apt-pkg/contrib/fileutl.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: fileutl.h,v 1.26 2001/05/07 05:06:52 jgg Exp $
   4 /* ######################################################################
   5
   6    File Utilities
   7
   8    CopyFile - Buffered copy of a single file
   9    GetLock - dpkg compatible lock file manipulation (fcntl)
  10    FileExists - Returns true if the file exists
  11    SafeGetCWD - Returns the CWD in a string with overrun protection
  12
  13    The file class is a handy abstraction for various functions+classes
  14    that need to accept filenames.
  15
  16    This source is placed in the Public Domain, do with it what you will
  17    It was originally written by Jason Gunthorpe.
  18
  19    ##################################################################### */
  20                                                                         /*}}}*/
  21 #ifndef PKGLIB_FILEUTL_H
  22 #define PKGLIB_FILEUTL_H
  23
  24 #include <apt-pkg/macros.h>
  25
  26 #include <string>
  27 #include <vector>
  28
  29 #include <zlib.h>
  30
  31 /* Define this for python-apt */
  32 #define APT_HAS_GZIP 1
  33
  34 using std::string;
  35
  36 class FileFd
  37 {
  38    protected:
  39    int iFd;
  40
  41    enum LocalFlags {AutoClose = (1<<0),Fail = (1<<1),DelOnFail = (1<<2),
  42                     HitEof = (1<<3), Replace = (1<<4) };
  43    unsigned long Flags;
  44    string FileName;
  45    string TemporaryFileName;
  46    gzFile gz;
  47
  48    public:
  49    enum OpenMode {ReadOnly,WriteEmpty,WriteExists,WriteAny,WriteTemp,ReadOnlyGzip,
  50                   WriteAtomic};
  51
  52    inline bool Read(void *To,unsigned long Size,bool AllowEof)
  53    {
  54       unsigned long Jnk;
  55       if (AllowEof)
  56          return Read(To,Size,&Jnk);
  57       return Read(To,Size);
  58    }
  59    bool Read(void *To,unsigned long Size,unsigned long *Actual = 0);
  60    bool Write(const void *From,unsigned long Size);
  61    bool Seek(unsigned long To);
  62    bool Skip(unsigned long To);
  63    bool Truncate(unsigned long To);
  64    unsigned long Tell();
  65    unsigned long Size();
  66    unsigned long FileSize();
  67    bool Open(string FileName,OpenMode Mode,unsigned long Perms = 0666);
  68    bool OpenDescriptor(int Fd, OpenMode Mode, bool AutoClose=false);
  69    bool Close();
  70    bool Sync();
  71
  72    // Simple manipulators
  73    inline int Fd() {return iFd;};
  74    inline void Fd(int fd) {iFd = fd;};
  75    inline gzFile gzFd() {return gz;};
  76    inline bool IsOpen() {return iFd >= 0;};
  77    inline bool Failed() {return (Flags & Fail) == Fail;};
  78    inline void EraseOnFailure() {Flags |= DelOnFail;};
  79    inline void OpFail() {Flags |= Fail;};
  80    inline bool Eof() {return (Flags & HitEof) == HitEof;};
  81    inline string &Name() {return FileName;};
  82
  83    FileFd(string FileName,OpenMode Mode,unsigned long Perms = 0666) : iFd(-1),
  84             Flags(0), gz(NULL)
  85    {
  86       Open(FileName,Mode,Perms);
  87    };
  88    FileFd(int Fd = -1) : iFd(Fd), Flags(AutoClose), gz(NULL) {};
  89    FileFd(int Fd,bool) : iFd(Fd), Flags(0), gz(NULL) {};
  90    virtual ~FileFd();
  91 };
  92
  93 bool RunScripts(const char *Cnf);
  94 bool CopyFile(FileFd &From,FileFd &To);
  95 int GetLock(string File,bool Errors = true);
  96 bool FileExists(string File);
  97 bool RealFileExists(string File);
  98 bool DirectoryExists(string const &Path) __attrib_const;
  99 bool CreateDirectory(string const &Parent, string const &Path);
 100
 101 /** \brief Ensure the existence of the given Path
 102  *
 103  *  \param Parent directory of the Path directory - a trailing
 104  *  /apt/ will be removed before CreateDirectory call.
 105  *  \param Path which should exist after (successful) call
 106  */
 107 bool CreateAPTDirectoryIfNeeded(string const &Parent, string const &Path);
 108
 109 std::vector<string> GetListOfFilesInDir(string const &Dir, string const &Ext,
 110                                         bool const &SortList, bool const &AllowNoExt=false);
 111 std::vector<string> GetListOfFilesInDir(string const &Dir, std::vector<string> const &Ext,
 112                                         bool const &SortList);
 113 string SafeGetCWD();
 114 void SetCloseExec(int Fd,bool Close);
 115 void SetNonBlock(int Fd,bool Block);
 116 bool WaitFd(int Fd,bool write = false,unsigned long timeout = 0);
 117 pid_t ExecFork();
 118 bool ExecWait(pid_t Pid,const char *Name,bool Reap = false);
 119
 120 // File string manipulators
 121 string flNotDir(string File);
 122 string flNotFile(string File);
 123 string flNoLink(string File);
 124 string flExtension(string File);
 125 string flCombine(string Dir,string File);
 126
 127 #endif