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>
47 // FIXME: Compressor Fds have some speed disadvantages and are a bit buggy currently,
48 // so while the current implementation satisfies the testcases it is not a real option
49 // to disable it for now
50 #define APT_USE_ZLIB 1
54 #pragma message "Usage of zlib is DISABLED!"
57 #ifdef WORDS_BIGENDIAN
76 APT::Configuration::Compressor compressor
;
77 unsigned int openmode
;
78 unsigned long long seekpos
;
79 FileFdPrivate() : gz(NULL
), compressed_fd(-1), compressor_pid(-1), pipe(false),
80 openmode(0), seekpos(0) {};
83 // RunScripts - Run a set of scripts from a configuration subtree /*{{{*/
84 // ---------------------------------------------------------------------
86 bool RunScripts(const char *Cnf
)
88 Configuration::Item
const *Opts
= _config
->Tree(Cnf
);
89 if (Opts
== 0 || Opts
->Child
== 0)
93 // Fork for running the system calls
94 pid_t Child
= ExecFork();
99 if (_config
->FindDir("DPkg::Chroot-Directory","/") != "/")
101 std::cerr
<< "Chrooting into "
102 << _config
->FindDir("DPkg::Chroot-Directory")
104 if (chroot(_config
->FindDir("DPkg::Chroot-Directory","/").c_str()) != 0)
108 if (chdir("/tmp/") != 0)
111 unsigned int Count
= 1;
112 for (; Opts
!= 0; Opts
= Opts
->Next
, Count
++)
114 if (Opts
->Value
.empty() == true)
117 if (system(Opts
->Value
.c_str()) != 0)
123 // Wait for the child
125 while (waitpid(Child
,&Status
,0) != Child
)
129 return _error
->Errno("waitpid","Couldn't wait for subprocess");
132 // Restore sig int/quit
133 signal(SIGQUIT
,SIG_DFL
);
134 signal(SIGINT
,SIG_DFL
);
136 // Check for an error code.
137 if (WIFEXITED(Status
) == 0 || WEXITSTATUS(Status
) != 0)
139 unsigned int Count
= WEXITSTATUS(Status
);
143 for (; Opts
!= 0 && Count
!= 1; Opts
= Opts
->Next
, Count
--);
144 _error
->Error("Problem executing scripts %s '%s'",Cnf
,Opts
->Value
.c_str());
147 return _error
->Error("Sub-process returned an error code");
154 // CopyFile - Buffered copy of a file /*{{{*/
155 // ---------------------------------------------------------------------
156 /* The caller is expected to set things so that failure causes erasure */
157 bool CopyFile(FileFd
&From
,FileFd
&To
)
159 if (From
.IsOpen() == false || To
.IsOpen() == false)
162 // Buffered copy between fds
163 SPtrArray
<unsigned char> Buf
= new unsigned char[64000];
164 unsigned long long Size
= From
.Size();
167 unsigned long long ToRead
= Size
;
171 if (From
.Read(Buf
,ToRead
) == false ||
172 To
.Write(Buf
,ToRead
) == false)
181 // GetLock - Gets a lock file /*{{{*/
182 // ---------------------------------------------------------------------
183 /* This will create an empty file of the given name and lock it. Once this
184 is done all other calls to GetLock in any other process will fail with
185 -1. The return result is the fd of the file, the call should call
186 close at some time. */
187 int GetLock(string File
,bool Errors
)
189 // GetLock() is used in aptitude on directories with public-write access
190 // Use O_NOFOLLOW here to prevent symlink traversal attacks
191 int FD
= open(File
.c_str(),O_RDWR
| O_CREAT
| O_NOFOLLOW
,0640);
194 // Read only .. cant have locking problems there.
197 _error
->Warning(_("Not using locking for read only lock file %s"),File
.c_str());
198 return dup(0); // Need something for the caller to close
202 _error
->Errno("open",_("Could not open lock file %s"),File
.c_str());
204 // Feh.. We do this to distinguish the lock vs open case..
208 SetCloseExec(FD
,true);
210 // Aquire a write lock
213 fl
.l_whence
= SEEK_SET
;
216 if (fcntl(FD
,F_SETLK
,&fl
) == -1)
220 _error
->Warning(_("Not using locking for nfs mounted lock file %s"),File
.c_str());
221 return dup(0); // Need something for the caller to close
224 _error
->Errno("open",_("Could not get lock %s"),File
.c_str());
235 // FileExists - Check if a file exists /*{{{*/
236 // ---------------------------------------------------------------------
237 /* Beware: Directories are also files! */
238 bool FileExists(string File
)
241 if (stat(File
.c_str(),&Buf
) != 0)
246 // RealFileExists - Check if a file exists and if it is really a file /*{{{*/
247 // ---------------------------------------------------------------------
249 bool RealFileExists(string File
)
252 if (stat(File
.c_str(),&Buf
) != 0)
254 return ((Buf
.st_mode
& S_IFREG
) != 0);
257 // DirectoryExists - Check if a directory exists and is really one /*{{{*/
258 // ---------------------------------------------------------------------
260 bool DirectoryExists(string
const &Path
)
263 if (stat(Path
.c_str(),&Buf
) != 0)
265 return ((Buf
.st_mode
& S_IFDIR
) != 0);
268 // CreateDirectory - poor man's mkdir -p guarded by a parent directory /*{{{*/
269 // ---------------------------------------------------------------------
270 /* This method will create all directories needed for path in good old
271 mkdir -p style but refuses to do this if Parent is not a prefix of
272 this Path. Example: /var/cache/ and /var/cache/apt/archives are given,
273 so it will create apt/archives if /var/cache exists - on the other
274 hand if the parent is /var/lib the creation will fail as this path
275 is not a parent of the path to be generated. */
276 bool CreateDirectory(string
const &Parent
, string
const &Path
)
278 if (Parent
.empty() == true || Path
.empty() == true)
281 if (DirectoryExists(Path
) == true)
284 if (DirectoryExists(Parent
) == false)
287 // we are not going to create directories "into the blue"
288 if (Path
.find(Parent
, 0) != 0)
291 vector
<string
> const dirs
= VectorizeString(Path
.substr(Parent
.size()), '/');
292 string progress
= Parent
;
293 for (vector
<string
>::const_iterator d
= dirs
.begin(); d
!= dirs
.end(); ++d
)
295 if (d
->empty() == true)
298 progress
.append("/").append(*d
);
299 if (DirectoryExists(progress
) == true)
302 if (mkdir(progress
.c_str(), 0755) != 0)
308 // CreateAPTDirectoryIfNeeded - ensure that the given directory exists /*{{{*/
309 // ---------------------------------------------------------------------
310 /* a small wrapper around CreateDirectory to check if it exists and to
311 remove the trailing "/apt/" from the parent directory if needed */
312 bool CreateAPTDirectoryIfNeeded(string
const &Parent
, string
const &Path
)
314 if (DirectoryExists(Path
) == true)
317 size_t const len
= Parent
.size();
318 if (len
> 5 && Parent
.find("/apt/", len
- 6, 5) == len
- 5)
320 if (CreateDirectory(Parent
.substr(0,len
-5), Path
) == true)
323 else if (CreateDirectory(Parent
, Path
) == true)
329 // GetListOfFilesInDir - returns a vector of files in the given dir /*{{{*/
330 // ---------------------------------------------------------------------
331 /* If an extension is given only files with this extension are included
332 in the returned vector, otherwise every "normal" file is included. */
333 std::vector
<string
> GetListOfFilesInDir(string
const &Dir
, string
const &Ext
,
334 bool const &SortList
, bool const &AllowNoExt
)
336 std::vector
<string
> ext
;
338 if (Ext
.empty() == false)
340 if (AllowNoExt
== true && ext
.empty() == false)
342 return GetListOfFilesInDir(Dir
, ext
, SortList
);
344 std::vector
<string
> GetListOfFilesInDir(string
const &Dir
, std::vector
<string
> const &Ext
,
345 bool const &SortList
)
347 // Attention debuggers: need to be set with the environment config file!
348 bool const Debug
= _config
->FindB("Debug::GetListOfFilesInDir", false);
351 std::clog
<< "Accept in " << Dir
<< " only files with the following " << Ext
.size() << " extensions:" << std::endl
;
352 if (Ext
.empty() == true)
353 std::clog
<< "\tNO extension" << std::endl
;
355 for (std::vector
<string
>::const_iterator e
= Ext
.begin();
357 std::clog
<< '\t' << (e
->empty() == true ? "NO" : *e
) << " extension" << std::endl
;
360 std::vector
<string
> List
;
362 if (DirectoryExists(Dir
.c_str()) == false)
364 _error
->Error(_("List of files can't be created as '%s' is not a directory"), Dir
.c_str());
368 Configuration::MatchAgainstConfig
SilentIgnore("Dir::Ignore-Files-Silently");
369 DIR *D
= opendir(Dir
.c_str());
372 _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
376 for (struct dirent
*Ent
= readdir(D
); Ent
!= 0; Ent
= readdir(D
))
378 // skip "hidden" files
379 if (Ent
->d_name
[0] == '.')
382 // Make sure it is a file and not something else
383 string
const File
= flCombine(Dir
,Ent
->d_name
);
384 #ifdef _DIRENT_HAVE_D_TYPE
385 if (Ent
->d_type
!= DT_REG
)
388 if (RealFileExists(File
.c_str()) == false)
390 if (SilentIgnore
.Match(Ent
->d_name
) == false)
391 _error
->Notice(_("Ignoring '%s' in directory '%s' as it is not a regular file"), Ent
->d_name
, Dir
.c_str());
396 // check for accepted extension:
397 // no extension given -> periods are bad as hell!
398 // extensions given -> "" extension allows no extension
399 if (Ext
.empty() == false)
401 string d_ext
= flExtension(Ent
->d_name
);
402 if (d_ext
== Ent
->d_name
) // no extension
404 if (std::find(Ext
.begin(), Ext
.end(), "") == Ext
.end())
407 std::clog
<< "Bad file: " << Ent
->d_name
<< " → no extension" << std::endl
;
408 if (SilentIgnore
.Match(Ent
->d_name
) == false)
409 _error
->Notice(_("Ignoring file '%s' in directory '%s' as it has no filename extension"), Ent
->d_name
, Dir
.c_str());
413 else if (std::find(Ext
.begin(), Ext
.end(), d_ext
) == Ext
.end())
416 std::clog
<< "Bad file: " << Ent
->d_name
<< " → bad extension »" << flExtension(Ent
->d_name
) << "«" << std::endl
;
417 if (SilentIgnore
.Match(Ent
->d_name
) == false)
418 _error
->Notice(_("Ignoring file '%s' in directory '%s' as it has an invalid filename extension"), Ent
->d_name
, Dir
.c_str());
423 // Skip bad filenames ala run-parts
424 const char *C
= Ent
->d_name
;
426 if (isalpha(*C
) == 0 && isdigit(*C
) == 0
427 && *C
!= '_' && *C
!= '-') {
428 // no required extension -> dot is a bad character
429 if (*C
== '.' && Ext
.empty() == false)
434 // we don't reach the end of the name -> bad character included
438 std::clog
<< "Bad file: " << Ent
->d_name
<< " → bad character »"
439 << *C
<< "« in filename (period allowed: " << (Ext
.empty() ? "no" : "yes") << ")" << std::endl
;
443 // skip filenames which end with a period. These are never valid
447 std::clog
<< "Bad file: " << Ent
->d_name
<< " → Period as last character" << std::endl
;
452 std::clog
<< "Accept file: " << Ent
->d_name
<< " in " << Dir
<< std::endl
;
453 List
.push_back(File
);
457 if (SortList
== true)
458 std::sort(List
.begin(),List
.end());
462 // SafeGetCWD - This is a safer getcwd that returns a dynamic string /*{{{*/
463 // ---------------------------------------------------------------------
464 /* We return / on failure. */
467 // Stash the current dir.
470 if (getcwd(S
,sizeof(S
)-2) == 0)
472 unsigned int Len
= strlen(S
);
478 // GetModificationTime - Get the mtime of the given file or -1 on error /*{{{*/
479 // ---------------------------------------------------------------------
480 /* We return / on failure. */
481 time_t GetModificationTime(string
const &Path
)
484 if (stat(Path
.c_str(), &St
) < 0)
489 // flNotDir - Strip the directory from the filename /*{{{*/
490 // ---------------------------------------------------------------------
492 string
flNotDir(string File
)
494 string::size_type Res
= File
.rfind('/');
495 if (Res
== string::npos
)
498 return string(File
,Res
,Res
- File
.length());
501 // flNotFile - Strip the file from the directory name /*{{{*/
502 // ---------------------------------------------------------------------
503 /* Result ends in a / */
504 string
flNotFile(string File
)
506 string::size_type Res
= File
.rfind('/');
507 if (Res
== string::npos
)
510 return string(File
,0,Res
);
513 // flExtension - Return the extension for the file /*{{{*/
514 // ---------------------------------------------------------------------
516 string
flExtension(string File
)
518 string::size_type Res
= File
.rfind('.');
519 if (Res
== string::npos
)
522 return string(File
,Res
,Res
- File
.length());
525 // flNoLink - If file is a symlink then deref it /*{{{*/
526 // ---------------------------------------------------------------------
527 /* If the name is not a link then the returned path is the input. */
528 string
flNoLink(string File
)
531 if (lstat(File
.c_str(),&St
) != 0 || S_ISLNK(St
.st_mode
) == 0)
533 if (stat(File
.c_str(),&St
) != 0)
536 /* Loop resolving the link. There is no need to limit the number of
537 loops because the stat call above ensures that the symlink is not
545 if ((Res
= readlink(NFile
.c_str(),Buffer
,sizeof(Buffer
))) <= 0 ||
546 (unsigned)Res
>= sizeof(Buffer
))
549 // Append or replace the previous path
551 if (Buffer
[0] == '/')
554 NFile
= flNotFile(NFile
) + Buffer
;
556 // See if we are done
557 if (lstat(NFile
.c_str(),&St
) != 0)
559 if (S_ISLNK(St
.st_mode
) == 0)
564 // flCombine - Combine a file and a directory /*{{{*/
565 // ---------------------------------------------------------------------
566 /* If the file is an absolute path then it is just returned, otherwise
567 the directory is pre-pended to it. */
568 string
flCombine(string Dir
,string File
)
570 if (File
.empty() == true)
573 if (File
[0] == '/' || Dir
.empty() == true)
575 if (File
.length() >= 2 && File
[0] == '.' && File
[1] == '/')
577 if (Dir
[Dir
.length()-1] == '/')
579 return Dir
+ '/' + File
;
582 // SetCloseExec - Set the close on exec flag /*{{{*/
583 // ---------------------------------------------------------------------
585 void SetCloseExec(int Fd
,bool Close
)
587 if (fcntl(Fd
,F_SETFD
,(Close
== false)?0:FD_CLOEXEC
) != 0)
589 cerr
<< "FATAL -> Could not set close on exec " << strerror(errno
) << endl
;
594 // SetNonBlock - Set the nonblocking flag /*{{{*/
595 // ---------------------------------------------------------------------
597 void SetNonBlock(int Fd
,bool Block
)
599 int Flags
= fcntl(Fd
,F_GETFL
) & (~O_NONBLOCK
);
600 if (fcntl(Fd
,F_SETFL
,Flags
| ((Block
== false)?0:O_NONBLOCK
)) != 0)
602 cerr
<< "FATAL -> Could not set non-blocking flag " << strerror(errno
) << endl
;
607 // WaitFd - Wait for a FD to become readable /*{{{*/
608 // ---------------------------------------------------------------------
609 /* This waits for a FD to become readable using select. It is useful for
610 applications making use of non-blocking sockets. The timeout is
612 bool WaitFd(int Fd
,bool write
,unsigned long timeout
)
625 Res
= select(Fd
+1,0,&Set
,0,(timeout
!= 0?&tv
:0));
627 while (Res
< 0 && errno
== EINTR
);
637 Res
= select(Fd
+1,&Set
,0,0,(timeout
!= 0?&tv
:0));
639 while (Res
< 0 && errno
== EINTR
);
648 // ExecFork - Magical fork that sanitizes the context before execing /*{{{*/
649 // ---------------------------------------------------------------------
650 /* This is used if you want to cleanse the environment for the forked
651 child, it fixes up the important signals and nukes all of the fds,
652 otherwise acts like normal fork. */
655 // Fork off the process
656 pid_t Process
= fork();
659 cerr
<< "FATAL -> Failed to fork." << endl
;
663 // Spawn the subprocess
667 signal(SIGPIPE
,SIG_DFL
);
668 signal(SIGQUIT
,SIG_DFL
);
669 signal(SIGINT
,SIG_DFL
);
670 signal(SIGWINCH
,SIG_DFL
);
671 signal(SIGCONT
,SIG_DFL
);
672 signal(SIGTSTP
,SIG_DFL
);
675 Configuration::Item
const *Opts
= _config
->Tree("APT::Keep-Fds");
676 if (Opts
!= 0 && Opts
->Child
!= 0)
679 for (; Opts
!= 0; Opts
= Opts
->Next
)
681 if (Opts
->Value
.empty() == true)
683 int fd
= atoi(Opts
->Value
.c_str());
688 // Close all of our FDs - just in case
689 for (int K
= 3; K
!= 40; K
++)
691 if(KeepFDs
.find(K
) == KeepFDs
.end())
692 fcntl(K
,F_SETFD
,FD_CLOEXEC
);
699 // ExecWait - Fancy waitpid /*{{{*/
700 // ---------------------------------------------------------------------
701 /* Waits for the given sub process. If Reap is set then no errors are
702 generated. Otherwise a failed subprocess will generate a proper descriptive
704 bool ExecWait(pid_t Pid
,const char *Name
,bool Reap
)
709 // Wait and collect the error code
711 while (waitpid(Pid
,&Status
,0) != Pid
)
719 return _error
->Error(_("Waited for %s but it wasn't there"),Name
);
723 // Check for an error code.
724 if (WIFEXITED(Status
) == 0 || WEXITSTATUS(Status
) != 0)
728 if (WIFSIGNALED(Status
) != 0)
730 if( WTERMSIG(Status
) == SIGSEGV
)
731 return _error
->Error(_("Sub-process %s received a segmentation fault."),Name
);
733 return _error
->Error(_("Sub-process %s received signal %u."),Name
, WTERMSIG(Status
));
736 if (WIFEXITED(Status
) != 0)
737 return _error
->Error(_("Sub-process %s returned an error code (%u)"),Name
,WEXITSTATUS(Status
));
739 return _error
->Error(_("Sub-process %s exited unexpectedly"),Name
);
746 // FileFd::Open - Open a file /*{{{*/
747 // ---------------------------------------------------------------------
748 /* The most commonly used open mode combinations are given with Mode */
749 bool FileFd::Open(string FileName
,unsigned int const Mode
,CompressMode Compress
, unsigned long const Perms
)
751 if (Mode
== ReadOnlyGzip
)
752 return Open(FileName
, ReadOnly
, Gzip
, Perms
);
754 if (Compress
== Auto
&& (Mode
& WriteOnly
) == WriteOnly
)
755 return _error
->Error("Autodetection on %s only works in ReadOnly openmode!", FileName
.c_str());
757 // FIXME: Denote inbuilt compressors somehow - as we don't need to have the binaries for them
758 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
759 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
760 if (Compress
== Auto
)
762 for (; compressor
!= compressors
.end(); ++compressor
)
764 std::string file
= std::string(FileName
).append(compressor
->Extension
);
765 if (FileExists(file
) == false)
771 else if (Compress
== Extension
)
773 std::string::size_type
const found
= FileName
.find_last_of('.');
775 if (found
!= std::string::npos
)
777 ext
= FileName
.substr(found
);
778 if (ext
== ".new" || ext
== ".bak")
780 std::string::size_type
const found2
= FileName
.find_last_of('.', found
- 1);
781 if (found2
!= std::string::npos
)
782 ext
= FileName
.substr(found2
, found
- found2
);
787 for (; compressor
!= compressors
.end(); ++compressor
)
788 if (ext
== compressor
->Extension
)
790 // no matching extension - assume uncompressed (imagine files like 'example.org_Packages')
791 if (compressor
== compressors
.end())
792 for (compressor
= compressors
.begin(); compressor
!= compressors
.end(); ++compressor
)
793 if (compressor
->Name
== ".")
801 case None
: name
= "."; break;
802 case Gzip
: name
= "gzip"; break;
803 case Bzip2
: name
= "bzip2"; break;
804 case Lzma
: name
= "lzma"; break;
805 case Xz
: name
= "xz"; break;
809 return _error
->Error("Opening File %s in None, Auto or Extension should be already handled?!?", FileName
.c_str());
811 for (; compressor
!= compressors
.end(); ++compressor
)
812 if (compressor
->Name
== name
)
814 if (compressor
== compressors
.end())
815 return _error
->Error("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
818 if (compressor
== compressors
.end())
819 return _error
->Error("Can't find a match for specified compressor mode for file %s", FileName
.c_str());
820 return Open(FileName
, Mode
, *compressor
, Perms
);
822 bool FileFd::Open(string FileName
,unsigned int const Mode
,APT::Configuration::Compressor
const &compressor
, unsigned long const Perms
)
825 d
= new FileFdPrivate
;
829 if ((Mode
& WriteOnly
) != WriteOnly
&& (Mode
& (Atomic
| Create
| Empty
| Exclusive
)) != 0)
830 return _error
->Error("ReadOnly mode for %s doesn't accept additional flags!", FileName
.c_str());
831 if ((Mode
& ReadWrite
) == 0)
832 return _error
->Error("No openmode provided in FileFd::Open for %s", FileName
.c_str());
834 if ((Mode
& Atomic
) == Atomic
)
837 char *name
= strdup((FileName
+ ".XXXXXX").c_str());
838 TemporaryFileName
= string(mktemp(name
));
841 else if ((Mode
& (Exclusive
| Create
)) == (Exclusive
| Create
))
843 // for atomic, this will be done by rename in Close()
844 unlink(FileName
.c_str());
846 if ((Mode
& Empty
) == Empty
)
849 if (lstat(FileName
.c_str(),&Buf
) == 0 && S_ISLNK(Buf
.st_mode
))
850 unlink(FileName
.c_str());
854 #define if_FLAGGED_SET(FLAG, MODE) if ((Mode & FLAG) == FLAG) fileflags |= MODE
855 if_FLAGGED_SET(ReadWrite
, O_RDWR
);
856 else if_FLAGGED_SET(ReadOnly
, O_RDONLY
);
857 else if_FLAGGED_SET(WriteOnly
, O_WRONLY
);
859 if_FLAGGED_SET(Create
, O_CREAT
);
860 if_FLAGGED_SET(Empty
, O_TRUNC
);
861 if_FLAGGED_SET(Exclusive
, O_EXCL
);
862 else if_FLAGGED_SET(Atomic
, O_EXCL
);
863 #undef if_FLAGGED_SET
865 if (TemporaryFileName
.empty() == false)
866 iFd
= open(TemporaryFileName
.c_str(), fileflags
, Perms
);
868 iFd
= open(FileName
.c_str(), fileflags
, Perms
);
870 if (iFd
== -1 || OpenInternDescriptor(Mode
, compressor
) == false)
877 return _error
->Errno("open",_("Could not open file %s"), FileName
.c_str());
880 this->FileName
= FileName
;
881 SetCloseExec(iFd
,true);
885 // FileFd::OpenDescriptor - Open a filedescriptor /*{{{*/
886 // ---------------------------------------------------------------------
888 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, CompressMode Compress
, bool AutoClose
)
890 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
891 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
895 case None
: name
= "."; break;
896 case Gzip
: name
= "gzip"; break;
897 case Bzip2
: name
= "bzip2"; break;
898 case Lzma
: name
= "lzma"; break;
899 case Xz
: name
= "xz"; break;
902 return _error
->Error("Opening Fd %d in Auto or Extension compression mode is not supported", Fd
);
904 for (; compressor
!= compressors
.end(); ++compressor
)
905 if (compressor
->Name
== name
)
907 if (compressor
== compressors
.end())
908 return _error
->Error("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
910 return OpenDescriptor(Fd
, Mode
, *compressor
, AutoClose
);
912 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
, bool AutoClose
)
915 d
= new FileFdPrivate
;
917 Flags
= (AutoClose
) ? FileFd::AutoClose
: 0;
919 if (OpenInternDescriptor(Mode
, compressor
) == false)
923 return _error
->Errno("gzdopen",_("Could not open file descriptor %d"), Fd
);
928 bool FileFd::OpenInternDescriptor(unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
)
930 d
->compressor
= compressor
;
931 if (compressor
.Name
== "." || compressor
.Binary
.empty() == true)
934 else if (compressor
.Name
== "gzip")
936 if ((Mode
& ReadWrite
) == ReadWrite
)
937 d
->gz
= gzdopen(iFd
, "r+");
938 else if ((Mode
& WriteOnly
) == WriteOnly
)
939 d
->gz
= gzdopen(iFd
, "w");
941 d
->gz
= gzdopen (iFd
, "r");
949 if ((Mode
& ReadWrite
) == ReadWrite
)
950 return _error
->Error("ReadWrite mode is not supported for file %s", FileName
.c_str());
952 bool const Comp
= (Mode
& WriteOnly
) == WriteOnly
;
953 // Handle 'decompression' of empty files
958 if (Buf
.st_size
== 0 && S_ISFIFO(Buf
.st_mode
) == false)
961 // We don't need the file open - instead let the compressor open it
962 // as he properly knows better how to efficiently read from 'his' file
963 if (FileName
.empty() == false)
967 // Create a data pipe
968 int Pipe
[2] = {-1,-1};
970 return _error
->Errno("pipe",_("Failed to create subprocess IPC"));
971 for (int J
= 0; J
!= 2; J
++)
972 SetCloseExec(Pipe
[J
],true);
974 d
->compressed_fd
= iFd
;
983 d
->compressor_pid
= ExecFork();
984 if (d
->compressor_pid
== 0)
988 dup2(d
->compressed_fd
,STDOUT_FILENO
);
989 dup2(Pipe
[0],STDIN_FILENO
);
993 if (FileName
.empty() == true)
994 dup2(d
->compressed_fd
,STDIN_FILENO
);
995 dup2(Pipe
[1],STDOUT_FILENO
);
998 SetCloseExec(STDOUT_FILENO
,false);
999 SetCloseExec(STDIN_FILENO
,false);
1001 std::vector
<char const*> Args
;
1002 Args
.push_back(compressor
.Binary
.c_str());
1003 std::vector
<std::string
> const * const addArgs
=
1004 (Comp
== true) ? &(compressor
.CompressArgs
) : &(compressor
.UncompressArgs
);
1005 for (std::vector
<std::string
>::const_iterator a
= addArgs
->begin();
1006 a
!= addArgs
->end(); ++a
)
1007 Args
.push_back(a
->c_str());
1008 if (Comp
== false && FileName
.empty() == false)
1010 Args
.push_back("--stdout");
1011 if (TemporaryFileName
.empty() == false)
1012 Args
.push_back(TemporaryFileName
.c_str());
1014 Args
.push_back(FileName
.c_str());
1016 Args
.push_back(NULL
);
1018 execvp(Args
[0],(char **)&Args
[0]);
1019 cerr
<< _("Failed to exec compressor ") << Args
[0] << endl
;
1026 if (Comp
== true || FileName
.empty() == true)
1027 close(d
->compressed_fd
);
1032 // FileFd::~File - Closes the file /*{{{*/
1033 // ---------------------------------------------------------------------
1034 /* If the proper modes are selected then we close the Fd and possibly
1035 unlink the file on error. */
1041 // FileFd::Read - Read a bit of the file /*{{{*/
1042 // ---------------------------------------------------------------------
1043 /* We are carefull to handle interruption by a signal while reading
1045 bool FileFd::Read(void *To
,unsigned long long Size
,unsigned long long *Actual
)
1051 *((char *)To
) = '\0';
1056 Res
= gzread(d
->gz
,To
,Size
);
1059 Res
= read(iFd
,To
,Size
);
1060 if (Res
< 0 && errno
== EINTR
)
1065 return _error
->Errno("read",_("Read error"));
1068 To
= (char *)To
+ Res
;
1074 while (Res
> 0 && Size
> 0);
1087 return _error
->Error(_("read, still have %llu to read but none left"), Size
);
1090 // FileFd::ReadLine - Read a complete line from the file /*{{{*/
1091 // ---------------------------------------------------------------------
1092 /* Beware: This method can be quiet slow for big buffers on UNcompressed
1093 files because of the naive implementation! */
1094 char* FileFd::ReadLine(char *To
, unsigned long long const Size
)
1099 return gzgets(d
->gz
, To
, Size
);
1102 unsigned long long read
= 0;
1103 while ((Size
- 1) != read
)
1105 unsigned long long done
= 0;
1106 if (Read(To
+ read
, 1, &done
) == false)
1110 if (To
[read
++] == '\n')
1119 // FileFd::Write - Write to the file /*{{{*/
1120 // ---------------------------------------------------------------------
1122 bool FileFd::Write(const void *From
,unsigned long long Size
)
1130 Res
= gzwrite(d
->gz
,From
,Size
);
1133 Res
= write(iFd
,From
,Size
);
1134 if (Res
< 0 && errno
== EINTR
)
1139 return _error
->Errno("write",_("Write error"));
1142 From
= (char *)From
+ Res
;
1146 while (Res
> 0 && Size
> 0);
1152 return _error
->Error(_("write, still have %llu to write but couldn't"), Size
);
1155 // FileFd::Seek - Seek in the file /*{{{*/
1156 // ---------------------------------------------------------------------
1158 bool FileFd::Seek(unsigned long long To
)
1160 if (d
->pipe
== true)
1162 // Our poor man seeking in pipes is costly, so try to avoid it
1163 unsigned long long seekpos
= Tell();
1166 else if (seekpos
< To
)
1167 return Skip(To
- seekpos
);
1169 if ((d
->openmode
& ReadOnly
) != ReadOnly
)
1170 return _error
->Error("Reopen is only implemented for read-only files!");
1173 if (TemporaryFileName
.empty() == false)
1174 iFd
= open(TemporaryFileName
.c_str(), O_RDONLY
);
1175 else if (FileName
.empty() == false)
1176 iFd
= open(FileName
.c_str(), O_RDONLY
);
1179 if (d
->compressed_fd
> 0)
1180 if (lseek(d
->compressed_fd
, 0, SEEK_SET
) != 0)
1181 iFd
= d
->compressed_fd
;
1183 return _error
->Error("Reopen is not implemented for pipes opened with FileFd::OpenDescriptor()!");
1186 if (OpenInternDescriptor(d
->openmode
, d
->compressor
) == false)
1187 return _error
->Error("Seek on file %s because it couldn't be reopened", FileName
.c_str());
1198 res
= gzseek(d
->gz
,To
,SEEK_SET
);
1201 res
= lseek(iFd
,To
,SEEK_SET
);
1202 if (res
!= (signed)To
)
1205 return _error
->Error("Unable to seek to %llu", To
);
1212 // FileFd::Skip - Seek in the file /*{{{*/
1213 // ---------------------------------------------------------------------
1215 bool FileFd::Skip(unsigned long long Over
)
1217 if (d
->pipe
== true)
1223 unsigned long long toread
= std::min((unsigned long long) sizeof(buffer
), Over
);
1224 if (Read(buffer
, toread
) == false)
1225 return _error
->Error("Unable to seek ahead %llu",Over
);
1234 res
= gzseek(d
->gz
,Over
,SEEK_CUR
);
1237 res
= lseek(iFd
,Over
,SEEK_CUR
);
1241 return _error
->Error("Unable to seek ahead %llu",Over
);
1248 // FileFd::Truncate - Truncate the file /*{{{*/
1249 // ---------------------------------------------------------------------
1251 bool FileFd::Truncate(unsigned long long To
)
1256 return _error
->Error("Truncating gzipped files is not implemented (%s)", FileName
.c_str());
1258 if (ftruncate(iFd
,To
) != 0)
1261 return _error
->Error("Unable to truncate to %llu",To
);
1267 // FileFd::Tell - Current seek position /*{{{*/
1268 // ---------------------------------------------------------------------
1270 unsigned long long FileFd::Tell()
1272 // In theory, we could just return seekpos here always instead of
1273 // seeking around, but not all users of FileFd use always Seek() and co
1274 // so d->seekpos isn't always true and we can just use it as a hint if
1275 // we have nothing else, but not always as an authority…
1276 if (d
->pipe
== true)
1282 Res
= gztell(d
->gz
);
1285 Res
= lseek(iFd
,0,SEEK_CUR
);
1286 if (Res
== (off_t
)-1)
1287 _error
->Errno("lseek","Failed to determine the current file position");
1292 // FileFd::FileSize - Return the size of the file /*{{{*/
1293 // ---------------------------------------------------------------------
1295 unsigned long long FileFd::FileSize()
1298 if (d
->pipe
== false && fstat(iFd
,&Buf
) != 0)
1299 return _error
->Errno("fstat","Unable to determine the file size");
1301 // for compressor pipes st_size is undefined and at 'best' zero
1302 if (d
->pipe
== true || S_ISFIFO(Buf
.st_mode
))
1304 // we set it here, too, as we get the info here for free
1305 // in theory the Open-methods should take care of it already
1307 if (stat(FileName
.c_str(), &Buf
) != 0)
1308 return _error
->Errno("stat","Unable to determine the file size");
1314 // FileFd::Size - Return the size of the content in the file /*{{{*/
1315 // ---------------------------------------------------------------------
1317 unsigned long long FileFd::Size()
1319 unsigned long long size
= FileSize();
1321 // for compressor pipes st_size is undefined and at 'best' zero,
1322 // so we 'read' the content and 'seek' back - see there
1323 if (d
->pipe
== true)
1325 unsigned long long const oldSeek
= Tell();
1327 unsigned long long read
= 0;
1329 Read(ignore
, sizeof(ignore
), &read
);
1335 // only check gzsize if we are actually a gzip file, just checking for
1336 // "gz" is not sufficient as uncompressed files could be opened with
1337 // gzopen in "direct" mode as well
1338 else if (d
->gz
&& !gzdirect(d
->gz
) && size
> 0)
1340 /* unfortunately zlib.h doesn't provide a gzsize(), so we have to do
1341 * this ourselves; the original (uncompressed) file size is the last 32
1342 * bits of the file */
1343 // FIXME: Size for gz-files is limited by 32bit… no largefile support
1344 if (lseek(iFd
, -4, SEEK_END
) < 0)
1345 return _error
->Errno("lseek","Unable to seek to end of gzipped file");
1347 if (read(iFd
, &size
, 4) != 4)
1348 return _error
->Errno("read","Unable to read original size of gzipped file");
1350 #ifdef WORDS_BIGENDIAN
1351 uint32_t tmp_size
= size
;
1352 uint8_t const * const p
= (uint8_t const * const) &tmp_size
;
1353 tmp_size
= (p
[3] << 24) | (p
[2] << 16) | (p
[1] << 8) | p
[0];
1357 if (lseek(iFd
, d
->seekpos
, SEEK_SET
) < 0)
1358 return _error
->Errno("lseek","Unable to seek in gzipped file");
1366 // FileFd::ModificationTime - Return the time of last touch /*{{{*/
1367 // ---------------------------------------------------------------------
1369 time_t FileFd::ModificationTime()
1372 if (d
->pipe
== false && fstat(iFd
,&Buf
) != 0)
1374 _error
->Errno("fstat","Unable to determine the modification time of file %s", FileName
.c_str());
1378 // for compressor pipes st_size is undefined and at 'best' zero
1379 if (d
->pipe
== true || S_ISFIFO(Buf
.st_mode
))
1381 // we set it here, too, as we get the info here for free
1382 // in theory the Open-methods should take care of it already
1384 if (stat(FileName
.c_str(), &Buf
) != 0)
1386 _error
->Errno("fstat","Unable to determine the modification time of file %s", FileName
.c_str());
1391 return Buf
.st_mtime
;
1394 // FileFd::Close - Close the file if the close flag is set /*{{{*/
1395 // ---------------------------------------------------------------------
1397 bool FileFd::Close()
1403 if ((Flags
& AutoClose
) == AutoClose
)
1406 if (d
!= NULL
&& d
->gz
!= NULL
) {
1407 int const e
= gzclose(d
->gz
);
1408 // gzdopen() on empty files always fails with "buffer error" here, ignore that
1409 if (e
!= 0 && e
!= Z_BUF_ERROR
)
1410 Res
&= _error
->Errno("close",_("Problem closing the gzip file %s"), FileName
.c_str());
1413 if (iFd
> 0 && close(iFd
) != 0)
1414 Res
&= _error
->Errno("close",_("Problem closing the file %s"), FileName
.c_str());
1417 if ((Flags
& Replace
) == Replace
&& iFd
>= 0) {
1418 if (rename(TemporaryFileName
.c_str(), FileName
.c_str()) != 0)
1419 Res
&= _error
->Errno("rename",_("Problem renaming the file %s to %s"), TemporaryFileName
.c_str(), FileName
.c_str());
1421 FileName
= TemporaryFileName
; // for the unlink() below.
1422 TemporaryFileName
.clear();
1427 if ((Flags
& Fail
) == Fail
&& (Flags
& DelOnFail
) == DelOnFail
&&
1428 FileName
.empty() == false)
1429 if (unlink(FileName
.c_str()) != 0)
1430 Res
&= _error
->WarningE("unlnk",_("Problem unlinking the file %s"), FileName
.c_str());
1434 if (d
->compressor_pid
> 0)
1435 ExecWait(d
->compressor_pid
, "FileFdCompressor", true);
1443 // FileFd::Sync - Sync the file /*{{{*/
1444 // ---------------------------------------------------------------------
1448 #ifdef _POSIX_SYNCHRONIZED_IO
1449 if (fsync(iFd
) != 0)
1450 return _error
->Errno("sync",_("Problem syncing the file"));
1456 gzFile
FileFd::gzFd() { return (gzFile
) d
->gz
; }