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 size_t buffersize_max
= 0;
924 unsigned long long bufferstart
= 0;
925 unsigned long long bufferend
= 0;
926 char *buffer
= nullptr;
935 const char *get() const { return buffer
+ bufferstart
; }
936 char *get() { return buffer
+ bufferstart
; }
937 bool empty() const { return bufferend
<= bufferstart
; }
938 bool full() const { return bufferend
== buffersize_max
; }
939 unsigned long long size() const { return bufferend
-bufferstart
; }
940 void reset(size_t size
)
942 if (size
> buffersize_max
) {
944 buffersize_max
= size
;
945 buffer
= new char[size
];
949 void reset() { bufferend
= bufferstart
= 0; }
950 ssize_t
read(void *to
, unsigned long long requested_size
) APT_MUSTCHECK
952 if (size() < requested_size
)
953 requested_size
= size();
954 memcpy(to
, buffer
+ bufferstart
, requested_size
);
955 bufferstart
+= requested_size
;
956 if (bufferstart
== bufferend
)
957 bufferstart
= bufferend
= 0;
958 return requested_size
;
960 ssize_t
write(const void *from
, unsigned long long requested_size
) APT_MUSTCHECK
962 if (buffersize_max
- size() < requested_size
)
963 requested_size
= buffersize_max
- size();
964 memcpy(buffer
+ bufferend
, from
, requested_size
);
965 bufferend
+= requested_size
;
966 if (bufferstart
== bufferend
)
967 bufferstart
= bufferend
= 0;
968 return requested_size
;
973 class APT_HIDDEN FileFdPrivate
{ /*{{{*/
974 friend class BufferedWriteFileFdPrivate
;
976 FileFd
* const filefd
;
977 simple_buffer buffer
;
979 pid_t compressor_pid
;
981 APT::Configuration::Compressor compressor
;
982 unsigned int openmode
;
983 unsigned long long seekpos
;
986 explicit FileFdPrivate(FileFd
* const pfilefd
) : filefd(pfilefd
),
987 compressed_fd(-1), compressor_pid(-1), is_pipe(false),
988 openmode(0), seekpos(0) {};
989 virtual APT::Configuration::Compressor
get_compressor() const
993 virtual void set_compressor(APT::Configuration::Compressor
const &compressor
)
995 this->compressor
= compressor
;
997 virtual unsigned int get_openmode() const
1001 virtual void set_openmode(unsigned int openmode
)
1003 this->openmode
= openmode
;
1005 virtual bool get_is_pipe() const
1009 virtual void set_is_pipe(bool is_pipe
)
1011 this->is_pipe
= is_pipe
;
1013 virtual unsigned long long get_seekpos() const
1017 virtual void set_seekpos(unsigned long long seekpos
)
1019 this->seekpos
= seekpos
;
1022 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) = 0;
1023 ssize_t
InternalRead(void * To
, unsigned long long Size
)
1025 // Drain the buffer if needed.
1026 if (buffer
.empty() == false)
1028 return buffer
.read(To
, Size
);
1030 return InternalUnbufferedRead(To
, Size
);
1032 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) = 0;
1033 virtual bool InternalReadError() { return filefd
->FileFdErrno("read",_("Read error")); }
1034 virtual char * InternalReadLine(char * To
, unsigned long long Size
)
1036 if (unlikely(Size
== 0))
1038 // Read one byte less than buffer size to have space for trailing 0.
1041 char * const InitialTo
= To
;
1044 if (buffer
.empty() == true)
1047 unsigned long long actualread
= 0;
1048 if (filefd
->Read(buffer
.get(), buffer
.buffersize_max
, &actualread
) == false)
1050 buffer
.bufferend
= actualread
;
1051 if (buffer
.size() == 0)
1053 if (To
== InitialTo
)
1057 filefd
->Flags
&= ~FileFd::HitEof
;
1060 unsigned long long const OutputSize
= std::min(Size
, buffer
.size());
1061 char const * const newline
= static_cast<char const * const>(memchr(buffer
.get(), '\n', OutputSize
));
1062 // Read until end of line or up to Size bytes from the buffer.
1063 unsigned long long actualread
= buffer
.read(To
,
1064 (newline
!= nullptr)
1065 ? (newline
- buffer
.get()) + 1
1069 if (newline
!= nullptr)
1075 virtual bool InternalFlush()
1079 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) = 0;
1080 virtual bool InternalWriteError() { return filefd
->FileFdErrno("write",_("Write error")); }
1081 virtual bool InternalSeek(unsigned long long const To
)
1083 // Our poor man seeking is costly, so try to avoid it
1084 unsigned long long const iseekpos
= filefd
->Tell();
1087 else if (iseekpos
< To
)
1088 return filefd
->Skip(To
- iseekpos
);
1090 if ((openmode
& FileFd::ReadOnly
) != FileFd::ReadOnly
)
1091 return filefd
->FileFdError("Reopen is only implemented for read-only files!");
1092 InternalClose(filefd
->FileName
);
1093 if (filefd
->iFd
!= -1)
1096 if (filefd
->TemporaryFileName
.empty() == false)
1097 filefd
->iFd
= open(filefd
->TemporaryFileName
.c_str(), O_RDONLY
);
1098 else if (filefd
->FileName
.empty() == false)
1099 filefd
->iFd
= open(filefd
->FileName
.c_str(), O_RDONLY
);
1102 if (compressed_fd
> 0)
1103 if (lseek(compressed_fd
, 0, SEEK_SET
) != 0)
1104 filefd
->iFd
= compressed_fd
;
1105 if (filefd
->iFd
< 0)
1106 return filefd
->FileFdError("Reopen is not implemented for pipes opened with FileFd::OpenDescriptor()!");
1109 if (filefd
->OpenInternDescriptor(openmode
, compressor
) == false)
1110 return filefd
->FileFdError("Seek on file %s because it couldn't be reopened", filefd
->FileName
.c_str());
1114 return filefd
->Skip(To
);
1119 virtual bool InternalSkip(unsigned long long Over
)
1121 unsigned long long constexpr buffersize
= 1024;
1122 char buffer
[buffersize
];
1125 unsigned long long toread
= std::min(buffersize
, Over
);
1126 if (filefd
->Read(buffer
, toread
) == false)
1127 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
1132 virtual bool InternalTruncate(unsigned long long const)
1134 return filefd
->FileFdError("Truncating compressed files is not implemented (%s)", filefd
->FileName
.c_str());
1136 virtual unsigned long long InternalTell()
1138 // In theory, we could just return seekpos here always instead of
1139 // seeking around, but not all users of FileFd use always Seek() and co
1140 // so d->seekpos isn't always true and we can just use it as a hint if
1141 // we have nothing else, but not always as an authority…
1142 return seekpos
- buffer
.size();
1144 virtual unsigned long long InternalSize()
1146 unsigned long long size
= 0;
1147 unsigned long long const oldSeek
= filefd
->Tell();
1148 unsigned long long constexpr ignoresize
= 1024;
1149 char ignore
[ignoresize
];
1150 unsigned long long read
= 0;
1152 if (filefd
->Read(ignore
, ignoresize
, &read
) == false)
1154 filefd
->Seek(oldSeek
);
1158 size
= filefd
->Tell();
1159 filefd
->Seek(oldSeek
);
1162 virtual bool InternalClose(std::string
const &FileName
) = 0;
1163 virtual bool InternalStream() const { return false; }
1164 virtual bool InternalAlwaysAutoClose() const { return true; }
1166 virtual ~FileFdPrivate() {}
1169 class APT_HIDDEN BufferedWriteFileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1171 FileFdPrivate
*wrapped
;
1172 simple_buffer writebuffer
;
1176 explicit BufferedWriteFileFdPrivate(FileFdPrivate
*Priv
) :
1177 FileFdPrivate(Priv
->filefd
), wrapped(Priv
) {};
1179 virtual APT::Configuration::Compressor
get_compressor() const override
1181 return wrapped
->get_compressor();
1183 virtual void set_compressor(APT::Configuration::Compressor
const &compressor
) override
1185 return wrapped
->set_compressor(compressor
);
1187 virtual unsigned int get_openmode() const override
1189 return wrapped
->get_openmode();
1191 virtual void set_openmode(unsigned int openmode
) override
1193 return wrapped
->set_openmode(openmode
);
1195 virtual bool get_is_pipe() const override
1197 return wrapped
->get_is_pipe();
1199 virtual void set_is_pipe(bool is_pipe
) override
1201 FileFdPrivate::set_is_pipe(is_pipe
);
1202 wrapped
->set_is_pipe(is_pipe
);
1204 virtual unsigned long long get_seekpos() const override
1206 return wrapped
->get_seekpos();
1208 virtual void set_seekpos(unsigned long long seekpos
) override
1210 return wrapped
->set_seekpos(seekpos
);
1212 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1214 if (InternalFlush() == false)
1216 return wrapped
->InternalOpen(iFd
, Mode
);
1218 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1220 if (InternalFlush() == false)
1222 return wrapped
->InternalUnbufferedRead(To
, Size
);
1225 virtual bool InternalReadError() override
1227 return wrapped
->InternalReadError();
1229 virtual char * InternalReadLine(char * To
, unsigned long long Size
) override
1231 if (InternalFlush() == false)
1233 return wrapped
->InternalReadLine(To
, Size
);
1235 virtual bool InternalFlush() override
1237 while (writebuffer
.empty() == false) {
1238 auto written
= wrapped
->InternalWrite(writebuffer
.get(),
1239 writebuffer
.size());
1240 // Ignore interrupted syscalls
1241 if (written
< 0 && errno
== EINTR
)
1246 writebuffer
.bufferstart
+= written
;
1249 writebuffer
.reset();
1252 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1256 while (written
< Size
) {
1257 auto buffered
= writebuffer
.write(static_cast<char const*>(From
) + written
, Size
- written
);
1259 written
+= buffered
;
1261 if (writebuffer
.full() && InternalFlush() == false)
1267 virtual bool InternalWriteError()
1269 return wrapped
->InternalWriteError();
1271 virtual bool InternalSeek(unsigned long long const To
)
1273 if (InternalFlush() == false)
1275 return wrapped
->InternalSeek(To
);
1277 virtual bool InternalSkip(unsigned long long Over
)
1279 if (InternalFlush() == false)
1281 return wrapped
->InternalSkip(Over
);
1283 virtual bool InternalTruncate(unsigned long long const Size
)
1285 if (InternalFlush() == false)
1287 return wrapped
->InternalTruncate(Size
);
1289 virtual unsigned long long InternalTell()
1291 if (InternalFlush() == false)
1293 return wrapped
->InternalTell();
1295 virtual unsigned long long InternalSize()
1297 if (InternalFlush() == false)
1299 return wrapped
->InternalSize();
1301 virtual bool InternalClose(std::string
const &FileName
)
1303 return wrapped
->InternalClose(FileName
);
1305 virtual bool InternalAlwaysAutoClose() const
1307 return wrapped
->InternalAlwaysAutoClose();
1309 virtual ~BufferedWriteFileFdPrivate()
1315 class APT_HIDDEN GzipFileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1319 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1321 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1322 gz
= gzdopen(iFd
, "r+");
1323 else if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1324 gz
= gzdopen(iFd
, "w");
1326 gz
= gzdopen(iFd
, "r");
1327 filefd
->Flags
|= FileFd::Compressed
;
1328 return gz
!= nullptr;
1330 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1332 return gzread(gz
, To
, Size
);
1334 virtual bool InternalReadError() override
1337 char const * const errmsg
= gzerror(gz
, &err
);
1339 return filefd
->FileFdError("gzread: %s (%d: %s)", _("Read error"), err
, errmsg
);
1340 return FileFdPrivate::InternalReadError();
1342 virtual char * InternalReadLine(char * To
, unsigned long long Size
) override
1344 return gzgets(gz
, To
, Size
);
1346 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1348 return gzwrite(gz
,From
,Size
);
1350 virtual bool InternalWriteError() override
1353 char const * const errmsg
= gzerror(gz
, &err
);
1355 return filefd
->FileFdError("gzwrite: %s (%d: %s)", _("Write error"), err
, errmsg
);
1356 return FileFdPrivate::InternalWriteError();
1358 virtual bool InternalSeek(unsigned long long const To
) override
1360 off_t
const res
= gzseek(gz
, To
, SEEK_SET
);
1361 if (res
!= (off_t
)To
)
1362 return filefd
->FileFdError("Unable to seek to %llu", To
);
1367 virtual bool InternalSkip(unsigned long long Over
) override
1369 if (Over
>= buffer
.size())
1371 Over
-= buffer
.size();
1376 buffer
.bufferstart
+= Over
;
1381 off_t
const res
= gzseek(gz
, Over
, SEEK_CUR
);
1383 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
1387 virtual unsigned long long InternalTell() override
1389 return gztell(gz
) - buffer
.size();
1391 virtual unsigned long long InternalSize() override
1393 unsigned long long filesize
= FileFdPrivate::InternalSize();
1394 // only check gzsize if we are actually a gzip file, just checking for
1395 // "gz" is not sufficient as uncompressed files could be opened with
1396 // gzopen in "direct" mode as well
1397 if (filesize
== 0 || gzdirect(gz
))
1400 off_t
const oldPos
= lseek(filefd
->iFd
, 0, SEEK_CUR
);
1401 /* unfortunately zlib.h doesn't provide a gzsize(), so we have to do
1402 * this ourselves; the original (uncompressed) file size is the last 32
1403 * bits of the file */
1404 // FIXME: Size for gz-files is limited by 32bit… no largefile support
1405 if (lseek(filefd
->iFd
, -4, SEEK_END
) < 0)
1407 filefd
->FileFdErrno("lseek","Unable to seek to end of gzipped file");
1411 if (read(filefd
->iFd
, &size
, 4) != 4)
1413 filefd
->FileFdErrno("read","Unable to read original size of gzipped file");
1416 size
= le32toh(size
);
1418 if (lseek(filefd
->iFd
, oldPos
, SEEK_SET
) < 0)
1420 filefd
->FileFdErrno("lseek","Unable to seek in gzipped file");
1425 virtual bool InternalClose(std::string
const &FileName
) override
1429 int const e
= gzclose(gz
);
1431 // gzdclose() on empty files always fails with "buffer error" here, ignore that
1432 if (e
!= 0 && e
!= Z_BUF_ERROR
)
1433 return _error
->Errno("close",_("Problem closing the gzip file %s"), FileName
.c_str());
1437 explicit GzipFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), gz(nullptr) {}
1438 virtual ~GzipFileFdPrivate() { InternalClose(""); }
1442 class APT_HIDDEN Bz2FileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1446 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1448 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1449 bz2
= BZ2_bzdopen(iFd
, "r+");
1450 else if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1451 bz2
= BZ2_bzdopen(iFd
, "w");
1453 bz2
= BZ2_bzdopen(iFd
, "r");
1454 filefd
->Flags
|= FileFd::Compressed
;
1455 return bz2
!= nullptr;
1457 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1459 return BZ2_bzread(bz2
, To
, Size
);
1461 virtual bool InternalReadError() override
1464 char const * const errmsg
= BZ2_bzerror(bz2
, &err
);
1465 if (err
!= BZ_IO_ERROR
)
1466 return filefd
->FileFdError("BZ2_bzread: %s %s (%d: %s)", filefd
->FileName
.c_str(), _("Read error"), err
, errmsg
);
1467 return FileFdPrivate::InternalReadError();
1469 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1471 return BZ2_bzwrite(bz2
, (void*)From
, Size
);
1473 virtual bool InternalWriteError() override
1476 char const * const errmsg
= BZ2_bzerror(bz2
, &err
);
1477 if (err
!= BZ_IO_ERROR
)
1478 return filefd
->FileFdError("BZ2_bzwrite: %s %s (%d: %s)", filefd
->FileName
.c_str(), _("Write error"), err
, errmsg
);
1479 return FileFdPrivate::InternalWriteError();
1481 virtual bool InternalStream() const override
{ return true; }
1482 virtual bool InternalClose(std::string
const &) override
1491 explicit Bz2FileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), bz2(nullptr) {}
1492 virtual ~Bz2FileFdPrivate() { InternalClose(""); }
1496 class APT_HIDDEN LzmaFileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1500 uint8_t buffer
[4096];
1506 LZMAFILE() : file(nullptr), eof(false), compressing(false) { buffer
[0] = '\0'; }
1509 if (compressing
== true)
1511 size_t constexpr buffersize
= sizeof(buffer
)/sizeof(buffer
[0]);
1514 stream
.avail_out
= buffersize
;
1515 stream
.next_out
= buffer
;
1516 err
= lzma_code(&stream
, LZMA_FINISH
);
1517 if (err
!= LZMA_OK
&& err
!= LZMA_STREAM_END
)
1519 _error
->Error("~LZMAFILE: Compress finalisation failed");
1522 size_t const n
= buffersize
- stream
.avail_out
;
1523 if (n
&& fwrite(buffer
, 1, n
, file
) != n
)
1525 _error
->Errno("~LZMAFILE",_("Write error"));
1528 if (err
== LZMA_STREAM_END
)
1537 static uint32_t findXZlevel(std::vector
<std::string
> const &Args
)
1539 for (auto a
= Args
.rbegin(); a
!= Args
.rend(); ++a
)
1540 if (a
->empty() == false && (*a
)[0] == '-' && (*a
)[1] != '-')
1542 auto const number
= a
->find_last_of("0123456789");
1543 if (number
== std::string::npos
)
1545 auto const extreme
= a
->find("e", number
);
1546 uint32_t level
= (extreme
!= std::string::npos
) ? LZMA_PRESET_EXTREME
: 0;
1547 switch ((*a
)[number
])
1549 case '0': return level
| 0;
1550 case '1': return level
| 1;
1551 case '2': return level
| 2;
1552 case '3': return level
| 3;
1553 case '4': return level
| 4;
1554 case '5': return level
| 5;
1555 case '6': return level
| 6;
1556 case '7': return level
| 7;
1557 case '8': return level
| 8;
1558 case '9': return level
| 9;
1564 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1566 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1567 return filefd
->FileFdError("ReadWrite mode is not supported for lzma/xz files %s", filefd
->FileName
.c_str());
1569 if (lzma
== nullptr)
1570 lzma
= new LzmaFileFdPrivate::LZMAFILE
;
1571 if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1572 lzma
->file
= fdopen(iFd
, "w");
1574 lzma
->file
= fdopen(iFd
, "r");
1575 filefd
->Flags
|= FileFd::Compressed
;
1576 if (lzma
->file
== nullptr)
1579 lzma_stream tmp_stream
= LZMA_STREAM_INIT
;
1580 lzma
->stream
= tmp_stream
;
1582 if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1584 uint32_t const xzlevel
= findXZlevel(compressor
.CompressArgs
);
1585 if (compressor
.Name
== "xz")
1587 if (lzma_easy_encoder(&lzma
->stream
, xzlevel
, LZMA_CHECK_CRC64
) != LZMA_OK
)
1592 lzma_options_lzma options
;
1593 lzma_lzma_preset(&options
, xzlevel
);
1594 if (lzma_alone_encoder(&lzma
->stream
, &options
) != LZMA_OK
)
1597 lzma
->compressing
= true;
1601 uint64_t const memlimit
= UINT64_MAX
;
1602 if (compressor
.Name
== "xz")
1604 if (lzma_auto_decoder(&lzma
->stream
, memlimit
, 0) != LZMA_OK
)
1609 if (lzma_alone_decoder(&lzma
->stream
, memlimit
) != LZMA_OK
)
1612 lzma
->compressing
= false;
1616 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1619 if (lzma
->eof
== true)
1622 lzma
->stream
.next_out
= (uint8_t *) To
;
1623 lzma
->stream
.avail_out
= Size
;
1624 if (lzma
->stream
.avail_in
== 0)
1626 lzma
->stream
.next_in
= lzma
->buffer
;
1627 lzma
->stream
.avail_in
= fread(lzma
->buffer
, 1, sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]), lzma
->file
);
1629 lzma
->err
= lzma_code(&lzma
->stream
, LZMA_RUN
);
1630 if (lzma
->err
== LZMA_STREAM_END
)
1633 Res
= Size
- lzma
->stream
.avail_out
;
1635 else if (lzma
->err
!= LZMA_OK
)
1642 Res
= Size
- lzma
->stream
.avail_out
;
1645 // lzma run was okay, but produced no output…
1652 virtual bool InternalReadError() override
1654 return filefd
->FileFdError("lzma_read: %s (%d)", _("Read error"), lzma
->err
);
1656 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1658 lzma
->stream
.next_in
= (uint8_t *)From
;
1659 lzma
->stream
.avail_in
= Size
;
1660 lzma
->stream
.next_out
= lzma
->buffer
;
1661 lzma
->stream
.avail_out
= sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]);
1662 lzma
->err
= lzma_code(&lzma
->stream
, LZMA_RUN
);
1663 if (lzma
->err
!= LZMA_OK
)
1665 size_t const n
= sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]) - lzma
->stream
.avail_out
;
1666 size_t const m
= (n
== 0) ? 0 : fwrite(lzma
->buffer
, 1, n
, lzma
->file
);
1670 return Size
- lzma
->stream
.avail_in
;
1672 virtual bool InternalWriteError() override
1674 return filefd
->FileFdError("lzma_write: %s (%d)", _("Write error"), lzma
->err
);
1676 virtual bool InternalStream() const override
{ return true; }
1677 virtual bool InternalClose(std::string
const &) override
1684 explicit LzmaFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), lzma(nullptr) {}
1685 virtual ~LzmaFileFdPrivate() { InternalClose(""); }
1689 class APT_HIDDEN PipedFileFdPrivate
: public FileFdPrivate
/*{{{*/
1690 /* if we don't have a specific class dealing with library calls, we (un)compress
1691 by executing a specified binary and pipe in/out what we need */
1694 virtual bool InternalOpen(int const, unsigned int const Mode
) override
1696 // collect zombies here in case we reopen
1697 if (compressor_pid
> 0)
1698 ExecWait(compressor_pid
, "FileFdCompressor", true);
1700 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1701 return filefd
->FileFdError("ReadWrite mode is not supported for file %s", filefd
->FileName
.c_str());
1703 bool const Comp
= (Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
;
1706 // Handle 'decompression' of empty files
1708 fstat(filefd
->iFd
, &Buf
);
1709 if (Buf
.st_size
== 0 && S_ISFIFO(Buf
.st_mode
) == false)
1712 // We don't need the file open - instead let the compressor open it
1713 // as he properly knows better how to efficiently read from 'his' file
1714 if (filefd
->FileName
.empty() == false)
1721 // Create a data pipe
1722 int Pipe
[2] = {-1,-1};
1723 if (pipe(Pipe
) != 0)
1724 return filefd
->FileFdErrno("pipe",_("Failed to create subprocess IPC"));
1725 for (int J
= 0; J
!= 2; J
++)
1726 SetCloseExec(Pipe
[J
],true);
1728 compressed_fd
= filefd
->iFd
;
1732 filefd
->iFd
= Pipe
[1];
1734 filefd
->iFd
= Pipe
[0];
1737 compressor_pid
= ExecFork();
1738 if (compressor_pid
== 0)
1742 dup2(compressed_fd
,STDOUT_FILENO
);
1743 dup2(Pipe
[0],STDIN_FILENO
);
1747 if (compressed_fd
!= -1)
1748 dup2(compressed_fd
,STDIN_FILENO
);
1749 dup2(Pipe
[1],STDOUT_FILENO
);
1751 int const nullfd
= open("/dev/null", O_WRONLY
);
1754 dup2(nullfd
,STDERR_FILENO
);
1758 SetCloseExec(STDOUT_FILENO
,false);
1759 SetCloseExec(STDIN_FILENO
,false);
1761 std::vector
<char const*> Args
;
1762 Args
.push_back(compressor
.Binary
.c_str());
1763 std::vector
<std::string
> const * const addArgs
=
1764 (Comp
== true) ? &(compressor
.CompressArgs
) : &(compressor
.UncompressArgs
);
1765 for (std::vector
<std::string
>::const_iterator a
= addArgs
->begin();
1766 a
!= addArgs
->end(); ++a
)
1767 Args
.push_back(a
->c_str());
1768 if (Comp
== false && filefd
->FileName
.empty() == false)
1770 // commands not needing arguments, do not need to be told about using standard output
1771 // in reality, only testcases with tools like cat, rev, rot13, … are able to trigger this
1772 if (compressor
.CompressArgs
.empty() == false && compressor
.UncompressArgs
.empty() == false)
1773 Args
.push_back("--stdout");
1774 if (filefd
->TemporaryFileName
.empty() == false)
1775 Args
.push_back(filefd
->TemporaryFileName
.c_str());
1777 Args
.push_back(filefd
->FileName
.c_str());
1779 Args
.push_back(NULL
);
1781 execvp(Args
[0],(char **)&Args
[0]);
1782 cerr
<< _("Failed to exec compressor ") << Args
[0] << endl
;
1792 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1794 return read(filefd
->iFd
, To
, Size
);
1796 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1798 return write(filefd
->iFd
, From
, Size
);
1800 virtual bool InternalClose(std::string
const &) override
1803 if (compressor_pid
> 0)
1804 Ret
&= ExecWait(compressor_pid
, "FileFdCompressor", true);
1805 compressor_pid
= -1;
1808 explicit PipedFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
) {}
1809 virtual ~PipedFileFdPrivate() { InternalClose(""); }
1812 class APT_HIDDEN DirectFileFdPrivate
: public FileFdPrivate
/*{{{*/
1815 virtual bool InternalOpen(int const, unsigned int const) override
{ return true; }
1816 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1818 return read(filefd
->iFd
, To
, Size
);
1820 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1822 // files opened read+write are strange and only really "supported" for direct files
1823 if (buffer
.size() != 0)
1825 lseek(filefd
->iFd
, -buffer
.size(), SEEK_CUR
);
1828 return write(filefd
->iFd
, From
, Size
);
1830 virtual bool InternalSeek(unsigned long long const To
) override
1832 off_t
const res
= lseek(filefd
->iFd
, To
, SEEK_SET
);
1833 if (res
!= (off_t
)To
)
1834 return filefd
->FileFdError("Unable to seek to %llu", To
);
1839 virtual bool InternalSkip(unsigned long long Over
) override
1841 if (Over
>= buffer
.size())
1843 Over
-= buffer
.size();
1848 buffer
.bufferstart
+= Over
;
1853 off_t
const res
= lseek(filefd
->iFd
, Over
, SEEK_CUR
);
1855 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
1859 virtual bool InternalTruncate(unsigned long long const To
) override
1861 if (buffer
.size() != 0)
1863 unsigned long long const seekpos
= lseek(filefd
->iFd
, 0, SEEK_CUR
);
1864 if ((seekpos
- buffer
.size()) >= To
)
1866 else if (seekpos
>= To
)
1867 buffer
.bufferend
= (To
- seekpos
) + buffer
.bufferstart
;
1871 if (ftruncate(filefd
->iFd
, To
) != 0)
1872 return filefd
->FileFdError("Unable to truncate to %llu",To
);
1875 virtual unsigned long long InternalTell() override
1877 return lseek(filefd
->iFd
,0,SEEK_CUR
) - buffer
.size();
1879 virtual unsigned long long InternalSize() override
1881 return filefd
->FileSize();
1883 virtual bool InternalClose(std::string
const &) override
{ return true; }
1884 virtual bool InternalAlwaysAutoClose() const override
{ return false; }
1886 explicit DirectFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
) {}
1887 virtual ~DirectFileFdPrivate() { InternalClose(""); }
1890 // FileFd Constructors /*{{{*/
1891 FileFd::FileFd(std::string FileName
,unsigned int const Mode
,unsigned long AccessMode
) : iFd(-1), Flags(0), d(NULL
)
1893 Open(FileName
,Mode
, None
, AccessMode
);
1895 FileFd::FileFd(std::string FileName
,unsigned int const Mode
, CompressMode Compress
, unsigned long AccessMode
) : iFd(-1), Flags(0), d(NULL
)
1897 Open(FileName
,Mode
, Compress
, AccessMode
);
1899 FileFd::FileFd() : iFd(-1), Flags(AutoClose
), d(NULL
) {}
1900 FileFd::FileFd(int const Fd
, unsigned int const Mode
, CompressMode Compress
) : iFd(-1), Flags(0), d(NULL
)
1902 OpenDescriptor(Fd
, Mode
, Compress
);
1904 FileFd::FileFd(int const Fd
, bool const AutoClose
) : iFd(-1), Flags(0), d(NULL
)
1906 OpenDescriptor(Fd
, ReadWrite
, None
, AutoClose
);
1909 // FileFd::Open - Open a file /*{{{*/
1910 // ---------------------------------------------------------------------
1911 /* The most commonly used open mode combinations are given with Mode */
1912 bool FileFd::Open(string FileName
,unsigned int const Mode
,CompressMode Compress
, unsigned long const AccessMode
)
1914 if (Mode
== ReadOnlyGzip
)
1915 return Open(FileName
, ReadOnly
, Gzip
, AccessMode
);
1917 if (Compress
== Auto
&& (Mode
& WriteOnly
) == WriteOnly
)
1918 return FileFdError("Autodetection on %s only works in ReadOnly openmode!", FileName
.c_str());
1920 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
1921 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
1922 if (Compress
== Auto
)
1924 for (; compressor
!= compressors
.end(); ++compressor
)
1926 std::string file
= FileName
+ compressor
->Extension
;
1927 if (FileExists(file
) == false)
1933 else if (Compress
== Extension
)
1935 std::string::size_type
const found
= FileName
.find_last_of('.');
1937 if (found
!= std::string::npos
)
1939 ext
= FileName
.substr(found
);
1940 if (ext
== ".new" || ext
== ".bak")
1942 std::string::size_type
const found2
= FileName
.find_last_of('.', found
- 1);
1943 if (found2
!= std::string::npos
)
1944 ext
= FileName
.substr(found2
, found
- found2
);
1949 for (; compressor
!= compressors
.end(); ++compressor
)
1950 if (ext
== compressor
->Extension
)
1952 // no matching extension - assume uncompressed (imagine files like 'example.org_Packages')
1953 if (compressor
== compressors
.end())
1954 for (compressor
= compressors
.begin(); compressor
!= compressors
.end(); ++compressor
)
1955 if (compressor
->Name
== ".")
1963 case None
: name
= "."; break;
1964 case Gzip
: name
= "gzip"; break;
1965 case Bzip2
: name
= "bzip2"; break;
1966 case Lzma
: name
= "lzma"; break;
1967 case Xz
: name
= "xz"; break;
1971 return FileFdError("Opening File %s in None, Auto or Extension should be already handled?!?", FileName
.c_str());
1973 for (; compressor
!= compressors
.end(); ++compressor
)
1974 if (compressor
->Name
== name
)
1976 if (compressor
== compressors
.end())
1977 return FileFdError("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
1980 if (compressor
== compressors
.end())
1981 return FileFdError("Can't find a match for specified compressor mode for file %s", FileName
.c_str());
1982 return Open(FileName
, Mode
, *compressor
, AccessMode
);
1984 bool FileFd::Open(string FileName
,unsigned int const Mode
,APT::Configuration::Compressor
const &compressor
, unsigned long const AccessMode
)
1989 if ((Mode
& WriteOnly
) != WriteOnly
&& (Mode
& (Atomic
| Create
| Empty
| Exclusive
)) != 0)
1990 return FileFdError("ReadOnly mode for %s doesn't accept additional flags!", FileName
.c_str());
1991 if ((Mode
& ReadWrite
) == 0)
1992 return FileFdError("No openmode provided in FileFd::Open for %s", FileName
.c_str());
1994 unsigned int OpenMode
= Mode
;
1995 if (FileName
== "/dev/null")
1996 OpenMode
= OpenMode
& ~(Atomic
| Exclusive
| Create
| Empty
);
1998 if ((OpenMode
& Atomic
) == Atomic
)
2002 else if ((OpenMode
& (Exclusive
| Create
)) == (Exclusive
| Create
))
2004 // for atomic, this will be done by rename in Close()
2005 RemoveFile("FileFd::Open", FileName
);
2007 if ((OpenMode
& Empty
) == Empty
)
2010 if (lstat(FileName
.c_str(),&Buf
) == 0 && S_ISLNK(Buf
.st_mode
))
2011 RemoveFile("FileFd::Open", FileName
);
2015 #define if_FLAGGED_SET(FLAG, MODE) if ((OpenMode & FLAG) == FLAG) fileflags |= MODE
2016 if_FLAGGED_SET(ReadWrite
, O_RDWR
);
2017 else if_FLAGGED_SET(ReadOnly
, O_RDONLY
);
2018 else if_FLAGGED_SET(WriteOnly
, O_WRONLY
);
2020 if_FLAGGED_SET(Create
, O_CREAT
);
2021 if_FLAGGED_SET(Empty
, O_TRUNC
);
2022 if_FLAGGED_SET(Exclusive
, O_EXCL
);
2023 #undef if_FLAGGED_SET
2025 if ((OpenMode
& Atomic
) == Atomic
)
2027 char *name
= strdup((FileName
+ ".XXXXXX").c_str());
2029 if((iFd
= mkstemp(name
)) == -1)
2032 return FileFdErrno("mkstemp", "Could not create temporary file for %s", FileName
.c_str());
2035 TemporaryFileName
= string(name
);
2038 // umask() will always set the umask and return the previous value, so
2039 // we first set the umask and then reset it to the old value
2040 mode_t
const CurrentUmask
= umask(0);
2041 umask(CurrentUmask
);
2042 // calculate the actual file permissions (just like open/creat)
2043 mode_t
const FilePermissions
= (AccessMode
& ~CurrentUmask
);
2045 if(fchmod(iFd
, FilePermissions
) == -1)
2046 return FileFdErrno("fchmod", "Could not change permissions for temporary file %s", TemporaryFileName
.c_str());
2049 iFd
= open(FileName
.c_str(), fileflags
, AccessMode
);
2051 this->FileName
= FileName
;
2052 if (iFd
== -1 || OpenInternDescriptor(OpenMode
, compressor
) == false)
2059 return FileFdErrno("open",_("Could not open file %s"), FileName
.c_str());
2062 SetCloseExec(iFd
,true);
2066 // FileFd::OpenDescriptor - Open a filedescriptor /*{{{*/
2067 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, CompressMode Compress
, bool AutoClose
)
2069 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
2070 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
2073 // compat with the old API
2074 if (Mode
== ReadOnlyGzip
&& Compress
== None
)
2079 case None
: name
= "."; break;
2080 case Gzip
: name
= "gzip"; break;
2081 case Bzip2
: name
= "bzip2"; break;
2082 case Lzma
: name
= "lzma"; break;
2083 case Xz
: name
= "xz"; break;
2086 if (AutoClose
== true && Fd
!= -1)
2088 return FileFdError("Opening Fd %d in Auto or Extension compression mode is not supported", Fd
);
2090 for (; compressor
!= compressors
.end(); ++compressor
)
2091 if (compressor
->Name
== name
)
2093 if (compressor
== compressors
.end())
2095 if (AutoClose
== true && Fd
!= -1)
2097 return FileFdError("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
2099 return OpenDescriptor(Fd
, Mode
, *compressor
, AutoClose
);
2101 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
, bool AutoClose
)
2104 Flags
= (AutoClose
) ? FileFd::AutoClose
: 0;
2106 this->FileName
= "";
2107 if (OpenInternDescriptor(Mode
, compressor
) == false)
2110 (Flags
& Compressed
) == Compressed
||
2116 return FileFdError(_("Could not open file descriptor %d"), Fd
);
2120 bool FileFd::OpenInternDescriptor(unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
)
2126 d
->InternalClose(FileName
);
2131 /* dummy so that the rest can be 'else if's */;
2132 #define APT_COMPRESS_INIT(NAME, CONSTRUCTOR) \
2133 else if (compressor.Name == NAME) \
2134 d = new CONSTRUCTOR(this)
2136 APT_COMPRESS_INIT("gzip", GzipFileFdPrivate
);
2139 APT_COMPRESS_INIT("bzip2", Bz2FileFdPrivate
);
2142 APT_COMPRESS_INIT("xz", LzmaFileFdPrivate
);
2143 APT_COMPRESS_INIT("lzma", LzmaFileFdPrivate
);
2145 #undef APT_COMPRESS_INIT
2146 else if (compressor
.Name
== "." || compressor
.Binary
.empty() == true)
2147 d
= new DirectFileFdPrivate(this);
2149 d
= new PipedFileFdPrivate(this);
2151 if (Mode
& BufferedWrite
)
2152 d
= new BufferedWriteFileFdPrivate(d
);
2154 d
->set_openmode(Mode
);
2155 d
->set_compressor(compressor
);
2156 if ((Flags
& AutoClose
) != AutoClose
&& d
->InternalAlwaysAutoClose())
2158 // Need to duplicate fd here or gz/bz2 close for cleanup will close the fd as well
2159 int const internFd
= dup(iFd
);
2161 return FileFdErrno("OpenInternDescriptor", _("Could not open file descriptor %d"), iFd
);
2165 return d
->InternalOpen(iFd
, Mode
);
2168 // FileFd::~File - Closes the file /*{{{*/
2169 // ---------------------------------------------------------------------
2170 /* If the proper modes are selected then we close the Fd and possibly
2171 unlink the file on error. */
2176 d
->InternalClose(FileName
);
2181 // FileFd::Read - Read a bit of the file /*{{{*/
2182 // ---------------------------------------------------------------------
2183 /* We are careful to handle interruption by a signal while reading
2185 bool FileFd::Read(void *To
,unsigned long long Size
,unsigned long long *Actual
)
2193 *((char *)To
) = '\0';
2194 while (Res
> 0 && Size
> 0)
2196 Res
= d
->InternalRead(To
, Size
);
2202 // trick the while-loop into running again
2207 return d
->InternalReadError();
2210 To
= (char *)To
+ Res
;
2213 d
->set_seekpos(d
->get_seekpos() + Res
);
2228 return FileFdError(_("read, still have %llu to read but none left"), Size
);
2231 // FileFd::ReadLine - Read a complete line from the file /*{{{*/
2232 // ---------------------------------------------------------------------
2233 /* Beware: This method can be quite slow for big buffers on UNcompressed
2234 files because of the naive implementation! */
2235 char* FileFd::ReadLine(char *To
, unsigned long long const Size
)
2240 return d
->InternalReadLine(To
, Size
);
2243 // FileFd::Flush - Flush the file /*{{{*/
2244 bool FileFd::Flush()
2249 return d
->InternalFlush();
2252 // FileFd::Write - Write to the file /*{{{*/
2253 bool FileFd::Write(const void *From
,unsigned long long Size
)
2259 while (Res
> 0 && Size
> 0)
2261 Res
= d
->InternalWrite(From
, Size
);
2262 if (Res
< 0 && errno
== EINTR
)
2265 return d
->InternalWriteError();
2267 From
= (char const *)From
+ Res
;
2270 d
->set_seekpos(d
->get_seekpos() + Res
);
2276 return FileFdError(_("write, still have %llu to write but couldn't"), Size
);
2278 bool FileFd::Write(int Fd
, const void *From
, unsigned long long Size
)
2282 while (Res
> 0 && Size
> 0)
2284 Res
= write(Fd
,From
,Size
);
2285 if (Res
< 0 && errno
== EINTR
)
2288 return _error
->Errno("write",_("Write error"));
2290 From
= (char const *)From
+ Res
;
2297 return _error
->Error(_("write, still have %llu to write but couldn't"), Size
);
2300 // FileFd::Seek - Seek in the file /*{{{*/
2301 bool FileFd::Seek(unsigned long long To
)
2306 return d
->InternalSeek(To
);
2309 // FileFd::Skip - Skip over data in the file /*{{{*/
2310 bool FileFd::Skip(unsigned long long Over
)
2314 return d
->InternalSkip(Over
);
2317 // FileFd::Truncate - Truncate the file /*{{{*/
2318 bool FileFd::Truncate(unsigned long long To
)
2322 // truncating /dev/null is always successful - as we get an error otherwise
2323 if (To
== 0 && FileName
== "/dev/null")
2325 return d
->InternalTruncate(To
);
2328 // FileFd::Tell - Current seek position /*{{{*/
2329 // ---------------------------------------------------------------------
2331 unsigned long long FileFd::Tell()
2335 off_t
const Res
= d
->InternalTell();
2336 if (Res
== (off_t
)-1)
2337 FileFdErrno("lseek","Failed to determine the current file position");
2338 d
->set_seekpos(Res
);
2342 static bool StatFileFd(char const * const msg
, int const iFd
, std::string
const &FileName
, struct stat
&Buf
, FileFdPrivate
* const d
) /*{{{*/
2344 bool ispipe
= (d
!= NULL
&& d
->get_is_pipe() == true);
2345 if (ispipe
== false)
2347 if (fstat(iFd
,&Buf
) != 0)
2348 // higher-level code will generate more meaningful messages,
2349 // even translated this would be meaningless for users
2350 return _error
->Errno("fstat", "Unable to determine %s for fd %i", msg
, iFd
);
2351 if (FileName
.empty() == false)
2352 ispipe
= S_ISFIFO(Buf
.st_mode
);
2355 // for compressor pipes st_size is undefined and at 'best' zero
2358 // we set it here, too, as we get the info here for free
2359 // in theory the Open-methods should take care of it already
2361 d
->set_is_pipe(true);
2362 if (stat(FileName
.c_str(), &Buf
) != 0)
2363 return _error
->Errno("fstat", "Unable to determine %s for file %s", msg
, FileName
.c_str());
2368 // FileFd::FileSize - Return the size of the file /*{{{*/
2369 unsigned long long FileFd::FileSize()
2372 if (StatFileFd("file size", iFd
, FileName
, Buf
, d
) == false)
2380 // FileFd::ModificationTime - Return the time of last touch /*{{{*/
2381 time_t FileFd::ModificationTime()
2384 if (StatFileFd("modification time", iFd
, FileName
, Buf
, d
) == false)
2389 return Buf
.st_mtime
;
2392 // FileFd::Size - Return the size of the content in the file /*{{{*/
2393 unsigned long long FileFd::Size()
2397 return d
->InternalSize();
2400 // FileFd::Close - Close the file if the close flag is set /*{{{*/
2401 // ---------------------------------------------------------------------
2403 bool FileFd::Close()
2405 if (Flush() == false)
2411 if ((Flags
& AutoClose
) == AutoClose
)
2413 if ((Flags
& Compressed
) != Compressed
&& iFd
> 0 && close(iFd
) != 0)
2414 Res
&= _error
->Errno("close",_("Problem closing the file %s"), FileName
.c_str());
2419 Res
&= d
->InternalClose(FileName
);
2424 if ((Flags
& Replace
) == Replace
) {
2425 if (rename(TemporaryFileName
.c_str(), FileName
.c_str()) != 0)
2426 Res
&= _error
->Errno("rename",_("Problem renaming the file %s to %s"), TemporaryFileName
.c_str(), FileName
.c_str());
2428 FileName
= TemporaryFileName
; // for the unlink() below.
2429 TemporaryFileName
.clear();
2434 if ((Flags
& Fail
) == Fail
&& (Flags
& DelOnFail
) == DelOnFail
&&
2435 FileName
.empty() == false)
2436 Res
&= RemoveFile("FileFd::Close", FileName
);
2443 // FileFd::Sync - Sync the file /*{{{*/
2444 // ---------------------------------------------------------------------
2448 if (fsync(iFd
) != 0)
2449 return FileFdErrno("sync",_("Problem syncing the file"));
2453 // FileFd::FileFdErrno - set Fail and call _error->Errno *{{{*/
2454 bool FileFd::FileFdErrno(const char *Function
, const char *Description
,...)
2458 size_t msgSize
= 400;
2459 int const errsv
= errno
;
2462 va_start(args
,Description
);
2463 if (_error
->InsertErrno(GlobalError::ERROR
, Function
, Description
, args
, errsv
, msgSize
) == false)
2470 // FileFd::FileFdError - set Fail and call _error->Error *{{{*/
2471 bool FileFd::FileFdError(const char *Description
,...) {
2474 size_t msgSize
= 400;
2477 va_start(args
,Description
);
2478 if (_error
->Insert(GlobalError::ERROR
, Description
, args
, msgSize
) == false)
2485 gzFile
FileFd::gzFd() { /*{{{*/
2487 GzipFileFdPrivate
* const gzipd
= dynamic_cast<GzipFileFdPrivate
*>(d
);
2488 if (gzipd
== nullptr)
2498 // Glob - wrapper around "glob()" /*{{{*/
2499 std::vector
<std::string
> Glob(std::string
const &pattern
, int flags
)
2501 std::vector
<std::string
> result
;
2506 glob_res
= glob(pattern
.c_str(), flags
, NULL
, &globbuf
);
2510 if(glob_res
!= GLOB_NOMATCH
) {
2511 _error
->Errno("glob", "Problem with glob");
2517 for(i
=0;i
<globbuf
.gl_pathc
;i
++)
2518 result
.push_back(string(globbuf
.gl_pathv
[i
]));
2524 std::string
GetTempDir() /*{{{*/
2526 const char *tmpdir
= getenv("TMPDIR");
2534 if (!tmpdir
|| strlen(tmpdir
) == 0 || // tmpdir is set
2535 stat(tmpdir
, &st
) != 0 || (st
.st_mode
& S_IFDIR
) == 0) // exists and is directory
2537 else if (geteuid() != 0 && // root can do everything anyway
2538 faccessat(-1, tmpdir
, R_OK
| W_OK
| X_OK
, AT_EACCESS
| AT_SYMLINK_NOFOLLOW
) != 0) // current user has rwx access to directory
2541 return string(tmpdir
);
2543 std::string
GetTempDir(std::string
const &User
)
2545 // no need/possibility to drop privs
2546 if(getuid() != 0 || User
.empty() || User
== "root")
2547 return GetTempDir();
2549 struct passwd
const * const pw
= getpwnam(User
.c_str());
2551 return GetTempDir();
2553 gid_t
const old_euid
= geteuid();
2554 gid_t
const old_egid
= getegid();
2555 if (setegid(pw
->pw_gid
) != 0)
2556 _error
->Errno("setegid", "setegid %u failed", pw
->pw_gid
);
2557 if (seteuid(pw
->pw_uid
) != 0)
2558 _error
->Errno("seteuid", "seteuid %u failed", pw
->pw_uid
);
2560 std::string
const tmp
= GetTempDir();
2562 if (seteuid(old_euid
) != 0)
2563 _error
->Errno("seteuid", "seteuid %u failed", old_euid
);
2564 if (setegid(old_egid
) != 0)
2565 _error
->Errno("setegid", "setegid %u failed", old_egid
);
2570 FileFd
* GetTempFile(std::string
const &Prefix
, bool ImmediateUnlink
, FileFd
* const TmpFd
) /*{{{*/
2573 FileFd
* const Fd
= TmpFd
== NULL
? new FileFd() : TmpFd
;
2575 std::string
const tempdir
= GetTempDir();
2576 snprintf(fn
, sizeof(fn
), "%s/%s.XXXXXX",
2577 tempdir
.c_str(), Prefix
.c_str());
2578 int const fd
= mkstemp(fn
);
2583 _error
->Errno("GetTempFile",_("Unable to mkstemp %s"), fn
);
2586 if (!Fd
->OpenDescriptor(fd
, FileFd::ReadWrite
, FileFd::None
, true))
2588 _error
->Errno("GetTempFile",_("Unable to write to %s"),fn
);
2594 bool Rename(std::string From
, std::string To
) /*{{{*/
2596 if (rename(From
.c_str(),To
.c_str()) != 0)
2598 _error
->Error(_("rename failed, %s (%s -> %s)."),strerror(errno
),
2599 From
.c_str(),To
.c_str());
2605 bool Popen(const char* Args
[], FileFd
&Fd
, pid_t
&Child
, FileFd::OpenMode Mode
)/*{{{*/
2608 if (Mode
!= FileFd::ReadOnly
&& Mode
!= FileFd::WriteOnly
)
2609 return _error
->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2611 int Pipe
[2] = {-1, -1};
2613 return _error
->Errno("pipe", _("Failed to create subprocess IPC"));
2615 std::set
<int> keep_fds
;
2616 keep_fds
.insert(Pipe
[0]);
2617 keep_fds
.insert(Pipe
[1]);
2618 Child
= ExecFork(keep_fds
);
2620 return _error
->Errno("fork", "Failed to fork");
2623 if(Mode
== FileFd::ReadOnly
)
2628 else if(Mode
== FileFd::WriteOnly
)
2634 if(Mode
== FileFd::ReadOnly
)
2638 } else if(Mode
== FileFd::WriteOnly
)
2641 execv(Args
[0], (char**)Args
);
2644 if(Mode
== FileFd::ReadOnly
)
2649 else if(Mode
== FileFd::WriteOnly
)
2655 return _error
->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2656 Fd
.OpenDescriptor(fd
, Mode
, FileFd::None
, true);
2661 bool DropPrivileges() /*{{{*/
2663 if(_config
->FindB("Debug::NoDropPrivs", false) == true)
2667 #if defined(PR_SET_NO_NEW_PRIVS) && ( PR_SET_NO_NEW_PRIVS != 38 )
2668 #error "PR_SET_NO_NEW_PRIVS is defined, but with a different value than expected!"
2670 // see prctl(2), needs linux3.5 at runtime - magic constant to avoid it at buildtime
2671 int ret
= prctl(38, 1, 0, 0, 0);
2672 // ignore EINVAL - kernel is too old to understand the option
2673 if(ret
< 0 && errno
!= EINVAL
)
2674 _error
->Warning("PR_SET_NO_NEW_PRIVS failed with %i", ret
);
2677 // empty setting disables privilege dropping - this also ensures
2678 // backward compatibility, see bug #764506
2679 const std::string toUser
= _config
->Find("APT::Sandbox::User");
2680 if (toUser
.empty() || toUser
== "root")
2683 // a lot can go wrong trying to drop privileges completely,
2684 // so ideally we would like to verify that we have done it –
2685 // but the verify asks for too much in case of fakeroot (and alike)
2686 // [Specific checks can be overridden with dedicated options]
2687 bool const VerifySandboxing
= _config
->FindB("APT::Sandbox::Verify", false);
2689 // uid will be 0 in the end, but gid might be different anyway
2690 uid_t
const old_uid
= getuid();
2691 gid_t
const old_gid
= getgid();
2696 struct passwd
*pw
= getpwnam(toUser
.c_str());
2698 return _error
->Error("No user %s, can not drop rights", toUser
.c_str());
2700 // Do not change the order here, it might break things
2701 // Get rid of all our supplementary groups first
2702 if (setgroups(1, &pw
->pw_gid
))
2703 return _error
->Errno("setgroups", "Failed to setgroups");
2705 // Now change the group ids to the new user
2706 #ifdef HAVE_SETRESGID
2707 if (setresgid(pw
->pw_gid
, pw
->pw_gid
, pw
->pw_gid
) != 0)
2708 return _error
->Errno("setresgid", "Failed to set new group ids");
2710 if (setegid(pw
->pw_gid
) != 0)
2711 return _error
->Errno("setegid", "Failed to setegid");
2713 if (setgid(pw
->pw_gid
) != 0)
2714 return _error
->Errno("setgid", "Failed to setgid");
2717 // Change the user ids to the new user
2718 #ifdef HAVE_SETRESUID
2719 if (setresuid(pw
->pw_uid
, pw
->pw_uid
, pw
->pw_uid
) != 0)
2720 return _error
->Errno("setresuid", "Failed to set new user ids");
2722 if (setuid(pw
->pw_uid
) != 0)
2723 return _error
->Errno("setuid", "Failed to setuid");
2724 if (seteuid(pw
->pw_uid
) != 0)
2725 return _error
->Errno("seteuid", "Failed to seteuid");
2728 // disabled by default as fakeroot doesn't implement getgroups currently (#806521)
2729 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::Groups", false) == true)
2731 // Verify that the user isn't still in any supplementary groups
2732 long const ngroups_max
= sysconf(_SC_NGROUPS_MAX
);
2733 std::unique_ptr
<gid_t
[]> gidlist(new gid_t
[ngroups_max
]);
2734 if (unlikely(gidlist
== NULL
))
2735 return _error
->Error("Allocation of a list of size %lu for getgroups failed", ngroups_max
);
2737 if ((gidlist_nr
= getgroups(ngroups_max
, gidlist
.get())) < 0)
2738 return _error
->Errno("getgroups", "Could not get new groups (%lu)", ngroups_max
);
2739 for (ssize_t i
= 0; i
< gidlist_nr
; ++i
)
2740 if (gidlist
[i
] != pw
->pw_gid
)
2741 return _error
->Error("Could not switch group, user %s is still in group %d", toUser
.c_str(), gidlist
[i
]);
2744 // enabled by default as all fakeroot-lookalikes should fake that accordingly
2745 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::IDs", true) == true)
2747 // Verify that gid, egid, uid, and euid changed
2748 if (getgid() != pw
->pw_gid
)
2749 return _error
->Error("Could not switch group");
2750 if (getegid() != pw
->pw_gid
)
2751 return _error
->Error("Could not switch effective group");
2752 if (getuid() != pw
->pw_uid
)
2753 return _error
->Error("Could not switch user");
2754 if (geteuid() != pw
->pw_uid
)
2755 return _error
->Error("Could not switch effective user");
2757 #ifdef HAVE_GETRESUID
2758 // verify that the saved set-user-id was changed as well
2762 if (getresuid(&ruid
, &euid
, &suid
))
2763 return _error
->Errno("getresuid", "Could not get saved set-user-ID");
2764 if (suid
!= pw
->pw_uid
)
2765 return _error
->Error("Could not switch saved set-user-ID");
2768 #ifdef HAVE_GETRESGID
2769 // verify that the saved set-group-id was changed as well
2773 if (getresgid(&rgid
, &egid
, &sgid
))
2774 return _error
->Errno("getresuid", "Could not get saved set-group-ID");
2775 if (sgid
!= pw
->pw_gid
)
2776 return _error
->Error("Could not switch saved set-group-ID");
2780 // disabled as fakeroot doesn't forbid (by design) (re)gaining root from unprivileged
2781 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::Regain", false) == true)
2783 // Check that uid and gid changes do not work anymore
2784 if (pw
->pw_gid
!= old_gid
&& (setgid(old_gid
) != -1 || setegid(old_gid
) != -1))
2785 return _error
->Error("Could restore a gid to root, privilege dropping did not work");
2787 if (pw
->pw_uid
!= old_uid
&& (setuid(old_uid
) != -1 || seteuid(old_uid
) != -1))
2788 return _error
->Error("Could restore a uid to root, privilege dropping did not work");