Merge branch 'debian/sid' into debian/experimental

[apt.git] / apt-pkg / contrib / fileutl.h

diff --git a/apt-pkg/contrib/fileutl.h b/apt-pkg/contrib/fileutl.h
index 0f2dd419420cf0d8a4f01459dd7821381634132b..e04f75e2aed57eea283c1aad26c82b1887a0bfdf 100644 (file)
--- a/apt-pkg/contrib/fileutl.h
+++ b/apt-pkg/contrib/fileutl.h
@@ -22,32 +22,53 @@
 #define PKGLIB_FILEUTL_H
 
 #include <apt-pkg/macros.h>
 #define PKGLIB_FILEUTL_H
 
 #include <apt-pkg/macros.h>

+#include <apt-pkg/aptconfiguration.h>

 
 #include <string>
 #include <vector>
 
 #include <string>
 #include <vector>

+#include <set>
+#include <time.h>

 
 #include <zlib.h>
 
 
 #include <zlib.h>
 

+#ifndef APT_8_CLEANER_HEADERS
+using std::string;
+#endif
+

 /* Define this for python-apt */
 #define APT_HAS_GZIP 1
 
 /* Define this for python-apt */
 #define APT_HAS_GZIP 1
 

-using std::string;
-
+class FileFdPrivate;

 class FileFd
 {
    protected:
    int iFd;
  
    enum LocalFlags {AutoClose = (1<<0),Fail = (1<<1),DelOnFail = (1<<2),
 class FileFd
 {
    protected:
    int iFd;
  
    enum LocalFlags {AutoClose = (1<<0),Fail = (1<<1),DelOnFail = (1<<2),

-                    HitEof = (1<<3), Replace = (1<<4) };
+                    HitEof = (1<<3), Replace = (1<<4), Compressed = (1<<5) };

    unsigned long Flags;
    unsigned long Flags;

-   string FileName;
-   string TemporaryFileName;
-   gzFile gz;
+   std::string FileName;
+   std::string TemporaryFileName;

 
    public:
 
    public:

-   enum OpenMode {ReadOnly,WriteEmpty,WriteExists,WriteAny,WriteTemp,ReadOnlyGzip,
-                  WriteAtomic};
+   enum OpenMode {
+       ReadOnly = (1 << 0),
+       WriteOnly = (1 << 1),
+       ReadWrite = ReadOnly | WriteOnly,
+
+       Create = (1 << 2),
+       Exclusive = (1 << 3),
+       Atomic = Exclusive | (1 << 4),
+       Empty = (1 << 5),
+
+       WriteEmpty = ReadWrite | Create | Empty,
+       WriteExists = ReadWrite,
+       WriteAny = ReadWrite | Create,
+       WriteTemp = ReadWrite | Create | Exclusive,
+       ReadOnlyGzip,
+       WriteAtomic = ReadWrite | Create | Atomic
+   };
+   enum CompressMode { Auto = 'A', None = 'N', Extension = 'E', Gzip = 'G', Bzip2 = 'B', Lzma = 'L', Xz = 'X' };

    
    inline bool Read(void *To,unsigned long long Size,bool AllowEof)
    {
    
    inline bool Read(void *To,unsigned long long Size,bool AllowEof)
    {


@@ -57,13 +78,16 @@ class FileFd
       return Read(To,Size);
    }   
    bool Read(void *To,unsigned long long Size,unsigned long long *Actual = 0);
       return Read(To,Size);
    }   
    bool Read(void *To,unsigned long long Size,unsigned long long *Actual = 0);

+   char* ReadLine(char *To, unsigned long long const Size);

    bool Write(const void *From,unsigned long long Size);
    bool Write(const void *From,unsigned long long Size);

+   bool static Write(int Fd, const void *From, unsigned long long Size);

    bool Seek(unsigned long long To);
    bool Skip(unsigned long long To);
    bool Truncate(unsigned long long To);
    unsigned long long Tell();
    unsigned long long Size();
    unsigned long long FileSize();
    bool Seek(unsigned long long To);
    bool Skip(unsigned long long To);
    bool Truncate(unsigned long long To);
    unsigned long long Tell();
    unsigned long long Size();
    unsigned long long FileSize();

+   time_t ModificationTime();

 
    /* You want to use 'unsigned long long' if you are talking about a file
       to be able to support large files (>2 or >4 GB) properly.
 
    /* You want to use 'unsigned long long' if you are talking about a file
       to be able to support large files (>2 or >4 GB) properly.


@@ -71,7 +95,7 @@ class FileFd
       And as the auto-conversation converts a 'unsigned long *' to a 'bool'
       instead of 'unsigned long long *' we need to provide this explicitely -
       otherwise applications magically start to fail… */
       And as the auto-conversation converts a 'unsigned long *' to a 'bool'
       instead of 'unsigned long long *' we need to provide this explicitely -
       otherwise applications magically start to fail… */

-   __deprecated bool Read(void *To,unsigned long long Size,unsigned long *Actual)
+   bool Read(void *To,unsigned long long Size,unsigned long *Actual) APT_DEPRECATED

    {
        unsigned long long R;
        bool const T = Read(To, Size, &R);
    {
        unsigned long long R;
        bool const T = Read(To, Size, &R);


@@ -79,39 +103,73 @@ class FileFd
        return T;
    }
 
        return T;
    }
 

-   bool Open(string FileName,OpenMode Mode,unsigned long Perms = 0666);
-   bool OpenDescriptor(int Fd, OpenMode Mode, bool AutoClose=false);
+   bool Open(std::string FileName,unsigned int const Mode,CompressMode Compress,unsigned long const AccessMode = 0666);
+   bool Open(std::string FileName,unsigned int const Mode,APT::Configuration::Compressor const &compressor,unsigned long const AccessMode = 0666);
+   inline bool Open(std::string const &FileName,unsigned int const Mode, unsigned long const AccessMode = 0666) {
+      return Open(FileName, Mode, None, AccessMode);
+   };
+   bool OpenDescriptor(int Fd, unsigned int const Mode, CompressMode Compress, bool AutoClose=false);
+   bool OpenDescriptor(int Fd, unsigned int const Mode, APT::Configuration::Compressor const &compressor, bool AutoClose=false);
+   inline bool OpenDescriptor(int Fd, unsigned int const Mode, bool AutoClose=false) {
+      return OpenDescriptor(Fd, Mode, None, AutoClose);
+   };

    bool Close();
    bool Sync();
    
    // Simple manipulators
    inline int Fd() {return iFd;};
    bool Close();
    bool Sync();
    
    // Simple manipulators
    inline int Fd() {return iFd;};

-   inline void Fd(int fd) {iFd = fd;};
-   inline gzFile gzFd() {return gz;};
+   inline void Fd(int fd) { OpenDescriptor(fd, ReadWrite);};
+   gzFile gzFd() APT_DEPRECATED APT_PURE;
+

    inline bool IsOpen() {return iFd >= 0;};
    inline bool Failed() {return (Flags & Fail) == Fail;};
    inline void EraseOnFailure() {Flags |= DelOnFail;};
    inline void OpFail() {Flags |= Fail;};
    inline bool Eof() {return (Flags & HitEof) == HitEof;};
    inline bool IsOpen() {return iFd >= 0;};
    inline bool Failed() {return (Flags & Fail) == Fail;};
    inline void EraseOnFailure() {Flags |= DelOnFail;};
    inline void OpFail() {Flags |= Fail;};
    inline bool Eof() {return (Flags & HitEof) == HitEof;};

-   inline string &Name() {return FileName;};
+   inline bool IsCompressed() {return (Flags & Compressed) == Compressed;};
+   inline std::string &Name() {return FileName;};

    
    

-   FileFd(string FileName,OpenMode Mode,unsigned long Perms = 0666) : iFd(-1), 
-            Flags(0), gz(NULL)
+   FileFd(std::string FileName,unsigned int const Mode,unsigned long AccessMode = 0666) : iFd(-1), Flags(0), d(NULL)
+   {
+      Open(FileName,Mode, None, AccessMode);
+   };
+   FileFd(std::string FileName,unsigned int const Mode, CompressMode Compress, unsigned long AccessMode = 0666) : iFd(-1), Flags(0), d(NULL)
+   {
+      Open(FileName,Mode, Compress, AccessMode);
+   };
+   FileFd() : iFd(-1), Flags(AutoClose), d(NULL) {};
+   FileFd(int const Fd, unsigned int const Mode = ReadWrite, CompressMode Compress = None) : iFd(-1), Flags(0), d(NULL)

    {
    {

-      Open(FileName,Mode,Perms);
+      OpenDescriptor(Fd, Mode, Compress);
+   };
+   FileFd(int const Fd, bool const AutoClose) : iFd(-1), Flags(0), d(NULL)
+   {
+      OpenDescriptor(Fd, ReadWrite, None, AutoClose);

    };
    };

-   FileFd(int Fd = -1) : iFd(Fd), Flags(AutoClose), gz(NULL) {};
-   FileFd(int Fd,bool) : iFd(Fd), Flags(0), gz(NULL) {};

    virtual ~FileFd();
    virtual ~FileFd();

+
+   private:
+   FileFdPrivate* d;
+   APT_HIDDEN bool OpenInternDescriptor(unsigned int const Mode, APT::Configuration::Compressor const &compressor);
+
+   // private helpers to set Fail flag and call _error->Error
+   APT_HIDDEN bool FileFdErrno(const char* Function, const char* Description,...) APT_PRINTF(3) APT_COLD;
+   APT_HIDDEN bool FileFdError(const char* Description,...) APT_PRINTF(2) APT_COLD;

 };
 
 bool RunScripts(const char *Cnf);
 bool CopyFile(FileFd &From,FileFd &To);
 };
 
 bool RunScripts(const char *Cnf);
 bool CopyFile(FileFd &From,FileFd &To);

-int GetLock(string File,bool Errors = true);
-bool FileExists(string File);
-bool RealFileExists(string File);
-bool DirectoryExists(string const &Path) __attrib_const;
-bool CreateDirectory(string const &Parent, string const &Path);
+int GetLock(std::string File,bool Errors = true);
+bool FileExists(std::string File);
+bool RealFileExists(std::string File);
+bool DirectoryExists(std::string const &Path) APT_CONST;
+bool CreateDirectory(std::string const &Parent, std::string const &Path);
+time_t GetModificationTime(std::string const &Path);
+bool Rename(std::string From, std::string To);
+
+std::string GetTempDir();
+FileFd* GetTempFile(std::string const &Prefix = "", 
+                    bool ImmediateUnlink = true);

 
 /** \brief Ensure the existence of the given Path
  *
 
 /** \brief Ensure the existence of the given Path
  *


@@ -119,24 +177,53 @@ bool CreateDirectory(string const &Parent, string const &Path);
  *  /apt/ will be removed before CreateDirectory call.
  *  \param Path which should exist after (successful) call
  */
  *  /apt/ will be removed before CreateDirectory call.
  *  \param Path which should exist after (successful) call
  */

-bool CreateAPTDirectoryIfNeeded(string const &Parent, string const &Path);
+bool CreateAPTDirectoryIfNeeded(std::string const &Parent, std::string const &Path);

 
 

-std::vector<string> GetListOfFilesInDir(string const &Dir, string const &Ext,
+std::vector<std::string> GetListOfFilesInDir(std::string const &Dir, std::string const &Ext,

                                        bool const &SortList, bool const &AllowNoExt=false);
                                        bool const &SortList, bool const &AllowNoExt=false);

-std::vector<string> GetListOfFilesInDir(string const &Dir, std::vector<string> const &Ext,
+std::vector<std::string> GetListOfFilesInDir(std::string const &Dir, std::vector<std::string> const &Ext,

                                        bool const &SortList);
                                        bool const &SortList);

-string SafeGetCWD();
+std::vector<std::string> GetListOfFilesInDir(std::string const &Dir, bool SortList);
+std::string SafeGetCWD();

 void SetCloseExec(int Fd,bool Close);
 void SetNonBlock(int Fd,bool Block);
 bool WaitFd(int Fd,bool write = false,unsigned long timeout = 0);
 pid_t ExecFork();
 void SetCloseExec(int Fd,bool Close);
 void SetNonBlock(int Fd,bool Block);
 bool WaitFd(int Fd,bool write = false,unsigned long timeout = 0);
 pid_t ExecFork();

+pid_t ExecFork(std::set<int> keep_fds);
+void MergeKeepFdsFromConfiguration(std::set<int> &keep_fds);

 bool ExecWait(pid_t Pid,const char *Name,bool Reap = false);
 
 bool ExecWait(pid_t Pid,const char *Name,bool Reap = false);
 

+
+// check if the given file starts with a PGP cleartext signature
+bool StartsWithGPGClearTextSignature(std::string const &FileName);
+
+// process releated
+bool DropPrivs();
+

 // File string manipulators
 // File string manipulators

-string flNotDir(string File);
-string flNotFile(string File);
-string flNoLink(string File);
-string flExtension(string File);
-string flCombine(string Dir,string File);
+std::string flNotDir(std::string File);
+std::string flNotFile(std::string File);
+std::string flNoLink(std::string File);
+std::string flExtension(std::string File);
+std::string flCombine(std::string Dir,std::string File);
+
+/** \brief Takes a file path and returns the absolute path
+ */
+std::string flAbsPath(std::string File);
+
+// simple c++ glob
+std::vector<std::string> Glob(std::string const &pattern, int flags=0);
+
+/** \brief Popen() implementation that execv() instead of using a shell
+ *
+ * \param Args the execv style command to run
+ * \param FileFd is a referenz to the FileFd to use for input or output
+ * \param Child a reference to the integer that stores the child pid
+ *        Note that you must call ExecWait() or similar to cleanup
+ * \param Mode is either FileFd::ReadOnly or FileFd::WriteOnly
+ * \return true on success, false on failure with _error set
+ */
+bool Popen(const char* Args[], FileFd &Fd, pid_t &Child, FileFd::OpenMode Mode);
+

 
 #endif
 
 #endif