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>
70 #include <sys/prctl.h>
78 // RunScripts - Run a set of scripts from a configuration subtree /*{{{*/
79 // ---------------------------------------------------------------------
81 bool RunScripts(const char *Cnf
)
83 Configuration::Item
const *Opts
= _config
->Tree(Cnf
);
84 if (Opts
== 0 || Opts
->Child
== 0)
88 // Fork for running the system calls
89 pid_t Child
= ExecFork();
94 if (_config
->FindDir("DPkg::Chroot-Directory","/") != "/")
96 std::cerr
<< "Chrooting into "
97 << _config
->FindDir("DPkg::Chroot-Directory")
99 if (chroot(_config
->FindDir("DPkg::Chroot-Directory","/").c_str()) != 0)
103 if (chdir("/tmp/") != 0)
106 unsigned int Count
= 1;
107 for (; Opts
!= 0; Opts
= Opts
->Next
, Count
++)
109 if (Opts
->Value
.empty() == true)
112 if(_config
->FindB("Debug::RunScripts", false) == true)
113 std::clog
<< "Running external script: '"
114 << Opts
->Value
<< "'" << std::endl
;
116 if (system(Opts
->Value
.c_str()) != 0)
122 // Wait for the child
124 while (waitpid(Child
,&Status
,0) != Child
)
128 return _error
->Errno("waitpid","Couldn't wait for subprocess");
131 // Restore sig int/quit
132 signal(SIGQUIT
,SIG_DFL
);
133 signal(SIGINT
,SIG_DFL
);
135 // Check for an error code.
136 if (WIFEXITED(Status
) == 0 || WEXITSTATUS(Status
) != 0)
138 unsigned int Count
= WEXITSTATUS(Status
);
142 for (; Opts
!= 0 && Count
!= 1; Opts
= Opts
->Next
, Count
--);
143 _error
->Error("Problem executing scripts %s '%s'",Cnf
,Opts
->Value
.c_str());
146 return _error
->Error("Sub-process returned an error code");
153 // CopyFile - Buffered copy of a file /*{{{*/
154 // ---------------------------------------------------------------------
155 /* The caller is expected to set things so that failure causes erasure */
156 bool CopyFile(FileFd
&From
,FileFd
&To
)
158 if (From
.IsOpen() == false || To
.IsOpen() == false ||
159 From
.Failed() == true || To
.Failed() == true)
162 // Buffered copy between fds
163 constexpr size_t BufSize
= 64000;
164 std::unique_ptr
<unsigned char[]> Buf(new unsigned char[BufSize
]);
165 unsigned long long ToRead
= 0;
167 if (From
.Read(Buf
.get(),BufSize
, &ToRead
) == false ||
168 To
.Write(Buf
.get(),ToRead
) == false)
170 } while (ToRead
!= 0);
175 bool RemoveFile(char const * const Function
, std::string
const &FileName
)/*{{{*/
177 if (FileName
== "/dev/null")
180 if (unlink(FileName
.c_str()) != 0)
185 return _error
->WarningE(Function
,_("Problem unlinking the file %s"), FileName
.c_str());
190 // GetLock - Gets a lock file /*{{{*/
191 // ---------------------------------------------------------------------
192 /* This will create an empty file of the given name and lock it. Once this
193 is done all other calls to GetLock in any other process will fail with
194 -1. The return result is the fd of the file, the call should call
195 close at some time. */
196 int GetLock(string File
,bool Errors
)
198 // GetLock() is used in aptitude on directories with public-write access
199 // Use O_NOFOLLOW here to prevent symlink traversal attacks
200 int FD
= open(File
.c_str(),O_RDWR
| O_CREAT
| O_NOFOLLOW
,0640);
203 // Read only .. can't have locking problems there.
206 _error
->Warning(_("Not using locking for read only lock file %s"),File
.c_str());
207 return dup(0); // Need something for the caller to close
211 _error
->Errno("open",_("Could not open lock file %s"),File
.c_str());
213 // Feh.. We do this to distinguish the lock vs open case..
217 SetCloseExec(FD
,true);
219 // Acquire a write lock
222 fl
.l_whence
= SEEK_SET
;
225 if (fcntl(FD
,F_SETLK
,&fl
) == -1)
227 // always close to not leak resources
234 _error
->Warning(_("Not using locking for nfs mounted lock file %s"),File
.c_str());
235 return dup(0); // Need something for the caller to close
239 _error
->Errno("open",_("Could not get lock %s"),File
.c_str());
247 // FileExists - Check if a file exists /*{{{*/
248 // ---------------------------------------------------------------------
249 /* Beware: Directories are also files! */
250 bool FileExists(string File
)
253 if (stat(File
.c_str(),&Buf
) != 0)
258 // RealFileExists - Check if a file exists and if it is really a file /*{{{*/
259 // ---------------------------------------------------------------------
261 bool RealFileExists(string File
)
264 if (stat(File
.c_str(),&Buf
) != 0)
266 return ((Buf
.st_mode
& S_IFREG
) != 0);
269 // DirectoryExists - Check if a directory exists and is really one /*{{{*/
270 // ---------------------------------------------------------------------
272 bool DirectoryExists(string
const &Path
)
275 if (stat(Path
.c_str(),&Buf
) != 0)
277 return ((Buf
.st_mode
& S_IFDIR
) != 0);
280 // CreateDirectory - poor man's mkdir -p guarded by a parent directory /*{{{*/
281 // ---------------------------------------------------------------------
282 /* This method will create all directories needed for path in good old
283 mkdir -p style but refuses to do this if Parent is not a prefix of
284 this Path. Example: /var/cache/ and /var/cache/apt/archives are given,
285 so it will create apt/archives if /var/cache exists - on the other
286 hand if the parent is /var/lib the creation will fail as this path
287 is not a parent of the path to be generated. */
288 bool CreateDirectory(string
const &Parent
, string
const &Path
)
290 if (Parent
.empty() == true || Path
.empty() == true)
293 if (DirectoryExists(Path
) == true)
296 if (DirectoryExists(Parent
) == false)
299 // we are not going to create directories "into the blue"
300 if (Path
.compare(0, Parent
.length(), Parent
) != 0)
303 vector
<string
> const dirs
= VectorizeString(Path
.substr(Parent
.size()), '/');
304 string progress
= Parent
;
305 for (vector
<string
>::const_iterator d
= dirs
.begin(); d
!= dirs
.end(); ++d
)
307 if (d
->empty() == true)
310 progress
.append("/").append(*d
);
311 if (DirectoryExists(progress
) == true)
314 if (mkdir(progress
.c_str(), 0755) != 0)
320 // CreateAPTDirectoryIfNeeded - ensure that the given directory exists /*{{{*/
321 // ---------------------------------------------------------------------
322 /* a small wrapper around CreateDirectory to check if it exists and to
323 remove the trailing "/apt/" from the parent directory if needed */
324 bool CreateAPTDirectoryIfNeeded(string
const &Parent
, string
const &Path
)
326 if (DirectoryExists(Path
) == true)
329 size_t const len
= Parent
.size();
330 if (len
> 5 && Parent
.find("/apt/", len
- 6, 5) == len
- 5)
332 if (CreateDirectory(Parent
.substr(0,len
-5), Path
) == true)
335 else if (CreateDirectory(Parent
, Path
) == true)
341 // GetListOfFilesInDir - returns a vector of files in the given dir /*{{{*/
342 // ---------------------------------------------------------------------
343 /* If an extension is given only files with this extension are included
344 in the returned vector, otherwise every "normal" file is included. */
345 std::vector
<string
> GetListOfFilesInDir(string
const &Dir
, string
const &Ext
,
346 bool const &SortList
, bool const &AllowNoExt
)
348 std::vector
<string
> ext
;
350 if (Ext
.empty() == false)
352 if (AllowNoExt
== true && ext
.empty() == false)
354 return GetListOfFilesInDir(Dir
, ext
, SortList
);
356 std::vector
<string
> GetListOfFilesInDir(string
const &Dir
, std::vector
<string
> const &Ext
,
357 bool const &SortList
)
359 // Attention debuggers: need to be set with the environment config file!
360 bool const Debug
= _config
->FindB("Debug::GetListOfFilesInDir", false);
363 std::clog
<< "Accept in " << Dir
<< " only files with the following " << Ext
.size() << " extensions:" << std::endl
;
364 if (Ext
.empty() == true)
365 std::clog
<< "\tNO extension" << std::endl
;
367 for (std::vector
<string
>::const_iterator e
= Ext
.begin();
369 std::clog
<< '\t' << (e
->empty() == true ? "NO" : *e
) << " extension" << std::endl
;
372 std::vector
<string
> List
;
374 if (DirectoryExists(Dir
) == false)
376 _error
->Error(_("List of files can't be created as '%s' is not a directory"), Dir
.c_str());
380 Configuration::MatchAgainstConfig
SilentIgnore("Dir::Ignore-Files-Silently");
381 DIR *D
= opendir(Dir
.c_str());
384 _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
388 for (struct dirent
*Ent
= readdir(D
); Ent
!= 0; Ent
= readdir(D
))
390 // skip "hidden" files
391 if (Ent
->d_name
[0] == '.')
394 // Make sure it is a file and not something else
395 string
const File
= flCombine(Dir
,Ent
->d_name
);
396 #ifdef _DIRENT_HAVE_D_TYPE
397 if (Ent
->d_type
!= DT_REG
)
400 if (RealFileExists(File
) == false)
402 // do not show ignoration warnings for directories
404 #ifdef _DIRENT_HAVE_D_TYPE
405 Ent
->d_type
== DT_DIR
||
407 DirectoryExists(File
) == true)
409 if (SilentIgnore
.Match(Ent
->d_name
) == false)
410 _error
->Notice(_("Ignoring '%s' in directory '%s' as it is not a regular file"), Ent
->d_name
, Dir
.c_str());
415 // check for accepted extension:
416 // no extension given -> periods are bad as hell!
417 // extensions given -> "" extension allows no extension
418 if (Ext
.empty() == false)
420 string d_ext
= flExtension(Ent
->d_name
);
421 if (d_ext
== Ent
->d_name
) // no extension
423 if (std::find(Ext
.begin(), Ext
.end(), "") == Ext
.end())
426 std::clog
<< "Bad file: " << Ent
->d_name
<< " → no extension" << std::endl
;
427 if (SilentIgnore
.Match(Ent
->d_name
) == false)
428 _error
->Notice(_("Ignoring file '%s' in directory '%s' as it has no filename extension"), Ent
->d_name
, Dir
.c_str());
432 else if (std::find(Ext
.begin(), Ext
.end(), d_ext
) == Ext
.end())
435 std::clog
<< "Bad file: " << Ent
->d_name
<< " → bad extension »" << flExtension(Ent
->d_name
) << "«" << std::endl
;
436 if (SilentIgnore
.Match(Ent
->d_name
) == false)
437 _error
->Notice(_("Ignoring file '%s' in directory '%s' as it has an invalid filename extension"), Ent
->d_name
, Dir
.c_str());
442 // Skip bad filenames ala run-parts
443 const char *C
= Ent
->d_name
;
445 if (isalpha(*C
) == 0 && isdigit(*C
) == 0
446 && *C
!= '_' && *C
!= '-' && *C
!= ':') {
447 // no required extension -> dot is a bad character
448 if (*C
== '.' && Ext
.empty() == false)
453 // we don't reach the end of the name -> bad character included
457 std::clog
<< "Bad file: " << Ent
->d_name
<< " → bad character »"
458 << *C
<< "« in filename (period allowed: " << (Ext
.empty() ? "no" : "yes") << ")" << std::endl
;
462 // skip filenames which end with a period. These are never valid
466 std::clog
<< "Bad file: " << Ent
->d_name
<< " → Period as last character" << std::endl
;
471 std::clog
<< "Accept file: " << Ent
->d_name
<< " in " << Dir
<< std::endl
;
472 List
.push_back(File
);
476 if (SortList
== true)
477 std::sort(List
.begin(),List
.end());
480 std::vector
<string
> GetListOfFilesInDir(string
const &Dir
, bool SortList
)
482 bool const Debug
= _config
->FindB("Debug::GetListOfFilesInDir", false);
484 std::clog
<< "Accept in " << Dir
<< " all regular files" << std::endl
;
486 std::vector
<string
> List
;
488 if (DirectoryExists(Dir
) == false)
490 _error
->Error(_("List of files can't be created as '%s' is not a directory"), Dir
.c_str());
494 DIR *D
= opendir(Dir
.c_str());
497 _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
501 for (struct dirent
*Ent
= readdir(D
); Ent
!= 0; Ent
= readdir(D
))
503 // skip "hidden" files
504 if (Ent
->d_name
[0] == '.')
507 // Make sure it is a file and not something else
508 string
const File
= flCombine(Dir
,Ent
->d_name
);
509 #ifdef _DIRENT_HAVE_D_TYPE
510 if (Ent
->d_type
!= DT_REG
)
513 if (RealFileExists(File
) == false)
516 std::clog
<< "Bad file: " << Ent
->d_name
<< " → it is not a real file" << std::endl
;
521 // Skip bad filenames ala run-parts
522 const char *C
= Ent
->d_name
;
524 if (isalpha(*C
) == 0 && isdigit(*C
) == 0
525 && *C
!= '_' && *C
!= '-' && *C
!= '.')
528 // we don't reach the end of the name -> bad character included
532 std::clog
<< "Bad file: " << Ent
->d_name
<< " → bad character »" << *C
<< "« in filename" << std::endl
;
536 // skip filenames which end with a period. These are never valid
540 std::clog
<< "Bad file: " << Ent
->d_name
<< " → Period as last character" << std::endl
;
545 std::clog
<< "Accept file: " << Ent
->d_name
<< " in " << Dir
<< std::endl
;
546 List
.push_back(File
);
550 if (SortList
== true)
551 std::sort(List
.begin(),List
.end());
555 // SafeGetCWD - This is a safer getcwd that returns a dynamic string /*{{{*/
556 // ---------------------------------------------------------------------
557 /* We return / on failure. */
560 // Stash the current dir.
563 if (getcwd(S
,sizeof(S
)-2) == 0)
565 unsigned int Len
= strlen(S
);
571 // GetModificationTime - Get the mtime of the given file or -1 on error /*{{{*/
572 // ---------------------------------------------------------------------
573 /* We return / on failure. */
574 time_t GetModificationTime(string
const &Path
)
577 if (stat(Path
.c_str(), &St
) < 0)
582 // flNotDir - Strip the directory from the filename /*{{{*/
583 // ---------------------------------------------------------------------
585 string
flNotDir(string File
)
587 string::size_type Res
= File
.rfind('/');
588 if (Res
== string::npos
)
591 return string(File
,Res
,Res
- File
.length());
594 // flNotFile - Strip the file from the directory name /*{{{*/
595 // ---------------------------------------------------------------------
596 /* Result ends in a / */
597 string
flNotFile(string File
)
599 string::size_type Res
= File
.rfind('/');
600 if (Res
== string::npos
)
603 return string(File
,0,Res
);
606 // flExtension - Return the extension for the file /*{{{*/
607 // ---------------------------------------------------------------------
609 string
flExtension(string File
)
611 string::size_type Res
= File
.rfind('.');
612 if (Res
== string::npos
)
615 return string(File
,Res
,Res
- File
.length());
618 // flNoLink - If file is a symlink then deref it /*{{{*/
619 // ---------------------------------------------------------------------
620 /* If the name is not a link then the returned path is the input. */
621 string
flNoLink(string File
)
624 if (lstat(File
.c_str(),&St
) != 0 || S_ISLNK(St
.st_mode
) == 0)
626 if (stat(File
.c_str(),&St
) != 0)
629 /* Loop resolving the link. There is no need to limit the number of
630 loops because the stat call above ensures that the symlink is not
638 if ((Res
= readlink(NFile
.c_str(),Buffer
,sizeof(Buffer
))) <= 0 ||
639 (size_t)Res
>= sizeof(Buffer
))
642 // Append or replace the previous path
644 if (Buffer
[0] == '/')
647 NFile
= flNotFile(NFile
) + Buffer
;
649 // See if we are done
650 if (lstat(NFile
.c_str(),&St
) != 0)
652 if (S_ISLNK(St
.st_mode
) == 0)
657 // flCombine - Combine a file and a directory /*{{{*/
658 // ---------------------------------------------------------------------
659 /* If the file is an absolute path then it is just returned, otherwise
660 the directory is pre-pended to it. */
661 string
flCombine(string Dir
,string File
)
663 if (File
.empty() == true)
666 if (File
[0] == '/' || Dir
.empty() == true)
668 if (File
.length() >= 2 && File
[0] == '.' && File
[1] == '/')
670 if (Dir
[Dir
.length()-1] == '/')
672 return Dir
+ '/' + File
;
675 // flAbsPath - Return the absolute path of the filename /*{{{*/
676 // ---------------------------------------------------------------------
678 string
flAbsPath(string File
)
680 char *p
= realpath(File
.c_str(), NULL
);
683 _error
->Errno("realpath", "flAbsPath on %s failed", File
.c_str());
686 std::string
AbsPath(p
);
691 // SetCloseExec - Set the close on exec flag /*{{{*/
692 // ---------------------------------------------------------------------
694 void SetCloseExec(int Fd
,bool Close
)
696 if (fcntl(Fd
,F_SETFD
,(Close
== false)?0:FD_CLOEXEC
) != 0)
698 cerr
<< "FATAL -> Could not set close on exec " << strerror(errno
) << endl
;
703 // SetNonBlock - Set the nonblocking flag /*{{{*/
704 // ---------------------------------------------------------------------
706 void SetNonBlock(int Fd
,bool Block
)
708 int Flags
= fcntl(Fd
,F_GETFL
) & (~O_NONBLOCK
);
709 if (fcntl(Fd
,F_SETFL
,Flags
| ((Block
== false)?0:O_NONBLOCK
)) != 0)
711 cerr
<< "FATAL -> Could not set non-blocking flag " << strerror(errno
) << endl
;
716 // WaitFd - Wait for a FD to become readable /*{{{*/
717 // ---------------------------------------------------------------------
718 /* This waits for a FD to become readable using select. It is useful for
719 applications making use of non-blocking sockets. The timeout is
721 bool WaitFd(int Fd
,bool write
,unsigned long timeout
)
734 Res
= select(Fd
+1,0,&Set
,0,(timeout
!= 0?&tv
:0));
736 while (Res
< 0 && errno
== EINTR
);
746 Res
= select(Fd
+1,&Set
,0,0,(timeout
!= 0?&tv
:0));
748 while (Res
< 0 && errno
== EINTR
);
757 // MergeKeepFdsFromConfiguration - Merge APT::Keep-Fds configuration /*{{{*/
758 // ---------------------------------------------------------------------
759 /* This is used to merge the APT::Keep-Fds with the provided KeepFDs
762 void MergeKeepFdsFromConfiguration(std::set
<int> &KeepFDs
)
764 Configuration::Item
const *Opts
= _config
->Tree("APT::Keep-Fds");
765 if (Opts
!= 0 && Opts
->Child
!= 0)
768 for (; Opts
!= 0; Opts
= Opts
->Next
)
770 if (Opts
->Value
.empty() == true)
772 int fd
= atoi(Opts
->Value
.c_str());
778 // ExecFork - Magical fork that sanitizes the context before execing /*{{{*/
779 // ---------------------------------------------------------------------
780 /* This is used if you want to cleanse the environment for the forked
781 child, it fixes up the important signals and nukes all of the fds,
782 otherwise acts like normal fork. */
786 // we need to merge the Keep-Fds as external tools like
787 // debconf-apt-progress use it
788 MergeKeepFdsFromConfiguration(KeepFDs
);
789 return ExecFork(KeepFDs
);
792 pid_t
ExecFork(std::set
<int> KeepFDs
)
794 // Fork off the process
795 pid_t Process
= fork();
798 cerr
<< "FATAL -> Failed to fork." << endl
;
802 // Spawn the subprocess
806 signal(SIGPIPE
,SIG_DFL
);
807 signal(SIGQUIT
,SIG_DFL
);
808 signal(SIGINT
,SIG_DFL
);
809 signal(SIGWINCH
,SIG_DFL
);
810 signal(SIGCONT
,SIG_DFL
);
811 signal(SIGTSTP
,SIG_DFL
);
813 DIR *dir
= opendir("/proc/self/fd");
817 while ((ent
= readdir(dir
)))
819 int fd
= atoi(ent
->d_name
);
820 // If fd > 0, it was a fd number and not . or ..
821 if (fd
>= 3 && KeepFDs
.find(fd
) == KeepFDs
.end())
822 fcntl(fd
,F_SETFD
,FD_CLOEXEC
);
826 long ScOpenMax
= sysconf(_SC_OPEN_MAX
);
827 // Close all of our FDs - just in case
828 for (int K
= 3; K
!= ScOpenMax
; K
++)
830 if(KeepFDs
.find(K
) == KeepFDs
.end())
831 fcntl(K
,F_SETFD
,FD_CLOEXEC
);
839 // ExecWait - Fancy waitpid /*{{{*/
840 // ---------------------------------------------------------------------
841 /* Waits for the given sub process. If Reap is set then no errors are
842 generated. Otherwise a failed subprocess will generate a proper descriptive
844 bool ExecWait(pid_t Pid
,const char *Name
,bool Reap
)
849 // Wait and collect the error code
851 while (waitpid(Pid
,&Status
,0) != Pid
)
859 return _error
->Error(_("Waited for %s but it wasn't there"),Name
);
863 // Check for an error code.
864 if (WIFEXITED(Status
) == 0 || WEXITSTATUS(Status
) != 0)
868 if (WIFSIGNALED(Status
) != 0)
870 if( WTERMSIG(Status
) == SIGSEGV
)
871 return _error
->Error(_("Sub-process %s received a segmentation fault."),Name
);
873 return _error
->Error(_("Sub-process %s received signal %u."),Name
, WTERMSIG(Status
));
876 if (WIFEXITED(Status
) != 0)
877 return _error
->Error(_("Sub-process %s returned an error code (%u)"),Name
,WEXITSTATUS(Status
));
879 return _error
->Error(_("Sub-process %s exited unexpectedly"),Name
);
885 // StartsWithGPGClearTextSignature - Check if a file is Pgp/GPG clearsigned /*{{{*/
886 bool StartsWithGPGClearTextSignature(string
const &FileName
)
888 static const char* SIGMSG
= "-----BEGIN PGP SIGNED MESSAGE-----\n";
889 char buffer
[strlen(SIGMSG
)+1];
890 FILE* gpg
= fopen(FileName
.c_str(), "r");
894 char const * const test
= fgets(buffer
, sizeof(buffer
), gpg
);
896 if (test
== NULL
|| strcmp(buffer
, SIGMSG
) != 0)
902 // ChangeOwnerAndPermissionOfFile - set file attributes to requested values /*{{{*/
903 bool ChangeOwnerAndPermissionOfFile(char const * const requester
, char const * const file
, char const * const user
, char const * const group
, mode_t
const mode
)
905 if (strcmp(file
, "/dev/null") == 0)
908 if (getuid() == 0 && strlen(user
) != 0 && strlen(group
) != 0) // if we aren't root, we can't chown, so don't try it
910 // ensure the file is owned by root and has good permissions
911 struct passwd
const * const pw
= getpwnam(user
);
912 struct group
const * const gr
= getgrnam(group
);
913 if (pw
!= NULL
&& gr
!= NULL
&& chown(file
, pw
->pw_uid
, gr
->gr_gid
) != 0)
914 Res
&= _error
->WarningE(requester
, "chown to %s:%s of file %s failed", user
, group
, file
);
916 if (chmod(file
, mode
) != 0)
917 Res
&= _error
->WarningE(requester
, "chmod 0%o of file %s failed", mode
, file
);
922 class FileFdPrivate
{ /*{{{*/
933 uint8_t buffer
[4096];
939 LZMAFILE() : file(NULL
), eof(false), compressing(false) { buffer
[0] = '\0'; }
941 if (compressing
== true)
944 stream
.avail_out
= sizeof(buffer
)/sizeof(buffer
[0]);
945 stream
.next_out
= buffer
;
946 err
= lzma_code(&stream
, LZMA_FINISH
);
947 if (err
!= LZMA_OK
&& err
!= LZMA_STREAM_END
)
949 _error
->Error("~LZMAFILE: Compress finalisation failed");
952 size_t const n
= sizeof(buffer
)/sizeof(buffer
[0]) - stream
.avail_out
;
953 if (n
&& fwrite(buffer
, 1, n
, file
) != n
)
955 _error
->Errno("~LZMAFILE",_("Write error"));
958 if (err
== LZMA_STREAM_END
)
969 pid_t compressor_pid
;
971 APT::Configuration::Compressor compressor
;
972 unsigned int openmode
;
973 unsigned long long seekpos
;
984 compressed_fd(-1), compressor_pid(-1), pipe(false),
985 openmode(0), seekpos(0) {};
986 bool InternalClose(std::string
const &FileName
)
989 /* dummy so that the rest can be 'else if's */;
991 else if (gz
!= NULL
) {
992 int const e
= gzclose(gz
);
994 // gzdclose() on empty files always fails with "buffer error" here, ignore that
995 if (e
!= 0 && e
!= Z_BUF_ERROR
)
996 return _error
->Errno("close",_("Problem closing the gzip file %s"), FileName
.c_str());
1000 else if (bz2
!= NULL
) {
1006 else if (lzma
!= NULL
) {
1013 bool CloseDown(std::string
const &FileName
)
1015 bool const Res
= InternalClose(FileName
);
1017 if (compressor_pid
> 0)
1018 ExecWait(compressor_pid
, "FileFdCompressor", true);
1019 compressor_pid
= -1;
1023 bool InternalStream() const {
1035 ~FileFdPrivate() { CloseDown(""); }
1038 // FileFd Constructors /*{{{*/
1039 FileFd::FileFd(std::string FileName
,unsigned int const Mode
,unsigned long AccessMode
) : iFd(-1), Flags(0), d(NULL
)
1041 Open(FileName
,Mode
, None
, AccessMode
);
1043 FileFd::FileFd(std::string FileName
,unsigned int const Mode
, CompressMode Compress
, unsigned long AccessMode
) : iFd(-1), Flags(0), d(NULL
)
1045 Open(FileName
,Mode
, Compress
, AccessMode
);
1047 FileFd::FileFd() : iFd(-1), Flags(AutoClose
), d(NULL
) {}
1048 FileFd::FileFd(int const Fd
, unsigned int const Mode
, CompressMode Compress
) : iFd(-1), Flags(0), d(NULL
)
1050 OpenDescriptor(Fd
, Mode
, Compress
);
1052 FileFd::FileFd(int const Fd
, bool const AutoClose
) : iFd(-1), Flags(0), d(NULL
)
1054 OpenDescriptor(Fd
, ReadWrite
, None
, AutoClose
);
1057 // FileFd::Open - Open a file /*{{{*/
1058 // ---------------------------------------------------------------------
1059 /* The most commonly used open mode combinations are given with Mode */
1060 bool FileFd::Open(string FileName
,unsigned int const Mode
,CompressMode Compress
, unsigned long const AccessMode
)
1062 if (Mode
== ReadOnlyGzip
)
1063 return Open(FileName
, ReadOnly
, Gzip
, AccessMode
);
1065 if (Compress
== Auto
&& (Mode
& WriteOnly
) == WriteOnly
)
1066 return FileFdError("Autodetection on %s only works in ReadOnly openmode!", FileName
.c_str());
1068 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
1069 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
1070 if (Compress
== Auto
)
1072 for (; compressor
!= compressors
.end(); ++compressor
)
1074 std::string file
= FileName
+ compressor
->Extension
;
1075 if (FileExists(file
) == false)
1081 else if (Compress
== Extension
)
1083 std::string::size_type
const found
= FileName
.find_last_of('.');
1085 if (found
!= std::string::npos
)
1087 ext
= FileName
.substr(found
);
1088 if (ext
== ".new" || ext
== ".bak")
1090 std::string::size_type
const found2
= FileName
.find_last_of('.', found
- 1);
1091 if (found2
!= std::string::npos
)
1092 ext
= FileName
.substr(found2
, found
- found2
);
1097 for (; compressor
!= compressors
.end(); ++compressor
)
1098 if (ext
== compressor
->Extension
)
1100 // no matching extension - assume uncompressed (imagine files like 'example.org_Packages')
1101 if (compressor
== compressors
.end())
1102 for (compressor
= compressors
.begin(); compressor
!= compressors
.end(); ++compressor
)
1103 if (compressor
->Name
== ".")
1111 case None
: name
= "."; break;
1112 case Gzip
: name
= "gzip"; break;
1113 case Bzip2
: name
= "bzip2"; break;
1114 case Lzma
: name
= "lzma"; break;
1115 case Xz
: name
= "xz"; break;
1119 return FileFdError("Opening File %s in None, Auto or Extension should be already handled?!?", FileName
.c_str());
1121 for (; compressor
!= compressors
.end(); ++compressor
)
1122 if (compressor
->Name
== name
)
1124 if (compressor
== compressors
.end())
1125 return FileFdError("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
1128 if (compressor
== compressors
.end())
1129 return FileFdError("Can't find a match for specified compressor mode for file %s", FileName
.c_str());
1130 return Open(FileName
, Mode
, *compressor
, AccessMode
);
1132 bool FileFd::Open(string FileName
,unsigned int const Mode
,APT::Configuration::Compressor
const &compressor
, unsigned long const AccessMode
)
1137 if ((Mode
& WriteOnly
) != WriteOnly
&& (Mode
& (Atomic
| Create
| Empty
| Exclusive
)) != 0)
1138 return FileFdError("ReadOnly mode for %s doesn't accept additional flags!", FileName
.c_str());
1139 if ((Mode
& ReadWrite
) == 0)
1140 return FileFdError("No openmode provided in FileFd::Open for %s", FileName
.c_str());
1142 unsigned int OpenMode
= Mode
;
1143 if (FileName
== "/dev/null")
1144 OpenMode
= OpenMode
& ~(Atomic
| Exclusive
| Create
| Empty
);
1146 if ((OpenMode
& Atomic
) == Atomic
)
1150 else if ((OpenMode
& (Exclusive
| Create
)) == (Exclusive
| Create
))
1152 // for atomic, this will be done by rename in Close()
1153 RemoveFile("FileFd::Open", FileName
);
1155 if ((OpenMode
& Empty
) == Empty
)
1158 if (lstat(FileName
.c_str(),&Buf
) == 0 && S_ISLNK(Buf
.st_mode
))
1159 RemoveFile("FileFd::Open", FileName
);
1163 #define if_FLAGGED_SET(FLAG, MODE) if ((OpenMode & FLAG) == FLAG) fileflags |= MODE
1164 if_FLAGGED_SET(ReadWrite
, O_RDWR
);
1165 else if_FLAGGED_SET(ReadOnly
, O_RDONLY
);
1166 else if_FLAGGED_SET(WriteOnly
, O_WRONLY
);
1168 if_FLAGGED_SET(Create
, O_CREAT
);
1169 if_FLAGGED_SET(Empty
, O_TRUNC
);
1170 if_FLAGGED_SET(Exclusive
, O_EXCL
);
1171 #undef if_FLAGGED_SET
1173 if ((OpenMode
& Atomic
) == Atomic
)
1175 char *name
= strdup((FileName
+ ".XXXXXX").c_str());
1177 if((iFd
= mkstemp(name
)) == -1)
1180 return FileFdErrno("mkstemp", "Could not create temporary file for %s", FileName
.c_str());
1183 TemporaryFileName
= string(name
);
1186 // umask() will always set the umask and return the previous value, so
1187 // we first set the umask and then reset it to the old value
1188 mode_t
const CurrentUmask
= umask(0);
1189 umask(CurrentUmask
);
1190 // calculate the actual file permissions (just like open/creat)
1191 mode_t
const FilePermissions
= (AccessMode
& ~CurrentUmask
);
1193 if(fchmod(iFd
, FilePermissions
) == -1)
1194 return FileFdErrno("fchmod", "Could not change permissions for temporary file %s", TemporaryFileName
.c_str());
1197 iFd
= open(FileName
.c_str(), fileflags
, AccessMode
);
1199 this->FileName
= FileName
;
1200 if (iFd
== -1 || OpenInternDescriptor(OpenMode
, compressor
) == false)
1207 return FileFdErrno("open",_("Could not open file %s"), FileName
.c_str());
1210 SetCloseExec(iFd
,true);
1214 // FileFd::OpenDescriptor - Open a filedescriptor /*{{{*/
1215 // ---------------------------------------------------------------------
1217 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, CompressMode Compress
, bool AutoClose
)
1219 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
1220 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
1223 // compat with the old API
1224 if (Mode
== ReadOnlyGzip
&& Compress
== None
)
1229 case None
: name
= "."; break;
1230 case Gzip
: name
= "gzip"; break;
1231 case Bzip2
: name
= "bzip2"; break;
1232 case Lzma
: name
= "lzma"; break;
1233 case Xz
: name
= "xz"; break;
1236 if (AutoClose
== true && Fd
!= -1)
1238 return FileFdError("Opening Fd %d in Auto or Extension compression mode is not supported", Fd
);
1240 for (; compressor
!= compressors
.end(); ++compressor
)
1241 if (compressor
->Name
== name
)
1243 if (compressor
== compressors
.end())
1245 if (AutoClose
== true && Fd
!= -1)
1247 return FileFdError("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
1249 return OpenDescriptor(Fd
, Mode
, *compressor
, AutoClose
);
1251 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
, bool AutoClose
)
1254 Flags
= (AutoClose
) ? FileFd::AutoClose
: 0;
1256 this->FileName
= "";
1257 if (OpenInternDescriptor(Mode
, compressor
) == false)
1260 (Flags
& Compressed
) == Compressed
||
1266 return FileFdError(_("Could not open file descriptor %d"), Fd
);
1270 bool FileFd::OpenInternDescriptor(unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
)
1274 if (compressor
.Name
== "." || compressor
.Binary
.empty() == true)
1277 #if defined HAVE_ZLIB || defined HAVE_BZ2 || defined HAVE_LZMA
1278 // the API to open files is similar, so setup to avoid code duplicates later
1279 // and while at it ensure that we close before opening (if its a reopen)
1280 void* (*compress_open
)(int, const char *) = NULL
;
1282 /* dummy so that the rest can be 'else if's */;
1283 #define APT_COMPRESS_INIT(NAME,OPEN) \
1284 else if (compressor.Name == NAME) \
1286 compress_open = (void*(*)(int, const char *)) OPEN; \
1287 if (d != NULL) d->InternalClose(FileName); \
1290 APT_COMPRESS_INIT("gzip", gzdopen
)
1293 APT_COMPRESS_INIT("bzip2", BZ2_bzdopen
)
1296 APT_COMPRESS_INIT("xz", fdopen
)
1297 APT_COMPRESS_INIT("lzma", fdopen
)
1299 #undef APT_COMPRESS_INIT
1304 d
= new FileFdPrivate();
1306 d
->compressor
= compressor
;
1307 #if defined HAVE_ZLIB || defined HAVE_BZ2 || defined HAVE_LZMA
1308 if ((Flags
& AutoClose
) != AutoClose
&& compress_open
!= NULL
)
1310 // Need to duplicate fd here or gz/bz2 close for cleanup will close the fd as well
1311 int const internFd
= dup(iFd
);
1313 return FileFdErrno("OpenInternDescriptor", _("Could not open file descriptor %d"), iFd
);
1319 #if defined HAVE_ZLIB || defined HAVE_BZ2 || defined HAVE_LZMA
1320 if (compress_open
!= NULL
)
1322 void* compress_struct
= NULL
;
1323 if ((Mode
& ReadWrite
) == ReadWrite
)
1324 compress_struct
= compress_open(iFd
, "r+");
1325 else if ((Mode
& WriteOnly
) == WriteOnly
)
1326 compress_struct
= compress_open(iFd
, "w");
1328 compress_struct
= compress_open(iFd
, "r");
1329 if (compress_struct
== NULL
)
1333 /* dummy so that the rest can be 'else if's */;
1335 else if (compressor
.Name
== "gzip")
1336 d
->gz
= (gzFile
) compress_struct
;
1339 else if (compressor
.Name
== "bzip2")
1340 d
->bz2
= (BZFILE
*) compress_struct
;
1343 else if (compressor
.Name
== "xz" || compressor
.Name
== "lzma")
1345 uint32_t const xzlevel
= 6;
1346 uint64_t const memlimit
= UINT64_MAX
;
1347 if (d
->lzma
== NULL
)
1348 d
->lzma
= new FileFdPrivate::LZMAFILE
;
1349 d
->lzma
->file
= (FILE*) compress_struct
;
1350 lzma_stream tmp_stream
= LZMA_STREAM_INIT
;
1351 d
->lzma
->stream
= tmp_stream
;
1353 if ((Mode
& ReadWrite
) == ReadWrite
)
1354 return FileFdError("ReadWrite mode is not supported for file %s", FileName
.c_str());
1356 if ((Mode
& WriteOnly
) == WriteOnly
)
1358 if (compressor
.Name
== "xz")
1360 if (lzma_easy_encoder(&d
->lzma
->stream
, xzlevel
, LZMA_CHECK_CRC32
) != LZMA_OK
)
1365 lzma_options_lzma options
;
1366 lzma_lzma_preset(&options
, xzlevel
);
1367 if (lzma_alone_encoder(&d
->lzma
->stream
, &options
) != LZMA_OK
)
1370 d
->lzma
->compressing
= true;
1374 if (compressor
.Name
== "xz")
1376 if (lzma_auto_decoder(&d
->lzma
->stream
, memlimit
, 0) != LZMA_OK
)
1381 if (lzma_alone_decoder(&d
->lzma
->stream
, memlimit
) != LZMA_OK
)
1384 d
->lzma
->compressing
= false;
1388 Flags
|= Compressed
;
1393 // collect zombies here in case we reopen
1394 if (d
->compressor_pid
> 0)
1395 ExecWait(d
->compressor_pid
, "FileFdCompressor", true);
1397 if ((Mode
& ReadWrite
) == ReadWrite
)
1398 return FileFdError("ReadWrite mode is not supported for file %s", FileName
.c_str());
1400 bool const Comp
= (Mode
& WriteOnly
) == WriteOnly
;
1403 // Handle 'decompression' of empty files
1406 if (Buf
.st_size
== 0 && S_ISFIFO(Buf
.st_mode
) == false)
1409 // We don't need the file open - instead let the compressor open it
1410 // as he properly knows better how to efficiently read from 'his' file
1411 if (FileName
.empty() == false)
1418 // Create a data pipe
1419 int Pipe
[2] = {-1,-1};
1420 if (pipe(Pipe
) != 0)
1421 return FileFdErrno("pipe",_("Failed to create subprocess IPC"));
1422 for (int J
= 0; J
!= 2; J
++)
1423 SetCloseExec(Pipe
[J
],true);
1425 d
->compressed_fd
= iFd
;
1434 d
->compressor_pid
= ExecFork();
1435 if (d
->compressor_pid
== 0)
1439 dup2(d
->compressed_fd
,STDOUT_FILENO
);
1440 dup2(Pipe
[0],STDIN_FILENO
);
1444 if (d
->compressed_fd
!= -1)
1445 dup2(d
->compressed_fd
,STDIN_FILENO
);
1446 dup2(Pipe
[1],STDOUT_FILENO
);
1448 int const nullfd
= open("/dev/null", O_WRONLY
);
1451 dup2(nullfd
,STDERR_FILENO
);
1455 SetCloseExec(STDOUT_FILENO
,false);
1456 SetCloseExec(STDIN_FILENO
,false);
1458 std::vector
<char const*> Args
;
1459 Args
.push_back(compressor
.Binary
.c_str());
1460 std::vector
<std::string
> const * const addArgs
=
1461 (Comp
== true) ? &(compressor
.CompressArgs
) : &(compressor
.UncompressArgs
);
1462 for (std::vector
<std::string
>::const_iterator a
= addArgs
->begin();
1463 a
!= addArgs
->end(); ++a
)
1464 Args
.push_back(a
->c_str());
1465 if (Comp
== false && FileName
.empty() == false)
1467 // commands not needing arguments, do not need to be told about using standard output
1468 // in reality, only testcases with tools like cat, rev, rot13, … are able to trigger this
1469 if (compressor
.CompressArgs
.empty() == false && compressor
.UncompressArgs
.empty() == false)
1470 Args
.push_back("--stdout");
1471 if (TemporaryFileName
.empty() == false)
1472 Args
.push_back(TemporaryFileName
.c_str());
1474 Args
.push_back(FileName
.c_str());
1476 Args
.push_back(NULL
);
1478 execvp(Args
[0],(char **)&Args
[0]);
1479 cerr
<< _("Failed to exec compressor ") << Args
[0] << endl
;
1490 // FileFd::~File - Closes the file /*{{{*/
1491 // ---------------------------------------------------------------------
1492 /* If the proper modes are selected then we close the Fd and possibly
1493 unlink the file on error. */
1498 d
->CloseDown(FileName
);
1503 // FileFd::Read - Read a bit of the file /*{{{*/
1504 // ---------------------------------------------------------------------
1505 /* We are careful to handle interruption by a signal while reading
1507 bool FileFd::Read(void *To
,unsigned long long Size
,unsigned long long *Actual
)
1513 *((char *)To
) = '\0';
1514 while (Res
> 0 && Size
> 0)
1517 /* dummy so that the rest can be 'else if's */;
1519 else if (d
!= NULL
&& d
->gz
!= NULL
)
1520 Res
= gzread(d
->gz
,To
,Size
);
1523 else if (d
!= NULL
&& d
->bz2
!= NULL
)
1524 Res
= BZ2_bzread(d
->bz2
,To
,Size
);
1527 else if (d
!= NULL
&& d
->lzma
!= NULL
)
1529 if (d
->lzma
->eof
== true)
1532 d
->lzma
->stream
.next_out
= (uint8_t *) To
;
1533 d
->lzma
->stream
.avail_out
= Size
;
1534 if (d
->lzma
->stream
.avail_in
== 0)
1536 d
->lzma
->stream
.next_in
= d
->lzma
->buffer
;
1537 d
->lzma
->stream
.avail_in
= fread(d
->lzma
->buffer
, 1, sizeof(d
->lzma
->buffer
)/sizeof(d
->lzma
->buffer
[0]), d
->lzma
->file
);
1539 d
->lzma
->err
= lzma_code(&d
->lzma
->stream
, LZMA_RUN
);
1540 if (d
->lzma
->err
== LZMA_STREAM_END
)
1542 d
->lzma
->eof
= true;
1543 Res
= Size
- d
->lzma
->stream
.avail_out
;
1545 else if (d
->lzma
->err
!= LZMA_OK
)
1552 Res
= Size
- d
->lzma
->stream
.avail_out
;
1555 // lzma run was okay, but produced no output…
1563 Res
= read(iFd
,To
,Size
);
1569 // trick the while-loop into running again
1575 /* dummy so that the rest can be 'else if's */;
1577 else if (d
!= NULL
&& d
->gz
!= NULL
)
1580 char const * const errmsg
= gzerror(d
->gz
, &err
);
1582 return FileFdError("gzread: %s (%d: %s)", _("Read error"), err
, errmsg
);
1586 else if (d
!= NULL
&& d
->bz2
!= NULL
)
1589 char const * const errmsg
= BZ2_bzerror(d
->bz2
, &err
);
1590 if (err
!= BZ_IO_ERROR
)
1591 return FileFdError("BZ2_bzread: %s %s (%d: %s)", FileName
.c_str(), _("Read error"), err
, errmsg
);
1595 else if (d
!= NULL
&& d
->lzma
!= NULL
)
1596 return FileFdError("lzma_read: %s (%d)", _("Read error"), d
->lzma
->err
);
1598 return FileFdErrno("read",_("Read error"));
1601 To
= (char *)To
+ Res
;
1619 return FileFdError(_("read, still have %llu to read but none left"), Size
);
1622 // FileFd::ReadLine - Read a complete line from the file /*{{{*/
1623 // ---------------------------------------------------------------------
1624 /* Beware: This method can be quiet slow for big buffers on UNcompressed
1625 files because of the naive implementation! */
1626 char* FileFd::ReadLine(char *To
, unsigned long long const Size
)
1630 if (d
!= NULL
&& d
->gz
!= NULL
)
1631 return gzgets(d
->gz
, To
, Size
);
1634 unsigned long long read
= 0;
1635 while ((Size
- 1) != read
)
1637 unsigned long long done
= 0;
1638 if (Read(To
+ read
, 1, &done
) == false)
1642 if (To
[read
++] == '\n')
1651 // FileFd::Write - Write to the file /*{{{*/
1652 // ---------------------------------------------------------------------
1654 bool FileFd::Write(const void *From
,unsigned long long Size
)
1658 while (Res
> 0 && Size
> 0)
1661 /* dummy so that the rest can be 'else if's */;
1663 else if (d
!= NULL
&& d
->gz
!= NULL
)
1664 Res
= gzwrite(d
->gz
,From
,Size
);
1667 else if (d
!= NULL
&& d
->bz2
!= NULL
)
1668 Res
= BZ2_bzwrite(d
->bz2
,(void*)From
,Size
);
1671 else if (d
!= NULL
&& d
->lzma
!= NULL
)
1673 d
->lzma
->stream
.next_in
= (uint8_t *)From
;
1674 d
->lzma
->stream
.avail_in
= Size
;
1675 d
->lzma
->stream
.next_out
= d
->lzma
->buffer
;
1676 d
->lzma
->stream
.avail_out
= sizeof(d
->lzma
->buffer
)/sizeof(d
->lzma
->buffer
[0]);
1677 d
->lzma
->err
= lzma_code(&d
->lzma
->stream
, LZMA_RUN
);
1678 if (d
->lzma
->err
!= LZMA_OK
)
1680 size_t const n
= sizeof(d
->lzma
->buffer
)/sizeof(d
->lzma
->buffer
[0]) - d
->lzma
->stream
.avail_out
;
1681 size_t const m
= (n
== 0) ? 0 : fwrite(d
->lzma
->buffer
, 1, n
, d
->lzma
->file
);
1685 Res
= Size
- d
->lzma
->stream
.avail_in
;
1689 Res
= write(iFd
,From
,Size
);
1691 if (Res
< 0 && errno
== EINTR
)
1696 /* dummy so that the rest can be 'else if's */;
1698 else if (d
!= NULL
&& d
->gz
!= NULL
)
1701 char const * const errmsg
= gzerror(d
->gz
, &err
);
1703 return FileFdError("gzwrite: %s (%d: %s)", _("Write error"), err
, errmsg
);
1707 else if (d
!= NULL
&& d
->bz2
!= NULL
)
1710 char const * const errmsg
= BZ2_bzerror(d
->bz2
, &err
);
1711 if (err
!= BZ_IO_ERROR
)
1712 return FileFdError("BZ2_bzwrite: %s (%d: %s)", _("Write error"), err
, errmsg
);
1716 else if (d
!= NULL
&& d
->lzma
!= NULL
)
1717 return FileFdErrno("lzma_fwrite", _("Write error"));
1719 return FileFdErrno("write",_("Write error"));
1722 From
= (char const *)From
+ Res
;
1731 return FileFdError(_("write, still have %llu to write but couldn't"), Size
);
1733 bool FileFd::Write(int Fd
, const void *From
, unsigned long long Size
)
1737 while (Res
> 0 && Size
> 0)
1739 Res
= write(Fd
,From
,Size
);
1740 if (Res
< 0 && errno
== EINTR
)
1743 return _error
->Errno("write",_("Write error"));
1745 From
= (char const *)From
+ Res
;
1752 return _error
->Error(_("write, still have %llu to write but couldn't"), Size
);
1755 // FileFd::Seek - Seek in the file /*{{{*/
1756 // ---------------------------------------------------------------------
1758 bool FileFd::Seek(unsigned long long To
)
1762 if (d
!= NULL
&& (d
->pipe
== true || d
->InternalStream() == true))
1764 // Our poor man seeking in pipes is costly, so try to avoid it
1765 unsigned long long seekpos
= Tell();
1768 else if (seekpos
< To
)
1769 return Skip(To
- seekpos
);
1771 if ((d
->openmode
& ReadOnly
) != ReadOnly
)
1772 return FileFdError("Reopen is only implemented for read-only files!");
1773 d
->InternalClose(FileName
);
1777 if (TemporaryFileName
.empty() == false)
1778 iFd
= open(TemporaryFileName
.c_str(), O_RDONLY
);
1779 else if (FileName
.empty() == false)
1780 iFd
= open(FileName
.c_str(), O_RDONLY
);
1783 if (d
->compressed_fd
> 0)
1784 if (lseek(d
->compressed_fd
, 0, SEEK_SET
) != 0)
1785 iFd
= d
->compressed_fd
;
1787 return FileFdError("Reopen is not implemented for pipes opened with FileFd::OpenDescriptor()!");
1790 if (OpenInternDescriptor(d
->openmode
, d
->compressor
) == false)
1791 return FileFdError("Seek on file %s because it couldn't be reopened", FileName
.c_str());
1801 if (d
!= NULL
&& d
->gz
)
1802 res
= gzseek(d
->gz
,To
,SEEK_SET
);
1805 res
= lseek(iFd
,To
,SEEK_SET
);
1806 if (res
!= (off_t
)To
)
1807 return FileFdError("Unable to seek to %llu", To
);
1814 // FileFd::Skip - Seek in the file /*{{{*/
1815 // ---------------------------------------------------------------------
1817 bool FileFd::Skip(unsigned long long Over
)
1819 if (d
!= NULL
&& (d
->pipe
== true || d
->InternalStream() == true))
1824 unsigned long long toread
= std::min((unsigned long long) sizeof(buffer
), Over
);
1825 if (Read(buffer
, toread
) == false)
1826 return FileFdError("Unable to seek ahead %llu",Over
);
1834 if (d
!= NULL
&& d
->gz
!= NULL
)
1835 res
= gzseek(d
->gz
,Over
,SEEK_CUR
);
1838 res
= lseek(iFd
,Over
,SEEK_CUR
);
1840 return FileFdError("Unable to seek ahead %llu",Over
);
1847 // FileFd::Truncate - Truncate the file /*{{{*/
1848 // ---------------------------------------------------------------------
1850 bool FileFd::Truncate(unsigned long long To
)
1852 // truncating /dev/null is always successful - as we get an error otherwise
1853 if (To
== 0 && FileName
== "/dev/null")
1855 #if defined HAVE_ZLIB || defined HAVE_BZ2 || defined HAVE_LZMA
1856 if (d
!= NULL
&& (d
->InternalStream() == true
1861 return FileFdError("Truncating compressed files is not implemented (%s)", FileName
.c_str());
1863 if (ftruncate(iFd
,To
) != 0)
1864 return FileFdError("Unable to truncate to %llu",To
);
1869 // FileFd::Tell - Current seek position /*{{{*/
1870 // ---------------------------------------------------------------------
1872 unsigned long long FileFd::Tell()
1874 // In theory, we could just return seekpos here always instead of
1875 // seeking around, but not all users of FileFd use always Seek() and co
1876 // so d->seekpos isn't always true and we can just use it as a hint if
1877 // we have nothing else, but not always as an authority…
1878 if (d
!= NULL
&& (d
->pipe
== true || d
->InternalStream() == true))
1883 if (d
!= NULL
&& d
->gz
!= NULL
)
1884 Res
= gztell(d
->gz
);
1887 Res
= lseek(iFd
,0,SEEK_CUR
);
1888 if (Res
== (off_t
)-1)
1889 FileFdErrno("lseek","Failed to determine the current file position");
1895 static bool StatFileFd(char const * const msg
, int const iFd
, std::string
const &FileName
, struct stat
&Buf
, FileFdPrivate
* const d
) /*{{{*/
1897 bool ispipe
= (d
!= NULL
&& d
->pipe
== true);
1898 if (ispipe
== false)
1900 if (fstat(iFd
,&Buf
) != 0)
1901 // higher-level code will generate more meaningful messages,
1902 // even translated this would be meaningless for users
1903 return _error
->Errno("fstat", "Unable to determine %s for fd %i", msg
, iFd
);
1904 if (FileName
.empty() == false)
1905 ispipe
= S_ISFIFO(Buf
.st_mode
);
1908 // for compressor pipes st_size is undefined and at 'best' zero
1911 // we set it here, too, as we get the info here for free
1912 // in theory the Open-methods should take care of it already
1915 if (stat(FileName
.c_str(), &Buf
) != 0)
1916 return _error
->Errno("fstat", "Unable to determine %s for file %s", msg
, FileName
.c_str());
1921 // FileFd::FileSize - Return the size of the file /*{{{*/
1922 unsigned long long FileFd::FileSize()
1925 if (StatFileFd("file size", iFd
, FileName
, Buf
, d
) == false)
1933 // FileFd::ModificationTime - Return the time of last touch /*{{{*/
1934 time_t FileFd::ModificationTime()
1937 if (StatFileFd("modification time", iFd
, FileName
, Buf
, d
) == false)
1942 return Buf
.st_mtime
;
1945 // FileFd::Size - Return the size of the content in the file /*{{{*/
1946 // ---------------------------------------------------------------------
1948 unsigned long long FileFd::Size()
1950 unsigned long long size
= FileSize();
1952 // for compressor pipes st_size is undefined and at 'best' zero,
1953 // so we 'read' the content and 'seek' back - see there
1954 if (d
!= NULL
&& (d
->pipe
== true || (d
->InternalStream() == true && size
> 0)))
1956 unsigned long long const oldSeek
= Tell();
1958 unsigned long long read
= 0;
1960 if (Read(ignore
, sizeof(ignore
), &read
) == false)
1970 // only check gzsize if we are actually a gzip file, just checking for
1971 // "gz" is not sufficient as uncompressed files could be opened with
1972 // gzopen in "direct" mode as well
1973 else if (d
!= NULL
&& d
->gz
&& !gzdirect(d
->gz
) && size
> 0)
1975 off_t
const oldPos
= lseek(iFd
,0,SEEK_CUR
);
1976 /* unfortunately zlib.h doesn't provide a gzsize(), so we have to do
1977 * this ourselves; the original (uncompressed) file size is the last 32
1978 * bits of the file */
1979 // FIXME: Size for gz-files is limited by 32bit… no largefile support
1980 if (lseek(iFd
, -4, SEEK_END
) < 0)
1982 FileFdErrno("lseek","Unable to seek to end of gzipped file");
1986 if (read(iFd
, &size
, 4) != 4)
1988 FileFdErrno("read","Unable to read original size of gzipped file");
1991 size
= le32toh(size
);
1993 if (lseek(iFd
, oldPos
, SEEK_SET
) < 0)
1995 FileFdErrno("lseek","Unable to seek in gzipped file");
2006 // FileFd::Close - Close the file if the close flag is set /*{{{*/
2007 // ---------------------------------------------------------------------
2009 bool FileFd::Close()
2015 if ((Flags
& AutoClose
) == AutoClose
)
2017 if ((Flags
& Compressed
) != Compressed
&& iFd
> 0 && close(iFd
) != 0)
2018 Res
&= _error
->Errno("close",_("Problem closing the file %s"), FileName
.c_str());
2023 Res
&= d
->CloseDown(FileName
);
2028 if ((Flags
& Replace
) == Replace
) {
2029 if (rename(TemporaryFileName
.c_str(), FileName
.c_str()) != 0)
2030 Res
&= _error
->Errno("rename",_("Problem renaming the file %s to %s"), TemporaryFileName
.c_str(), FileName
.c_str());
2032 FileName
= TemporaryFileName
; // for the unlink() below.
2033 TemporaryFileName
.clear();
2038 if ((Flags
& Fail
) == Fail
&& (Flags
& DelOnFail
) == DelOnFail
&&
2039 FileName
.empty() == false)
2040 Res
&= RemoveFile("FileFd::Close", FileName
);
2047 // FileFd::Sync - Sync the file /*{{{*/
2048 // ---------------------------------------------------------------------
2052 if (fsync(iFd
) != 0)
2053 return FileFdErrno("sync",_("Problem syncing the file"));
2057 // FileFd::FileFdErrno - set Fail and call _error->Errno *{{{*/
2058 bool FileFd::FileFdErrno(const char *Function
, const char *Description
,...)
2062 size_t msgSize
= 400;
2063 int const errsv
= errno
;
2066 va_start(args
,Description
);
2067 if (_error
->InsertErrno(GlobalError::ERROR
, Function
, Description
, args
, errsv
, msgSize
) == false)
2074 // FileFd::FileFdError - set Fail and call _error->Error *{{{*/
2075 bool FileFd::FileFdError(const char *Description
,...) {
2078 size_t msgSize
= 400;
2081 va_start(args
,Description
);
2082 if (_error
->Insert(GlobalError::ERROR
, Description
, args
, msgSize
) == false)
2090 gzFile
FileFd::gzFd() {
2098 // Glob - wrapper around "glob()" /*{{{*/
2099 std::vector
<std::string
> Glob(std::string
const &pattern
, int flags
)
2101 std::vector
<std::string
> result
;
2106 glob_res
= glob(pattern
.c_str(), flags
, NULL
, &globbuf
);
2110 if(glob_res
!= GLOB_NOMATCH
) {
2111 _error
->Errno("glob", "Problem with glob");
2117 for(i
=0;i
<globbuf
.gl_pathc
;i
++)
2118 result
.push_back(string(globbuf
.gl_pathv
[i
]));
2124 std::string
GetTempDir() /*{{{*/
2126 const char *tmpdir
= getenv("TMPDIR");
2134 if (!tmpdir
|| strlen(tmpdir
) == 0 || // tmpdir is set
2135 stat(tmpdir
, &st
) != 0 || (st
.st_mode
& S_IFDIR
) == 0) // exists and is directory
2137 else if (geteuid() != 0 && // root can do everything anyway
2138 faccessat(-1, tmpdir
, R_OK
| W_OK
| X_OK
, AT_EACCESS
| AT_SYMLINK_NOFOLLOW
) != 0) // current user has rwx access to directory
2141 return string(tmpdir
);
2143 std::string
GetTempDir(std::string
const &User
)
2145 // no need/possibility to drop privs
2146 if(getuid() != 0 || User
.empty() || User
== "root")
2147 return GetTempDir();
2149 struct passwd
const * const pw
= getpwnam(User
.c_str());
2151 return GetTempDir();
2153 gid_t
const old_euid
= geteuid();
2154 gid_t
const old_egid
= getegid();
2155 if (setegid(pw
->pw_gid
) != 0)
2156 _error
->Errno("setegid", "setegid %u failed", pw
->pw_gid
);
2157 if (seteuid(pw
->pw_uid
) != 0)
2158 _error
->Errno("seteuid", "seteuid %u failed", pw
->pw_uid
);
2160 std::string
const tmp
= GetTempDir();
2162 if (seteuid(old_euid
) != 0)
2163 _error
->Errno("seteuid", "seteuid %u failed", old_euid
);
2164 if (setegid(old_egid
) != 0)
2165 _error
->Errno("setegid", "setegid %u failed", old_egid
);
2170 FileFd
* GetTempFile(std::string
const &Prefix
, bool ImmediateUnlink
, FileFd
* const TmpFd
) /*{{{*/
2173 FileFd
* const Fd
= TmpFd
== NULL
? new FileFd() : TmpFd
;
2175 std::string
const tempdir
= GetTempDir();
2176 snprintf(fn
, sizeof(fn
), "%s/%s.XXXXXX",
2177 tempdir
.c_str(), Prefix
.c_str());
2178 int const fd
= mkstemp(fn
);
2183 _error
->Errno("GetTempFile",_("Unable to mkstemp %s"), fn
);
2186 if (!Fd
->OpenDescriptor(fd
, FileFd::ReadWrite
, FileFd::None
, true))
2188 _error
->Errno("GetTempFile",_("Unable to write to %s"),fn
);
2194 bool Rename(std::string From
, std::string To
) /*{{{*/
2196 if (rename(From
.c_str(),To
.c_str()) != 0)
2198 _error
->Error(_("rename failed, %s (%s -> %s)."),strerror(errno
),
2199 From
.c_str(),To
.c_str());
2205 bool Popen(const char* Args
[], FileFd
&Fd
, pid_t
&Child
, FileFd::OpenMode Mode
)/*{{{*/
2208 if (Mode
!= FileFd::ReadOnly
&& Mode
!= FileFd::WriteOnly
)
2209 return _error
->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2211 int Pipe
[2] = {-1, -1};
2213 return _error
->Errno("pipe", _("Failed to create subprocess IPC"));
2215 std::set
<int> keep_fds
;
2216 keep_fds
.insert(Pipe
[0]);
2217 keep_fds
.insert(Pipe
[1]);
2218 Child
= ExecFork(keep_fds
);
2220 return _error
->Errno("fork", "Failed to fork");
2223 if(Mode
== FileFd::ReadOnly
)
2228 else if(Mode
== FileFd::WriteOnly
)
2234 if(Mode
== FileFd::ReadOnly
)
2238 } else if(Mode
== FileFd::WriteOnly
)
2241 execv(Args
[0], (char**)Args
);
2244 if(Mode
== FileFd::ReadOnly
)
2249 else if(Mode
== FileFd::WriteOnly
)
2255 return _error
->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2256 Fd
.OpenDescriptor(fd
, Mode
, FileFd::None
, true);
2261 bool DropPrivileges() /*{{{*/
2263 if(_config
->FindB("Debug::NoDropPrivs", false) == true)
2267 #if defined(PR_SET_NO_NEW_PRIVS) && ( PR_SET_NO_NEW_PRIVS != 38 )
2268 #error "PR_SET_NO_NEW_PRIVS is defined, but with a different value than expected!"
2270 // see prctl(2), needs linux3.5 at runtime - magic constant to avoid it at buildtime
2271 int ret
= prctl(38, 1, 0, 0, 0);
2272 // ignore EINVAL - kernel is too old to understand the option
2273 if(ret
< 0 && errno
!= EINVAL
)
2274 _error
->Warning("PR_SET_NO_NEW_PRIVS failed with %i", ret
);
2277 // empty setting disables privilege dropping - this also ensures
2278 // backward compatibility, see bug #764506
2279 const std::string toUser
= _config
->Find("APT::Sandbox::User");
2280 if (toUser
.empty() || toUser
== "root")
2283 // a lot can go wrong trying to drop privileges completely,
2284 // so ideally we would like to verify that we have done it –
2285 // but the verify asks for too much in case of fakeroot (and alike)
2286 // [Specific checks can be overridden with dedicated options]
2287 bool const VerifySandboxing
= _config
->FindB("APT::Sandbox::Verify", false);
2289 // uid will be 0 in the end, but gid might be different anyway
2290 uid_t
const old_uid
= getuid();
2291 gid_t
const old_gid
= getgid();
2296 struct passwd
*pw
= getpwnam(toUser
.c_str());
2298 return _error
->Error("No user %s, can not drop rights", toUser
.c_str());
2300 // Do not change the order here, it might break things
2301 // Get rid of all our supplementary groups first
2302 if (setgroups(1, &pw
->pw_gid
))
2303 return _error
->Errno("setgroups", "Failed to setgroups");
2305 // Now change the group ids to the new user
2306 #ifdef HAVE_SETRESGID
2307 if (setresgid(pw
->pw_gid
, pw
->pw_gid
, pw
->pw_gid
) != 0)
2308 return _error
->Errno("setresgid", "Failed to set new group ids");
2310 if (setegid(pw
->pw_gid
) != 0)
2311 return _error
->Errno("setegid", "Failed to setegid");
2313 if (setgid(pw
->pw_gid
) != 0)
2314 return _error
->Errno("setgid", "Failed to setgid");
2317 // Change the user ids to the new user
2318 #ifdef HAVE_SETRESUID
2319 if (setresuid(pw
->pw_uid
, pw
->pw_uid
, pw
->pw_uid
) != 0)
2320 return _error
->Errno("setresuid", "Failed to set new user ids");
2322 if (setuid(pw
->pw_uid
) != 0)
2323 return _error
->Errno("setuid", "Failed to setuid");
2324 if (seteuid(pw
->pw_uid
) != 0)
2325 return _error
->Errno("seteuid", "Failed to seteuid");
2328 // disabled by default as fakeroot doesn't implement getgroups currently (#806521)
2329 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::Groups", false) == true)
2331 // Verify that the user isn't still in any supplementary groups
2332 long const ngroups_max
= sysconf(_SC_NGROUPS_MAX
);
2333 std::unique_ptr
<gid_t
[]> gidlist(new gid_t
[ngroups_max
]);
2334 if (unlikely(gidlist
== NULL
))
2335 return _error
->Error("Allocation of a list of size %lu for getgroups failed", ngroups_max
);
2337 if ((gidlist_nr
= getgroups(ngroups_max
, gidlist
.get())) < 0)
2338 return _error
->Errno("getgroups", "Could not get new groups (%lu)", ngroups_max
);
2339 for (ssize_t i
= 0; i
< gidlist_nr
; ++i
)
2340 if (gidlist
[i
] != pw
->pw_gid
)
2341 return _error
->Error("Could not switch group, user %s is still in group %d", toUser
.c_str(), gidlist
[i
]);
2344 // enabled by default as all fakeroot-lookalikes should fake that accordingly
2345 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::IDs", true) == true)
2347 // Verify that gid, egid, uid, and euid changed
2348 if (getgid() != pw
->pw_gid
)
2349 return _error
->Error("Could not switch group");
2350 if (getegid() != pw
->pw_gid
)
2351 return _error
->Error("Could not switch effective group");
2352 if (getuid() != pw
->pw_uid
)
2353 return _error
->Error("Could not switch user");
2354 if (geteuid() != pw
->pw_uid
)
2355 return _error
->Error("Could not switch effective user");
2357 #ifdef HAVE_GETRESUID
2358 // verify that the saved set-user-id was changed as well
2362 if (getresuid(&ruid
, &euid
, &suid
))
2363 return _error
->Errno("getresuid", "Could not get saved set-user-ID");
2364 if (suid
!= pw
->pw_uid
)
2365 return _error
->Error("Could not switch saved set-user-ID");
2368 #ifdef HAVE_GETRESGID
2369 // verify that the saved set-group-id was changed as well
2373 if (getresgid(&rgid
, &egid
, &sgid
))
2374 return _error
->Errno("getresuid", "Could not get saved set-group-ID");
2375 if (sgid
!= pw
->pw_gid
)
2376 return _error
->Error("Could not switch saved set-group-ID");
2380 // disabled as fakeroot doesn't forbid (by design) (re)gaining root from unprivileged
2381 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::Regain", false) == true)
2383 // Check that uid and gid changes do not work anymore
2384 if (pw
->pw_gid
!= old_gid
&& (setgid(old_gid
) != -1 || setegid(old_gid
) != -1))
2385 return _error
->Error("Could restore a gid to root, privilege dropping did not work");
2387 if (pw
->pw_uid
!= old_uid
&& (setuid(old_uid
) != -1 || seteuid(old_uid
) != -1))
2388 return _error
->Error("Could restore a uid to root, privilege dropping did not work");