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 struct APT_HIDDEN simple_buffer
{ /*{{{*/
923 static constexpr size_t buffersize_max
= 4096;
924 unsigned long long bufferstart
= 0;
925 unsigned long long bufferend
= 0;
926 char buffer
[buffersize_max
];
928 const char *get() const { return buffer
+ bufferstart
; }
929 char *get() { return buffer
+ bufferstart
; }
930 bool empty() const { return bufferend
<= bufferstart
; }
931 bool full() const { return bufferend
== buffersize_max
; }
932 unsigned long long size() const { return bufferend
-bufferstart
; }
933 void reset() { bufferend
= bufferstart
= 0; }
934 ssize_t
read(void *to
, unsigned long long requested_size
) APT_MUSTCHECK
936 if (size() < requested_size
)
937 requested_size
= size();
938 memcpy(to
, buffer
+ bufferstart
, requested_size
);
939 bufferstart
+= requested_size
;
940 if (bufferstart
== bufferend
)
941 bufferstart
= bufferend
= 0;
942 return requested_size
;
944 ssize_t
write(const void *from
, unsigned long long requested_size
) APT_MUSTCHECK
946 if (buffersize_max
- size() < requested_size
)
947 requested_size
= buffersize_max
- size();
948 memcpy(buffer
+ bufferend
, from
, requested_size
);
949 bufferend
+= requested_size
;
950 if (bufferstart
== bufferend
)
951 bufferstart
= bufferend
= 0;
952 return requested_size
;
957 class APT_HIDDEN FileFdPrivate
{ /*{{{*/
958 friend class BufferedWriteFileFdPrivate
;
960 FileFd
* const filefd
;
961 simple_buffer buffer
;
963 pid_t compressor_pid
;
965 APT::Configuration::Compressor compressor
;
966 unsigned int openmode
;
967 unsigned long long seekpos
;
970 explicit FileFdPrivate(FileFd
* const pfilefd
) : filefd(pfilefd
),
971 compressed_fd(-1), compressor_pid(-1), is_pipe(false),
972 openmode(0), seekpos(0) {};
973 virtual APT::Configuration::Compressor
get_compressor() const
977 virtual void set_compressor(APT::Configuration::Compressor
const &compressor
)
979 this->compressor
= compressor
;
981 virtual unsigned int get_openmode() const
985 virtual void set_openmode(unsigned int openmode
)
987 this->openmode
= openmode
;
989 virtual bool get_is_pipe() const
993 virtual void set_is_pipe(bool is_pipe
)
995 this->is_pipe
= is_pipe
;
997 virtual unsigned long long get_seekpos() const
1001 virtual void set_seekpos(unsigned long long seekpos
)
1003 this->seekpos
= seekpos
;
1006 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) = 0;
1007 ssize_t
InternalRead(void * To
, unsigned long long Size
)
1009 // Drain the buffer if needed.
1010 if (buffer
.empty() == false)
1012 return buffer
.read(To
, Size
);
1014 return InternalUnbufferedRead(To
, Size
);
1016 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) = 0;
1017 virtual bool InternalReadError() { return filefd
->FileFdErrno("read",_("Read error")); }
1018 virtual char * InternalReadLine(char * To
, unsigned long long Size
)
1020 if (unlikely(Size
== 0))
1022 // Read one byte less than buffer size to have space for trailing 0.
1025 char * const InitialTo
= To
;
1028 if (buffer
.empty() == true)
1031 unsigned long long actualread
= 0;
1032 if (filefd
->Read(buffer
.get(), buffer
.buffersize_max
, &actualread
) == false)
1034 buffer
.bufferend
= actualread
;
1035 if (buffer
.size() == 0)
1037 if (To
== InitialTo
)
1041 filefd
->Flags
&= ~FileFd::HitEof
;
1044 unsigned long long const OutputSize
= std::min(Size
, buffer
.size());
1045 char const * const newline
= static_cast<char const * const>(memchr(buffer
.get(), '\n', OutputSize
));
1046 // Read until end of line or up to Size bytes from the buffer.
1047 unsigned long long actualread
= buffer
.read(To
,
1048 (newline
!= nullptr)
1049 ? (newline
- buffer
.get()) + 1
1053 if (newline
!= nullptr)
1059 virtual bool InternalFlush()
1063 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) = 0;
1064 virtual bool InternalWriteError() { return filefd
->FileFdErrno("write",_("Write error")); }
1065 virtual bool InternalSeek(unsigned long long const To
)
1067 // Our poor man seeking is costly, so try to avoid it
1068 unsigned long long const iseekpos
= filefd
->Tell();
1071 else if (iseekpos
< To
)
1072 return filefd
->Skip(To
- iseekpos
);
1074 if ((openmode
& FileFd::ReadOnly
) != FileFd::ReadOnly
)
1075 return filefd
->FileFdError("Reopen is only implemented for read-only files!");
1076 InternalClose(filefd
->FileName
);
1077 if (filefd
->iFd
!= -1)
1080 if (filefd
->TemporaryFileName
.empty() == false)
1081 filefd
->iFd
= open(filefd
->TemporaryFileName
.c_str(), O_RDONLY
);
1082 else if (filefd
->FileName
.empty() == false)
1083 filefd
->iFd
= open(filefd
->FileName
.c_str(), O_RDONLY
);
1086 if (compressed_fd
> 0)
1087 if (lseek(compressed_fd
, 0, SEEK_SET
) != 0)
1088 filefd
->iFd
= compressed_fd
;
1089 if (filefd
->iFd
< 0)
1090 return filefd
->FileFdError("Reopen is not implemented for pipes opened with FileFd::OpenDescriptor()!");
1093 if (filefd
->OpenInternDescriptor(openmode
, compressor
) == false)
1094 return filefd
->FileFdError("Seek on file %s because it couldn't be reopened", filefd
->FileName
.c_str());
1098 return filefd
->Skip(To
);
1103 virtual bool InternalSkip(unsigned long long Over
)
1105 unsigned long long constexpr buffersize
= 1024;
1106 char buffer
[buffersize
];
1109 unsigned long long toread
= std::min(buffersize
, Over
);
1110 if (filefd
->Read(buffer
, toread
) == false)
1111 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
1116 virtual bool InternalTruncate(unsigned long long const)
1118 return filefd
->FileFdError("Truncating compressed files is not implemented (%s)", filefd
->FileName
.c_str());
1120 virtual unsigned long long InternalTell()
1122 // In theory, we could just return seekpos here always instead of
1123 // seeking around, but not all users of FileFd use always Seek() and co
1124 // so d->seekpos isn't always true and we can just use it as a hint if
1125 // we have nothing else, but not always as an authority…
1126 return seekpos
- buffer
.size();
1128 virtual unsigned long long InternalSize()
1130 unsigned long long size
= 0;
1131 unsigned long long const oldSeek
= filefd
->Tell();
1132 unsigned long long constexpr ignoresize
= 1024;
1133 char ignore
[ignoresize
];
1134 unsigned long long read
= 0;
1136 if (filefd
->Read(ignore
, ignoresize
, &read
) == false)
1138 filefd
->Seek(oldSeek
);
1142 size
= filefd
->Tell();
1143 filefd
->Seek(oldSeek
);
1146 virtual bool InternalClose(std::string
const &FileName
) = 0;
1147 virtual bool InternalStream() const { return false; }
1148 virtual bool InternalAlwaysAutoClose() const { return true; }
1150 virtual ~FileFdPrivate() {}
1153 class APT_HIDDEN BufferedWriteFileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1155 FileFdPrivate
*wrapped
;
1156 simple_buffer writebuffer
;
1160 explicit BufferedWriteFileFdPrivate(FileFdPrivate
*Priv
) :
1161 FileFdPrivate(Priv
->filefd
), wrapped(Priv
) {};
1163 virtual APT::Configuration::Compressor
get_compressor() const override
1165 return wrapped
->get_compressor();
1167 virtual void set_compressor(APT::Configuration::Compressor
const &compressor
) override
1169 return wrapped
->set_compressor(compressor
);
1171 virtual unsigned int get_openmode() const override
1173 return wrapped
->get_openmode();
1175 virtual void set_openmode(unsigned int openmode
) override
1177 return wrapped
->set_openmode(openmode
);
1179 virtual bool get_is_pipe() const override
1181 return wrapped
->get_is_pipe();
1183 virtual void set_is_pipe(bool is_pipe
) override
1185 FileFdPrivate::set_is_pipe(is_pipe
);
1186 wrapped
->set_is_pipe(is_pipe
);
1188 virtual unsigned long long get_seekpos() const override
1190 return wrapped
->get_seekpos();
1192 virtual void set_seekpos(unsigned long long seekpos
) override
1194 return wrapped
->set_seekpos(seekpos
);
1196 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1198 if (InternalFlush() == false)
1200 return wrapped
->InternalOpen(iFd
, Mode
);
1202 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1204 if (InternalFlush() == false)
1206 return wrapped
->InternalUnbufferedRead(To
, Size
);
1209 virtual bool InternalReadError() override
1211 return wrapped
->InternalReadError();
1213 virtual char * InternalReadLine(char * To
, unsigned long long Size
) override
1215 if (InternalFlush() == false)
1217 return wrapped
->InternalReadLine(To
, Size
);
1219 virtual bool InternalFlush() override
1222 char *data
= writebuffer
.get();
1223 auto size
= writebuffer
.size();
1225 while (written
< size
) {
1226 auto written_this_time
= wrapped
->InternalWrite(data
+ written
, size
- written
);
1227 if (written_this_time
< 0)
1230 written
+= written_this_time
;
1233 writebuffer
.reset();
1236 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1240 while (written
< Size
) {
1241 auto buffered
= writebuffer
.write(static_cast<char const*>(From
) + written
, Size
- written
);
1243 written
+= buffered
;
1245 if (writebuffer
.full() && InternalFlush() == false)
1251 virtual bool InternalWriteError()
1253 return wrapped
->InternalWriteError();
1255 virtual bool InternalSeek(unsigned long long const To
)
1257 if (InternalFlush() == false)
1259 return wrapped
->InternalSeek(To
);
1261 virtual bool InternalSkip(unsigned long long Over
)
1263 if (InternalFlush() == false)
1265 return wrapped
->InternalSkip(Over
);
1267 virtual bool InternalTruncate(unsigned long long const Size
)
1269 if (InternalFlush() == false)
1271 return wrapped
->InternalTruncate(Size
);
1273 virtual unsigned long long InternalTell()
1275 if (InternalFlush() == false)
1277 return wrapped
->InternalTell();
1279 virtual unsigned long long InternalSize()
1281 if (InternalFlush() == false)
1283 return wrapped
->InternalSize();
1285 virtual bool InternalClose(std::string
const &FileName
)
1287 return wrapped
->InternalClose(FileName
);
1289 virtual bool InternalAlwaysAutoClose() const
1291 return wrapped
->InternalAlwaysAutoClose();
1293 virtual ~BufferedWriteFileFdPrivate()
1299 class APT_HIDDEN GzipFileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1303 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1305 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1306 gz
= gzdopen(iFd
, "r+");
1307 else if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1308 gz
= gzdopen(iFd
, "w");
1310 gz
= gzdopen(iFd
, "r");
1311 filefd
->Flags
|= FileFd::Compressed
;
1312 return gz
!= nullptr;
1314 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1316 return gzread(gz
, To
, Size
);
1318 virtual bool InternalReadError() override
1321 char const * const errmsg
= gzerror(gz
, &err
);
1323 return filefd
->FileFdError("gzread: %s (%d: %s)", _("Read error"), err
, errmsg
);
1324 return FileFdPrivate::InternalReadError();
1326 virtual char * InternalReadLine(char * To
, unsigned long long Size
) override
1328 return gzgets(gz
, To
, Size
);
1330 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1332 return gzwrite(gz
,From
,Size
);
1334 virtual bool InternalWriteError() override
1337 char const * const errmsg
= gzerror(gz
, &err
);
1339 return filefd
->FileFdError("gzwrite: %s (%d: %s)", _("Write error"), err
, errmsg
);
1340 return FileFdPrivate::InternalWriteError();
1342 virtual bool InternalSeek(unsigned long long const To
) override
1344 off_t
const res
= gzseek(gz
, To
, SEEK_SET
);
1345 if (res
!= (off_t
)To
)
1346 return filefd
->FileFdError("Unable to seek to %llu", To
);
1351 virtual bool InternalSkip(unsigned long long Over
) override
1353 if (Over
>= buffer
.size())
1355 Over
-= buffer
.size();
1360 buffer
.bufferstart
+= Over
;
1365 off_t
const res
= gzseek(gz
, Over
, SEEK_CUR
);
1367 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
1371 virtual unsigned long long InternalTell() override
1373 return gztell(gz
) - buffer
.size();
1375 virtual unsigned long long InternalSize() override
1377 unsigned long long filesize
= FileFdPrivate::InternalSize();
1378 // only check gzsize if we are actually a gzip file, just checking for
1379 // "gz" is not sufficient as uncompressed files could be opened with
1380 // gzopen in "direct" mode as well
1381 if (filesize
== 0 || gzdirect(gz
))
1384 off_t
const oldPos
= lseek(filefd
->iFd
, 0, SEEK_CUR
);
1385 /* unfortunately zlib.h doesn't provide a gzsize(), so we have to do
1386 * this ourselves; the original (uncompressed) file size is the last 32
1387 * bits of the file */
1388 // FIXME: Size for gz-files is limited by 32bit… no largefile support
1389 if (lseek(filefd
->iFd
, -4, SEEK_END
) < 0)
1391 filefd
->FileFdErrno("lseek","Unable to seek to end of gzipped file");
1395 if (read(filefd
->iFd
, &size
, 4) != 4)
1397 filefd
->FileFdErrno("read","Unable to read original size of gzipped file");
1400 size
= le32toh(size
);
1402 if (lseek(filefd
->iFd
, oldPos
, SEEK_SET
) < 0)
1404 filefd
->FileFdErrno("lseek","Unable to seek in gzipped file");
1409 virtual bool InternalClose(std::string
const &FileName
) override
1413 int const e
= gzclose(gz
);
1415 // gzdclose() on empty files always fails with "buffer error" here, ignore that
1416 if (e
!= 0 && e
!= Z_BUF_ERROR
)
1417 return _error
->Errno("close",_("Problem closing the gzip file %s"), FileName
.c_str());
1421 explicit GzipFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), gz(nullptr) {}
1422 virtual ~GzipFileFdPrivate() { InternalClose(""); }
1426 class APT_HIDDEN Bz2FileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1430 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1432 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1433 bz2
= BZ2_bzdopen(iFd
, "r+");
1434 else if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1435 bz2
= BZ2_bzdopen(iFd
, "w");
1437 bz2
= BZ2_bzdopen(iFd
, "r");
1438 filefd
->Flags
|= FileFd::Compressed
;
1439 return bz2
!= nullptr;
1441 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1443 return BZ2_bzread(bz2
, To
, Size
);
1445 virtual bool InternalReadError() override
1448 char const * const errmsg
= BZ2_bzerror(bz2
, &err
);
1449 if (err
!= BZ_IO_ERROR
)
1450 return filefd
->FileFdError("BZ2_bzread: %s %s (%d: %s)", filefd
->FileName
.c_str(), _("Read error"), err
, errmsg
);
1451 return FileFdPrivate::InternalReadError();
1453 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1455 return BZ2_bzwrite(bz2
, (void*)From
, Size
);
1457 virtual bool InternalWriteError() override
1460 char const * const errmsg
= BZ2_bzerror(bz2
, &err
);
1461 if (err
!= BZ_IO_ERROR
)
1462 return filefd
->FileFdError("BZ2_bzwrite: %s %s (%d: %s)", filefd
->FileName
.c_str(), _("Write error"), err
, errmsg
);
1463 return FileFdPrivate::InternalWriteError();
1465 virtual bool InternalStream() const override
{ return true; }
1466 virtual bool InternalClose(std::string
const &) override
1475 explicit Bz2FileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), bz2(nullptr) {}
1476 virtual ~Bz2FileFdPrivate() { InternalClose(""); }
1480 class APT_HIDDEN LzmaFileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1484 uint8_t buffer
[4096];
1490 LZMAFILE() : file(nullptr), eof(false), compressing(false) { buffer
[0] = '\0'; }
1493 if (compressing
== true)
1495 size_t constexpr buffersize
= sizeof(buffer
)/sizeof(buffer
[0]);
1498 stream
.avail_out
= buffersize
;
1499 stream
.next_out
= buffer
;
1500 err
= lzma_code(&stream
, LZMA_FINISH
);
1501 if (err
!= LZMA_OK
&& err
!= LZMA_STREAM_END
)
1503 _error
->Error("~LZMAFILE: Compress finalisation failed");
1506 size_t const n
= buffersize
- stream
.avail_out
;
1507 if (n
&& fwrite(buffer
, 1, n
, file
) != n
)
1509 _error
->Errno("~LZMAFILE",_("Write error"));
1512 if (err
== LZMA_STREAM_END
)
1521 static uint32_t findXZlevel(std::vector
<std::string
> const &Args
)
1523 for (auto a
= Args
.rbegin(); a
!= Args
.rend(); ++a
)
1524 if (a
->empty() == false && (*a
)[0] == '-' && (*a
)[1] != '-')
1526 auto const number
= a
->find_last_of("0123456789");
1527 if (number
== std::string::npos
)
1529 auto const extreme
= a
->find("e", number
);
1530 uint32_t level
= (extreme
!= std::string::npos
) ? LZMA_PRESET_EXTREME
: 0;
1531 switch ((*a
)[number
])
1533 case '0': return level
| 0;
1534 case '1': return level
| 1;
1535 case '2': return level
| 2;
1536 case '3': return level
| 3;
1537 case '4': return level
| 4;
1538 case '5': return level
| 5;
1539 case '6': return level
| 6;
1540 case '7': return level
| 7;
1541 case '8': return level
| 8;
1542 case '9': return level
| 9;
1548 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1550 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1551 return filefd
->FileFdError("ReadWrite mode is not supported for lzma/xz files %s", filefd
->FileName
.c_str());
1553 if (lzma
== nullptr)
1554 lzma
= new LzmaFileFdPrivate::LZMAFILE
;
1555 if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1556 lzma
->file
= fdopen(iFd
, "w");
1558 lzma
->file
= fdopen(iFd
, "r");
1559 filefd
->Flags
|= FileFd::Compressed
;
1560 if (lzma
->file
== nullptr)
1563 lzma_stream tmp_stream
= LZMA_STREAM_INIT
;
1564 lzma
->stream
= tmp_stream
;
1566 if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1568 uint32_t const xzlevel
= findXZlevel(compressor
.CompressArgs
);
1569 if (compressor
.Name
== "xz")
1571 if (lzma_easy_encoder(&lzma
->stream
, xzlevel
, LZMA_CHECK_CRC64
) != LZMA_OK
)
1576 lzma_options_lzma options
;
1577 lzma_lzma_preset(&options
, xzlevel
);
1578 if (lzma_alone_encoder(&lzma
->stream
, &options
) != LZMA_OK
)
1581 lzma
->compressing
= true;
1585 uint64_t const memlimit
= UINT64_MAX
;
1586 if (compressor
.Name
== "xz")
1588 if (lzma_auto_decoder(&lzma
->stream
, memlimit
, 0) != LZMA_OK
)
1593 if (lzma_alone_decoder(&lzma
->stream
, memlimit
) != LZMA_OK
)
1596 lzma
->compressing
= false;
1600 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1603 if (lzma
->eof
== true)
1606 lzma
->stream
.next_out
= (uint8_t *) To
;
1607 lzma
->stream
.avail_out
= Size
;
1608 if (lzma
->stream
.avail_in
== 0)
1610 lzma
->stream
.next_in
= lzma
->buffer
;
1611 lzma
->stream
.avail_in
= fread(lzma
->buffer
, 1, sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]), lzma
->file
);
1613 lzma
->err
= lzma_code(&lzma
->stream
, LZMA_RUN
);
1614 if (lzma
->err
== LZMA_STREAM_END
)
1617 Res
= Size
- lzma
->stream
.avail_out
;
1619 else if (lzma
->err
!= LZMA_OK
)
1626 Res
= Size
- lzma
->stream
.avail_out
;
1629 // lzma run was okay, but produced no output…
1636 virtual bool InternalReadError() override
1638 return filefd
->FileFdError("lzma_read: %s (%d)", _("Read error"), lzma
->err
);
1640 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1642 lzma
->stream
.next_in
= (uint8_t *)From
;
1643 lzma
->stream
.avail_in
= Size
;
1644 lzma
->stream
.next_out
= lzma
->buffer
;
1645 lzma
->stream
.avail_out
= sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]);
1646 lzma
->err
= lzma_code(&lzma
->stream
, LZMA_RUN
);
1647 if (lzma
->err
!= LZMA_OK
)
1649 size_t const n
= sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]) - lzma
->stream
.avail_out
;
1650 size_t const m
= (n
== 0) ? 0 : fwrite(lzma
->buffer
, 1, n
, lzma
->file
);
1654 return Size
- lzma
->stream
.avail_in
;
1656 virtual bool InternalWriteError() override
1658 return filefd
->FileFdError("lzma_write: %s (%d)", _("Write error"), lzma
->err
);
1660 virtual bool InternalStream() const override
{ return true; }
1661 virtual bool InternalClose(std::string
const &) override
1668 explicit LzmaFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), lzma(nullptr) {}
1669 virtual ~LzmaFileFdPrivate() { InternalClose(""); }
1673 class APT_HIDDEN PipedFileFdPrivate
: public FileFdPrivate
/*{{{*/
1674 /* if we don't have a specific class dealing with library calls, we (un)compress
1675 by executing a specified binary and pipe in/out what we need */
1678 virtual bool InternalOpen(int const, unsigned int const Mode
) override
1680 // collect zombies here in case we reopen
1681 if (compressor_pid
> 0)
1682 ExecWait(compressor_pid
, "FileFdCompressor", true);
1684 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1685 return filefd
->FileFdError("ReadWrite mode is not supported for file %s", filefd
->FileName
.c_str());
1687 bool const Comp
= (Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
;
1690 // Handle 'decompression' of empty files
1692 fstat(filefd
->iFd
, &Buf
);
1693 if (Buf
.st_size
== 0 && S_ISFIFO(Buf
.st_mode
) == false)
1696 // We don't need the file open - instead let the compressor open it
1697 // as he properly knows better how to efficiently read from 'his' file
1698 if (filefd
->FileName
.empty() == false)
1705 // Create a data pipe
1706 int Pipe
[2] = {-1,-1};
1707 if (pipe(Pipe
) != 0)
1708 return filefd
->FileFdErrno("pipe",_("Failed to create subprocess IPC"));
1709 for (int J
= 0; J
!= 2; J
++)
1710 SetCloseExec(Pipe
[J
],true);
1712 compressed_fd
= filefd
->iFd
;
1716 filefd
->iFd
= Pipe
[1];
1718 filefd
->iFd
= Pipe
[0];
1721 compressor_pid
= ExecFork();
1722 if (compressor_pid
== 0)
1726 dup2(compressed_fd
,STDOUT_FILENO
);
1727 dup2(Pipe
[0],STDIN_FILENO
);
1731 if (compressed_fd
!= -1)
1732 dup2(compressed_fd
,STDIN_FILENO
);
1733 dup2(Pipe
[1],STDOUT_FILENO
);
1735 int const nullfd
= open("/dev/null", O_WRONLY
);
1738 dup2(nullfd
,STDERR_FILENO
);
1742 SetCloseExec(STDOUT_FILENO
,false);
1743 SetCloseExec(STDIN_FILENO
,false);
1745 std::vector
<char const*> Args
;
1746 Args
.push_back(compressor
.Binary
.c_str());
1747 std::vector
<std::string
> const * const addArgs
=
1748 (Comp
== true) ? &(compressor
.CompressArgs
) : &(compressor
.UncompressArgs
);
1749 for (std::vector
<std::string
>::const_iterator a
= addArgs
->begin();
1750 a
!= addArgs
->end(); ++a
)
1751 Args
.push_back(a
->c_str());
1752 if (Comp
== false && filefd
->FileName
.empty() == false)
1754 // commands not needing arguments, do not need to be told about using standard output
1755 // in reality, only testcases with tools like cat, rev, rot13, … are able to trigger this
1756 if (compressor
.CompressArgs
.empty() == false && compressor
.UncompressArgs
.empty() == false)
1757 Args
.push_back("--stdout");
1758 if (filefd
->TemporaryFileName
.empty() == false)
1759 Args
.push_back(filefd
->TemporaryFileName
.c_str());
1761 Args
.push_back(filefd
->FileName
.c_str());
1763 Args
.push_back(NULL
);
1765 execvp(Args
[0],(char **)&Args
[0]);
1766 cerr
<< _("Failed to exec compressor ") << Args
[0] << endl
;
1776 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1778 return read(filefd
->iFd
, To
, Size
);
1780 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1782 return write(filefd
->iFd
, From
, Size
);
1784 virtual bool InternalClose(std::string
const &) override
1787 if (compressor_pid
> 0)
1788 Ret
&= ExecWait(compressor_pid
, "FileFdCompressor", true);
1789 compressor_pid
= -1;
1792 explicit PipedFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
) {}
1793 virtual ~PipedFileFdPrivate() { InternalClose(""); }
1796 class APT_HIDDEN DirectFileFdPrivate
: public FileFdPrivate
/*{{{*/
1799 virtual bool InternalOpen(int const, unsigned int const) override
{ return true; }
1800 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1802 return read(filefd
->iFd
, To
, Size
);
1804 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1806 // files opened read+write are strange and only really "supported" for direct files
1807 if (buffer
.size() != 0)
1809 lseek(filefd
->iFd
, -buffer
.size(), SEEK_CUR
);
1812 return write(filefd
->iFd
, From
, Size
);
1814 virtual bool InternalSeek(unsigned long long const To
) override
1816 off_t
const res
= lseek(filefd
->iFd
, To
, SEEK_SET
);
1817 if (res
!= (off_t
)To
)
1818 return filefd
->FileFdError("Unable to seek to %llu", To
);
1823 virtual bool InternalSkip(unsigned long long Over
) override
1825 if (Over
>= buffer
.size())
1827 Over
-= buffer
.size();
1832 buffer
.bufferstart
+= Over
;
1837 off_t
const res
= lseek(filefd
->iFd
, Over
, SEEK_CUR
);
1839 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
1843 virtual bool InternalTruncate(unsigned long long const To
) override
1845 if (buffer
.size() != 0)
1847 unsigned long long const seekpos
= lseek(filefd
->iFd
, 0, SEEK_CUR
);
1848 if ((seekpos
- buffer
.size()) >= To
)
1850 else if (seekpos
>= To
)
1851 buffer
.bufferend
= (To
- seekpos
) + buffer
.bufferstart
;
1855 if (ftruncate(filefd
->iFd
, To
) != 0)
1856 return filefd
->FileFdError("Unable to truncate to %llu",To
);
1859 virtual unsigned long long InternalTell() override
1861 return lseek(filefd
->iFd
,0,SEEK_CUR
) - buffer
.size();
1863 virtual unsigned long long InternalSize() override
1865 return filefd
->FileSize();
1867 virtual bool InternalClose(std::string
const &) override
{ return true; }
1868 virtual bool InternalAlwaysAutoClose() const override
{ return false; }
1870 explicit DirectFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
) {}
1871 virtual ~DirectFileFdPrivate() { InternalClose(""); }
1874 // FileFd Constructors /*{{{*/
1875 FileFd::FileFd(std::string FileName
,unsigned int const Mode
,unsigned long AccessMode
) : iFd(-1), Flags(0), d(NULL
)
1877 Open(FileName
,Mode
, None
, AccessMode
);
1879 FileFd::FileFd(std::string FileName
,unsigned int const Mode
, CompressMode Compress
, unsigned long AccessMode
) : iFd(-1), Flags(0), d(NULL
)
1881 Open(FileName
,Mode
, Compress
, AccessMode
);
1883 FileFd::FileFd() : iFd(-1), Flags(AutoClose
), d(NULL
) {}
1884 FileFd::FileFd(int const Fd
, unsigned int const Mode
, CompressMode Compress
) : iFd(-1), Flags(0), d(NULL
)
1886 OpenDescriptor(Fd
, Mode
, Compress
);
1888 FileFd::FileFd(int const Fd
, bool const AutoClose
) : iFd(-1), Flags(0), d(NULL
)
1890 OpenDescriptor(Fd
, ReadWrite
, None
, AutoClose
);
1893 // FileFd::Open - Open a file /*{{{*/
1894 // ---------------------------------------------------------------------
1895 /* The most commonly used open mode combinations are given with Mode */
1896 bool FileFd::Open(string FileName
,unsigned int const Mode
,CompressMode Compress
, unsigned long const AccessMode
)
1898 if (Mode
== ReadOnlyGzip
)
1899 return Open(FileName
, ReadOnly
, Gzip
, AccessMode
);
1901 if (Compress
== Auto
&& (Mode
& WriteOnly
) == WriteOnly
)
1902 return FileFdError("Autodetection on %s only works in ReadOnly openmode!", FileName
.c_str());
1904 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
1905 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
1906 if (Compress
== Auto
)
1908 for (; compressor
!= compressors
.end(); ++compressor
)
1910 std::string file
= FileName
+ compressor
->Extension
;
1911 if (FileExists(file
) == false)
1917 else if (Compress
== Extension
)
1919 std::string::size_type
const found
= FileName
.find_last_of('.');
1921 if (found
!= std::string::npos
)
1923 ext
= FileName
.substr(found
);
1924 if (ext
== ".new" || ext
== ".bak")
1926 std::string::size_type
const found2
= FileName
.find_last_of('.', found
- 1);
1927 if (found2
!= std::string::npos
)
1928 ext
= FileName
.substr(found2
, found
- found2
);
1933 for (; compressor
!= compressors
.end(); ++compressor
)
1934 if (ext
== compressor
->Extension
)
1936 // no matching extension - assume uncompressed (imagine files like 'example.org_Packages')
1937 if (compressor
== compressors
.end())
1938 for (compressor
= compressors
.begin(); compressor
!= compressors
.end(); ++compressor
)
1939 if (compressor
->Name
== ".")
1947 case None
: name
= "."; break;
1948 case Gzip
: name
= "gzip"; break;
1949 case Bzip2
: name
= "bzip2"; break;
1950 case Lzma
: name
= "lzma"; break;
1951 case Xz
: name
= "xz"; break;
1955 return FileFdError("Opening File %s in None, Auto or Extension should be already handled?!?", FileName
.c_str());
1957 for (; compressor
!= compressors
.end(); ++compressor
)
1958 if (compressor
->Name
== name
)
1960 if (compressor
== compressors
.end())
1961 return FileFdError("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
1964 if (compressor
== compressors
.end())
1965 return FileFdError("Can't find a match for specified compressor mode for file %s", FileName
.c_str());
1966 return Open(FileName
, Mode
, *compressor
, AccessMode
);
1968 bool FileFd::Open(string FileName
,unsigned int const Mode
,APT::Configuration::Compressor
const &compressor
, unsigned long const AccessMode
)
1973 if ((Mode
& WriteOnly
) != WriteOnly
&& (Mode
& (Atomic
| Create
| Empty
| Exclusive
)) != 0)
1974 return FileFdError("ReadOnly mode for %s doesn't accept additional flags!", FileName
.c_str());
1975 if ((Mode
& ReadWrite
) == 0)
1976 return FileFdError("No openmode provided in FileFd::Open for %s", FileName
.c_str());
1978 unsigned int OpenMode
= Mode
;
1979 if (FileName
== "/dev/null")
1980 OpenMode
= OpenMode
& ~(Atomic
| Exclusive
| Create
| Empty
);
1982 if ((OpenMode
& Atomic
) == Atomic
)
1986 else if ((OpenMode
& (Exclusive
| Create
)) == (Exclusive
| Create
))
1988 // for atomic, this will be done by rename in Close()
1989 RemoveFile("FileFd::Open", FileName
);
1991 if ((OpenMode
& Empty
) == Empty
)
1994 if (lstat(FileName
.c_str(),&Buf
) == 0 && S_ISLNK(Buf
.st_mode
))
1995 RemoveFile("FileFd::Open", FileName
);
1999 #define if_FLAGGED_SET(FLAG, MODE) if ((OpenMode & FLAG) == FLAG) fileflags |= MODE
2000 if_FLAGGED_SET(ReadWrite
, O_RDWR
);
2001 else if_FLAGGED_SET(ReadOnly
, O_RDONLY
);
2002 else if_FLAGGED_SET(WriteOnly
, O_WRONLY
);
2004 if_FLAGGED_SET(Create
, O_CREAT
);
2005 if_FLAGGED_SET(Empty
, O_TRUNC
);
2006 if_FLAGGED_SET(Exclusive
, O_EXCL
);
2007 #undef if_FLAGGED_SET
2009 if ((OpenMode
& Atomic
) == Atomic
)
2011 char *name
= strdup((FileName
+ ".XXXXXX").c_str());
2013 if((iFd
= mkstemp(name
)) == -1)
2016 return FileFdErrno("mkstemp", "Could not create temporary file for %s", FileName
.c_str());
2019 TemporaryFileName
= string(name
);
2022 // umask() will always set the umask and return the previous value, so
2023 // we first set the umask and then reset it to the old value
2024 mode_t
const CurrentUmask
= umask(0);
2025 umask(CurrentUmask
);
2026 // calculate the actual file permissions (just like open/creat)
2027 mode_t
const FilePermissions
= (AccessMode
& ~CurrentUmask
);
2029 if(fchmod(iFd
, FilePermissions
) == -1)
2030 return FileFdErrno("fchmod", "Could not change permissions for temporary file %s", TemporaryFileName
.c_str());
2033 iFd
= open(FileName
.c_str(), fileflags
, AccessMode
);
2035 this->FileName
= FileName
;
2036 if (iFd
== -1 || OpenInternDescriptor(OpenMode
, compressor
) == false)
2043 return FileFdErrno("open",_("Could not open file %s"), FileName
.c_str());
2046 SetCloseExec(iFd
,true);
2050 // FileFd::OpenDescriptor - Open a filedescriptor /*{{{*/
2051 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, CompressMode Compress
, bool AutoClose
)
2053 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
2054 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
2057 // compat with the old API
2058 if (Mode
== ReadOnlyGzip
&& Compress
== None
)
2063 case None
: name
= "."; break;
2064 case Gzip
: name
= "gzip"; break;
2065 case Bzip2
: name
= "bzip2"; break;
2066 case Lzma
: name
= "lzma"; break;
2067 case Xz
: name
= "xz"; break;
2070 if (AutoClose
== true && Fd
!= -1)
2072 return FileFdError("Opening Fd %d in Auto or Extension compression mode is not supported", Fd
);
2074 for (; compressor
!= compressors
.end(); ++compressor
)
2075 if (compressor
->Name
== name
)
2077 if (compressor
== compressors
.end())
2079 if (AutoClose
== true && Fd
!= -1)
2081 return FileFdError("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
2083 return OpenDescriptor(Fd
, Mode
, *compressor
, AutoClose
);
2085 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
, bool AutoClose
)
2088 Flags
= (AutoClose
) ? FileFd::AutoClose
: 0;
2090 this->FileName
= "";
2091 if (OpenInternDescriptor(Mode
, compressor
) == false)
2094 (Flags
& Compressed
) == Compressed
||
2100 return FileFdError(_("Could not open file descriptor %d"), Fd
);
2104 bool FileFd::OpenInternDescriptor(unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
)
2110 d
->InternalClose(FileName
);
2115 /* dummy so that the rest can be 'else if's */;
2116 #define APT_COMPRESS_INIT(NAME, CONSTRUCTOR) \
2117 else if (compressor.Name == NAME) \
2118 d = new CONSTRUCTOR(this)
2120 APT_COMPRESS_INIT("gzip", GzipFileFdPrivate
);
2123 APT_COMPRESS_INIT("bzip2", Bz2FileFdPrivate
);
2126 APT_COMPRESS_INIT("xz", LzmaFileFdPrivate
);
2127 APT_COMPRESS_INIT("lzma", LzmaFileFdPrivate
);
2129 #undef APT_COMPRESS_INIT
2130 else if (compressor
.Name
== "." || compressor
.Binary
.empty() == true)
2131 d
= new DirectFileFdPrivate(this);
2133 d
= new PipedFileFdPrivate(this);
2135 if (Mode
& BufferedWrite
)
2136 d
= new BufferedWriteFileFdPrivate(d
);
2138 d
->set_openmode(Mode
);
2139 d
->set_compressor(compressor
);
2140 if ((Flags
& AutoClose
) != AutoClose
&& d
->InternalAlwaysAutoClose())
2142 // Need to duplicate fd here or gz/bz2 close for cleanup will close the fd as well
2143 int const internFd
= dup(iFd
);
2145 return FileFdErrno("OpenInternDescriptor", _("Could not open file descriptor %d"), iFd
);
2149 return d
->InternalOpen(iFd
, Mode
);
2152 // FileFd::~File - Closes the file /*{{{*/
2153 // ---------------------------------------------------------------------
2154 /* If the proper modes are selected then we close the Fd and possibly
2155 unlink the file on error. */
2160 d
->InternalClose(FileName
);
2165 // FileFd::Read - Read a bit of the file /*{{{*/
2166 // ---------------------------------------------------------------------
2167 /* We are careful to handle interruption by a signal while reading
2169 bool FileFd::Read(void *To
,unsigned long long Size
,unsigned long long *Actual
)
2177 *((char *)To
) = '\0';
2178 while (Res
> 0 && Size
> 0)
2180 Res
= d
->InternalRead(To
, Size
);
2186 // trick the while-loop into running again
2191 return d
->InternalReadError();
2194 To
= (char *)To
+ Res
;
2197 d
->set_seekpos(d
->get_seekpos() + Res
);
2212 return FileFdError(_("read, still have %llu to read but none left"), Size
);
2215 // FileFd::ReadLine - Read a complete line from the file /*{{{*/
2216 // ---------------------------------------------------------------------
2217 /* Beware: This method can be quite slow for big buffers on UNcompressed
2218 files because of the naive implementation! */
2219 char* FileFd::ReadLine(char *To
, unsigned long long const Size
)
2224 return d
->InternalReadLine(To
, Size
);
2227 // FileFd::Flush - Flush the file /*{{{*/
2228 bool FileFd::Flush()
2233 return d
->InternalFlush();
2236 // FileFd::Write - Write to the file /*{{{*/
2237 bool FileFd::Write(const void *From
,unsigned long long Size
)
2243 while (Res
> 0 && Size
> 0)
2245 Res
= d
->InternalWrite(From
, Size
);
2246 if (Res
< 0 && errno
== EINTR
)
2249 return d
->InternalWriteError();
2251 From
= (char const *)From
+ Res
;
2254 d
->set_seekpos(d
->get_seekpos() + Res
);
2260 return FileFdError(_("write, still have %llu to write but couldn't"), Size
);
2262 bool FileFd::Write(int Fd
, const void *From
, unsigned long long Size
)
2266 while (Res
> 0 && Size
> 0)
2268 Res
= write(Fd
,From
,Size
);
2269 if (Res
< 0 && errno
== EINTR
)
2272 return _error
->Errno("write",_("Write error"));
2274 From
= (char const *)From
+ Res
;
2281 return _error
->Error(_("write, still have %llu to write but couldn't"), Size
);
2284 // FileFd::Seek - Seek in the file /*{{{*/
2285 bool FileFd::Seek(unsigned long long To
)
2290 return d
->InternalSeek(To
);
2293 // FileFd::Skip - Skip over data in the file /*{{{*/
2294 bool FileFd::Skip(unsigned long long Over
)
2298 return d
->InternalSkip(Over
);
2301 // FileFd::Truncate - Truncate the file /*{{{*/
2302 bool FileFd::Truncate(unsigned long long To
)
2306 // truncating /dev/null is always successful - as we get an error otherwise
2307 if (To
== 0 && FileName
== "/dev/null")
2309 return d
->InternalTruncate(To
);
2312 // FileFd::Tell - Current seek position /*{{{*/
2313 // ---------------------------------------------------------------------
2315 unsigned long long FileFd::Tell()
2319 off_t
const Res
= d
->InternalTell();
2320 if (Res
== (off_t
)-1)
2321 FileFdErrno("lseek","Failed to determine the current file position");
2322 d
->set_seekpos(Res
);
2326 static bool StatFileFd(char const * const msg
, int const iFd
, std::string
const &FileName
, struct stat
&Buf
, FileFdPrivate
* const d
) /*{{{*/
2328 bool ispipe
= (d
!= NULL
&& d
->get_is_pipe() == true);
2329 if (ispipe
== false)
2331 if (fstat(iFd
,&Buf
) != 0)
2332 // higher-level code will generate more meaningful messages,
2333 // even translated this would be meaningless for users
2334 return _error
->Errno("fstat", "Unable to determine %s for fd %i", msg
, iFd
);
2335 if (FileName
.empty() == false)
2336 ispipe
= S_ISFIFO(Buf
.st_mode
);
2339 // for compressor pipes st_size is undefined and at 'best' zero
2342 // we set it here, too, as we get the info here for free
2343 // in theory the Open-methods should take care of it already
2345 d
->set_is_pipe(true);
2346 if (stat(FileName
.c_str(), &Buf
) != 0)
2347 return _error
->Errno("fstat", "Unable to determine %s for file %s", msg
, FileName
.c_str());
2352 // FileFd::FileSize - Return the size of the file /*{{{*/
2353 unsigned long long FileFd::FileSize()
2356 if (StatFileFd("file size", iFd
, FileName
, Buf
, d
) == false)
2364 // FileFd::ModificationTime - Return the time of last touch /*{{{*/
2365 time_t FileFd::ModificationTime()
2368 if (StatFileFd("modification time", iFd
, FileName
, Buf
, d
) == false)
2373 return Buf
.st_mtime
;
2376 // FileFd::Size - Return the size of the content in the file /*{{{*/
2377 unsigned long long FileFd::Size()
2381 return d
->InternalSize();
2384 // FileFd::Close - Close the file if the close flag is set /*{{{*/
2385 // ---------------------------------------------------------------------
2387 bool FileFd::Close()
2389 if (Flush() == false)
2395 if ((Flags
& AutoClose
) == AutoClose
)
2397 if ((Flags
& Compressed
) != Compressed
&& iFd
> 0 && close(iFd
) != 0)
2398 Res
&= _error
->Errno("close",_("Problem closing the file %s"), FileName
.c_str());
2403 Res
&= d
->InternalClose(FileName
);
2408 if ((Flags
& Replace
) == Replace
) {
2409 if (rename(TemporaryFileName
.c_str(), FileName
.c_str()) != 0)
2410 Res
&= _error
->Errno("rename",_("Problem renaming the file %s to %s"), TemporaryFileName
.c_str(), FileName
.c_str());
2412 FileName
= TemporaryFileName
; // for the unlink() below.
2413 TemporaryFileName
.clear();
2418 if ((Flags
& Fail
) == Fail
&& (Flags
& DelOnFail
) == DelOnFail
&&
2419 FileName
.empty() == false)
2420 Res
&= RemoveFile("FileFd::Close", FileName
);
2427 // FileFd::Sync - Sync the file /*{{{*/
2428 // ---------------------------------------------------------------------
2432 if (fsync(iFd
) != 0)
2433 return FileFdErrno("sync",_("Problem syncing the file"));
2437 // FileFd::FileFdErrno - set Fail and call _error->Errno *{{{*/
2438 bool FileFd::FileFdErrno(const char *Function
, const char *Description
,...)
2442 size_t msgSize
= 400;
2443 int const errsv
= errno
;
2446 va_start(args
,Description
);
2447 if (_error
->InsertErrno(GlobalError::ERROR
, Function
, Description
, args
, errsv
, msgSize
) == false)
2454 // FileFd::FileFdError - set Fail and call _error->Error *{{{*/
2455 bool FileFd::FileFdError(const char *Description
,...) {
2458 size_t msgSize
= 400;
2461 va_start(args
,Description
);
2462 if (_error
->Insert(GlobalError::ERROR
, Description
, args
, msgSize
) == false)
2469 gzFile
FileFd::gzFd() { /*{{{*/
2471 GzipFileFdPrivate
* const gzipd
= dynamic_cast<GzipFileFdPrivate
*>(d
);
2472 if (gzipd
== nullptr)
2482 // Glob - wrapper around "glob()" /*{{{*/
2483 std::vector
<std::string
> Glob(std::string
const &pattern
, int flags
)
2485 std::vector
<std::string
> result
;
2490 glob_res
= glob(pattern
.c_str(), flags
, NULL
, &globbuf
);
2494 if(glob_res
!= GLOB_NOMATCH
) {
2495 _error
->Errno("glob", "Problem with glob");
2501 for(i
=0;i
<globbuf
.gl_pathc
;i
++)
2502 result
.push_back(string(globbuf
.gl_pathv
[i
]));
2508 std::string
GetTempDir() /*{{{*/
2510 const char *tmpdir
= getenv("TMPDIR");
2518 if (!tmpdir
|| strlen(tmpdir
) == 0 || // tmpdir is set
2519 stat(tmpdir
, &st
) != 0 || (st
.st_mode
& S_IFDIR
) == 0) // exists and is directory
2521 else if (geteuid() != 0 && // root can do everything anyway
2522 faccessat(-1, tmpdir
, R_OK
| W_OK
| X_OK
, AT_EACCESS
| AT_SYMLINK_NOFOLLOW
) != 0) // current user has rwx access to directory
2525 return string(tmpdir
);
2527 std::string
GetTempDir(std::string
const &User
)
2529 // no need/possibility to drop privs
2530 if(getuid() != 0 || User
.empty() || User
== "root")
2531 return GetTempDir();
2533 struct passwd
const * const pw
= getpwnam(User
.c_str());
2535 return GetTempDir();
2537 gid_t
const old_euid
= geteuid();
2538 gid_t
const old_egid
= getegid();
2539 if (setegid(pw
->pw_gid
) != 0)
2540 _error
->Errno("setegid", "setegid %u failed", pw
->pw_gid
);
2541 if (seteuid(pw
->pw_uid
) != 0)
2542 _error
->Errno("seteuid", "seteuid %u failed", pw
->pw_uid
);
2544 std::string
const tmp
= GetTempDir();
2546 if (seteuid(old_euid
) != 0)
2547 _error
->Errno("seteuid", "seteuid %u failed", old_euid
);
2548 if (setegid(old_egid
) != 0)
2549 _error
->Errno("setegid", "setegid %u failed", old_egid
);
2554 FileFd
* GetTempFile(std::string
const &Prefix
, bool ImmediateUnlink
, FileFd
* const TmpFd
) /*{{{*/
2557 FileFd
* const Fd
= TmpFd
== NULL
? new FileFd() : TmpFd
;
2559 std::string
const tempdir
= GetTempDir();
2560 snprintf(fn
, sizeof(fn
), "%s/%s.XXXXXX",
2561 tempdir
.c_str(), Prefix
.c_str());
2562 int const fd
= mkstemp(fn
);
2567 _error
->Errno("GetTempFile",_("Unable to mkstemp %s"), fn
);
2570 if (!Fd
->OpenDescriptor(fd
, FileFd::ReadWrite
, FileFd::None
, true))
2572 _error
->Errno("GetTempFile",_("Unable to write to %s"),fn
);
2578 bool Rename(std::string From
, std::string To
) /*{{{*/
2580 if (rename(From
.c_str(),To
.c_str()) != 0)
2582 _error
->Error(_("rename failed, %s (%s -> %s)."),strerror(errno
),
2583 From
.c_str(),To
.c_str());
2589 bool Popen(const char* Args
[], FileFd
&Fd
, pid_t
&Child
, FileFd::OpenMode Mode
)/*{{{*/
2592 if (Mode
!= FileFd::ReadOnly
&& Mode
!= FileFd::WriteOnly
)
2593 return _error
->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2595 int Pipe
[2] = {-1, -1};
2597 return _error
->Errno("pipe", _("Failed to create subprocess IPC"));
2599 std::set
<int> keep_fds
;
2600 keep_fds
.insert(Pipe
[0]);
2601 keep_fds
.insert(Pipe
[1]);
2602 Child
= ExecFork(keep_fds
);
2604 return _error
->Errno("fork", "Failed to fork");
2607 if(Mode
== FileFd::ReadOnly
)
2612 else if(Mode
== FileFd::WriteOnly
)
2618 if(Mode
== FileFd::ReadOnly
)
2622 } else if(Mode
== FileFd::WriteOnly
)
2625 execv(Args
[0], (char**)Args
);
2628 if(Mode
== FileFd::ReadOnly
)
2633 else if(Mode
== FileFd::WriteOnly
)
2639 return _error
->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2640 Fd
.OpenDescriptor(fd
, Mode
, FileFd::None
, true);
2645 bool DropPrivileges() /*{{{*/
2647 if(_config
->FindB("Debug::NoDropPrivs", false) == true)
2651 #if defined(PR_SET_NO_NEW_PRIVS) && ( PR_SET_NO_NEW_PRIVS != 38 )
2652 #error "PR_SET_NO_NEW_PRIVS is defined, but with a different value than expected!"
2654 // see prctl(2), needs linux3.5 at runtime - magic constant to avoid it at buildtime
2655 int ret
= prctl(38, 1, 0, 0, 0);
2656 // ignore EINVAL - kernel is too old to understand the option
2657 if(ret
< 0 && errno
!= EINVAL
)
2658 _error
->Warning("PR_SET_NO_NEW_PRIVS failed with %i", ret
);
2661 // empty setting disables privilege dropping - this also ensures
2662 // backward compatibility, see bug #764506
2663 const std::string toUser
= _config
->Find("APT::Sandbox::User");
2664 if (toUser
.empty() || toUser
== "root")
2667 // a lot can go wrong trying to drop privileges completely,
2668 // so ideally we would like to verify that we have done it –
2669 // but the verify asks for too much in case of fakeroot (and alike)
2670 // [Specific checks can be overridden with dedicated options]
2671 bool const VerifySandboxing
= _config
->FindB("APT::Sandbox::Verify", false);
2673 // uid will be 0 in the end, but gid might be different anyway
2674 uid_t
const old_uid
= getuid();
2675 gid_t
const old_gid
= getgid();
2680 struct passwd
*pw
= getpwnam(toUser
.c_str());
2682 return _error
->Error("No user %s, can not drop rights", toUser
.c_str());
2684 // Do not change the order here, it might break things
2685 // Get rid of all our supplementary groups first
2686 if (setgroups(1, &pw
->pw_gid
))
2687 return _error
->Errno("setgroups", "Failed to setgroups");
2689 // Now change the group ids to the new user
2690 #ifdef HAVE_SETRESGID
2691 if (setresgid(pw
->pw_gid
, pw
->pw_gid
, pw
->pw_gid
) != 0)
2692 return _error
->Errno("setresgid", "Failed to set new group ids");
2694 if (setegid(pw
->pw_gid
) != 0)
2695 return _error
->Errno("setegid", "Failed to setegid");
2697 if (setgid(pw
->pw_gid
) != 0)
2698 return _error
->Errno("setgid", "Failed to setgid");
2701 // Change the user ids to the new user
2702 #ifdef HAVE_SETRESUID
2703 if (setresuid(pw
->pw_uid
, pw
->pw_uid
, pw
->pw_uid
) != 0)
2704 return _error
->Errno("setresuid", "Failed to set new user ids");
2706 if (setuid(pw
->pw_uid
) != 0)
2707 return _error
->Errno("setuid", "Failed to setuid");
2708 if (seteuid(pw
->pw_uid
) != 0)
2709 return _error
->Errno("seteuid", "Failed to seteuid");
2712 // disabled by default as fakeroot doesn't implement getgroups currently (#806521)
2713 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::Groups", false) == true)
2715 // Verify that the user isn't still in any supplementary groups
2716 long const ngroups_max
= sysconf(_SC_NGROUPS_MAX
);
2717 std::unique_ptr
<gid_t
[]> gidlist(new gid_t
[ngroups_max
]);
2718 if (unlikely(gidlist
== NULL
))
2719 return _error
->Error("Allocation of a list of size %lu for getgroups failed", ngroups_max
);
2721 if ((gidlist_nr
= getgroups(ngroups_max
, gidlist
.get())) < 0)
2722 return _error
->Errno("getgroups", "Could not get new groups (%lu)", ngroups_max
);
2723 for (ssize_t i
= 0; i
< gidlist_nr
; ++i
)
2724 if (gidlist
[i
] != pw
->pw_gid
)
2725 return _error
->Error("Could not switch group, user %s is still in group %d", toUser
.c_str(), gidlist
[i
]);
2728 // enabled by default as all fakeroot-lookalikes should fake that accordingly
2729 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::IDs", true) == true)
2731 // Verify that gid, egid, uid, and euid changed
2732 if (getgid() != pw
->pw_gid
)
2733 return _error
->Error("Could not switch group");
2734 if (getegid() != pw
->pw_gid
)
2735 return _error
->Error("Could not switch effective group");
2736 if (getuid() != pw
->pw_uid
)
2737 return _error
->Error("Could not switch user");
2738 if (geteuid() != pw
->pw_uid
)
2739 return _error
->Error("Could not switch effective user");
2741 #ifdef HAVE_GETRESUID
2742 // verify that the saved set-user-id was changed as well
2746 if (getresuid(&ruid
, &euid
, &suid
))
2747 return _error
->Errno("getresuid", "Could not get saved set-user-ID");
2748 if (suid
!= pw
->pw_uid
)
2749 return _error
->Error("Could not switch saved set-user-ID");
2752 #ifdef HAVE_GETRESGID
2753 // verify that the saved set-group-id was changed as well
2757 if (getresgid(&rgid
, &egid
, &sgid
))
2758 return _error
->Errno("getresuid", "Could not get saved set-group-ID");
2759 if (sgid
!= pw
->pw_gid
)
2760 return _error
->Error("Could not switch saved set-group-ID");
2764 // disabled as fakeroot doesn't forbid (by design) (re)gaining root from unprivileged
2765 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::Regain", false) == true)
2767 // Check that uid and gid changes do not work anymore
2768 if (pw
->pw_gid
!= old_gid
&& (setgid(old_gid
) != -1 || setegid(old_gid
) != -1))
2769 return _error
->Error("Could restore a gid to root, privilege dropping did not work");
2771 if (pw
->pw_uid
!= old_uid
&& (setuid(old_uid
) != -1 || seteuid(old_uid
) != -1))
2772 return _error
->Error("Could restore a uid to root, privilege dropping did not work");