1 // -*- mode: cpp; mode: fold -*-
3 /* ######################################################################
7 CopyFile - Buffered copy of a single file
8 GetLock - dpkg compatible lock file manipulation (fcntl)
10 Most of this source is placed in the Public Domain, do with it what
12 It was originally written by Jason Gunthorpe <jgg@debian.org>.
13 FileFd gzip support added by Martin Pitt <martin.pitt@canonical.com>
15 The exception is RunScripts() it is under the GPLv2
17 ##################################################################### */
19 // Include Files /*{{{*/
22 #include <apt-pkg/fileutl.h>
23 #include <apt-pkg/strutl.h>
24 #include <apt-pkg/error.h>
25 #include <apt-pkg/sptr.h>
26 #include <apt-pkg/aptconfiguration.h>
27 #include <apt-pkg/configuration.h>
28 #include <apt-pkg/macros.h>
33 #include <sys/select.h>
69 #include <sys/prctl.h>
77 // RunScripts - Run a set of scripts from a configuration subtree /*{{{*/
78 // ---------------------------------------------------------------------
80 bool RunScripts(const char *Cnf
)
82 Configuration::Item
const *Opts
= _config
->Tree(Cnf
);
83 if (Opts
== 0 || Opts
->Child
== 0)
87 // Fork for running the system calls
88 pid_t Child
= ExecFork();
93 if (_config
->FindDir("DPkg::Chroot-Directory","/") != "/")
95 std::cerr
<< "Chrooting into "
96 << _config
->FindDir("DPkg::Chroot-Directory")
98 if (chroot(_config
->FindDir("DPkg::Chroot-Directory","/").c_str()) != 0)
102 if (chdir("/tmp/") != 0)
105 unsigned int Count
= 1;
106 for (; Opts
!= 0; Opts
= Opts
->Next
, Count
++)
108 if (Opts
->Value
.empty() == true)
111 if(_config
->FindB("Debug::RunScripts", false) == true)
112 std::clog
<< "Running external script: '"
113 << Opts
->Value
<< "'" << std::endl
;
115 if (system(Opts
->Value
.c_str()) != 0)
121 // Wait for the child
123 while (waitpid(Child
,&Status
,0) != Child
)
127 return _error
->Errno("waitpid","Couldn't wait for subprocess");
130 // Restore sig int/quit
131 signal(SIGQUIT
,SIG_DFL
);
132 signal(SIGINT
,SIG_DFL
);
134 // Check for an error code.
135 if (WIFEXITED(Status
) == 0 || WEXITSTATUS(Status
) != 0)
137 unsigned int Count
= WEXITSTATUS(Status
);
141 for (; Opts
!= 0 && Count
!= 1; Opts
= Opts
->Next
, Count
--);
142 _error
->Error("Problem executing scripts %s '%s'",Cnf
,Opts
->Value
.c_str());
145 return _error
->Error("Sub-process returned an error code");
152 // CopyFile - Buffered copy of a file /*{{{*/
153 // ---------------------------------------------------------------------
154 /* The caller is expected to set things so that failure causes erasure */
155 bool CopyFile(FileFd
&From
,FileFd
&To
)
157 if (From
.IsOpen() == false || To
.IsOpen() == false ||
158 From
.Failed() == true || To
.Failed() == true)
161 // Buffered copy between fds
162 SPtrArray
<unsigned char> Buf
= new unsigned char[64000];
163 unsigned long long Size
= From
.Size();
166 unsigned long long ToRead
= Size
;
170 if (From
.Read(Buf
,ToRead
) == false ||
171 To
.Write(Buf
,ToRead
) == false)
180 // GetLock - Gets a lock file /*{{{*/
181 // ---------------------------------------------------------------------
182 /* This will create an empty file of the given name and lock it. Once this
183 is done all other calls to GetLock in any other process will fail with
184 -1. The return result is the fd of the file, the call should call
185 close at some time. */
186 int GetLock(string File
,bool Errors
)
188 // GetLock() is used in aptitude on directories with public-write access
189 // Use O_NOFOLLOW here to prevent symlink traversal attacks
190 int FD
= open(File
.c_str(),O_RDWR
| O_CREAT
| O_NOFOLLOW
,0640);
193 // Read only .. can't have locking problems there.
196 _error
->Warning(_("Not using locking for read only lock file %s"),File
.c_str());
197 return dup(0); // Need something for the caller to close
201 _error
->Errno("open",_("Could not open lock file %s"),File
.c_str());
203 // Feh.. We do this to distinguish the lock vs open case..
207 SetCloseExec(FD
,true);
209 // Acquire a write lock
212 fl
.l_whence
= SEEK_SET
;
215 if (fcntl(FD
,F_SETLK
,&fl
) == -1)
217 // always close to not leak resources
224 _error
->Warning(_("Not using locking for nfs mounted lock file %s"),File
.c_str());
225 return dup(0); // Need something for the caller to close
229 _error
->Errno("open",_("Could not get lock %s"),File
.c_str());
237 // FileExists - Check if a file exists /*{{{*/
238 // ---------------------------------------------------------------------
239 /* Beware: Directories are also files! */
240 bool FileExists(string File
)
243 if (stat(File
.c_str(),&Buf
) != 0)
248 // RealFileExists - Check if a file exists and if it is really a file /*{{{*/
249 // ---------------------------------------------------------------------
251 bool RealFileExists(string File
)
254 if (stat(File
.c_str(),&Buf
) != 0)
256 return ((Buf
.st_mode
& S_IFREG
) != 0);
259 // DirectoryExists - Check if a directory exists and is really one /*{{{*/
260 // ---------------------------------------------------------------------
262 bool DirectoryExists(string
const &Path
)
265 if (stat(Path
.c_str(),&Buf
) != 0)
267 return ((Buf
.st_mode
& S_IFDIR
) != 0);
270 // CreateDirectory - poor man's mkdir -p guarded by a parent directory /*{{{*/
271 // ---------------------------------------------------------------------
272 /* This method will create all directories needed for path in good old
273 mkdir -p style but refuses to do this if Parent is not a prefix of
274 this Path. Example: /var/cache/ and /var/cache/apt/archives are given,
275 so it will create apt/archives if /var/cache exists - on the other
276 hand if the parent is /var/lib the creation will fail as this path
277 is not a parent of the path to be generated. */
278 bool CreateDirectory(string
const &Parent
, string
const &Path
)
280 if (Parent
.empty() == true || Path
.empty() == true)
283 if (DirectoryExists(Path
) == true)
286 if (DirectoryExists(Parent
) == false)
289 // we are not going to create directories "into the blue"
290 if (Path
.compare(0, Parent
.length(), Parent
) != 0)
293 vector
<string
> const dirs
= VectorizeString(Path
.substr(Parent
.size()), '/');
294 string progress
= Parent
;
295 for (vector
<string
>::const_iterator d
= dirs
.begin(); d
!= dirs
.end(); ++d
)
297 if (d
->empty() == true)
300 progress
.append("/").append(*d
);
301 if (DirectoryExists(progress
) == true)
304 if (mkdir(progress
.c_str(), 0755) != 0)
310 // CreateAPTDirectoryIfNeeded - ensure that the given directory exists /*{{{*/
311 // ---------------------------------------------------------------------
312 /* a small wrapper around CreateDirectory to check if it exists and to
313 remove the trailing "/apt/" from the parent directory if needed */
314 bool CreateAPTDirectoryIfNeeded(string
const &Parent
, string
const &Path
)
316 if (DirectoryExists(Path
) == true)
319 size_t const len
= Parent
.size();
320 if (len
> 5 && Parent
.find("/apt/", len
- 6, 5) == len
- 5)
322 if (CreateDirectory(Parent
.substr(0,len
-5), Path
) == true)
325 else if (CreateDirectory(Parent
, Path
) == true)
331 // GetListOfFilesInDir - returns a vector of files in the given dir /*{{{*/
332 // ---------------------------------------------------------------------
333 /* If an extension is given only files with this extension are included
334 in the returned vector, otherwise every "normal" file is included. */
335 std::vector
<string
> GetListOfFilesInDir(string
const &Dir
, string
const &Ext
,
336 bool const &SortList
, bool const &AllowNoExt
)
338 std::vector
<string
> ext
;
340 if (Ext
.empty() == false)
342 if (AllowNoExt
== true && ext
.empty() == false)
344 return GetListOfFilesInDir(Dir
, ext
, SortList
);
346 std::vector
<string
> GetListOfFilesInDir(string
const &Dir
, std::vector
<string
> const &Ext
,
347 bool const &SortList
)
349 // Attention debuggers: need to be set with the environment config file!
350 bool const Debug
= _config
->FindB("Debug::GetListOfFilesInDir", false);
353 std::clog
<< "Accept in " << Dir
<< " only files with the following " << Ext
.size() << " extensions:" << std::endl
;
354 if (Ext
.empty() == true)
355 std::clog
<< "\tNO extension" << std::endl
;
357 for (std::vector
<string
>::const_iterator e
= Ext
.begin();
359 std::clog
<< '\t' << (e
->empty() == true ? "NO" : *e
) << " extension" << std::endl
;
362 std::vector
<string
> List
;
364 if (DirectoryExists(Dir
) == false)
366 _error
->Error(_("List of files can't be created as '%s' is not a directory"), Dir
.c_str());
370 Configuration::MatchAgainstConfig
SilentIgnore("Dir::Ignore-Files-Silently");
371 DIR *D
= opendir(Dir
.c_str());
374 _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
378 for (struct dirent
*Ent
= readdir(D
); Ent
!= 0; Ent
= readdir(D
))
380 // skip "hidden" files
381 if (Ent
->d_name
[0] == '.')
384 // Make sure it is a file and not something else
385 string
const File
= flCombine(Dir
,Ent
->d_name
);
386 #ifdef _DIRENT_HAVE_D_TYPE
387 if (Ent
->d_type
!= DT_REG
)
390 if (RealFileExists(File
) == false)
392 // do not show ignoration warnings for directories
394 #ifdef _DIRENT_HAVE_D_TYPE
395 Ent
->d_type
== DT_DIR
||
397 DirectoryExists(File
) == true)
399 if (SilentIgnore
.Match(Ent
->d_name
) == false)
400 _error
->Notice(_("Ignoring '%s' in directory '%s' as it is not a regular file"), Ent
->d_name
, Dir
.c_str());
405 // check for accepted extension:
406 // no extension given -> periods are bad as hell!
407 // extensions given -> "" extension allows no extension
408 if (Ext
.empty() == false)
410 string d_ext
= flExtension(Ent
->d_name
);
411 if (d_ext
== Ent
->d_name
) // no extension
413 if (std::find(Ext
.begin(), Ext
.end(), "") == Ext
.end())
416 std::clog
<< "Bad file: " << Ent
->d_name
<< " → no extension" << std::endl
;
417 if (SilentIgnore
.Match(Ent
->d_name
) == false)
418 _error
->Notice(_("Ignoring file '%s' in directory '%s' as it has no filename extension"), Ent
->d_name
, Dir
.c_str());
422 else if (std::find(Ext
.begin(), Ext
.end(), d_ext
) == Ext
.end())
425 std::clog
<< "Bad file: " << Ent
->d_name
<< " → bad extension »" << flExtension(Ent
->d_name
) << "«" << std::endl
;
426 if (SilentIgnore
.Match(Ent
->d_name
) == false)
427 _error
->Notice(_("Ignoring file '%s' in directory '%s' as it has an invalid filename extension"), Ent
->d_name
, Dir
.c_str());
432 // Skip bad filenames ala run-parts
433 const char *C
= Ent
->d_name
;
435 if (isalpha(*C
) == 0 && isdigit(*C
) == 0
436 && *C
!= '_' && *C
!= '-' && *C
!= ':') {
437 // no required extension -> dot is a bad character
438 if (*C
== '.' && Ext
.empty() == false)
443 // we don't reach the end of the name -> bad character included
447 std::clog
<< "Bad file: " << Ent
->d_name
<< " → bad character »"
448 << *C
<< "« in filename (period allowed: " << (Ext
.empty() ? "no" : "yes") << ")" << std::endl
;
452 // skip filenames which end with a period. These are never valid
456 std::clog
<< "Bad file: " << Ent
->d_name
<< " → Period as last character" << std::endl
;
461 std::clog
<< "Accept file: " << Ent
->d_name
<< " in " << Dir
<< std::endl
;
462 List
.push_back(File
);
466 if (SortList
== true)
467 std::sort(List
.begin(),List
.end());
470 std::vector
<string
> GetListOfFilesInDir(string
const &Dir
, bool SortList
)
472 bool const Debug
= _config
->FindB("Debug::GetListOfFilesInDir", false);
474 std::clog
<< "Accept in " << Dir
<< " all regular files" << std::endl
;
476 std::vector
<string
> List
;
478 if (DirectoryExists(Dir
) == false)
480 _error
->Error(_("List of files can't be created as '%s' is not a directory"), Dir
.c_str());
484 DIR *D
= opendir(Dir
.c_str());
487 _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
491 for (struct dirent
*Ent
= readdir(D
); Ent
!= 0; Ent
= readdir(D
))
493 // skip "hidden" files
494 if (Ent
->d_name
[0] == '.')
497 // Make sure it is a file and not something else
498 string
const File
= flCombine(Dir
,Ent
->d_name
);
499 #ifdef _DIRENT_HAVE_D_TYPE
500 if (Ent
->d_type
!= DT_REG
)
503 if (RealFileExists(File
) == false)
506 std::clog
<< "Bad file: " << Ent
->d_name
<< " → it is not a real file" << std::endl
;
511 // Skip bad filenames ala run-parts
512 const char *C
= Ent
->d_name
;
514 if (isalpha(*C
) == 0 && isdigit(*C
) == 0
515 && *C
!= '_' && *C
!= '-' && *C
!= '.')
518 // we don't reach the end of the name -> bad character included
522 std::clog
<< "Bad file: " << Ent
->d_name
<< " → bad character »" << *C
<< "« in filename" << std::endl
;
526 // skip filenames which end with a period. These are never valid
530 std::clog
<< "Bad file: " << Ent
->d_name
<< " → Period as last character" << std::endl
;
535 std::clog
<< "Accept file: " << Ent
->d_name
<< " in " << Dir
<< std::endl
;
536 List
.push_back(File
);
540 if (SortList
== true)
541 std::sort(List
.begin(),List
.end());
545 // SafeGetCWD - This is a safer getcwd that returns a dynamic string /*{{{*/
546 // ---------------------------------------------------------------------
547 /* We return / on failure. */
550 // Stash the current dir.
553 if (getcwd(S
,sizeof(S
)-2) == 0)
555 unsigned int Len
= strlen(S
);
561 // GetModificationTime - Get the mtime of the given file or -1 on error /*{{{*/
562 // ---------------------------------------------------------------------
563 /* We return / on failure. */
564 time_t GetModificationTime(string
const &Path
)
567 if (stat(Path
.c_str(), &St
) < 0)
572 // flNotDir - Strip the directory from the filename /*{{{*/
573 // ---------------------------------------------------------------------
575 string
flNotDir(string File
)
577 string::size_type Res
= File
.rfind('/');
578 if (Res
== string::npos
)
581 return string(File
,Res
,Res
- File
.length());
584 // flNotFile - Strip the file from the directory name /*{{{*/
585 // ---------------------------------------------------------------------
586 /* Result ends in a / */
587 string
flNotFile(string File
)
589 string::size_type Res
= File
.rfind('/');
590 if (Res
== string::npos
)
593 return string(File
,0,Res
);
596 // flExtension - Return the extension for the file /*{{{*/
597 // ---------------------------------------------------------------------
599 string
flExtension(string File
)
601 string::size_type Res
= File
.rfind('.');
602 if (Res
== string::npos
)
605 return string(File
,Res
,Res
- File
.length());
608 // flNoLink - If file is a symlink then deref it /*{{{*/
609 // ---------------------------------------------------------------------
610 /* If the name is not a link then the returned path is the input. */
611 string
flNoLink(string File
)
614 if (lstat(File
.c_str(),&St
) != 0 || S_ISLNK(St
.st_mode
) == 0)
616 if (stat(File
.c_str(),&St
) != 0)
619 /* Loop resolving the link. There is no need to limit the number of
620 loops because the stat call above ensures that the symlink is not
628 if ((Res
= readlink(NFile
.c_str(),Buffer
,sizeof(Buffer
))) <= 0 ||
629 (size_t)Res
>= sizeof(Buffer
))
632 // Append or replace the previous path
634 if (Buffer
[0] == '/')
637 NFile
= flNotFile(NFile
) + Buffer
;
639 // See if we are done
640 if (lstat(NFile
.c_str(),&St
) != 0)
642 if (S_ISLNK(St
.st_mode
) == 0)
647 // flCombine - Combine a file and a directory /*{{{*/
648 // ---------------------------------------------------------------------
649 /* If the file is an absolute path then it is just returned, otherwise
650 the directory is pre-pended to it. */
651 string
flCombine(string Dir
,string File
)
653 if (File
.empty() == true)
656 if (File
[0] == '/' || Dir
.empty() == true)
658 if (File
.length() >= 2 && File
[0] == '.' && File
[1] == '/')
660 if (Dir
[Dir
.length()-1] == '/')
662 return Dir
+ '/' + File
;
665 // flAbsPath - Return the absolute path of the filename /*{{{*/
666 // ---------------------------------------------------------------------
668 string
flAbsPath(string File
)
670 char *p
= realpath(File
.c_str(), NULL
);
673 _error
->Errno("realpath", "flAbsPath failed");
676 std::string
AbsPath(p
);
681 // SetCloseExec - Set the close on exec flag /*{{{*/
682 // ---------------------------------------------------------------------
684 void SetCloseExec(int Fd
,bool Close
)
686 if (fcntl(Fd
,F_SETFD
,(Close
== false)?0:FD_CLOEXEC
) != 0)
688 cerr
<< "FATAL -> Could not set close on exec " << strerror(errno
) << endl
;
693 // SetNonBlock - Set the nonblocking flag /*{{{*/
694 // ---------------------------------------------------------------------
696 void SetNonBlock(int Fd
,bool Block
)
698 int Flags
= fcntl(Fd
,F_GETFL
) & (~O_NONBLOCK
);
699 if (fcntl(Fd
,F_SETFL
,Flags
| ((Block
== false)?0:O_NONBLOCK
)) != 0)
701 cerr
<< "FATAL -> Could not set non-blocking flag " << strerror(errno
) << endl
;
706 // WaitFd - Wait for a FD to become readable /*{{{*/
707 // ---------------------------------------------------------------------
708 /* This waits for a FD to become readable using select. It is useful for
709 applications making use of non-blocking sockets. The timeout is
711 bool WaitFd(int Fd
,bool write
,unsigned long timeout
)
724 Res
= select(Fd
+1,0,&Set
,0,(timeout
!= 0?&tv
:0));
726 while (Res
< 0 && errno
== EINTR
);
736 Res
= select(Fd
+1,&Set
,0,0,(timeout
!= 0?&tv
:0));
738 while (Res
< 0 && errno
== EINTR
);
747 // MergeKeepFdsFromConfiguration - Merge APT::Keep-Fds configuration /*{{{*/
748 // ---------------------------------------------------------------------
749 /* This is used to merge the APT::Keep-Fds with the provided KeepFDs
752 void MergeKeepFdsFromConfiguration(std::set
<int> &KeepFDs
)
754 Configuration::Item
const *Opts
= _config
->Tree("APT::Keep-Fds");
755 if (Opts
!= 0 && Opts
->Child
!= 0)
758 for (; Opts
!= 0; Opts
= Opts
->Next
)
760 if (Opts
->Value
.empty() == true)
762 int fd
= atoi(Opts
->Value
.c_str());
768 // ExecFork - Magical fork that sanitizes the context before execing /*{{{*/
769 // ---------------------------------------------------------------------
770 /* This is used if you want to cleanse the environment for the forked
771 child, it fixes up the important signals and nukes all of the fds,
772 otherwise acts like normal fork. */
776 // we need to merge the Keep-Fds as external tools like
777 // debconf-apt-progress use it
778 MergeKeepFdsFromConfiguration(KeepFDs
);
779 return ExecFork(KeepFDs
);
782 pid_t
ExecFork(std::set
<int> KeepFDs
)
784 // Fork off the process
785 pid_t Process
= fork();
788 cerr
<< "FATAL -> Failed to fork." << endl
;
792 // Spawn the subprocess
796 signal(SIGPIPE
,SIG_DFL
);
797 signal(SIGQUIT
,SIG_DFL
);
798 signal(SIGINT
,SIG_DFL
);
799 signal(SIGWINCH
,SIG_DFL
);
800 signal(SIGCONT
,SIG_DFL
);
801 signal(SIGTSTP
,SIG_DFL
);
803 // Close all of our FDs - just in case
804 for (int K
= 3; K
!= sysconf(_SC_OPEN_MAX
); K
++)
806 if(KeepFDs
.find(K
) == KeepFDs
.end())
807 fcntl(K
,F_SETFD
,FD_CLOEXEC
);
814 // ExecWait - Fancy waitpid /*{{{*/
815 // ---------------------------------------------------------------------
816 /* Waits for the given sub process. If Reap is set then no errors are
817 generated. Otherwise a failed subprocess will generate a proper descriptive
819 bool ExecWait(pid_t Pid
,const char *Name
,bool Reap
)
824 // Wait and collect the error code
826 while (waitpid(Pid
,&Status
,0) != Pid
)
834 return _error
->Error(_("Waited for %s but it wasn't there"),Name
);
838 // Check for an error code.
839 if (WIFEXITED(Status
) == 0 || WEXITSTATUS(Status
) != 0)
843 if (WIFSIGNALED(Status
) != 0)
845 if( WTERMSIG(Status
) == SIGSEGV
)
846 return _error
->Error(_("Sub-process %s received a segmentation fault."),Name
);
848 return _error
->Error(_("Sub-process %s received signal %u."),Name
, WTERMSIG(Status
));
851 if (WIFEXITED(Status
) != 0)
852 return _error
->Error(_("Sub-process %s returned an error code (%u)"),Name
,WEXITSTATUS(Status
));
854 return _error
->Error(_("Sub-process %s exited unexpectedly"),Name
);
862 // StartsWithGPGClearTextSignature - Check if a file is Pgp/GPG clearsigned /*{{{*/
863 // ---------------------------------------------------------------------
865 bool StartsWithGPGClearTextSignature(string
const &FileName
)
867 static const char* SIGMSG
= "-----BEGIN PGP SIGNED MESSAGE-----\n";
868 char buffer
[strlen(SIGMSG
)+1];
869 FILE* gpg
= fopen(FileName
.c_str(), "r");
873 char const * const test
= fgets(buffer
, sizeof(buffer
), gpg
);
875 if (test
== NULL
|| strcmp(buffer
, SIGMSG
) != 0)
882 class FileFdPrivate
{ /*{{{*/
893 uint8_t buffer
[4096];
899 LZMAFILE() : file(NULL
), eof(false), compressing(false) { buffer
[0] = '\0'; }
901 if (compressing
== true)
904 stream
.avail_out
= sizeof(buffer
)/sizeof(buffer
[0]);
905 stream
.next_out
= buffer
;
906 err
= lzma_code(&stream
, LZMA_FINISH
);
907 if (err
!= LZMA_OK
&& err
!= LZMA_STREAM_END
)
909 _error
->Error("~LZMAFILE: Compress finalisation failed");
912 size_t const n
= sizeof(buffer
)/sizeof(buffer
[0]) - stream
.avail_out
;
913 if (n
&& fwrite(buffer
, 1, n
, file
) != n
)
915 _error
->Errno("~LZMAFILE",_("Write error"));
918 if (err
== LZMA_STREAM_END
)
929 pid_t compressor_pid
;
931 APT::Configuration::Compressor compressor
;
932 unsigned int openmode
;
933 unsigned long long seekpos
;
944 compressed_fd(-1), compressor_pid(-1), pipe(false),
945 openmode(0), seekpos(0) {};
946 bool InternalClose(std::string
const &FileName
)
949 /* dummy so that the rest can be 'else if's */;
951 else if (gz
!= NULL
) {
952 int const e
= gzclose(gz
);
954 // gzdclose() on empty files always fails with "buffer error" here, ignore that
955 if (e
!= 0 && e
!= Z_BUF_ERROR
)
956 return _error
->Errno("close",_("Problem closing the gzip file %s"), FileName
.c_str());
960 else if (bz2
!= NULL
) {
966 else if (lzma
!= NULL
) {
973 bool CloseDown(std::string
const &FileName
)
975 bool const Res
= InternalClose(FileName
);
977 if (compressor_pid
> 0)
978 ExecWait(compressor_pid
, "FileFdCompressor", true);
983 bool InternalStream() const {
995 ~FileFdPrivate() { CloseDown(""); }
998 // FileFd::Open - Open a file /*{{{*/
999 // ---------------------------------------------------------------------
1000 /* The most commonly used open mode combinations are given with Mode */
1001 bool FileFd::Open(string FileName
,unsigned int const Mode
,CompressMode Compress
, unsigned long const AccessMode
)
1003 if (Mode
== ReadOnlyGzip
)
1004 return Open(FileName
, ReadOnly
, Gzip
, AccessMode
);
1006 if (Compress
== Auto
&& (Mode
& WriteOnly
) == WriteOnly
)
1007 return FileFdError("Autodetection on %s only works in ReadOnly openmode!", FileName
.c_str());
1009 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
1010 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
1011 if (Compress
== Auto
)
1013 for (; compressor
!= compressors
.end(); ++compressor
)
1015 std::string file
= FileName
+ compressor
->Extension
;
1016 if (FileExists(file
) == false)
1022 else if (Compress
== Extension
)
1024 std::string::size_type
const found
= FileName
.find_last_of('.');
1026 if (found
!= std::string::npos
)
1028 ext
= FileName
.substr(found
);
1029 if (ext
== ".new" || ext
== ".bak")
1031 std::string::size_type
const found2
= FileName
.find_last_of('.', found
- 1);
1032 if (found2
!= std::string::npos
)
1033 ext
= FileName
.substr(found2
, found
- found2
);
1038 for (; compressor
!= compressors
.end(); ++compressor
)
1039 if (ext
== compressor
->Extension
)
1041 // no matching extension - assume uncompressed (imagine files like 'example.org_Packages')
1042 if (compressor
== compressors
.end())
1043 for (compressor
= compressors
.begin(); compressor
!= compressors
.end(); ++compressor
)
1044 if (compressor
->Name
== ".")
1052 case None
: name
= "."; break;
1053 case Gzip
: name
= "gzip"; break;
1054 case Bzip2
: name
= "bzip2"; break;
1055 case Lzma
: name
= "lzma"; break;
1056 case Xz
: name
= "xz"; break;
1060 return FileFdError("Opening File %s in None, Auto or Extension should be already handled?!?", FileName
.c_str());
1062 for (; compressor
!= compressors
.end(); ++compressor
)
1063 if (compressor
->Name
== name
)
1065 if (compressor
== compressors
.end())
1066 return FileFdError("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
1069 if (compressor
== compressors
.end())
1070 return FileFdError("Can't find a match for specified compressor mode for file %s", FileName
.c_str());
1071 return Open(FileName
, Mode
, *compressor
, AccessMode
);
1073 bool FileFd::Open(string FileName
,unsigned int const Mode
,APT::Configuration::Compressor
const &compressor
, unsigned long const AccessMode
)
1078 if ((Mode
& WriteOnly
) != WriteOnly
&& (Mode
& (Atomic
| Create
| Empty
| Exclusive
)) != 0)
1079 return FileFdError("ReadOnly mode for %s doesn't accept additional flags!", FileName
.c_str());
1080 if ((Mode
& ReadWrite
) == 0)
1081 return FileFdError("No openmode provided in FileFd::Open for %s", FileName
.c_str());
1083 if ((Mode
& Atomic
) == Atomic
)
1087 else if ((Mode
& (Exclusive
| Create
)) == (Exclusive
| Create
))
1089 // for atomic, this will be done by rename in Close()
1090 unlink(FileName
.c_str());
1092 if ((Mode
& Empty
) == Empty
)
1095 if (lstat(FileName
.c_str(),&Buf
) == 0 && S_ISLNK(Buf
.st_mode
))
1096 unlink(FileName
.c_str());
1100 #define if_FLAGGED_SET(FLAG, MODE) if ((Mode & FLAG) == FLAG) fileflags |= MODE
1101 if_FLAGGED_SET(ReadWrite
, O_RDWR
);
1102 else if_FLAGGED_SET(ReadOnly
, O_RDONLY
);
1103 else if_FLAGGED_SET(WriteOnly
, O_WRONLY
);
1105 if_FLAGGED_SET(Create
, O_CREAT
);
1106 if_FLAGGED_SET(Empty
, O_TRUNC
);
1107 if_FLAGGED_SET(Exclusive
, O_EXCL
);
1108 #undef if_FLAGGED_SET
1110 if ((Mode
& Atomic
) == Atomic
)
1112 char *name
= strdup((FileName
+ ".XXXXXX").c_str());
1114 if((iFd
= mkstemp(name
)) == -1)
1117 return FileFdErrno("mkstemp", "Could not create temporary file for %s", FileName
.c_str());
1120 TemporaryFileName
= string(name
);
1123 // umask() will always set the umask and return the previous value, so
1124 // we first set the umask and then reset it to the old value
1125 mode_t
const CurrentUmask
= umask(0);
1126 umask(CurrentUmask
);
1127 // calculate the actual file permissions (just like open/creat)
1128 mode_t
const FilePermissions
= (AccessMode
& ~CurrentUmask
);
1130 if(fchmod(iFd
, FilePermissions
) == -1)
1131 return FileFdErrno("fchmod", "Could not change permissions for temporary file %s", TemporaryFileName
.c_str());
1134 iFd
= open(FileName
.c_str(), fileflags
, AccessMode
);
1136 this->FileName
= FileName
;
1137 if (iFd
== -1 || OpenInternDescriptor(Mode
, compressor
) == false)
1144 return FileFdErrno("open",_("Could not open file %s"), FileName
.c_str());
1147 SetCloseExec(iFd
,true);
1151 // FileFd::OpenDescriptor - Open a filedescriptor /*{{{*/
1152 // ---------------------------------------------------------------------
1154 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, CompressMode Compress
, bool AutoClose
)
1156 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
1157 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
1160 // compat with the old API
1161 if (Mode
== ReadOnlyGzip
&& Compress
== None
)
1166 case None
: name
= "."; break;
1167 case Gzip
: name
= "gzip"; break;
1168 case Bzip2
: name
= "bzip2"; break;
1169 case Lzma
: name
= "lzma"; break;
1170 case Xz
: name
= "xz"; break;
1173 if (AutoClose
== true && Fd
!= -1)
1175 return FileFdError("Opening Fd %d in Auto or Extension compression mode is not supported", Fd
);
1177 for (; compressor
!= compressors
.end(); ++compressor
)
1178 if (compressor
->Name
== name
)
1180 if (compressor
== compressors
.end())
1182 if (AutoClose
== true && Fd
!= -1)
1184 return FileFdError("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
1186 return OpenDescriptor(Fd
, Mode
, *compressor
, AutoClose
);
1188 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
, bool AutoClose
)
1191 Flags
= (AutoClose
) ? FileFd::AutoClose
: 0;
1193 this->FileName
= "";
1194 if (OpenInternDescriptor(Mode
, compressor
) == false)
1197 (Flags
& Compressed
) == Compressed
||
1203 return FileFdError(_("Could not open file descriptor %d"), Fd
);
1207 bool FileFd::OpenInternDescriptor(unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
)
1211 if (compressor
.Name
== "." || compressor
.Binary
.empty() == true)
1214 #if defined HAVE_ZLIB || defined HAVE_BZ2 || defined HAVE_LZMA
1215 // the API to open files is similar, so setup to avoid code duplicates later
1216 // and while at it ensure that we close before opening (if its a reopen)
1217 void* (*compress_open
)(int, const char *) = NULL
;
1219 /* dummy so that the rest can be 'else if's */;
1220 #define APT_COMPRESS_INIT(NAME,OPEN) \
1221 else if (compressor.Name == NAME) \
1223 compress_open = (void*(*)(int, const char *)) OPEN; \
1224 if (d != NULL) d->InternalClose(FileName); \
1227 APT_COMPRESS_INIT("gzip", gzdopen
)
1230 APT_COMPRESS_INIT("bzip2", BZ2_bzdopen
)
1233 APT_COMPRESS_INIT("xz", fdopen
)
1234 APT_COMPRESS_INIT("lzma", fdopen
)
1236 #undef APT_COMPRESS_INIT
1241 d
= new FileFdPrivate();
1243 d
->compressor
= compressor
;
1244 #if defined HAVE_ZLIB || defined HAVE_BZ2 || defined HAVE_LZMA
1245 if ((Flags
& AutoClose
) != AutoClose
&& compress_open
!= NULL
)
1247 // Need to duplicate fd here or gz/bz2 close for cleanup will close the fd as well
1248 int const internFd
= dup(iFd
);
1250 return FileFdErrno("OpenInternDescriptor", _("Could not open file descriptor %d"), iFd
);
1256 #if defined HAVE_ZLIB || defined HAVE_BZ2 || defined HAVE_LZMA
1257 if (compress_open
!= NULL
)
1259 void* compress_struct
= NULL
;
1260 if ((Mode
& ReadWrite
) == ReadWrite
)
1261 compress_struct
= compress_open(iFd
, "r+");
1262 else if ((Mode
& WriteOnly
) == WriteOnly
)
1263 compress_struct
= compress_open(iFd
, "w");
1265 compress_struct
= compress_open(iFd
, "r");
1266 if (compress_struct
== NULL
)
1270 /* dummy so that the rest can be 'else if's */;
1272 else if (compressor
.Name
== "gzip")
1273 d
->gz
= (gzFile
) compress_struct
;
1276 else if (compressor
.Name
== "bzip2")
1277 d
->bz2
= (BZFILE
*) compress_struct
;
1280 else if (compressor
.Name
== "xz" || compressor
.Name
== "lzma")
1282 uint32_t const xzlevel
= 6;
1283 uint64_t const memlimit
= UINT64_MAX
;
1284 if (d
->lzma
== NULL
)
1285 d
->lzma
= new FileFdPrivate::LZMAFILE
;
1286 d
->lzma
->file
= (FILE*) compress_struct
;
1287 lzma_stream tmp_stream
= LZMA_STREAM_INIT
;
1288 d
->lzma
->stream
= tmp_stream
;
1290 if ((Mode
& ReadWrite
) == ReadWrite
)
1291 return FileFdError("ReadWrite mode is not supported for file %s", FileName
.c_str());
1293 if ((Mode
& WriteOnly
) == WriteOnly
)
1295 if (compressor
.Name
== "xz")
1297 if (lzma_easy_encoder(&d
->lzma
->stream
, xzlevel
, LZMA_CHECK_CRC32
) != LZMA_OK
)
1302 lzma_options_lzma options
;
1303 lzma_lzma_preset(&options
, xzlevel
);
1304 if (lzma_alone_encoder(&d
->lzma
->stream
, &options
) != LZMA_OK
)
1307 d
->lzma
->compressing
= true;
1311 if (compressor
.Name
== "xz")
1313 if (lzma_auto_decoder(&d
->lzma
->stream
, memlimit
, 0) != LZMA_OK
)
1318 if (lzma_alone_decoder(&d
->lzma
->stream
, memlimit
) != LZMA_OK
)
1321 d
->lzma
->compressing
= false;
1325 Flags
|= Compressed
;
1330 // collect zombies here in case we reopen
1331 if (d
->compressor_pid
> 0)
1332 ExecWait(d
->compressor_pid
, "FileFdCompressor", true);
1334 if ((Mode
& ReadWrite
) == ReadWrite
)
1335 return FileFdError("ReadWrite mode is not supported for file %s", FileName
.c_str());
1337 bool const Comp
= (Mode
& WriteOnly
) == WriteOnly
;
1340 // Handle 'decompression' of empty files
1343 if (Buf
.st_size
== 0 && S_ISFIFO(Buf
.st_mode
) == false)
1346 // We don't need the file open - instead let the compressor open it
1347 // as he properly knows better how to efficiently read from 'his' file
1348 if (FileName
.empty() == false)
1355 // Create a data pipe
1356 int Pipe
[2] = {-1,-1};
1357 if (pipe(Pipe
) != 0)
1358 return FileFdErrno("pipe",_("Failed to create subprocess IPC"));
1359 for (int J
= 0; J
!= 2; J
++)
1360 SetCloseExec(Pipe
[J
],true);
1362 d
->compressed_fd
= iFd
;
1371 d
->compressor_pid
= ExecFork();
1372 if (d
->compressor_pid
== 0)
1376 dup2(d
->compressed_fd
,STDOUT_FILENO
);
1377 dup2(Pipe
[0],STDIN_FILENO
);
1381 if (d
->compressed_fd
!= -1)
1382 dup2(d
->compressed_fd
,STDIN_FILENO
);
1383 dup2(Pipe
[1],STDOUT_FILENO
);
1385 int const nullfd
= open("/dev/null", O_WRONLY
);
1388 dup2(nullfd
,STDERR_FILENO
);
1392 SetCloseExec(STDOUT_FILENO
,false);
1393 SetCloseExec(STDIN_FILENO
,false);
1395 std::vector
<char const*> Args
;
1396 Args
.push_back(compressor
.Binary
.c_str());
1397 std::vector
<std::string
> const * const addArgs
=
1398 (Comp
== true) ? &(compressor
.CompressArgs
) : &(compressor
.UncompressArgs
);
1399 for (std::vector
<std::string
>::const_iterator a
= addArgs
->begin();
1400 a
!= addArgs
->end(); ++a
)
1401 Args
.push_back(a
->c_str());
1402 if (Comp
== false && FileName
.empty() == false)
1404 // commands not needing arguments, do not need to be told about using standard output
1405 // in reality, only testcases with tools like cat, rev, rot13, … are able to trigger this
1406 if (compressor
.CompressArgs
.empty() == false && compressor
.UncompressArgs
.empty() == false)
1407 Args
.push_back("--stdout");
1408 if (TemporaryFileName
.empty() == false)
1409 Args
.push_back(TemporaryFileName
.c_str());
1411 Args
.push_back(FileName
.c_str());
1413 Args
.push_back(NULL
);
1415 execvp(Args
[0],(char **)&Args
[0]);
1416 cerr
<< _("Failed to exec compressor ") << Args
[0] << endl
;
1427 // FileFd::~File - Closes the file /*{{{*/
1428 // ---------------------------------------------------------------------
1429 /* If the proper modes are selected then we close the Fd and possibly
1430 unlink the file on error. */
1435 d
->CloseDown(FileName
);
1440 // FileFd::Read - Read a bit of the file /*{{{*/
1441 // ---------------------------------------------------------------------
1442 /* We are careful to handle interruption by a signal while reading
1444 bool FileFd::Read(void *To
,unsigned long long Size
,unsigned long long *Actual
)
1450 *((char *)To
) = '\0';
1454 /* dummy so that the rest can be 'else if's */;
1456 else if (d
!= NULL
&& d
->gz
!= NULL
)
1457 Res
= gzread(d
->gz
,To
,Size
);
1460 else if (d
!= NULL
&& d
->bz2
!= NULL
)
1461 Res
= BZ2_bzread(d
->bz2
,To
,Size
);
1464 else if (d
!= NULL
&& d
->lzma
!= NULL
)
1466 if (d
->lzma
->eof
== true)
1469 d
->lzma
->stream
.next_out
= (uint8_t *) To
;
1470 d
->lzma
->stream
.avail_out
= Size
;
1471 if (d
->lzma
->stream
.avail_in
== 0)
1473 d
->lzma
->stream
.next_in
= d
->lzma
->buffer
;
1474 d
->lzma
->stream
.avail_in
= fread(d
->lzma
->buffer
, 1, sizeof(d
->lzma
->buffer
)/sizeof(d
->lzma
->buffer
[0]), d
->lzma
->file
);
1476 d
->lzma
->err
= lzma_code(&d
->lzma
->stream
, LZMA_RUN
);
1477 if (d
->lzma
->err
== LZMA_STREAM_END
)
1479 d
->lzma
->eof
= true;
1480 Res
= Size
- d
->lzma
->stream
.avail_out
;
1482 else if (d
->lzma
->err
!= LZMA_OK
)
1489 Res
= Size
- d
->lzma
->stream
.avail_out
;
1492 // lzma run was okay, but produced no output…
1500 Res
= read(iFd
,To
,Size
);
1506 // trick the while-loop into running again
1512 /* dummy so that the rest can be 'else if's */;
1514 else if (d
!= NULL
&& d
->gz
!= NULL
)
1517 char const * const errmsg
= gzerror(d
->gz
, &err
);
1519 return FileFdError("gzread: %s (%d: %s)", _("Read error"), err
, errmsg
);
1523 else if (d
!= NULL
&& d
->bz2
!= NULL
)
1526 char const * const errmsg
= BZ2_bzerror(d
->bz2
, &err
);
1527 if (err
!= BZ_IO_ERROR
)
1528 return FileFdError("BZ2_bzread: %s %s (%d: %s)", FileName
.c_str(), _("Read error"), err
, errmsg
);
1532 else if (d
!= NULL
&& d
->lzma
!= NULL
)
1533 return FileFdError("lzma_read: %s (%d)", _("Read error"), d
->lzma
->err
);
1535 return FileFdErrno("read",_("Read error"));
1538 To
= (char *)To
+ Res
;
1545 while (Res
> 0 && Size
> 0);
1557 return FileFdError(_("read, still have %llu to read but none left"), Size
);
1560 // FileFd::ReadLine - Read a complete line from the file /*{{{*/
1561 // ---------------------------------------------------------------------
1562 /* Beware: This method can be quiet slow for big buffers on UNcompressed
1563 files because of the naive implementation! */
1564 char* FileFd::ReadLine(char *To
, unsigned long long const Size
)
1568 if (d
!= NULL
&& d
->gz
!= NULL
)
1569 return gzgets(d
->gz
, To
, Size
);
1572 unsigned long long read
= 0;
1573 while ((Size
- 1) != read
)
1575 unsigned long long done
= 0;
1576 if (Read(To
+ read
, 1, &done
) == false)
1580 if (To
[read
++] == '\n')
1589 // FileFd::Write - Write to the file /*{{{*/
1590 // ---------------------------------------------------------------------
1592 bool FileFd::Write(const void *From
,unsigned long long Size
)
1599 /* dummy so that the rest can be 'else if's */;
1601 else if (d
!= NULL
&& d
->gz
!= NULL
)
1602 Res
= gzwrite(d
->gz
,From
,Size
);
1605 else if (d
!= NULL
&& d
->bz2
!= NULL
)
1606 Res
= BZ2_bzwrite(d
->bz2
,(void*)From
,Size
);
1609 else if (d
!= NULL
&& d
->lzma
!= NULL
)
1611 d
->lzma
->stream
.next_in
= (uint8_t *)From
;
1612 d
->lzma
->stream
.avail_in
= Size
;
1613 d
->lzma
->stream
.next_out
= d
->lzma
->buffer
;
1614 d
->lzma
->stream
.avail_out
= sizeof(d
->lzma
->buffer
)/sizeof(d
->lzma
->buffer
[0]);
1615 d
->lzma
->err
= lzma_code(&d
->lzma
->stream
, LZMA_RUN
);
1616 if (d
->lzma
->err
!= LZMA_OK
)
1618 size_t const n
= sizeof(d
->lzma
->buffer
)/sizeof(d
->lzma
->buffer
[0]) - d
->lzma
->stream
.avail_out
;
1619 size_t const m
= (n
== 0) ? 0 : fwrite(d
->lzma
->buffer
, 1, n
, d
->lzma
->file
);
1623 Res
= Size
- d
->lzma
->stream
.avail_in
;
1627 Res
= write(iFd
,From
,Size
);
1629 if (Res
< 0 && errno
== EINTR
)
1634 /* dummy so that the rest can be 'else if's */;
1636 else if (d
!= NULL
&& d
->gz
!= NULL
)
1639 char const * const errmsg
= gzerror(d
->gz
, &err
);
1641 return FileFdError("gzwrite: %s (%d: %s)", _("Write error"), err
, errmsg
);
1645 else if (d
!= NULL
&& d
->bz2
!= NULL
)
1648 char const * const errmsg
= BZ2_bzerror(d
->bz2
, &err
);
1649 if (err
!= BZ_IO_ERROR
)
1650 return FileFdError("BZ2_bzwrite: %s (%d: %s)", _("Write error"), err
, errmsg
);
1654 else if (d
!= NULL
&& d
->lzma
!= NULL
)
1655 return FileFdErrno("lzma_fwrite", _("Write error"));
1657 return FileFdErrno("write",_("Write error"));
1660 From
= (char const *)From
+ Res
;
1665 while (Res
> 0 && Size
> 0);
1670 return FileFdError(_("write, still have %llu to write but couldn't"), Size
);
1672 bool FileFd::Write(int Fd
, const void *From
, unsigned long long Size
)
1678 Res
= write(Fd
,From
,Size
);
1679 if (Res
< 0 && errno
== EINTR
)
1682 return _error
->Errno("write",_("Write error"));
1684 From
= (char const *)From
+ Res
;
1687 while (Res
> 0 && Size
> 0);
1692 return _error
->Error(_("write, still have %llu to write but couldn't"), Size
);
1695 // FileFd::Seek - Seek in the file /*{{{*/
1696 // ---------------------------------------------------------------------
1698 bool FileFd::Seek(unsigned long long To
)
1702 if (d
!= NULL
&& (d
->pipe
== true || d
->InternalStream() == true))
1704 // Our poor man seeking in pipes is costly, so try to avoid it
1705 unsigned long long seekpos
= Tell();
1708 else if (seekpos
< To
)
1709 return Skip(To
- seekpos
);
1711 if ((d
->openmode
& ReadOnly
) != ReadOnly
)
1712 return FileFdError("Reopen is only implemented for read-only files!");
1713 d
->InternalClose(FileName
);
1717 if (TemporaryFileName
.empty() == false)
1718 iFd
= open(TemporaryFileName
.c_str(), O_RDONLY
);
1719 else if (FileName
.empty() == false)
1720 iFd
= open(FileName
.c_str(), O_RDONLY
);
1723 if (d
->compressed_fd
> 0)
1724 if (lseek(d
->compressed_fd
, 0, SEEK_SET
) != 0)
1725 iFd
= d
->compressed_fd
;
1727 return FileFdError("Reopen is not implemented for pipes opened with FileFd::OpenDescriptor()!");
1730 if (OpenInternDescriptor(d
->openmode
, d
->compressor
) == false)
1731 return FileFdError("Seek on file %s because it couldn't be reopened", FileName
.c_str());
1741 if (d
!= NULL
&& d
->gz
)
1742 res
= gzseek(d
->gz
,To
,SEEK_SET
);
1745 res
= lseek(iFd
,To
,SEEK_SET
);
1746 if (res
!= (off_t
)To
)
1747 return FileFdError("Unable to seek to %llu", To
);
1754 // FileFd::Skip - Seek in the file /*{{{*/
1755 // ---------------------------------------------------------------------
1757 bool FileFd::Skip(unsigned long long Over
)
1759 if (d
!= NULL
&& (d
->pipe
== true || d
->InternalStream() == true))
1764 unsigned long long toread
= std::min((unsigned long long) sizeof(buffer
), Over
);
1765 if (Read(buffer
, toread
) == false)
1766 return FileFdError("Unable to seek ahead %llu",Over
);
1774 if (d
!= NULL
&& d
->gz
!= NULL
)
1775 res
= gzseek(d
->gz
,Over
,SEEK_CUR
);
1778 res
= lseek(iFd
,Over
,SEEK_CUR
);
1780 return FileFdError("Unable to seek ahead %llu",Over
);
1787 // FileFd::Truncate - Truncate the file /*{{{*/
1788 // ---------------------------------------------------------------------
1790 bool FileFd::Truncate(unsigned long long To
)
1792 // truncating /dev/null is always successful - as we get an error otherwise
1793 if (To
== 0 && FileName
== "/dev/null")
1795 #if defined HAVE_ZLIB || defined HAVE_BZ2 || defined HAVE_LZMA
1796 if (d
!= NULL
&& (d
->InternalStream() == true
1801 return FileFdError("Truncating compressed files is not implemented (%s)", FileName
.c_str());
1803 if (ftruncate(iFd
,To
) != 0)
1804 return FileFdError("Unable to truncate to %llu",To
);
1809 // FileFd::Tell - Current seek position /*{{{*/
1810 // ---------------------------------------------------------------------
1812 unsigned long long FileFd::Tell()
1814 // In theory, we could just return seekpos here always instead of
1815 // seeking around, but not all users of FileFd use always Seek() and co
1816 // so d->seekpos isn't always true and we can just use it as a hint if
1817 // we have nothing else, but not always as an authority…
1818 if (d
!= NULL
&& (d
->pipe
== true || d
->InternalStream() == true))
1823 if (d
!= NULL
&& d
->gz
!= NULL
)
1824 Res
= gztell(d
->gz
);
1827 Res
= lseek(iFd
,0,SEEK_CUR
);
1828 if (Res
== (off_t
)-1)
1829 FileFdErrno("lseek","Failed to determine the current file position");
1835 static bool StatFileFd(char const * const msg
, int const iFd
, std::string
const &FileName
, struct stat
&Buf
, FileFdPrivate
* const d
) /*{{{*/
1837 bool ispipe
= (d
!= NULL
&& d
->pipe
== true);
1838 if (ispipe
== false)
1840 if (fstat(iFd
,&Buf
) != 0)
1841 // higher-level code will generate more meaningful messages,
1842 // even translated this would be meaningless for users
1843 return _error
->Errno("fstat", "Unable to determine %s for fd %i", msg
, iFd
);
1844 if (FileName
.empty() == false)
1845 ispipe
= S_ISFIFO(Buf
.st_mode
);
1848 // for compressor pipes st_size is undefined and at 'best' zero
1851 // we set it here, too, as we get the info here for free
1852 // in theory the Open-methods should take care of it already
1855 if (stat(FileName
.c_str(), &Buf
) != 0)
1856 return _error
->Errno("fstat", "Unable to determine %s for file %s", msg
, FileName
.c_str());
1861 // FileFd::FileSize - Return the size of the file /*{{{*/
1862 unsigned long long FileFd::FileSize()
1865 if (StatFileFd("file size", iFd
, FileName
, Buf
, d
) == false)
1873 // FileFd::ModificationTime - Return the time of last touch /*{{{*/
1874 time_t FileFd::ModificationTime()
1877 if (StatFileFd("modification time", iFd
, FileName
, Buf
, d
) == false)
1882 return Buf
.st_mtime
;
1885 // FileFd::Size - Return the size of the content in the file /*{{{*/
1886 // ---------------------------------------------------------------------
1888 unsigned long long FileFd::Size()
1890 unsigned long long size
= FileSize();
1892 // for compressor pipes st_size is undefined and at 'best' zero,
1893 // so we 'read' the content and 'seek' back - see there
1894 if (d
!= NULL
&& (d
->pipe
== true || (d
->InternalStream() == true && size
> 0)))
1896 unsigned long long const oldSeek
= Tell();
1898 unsigned long long read
= 0;
1900 if (Read(ignore
, sizeof(ignore
), &read
) == false)
1910 // only check gzsize if we are actually a gzip file, just checking for
1911 // "gz" is not sufficient as uncompressed files could be opened with
1912 // gzopen in "direct" mode as well
1913 else if (d
!= NULL
&& d
->gz
&& !gzdirect(d
->gz
) && size
> 0)
1915 off_t
const oldPos
= lseek(iFd
,0,SEEK_CUR
);
1916 /* unfortunately zlib.h doesn't provide a gzsize(), so we have to do
1917 * this ourselves; the original (uncompressed) file size is the last 32
1918 * bits of the file */
1919 // FIXME: Size for gz-files is limited by 32bit… no largefile support
1920 if (lseek(iFd
, -4, SEEK_END
) < 0)
1922 FileFdErrno("lseek","Unable to seek to end of gzipped file");
1926 if (read(iFd
, &size
, 4) != 4)
1928 FileFdErrno("read","Unable to read original size of gzipped file");
1931 size
= le32toh(size
);
1933 if (lseek(iFd
, oldPos
, SEEK_SET
) < 0)
1935 FileFdErrno("lseek","Unable to seek in gzipped file");
1946 // FileFd::Close - Close the file if the close flag is set /*{{{*/
1947 // ---------------------------------------------------------------------
1949 bool FileFd::Close()
1955 if ((Flags
& AutoClose
) == AutoClose
)
1957 if ((Flags
& Compressed
) != Compressed
&& iFd
> 0 && close(iFd
) != 0)
1958 Res
&= _error
->Errno("close",_("Problem closing the file %s"), FileName
.c_str());
1961 Res
&= d
->CloseDown(FileName
);
1967 if ((Flags
& Replace
) == Replace
) {
1968 if (rename(TemporaryFileName
.c_str(), FileName
.c_str()) != 0)
1969 Res
&= _error
->Errno("rename",_("Problem renaming the file %s to %s"), TemporaryFileName
.c_str(), FileName
.c_str());
1971 FileName
= TemporaryFileName
; // for the unlink() below.
1972 TemporaryFileName
.clear();
1977 if ((Flags
& Fail
) == Fail
&& (Flags
& DelOnFail
) == DelOnFail
&&
1978 FileName
.empty() == false)
1979 if (unlink(FileName
.c_str()) != 0)
1980 Res
&= _error
->WarningE("unlnk",_("Problem unlinking the file %s"), FileName
.c_str());
1987 // FileFd::Sync - Sync the file /*{{{*/
1988 // ---------------------------------------------------------------------
1992 if (fsync(iFd
) != 0)
1993 return FileFdErrno("sync",_("Problem syncing the file"));
1997 // FileFd::FileFdErrno - set Fail and call _error->Errno *{{{*/
1998 bool FileFd::FileFdErrno(const char *Function
, const char *Description
,...)
2002 size_t msgSize
= 400;
2003 int const errsv
= errno
;
2006 va_start(args
,Description
);
2007 if (_error
->InsertErrno(GlobalError::ERROR
, Function
, Description
, args
, errsv
, msgSize
) == false)
2014 // FileFd::FileFdError - set Fail and call _error->Error *{{{*/
2015 bool FileFd::FileFdError(const char *Description
,...) {
2018 size_t msgSize
= 400;
2021 va_start(args
,Description
);
2022 if (_error
->Insert(GlobalError::ERROR
, Description
, args
, msgSize
) == false)
2030 APT_DEPRECATED gzFile
FileFd::gzFd() {
2039 // Glob - wrapper around "glob()" /*{{{*/
2040 // ---------------------------------------------------------------------
2042 std::vector
<std::string
> Glob(std::string
const &pattern
, int flags
)
2044 std::vector
<std::string
> result
;
2049 glob_res
= glob(pattern
.c_str(), flags
, NULL
, &globbuf
);
2053 if(glob_res
!= GLOB_NOMATCH
) {
2054 _error
->Errno("glob", "Problem with glob");
2060 for(i
=0;i
<globbuf
.gl_pathc
;i
++)
2061 result
.push_back(string(globbuf
.gl_pathv
[i
]));
2068 std::string
GetTempDir()
2070 const char *tmpdir
= getenv("TMPDIR");
2077 // check that tmpdir is set and exists
2079 if (!tmpdir
|| strlen(tmpdir
) == 0 || stat(tmpdir
, &st
) != 0)
2082 return string(tmpdir
);
2085 FileFd
* GetTempFile(std::string
const &Prefix
, bool ImmediateUnlink
)
2088 FileFd
*Fd
= new FileFd();
2090 std::string tempdir
= GetTempDir();
2091 snprintf(fn
, sizeof(fn
), "%s/%s.XXXXXX",
2092 tempdir
.c_str(), Prefix
.c_str());
2093 int fd
= mkstemp(fn
);
2098 _error
->Errno("GetTempFile",_("Unable to mkstemp %s"), fn
);
2101 if (!Fd
->OpenDescriptor(fd
, FileFd::WriteOnly
, FileFd::None
, true))
2103 _error
->Errno("GetTempFile",_("Unable to write to %s"),fn
);
2110 bool Rename(std::string From
, std::string To
)
2112 if (rename(From
.c_str(),To
.c_str()) != 0)
2114 _error
->Error(_("rename failed, %s (%s -> %s)."),strerror(errno
),
2115 From
.c_str(),To
.c_str());
2121 bool Popen(const char* Args
[], FileFd
&Fd
, pid_t
&Child
, FileFd::OpenMode Mode
)
2124 if (Mode
!= FileFd::ReadOnly
&& Mode
!= FileFd::WriteOnly
)
2125 return _error
->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2127 int Pipe
[2] = {-1, -1};
2129 return _error
->Errno("pipe", _("Failed to create subprocess IPC"));
2131 std::set
<int> keep_fds
;
2132 keep_fds
.insert(Pipe
[0]);
2133 keep_fds
.insert(Pipe
[1]);
2134 Child
= ExecFork(keep_fds
);
2136 return _error
->Errno("fork", "Failed to fork");
2139 if(Mode
== FileFd::ReadOnly
)
2144 else if(Mode
== FileFd::WriteOnly
)
2150 if(Mode
== FileFd::ReadOnly
)
2154 } else if(Mode
== FileFd::WriteOnly
)
2157 execv(Args
[0], (char**)Args
);
2160 if(Mode
== FileFd::ReadOnly
)
2164 } else if(Mode
== FileFd::WriteOnly
)
2169 Fd
.OpenDescriptor(fd
, Mode
, FileFd::None
, true);
2176 // uid will be 0 in the end, but gid might be different anyway
2177 uid_t old_uid
= getuid();
2178 gid_t old_gid
= getgid();
2182 if(_config
->FindB("Debug::NoDropPrivs", false) == true)
2185 const std::string toUser
= _config
->Find("APT::Sandbox::User", "_apt");
2186 struct passwd
*pw
= getpwnam(toUser
.c_str());
2188 return _error
->Error("No user %s, can not drop rights", toUser
.c_str());
2191 // see prctl(2), needs linux3.5
2192 int ret
= prctl(PR_SET_NO_NEW_PRIVS
, 1, 0,0, 0);
2194 _error
->Warning("PR_SET_NO_NEW_PRIVS failed with %i", ret
);
2196 // Do not change the order here, it might break things
2197 if (setgroups(1, &pw
->pw_gid
))
2198 return _error
->Errno("setgroups", "Failed to setgroups");
2200 if (setegid(pw
->pw_gid
) != 0)
2201 return _error
->Errno("setegid", "Failed to setegid");
2203 if (setgid(pw
->pw_gid
) != 0)
2204 return _error
->Errno("setgid", "Failed to setgid");
2206 if (setuid(pw
->pw_uid
) != 0)
2207 return _error
->Errno("setuid", "Failed to setuid");
2209 // the seteuid() is probably uneeded (at least thats what the linux
2210 // man-page says about setuid(2)) but we cargo culted it anyway
2211 if (seteuid(pw
->pw_uid
) != 0)
2212 return _error
->Errno("seteuid", "Failed to seteuid");
2214 // Verify that the user has only a single group, and the correct one
2216 if (getgroups(1, groups
) != 1)
2217 return _error
->Errno("getgroups", "Could not get new groups");
2218 if (groups
[0] != pw
->pw_gid
)
2219 return _error
->Error("Could not switch group");
2221 // Verify that gid, egid, uid, and euid changed
2222 if (getgid() != pw
->pw_gid
)
2223 return _error
->Error("Could not switch group");
2224 if (getegid() != pw
->pw_gid
)
2225 return _error
->Error("Could not switch effective group");
2226 if (getuid() != pw
->pw_uid
)
2227 return _error
->Error("Could not switch user");
2228 if (geteuid() != pw
->pw_uid
)
2229 return _error
->Error("Could not switch effective user");
2231 #ifdef HAVE_GETRESUID
2232 // verify that the saved set-user-id was changed as well
2236 if (getresuid(&ruid
, &euid
, &suid
))
2237 return _error
->Errno("getresuid", "Could not get saved set-user-ID");
2238 if (suid
!= pw
->pw_uid
)
2239 return _error
->Error("Could not switch saved set-user-ID");
2242 #ifdef HAVE_GETRESGID
2243 // verify that the saved set-group-id was changed as well
2247 if (getresgid(&rgid
, &egid
, &sgid
))
2248 return _error
->Errno("getresuid", "Could not get saved set-group-ID");
2249 if (sgid
!= pw
->pw_gid
)
2250 return _error
->Error("Could not switch saved set-group-ID");
2253 // Check that uid and gid changes do not work anymore
2254 if (pw
->pw_gid
!= old_gid
&& (setgid(old_gid
) != -1 || setegid(old_gid
) != -1))
2255 return _error
->Error("Could restore a gid to root, privilege dropping did not work");
2257 if (pw
->pw_uid
!= old_uid
&& (setuid(old_uid
) != -1 || seteuid(old_uid
) != -1))
2258 return _error
->Error("Could restore a uid to root, privilege dropping did not work");