* wording fixes (cherry picked from apt--mvo)

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

diff --git a/apt-pkg/contrib/fileutl.cc b/apt-pkg/contrib/fileutl.cc
index 65c19ea920d4bd989e3aeff75c196ca42e5e4175..9fd71728e9943a702ae6c286067b516ea55a1acc 100644 (file)
--- a/apt-pkg/contrib/fileutl.cc
+++ b/apt-pkg/contrib/fileutl.cc
@@ -1,6 +1,6 @@
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/

-// $Id: fileutl.cc,v 1.34 2000/01/17 07:11:49 jgg Exp $
+// $Id: fileutl.cc,v 1.42 2002/09/14 05:29:22 jgg Exp $

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


@@ -9,7 +9,7 @@
    GetLock - dpkg compatible lock file manipulation (fcntl)
    
    This source is placed in the Public Domain, do with it what you will
    GetLock - dpkg compatible lock file manipulation (fcntl)
    
    This source is placed in the Public Domain, do with it what you will

-   It was originally written by Jason Gunthorpe.
+   It was originally written by Jason Gunthorpe <jgg@debian.org>.

    
    ##################################################################### */
                                                                        /*}}}*/
    
    ##################################################################### */
                                                                        /*}}}*/


@@ -19,7 +19,12 @@
 #endif 
 #include <apt-pkg/fileutl.h>
 #include <apt-pkg/error.h>
 #endif 
 #include <apt-pkg/fileutl.h>
 #include <apt-pkg/error.h>

+#include <apt-pkg/sptr.h>
+#include <apt-pkg/configuration.h>

 
 

+#include <apti18n.h>
+
+#include <iostream>

 #include <unistd.h>
 #include <fcntl.h>
 #include <sys/stat.h>
 #include <unistd.h>
 #include <fcntl.h>
 #include <sys/stat.h>


@@ -28,8 +33,11 @@
 #include <sys/wait.h>
 #include <signal.h>
 #include <errno.h>
 #include <sys/wait.h>
 #include <signal.h>
 #include <errno.h>

+#include <set>

                                                                        /*}}}*/
 
                                                                        /*}}}*/
 

+using namespace std;
+

 // CopyFile - Buffered copy of a file                                  /*{{{*/
 // ---------------------------------------------------------------------
 /* The caller is expected to set things so that failure causes erasure */
 // CopyFile - Buffered copy of a file                                  /*{{{*/
 // ---------------------------------------------------------------------
 /* The caller is expected to set things so that failure causes erasure */


@@ -39,7 +47,7 @@ bool CopyFile(FileFd &From,FileFd &To)
       return false;
    
    // Buffered copy between fds
       return false;
    
    // Buffered copy between fds

-   unsigned char *Buf = new unsigned char[64000];
+   SPtrArray<unsigned char> Buf = new unsigned char[64000];

    unsigned long Size = From.Size();
    while (Size != 0)
    {
    unsigned long Size = From.Size();
    while (Size != 0)
    {


@@ -49,15 +57,11 @@ bool CopyFile(FileFd &From,FileFd &To)
       
       if (From.Read(Buf,ToRead) == false || 
          To.Write(Buf,ToRead) == false)
       
       if (From.Read(Buf,ToRead) == false || 
          To.Write(Buf,ToRead) == false)

-      {
-        delete [] Buf;

         return false;
         return false;

-      }

       
       Size -= ToRead;
    }
 
       
       Size -= ToRead;
    }
 

-   delete [] Buf;

    return true;   
 }
                                                                        /*}}}*/
    return true;   
 }
                                                                        /*}}}*/


@@ -72,11 +76,22 @@ int GetLock(string File,bool Errors)
    int FD = open(File.c_str(),O_RDWR | O_CREAT | O_TRUNC,0640);
    if (FD < 0)
    {
    int FD = open(File.c_str(),O_RDWR | O_CREAT | O_TRUNC,0640);
    if (FD < 0)
    {

+      // Read only .. cant have locking problems there.
+      if (errno == EROFS)
+      {
+        _error->Warning(_("Not using locking for read only lock file %s"),File.c_str());
+        return dup(0);       // Need something for the caller to close
+      }
+      

       if (Errors == true)
       if (Errors == true)

-        _error->Errno("open","Could not open lock file %s",File.c_str());
+        _error->Errno("open",_("Could not open lock file %s"),File.c_str());
+
+      // Feh.. We do this to distinguish the lock vs open case..
+      errno = EPERM;

       return -1;
    }
       return -1;
    }

-   
+   SetCloseExec(FD,true);
+      

    // Aquire a write lock
    struct flock fl;
    fl.l_type = F_WRLCK;
    // Aquire a write lock
    struct flock fl;
    fl.l_type = F_WRLCK;


@@ -87,12 +102,15 @@ int GetLock(string File,bool Errors)
    {
       if (errno == ENOLCK)
       {
    {
       if (errno == ENOLCK)
       {

-        _error->Warning("Not using locking for nfs mounted lock file %s",File.c_str());
-        return true;
+        _error->Warning(_("Not using locking for nfs mounted lock file %s"),File.c_str());
+        return dup(0);       // Need something for the caller to close  

       }      
       if (Errors == true)
       }      
       if (Errors == true)

-        _error->Errno("open","Could not get lock %s",File.c_str());
+        _error->Errno("open",_("Could not get lock %s"),File.c_str());
+      
+      int Tmp = errno;

       close(FD);
       close(FD);

+      errno = Tmp;

       return -1;
    }
 
       return -1;
    }
 


@@ -140,16 +158,28 @@ string flNotDir(string File)
                                                                        /*}}}*/
 // flNotFile - Strip the file from the directory name                  /*{{{*/
 // ---------------------------------------------------------------------
                                                                        /*}}}*/
 // flNotFile - Strip the file from the directory name                  /*{{{*/
 // ---------------------------------------------------------------------

-/* */
+/* Result ends in a / */

 string flNotFile(string File)
 {
    string::size_type Res = File.rfind('/');
    if (Res == string::npos)
 string flNotFile(string File)
 {
    string::size_type Res = File.rfind('/');
    if (Res == string::npos)

-      return File;
+      return "./";

    Res++;
    return string(File,0,Res);
 }
                                                                        /*}}}*/
    Res++;
    return string(File,0,Res);
 }
                                                                        /*}}}*/

+// flExtension - Return the extension for the file                     /*{{{*/
+// ---------------------------------------------------------------------
+/* */
+string flExtension(string File)
+{
+   string::size_type Res = File.rfind('.');
+   if (Res == string::npos)
+      return File;
+   Res++;
+   return string(File,Res,Res - File.length());
+}
+                                                                       /*}}}*/

 // flNoLink - If file is a symlink then deref it                       /*{{{*/
 // ---------------------------------------------------------------------
 /* If the name is not a link then the returned path is the input. */
 // flNoLink - If file is a symlink then deref it                       /*{{{*/
 // ---------------------------------------------------------------------
 /* If the name is not a link then the returned path is the input. */


@@ -189,6 +219,24 @@ string flNoLink(string File)
    }   
 }
                                                                        /*}}}*/
    }   
 }
                                                                        /*}}}*/

+// flCombine - Combine a file and a directory                          /*{{{*/
+// ---------------------------------------------------------------------
+/* If the file is an absolute path then it is just returned, otherwise
+   the directory is pre-pended to it. */
+string flCombine(string Dir,string File)
+{
+   if (File.empty() == true)
+      return string();
+   
+   if (File[0] == '/' || Dir.empty() == true)
+      return File;
+   if (File.length() >= 2 && File[0] == '.' && File[1] == '/')
+      return File;
+   if (Dir[Dir.length()-1] == '/')
+      return Dir + File;
+   return Dir + '/' + File;
+}
+                                                                       /*}}}*/

 // SetCloseExec - Set the close on exec flag                           /*{{{*/
 // ---------------------------------------------------------------------
 /* */
 // SetCloseExec - Set the close on exec flag                           /*{{{*/
 // ---------------------------------------------------------------------
 /* */


@@ -216,7 +264,7 @@ void SetNonBlock(int Fd,bool Block)
                                                                        /*}}}*/
 // WaitFd - Wait for a FD to become readable                           /*{{{*/
 // ---------------------------------------------------------------------
                                                                        /*}}}*/
 // WaitFd - Wait for a FD to become readable                           /*{{{*/
 // ---------------------------------------------------------------------

-/* This waits for a FD to become readable using select. It is usefull for
+/* This waits for a FD to become readable using select. It is useful for

    applications making use of non-blocking sockets. The timeout is 
    in seconds. */
 bool WaitFd(int Fd,bool write,unsigned long timeout)
    applications making use of non-blocking sockets. The timeout is 
    in seconds. */
 bool WaitFd(int Fd,bool write,unsigned long timeout)


@@ -260,7 +308,7 @@ bool WaitFd(int Fd,bool write,unsigned long timeout)
 /* This is used if you want to cleanse the environment for the forked 
    child, it fixes up the important signals and nukes all of the fds,
    otherwise acts like normal fork. */
 /* This is used if you want to cleanse the environment for the forked 
    child, it fixes up the important signals and nukes all of the fds,
    otherwise acts like normal fork. */

-int ExecFork()
+pid_t ExecFork()

 {
    // Fork off the process
    pid_t Process = fork();
 {
    // Fork off the process
    pid_t Process = fork();


@@ -280,10 +328,27 @@ int ExecFork()
       signal(SIGWINCH,SIG_DFL);
       signal(SIGCONT,SIG_DFL);
       signal(SIGTSTP,SIG_DFL);
       signal(SIGWINCH,SIG_DFL);
       signal(SIGCONT,SIG_DFL);
       signal(SIGTSTP,SIG_DFL);

-      
+
+      set<int> KeepFDs;
+      Configuration::Item const *Opts = _config->Tree("APT::Keep-Fds");
+      if (Opts != 0 && Opts->Child != 0)
+      {
+        Opts = Opts->Child;
+        for (; Opts != 0; Opts = Opts->Next)
+        {
+           if (Opts->Value.empty() == true)
+              continue;
+           int fd = atoi(Opts->Value.c_str());
+           KeepFDs.insert(fd);
+        }
+      }
+

       // Close all of our FDs - just in case
       for (int K = 3; K != 40; K++)
       // Close all of our FDs - just in case
       for (int K = 3; K != 40; K++)

-        fcntl(K,F_SETFD,FD_CLOEXEC);
+      {
+        if(KeepFDs.find(K) == KeepFDs.end())
+           fcntl(K,F_SETFD,FD_CLOEXEC);
+      }

    }
    
    return Process;
    }
    
    return Process;


@@ -291,10 +356,10 @@ int ExecFork()
                                                                        /*}}}*/
 // ExecWait - Fancy waitpid                                            /*{{{*/
 // ---------------------------------------------------------------------
                                                                        /*}}}*/
 // ExecWait - Fancy waitpid                                            /*{{{*/
 // ---------------------------------------------------------------------

-/* Waits for the given sub process. If Reap is set the no errors are 
+/* Waits for the given sub process. If Reap is set then no errors are 

    generated. Otherwise a failed subprocess will generate a proper descriptive
    message */
    generated. Otherwise a failed subprocess will generate a proper descriptive
    message */

-bool ExecWait(int Pid,const char *Name,bool Reap)
+bool ExecWait(pid_t Pid,const char *Name,bool Reap)

 {
    if (Pid <= 1)
       return true;
 {
    if (Pid <= 1)
       return true;


@@ -309,7 +374,7 @@ bool ExecWait(int Pid,const char *Name,bool Reap)
       if (Reap == true)
         return false;
       
       if (Reap == true)
         return false;
       

-      return _error->Error("Waited, for %s but it wasn't there",Name);
+      return _error->Error(_("Waited for %s but it wasn't there"),Name);

    }
 
    
    }
 
    


@@ -319,12 +384,12 @@ bool ExecWait(int Pid,const char *Name,bool Reap)
       if (Reap == true)
         return false;
       if (WIFSIGNALED(Status) != 0 && WTERMSIG(Status) == SIGSEGV)
       if (Reap == true)
         return false;
       if (WIFSIGNALED(Status) != 0 && WTERMSIG(Status) == SIGSEGV)

-        return _error->Error("Sub-process %s recieved a segmentation fault.",Name);
+        return _error->Error(_("Sub-process %s received a segmentation fault."),Name);

 
       if (WIFEXITED(Status) != 0)
 
       if (WIFEXITED(Status) != 0)

-        return _error->Error("Sub-process %s returned an error code (%u)",Name,WEXITSTATUS(Status));
+        return _error->Error(_("Sub-process %s returned an error code (%u)"),Name,WEXITSTATUS(Status));

       
       

-      return _error->Error("Sub-process %s exited unexpectedly",Name);
+      return _error->Error(_("Sub-process %s exited unexpectedly"),Name);

    }      
    
    return true;
    }      
    
    return true;


@@ -360,10 +425,15 @@ bool FileFd::Open(string FileName,OpenMode Mode, unsigned long Perms)
       case WriteAny:
       iFd = open(FileName.c_str(),O_RDWR | O_CREAT,Perms);
       break;      
       case WriteAny:
       iFd = open(FileName.c_str(),O_RDWR | O_CREAT,Perms);
       break;      

+
+      case WriteTemp:
+      unlink(FileName.c_str());
+      iFd = open(FileName.c_str(),O_RDWR | O_CREAT | O_EXCL,Perms);
+      break;

    }  
 
    if (iFd < 0)
    }  
 
    if (iFd < 0)

-      return _error->Errno("open","Could not open file %s",FileName.c_str());
+      return _error->Errno("open",_("Could not open file %s"),FileName.c_str());

    
    this->FileName = FileName;
    SetCloseExec(iFd,true);
    
    this->FileName = FileName;
    SetCloseExec(iFd,true);


@@ -383,10 +453,13 @@ FileFd::~FileFd()
 // ---------------------------------------------------------------------
 /* We are carefull to handle interruption by a signal while reading 
    gracefully. */
 // ---------------------------------------------------------------------
 /* We are carefull to handle interruption by a signal while reading 
    gracefully. */

-bool FileFd::Read(void *To,unsigned long Size,bool AllowEof)
+bool FileFd::Read(void *To,unsigned long Size,unsigned long *Actual)

 {
    int Res;
    errno = 0;
 {
    int Res;
    errno = 0;

+   if (Actual != 0)
+      *Actual = 0;
+   

    do
    {
       Res = read(iFd,To,Size);
    do
    {
       Res = read(iFd,To,Size);


@@ -395,11 +468,13 @@ bool FileFd::Read(void *To,unsigned long Size,bool AllowEof)
       if (Res < 0)
       {
         Flags |= Fail;
       if (Res < 0)
       {
         Flags |= Fail;

-        return _error->Errno("read","Read error");
+        return _error->Errno("read",_("Read error"));

       }
       
       To = (char *)To + Res;
       Size -= Res;
       }
       
       To = (char *)To + Res;
       Size -= Res;

+      if (Actual != 0)
+        *Actual += Res;

    }
    while (Res > 0 && Size > 0);
    
    }
    while (Res > 0 && Size > 0);
    


@@ -407,14 +482,14 @@ bool FileFd::Read(void *To,unsigned long Size,bool AllowEof)
       return true;
    
    // Eof handling
       return true;
    
    // Eof handling

-   if (AllowEof == true)
+   if (Actual != 0)

    {
       Flags |= HitEof;
       return true;
    }
    
    Flags |= Fail;
    {
       Flags |= HitEof;
       return true;
    }
    
    Flags |= Fail;

-   return _error->Error("read, still have %u to read but none left",Size);
+   return _error->Error(_("read, still have %lu to read but none left"),Size);

 }
                                                                        /*}}}*/
 // FileFd::Write - Write to the file                                   /*{{{*/
 }
                                                                        /*}}}*/
 // FileFd::Write - Write to the file                                   /*{{{*/


@@ -432,7 +507,7 @@ bool FileFd::Write(const void *From,unsigned long Size)
       if (Res < 0)
       {
         Flags |= Fail;
       if (Res < 0)
       {
         Flags |= Fail;

-        return _error->Errno("write","Write error");
+        return _error->Errno("write",_("Write error"));

       }
       
       From = (char *)From + Res;
       }
       
       From = (char *)From + Res;


@@ -444,7 +519,7 @@ bool FileFd::Write(const void *From,unsigned long Size)
       return true;
    
    Flags |= Fail;
       return true;
    
    Flags |= Fail;

-   return _error->Error("write, still have %u to write but couldn't",Size);
+   return _error->Error(_("write, still have %lu to write but couldn't"),Size);

 }
                                                                        /*}}}*/
 // FileFd::Seek - Seek in the file                                     /*{{{*/
 }
                                                                        /*}}}*/
 // FileFd::Seek - Seek in the file                                     /*{{{*/


@@ -455,7 +530,7 @@ bool FileFd::Seek(unsigned long To)
    if (lseek(iFd,To,SEEK_SET) != (signed)To)
    {
       Flags |= Fail;
    if (lseek(iFd,To,SEEK_SET) != (signed)To)
    {
       Flags |= Fail;

-      return _error->Error("Unable to seek to %u",To);
+      return _error->Error("Unable to seek to %lu",To);

    }
    
    return true;
    }
    
    return true;


@@ -469,7 +544,7 @@ bool FileFd::Skip(unsigned long Over)
    if (lseek(iFd,Over,SEEK_CUR) < 0)
    {
       Flags |= Fail;
    if (lseek(iFd,Over,SEEK_CUR) < 0)
    {
       Flags |= Fail;

-      return _error->Error("Unable to seek ahead %u",Over);
+      return _error->Error("Unable to seek ahead %lu",Over);

    }
    
    return true;
    }
    
    return true;


@@ -483,7 +558,7 @@ bool FileFd::Truncate(unsigned long To)
    if (ftruncate(iFd,To) != 0)
    {
       Flags |= Fail;
    if (ftruncate(iFd,To) != 0)
    {
       Flags |= Fail;

-      return _error->Error("Unable to truncate to %u",To);
+      return _error->Error("Unable to truncate to %lu",To);

    }
    
    return true;
    }
    
    return true;


@@ -519,13 +594,25 @@ bool FileFd::Close()
    bool Res = true;
    if ((Flags & AutoClose) == AutoClose)
       if (iFd >= 0 && close(iFd) != 0)
    bool Res = true;
    if ((Flags & AutoClose) == AutoClose)
       if (iFd >= 0 && close(iFd) != 0)

-        Res &= _error->Errno("close","Problem closing the file");
+        Res &= _error->Errno("close",_("Problem closing the file"));

    iFd = -1;
    
    if ((Flags & Fail) == Fail && (Flags & DelOnFail) == DelOnFail &&
        FileName.empty() == false)
       if (unlink(FileName.c_str()) != 0)
    iFd = -1;
    
    if ((Flags & Fail) == Fail && (Flags & DelOnFail) == DelOnFail &&
        FileName.empty() == false)
       if (unlink(FileName.c_str()) != 0)

-        Res &= _error->Warning("unlnk","Problem unlinking the file");
+        Res &= _error->WarningE("unlnk",_("Problem unlinking the file"));

    return Res;
 }
                                                                        /*}}}*/
    return Res;
 }
                                                                        /*}}}*/

+// FileFd::Sync - Sync the file                                                /*{{{*/
+// ---------------------------------------------------------------------
+/* */
+bool FileFd::Sync()
+{
+#ifdef _POSIX_SYNCHRONIZED_IO
+   if (fsync(iFd) != 0)
+      return _error->Errno("sync",_("Problem syncing the file"));
+#endif
+   return true;
+}
+                                                                       /*}}}*/