test/integration/test-ubuntu-bug-346386-apt-get-update-paywall: use downloadfile()

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

diff --git a/apt-pkg/contrib/fileutl.h b/apt-pkg/contrib/fileutl.h
index 7a72df09f670c80b4a787fbfaea80fae5466f5ee..cc1a98eae02c227b47962dff72421baf0e3f5e6d 100644 (file)
--- a/apt-pkg/contrib/fileutl.h
+++ b/apt-pkg/contrib/fileutl.h
@@ -1,6 +1,6 @@
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/

-// $Id: fileutl.h,v 1.7 1998/10/20 02:39:29 jgg Exp $
+// $Id: fileutl.h,v 1.26 2001/05/07 05:06:52 jgg Exp $

 /* ######################################################################
    
    File Utilities
 /* ######################################################################
    
    File Utilities


@@ -18,56 +18,187 @@
    
    ##################################################################### */
                                                                        /*}}}*/
    
    ##################################################################### */
                                                                        /*}}}*/

-// Header section: pkglib

 #ifndef PKGLIB_FILEUTL_H
 #define PKGLIB_FILEUTL_H
 
 #ifndef PKGLIB_FILEUTL_H
 #define PKGLIB_FILEUTL_H
 

-#ifdef __GNUG__
-#pragma interface "apt-pkg/fileutl.h"
-#endif 
+#include <apt-pkg/macros.h>
+#include <apt-pkg/aptconfiguration.h>

 
 #include <string>
 
 #include <string>

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

 
 

+#include <zlib.h>
+
+#ifndef APT_8_CLEANER_HEADERS
+using std::string;
+#endif
+
+/* Define this for python-apt */
+#define APT_HAS_GZIP 1
+
+class FileFdPrivate;

 class FileFd
 {
    protected:
    int iFd;
  
 class FileFd
 {
    protected:
    int iFd;
  

-   enum LocalFlags {AutoClose = (1<<0),Fail = (1<<1),DelOnFail = (1<<2)};
+   enum LocalFlags {AutoClose = (1<<0),Fail = (1<<1),DelOnFail = (1<<2),
+                    HitEof = (1<<3), Replace = (1<<4), Compressed = (1<<5) };

    unsigned long Flags;
    unsigned long Flags;

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

    public:
    public:

-   enum OpenMode {ReadOnly,WriteEmpty,WriteExists,WriteAny,LockEmpty};
+   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' };

    
    

-   bool Read(void *To,unsigned long Size);
-   bool Write(void *From,unsigned long Size);
-   bool Seek(unsigned long To);
-   unsigned long Size();
-   bool Close();
+   inline bool Read(void *To,unsigned long long Size,bool AllowEof)
+   {
+      unsigned long long Jnk;
+      if (AllowEof)
+        return Read(To,Size,&Jnk);
+      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 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();
+   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.
+      This shouldn't happen all to often for the indexes, but deb's might be…
+      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… */
+   bool Read(void *To,unsigned long long Size,unsigned long *Actual) APT_DEPRECATED
+   {
+       unsigned long long R;
+       bool const T = Read(To, Size, &R);
+       *Actual = R;
+       return T;
+   }

 
 

+   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;};
    // Simple manipulators
    inline int Fd() {return iFd;};

+   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 IsOpen() {return iFd >= 0;};
    inline bool Failed() {return (Flags & Fail) == Fail;};
    inline void EraseOnFailure() {Flags |= DelOnFail;};
    inline void OpFail() {Flags |= Fail;};

-      
-   FileFd(string FileName,OpenMode Mode,unsigned long Perms = 0666);
-   FileFd(int Fd) : iFd(Fd), Flags(AutoClose) {};
-   FileFd(int Fd,bool) : iFd(Fd), Flags(0) {};
+   inline bool Eof() {return (Flags & HitEof) == HitEof;};
+   inline bool IsCompressed() {return (Flags & Compressed) == Compressed;};
+   inline std::string &Name() {return FileName;};
+   
+   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)
+   {
+      OpenDescriptor(Fd, Mode, Compress);
+   };
+   FileFd(int const Fd, bool const AutoClose) : iFd(-1), Flags(0), d(NULL)
+   {
+      OpenDescriptor(Fd, ReadWrite, None, AutoClose);
+   };

    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 CopyFile(FileFd From,FileFd To);
-int GetLock(string File,bool Errors = true);
-bool FileExists(string File);
-string SafeGetCWD();
+bool RunScripts(const char *Cnf);
+bool CopyFile(FileFd &From,FileFd &To);
+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();
+
+/** \brief Ensure the existence of the given Path
+ *
+ *  \param Parent directory of the Path directory - a trailing
+ *  /apt/ will be removed before CreateDirectory call.
+ *  \param Path which should exist after (successful) call
+ */
+bool CreateAPTDirectoryIfNeeded(std::string const &Parent, std::string const &Path);
+
+std::vector<std::string> GetListOfFilesInDir(std::string const &Dir, std::string const &Ext,
+                                       bool const &SortList, bool const &AllowNoExt=false);
+std::vector<std::string> GetListOfFilesInDir(std::string const &Dir, std::vector<std::string> const &Ext,
+                                       bool const &SortList);
+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);
 void SetCloseExec(int Fd,bool Close);
 void SetNonBlock(int Fd,bool Block);

-bool WaitFd(int Fd);
+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);

 
 // File string manipulators
 
 // File string manipulators

-string flNotDir(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);
+
+// simple c++ glob
+std::vector<std::string> Glob(std::string const &pattern, int flags=0);

 
 #endif
 
 #endif