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 class FileFd
  35 {
  36    protected:
  37    int iFd;
  38
  39    enum LocalFlags {AutoClose = (1<<0),Fail = (1<<1),DelOnFail = (1<<2),
  40                     HitEof = (1<<3), Replace = (1<<4) };
  41    unsigned long Flags;
  42    std::string FileName;
  43    std::string TemporaryFileName;
  44    gzFile gz;
  45
  46    public:
  47    enum OpenMode {ReadOnly,WriteEmpty,WriteExists,WriteAny,WriteTemp,ReadOnlyGzip,
  48                   WriteAtomic};
  49
  50    inline bool Read(void *To,unsigned long long Size,bool AllowEof)
  51    {
  52       unsigned long long Jnk;
  53       if (AllowEof)
  54          return Read(To,Size,&Jnk);
  55       return Read(To,Size);
  56    }
  57    bool Read(void *To,unsigned long long Size,unsigned long long *Actual = 0);
  58    bool Write(const void *From,unsigned long long Size);
  59    bool Seek(unsigned long long To);
  60    bool Skip(unsigned long long To);
  61    bool Truncate(unsigned long long To);
  62    unsigned long long Tell();
  63    unsigned long long Size();
  64    unsigned long long FileSize();
  65
  66    /* You want to use 'unsigned long long' if you are talking about a file
  67       to be able to support large files (>2 or >4 GB) properly.
  68       This shouldn't happen all to often for the indexes, but deb's might be…
  69       And as the auto-conversation converts a 'unsigned long *' to a 'bool'
  70       instead of 'unsigned long long *' we need to provide this explicitely -
  71       otherwise applications magically start to fail… */
  72    __deprecated bool Read(void *To,unsigned long long Size,unsigned long *Actual)
  73    {
  74         unsigned long long R;
  75         bool const T = Read(To, Size, &R);
  76         *Actual = R;
  77         return T;
  78    }
  79
  80    bool Open(std::string FileName,OpenMode Mode,unsigned long Perms = 0666);
  81    bool OpenDescriptor(int Fd, OpenMode Mode, bool AutoClose=false);
  82    bool Close();
  83    bool Sync();
  84
  85    // Simple manipulators
  86    inline int Fd() {return iFd;};
  87    inline void Fd(int fd) {iFd = fd;};
  88    inline gzFile gzFd() {return gz;};
  89    inline bool IsOpen() {return iFd >= 0;};
  90    inline bool Failed() {return (Flags & Fail) == Fail;};
  91    inline void EraseOnFailure() {Flags |= DelOnFail;};
  92    inline void OpFail() {Flags |= Fail;};
  93    inline bool Eof() {return (Flags & HitEof) == HitEof;};
  94    inline std::string &Name() {return FileName;};
  95
  96    FileFd(std::string FileName,OpenMode Mode,unsigned long Perms = 0666) : iFd(-1),
  97             Flags(0), gz(NULL)
  98    {
  99       Open(FileName,Mode,Perms);
 100    };
 101    FileFd(int Fd = -1) : iFd(Fd), Flags(AutoClose), gz(NULL) {};
 102    FileFd(int Fd,bool) : iFd(Fd), Flags(0), gz(NULL) {};
 103    virtual ~FileFd();
 104 };
 105
 106 bool RunScripts(const char *Cnf);
 107 bool CopyFile(FileFd &From,FileFd &To);
 108 int GetLock(std::string File,bool Errors = true);
 109 bool FileExists(std::string File);
 110 bool RealFileExists(std::string File);
 111 bool DirectoryExists(std::string const &Path) __attrib_const;
 112 bool CreateDirectory(std::string const &Parent, std::string const &Path);
 113 time_t GetModificationTime(std::string const &Path);
 114
 115 /** \brief Ensure the existence of the given Path
 116  *
 117  *  \param Parent directory of the Path directory - a trailing
 118  *  /apt/ will be removed before CreateDirectory call.
 119  *  \param Path which should exist after (successful) call
 120  */
 121 bool CreateAPTDirectoryIfNeeded(std::string const &Parent, std::string const &Path);
 122
 123 std::vector<std::string> GetListOfFilesInDir(std::string const &Dir, std::string const &Ext,
 124                                         bool const &SortList, bool const &AllowNoExt=false);
 125 std::vector<std::string> GetListOfFilesInDir(std::string const &Dir, std::vector<std::string> const &Ext,
 126                                         bool const &SortList);
 127 std::string SafeGetCWD();
 128 void SetCloseExec(int Fd,bool Close);
 129 void SetNonBlock(int Fd,bool Block);
 130 bool WaitFd(int Fd,bool write = false,unsigned long timeout = 0);
 131 pid_t ExecFork();
 132 bool ExecWait(pid_t Pid,const char *Name,bool Reap = false);
 133
 134 // File string manipulators
 135 std::string flNotDir(std::string File);
 136 std::string flNotFile(std::string File);
 137 std::string flNoLink(std::string File);
 138 std::string flExtension(std::string File);
 139 std::string flCombine(std::string Dir,std::string File);
 140
 141 #endif