1 // -*- mode: cpp; mode: fold -*-
3 // $Id: fileutl.cc,v 1.42 2002/09/14 05:29:22 jgg Exp $
4 /* ######################################################################
8 CopyFile - Buffered copy of a single file
9 GetLock - dpkg compatible lock file manipulation (fcntl)
11 Most of this source is placed in the Public Domain, do with it what
13 It was originally written by Jason Gunthorpe <jgg@debian.org>.
14 FileFd gzip support added by Martin Pitt <martin.pitt@canonical.com>
16 The exception is RunScripts() it is under the GPLv2
18 ##################################################################### */
20 // Include Files /*{{{*/
23 #include <apt-pkg/fileutl.h>
24 #include <apt-pkg/strutl.h>
25 #include <apt-pkg/error.h>
26 #include <apt-pkg/sptr.h>
27 #include <apt-pkg/aptconfiguration.h>
28 #include <apt-pkg/configuration.h>
38 #include <sys/types.h>
54 #ifdef WORDS_BIGENDIAN
78 APT::Configuration::Compressor compressor
;
79 unsigned int openmode
;
80 unsigned long long seekpos
;
81 FileFdPrivate() : gz(NULL
), bz2(NULL
),
82 compressed_fd(-1), compressor_pid(-1), pipe(false),
83 openmode(0), seekpos(0) {};
86 // RunScripts - Run a set of scripts from a configuration subtree /*{{{*/
87 // ---------------------------------------------------------------------
89 bool RunScripts(const char *Cnf
)
91 Configuration::Item
const *Opts
= _config
->Tree(Cnf
);
92 if (Opts
== 0 || Opts
->Child
== 0)
96 // Fork for running the system calls
97 pid_t Child
= ExecFork();
102 if (_config
->FindDir("DPkg::Chroot-Directory","/") != "/")
104 std::cerr
<< "Chrooting into "
105 << _config
->FindDir("DPkg::Chroot-Directory")
107 if (chroot(_config
->FindDir("DPkg::Chroot-Directory","/").c_str()) != 0)
111 if (chdir("/tmp/") != 0)
114 unsigned int Count
= 1;
115 for (; Opts
!= 0; Opts
= Opts
->Next
, Count
++)
117 if (Opts
->Value
.empty() == true)
120 if (system(Opts
->Value
.c_str()) != 0)
126 // Wait for the child
128 while (waitpid(Child
,&Status
,0) != Child
)
132 return _error
->Errno("waitpid","Couldn't wait for subprocess");
135 // Restore sig int/quit
136 signal(SIGQUIT
,SIG_DFL
);
137 signal(SIGINT
,SIG_DFL
);
139 // Check for an error code.
140 if (WIFEXITED(Status
) == 0 || WEXITSTATUS(Status
) != 0)
142 unsigned int Count
= WEXITSTATUS(Status
);
146 for (; Opts
!= 0 && Count
!= 1; Opts
= Opts
->Next
, Count
--);
147 _error
->Error("Problem executing scripts %s '%s'",Cnf
,Opts
->Value
.c_str());
150 return _error
->Error("Sub-process returned an error code");
157 // CopyFile - Buffered copy of a file /*{{{*/
158 // ---------------------------------------------------------------------
159 /* The caller is expected to set things so that failure causes erasure */
160 bool CopyFile(FileFd
&From
,FileFd
&To
)
162 if (From
.IsOpen() == false || To
.IsOpen() == false)
165 // Buffered copy between fds
166 SPtrArray
<unsigned char> Buf
= new unsigned char[64000];
167 unsigned long long Size
= From
.Size();
170 unsigned long long ToRead
= Size
;
174 if (From
.Read(Buf
,ToRead
) == false ||
175 To
.Write(Buf
,ToRead
) == false)
184 // GetLock - Gets a lock file /*{{{*/
185 // ---------------------------------------------------------------------
186 /* This will create an empty file of the given name and lock it. Once this
187 is done all other calls to GetLock in any other process will fail with
188 -1. The return result is the fd of the file, the call should call
189 close at some time. */
190 int GetLock(string File
,bool Errors
)
192 // GetLock() is used in aptitude on directories with public-write access
193 // Use O_NOFOLLOW here to prevent symlink traversal attacks
194 int FD
= open(File
.c_str(),O_RDWR
| O_CREAT
| O_NOFOLLOW
,0640);
197 // Read only .. cant have locking problems there.
200 _error
->Warning(_("Not using locking for read only lock file %s"),File
.c_str());
201 return dup(0); // Need something for the caller to close
205 _error
->Errno("open",_("Could not open lock file %s"),File
.c_str());
207 // Feh.. We do this to distinguish the lock vs open case..
211 SetCloseExec(FD
,true);
213 // Aquire a write lock
216 fl
.l_whence
= SEEK_SET
;
219 if (fcntl(FD
,F_SETLK
,&fl
) == -1)
223 _error
->Warning(_("Not using locking for nfs mounted lock file %s"),File
.c_str());
224 return dup(0); // Need something for the caller to close
227 _error
->Errno("open",_("Could not get lock %s"),File
.c_str());
238 // FileExists - Check if a file exists /*{{{*/
239 // ---------------------------------------------------------------------
240 /* Beware: Directories are also files! */
241 bool FileExists(string File
)
244 if (stat(File
.c_str(),&Buf
) != 0)
249 // RealFileExists - Check if a file exists and if it is really a file /*{{{*/
250 // ---------------------------------------------------------------------
252 bool RealFileExists(string File
)
255 if (stat(File
.c_str(),&Buf
) != 0)
257 return ((Buf
.st_mode
& S_IFREG
) != 0);
260 // DirectoryExists - Check if a directory exists and is really one /*{{{*/
261 // ---------------------------------------------------------------------
263 bool DirectoryExists(string
const &Path
)
266 if (stat(Path
.c_str(),&Buf
) != 0)
268 return ((Buf
.st_mode
& S_IFDIR
) != 0);
271 // CreateDirectory - poor man's mkdir -p guarded by a parent directory /*{{{*/
272 // ---------------------------------------------------------------------
273 /* This method will create all directories needed for path in good old
274 mkdir -p style but refuses to do this if Parent is not a prefix of
275 this Path. Example: /var/cache/ and /var/cache/apt/archives are given,
276 so it will create apt/archives if /var/cache exists - on the other
277 hand if the parent is /var/lib the creation will fail as this path
278 is not a parent of the path to be generated. */
279 bool CreateDirectory(string
const &Parent
, string
const &Path
)
281 if (Parent
.empty() == true || Path
.empty() == true)
284 if (DirectoryExists(Path
) == true)
287 if (DirectoryExists(Parent
) == false)
290 // we are not going to create directories "into the blue"
291 if (Path
.find(Parent
, 0) != 0)
294 vector
<string
> const dirs
= VectorizeString(Path
.substr(Parent
.size()), '/');
295 string progress
= Parent
;
296 for (vector
<string
>::const_iterator d
= dirs
.begin(); d
!= dirs
.end(); ++d
)
298 if (d
->empty() == true)
301 progress
.append("/").append(*d
);
302 if (DirectoryExists(progress
) == true)
305 if (mkdir(progress
.c_str(), 0755) != 0)
311 // CreateAPTDirectoryIfNeeded - ensure that the given directory exists /*{{{*/
312 // ---------------------------------------------------------------------
313 /* a small wrapper around CreateDirectory to check if it exists and to
314 remove the trailing "/apt/" from the parent directory if needed */
315 bool CreateAPTDirectoryIfNeeded(string
const &Parent
, string
const &Path
)
317 if (DirectoryExists(Path
) == true)
320 size_t const len
= Parent
.size();
321 if (len
> 5 && Parent
.find("/apt/", len
- 6, 5) == len
- 5)
323 if (CreateDirectory(Parent
.substr(0,len
-5), Path
) == true)
326 else if (CreateDirectory(Parent
, Path
) == true)
332 // GetListOfFilesInDir - returns a vector of files in the given dir /*{{{*/
333 // ---------------------------------------------------------------------
334 /* If an extension is given only files with this extension are included
335 in the returned vector, otherwise every "normal" file is included. */
336 std::vector
<string
> GetListOfFilesInDir(string
const &Dir
, string
const &Ext
,
337 bool const &SortList
, bool const &AllowNoExt
)
339 std::vector
<string
> ext
;
341 if (Ext
.empty() == false)
343 if (AllowNoExt
== true && ext
.empty() == false)
345 return GetListOfFilesInDir(Dir
, ext
, SortList
);
347 std::vector
<string
> GetListOfFilesInDir(string
const &Dir
, std::vector
<string
> const &Ext
,
348 bool const &SortList
)
350 // Attention debuggers: need to be set with the environment config file!
351 bool const Debug
= _config
->FindB("Debug::GetListOfFilesInDir", false);
354 std::clog
<< "Accept in " << Dir
<< " only files with the following " << Ext
.size() << " extensions:" << std::endl
;
355 if (Ext
.empty() == true)
356 std::clog
<< "\tNO extension" << std::endl
;
358 for (std::vector
<string
>::const_iterator e
= Ext
.begin();
360 std::clog
<< '\t' << (e
->empty() == true ? "NO" : *e
) << " extension" << std::endl
;
363 std::vector
<string
> List
;
365 if (DirectoryExists(Dir
.c_str()) == false)
367 _error
->Error(_("List of files can't be created as '%s' is not a directory"), Dir
.c_str());
371 Configuration::MatchAgainstConfig
SilentIgnore("Dir::Ignore-Files-Silently");
372 DIR *D
= opendir(Dir
.c_str());
375 _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
379 for (struct dirent
*Ent
= readdir(D
); Ent
!= 0; Ent
= readdir(D
))
381 // skip "hidden" files
382 if (Ent
->d_name
[0] == '.')
385 // Make sure it is a file and not something else
386 string
const File
= flCombine(Dir
,Ent
->d_name
);
387 #ifdef _DIRENT_HAVE_D_TYPE
388 if (Ent
->d_type
!= DT_REG
)
391 if (RealFileExists(File
.c_str()) == false)
393 // do not show ignoration warnings for directories
395 #ifdef _DIRENT_HAVE_D_TYPE
396 Ent
->d_type
== DT_DIR
||
398 DirectoryExists(File
.c_str()) == true)
400 if (SilentIgnore
.Match(Ent
->d_name
) == false)
401 _error
->Notice(_("Ignoring '%s' in directory '%s' as it is not a regular file"), Ent
->d_name
, Dir
.c_str());
406 // check for accepted extension:
407 // no extension given -> periods are bad as hell!
408 // extensions given -> "" extension allows no extension
409 if (Ext
.empty() == false)
411 string d_ext
= flExtension(Ent
->d_name
);
412 if (d_ext
== Ent
->d_name
) // no extension
414 if (std::find(Ext
.begin(), Ext
.end(), "") == Ext
.end())
417 std::clog
<< "Bad file: " << Ent
->d_name
<< " → no extension" << std::endl
;
418 if (SilentIgnore
.Match(Ent
->d_name
) == false)
419 _error
->Notice(_("Ignoring file '%s' in directory '%s' as it has no filename extension"), Ent
->d_name
, Dir
.c_str());
423 else if (std::find(Ext
.begin(), Ext
.end(), d_ext
) == Ext
.end())
426 std::clog
<< "Bad file: " << Ent
->d_name
<< " → bad extension »" << flExtension(Ent
->d_name
) << "«" << std::endl
;
427 if (SilentIgnore
.Match(Ent
->d_name
) == false)
428 _error
->Notice(_("Ignoring file '%s' in directory '%s' as it has an invalid filename extension"), Ent
->d_name
, Dir
.c_str());
433 // Skip bad filenames ala run-parts
434 const char *C
= Ent
->d_name
;
436 if (isalpha(*C
) == 0 && isdigit(*C
) == 0
437 && *C
!= '_' && *C
!= '-') {
438 // no required extension -> dot is a bad character
439 if (*C
== '.' && Ext
.empty() == false)
444 // we don't reach the end of the name -> bad character included
448 std::clog
<< "Bad file: " << Ent
->d_name
<< " → bad character »"
449 << *C
<< "« in filename (period allowed: " << (Ext
.empty() ? "no" : "yes") << ")" << std::endl
;
453 // skip filenames which end with a period. These are never valid
457 std::clog
<< "Bad file: " << Ent
->d_name
<< " → Period as last character" << std::endl
;
462 std::clog
<< "Accept file: " << Ent
->d_name
<< " in " << Dir
<< std::endl
;
463 List
.push_back(File
);
467 if (SortList
== true)
468 std::sort(List
.begin(),List
.end());
471 std::vector
<string
> GetListOfFilesInDir(string
const &Dir
, bool SortList
)
473 bool const Debug
= _config
->FindB("Debug::GetListOfFilesInDir", false);
475 std::clog
<< "Accept in " << Dir
<< " all regular files" << std::endl
;
477 std::vector
<string
> List
;
479 if (DirectoryExists(Dir
.c_str()) == false)
481 _error
->Error(_("List of files can't be created as '%s' is not a directory"), Dir
.c_str());
485 DIR *D
= opendir(Dir
.c_str());
488 _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
492 for (struct dirent
*Ent
= readdir(D
); Ent
!= 0; Ent
= readdir(D
))
494 // skip "hidden" files
495 if (Ent
->d_name
[0] == '.')
498 // Make sure it is a file and not something else
499 string
const File
= flCombine(Dir
,Ent
->d_name
);
500 #ifdef _DIRENT_HAVE_D_TYPE
501 if (Ent
->d_type
!= DT_REG
)
504 if (RealFileExists(File
.c_str()) == false)
507 std::clog
<< "Bad file: " << Ent
->d_name
<< " → it is not a real file" << std::endl
;
512 // Skip bad filenames ala run-parts
513 const char *C
= Ent
->d_name
;
515 if (isalpha(*C
) == 0 && isdigit(*C
) == 0
516 && *C
!= '_' && *C
!= '-' && *C
!= '.')
519 // we don't reach the end of the name -> bad character included
523 std::clog
<< "Bad file: " << Ent
->d_name
<< " → bad character »" << *C
<< "« in filename" << std::endl
;
527 // skip filenames which end with a period. These are never valid
531 std::clog
<< "Bad file: " << Ent
->d_name
<< " → Period as last character" << std::endl
;
536 std::clog
<< "Accept file: " << Ent
->d_name
<< " in " << Dir
<< std::endl
;
537 List
.push_back(File
);
541 if (SortList
== true)
542 std::sort(List
.begin(),List
.end());
546 // SafeGetCWD - This is a safer getcwd that returns a dynamic string /*{{{*/
547 // ---------------------------------------------------------------------
548 /* We return / on failure. */
551 // Stash the current dir.
554 if (getcwd(S
,sizeof(S
)-2) == 0)
556 unsigned int Len
= strlen(S
);
562 // GetModificationTime - Get the mtime of the given file or -1 on error /*{{{*/
563 // ---------------------------------------------------------------------
564 /* We return / on failure. */
565 time_t GetModificationTime(string
const &Path
)
568 if (stat(Path
.c_str(), &St
) < 0)
573 // flNotDir - Strip the directory from the filename /*{{{*/
574 // ---------------------------------------------------------------------
576 string
flNotDir(string File
)
578 string::size_type Res
= File
.rfind('/');
579 if (Res
== string::npos
)
582 return string(File
,Res
,Res
- File
.length());
585 // flNotFile - Strip the file from the directory name /*{{{*/
586 // ---------------------------------------------------------------------
587 /* Result ends in a / */
588 string
flNotFile(string File
)
590 string::size_type Res
= File
.rfind('/');
591 if (Res
== string::npos
)
594 return string(File
,0,Res
);
597 // flExtension - Return the extension for the file /*{{{*/
598 // ---------------------------------------------------------------------
600 string
flExtension(string File
)
602 string::size_type Res
= File
.rfind('.');
603 if (Res
== string::npos
)
606 return string(File
,Res
,Res
- File
.length());
609 // flNoLink - If file is a symlink then deref it /*{{{*/
610 // ---------------------------------------------------------------------
611 /* If the name is not a link then the returned path is the input. */
612 string
flNoLink(string File
)
615 if (lstat(File
.c_str(),&St
) != 0 || S_ISLNK(St
.st_mode
) == 0)
617 if (stat(File
.c_str(),&St
) != 0)
620 /* Loop resolving the link. There is no need to limit the number of
621 loops because the stat call above ensures that the symlink is not
629 if ((Res
= readlink(NFile
.c_str(),Buffer
,sizeof(Buffer
))) <= 0 ||
630 (unsigned)Res
>= sizeof(Buffer
))
633 // Append or replace the previous path
635 if (Buffer
[0] == '/')
638 NFile
= flNotFile(NFile
) + Buffer
;
640 // See if we are done
641 if (lstat(NFile
.c_str(),&St
) != 0)
643 if (S_ISLNK(St
.st_mode
) == 0)
648 // flCombine - Combine a file and a directory /*{{{*/
649 // ---------------------------------------------------------------------
650 /* If the file is an absolute path then it is just returned, otherwise
651 the directory is pre-pended to it. */
652 string
flCombine(string Dir
,string File
)
654 if (File
.empty() == true)
657 if (File
[0] == '/' || Dir
.empty() == true)
659 if (File
.length() >= 2 && File
[0] == '.' && File
[1] == '/')
661 if (Dir
[Dir
.length()-1] == '/')
663 return Dir
+ '/' + File
;
666 // SetCloseExec - Set the close on exec flag /*{{{*/
667 // ---------------------------------------------------------------------
669 void SetCloseExec(int Fd
,bool Close
)
671 if (fcntl(Fd
,F_SETFD
,(Close
== false)?0:FD_CLOEXEC
) != 0)
673 cerr
<< "FATAL -> Could not set close on exec " << strerror(errno
) << endl
;
678 // SetNonBlock - Set the nonblocking flag /*{{{*/
679 // ---------------------------------------------------------------------
681 void SetNonBlock(int Fd
,bool Block
)
683 int Flags
= fcntl(Fd
,F_GETFL
) & (~O_NONBLOCK
);
684 if (fcntl(Fd
,F_SETFL
,Flags
| ((Block
== false)?0:O_NONBLOCK
)) != 0)
686 cerr
<< "FATAL -> Could not set non-blocking flag " << strerror(errno
) << endl
;
691 // WaitFd - Wait for a FD to become readable /*{{{*/
692 // ---------------------------------------------------------------------
693 /* This waits for a FD to become readable using select. It is useful for
694 applications making use of non-blocking sockets. The timeout is
696 bool WaitFd(int Fd
,bool write
,unsigned long timeout
)
709 Res
= select(Fd
+1,0,&Set
,0,(timeout
!= 0?&tv
:0));
711 while (Res
< 0 && errno
== EINTR
);
721 Res
= select(Fd
+1,&Set
,0,0,(timeout
!= 0?&tv
:0));
723 while (Res
< 0 && errno
== EINTR
);
732 // ExecFork - Magical fork that sanitizes the context before execing /*{{{*/
733 // ---------------------------------------------------------------------
734 /* This is used if you want to cleanse the environment for the forked
735 child, it fixes up the important signals and nukes all of the fds,
736 otherwise acts like normal fork. */
739 // Fork off the process
740 pid_t Process
= fork();
743 cerr
<< "FATAL -> Failed to fork." << endl
;
747 // Spawn the subprocess
751 signal(SIGPIPE
,SIG_DFL
);
752 signal(SIGQUIT
,SIG_DFL
);
753 signal(SIGINT
,SIG_DFL
);
754 signal(SIGWINCH
,SIG_DFL
);
755 signal(SIGCONT
,SIG_DFL
);
756 signal(SIGTSTP
,SIG_DFL
);
759 Configuration::Item
const *Opts
= _config
->Tree("APT::Keep-Fds");
760 if (Opts
!= 0 && Opts
->Child
!= 0)
763 for (; Opts
!= 0; Opts
= Opts
->Next
)
765 if (Opts
->Value
.empty() == true)
767 int fd
= atoi(Opts
->Value
.c_str());
772 // Close all of our FDs - just in case
773 for (int K
= 3; K
!= 40; K
++)
775 if(KeepFDs
.find(K
) == KeepFDs
.end())
776 fcntl(K
,F_SETFD
,FD_CLOEXEC
);
783 // ExecWait - Fancy waitpid /*{{{*/
784 // ---------------------------------------------------------------------
785 /* Waits for the given sub process. If Reap is set then no errors are
786 generated. Otherwise a failed subprocess will generate a proper descriptive
788 bool ExecWait(pid_t Pid
,const char *Name
,bool Reap
)
793 // Wait and collect the error code
795 while (waitpid(Pid
,&Status
,0) != Pid
)
803 return _error
->Error(_("Waited for %s but it wasn't there"),Name
);
807 // Check for an error code.
808 if (WIFEXITED(Status
) == 0 || WEXITSTATUS(Status
) != 0)
812 if (WIFSIGNALED(Status
) != 0)
814 if( WTERMSIG(Status
) == SIGSEGV
)
815 return _error
->Error(_("Sub-process %s received a segmentation fault."),Name
);
817 return _error
->Error(_("Sub-process %s received signal %u."),Name
, WTERMSIG(Status
));
820 if (WIFEXITED(Status
) != 0)
821 return _error
->Error(_("Sub-process %s returned an error code (%u)"),Name
,WEXITSTATUS(Status
));
823 return _error
->Error(_("Sub-process %s exited unexpectedly"),Name
);
830 // FileFd::Open - Open a file /*{{{*/
831 // ---------------------------------------------------------------------
832 /* The most commonly used open mode combinations are given with Mode */
833 bool FileFd::Open(string FileName
,unsigned int const Mode
,CompressMode Compress
, unsigned long const Perms
)
835 if (Mode
== ReadOnlyGzip
)
836 return Open(FileName
, ReadOnly
, Gzip
, Perms
);
838 if (Compress
== Auto
&& (Mode
& WriteOnly
) == WriteOnly
)
839 return _error
->Error("Autodetection on %s only works in ReadOnly openmode!", FileName
.c_str());
841 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
842 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
843 if (Compress
== Auto
)
845 for (; compressor
!= compressors
.end(); ++compressor
)
847 std::string file
= std::string(FileName
).append(compressor
->Extension
);
848 if (FileExists(file
) == false)
854 else if (Compress
== Extension
)
856 std::string::size_type
const found
= FileName
.find_last_of('.');
858 if (found
!= std::string::npos
)
860 ext
= FileName
.substr(found
);
861 if (ext
== ".new" || ext
== ".bak")
863 std::string::size_type
const found2
= FileName
.find_last_of('.', found
- 1);
864 if (found2
!= std::string::npos
)
865 ext
= FileName
.substr(found2
, found
- found2
);
870 for (; compressor
!= compressors
.end(); ++compressor
)
871 if (ext
== compressor
->Extension
)
873 // no matching extension - assume uncompressed (imagine files like 'example.org_Packages')
874 if (compressor
== compressors
.end())
875 for (compressor
= compressors
.begin(); compressor
!= compressors
.end(); ++compressor
)
876 if (compressor
->Name
== ".")
884 case None
: name
= "."; break;
885 case Gzip
: name
= "gzip"; break;
886 case Bzip2
: name
= "bzip2"; break;
887 case Lzma
: name
= "lzma"; break;
888 case Xz
: name
= "xz"; break;
892 return _error
->Error("Opening File %s in None, Auto or Extension should be already handled?!?", FileName
.c_str());
894 for (; compressor
!= compressors
.end(); ++compressor
)
895 if (compressor
->Name
== name
)
897 if (compressor
== compressors
.end())
898 return _error
->Error("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
901 if (compressor
== compressors
.end())
902 return _error
->Error("Can't find a match for specified compressor mode for file %s", FileName
.c_str());
903 return Open(FileName
, Mode
, *compressor
, Perms
);
905 bool FileFd::Open(string FileName
,unsigned int const Mode
,APT::Configuration::Compressor
const &compressor
, unsigned long const Perms
)
910 if ((Mode
& WriteOnly
) != WriteOnly
&& (Mode
& (Atomic
| Create
| Empty
| Exclusive
)) != 0)
911 return _error
->Error("ReadOnly mode for %s doesn't accept additional flags!", FileName
.c_str());
912 if ((Mode
& ReadWrite
) == 0)
913 return _error
->Error("No openmode provided in FileFd::Open for %s", FileName
.c_str());
915 if ((Mode
& Atomic
) == Atomic
)
918 char *name
= strdup((FileName
+ ".XXXXXX").c_str());
919 TemporaryFileName
= string(mktemp(name
));
922 else if ((Mode
& (Exclusive
| Create
)) == (Exclusive
| Create
))
924 // for atomic, this will be done by rename in Close()
925 unlink(FileName
.c_str());
927 if ((Mode
& Empty
) == Empty
)
930 if (lstat(FileName
.c_str(),&Buf
) == 0 && S_ISLNK(Buf
.st_mode
))
931 unlink(FileName
.c_str());
935 #define if_FLAGGED_SET(FLAG, MODE) if ((Mode & FLAG) == FLAG) fileflags |= MODE
936 if_FLAGGED_SET(ReadWrite
, O_RDWR
);
937 else if_FLAGGED_SET(ReadOnly
, O_RDONLY
);
938 else if_FLAGGED_SET(WriteOnly
, O_WRONLY
);
940 if_FLAGGED_SET(Create
, O_CREAT
);
941 if_FLAGGED_SET(Empty
, O_TRUNC
);
942 if_FLAGGED_SET(Exclusive
, O_EXCL
);
943 else if_FLAGGED_SET(Atomic
, O_EXCL
);
944 #undef if_FLAGGED_SET
946 if (TemporaryFileName
.empty() == false)
947 iFd
= open(TemporaryFileName
.c_str(), fileflags
, Perms
);
949 iFd
= open(FileName
.c_str(), fileflags
, Perms
);
951 this->FileName
= FileName
;
952 if (iFd
== -1 || OpenInternDescriptor(Mode
, compressor
) == false)
959 return _error
->Errno("open",_("Could not open file %s"), FileName
.c_str());
962 SetCloseExec(iFd
,true);
966 // FileFd::OpenDescriptor - Open a filedescriptor /*{{{*/
967 // ---------------------------------------------------------------------
969 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, CompressMode Compress
, bool AutoClose
)
971 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
972 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
975 // compat with the old API
976 if (Mode
== ReadOnlyGzip
&& Compress
== None
)
981 case None
: name
= "."; break;
982 case Gzip
: name
= "gzip"; break;
983 case Bzip2
: name
= "bzip2"; break;
984 case Lzma
: name
= "lzma"; break;
985 case Xz
: name
= "xz"; break;
988 return _error
->Error("Opening Fd %d in Auto or Extension compression mode is not supported", Fd
);
990 for (; compressor
!= compressors
.end(); ++compressor
)
991 if (compressor
->Name
== name
)
993 if (compressor
== compressors
.end())
994 return _error
->Error("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
996 return OpenDescriptor(Fd
, Mode
, *compressor
, AutoClose
);
998 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
, bool AutoClose
)
1001 Flags
= (AutoClose
) ? FileFd::AutoClose
: 0;
1003 this->FileName
= "";
1004 if (OpenInternDescriptor(Mode
, compressor
) == false)
1008 return _error
->Errno("gzdopen",_("Could not open file descriptor %d"), Fd
);
1012 bool FileFd::OpenInternDescriptor(unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
)
1016 d
= new FileFdPrivate();
1018 d
->compressor
= compressor
;
1020 if (compressor
.Name
== "." || compressor
.Binary
.empty() == true)
1023 else if (compressor
.Name
== "gzip")
1025 if ((Mode
& ReadWrite
) == ReadWrite
)
1026 d
->gz
= gzdopen(iFd
, "r+");
1027 else if ((Mode
& WriteOnly
) == WriteOnly
)
1028 d
->gz
= gzdopen(iFd
, "w");
1030 d
->gz
= gzdopen(iFd
, "r");
1033 Flags
|= Compressed
;
1038 else if (compressor
.Name
== "bzip2")
1040 if ((Mode
& ReadWrite
) == ReadWrite
)
1041 d
->bz2
= BZ2_bzdopen(iFd
, "r+");
1042 else if ((Mode
& WriteOnly
) == WriteOnly
)
1043 d
->bz2
= BZ2_bzdopen(iFd
, "w");
1045 d
->bz2
= BZ2_bzdopen(iFd
, "r");
1048 Flags
|= Compressed
;
1054 if ((Mode
& ReadWrite
) == ReadWrite
)
1055 return _error
->Error("ReadWrite mode is not supported for file %s", FileName
.c_str());
1057 bool const Comp
= (Mode
& WriteOnly
) == WriteOnly
;
1058 // Handle 'decompression' of empty files
1063 if (Buf
.st_size
== 0 && S_ISFIFO(Buf
.st_mode
) == false)
1066 // We don't need the file open - instead let the compressor open it
1067 // as he properly knows better how to efficiently read from 'his' file
1068 if (FileName
.empty() == false)
1075 // Create a data pipe
1076 int Pipe
[2] = {-1,-1};
1077 if (pipe(Pipe
) != 0)
1078 return _error
->Errno("pipe",_("Failed to create subprocess IPC"));
1079 for (int J
= 0; J
!= 2; J
++)
1080 SetCloseExec(Pipe
[J
],true);
1082 d
->compressed_fd
= iFd
;
1091 d
->compressor_pid
= ExecFork();
1092 if (d
->compressor_pid
== 0)
1096 dup2(d
->compressed_fd
,STDOUT_FILENO
);
1097 dup2(Pipe
[0],STDIN_FILENO
);
1101 if (FileName
.empty() == true)
1102 dup2(d
->compressed_fd
,STDIN_FILENO
);
1103 dup2(Pipe
[1],STDOUT_FILENO
);
1105 int const nullfd
= open("/dev/null", O_WRONLY
);
1108 dup2(nullfd
,STDERR_FILENO
);
1112 SetCloseExec(STDOUT_FILENO
,false);
1113 SetCloseExec(STDIN_FILENO
,false);
1115 std::vector
<char const*> Args
;
1116 Args
.push_back(compressor
.Binary
.c_str());
1117 std::vector
<std::string
> const * const addArgs
=
1118 (Comp
== true) ? &(compressor
.CompressArgs
) : &(compressor
.UncompressArgs
);
1119 for (std::vector
<std::string
>::const_iterator a
= addArgs
->begin();
1120 a
!= addArgs
->end(); ++a
)
1121 Args
.push_back(a
->c_str());
1122 if (Comp
== false && FileName
.empty() == false)
1124 Args
.push_back("--stdout");
1125 if (TemporaryFileName
.empty() == false)
1126 Args
.push_back(TemporaryFileName
.c_str());
1128 Args
.push_back(FileName
.c_str());
1130 Args
.push_back(NULL
);
1132 execvp(Args
[0],(char **)&Args
[0]);
1133 cerr
<< _("Failed to exec compressor ") << Args
[0] << endl
;
1140 if ((Comp
== true || FileName
.empty() == true) && d
->compressed_fd
!= -1)
1141 close(d
->compressed_fd
);
1146 // FileFd::~File - Closes the file /*{{{*/
1147 // ---------------------------------------------------------------------
1148 /* If the proper modes are selected then we close the Fd and possibly
1149 unlink the file on error. */
1155 // FileFd::Read - Read a bit of the file /*{{{*/
1156 // ---------------------------------------------------------------------
1157 /* We are carefull to handle interruption by a signal while reading
1159 bool FileFd::Read(void *To
,unsigned long long Size
,unsigned long long *Actual
)
1165 *((char *)To
) = '\0';
1170 Res
= gzread(d
->gz
,To
,Size
);
1175 Res
= BZ2_bzread(d
->bz2
,To
,Size
);
1178 Res
= read(iFd
,To
,Size
);
1189 char const * const errmsg
= gzerror(d
->gz
, &err
);
1191 return _error
->Error("gzread: %s (%d: %s)", _("Read error"), err
, errmsg
);
1198 char const * const errmsg
= BZ2_bzerror(d
->bz2
, &err
);
1199 if (err
!= BZ_IO_ERROR
)
1200 return _error
->Error("BZ2_bzread: %s (%d: %s)", _("Read error"), err
, errmsg
);
1203 return _error
->Errno("read",_("Read error"));
1206 To
= (char *)To
+ Res
;
1212 while (Res
> 0 && Size
> 0);
1225 return _error
->Error(_("read, still have %llu to read but none left"), Size
);
1228 // FileFd::ReadLine - Read a complete line from the file /*{{{*/
1229 // ---------------------------------------------------------------------
1230 /* Beware: This method can be quiet slow for big buffers on UNcompressed
1231 files because of the naive implementation! */
1232 char* FileFd::ReadLine(char *To
, unsigned long long const Size
)
1237 return gzgets(d
->gz
, To
, Size
);
1240 unsigned long long read
= 0;
1241 while ((Size
- 1) != read
)
1243 unsigned long long done
= 0;
1244 if (Read(To
+ read
, 1, &done
) == false)
1248 if (To
[read
++] == '\n')
1257 // FileFd::Write - Write to the file /*{{{*/
1258 // ---------------------------------------------------------------------
1260 bool FileFd::Write(const void *From
,unsigned long long Size
)
1268 Res
= gzwrite(d
->gz
,From
,Size
);
1273 Res
= BZ2_bzwrite(d
->bz2
,(void*)From
,Size
);
1276 Res
= write(iFd
,From
,Size
);
1277 if (Res
< 0 && errno
== EINTR
)
1286 char const * const errmsg
= gzerror(d
->gz
, &err
);
1288 return _error
->Error("gzwrite: %s (%d: %s)", _("Write error"), err
, errmsg
);
1295 char const * const errmsg
= BZ2_bzerror(d
->bz2
, &err
);
1296 if (err
!= BZ_IO_ERROR
)
1297 return _error
->Error("BZ2_bzwrite: %s (%d: %s)", _("Write error"), err
, errmsg
);
1300 return _error
->Errno("write",_("Write error"));
1303 From
= (char *)From
+ Res
;
1307 while (Res
> 0 && Size
> 0);
1313 return _error
->Error(_("write, still have %llu to write but couldn't"), Size
);
1315 bool FileFd::Write(int Fd
, const void *From
, unsigned long long Size
)
1321 Res
= write(Fd
,From
,Size
);
1322 if (Res
< 0 && errno
== EINTR
)
1325 return _error
->Errno("write",_("Write error"));
1327 From
= (char *)From
+ Res
;
1330 while (Res
> 0 && Size
> 0);
1335 return _error
->Error(_("write, still have %llu to write but couldn't"), Size
);
1338 // FileFd::Seek - Seek in the file /*{{{*/
1339 // ---------------------------------------------------------------------
1341 bool FileFd::Seek(unsigned long long To
)
1349 // Our poor man seeking in pipes is costly, so try to avoid it
1350 unsigned long long seekpos
= Tell();
1353 else if (seekpos
< To
)
1354 return Skip(To
- seekpos
);
1356 if ((d
->openmode
& ReadOnly
) != ReadOnly
)
1357 return _error
->Error("Reopen is only implemented for read-only files!");
1360 BZ2_bzclose(d
->bz2
);
1365 if (TemporaryFileName
.empty() == false)
1366 iFd
= open(TemporaryFileName
.c_str(), O_RDONLY
);
1367 else if (FileName
.empty() == false)
1368 iFd
= open(FileName
.c_str(), O_RDONLY
);
1371 if (d
->compressed_fd
> 0)
1372 if (lseek(d
->compressed_fd
, 0, SEEK_SET
) != 0)
1373 iFd
= d
->compressed_fd
;
1375 return _error
->Error("Reopen is not implemented for pipes opened with FileFd::OpenDescriptor()!");
1378 if (OpenInternDescriptor(d
->openmode
, d
->compressor
) == false)
1379 return _error
->Error("Seek on file %s because it couldn't be reopened", FileName
.c_str());
1390 res
= gzseek(d
->gz
,To
,SEEK_SET
);
1393 res
= lseek(iFd
,To
,SEEK_SET
);
1394 if (res
!= (signed)To
)
1397 return _error
->Error("Unable to seek to %llu", To
);
1404 // FileFd::Skip - Seek in the file /*{{{*/
1405 // ---------------------------------------------------------------------
1407 bool FileFd::Skip(unsigned long long Over
)
1419 unsigned long long toread
= std::min((unsigned long long) sizeof(buffer
), Over
);
1420 if (Read(buffer
, toread
) == false)
1421 return _error
->Error("Unable to seek ahead %llu",Over
);
1430 res
= gzseek(d
->gz
,Over
,SEEK_CUR
);
1433 res
= lseek(iFd
,Over
,SEEK_CUR
);
1437 return _error
->Error("Unable to seek ahead %llu",Over
);
1444 // FileFd::Truncate - Truncate the file /*{{{*/
1445 // ---------------------------------------------------------------------
1447 bool FileFd::Truncate(unsigned long long To
)
1449 #if defined HAVE_ZLIB || defined HAVE_BZ2
1450 if (d
->gz
!= NULL
|| d
->bz2
!= NULL
)
1453 return _error
->Error("Truncating compressed files is not implemented (%s)", FileName
.c_str());
1456 if (ftruncate(iFd
,To
) != 0)
1459 return _error
->Error("Unable to truncate to %llu",To
);
1465 // FileFd::Tell - Current seek position /*{{{*/
1466 // ---------------------------------------------------------------------
1468 unsigned long long FileFd::Tell()
1470 // In theory, we could just return seekpos here always instead of
1471 // seeking around, but not all users of FileFd use always Seek() and co
1472 // so d->seekpos isn't always true and we can just use it as a hint if
1473 // we have nothing else, but not always as an authority…
1484 Res
= gztell(d
->gz
);
1487 Res
= lseek(iFd
,0,SEEK_CUR
);
1488 if (Res
== (off_t
)-1)
1489 _error
->Errno("lseek","Failed to determine the current file position");
1494 // FileFd::FileSize - Return the size of the file /*{{{*/
1495 // ---------------------------------------------------------------------
1497 unsigned long long FileFd::FileSize()
1500 if (d
->pipe
== false && fstat(iFd
,&Buf
) != 0)
1501 return _error
->Errno("fstat","Unable to determine the file size");
1503 // for compressor pipes st_size is undefined and at 'best' zero
1504 if (d
->pipe
== true || S_ISFIFO(Buf
.st_mode
))
1506 // we set it here, too, as we get the info here for free
1507 // in theory the Open-methods should take care of it already
1509 if (stat(FileName
.c_str(), &Buf
) != 0)
1510 return _error
->Errno("stat","Unable to determine the file size");
1516 // FileFd::Size - Return the size of the content in the file /*{{{*/
1517 // ---------------------------------------------------------------------
1519 unsigned long long FileFd::Size()
1521 unsigned long long size
= FileSize();
1523 // for compressor pipes st_size is undefined and at 'best' zero,
1524 // so we 'read' the content and 'seek' back - see there
1527 || (d
->bz2
&& size
> 0)
1531 unsigned long long const oldSeek
= Tell();
1533 unsigned long long read
= 0;
1535 Read(ignore
, sizeof(ignore
), &read
);
1541 // only check gzsize if we are actually a gzip file, just checking for
1542 // "gz" is not sufficient as uncompressed files could be opened with
1543 // gzopen in "direct" mode as well
1544 else if (d
->gz
&& !gzdirect(d
->gz
) && size
> 0)
1546 off_t
const oldPos
= lseek(iFd
,0,SEEK_CUR
);
1547 /* unfortunately zlib.h doesn't provide a gzsize(), so we have to do
1548 * this ourselves; the original (uncompressed) file size is the last 32
1549 * bits of the file */
1550 // FIXME: Size for gz-files is limited by 32bit… no largefile support
1551 if (lseek(iFd
, -4, SEEK_END
) < 0)
1552 return _error
->Errno("lseek","Unable to seek to end of gzipped file");
1554 if (read(iFd
, &size
, 4) != 4)
1555 return _error
->Errno("read","Unable to read original size of gzipped file");
1557 #ifdef WORDS_BIGENDIAN
1558 uint32_t tmp_size
= size
;
1559 uint8_t const * const p
= (uint8_t const * const) &tmp_size
;
1560 tmp_size
= (p
[3] << 24) | (p
[2] << 16) | (p
[1] << 8) | p
[0];
1564 if (lseek(iFd
, oldPos
, SEEK_SET
) < 0)
1565 return _error
->Errno("lseek","Unable to seek in gzipped file");
1574 // FileFd::ModificationTime - Return the time of last touch /*{{{*/
1575 // ---------------------------------------------------------------------
1577 time_t FileFd::ModificationTime()
1580 if (d
->pipe
== false && fstat(iFd
,&Buf
) != 0)
1582 _error
->Errno("fstat","Unable to determine the modification time of file %s", FileName
.c_str());
1586 // for compressor pipes st_size is undefined and at 'best' zero
1587 if (d
->pipe
== true || S_ISFIFO(Buf
.st_mode
))
1589 // we set it here, too, as we get the info here for free
1590 // in theory the Open-methods should take care of it already
1592 if (stat(FileName
.c_str(), &Buf
) != 0)
1594 _error
->Errno("fstat","Unable to determine the modification time of file %s", FileName
.c_str());
1599 return Buf
.st_mtime
;
1602 // FileFd::Close - Close the file if the close flag is set /*{{{*/
1603 // ---------------------------------------------------------------------
1605 bool FileFd::Close()
1611 if ((Flags
& AutoClose
) == AutoClose
)
1614 if (d
!= NULL
&& d
->gz
!= NULL
) {
1615 int const e
= gzclose(d
->gz
);
1616 // gzdclose() on empty files always fails with "buffer error" here, ignore that
1617 if (e
!= 0 && e
!= Z_BUF_ERROR
)
1618 Res
&= _error
->Errno("close",_("Problem closing the gzip file %s"), FileName
.c_str());
1622 if (d
!= NULL
&& d
->bz2
!= NULL
)
1623 BZ2_bzclose(d
->bz2
);
1626 if (iFd
> 0 && close(iFd
) != 0)
1627 Res
&= _error
->Errno("close",_("Problem closing the file %s"), FileName
.c_str());
1630 if ((Flags
& Replace
) == Replace
&& iFd
>= 0) {
1631 if (rename(TemporaryFileName
.c_str(), FileName
.c_str()) != 0)
1632 Res
&= _error
->Errno("rename",_("Problem renaming the file %s to %s"), TemporaryFileName
.c_str(), FileName
.c_str());
1634 FileName
= TemporaryFileName
; // for the unlink() below.
1635 TemporaryFileName
.clear();
1640 if ((Flags
& Fail
) == Fail
&& (Flags
& DelOnFail
) == DelOnFail
&&
1641 FileName
.empty() == false)
1642 if (unlink(FileName
.c_str()) != 0)
1643 Res
&= _error
->WarningE("unlnk",_("Problem unlinking the file %s"), FileName
.c_str());
1647 if (d
->compressor_pid
> 0)
1648 ExecWait(d
->compressor_pid
, "FileFdCompressor", true);
1656 // FileFd::Sync - Sync the file /*{{{*/
1657 // ---------------------------------------------------------------------
1661 #ifdef _POSIX_SYNCHRONIZED_IO
1662 if (fsync(iFd
) != 0)
1663 return _error
->Errno("sync",_("Problem syncing the file"));
1669 gzFile
FileFd::gzFd() { return (gzFile
) d
->gz
; }