2003-04-04 18:14:56 +02:00
|
|
|
#ifndef __UTIL_H
|
|
|
|
#define __UTIL_H
|
|
|
|
|
2006-09-04 23:06:23 +02:00
|
|
|
#include "types.hh"
|
2003-04-08 14:00:51 +02:00
|
|
|
|
2003-10-22 12:48:22 +02:00
|
|
|
#include <sys/types.h>
|
|
|
|
#include <dirent.h>
|
2003-04-08 14:00:51 +02:00
|
|
|
#include <unistd.h>
|
2004-01-15 21:23:55 +01:00
|
|
|
#include <signal.h>
|
2003-04-08 14:00:51 +02:00
|
|
|
|
2003-06-27 15:55:12 +02:00
|
|
|
|
2006-09-04 23:06:23 +02:00
|
|
|
namespace nix {
|
2003-10-07 16:37:41 +02:00
|
|
|
|
|
|
|
|
2004-05-12 11:35:51 +02:00
|
|
|
/* Return an environment variable. */
|
|
|
|
string getEnv(const string & key, const string & def = "");
|
|
|
|
|
2003-06-16 15:33:38 +02:00
|
|
|
/* Return an absolutized path, resolving paths relative to the
|
2003-07-07 11:25:26 +02:00
|
|
|
specified directory, or the current directory otherwise. The path
|
|
|
|
is also canonicalised. */
|
2003-10-07 16:37:41 +02:00
|
|
|
Path absPath(Path path, Path dir = "");
|
2003-06-16 15:33:38 +02:00
|
|
|
|
2004-03-27 18:58:04 +01:00
|
|
|
/* Canonicalise a path by removing all `.' or `..' components and
|
2006-01-08 18:16:03 +01:00
|
|
|
double or trailing slashes. Optionally resolves all symlink
|
|
|
|
components such that each component of the resulting path is *not*
|
|
|
|
a symbolic link. */
|
|
|
|
Path canonPath(const Path & path, bool resolveSymlinks = false);
|
2003-07-07 11:25:26 +02:00
|
|
|
|
2004-03-27 18:58:04 +01:00
|
|
|
/* Return the directory part of the given canonical path, i.e.,
|
|
|
|
everything before the final `/'. If the path is the root or an
|
|
|
|
immediate child thereof (e.g., `/foo'), this means an empty string
|
|
|
|
is returned. */
|
2003-10-07 16:37:41 +02:00
|
|
|
Path dirOf(const Path & path);
|
2003-06-16 15:33:38 +02:00
|
|
|
|
2004-03-27 18:58:04 +01:00
|
|
|
/* Return the base name of the given canonical path, i.e., everything
|
|
|
|
following the final `/'. */
|
2003-10-07 16:37:41 +02:00
|
|
|
string baseNameOf(const Path & path);
|
2003-04-08 14:00:51 +02:00
|
|
|
|
2003-07-08 15:22:08 +02:00
|
|
|
/* Return true iff the given path exists. */
|
2003-10-07 16:37:41 +02:00
|
|
|
bool pathExists(const Path & path);
|
2003-04-08 14:00:51 +02:00
|
|
|
|
2004-01-05 17:26:43 +01:00
|
|
|
/* Read the contents (target) of a symbolic link. The result is not
|
|
|
|
in any way canonicalised. */
|
|
|
|
Path readLink(const Path & path);
|
|
|
|
|
2005-02-01 14:48:46 +01:00
|
|
|
bool isLink(const Path & path);
|
|
|
|
|
2003-11-19 18:27:16 +01:00
|
|
|
/* Read the contents of a directory. The entries `.' and `..' are
|
|
|
|
removed. */
|
|
|
|
Strings readDirectory(const Path & path);
|
|
|
|
|
2005-02-01 23:07:48 +01:00
|
|
|
/* Read the contents of a file into a string. */
|
|
|
|
string readFile(int fd);
|
|
|
|
string readFile(const Path & path);
|
|
|
|
|
2005-02-09 10:50:29 +01:00
|
|
|
/* Write a string to a file. */
|
|
|
|
void writeFile(const Path & path, const string & s);
|
|
|
|
|
2006-11-24 21:24:14 +01:00
|
|
|
/* Compute the sum of the sizes of all files in `path'. */
|
|
|
|
unsigned long long computePathSize(const Path & path);
|
|
|
|
|
2003-06-23 16:40:49 +02:00
|
|
|
/* Delete a path; i.e., in the case of a directory, it is deleted
|
2005-12-15 22:11:39 +01:00
|
|
|
recursively. Don't use this at home, kids. The second variant
|
|
|
|
returns the number of bytes freed. */
|
2003-10-07 16:37:41 +02:00
|
|
|
void deletePath(const Path & path);
|
2003-08-22 22:12:44 +02:00
|
|
|
|
2005-12-15 22:11:39 +01:00
|
|
|
void deletePath(const Path & path, unsigned long long & bytesFreed);
|
|
|
|
|
2003-08-22 22:12:44 +02:00
|
|
|
/* Make a path read-only recursively. */
|
2003-10-07 16:37:41 +02:00
|
|
|
void makePathReadOnly(const Path & path);
|
2003-06-23 16:40:49 +02:00
|
|
|
|
2003-10-02 13:55:38 +02:00
|
|
|
/* Create a temporary directory. */
|
2003-10-07 16:37:41 +02:00
|
|
|
Path createTempDir();
|
2003-10-02 13:55:38 +02:00
|
|
|
|
2005-03-24 18:46:38 +01:00
|
|
|
/* Create a directory and all its parents, if necessary. */
|
|
|
|
void createDirs(const Path & path);
|
|
|
|
|
2003-11-22 16:58:34 +01:00
|
|
|
/* Create a file and write the given text to it. The file is written
|
|
|
|
in binary mode (i.e., no end-of-line conversions). The path should
|
|
|
|
not already exist. */
|
|
|
|
void writeStringToFile(const Path & path, const string & s);
|
|
|
|
|
2005-02-11 17:56:45 +01:00
|
|
|
template<class T, class A>
|
|
|
|
T singleton(const A & a)
|
|
|
|
{
|
|
|
|
T t;
|
|
|
|
t.insert(a);
|
|
|
|
return t;
|
|
|
|
}
|
|
|
|
|
2003-06-23 16:40:49 +02:00
|
|
|
|
2003-07-04 14:18:06 +02:00
|
|
|
/* Messages. */
|
|
|
|
|
2004-03-22 21:53:49 +01:00
|
|
|
|
|
|
|
typedef enum {
|
|
|
|
ltPretty, /* nice, nested output */
|
|
|
|
ltEscapes, /* nesting indicated using escape codes (for log2xml) */
|
|
|
|
ltFlat /* no nesting */
|
|
|
|
} LogType;
|
|
|
|
|
|
|
|
extern LogType logType;
|
|
|
|
extern Verbosity verbosity; /* suppress msgs > this */
|
2003-07-24 10:53:43 +02:00
|
|
|
|
2003-07-04 14:18:06 +02:00
|
|
|
class Nest
|
|
|
|
{
|
|
|
|
private:
|
|
|
|
bool nest;
|
|
|
|
public:
|
2003-11-09 11:35:45 +01:00
|
|
|
Nest();
|
2003-07-04 14:18:06 +02:00
|
|
|
~Nest();
|
2003-11-09 11:35:45 +01:00
|
|
|
void open(Verbosity level, const format & f);
|
2004-03-22 22:42:28 +01:00
|
|
|
void close();
|
2003-07-04 14:18:06 +02:00
|
|
|
};
|
|
|
|
|
2003-11-09 11:35:45 +01:00
|
|
|
void printMsg_(Verbosity level, const format & f);
|
|
|
|
|
|
|
|
#define startNest(varName, level, f) \
|
|
|
|
Nest varName; \
|
|
|
|
if (level <= verbosity) { \
|
|
|
|
varName.open(level, (f)); \
|
|
|
|
}
|
|
|
|
|
|
|
|
#define printMsg(level, f) \
|
|
|
|
do { \
|
|
|
|
if (level <= verbosity) { \
|
|
|
|
printMsg_(level, (f)); \
|
|
|
|
} \
|
|
|
|
} while (0)
|
|
|
|
|
|
|
|
#define debug(f) printMsg(lvlDebug, f)
|
2003-05-26 00:42:19 +02:00
|
|
|
|
2006-08-29 17:29:38 +02:00
|
|
|
void warnOnce(bool & haveWarned, const format & f);
|
|
|
|
|
2003-05-26 00:42:19 +02:00
|
|
|
|
2003-07-20 23:11:43 +02:00
|
|
|
/* Wrappers arount read()/write() that read/write exactly the
|
|
|
|
requested number of bytes. */
|
|
|
|
void readFull(int fd, unsigned char * buf, size_t count);
|
|
|
|
void writeFull(int fd, const unsigned char * buf, size_t count);
|
|
|
|
|
|
|
|
|
2006-07-20 14:17:25 +02:00
|
|
|
/* Read a file descriptor until EOF occurs. */
|
|
|
|
string drainFD(int fd);
|
|
|
|
|
|
|
|
|
|
|
|
|
2003-10-22 12:48:22 +02:00
|
|
|
/* Automatic cleanup of resources. */
|
|
|
|
|
|
|
|
class AutoDelete
|
|
|
|
{
|
|
|
|
string path;
|
|
|
|
bool del;
|
|
|
|
public:
|
|
|
|
AutoDelete(const string & p);
|
|
|
|
~AutoDelete();
|
|
|
|
void cancel();
|
|
|
|
};
|
|
|
|
|
2004-06-22 11:51:44 +02:00
|
|
|
|
2003-10-22 12:48:22 +02:00
|
|
|
class AutoCloseFD
|
|
|
|
{
|
|
|
|
int fd;
|
|
|
|
public:
|
|
|
|
AutoCloseFD();
|
|
|
|
AutoCloseFD(int fd);
|
2005-01-31 11:27:25 +01:00
|
|
|
AutoCloseFD(const AutoCloseFD & fd);
|
2003-10-22 12:48:22 +02:00
|
|
|
~AutoCloseFD();
|
|
|
|
void operator =(int fd);
|
2005-01-31 11:27:25 +01:00
|
|
|
operator int() const;
|
2004-06-15 15:49:42 +02:00
|
|
|
void close();
|
|
|
|
bool isOpen();
|
2005-01-27 13:19:25 +01:00
|
|
|
int borrow();
|
2004-06-15 15:49:42 +02:00
|
|
|
};
|
|
|
|
|
2004-06-22 11:51:44 +02:00
|
|
|
|
2004-06-15 15:49:42 +02:00
|
|
|
class Pipe
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
AutoCloseFD readSide, writeSide;
|
|
|
|
void create();
|
2003-10-22 12:48:22 +02:00
|
|
|
};
|
|
|
|
|
2004-06-22 11:51:44 +02:00
|
|
|
|
2003-10-22 12:48:22 +02:00
|
|
|
class AutoCloseDir
|
|
|
|
{
|
|
|
|
DIR * dir;
|
|
|
|
public:
|
|
|
|
AutoCloseDir();
|
|
|
|
AutoCloseDir(DIR * dir);
|
|
|
|
~AutoCloseDir();
|
|
|
|
void operator =(DIR * dir);
|
|
|
|
operator DIR *();
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2004-06-22 11:51:44 +02:00
|
|
|
class Pid
|
|
|
|
{
|
|
|
|
pid_t pid;
|
|
|
|
bool separatePG;
|
|
|
|
public:
|
|
|
|
Pid();
|
|
|
|
~Pid();
|
|
|
|
void operator =(pid_t pid);
|
|
|
|
operator pid_t();
|
|
|
|
void kill();
|
|
|
|
int wait(bool block);
|
|
|
|
void setSeparatePG(bool separatePG);
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2006-07-20 14:17:25 +02:00
|
|
|
/* Run a program and return its stdout in a string (i.e., like the
|
|
|
|
shell backtick operator). */
|
|
|
|
string runProgram(Path program);
|
|
|
|
|
|
|
|
/* Wrapper around _exit() on Unix and ExitProcess() on Windows. (On
|
|
|
|
Cygwin, _exit() doesn't seem to do the right thing.) */
|
|
|
|
void quickExit(int status);
|
|
|
|
|
|
|
|
|
2004-01-15 21:23:55 +01:00
|
|
|
/* User interruption. */
|
|
|
|
|
|
|
|
extern volatile sig_atomic_t _isInterrupted;
|
|
|
|
|
|
|
|
void _interrupted();
|
|
|
|
|
|
|
|
void inline checkInterrupt()
|
|
|
|
{
|
|
|
|
if (_isInterrupted) _interrupted();
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2004-06-20 15:37:51 +02:00
|
|
|
/* String packing / unpacking. */
|
|
|
|
string packStrings(const Strings & strings);
|
|
|
|
Strings unpackStrings(const string & s);
|
|
|
|
|
|
|
|
|
2005-09-22 17:43:22 +02:00
|
|
|
/* String tokenizer. */
|
|
|
|
Strings tokenizeString(const string & s, const string & separators = " \t\n\r");
|
|
|
|
|
|
|
|
|
2004-06-22 10:50:25 +02:00
|
|
|
/* Convert the exit status of a child as returned by wait() into an
|
|
|
|
error string. */
|
|
|
|
string statusToString(int status);
|
|
|
|
|
2004-06-22 13:03:41 +02:00
|
|
|
bool statusOk(int status);
|
|
|
|
|
2004-06-22 10:50:25 +02:00
|
|
|
|
2004-09-10 15:32:08 +02:00
|
|
|
/* Parse a string into an integer. */
|
2006-08-26 18:48:01 +02:00
|
|
|
string int2String(int n);
|
2004-09-10 15:32:08 +02:00
|
|
|
bool string2Int(const string & s, int & n);
|
|
|
|
|
|
|
|
|
2006-09-05 00:55:28 +02:00
|
|
|
/* Setuid support. */
|
2004-09-09 23:12:53 +02:00
|
|
|
struct SwitchToOriginalUser
|
|
|
|
{
|
|
|
|
SwitchToOriginalUser();
|
|
|
|
~SwitchToOriginalUser();
|
|
|
|
};
|
|
|
|
|
2006-09-05 00:55:28 +02:00
|
|
|
void switchToNixUser();
|
|
|
|
|
2006-09-04 23:06:23 +02:00
|
|
|
|
|
|
|
}
|
|
|
|
|
2004-09-09 23:12:53 +02:00
|
|
|
|
2003-04-04 18:14:56 +02:00
|
|
|
#endif /* !__UTIL_H */
|