2019-01-05 15:53:28 +00:00
|
|
|
//! Tools and utilities
|
|
|
|
//!
|
|
|
|
//! This is a collection of small and useful tools.
|
2018-12-09 15:37:48 +00:00
|
|
|
use failure::*;
|
|
|
|
use nix::unistd;
|
|
|
|
use nix::sys::stat;
|
|
|
|
|
2019-01-18 08:58:15 +00:00
|
|
|
use lazy_static::lazy_static;
|
|
|
|
|
2018-12-19 09:02:24 +00:00
|
|
|
use std::fs::{File, OpenOptions};
|
2018-12-09 15:37:48 +00:00
|
|
|
use std::io::Write;
|
|
|
|
use std::path::Path;
|
2018-12-15 10:14:41 +00:00
|
|
|
use std::io::Read;
|
|
|
|
use std::io::ErrorKind;
|
2018-12-19 10:08:57 +00:00
|
|
|
use std::time::Duration;
|
2018-12-09 15:37:48 +00:00
|
|
|
|
2019-04-10 13:14:05 +00:00
|
|
|
use std::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
|
2018-12-19 09:02:24 +00:00
|
|
|
|
2019-03-12 13:39:51 +00:00
|
|
|
use std::collections::HashMap;
|
|
|
|
|
2019-03-03 08:52:06 +00:00
|
|
|
use serde_json::Value;
|
2019-01-17 11:14:02 +00:00
|
|
|
|
2019-04-29 12:16:15 +00:00
|
|
|
pub mod async_mutex;
|
2018-12-19 10:07:43 +00:00
|
|
|
pub mod timer;
|
2019-01-20 08:38:28 +00:00
|
|
|
pub mod wrapped_reader_stream;
|
2019-01-24 13:59:40 +00:00
|
|
|
#[macro_use]
|
|
|
|
pub mod common_regex;
|
2019-01-29 11:59:07 +00:00
|
|
|
pub mod ticket;
|
2019-02-12 09:09:31 +00:00
|
|
|
pub mod borrow;
|
2019-02-12 12:51:34 +00:00
|
|
|
pub mod fs;
|
2019-02-20 11:08:58 +00:00
|
|
|
pub mod tty;
|
2019-03-11 08:35:47 +00:00
|
|
|
pub mod signalfd;
|
2019-03-12 09:40:25 +00:00
|
|
|
pub mod daemon;
|
2019-04-03 11:39:20 +00:00
|
|
|
pub mod procfs;
|
2019-04-25 10:49:33 +00:00
|
|
|
pub mod read;
|
|
|
|
pub mod write;
|
2018-12-19 10:07:43 +00:00
|
|
|
|
2019-03-22 07:04:12 +00:00
|
|
|
mod process_locker;
|
|
|
|
pub use process_locker::*;
|
|
|
|
|
2019-03-01 08:34:29 +00:00
|
|
|
#[macro_use]
|
|
|
|
mod file_logger;
|
|
|
|
pub use file_logger::*;
|
|
|
|
|
2019-04-26 15:56:41 +00:00
|
|
|
mod broadcast_future;
|
|
|
|
pub use broadcast_future::*;
|
|
|
|
|
2019-02-15 10:20:45 +00:00
|
|
|
/// Macro to write error-handling blocks (like perl eval {})
|
|
|
|
///
|
|
|
|
/// #### Example:
|
|
|
|
/// ```
|
2019-02-15 10:33:51 +00:00
|
|
|
/// # #[macro_use] extern crate proxmox_backup;
|
|
|
|
/// # use failure::*;
|
|
|
|
/// # let some_condition = false;
|
2019-02-15 10:20:45 +00:00
|
|
|
/// let result = try_block!({
|
|
|
|
/// if (some_condition) {
|
|
|
|
/// bail!("some error");
|
|
|
|
/// }
|
|
|
|
/// Ok(())
|
|
|
|
/// })
|
|
|
|
/// .map_err(|e| format_err!("my try block returned an error - {}", e));
|
|
|
|
/// ```
|
|
|
|
|
2019-02-15 09:59:12 +00:00
|
|
|
#[macro_export]
|
|
|
|
macro_rules! try_block {
|
|
|
|
{ $($token:tt)* } => {{ (|| -> Result<_,_> { $($token)* })() }}
|
|
|
|
}
|
|
|
|
|
2019-02-15 14:33:12 +00:00
|
|
|
|
2019-02-28 08:17:04 +00:00
|
|
|
/// The `BufferedRead` trait provides a single function
|
2019-01-05 16:28:20 +00:00
|
|
|
/// `buffered_read`. It returns a reference to an internal buffer. The
|
|
|
|
/// purpose of this traid is to avoid unnecessary data copies.
|
2019-02-28 08:17:04 +00:00
|
|
|
pub trait BufferedRead {
|
2019-01-06 08:17:28 +00:00
|
|
|
/// This functions tries to fill the internal buffers, then
|
|
|
|
/// returns a reference to the available data. It returns an empty
|
|
|
|
/// buffer if `offset` points to the end of the file.
|
2019-01-05 16:28:20 +00:00
|
|
|
fn buffered_read(&mut self, offset: u64) -> Result<&[u8], Error>;
|
|
|
|
}
|
|
|
|
|
2019-01-05 15:53:28 +00:00
|
|
|
/// Directly map a type into a binary buffer. This is mostly useful
|
|
|
|
/// for reading structured data from a byte stream (file). You need to
|
|
|
|
/// make sure that the buffer location does not change, so please
|
|
|
|
/// avoid vec resize while you use such map.
|
|
|
|
///
|
|
|
|
/// This function panics if the buffer is not large enough.
|
2018-12-28 07:04:46 +00:00
|
|
|
pub fn map_struct<T>(buffer: &[u8]) -> Result<&T, Error> {
|
2018-12-27 08:20:17 +00:00
|
|
|
if buffer.len() < ::std::mem::size_of::<T>() {
|
|
|
|
bail!("unable to map struct - buffer too small");
|
|
|
|
}
|
2018-12-29 16:00:48 +00:00
|
|
|
Ok(unsafe { & * (buffer.as_ptr() as *const T) })
|
2018-12-27 08:20:17 +00:00
|
|
|
}
|
|
|
|
|
2019-01-05 15:53:28 +00:00
|
|
|
/// Directly map a type into a mutable binary buffer. This is mostly
|
|
|
|
/// useful for writing structured data into a byte stream (file). You
|
|
|
|
/// need to make sure that the buffer location does not change, so
|
|
|
|
/// please avoid vec resize while you use such map.
|
|
|
|
///
|
|
|
|
/// This function panics if the buffer is not large enough.
|
2018-12-28 07:04:46 +00:00
|
|
|
pub fn map_struct_mut<T>(buffer: &mut [u8]) -> Result<&mut T, Error> {
|
2018-12-27 08:20:17 +00:00
|
|
|
if buffer.len() < ::std::mem::size_of::<T>() {
|
|
|
|
bail!("unable to map struct - buffer too small");
|
|
|
|
}
|
2018-12-29 16:00:48 +00:00
|
|
|
Ok(unsafe { &mut * (buffer.as_ptr() as *mut T) })
|
2018-12-27 08:20:17 +00:00
|
|
|
}
|
|
|
|
|
2019-02-16 08:36:29 +00:00
|
|
|
pub fn file_read_firstline<P: AsRef<Path>>(path: P) -> Result<String, Error> {
|
2019-01-24 09:43:30 +00:00
|
|
|
|
|
|
|
let path = path.as_ref();
|
|
|
|
|
2019-02-16 08:36:29 +00:00
|
|
|
try_block!({
|
|
|
|
let file = std::fs::File::open(path)?;
|
2019-01-24 09:43:30 +00:00
|
|
|
|
2019-02-16 08:36:29 +00:00
|
|
|
use std::io::{BufRead, BufReader};
|
2019-01-24 09:43:30 +00:00
|
|
|
|
2019-02-16 08:36:29 +00:00
|
|
|
let mut reader = BufReader::new(file);
|
2019-01-24 09:43:30 +00:00
|
|
|
|
2019-02-16 08:36:29 +00:00
|
|
|
let mut line = String::new();
|
2019-01-24 09:43:30 +00:00
|
|
|
|
2019-02-16 08:36:29 +00:00
|
|
|
let _ = reader.read_line(&mut line)?;
|
2019-01-24 09:43:30 +00:00
|
|
|
|
2019-02-16 08:36:29 +00:00
|
|
|
Ok(line)
|
|
|
|
}).map_err(|err: Error| format_err!("unable to read {:?} - {}", path, err))
|
2019-01-24 09:43:30 +00:00
|
|
|
}
|
|
|
|
|
2019-02-16 08:42:00 +00:00
|
|
|
pub fn file_get_contents<P: AsRef<Path>>(path: P) -> Result<Vec<u8>, Error> {
|
|
|
|
|
|
|
|
let path = path.as_ref();
|
|
|
|
|
|
|
|
try_block!({
|
|
|
|
std::fs::read(path)
|
|
|
|
}).map_err(|err| format_err!("unable to read {:?} - {}", path, err))
|
2019-01-25 09:44:40 +00:00
|
|
|
}
|
|
|
|
|
2019-04-04 10:24:18 +00:00
|
|
|
pub fn file_get_json<P: AsRef<Path>>(path: P, default: Option<Value>) -> Result<Value, Error> {
|
2019-03-05 11:50:52 +00:00
|
|
|
|
|
|
|
let path = path.as_ref();
|
|
|
|
|
2019-04-04 10:24:18 +00:00
|
|
|
let raw = match std::fs::read(path) {
|
|
|
|
Ok(v) => v,
|
|
|
|
Err(err) => {
|
|
|
|
if err.kind() == std::io::ErrorKind::NotFound {
|
|
|
|
if let Some(v) = default {
|
|
|
|
return Ok(v);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
bail!("unable to read json {:?} - {}", path, err);
|
|
|
|
}
|
|
|
|
};
|
2019-03-05 11:50:52 +00:00
|
|
|
|
|
|
|
try_block!({
|
|
|
|
let data = String::from_utf8(raw)?;
|
|
|
|
let json = serde_json::from_str(&data)?;
|
|
|
|
Ok(json)
|
2019-04-04 10:24:18 +00:00
|
|
|
}).map_err(|err: Error| format_err!("unable to parse json from {:?} - {}", path, err))
|
2019-03-05 11:50:52 +00:00
|
|
|
}
|
|
|
|
|
2019-04-06 11:53:43 +00:00
|
|
|
/// Atomically write a file
|
|
|
|
///
|
|
|
|
/// We first create a temporary file, which is then renamed.
|
2018-12-09 15:37:48 +00:00
|
|
|
pub fn file_set_contents<P: AsRef<Path>>(
|
|
|
|
path: P,
|
|
|
|
data: &[u8],
|
|
|
|
perm: Option<stat::Mode>,
|
|
|
|
) -> Result<(), Error> {
|
2019-04-06 11:53:43 +00:00
|
|
|
file_set_contents_full(path, data, perm, None, None)
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Atomically write a file with owner and group
|
|
|
|
pub fn file_set_contents_full<P: AsRef<Path>>(
|
|
|
|
path: P,
|
|
|
|
data: &[u8],
|
|
|
|
perm: Option<stat::Mode>,
|
2019-04-06 14:50:23 +00:00
|
|
|
owner: Option<unistd::Uid>,
|
|
|
|
group: Option<unistd::Gid>,
|
2019-04-06 11:53:43 +00:00
|
|
|
) -> Result<(), Error> {
|
2018-12-09 15:37:48 +00:00
|
|
|
|
|
|
|
let path = path.as_ref();
|
|
|
|
|
2018-12-12 10:23:04 +00:00
|
|
|
// Note: we use mkstemp heŕe, because this worka with different
|
|
|
|
// processes, threads, and even tokio tasks.
|
2018-12-09 15:37:48 +00:00
|
|
|
let mut template = path.to_owned();
|
|
|
|
template.set_extension("tmp_XXXXXX");
|
|
|
|
let (fd, tmp_path) = match unistd::mkstemp(&template) {
|
|
|
|
Ok((fd, path)) => (fd, path),
|
|
|
|
Err(err) => bail!("mkstemp {:?} failed: {}", template, err),
|
|
|
|
};
|
|
|
|
|
|
|
|
let tmp_path = tmp_path.as_path();
|
|
|
|
|
2018-12-09 15:41:54 +00:00
|
|
|
let mode : stat::Mode = perm.unwrap_or(stat::Mode::from(
|
2018-12-09 15:37:48 +00:00
|
|
|
stat::Mode::S_IRUSR | stat::Mode::S_IWUSR |
|
|
|
|
stat::Mode::S_IRGRP | stat::Mode::S_IROTH
|
2018-12-09 15:41:54 +00:00
|
|
|
));
|
2018-12-09 15:37:48 +00:00
|
|
|
|
|
|
|
if let Err(err) = stat::fchmod(fd, mode) {
|
|
|
|
let _ = unistd::unlink(tmp_path);
|
|
|
|
bail!("fchmod {:?} failed: {}", tmp_path, err);
|
|
|
|
}
|
|
|
|
|
2019-04-06 11:53:43 +00:00
|
|
|
if owner != None || group != None {
|
|
|
|
if let Err(err) = fchown(fd, owner, group) {
|
|
|
|
let _ = unistd::unlink(tmp_path);
|
|
|
|
bail!("fchown {:?} failed: {}", tmp_path, err);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-12-09 15:37:48 +00:00
|
|
|
use std::os::unix::io::FromRawFd;
|
|
|
|
let mut file = unsafe { File::from_raw_fd(fd) };
|
|
|
|
|
|
|
|
if let Err(err) = file.write_all(data) {
|
|
|
|
let _ = unistd::unlink(tmp_path);
|
|
|
|
bail!("write failed: {}", err);
|
|
|
|
}
|
|
|
|
|
|
|
|
if let Err(err) = std::fs::rename(tmp_path, path) {
|
|
|
|
let _ = unistd::unlink(tmp_path);
|
|
|
|
bail!("Atomic rename failed for file {:?} - {}", path, err);
|
|
|
|
}
|
|
|
|
|
|
|
|
Ok(())
|
|
|
|
}
|
2018-12-15 10:14:41 +00:00
|
|
|
|
2019-01-05 15:53:28 +00:00
|
|
|
/// Create a file lock using fntl. This function allows you to specify
|
|
|
|
/// a timeout if you want to avoid infinite blocking.
|
2018-12-19 10:08:57 +00:00
|
|
|
pub fn lock_file<F: AsRawFd>(
|
|
|
|
file: &mut F,
|
|
|
|
exclusive: bool,
|
|
|
|
timeout: Option<Duration>,
|
2019-03-20 08:57:13 +00:00
|
|
|
) -> Result<(), Error> {
|
2018-12-19 10:08:57 +00:00
|
|
|
let lockarg =
|
|
|
|
if exclusive {
|
|
|
|
nix::fcntl::FlockArg::LockExclusive
|
|
|
|
} else {
|
|
|
|
nix::fcntl::FlockArg::LockShared
|
|
|
|
};
|
|
|
|
|
|
|
|
let timeout = match timeout {
|
|
|
|
None => {
|
|
|
|
nix::fcntl::flock(file.as_raw_fd(), lockarg)?;
|
|
|
|
return Ok(());
|
|
|
|
}
|
|
|
|
Some(t) => t,
|
|
|
|
};
|
|
|
|
|
|
|
|
// unblock the timeout signal temporarily
|
|
|
|
let _sigblock_guard = timer::unblock_timeout_signal();
|
|
|
|
|
|
|
|
// setup a timeout timer
|
|
|
|
let mut timer = timer::Timer::create(
|
|
|
|
timer::Clock::Realtime,
|
|
|
|
timer::TimerEvent::ThisThreadSignal(timer::SIGTIMEOUT))?;
|
|
|
|
|
|
|
|
timer.arm(timer::TimerSpec::new()
|
|
|
|
.value(Some(timeout))
|
|
|
|
.interval(Some(Duration::from_millis(10))))?;
|
|
|
|
|
|
|
|
nix::fcntl::flock(file.as_raw_fd(), lockarg)?;
|
|
|
|
Ok(())
|
|
|
|
}
|
2018-12-19 09:02:24 +00:00
|
|
|
|
2019-01-05 15:53:28 +00:00
|
|
|
/// Open or create a lock file (append mode). Then try to
|
|
|
|
/// aquire a lock using `lock_file()`.
|
2018-12-19 10:08:57 +00:00
|
|
|
pub fn open_file_locked<P: AsRef<Path>>(path: P, timeout: Duration)
|
|
|
|
-> Result<File, Error>
|
|
|
|
{
|
|
|
|
let path = path.as_ref();
|
|
|
|
let mut file =
|
|
|
|
match OpenOptions::new()
|
|
|
|
.create(true)
|
|
|
|
.append(true)
|
|
|
|
.open(path)
|
|
|
|
{
|
2018-12-19 09:02:24 +00:00
|
|
|
Ok(file) => file,
|
|
|
|
Err(err) => bail!("Unable to open lock {:?} - {}",
|
|
|
|
path, err),
|
|
|
|
};
|
2018-12-22 14:59:55 +00:00
|
|
|
match lock_file(&mut file, true, Some(timeout)) {
|
|
|
|
Ok(_) => Ok(file),
|
|
|
|
Err(err) => bail!("Unable to aquire lock {:?} - {}",
|
|
|
|
path, err),
|
|
|
|
}
|
2018-12-19 09:02:24 +00:00
|
|
|
}
|
|
|
|
|
2019-01-05 15:53:28 +00:00
|
|
|
/// Split a file into equal sized chunks. The last chunk may be
|
|
|
|
/// smaller. Note: We cannot implement an `Iterator`, because iterators
|
|
|
|
/// cannot return a borrowed buffer ref (we want zero-copy)
|
2018-12-15 10:14:41 +00:00
|
|
|
pub fn file_chunker<C, R>(
|
|
|
|
mut file: R,
|
|
|
|
chunk_size: usize,
|
2018-12-15 13:51:05 +00:00
|
|
|
mut chunk_cb: C
|
2018-12-15 10:14:41 +00:00
|
|
|
) -> Result<(), Error>
|
2018-12-15 13:51:05 +00:00
|
|
|
where C: FnMut(usize, &[u8]) -> Result<bool, Error>,
|
2018-12-15 10:14:41 +00:00
|
|
|
R: Read,
|
|
|
|
{
|
|
|
|
|
|
|
|
const READ_BUFFER_SIZE: usize = 4*1024*1024; // 4M
|
|
|
|
|
|
|
|
if chunk_size > READ_BUFFER_SIZE { bail!("chunk size too large!"); }
|
|
|
|
|
|
|
|
let mut buf = vec![0u8; READ_BUFFER_SIZE];
|
|
|
|
|
|
|
|
let mut pos = 0;
|
|
|
|
let mut file_pos = 0;
|
|
|
|
loop {
|
|
|
|
let mut eof = false;
|
|
|
|
let mut tmp = &mut buf[..];
|
|
|
|
// try to read large portions, at least chunk_size
|
|
|
|
while pos < chunk_size {
|
|
|
|
match file.read(tmp) {
|
|
|
|
Ok(0) => { eof = true; break; },
|
|
|
|
Ok(n) => {
|
|
|
|
pos += n;
|
|
|
|
if pos > chunk_size { break; }
|
|
|
|
tmp = &mut tmp[n..];
|
|
|
|
}
|
|
|
|
Err(ref e) if e.kind() == ErrorKind::Interrupted => { /* try again */ }
|
2018-12-15 10:16:27 +00:00
|
|
|
Err(e) => bail!("read chunk failed - {}", e.to_string()),
|
2018-12-15 10:14:41 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
let mut start = 0;
|
|
|
|
while start + chunk_size <= pos {
|
|
|
|
if !(chunk_cb)(file_pos, &buf[start..start+chunk_size])? { break; }
|
|
|
|
file_pos += chunk_size;
|
|
|
|
start += chunk_size;
|
|
|
|
}
|
|
|
|
if eof {
|
|
|
|
if start < pos {
|
|
|
|
(chunk_cb)(file_pos, &buf[start..pos])?;
|
|
|
|
//file_pos += pos - start;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
} else {
|
|
|
|
let rest = pos - start;
|
|
|
|
if rest > 0 {
|
|
|
|
let ptr = buf.as_mut_ptr();
|
|
|
|
unsafe { std::ptr::copy_nonoverlapping(ptr.add(start), ptr, rest); }
|
|
|
|
pos = rest;
|
|
|
|
} else {
|
|
|
|
pos = 0;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
Ok(())
|
|
|
|
}
|
2019-01-17 11:14:02 +00:00
|
|
|
|
2019-04-06 11:53:43 +00:00
|
|
|
/// Returns the Unix uid/gid for the sepcified system user.
|
2019-02-15 14:33:12 +00:00
|
|
|
pub fn getpwnam_ugid(username: &str) -> Result<(libc::uid_t,libc::gid_t), Error> {
|
|
|
|
let info = unsafe { libc::getpwnam(std::ffi::CString::new(username).unwrap().as_ptr()) };
|
|
|
|
if info == std::ptr::null_mut() {
|
|
|
|
bail!("getwpnam '{}' failed", username);
|
|
|
|
}
|
|
|
|
|
|
|
|
let info = unsafe { *info };
|
|
|
|
|
|
|
|
Ok((info.pw_uid, info.pw_gid))
|
|
|
|
}
|
|
|
|
|
2019-04-06 15:53:12 +00:00
|
|
|
/// Creates directory at the provided path with specified ownership
|
|
|
|
///
|
|
|
|
/// Simply returns if the directory already exists.
|
2019-04-06 14:50:23 +00:00
|
|
|
pub fn create_dir_chown<P: AsRef<Path>>(
|
|
|
|
path: P,
|
|
|
|
perm: Option<stat::Mode>,
|
|
|
|
owner: Option<unistd::Uid>,
|
|
|
|
group: Option<unistd::Gid>,
|
2019-04-06 15:53:12 +00:00
|
|
|
) -> Result<(), nix::Error>
|
2019-04-06 14:50:23 +00:00
|
|
|
{
|
2019-04-06 15:53:12 +00:00
|
|
|
let mode : stat::Mode = perm.unwrap_or(stat::Mode::from_bits_truncate(0o770));
|
2019-04-06 14:50:23 +00:00
|
|
|
|
|
|
|
let path = path.as_ref();
|
|
|
|
|
2019-04-06 15:53:12 +00:00
|
|
|
match nix::unistd::mkdir(path, mode) {
|
|
|
|
Ok(()) => {},
|
|
|
|
Err(nix::Error::Sys(nix::errno::Errno::EEXIST)) => {
|
|
|
|
return Ok(());
|
|
|
|
},
|
|
|
|
err => return err,
|
|
|
|
}
|
|
|
|
|
2019-04-06 14:50:23 +00:00
|
|
|
unistd::chown(path, owner, group)?;
|
|
|
|
|
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
|
2019-04-06 11:53:43 +00:00
|
|
|
/// Change ownership of an open file handle
|
|
|
|
pub fn fchown(
|
|
|
|
fd: RawFd,
|
|
|
|
owner: Option<nix::unistd::Uid>,
|
|
|
|
group: Option<nix::unistd::Gid>
|
|
|
|
) -> Result<(), Error> {
|
|
|
|
|
|
|
|
// According to the POSIX specification, -1 is used to indicate that owner and group
|
|
|
|
// are not to be changed. Since uid_t and gid_t are unsigned types, we have to wrap
|
|
|
|
// around to get -1 (copied fron nix crate).
|
|
|
|
let uid = owner.map(Into::into).unwrap_or((0 as libc::uid_t).wrapping_sub(1));
|
|
|
|
let gid = group.map(Into::into).unwrap_or((0 as libc::gid_t).wrapping_sub(1));
|
|
|
|
|
|
|
|
let res = unsafe { libc::fchown(fd, uid, gid) };
|
|
|
|
nix::errno::Errno::result(res)?;
|
|
|
|
|
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
|
2019-02-15 14:33:12 +00:00
|
|
|
// Returns the hosts node name (UTS node name)
|
2019-01-18 08:58:15 +00:00
|
|
|
pub fn nodename() -> &'static str {
|
|
|
|
|
|
|
|
lazy_static!{
|
|
|
|
static ref NODENAME: String = {
|
|
|
|
|
2019-01-18 09:13:45 +00:00
|
|
|
nix::sys::utsname::uname()
|
|
|
|
.nodename()
|
|
|
|
.split('.')
|
|
|
|
.next()
|
|
|
|
.unwrap()
|
|
|
|
.to_owned()
|
2019-01-18 08:58:15 +00:00
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
&NODENAME
|
|
|
|
}
|
|
|
|
|
2019-03-03 07:51:37 +00:00
|
|
|
pub fn json_object_to_query(data: Value) -> Result<String, Error> {
|
|
|
|
|
|
|
|
let mut query = url::form_urlencoded::Serializer::new(String::new());
|
|
|
|
|
|
|
|
let object = data.as_object().ok_or_else(|| {
|
|
|
|
format_err!("json_object_to_query: got wrong data type (expected object).")
|
|
|
|
})?;
|
|
|
|
|
|
|
|
for (key, value) in object {
|
|
|
|
match value {
|
|
|
|
Value::Bool(b) => { query.append_pair(key, &b.to_string()); }
|
|
|
|
Value::Number(n) => { query.append_pair(key, &n.to_string()); }
|
|
|
|
Value::String(s) => { query.append_pair(key, &s); }
|
|
|
|
Value::Array(arr) => {
|
|
|
|
for element in arr {
|
|
|
|
match element {
|
|
|
|
Value::Bool(b) => { query.append_pair(key, &b.to_string()); }
|
|
|
|
Value::Number(n) => { query.append_pair(key, &n.to_string()); }
|
|
|
|
Value::String(s) => { query.append_pair(key, &s); }
|
|
|
|
_ => bail!("json_object_to_query: unable to handle complex array data types."),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
_ => bail!("json_object_to_query: unable to handle complex data types."),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
Ok(query.finish())
|
|
|
|
}
|
|
|
|
|
2019-01-17 11:14:02 +00:00
|
|
|
pub fn required_string_param<'a>(param: &'a Value, name: &str) -> Result<&'a str, Error> {
|
|
|
|
match param[name].as_str() {
|
|
|
|
Some(s) => Ok(s),
|
|
|
|
None => bail!("missing parameter '{}'", name),
|
|
|
|
}
|
|
|
|
}
|
2019-01-18 09:13:45 +00:00
|
|
|
|
|
|
|
pub fn required_integer_param<'a>(param: &'a Value, name: &str) -> Result<i64, Error> {
|
|
|
|
match param[name].as_i64() {
|
|
|
|
Some(s) => Ok(s),
|
|
|
|
None => bail!("missing parameter '{}'", name),
|
2019-02-26 07:48:17 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn required_array_param<'a>(param: &'a Value, name: &str) -> Result<Vec<Value>, Error> {
|
|
|
|
match param[name].as_array() {
|
|
|
|
Some(s) => Ok(s.to_vec()),
|
|
|
|
None => bail!("missing parameter '{}'", name),
|
2019-01-18 09:13:45 +00:00
|
|
|
}
|
|
|
|
}
|
2019-01-18 12:42:52 +00:00
|
|
|
|
2019-03-12 13:39:51 +00:00
|
|
|
pub fn complete_file_name(arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
|
2019-01-18 12:42:52 +00:00
|
|
|
|
|
|
|
let mut result = vec![];
|
|
|
|
|
|
|
|
use nix::fcntl::OFlag;
|
|
|
|
use nix::sys::stat::Mode;
|
|
|
|
use nix::fcntl::AtFlags;
|
|
|
|
|
2019-03-14 07:17:35 +00:00
|
|
|
let mut dirname = std::path::PathBuf::from(if arg.len() == 0 { "./" } else { arg });
|
2019-01-18 12:42:52 +00:00
|
|
|
|
|
|
|
let is_dir = match nix::sys::stat::fstatat(libc::AT_FDCWD, &dirname, AtFlags::empty()) {
|
|
|
|
Ok(stat) => (stat.st_mode & libc::S_IFMT) == libc::S_IFDIR,
|
|
|
|
Err(_) => false,
|
|
|
|
};
|
|
|
|
|
|
|
|
if !is_dir {
|
|
|
|
if let Some(parent) = dirname.parent() {
|
|
|
|
dirname = parent.to_owned();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
let mut dir = match nix::dir::Dir::openat(libc::AT_FDCWD, &dirname, OFlag::O_DIRECTORY, Mode::empty()) {
|
|
|
|
Ok(d) => d,
|
|
|
|
Err(_) => return result,
|
|
|
|
};
|
|
|
|
|
|
|
|
for item in dir.iter() {
|
|
|
|
if let Ok(entry) = item {
|
|
|
|
if let Ok(name) = entry.file_name().to_str() {
|
|
|
|
if name == "." || name == ".." { continue; }
|
|
|
|
let mut newpath = dirname.clone();
|
|
|
|
newpath.push(name);
|
|
|
|
|
|
|
|
if let Ok(stat) = nix::sys::stat::fstatat(libc::AT_FDCWD, &newpath, AtFlags::empty()) {
|
|
|
|
if (stat.st_mode & libc::S_IFMT) == libc::S_IFDIR {
|
|
|
|
newpath.push("");
|
|
|
|
if let Some(newpath) = newpath.to_str() {
|
|
|
|
result.push(newpath.to_owned());
|
|
|
|
}
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if let Some(newpath) = newpath.to_str() {
|
|
|
|
result.push(newpath.to_owned());
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
result
|
|
|
|
}
|
2019-01-20 16:31:43 +00:00
|
|
|
|
|
|
|
/// Scan directory for matching file names.
|
|
|
|
///
|
|
|
|
/// Scan through all directory entries and call `callback()` function
|
|
|
|
/// if the entry name matches the regular expression. This function
|
|
|
|
/// used unix `openat()`, so you can pass absolute or relative file
|
|
|
|
/// names. This function simply skips non-UTF8 encoded names.
|
|
|
|
pub fn scandir<P, F>(
|
|
|
|
dirfd: RawFd,
|
2019-02-12 13:21:49 +00:00
|
|
|
path: &P,
|
2019-01-20 16:31:43 +00:00
|
|
|
regex: ®ex::Regex,
|
2019-01-20 16:49:11 +00:00
|
|
|
mut callback: F
|
2019-01-20 16:31:43 +00:00
|
|
|
) -> Result<(), Error>
|
2019-01-20 16:49:11 +00:00
|
|
|
where F: FnMut(RawFd, &str, nix::dir::Type) -> Result<(), Error>,
|
2019-02-12 13:21:49 +00:00
|
|
|
P: ?Sized + nix::NixPath,
|
2019-01-20 16:31:43 +00:00
|
|
|
{
|
2019-02-12 13:21:49 +00:00
|
|
|
for entry in self::fs::scan_subdir(dirfd, path, regex)? {
|
2019-01-20 16:31:43 +00:00
|
|
|
let entry = entry?;
|
|
|
|
let file_type = match entry.file_type() {
|
|
|
|
Some(file_type) => file_type,
|
|
|
|
None => bail!("unable to detect file type"),
|
|
|
|
};
|
|
|
|
|
2019-02-12 13:21:49 +00:00
|
|
|
callback(entry.parent_fd(), unsafe { entry.file_name_utf8_unchecked() }, file_type)?;
|
2019-01-20 16:31:43 +00:00
|
|
|
}
|
|
|
|
Ok(())
|
|
|
|
}
|
2019-01-22 11:50:19 +00:00
|
|
|
|
|
|
|
pub fn get_hardware_address() -> Result<String, Error> {
|
|
|
|
|
2019-01-25 11:23:47 +00:00
|
|
|
static FILENAME: &str = "/etc/ssh/ssh_host_rsa_key.pub";
|
2019-01-22 11:50:19 +00:00
|
|
|
|
2019-01-25 11:23:47 +00:00
|
|
|
let contents = file_get_contents(FILENAME)?;
|
2019-01-22 11:50:19 +00:00
|
|
|
let digest = md5::compute(contents);
|
|
|
|
|
|
|
|
Ok(format!("{:0x}", digest))
|
|
|
|
}
|
2019-01-25 09:58:28 +00:00
|
|
|
|
|
|
|
pub fn digest_to_hex(digest: &[u8]) -> String {
|
|
|
|
|
|
|
|
const HEX_CHARS: &'static [u8; 16] = b"0123456789abcdef";
|
|
|
|
|
|
|
|
let mut buf = Vec::<u8>::with_capacity(digest.len()*2);
|
|
|
|
|
|
|
|
for i in 0..digest.len() {
|
|
|
|
buf.push(HEX_CHARS[(digest[i] >> 4) as usize]);
|
|
|
|
buf.push(HEX_CHARS[(digest[i] & 0xf) as usize]);
|
|
|
|
}
|
|
|
|
|
|
|
|
unsafe { String::from_utf8_unchecked(buf) }
|
|
|
|
}
|
|
|
|
|
2019-01-25 10:38:59 +00:00
|
|
|
pub fn assert_if_modified(digest1: &str, digest2: &str) -> Result<(), Error> {
|
|
|
|
if digest1 != digest2 {
|
|
|
|
bail!("detected modified configuration - file changed by other user? Try again.");
|
|
|
|
}
|
|
|
|
Ok(())
|
|
|
|
}
|
2019-01-31 11:22:00 +00:00
|
|
|
|
|
|
|
/// Extract authentication cookie from cookie header.
|
|
|
|
/// We assume cookie_name is already url encoded.
|
|
|
|
pub fn extract_auth_cookie(cookie: &str, cookie_name: &str) -> Option<String> {
|
|
|
|
|
|
|
|
for pair in cookie.split(';') {
|
|
|
|
|
|
|
|
let (name, value) = match pair.find('=') {
|
|
|
|
Some(i) => (pair[..i].trim(), pair[(i + 1)..].trim()),
|
|
|
|
None => return None, // Cookie format error
|
|
|
|
};
|
|
|
|
|
|
|
|
if name == cookie_name {
|
|
|
|
use url::percent_encoding::percent_decode;
|
|
|
|
if let Ok(value) = percent_decode(value.as_bytes()).decode_utf8() {
|
|
|
|
return Some(value.into());
|
|
|
|
} else {
|
|
|
|
return None; // Cookie format error
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
None
|
|
|
|
}
|
2019-03-02 15:12:34 +00:00
|
|
|
|
|
|
|
pub fn join(data: &Vec<String>, sep: char) -> String {
|
|
|
|
|
|
|
|
let mut list = String::new();
|
|
|
|
|
|
|
|
for item in data {
|
|
|
|
if list.len() != 0 { list.push(sep); }
|
|
|
|
list.push_str(item);
|
|
|
|
}
|
|
|
|
|
|
|
|
list
|
|
|
|
}
|
2019-03-18 10:39:09 +00:00
|
|
|
|
2019-05-07 07:44:34 +00:00
|
|
|
/// normalize uri path
|
|
|
|
///
|
|
|
|
/// Do not allow ".", "..", or hidden files ".XXXX"
|
|
|
|
/// Also remove empty path components
|
|
|
|
pub fn normalize_uri_path(path: &str) -> Result<(String, Vec<&str>), Error> {
|
|
|
|
|
|
|
|
let items = path.split('/');
|
|
|
|
|
|
|
|
let mut path = String::new();
|
|
|
|
let mut components = vec![];
|
|
|
|
|
|
|
|
for name in items {
|
|
|
|
if name.is_empty() { continue; }
|
|
|
|
if name.starts_with(".") {
|
|
|
|
bail!("Path contains illegal components.");
|
|
|
|
}
|
|
|
|
path.push('/');
|
|
|
|
path.push_str(name);
|
|
|
|
components.push(name);
|
|
|
|
}
|
|
|
|
|
|
|
|
Ok((path, components))
|
|
|
|
}
|
|
|
|
|
2019-03-18 10:39:09 +00:00
|
|
|
pub fn fd_change_cloexec(fd: RawFd, on: bool) -> Result<(), Error> {
|
|
|
|
use nix::fcntl::{fcntl, F_GETFD, F_SETFD, FdFlag};
|
|
|
|
let mut flags = FdFlag::from_bits(fcntl(fd, F_GETFD)?)
|
|
|
|
.ok_or_else(|| format_err!("unhandled file flags"))?; // nix crate is stupid this way...
|
|
|
|
flags.set(FdFlag::FD_CLOEXEC, on);
|
|
|
|
fcntl(fd, F_SETFD(flags))?;
|
|
|
|
Ok(())
|
|
|
|
}
|
2019-04-01 10:03:47 +00:00
|
|
|
|
|
|
|
|
|
|
|
static mut SHUTDOWN_REQUESTED: bool = false;
|
|
|
|
|
|
|
|
pub fn request_shutdown() {
|
|
|
|
unsafe { SHUTDOWN_REQUESTED = true; }
|
2019-04-08 10:21:29 +00:00
|
|
|
crate::server::server_shutdown();
|
2019-04-01 10:03:47 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
#[inline(always)]
|
|
|
|
pub fn shutdown_requested() -> bool {
|
|
|
|
unsafe { SHUTDOWN_REQUESTED }
|
|
|
|
}
|
2019-04-01 10:13:02 +00:00
|
|
|
|
|
|
|
pub fn fail_on_shutdown() -> Result<(), Error> {
|
|
|
|
if shutdown_requested() {
|
|
|
|
bail!("Server shutdown requested - aborting task");
|
|
|
|
}
|
|
|
|
Ok(())
|
|
|
|
}
|
2019-04-10 13:14:05 +00:00
|
|
|
|
|
|
|
/// Guard a raw file descriptor with a drop handler. This is mostly useful when access to an owned
|
|
|
|
/// `RawFd` is required without the corresponding handler object (such as when only the file
|
|
|
|
/// descriptor number is required in a closure which may be dropped instead of being executed).
|
|
|
|
pub struct Fd(pub RawFd);
|
|
|
|
|
|
|
|
impl Drop for Fd {
|
|
|
|
fn drop(&mut self) {
|
|
|
|
if self.0 != -1 {
|
|
|
|
unsafe {
|
|
|
|
libc::close(self.0);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl AsRawFd for Fd {
|
|
|
|
fn as_raw_fd(&self) -> RawFd {
|
|
|
|
self.0
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl IntoRawFd for Fd {
|
|
|
|
fn into_raw_fd(mut self) -> RawFd {
|
|
|
|
let fd = self.0;
|
|
|
|
self.0 = -1;
|
|
|
|
fd
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl FromRawFd for Fd {
|
|
|
|
unsafe fn from_raw_fd(fd: RawFd) -> Self {
|
|
|
|
Self(fd)
|
|
|
|
}
|
|
|
|
}
|
2019-04-25 10:50:15 +00:00
|
|
|
|
|
|
|
// wrap nix::unistd::pipe2 + O_CLOEXEC into something returning guarded file descriptors
|
|
|
|
pub fn pipe() -> Result<(Fd, Fd), Error> {
|
|
|
|
let (pin, pout) = nix::unistd::pipe2(nix::fcntl::OFlag::O_CLOEXEC)?;
|
|
|
|
Ok((Fd(pin), Fd(pout)))
|
|
|
|
}
|