1 //! Tools and utilities
3 //! This is a collection of small and useful tools.
7 use nix
::{convert_ioctl_res, request_code_read, ioc}
;
9 use lazy_static
::lazy_static
;
11 use std
::fs
::{File, OpenOptions}
;
15 use std
::io
::ErrorKind
;
16 use std
::time
::Duration
;
19 use std
::os
::unix
::io
::{AsRawFd, FromRawFd, IntoRawFd, RawFd}
;
21 use std
::collections
::HashMap
;
23 use serde_json
::Value
;
25 use proxmox
::tools
::vec
;
29 pub mod wrapped_reader_stream
;
44 pub use process_locker
::*;
48 pub use file_logger
::*;
51 pub use broadcast_future
::*;
53 /// Macro to write error-handling blocks (like perl eval {})
57 /// # #[macro_use] extern crate proxmox_backup;
59 /// # let some_condition = false;
60 /// let result = try_block!({
61 /// if (some_condition) {
62 /// bail!("some error");
66 /// .map_err(|e| format_err!("my try block returned an error - {}", e));
70 macro_rules
! try_block
{
71 { $($token:tt)* }
=> {{ (|| -> Result<_,_> { $($token)* }
)() }}
75 /// The `BufferedRead` trait provides a single function
76 /// `buffered_read`. It returns a reference to an internal buffer. The
77 /// purpose of this traid is to avoid unnecessary data copies.
78 pub trait BufferedRead
{
79 /// This functions tries to fill the internal buffers, then
80 /// returns a reference to the available data. It returns an empty
81 /// buffer if `offset` points to the end of the file.
82 fn buffered_read(&mut self, offset
: u64) -> Result
<&[u8], Error
>;
85 /// Directly map a type into a binary buffer. This is mostly useful
86 /// for reading structured data from a byte stream (file). You need to
87 /// make sure that the buffer location does not change, so please
88 /// avoid vec resize while you use such map.
90 /// This function panics if the buffer is not large enough.
91 pub fn map_struct
<T
>(buffer
: &[u8]) -> Result
<&T
, Error
> {
92 if buffer
.len() < ::std
::mem
::size_of
::<T
>() {
93 bail
!("unable to map struct - buffer too small");
95 Ok(unsafe { & * (buffer.as_ptr() as *const T) }
)
98 /// Directly map a type into a mutable binary buffer. This is mostly
99 /// useful for writing structured data into a byte stream (file). You
100 /// need to make sure that the buffer location does not change, so
101 /// please avoid vec resize while you use such map.
103 /// This function panics if the buffer is not large enough.
104 pub fn map_struct_mut
<T
>(buffer
: &mut [u8]) -> Result
<&mut T
, Error
> {
105 if buffer
.len() < ::std
::mem
::size_of
::<T
>() {
106 bail
!("unable to map struct - buffer too small");
108 Ok(unsafe { &mut * (buffer.as_ptr() as *mut T) }
)
111 pub fn file_read_firstline
<P
: AsRef
<Path
>>(path
: P
) -> Result
<String
, Error
> {
113 let path
= path
.as_ref();
116 let file
= std
::fs
::File
::open(path
)?
;
118 use std
::io
::{BufRead, BufReader}
;
120 let mut reader
= BufReader
::new(file
);
122 let mut line
= String
::new();
124 let _
= reader
.read_line(&mut line
)?
;
127 }).map_err(|err
: Error
| format_err
!("unable to read {:?} - {}", path
, err
))
130 pub fn file_get_contents
<P
: AsRef
<Path
>>(path
: P
) -> Result
<Vec
<u8>, Error
> {
132 let path
= path
.as_ref();
136 }).map_err(|err
| format_err
!("unable to read {:?} - {}", path
, err
))
139 pub fn file_get_json
<P
: AsRef
<Path
>>(path
: P
, default: Option
<Value
>) -> Result
<Value
, Error
> {
141 let path
= path
.as_ref();
143 let raw
= match std
::fs
::read(path
) {
146 if err
.kind() == std
::io
::ErrorKind
::NotFound
{
147 if let Some(v
) = default {
151 bail
!("unable to read json {:?} - {}", path
, err
);
156 let data
= String
::from_utf8(raw
)?
;
157 let json
= serde_json
::from_str(&data
)?
;
159 }).map_err(|err
: Error
| format_err
!("unable to parse json from {:?} - {}", path
, err
))
162 /// Atomically write a file
164 /// We first create a temporary file, which is then renamed.
165 pub fn file_set_contents
<P
: AsRef
<Path
>>(
168 perm
: Option
<stat
::Mode
>,
169 ) -> Result
<(), Error
> {
170 file_set_contents_full(path
, data
, perm
, None
, None
)
173 /// Atomically write a file with owner and group
174 pub fn file_set_contents_full
<P
: AsRef
<Path
>>(
177 perm
: Option
<stat
::Mode
>,
178 owner
: Option
<unistd
::Uid
>,
179 group
: Option
<unistd
::Gid
>,
180 ) -> Result
<(), Error
> {
182 let path
= path
.as_ref();
184 // Note: we use mkstemp heŕe, because this worka with different
185 // processes, threads, and even tokio tasks.
186 let mut template
= path
.to_owned();
187 template
.set_extension("tmp_XXXXXX");
188 let (fd
, tmp_path
) = match unistd
::mkstemp(&template
) {
189 Ok((fd
, path
)) => (fd
, path
),
190 Err(err
) => bail
!("mkstemp {:?} failed: {}", template
, err
),
193 let tmp_path
= tmp_path
.as_path();
195 let mode
: stat
::Mode
= perm
.unwrap_or(stat
::Mode
::from(
196 stat
::Mode
::S_IRUSR
| stat
::Mode
::S_IWUSR
|
197 stat
::Mode
::S_IRGRP
| stat
::Mode
::S_IROTH
201 if let Err(err
) = stat
::fchmod(fd
, mode
) {
202 let _
= unistd
::unlink(tmp_path
);
203 bail
!("fchmod {:?} failed: {}", tmp_path
, err
);
207 if owner
!= None
|| group
!= None
{
208 if let Err(err
) = fchown(fd
, owner
, group
) {
209 let _
= unistd
::unlink(tmp_path
);
210 bail
!("fchown {:?} failed: {}", tmp_path
, err
);
214 let mut file
= unsafe { File::from_raw_fd(fd) }
;
216 if let Err(err
) = file
.write_all(data
) {
217 let _
= unistd
::unlink(tmp_path
);
218 bail
!("write failed: {}", err
);
221 if let Err(err
) = std
::fs
::rename(tmp_path
, path
) {
222 let _
= unistd
::unlink(tmp_path
);
223 bail
!("Atomic rename failed for file {:?} - {}", path
, err
);
229 /// Create a file lock using fntl. This function allows you to specify
230 /// a timeout if you want to avoid infinite blocking.
231 pub fn lock_file
<F
: AsRawFd
>(
234 timeout
: Option
<Duration
>,
235 ) -> Result
<(), Error
> {
238 nix
::fcntl
::FlockArg
::LockExclusive
240 nix
::fcntl
::FlockArg
::LockShared
243 let timeout
= match timeout
{
245 nix
::fcntl
::flock(file
.as_raw_fd(), lockarg
)?
;
251 // unblock the timeout signal temporarily
252 let _sigblock_guard
= timer
::unblock_timeout_signal();
254 // setup a timeout timer
255 let mut timer
= timer
::Timer
::create(
256 timer
::Clock
::Realtime
,
257 timer
::TimerEvent
::ThisThreadSignal(timer
::SIGTIMEOUT
))?
;
259 timer
.arm(timer
::TimerSpec
::new()
260 .value(Some(timeout
))
261 .interval(Some(Duration
::from_millis(10))))?
;
263 nix
::fcntl
::flock(file
.as_raw_fd(), lockarg
)?
;
267 /// Open or create a lock file (append mode). Then try to
268 /// aquire a lock using `lock_file()`.
269 pub fn open_file_locked
<P
: AsRef
<Path
>>(path
: P
, timeout
: Duration
)
270 -> Result
<File
, Error
>
272 let path
= path
.as_ref();
274 match OpenOptions
::new()
280 Err(err
) => bail
!("Unable to open lock {:?} - {}",
283 match lock_file(&mut file
, true, Some(timeout
)) {
285 Err(err
) => bail
!("Unable to aquire lock {:?} - {}",
290 /// Split a file into equal sized chunks. The last chunk may be
291 /// smaller. Note: We cannot implement an `Iterator`, because iterators
292 /// cannot return a borrowed buffer ref (we want zero-copy)
293 pub fn file_chunker
<C
, R
>(
297 ) -> Result
<(), Error
>
298 where C
: FnMut(usize, &[u8]) -> Result
<bool
, Error
>,
302 const READ_BUFFER_SIZE
: usize = 4*1024*1024; // 4M
304 if chunk_size
> READ_BUFFER_SIZE { bail!("chunk size too large!"); }
306 let mut buf
= vec
::undefined(READ_BUFFER_SIZE
);
309 let mut file_pos
= 0;
312 let mut tmp
= &mut buf
[..];
313 // try to read large portions, at least chunk_size
314 while pos
< chunk_size
{
315 match file
.read(tmp
) {
316 Ok(0) => { eof = true; break; }
,
319 if pos
> chunk_size { break; }
322 Err(ref e
) if e
.kind() == ErrorKind
::Interrupted
=> { /* try again */ }
323 Err(e
) => bail
!("read chunk failed - {}", e
.to_string()),
327 while start
+ chunk_size
<= pos
{
328 if !(chunk_cb
)(file_pos
, &buf
[start
..start
+chunk_size
])? { break; }
329 file_pos
+= chunk_size
;
334 (chunk_cb
)(file_pos
, &buf
[start
..pos
])?
;
335 //file_pos += pos - start;
339 let rest
= pos
- start
;
341 let ptr
= buf
.as_mut_ptr();
342 unsafe { std::ptr::copy_nonoverlapping(ptr.add(start), ptr, rest); }
353 /// Returns the Unix uid/gid for the sepcified system user.
354 pub fn getpwnam_ugid(username
: &str) -> Result
<(libc
::uid_t
,libc
::gid_t
), Error
> {
355 let info
= unsafe { libc::getpwnam(std::ffi::CString::new(username).unwrap().as_ptr()) }
;
356 if info
== std
::ptr
::null_mut() {
357 bail
!("getwpnam '{}' failed", username
);
360 let info
= unsafe { *info }
;
362 Ok((info
.pw_uid
, info
.pw_gid
))
365 /// Creates directory at the provided path with specified ownership
367 /// Simply returns if the directory already exists.
368 pub fn create_dir_chown
<P
: AsRef
<Path
>>(
370 perm
: Option
<stat
::Mode
>,
371 owner
: Option
<unistd
::Uid
>,
372 group
: Option
<unistd
::Gid
>,
373 ) -> Result
<(), nix
::Error
>
375 let mode
: stat
::Mode
= perm
.unwrap_or(stat
::Mode
::from_bits_truncate(0o770));
377 let path
= path
.as_ref();
379 match nix
::unistd
::mkdir(path
, mode
) {
381 Err(nix
::Error
::Sys(nix
::errno
::Errno
::EEXIST
)) => {
387 unistd
::chown(path
, owner
, group
)?
;
392 /// Change ownership of an open file handle
395 owner
: Option
<nix
::unistd
::Uid
>,
396 group
: Option
<nix
::unistd
::Gid
>
397 ) -> Result
<(), Error
> {
399 // According to the POSIX specification, -1 is used to indicate that owner and group
400 // are not to be changed. Since uid_t and gid_t are unsigned types, we have to wrap
401 // around to get -1 (copied fron nix crate).
402 let uid
= owner
.map(Into
::into
).unwrap_or((0 as libc
::uid_t
).wrapping_sub(1));
403 let gid
= group
.map(Into
::into
).unwrap_or((0 as libc
::gid_t
).wrapping_sub(1));
405 let res
= unsafe { libc::fchown(fd, uid, gid) }
;
406 nix
::errno
::Errno
::result(res
)?
;
411 // Returns the hosts node name (UTS node name)
412 pub fn nodename() -> &'
static str {
415 static ref NODENAME
: String
= {
417 nix
::sys
::utsname
::uname()
429 pub fn json_object_to_query(data
: Value
) -> Result
<String
, Error
> {
431 let mut query
= url
::form_urlencoded
::Serializer
::new(String
::new());
433 let object
= data
.as_object().ok_or_else(|| {
434 format_err
!("json_object_to_query: got wrong data type (expected object).")
437 for (key
, value
) in object
{
439 Value
::Bool(b
) => { query.append_pair(key, &b.to_string()); }
440 Value
::Number(n
) => { query.append_pair(key, &n.to_string()); }
441 Value
::String(s
) => { query.append_pair(key, &s); }
442 Value
::Array(arr
) => {
445 Value
::Bool(b
) => { query.append_pair(key, &b.to_string()); }
446 Value
::Number(n
) => { query.append_pair(key, &n.to_string()); }
447 Value
::String(s
) => { query.append_pair(key, &s); }
448 _
=> bail
!("json_object_to_query: unable to handle complex array data types."),
452 _
=> bail
!("json_object_to_query: unable to handle complex data types."),
459 pub fn required_string_param
<'a
>(param
: &'a Value
, name
: &str) -> Result
<&'a
str, Error
> {
460 match param
[name
].as_str() {
462 None
=> bail
!("missing parameter '{}'", name
),
466 pub fn required_integer_param
<'a
>(param
: &'a Value
, name
: &str) -> Result
<i64, Error
> {
467 match param
[name
].as_i64() {
469 None
=> bail
!("missing parameter '{}'", name
),
473 pub fn required_array_param
<'a
>(param
: &'a Value
, name
: &str) -> Result
<Vec
<Value
>, Error
> {
474 match param
[name
].as_array() {
475 Some(s
) => Ok(s
.to_vec()),
476 None
=> bail
!("missing parameter '{}'", name
),
480 pub fn complete_file_name(arg
: &str, _param
: &HashMap
<String
, String
>) -> Vec
<String
> {
482 let mut result
= vec
![];
484 use nix
::fcntl
::OFlag
;
485 use nix
::sys
::stat
::Mode
;
486 use nix
::fcntl
::AtFlags
;
488 let mut dirname
= std
::path
::PathBuf
::from(if arg
.len() == 0 { "./" }
else { arg }
);
490 let is_dir
= match nix
::sys
::stat
::fstatat(libc
::AT_FDCWD
, &dirname
, AtFlags
::empty()) {
491 Ok(stat
) => (stat
.st_mode
& libc
::S_IFMT
) == libc
::S_IFDIR
,
496 if let Some(parent
) = dirname
.parent() {
497 dirname
= parent
.to_owned();
501 let mut dir
= match nix
::dir
::Dir
::openat(libc
::AT_FDCWD
, &dirname
, OFlag
::O_DIRECTORY
, Mode
::empty()) {
503 Err(_
) => return result
,
506 for item
in dir
.iter() {
507 if let Ok(entry
) = item
{
508 if let Ok(name
) = entry
.file_name().to_str() {
509 if name
== "." || name
== ".." { continue; }
510 let mut newpath
= dirname
.clone();
513 if let Ok(stat
) = nix
::sys
::stat
::fstatat(libc
::AT_FDCWD
, &newpath
, AtFlags
::empty()) {
514 if (stat
.st_mode
& libc
::S_IFMT
) == libc
::S_IFDIR
{
516 if let Some(newpath
) = newpath
.to_str() {
517 result
.push(newpath
.to_owned());
522 if let Some(newpath
) = newpath
.to_str() {
523 result
.push(newpath
.to_owned());
533 /// Scan directory for matching file names.
535 /// Scan through all directory entries and call `callback()` function
536 /// if the entry name matches the regular expression. This function
537 /// used unix `openat()`, so you can pass absolute or relative file
538 /// names. This function simply skips non-UTF8 encoded names.
539 pub fn scandir
<P
, F
>(
542 regex
: ®ex
::Regex
,
544 ) -> Result
<(), Error
>
545 where F
: FnMut(RawFd
, &str, nix
::dir
::Type
) -> Result
<(), Error
>,
546 P
: ?Sized
+ nix
::NixPath
,
548 for entry
in self::fs
::scan_subdir(dirfd
, path
, regex
)?
{
550 let file_type
= match entry
.file_type() {
551 Some(file_type
) => file_type
,
552 None
=> bail
!("unable to detect file type"),
555 callback(entry
.parent_fd(), unsafe { entry.file_name_utf8_unchecked() }
, file_type
)?
;
560 pub fn get_hardware_address() -> Result
<String
, Error
> {
562 static FILENAME
: &str = "/etc/ssh/ssh_host_rsa_key.pub";
564 let contents
= file_get_contents(FILENAME
)?
;
565 let digest
= md5
::compute(contents
);
567 Ok(format
!("{:0x}", digest
))
571 pub fn assert_if_modified(digest1
: &str, digest2
: &str) -> Result
<(), Error
> {
572 if digest1
!= digest2
{
573 bail
!("detected modified configuration - file changed by other user? Try again.");
578 /// Extract authentication cookie from cookie header.
579 /// We assume cookie_name is already url encoded.
580 pub fn extract_auth_cookie(cookie
: &str, cookie_name
: &str) -> Option
<String
> {
582 for pair
in cookie
.split('
;'
) {
584 let (name
, value
) = match pair
.find('
='
) {
585 Some(i
) => (pair
[..i
].trim(), pair
[(i
+ 1)..].trim()),
586 None
=> return None
, // Cookie format error
589 if name
== cookie_name
{
590 use url
::percent_encoding
::percent_decode
;
591 if let Ok(value
) = percent_decode(value
.as_bytes()).decode_utf8() {
592 return Some(value
.into());
594 return None
; // Cookie format error
602 pub fn join(data
: &Vec
<String
>, sep
: char) -> String
{
604 let mut list
= String
::new();
607 if list
.len() != 0 { list.push(sep); }
614 /// normalize uri path
616 /// Do not allow ".", "..", or hidden files ".XXXX"
617 /// Also remove empty path components
618 pub fn normalize_uri_path(path
: &str) -> Result
<(String
, Vec
<&str>), Error
> {
620 let items
= path
.split('
/'
);
622 let mut path
= String
::new();
623 let mut components
= vec
![];
626 if name
.is_empty() { continue; }
627 if name
.starts_with(".") {
628 bail
!("Path contains illegal components.");
632 components
.push(name
);
635 Ok((path
, components
))
638 pub fn fd_change_cloexec(fd
: RawFd
, on
: bool
) -> Result
<(), Error
> {
639 use nix
::fcntl
::{fcntl, F_GETFD, F_SETFD, FdFlag}
;
640 let mut flags
= FdFlag
::from_bits(fcntl(fd
, F_GETFD
)?
)
641 .ok_or_else(|| format_err
!("unhandled file flags"))?
; // nix crate is stupid this way...
642 flags
.set(FdFlag
::FD_CLOEXEC
, on
);
643 fcntl(fd
, F_SETFD(flags
))?
;
648 static mut SHUTDOWN_REQUESTED
: bool
= false;
650 pub fn request_shutdown() {
651 unsafe { SHUTDOWN_REQUESTED = true; }
652 crate::server
::server_shutdown();
656 pub fn shutdown_requested() -> bool
{
657 unsafe { SHUTDOWN_REQUESTED }
660 pub fn fail_on_shutdown() -> Result
<(), Error
> {
661 if shutdown_requested() {
662 bail
!("Server shutdown requested - aborting task");
667 /// Guard a raw file descriptor with a drop handler. This is mostly useful when access to an owned
668 /// `RawFd` is required without the corresponding handler object (such as when only the file
669 /// descriptor number is required in a closure which may be dropped instead of being executed).
670 pub struct Fd(pub RawFd
);
682 impl AsRawFd
for Fd
{
683 fn as_raw_fd(&self) -> RawFd
{
688 impl IntoRawFd
for Fd
{
689 fn into_raw_fd(mut self) -> RawFd
{
696 impl FromRawFd
for Fd
{
697 unsafe fn from_raw_fd(fd
: RawFd
) -> Self {
702 // wrap nix::unistd::pipe2 + O_CLOEXEC into something returning guarded file descriptors
703 pub fn pipe() -> Result
<(Fd
, Fd
), Error
> {
704 let (pin
, pout
) = nix
::unistd
::pipe2(nix
::fcntl
::OFlag
::O_CLOEXEC
)?
;
705 Ok((Fd(pin
), Fd(pout
)))
708 /// An easy way to convert types to Any
710 /// Mostly useful to downcast trait objects (see RpcEnvironment).
712 fn as_any(&self) -> &dyn Any
;
715 impl<T
: Any
> AsAny
for T
{
716 fn as_any(&self) -> &dyn Any { self }
720 // /usr/include/linux/fs.h: #define BLKGETSIZE64 _IOR(0x12,114,size_t)
721 // return device size in bytes (u64 *arg)
722 nix
::ioctl_read
!(blkgetsize64
, 0x12, 114, u64);
724 /// Return file or block device size
725 pub fn image_size(path
: &Path
) -> Result
<u64, Error
> {
727 use std
::os
::unix
::fs
::FileTypeExt
;
729 let file
= std
::fs
::File
::open(path
)?
;
730 let metadata
= file
.metadata()?
;
731 let file_type
= metadata
.file_type();
733 if file_type
.is_block_device() {
734 let mut size
: u64 = 0;
735 let res
= unsafe { blkgetsize64(file.as_raw_fd(), &mut size) }
;
737 if let Err(err
) = res
{
738 bail
!("blkgetsize64 failed for {:?} - {}", path
, err
);
741 } else if file_type
.is_file() {
744 bail
!("image size failed - got unexpected file type {:?}", file_type
);