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 const char *getend() const { return buffer
+ bufferend
; }
938 char *getend() { return buffer
+ bufferend
; }
939 bool empty() const { return bufferend
<= bufferstart
; }
940 bool full() const { return bufferend
== buffersize_max
; }
941 unsigned long long free() const { return buffersize_max
- bufferend
; }
942 unsigned long long size() const { return bufferend
-bufferstart
; }
943 void reset(size_t size
)
945 if (size
> buffersize_max
) {
947 buffersize_max
= size
;
948 buffer
= new char[size
];
952 void reset() { bufferend
= bufferstart
= 0; }
953 ssize_t
read(void *to
, unsigned long long requested_size
) APT_MUSTCHECK
955 if (size() < requested_size
)
956 requested_size
= size();
957 memcpy(to
, buffer
+ bufferstart
, requested_size
);
958 bufferstart
+= requested_size
;
959 if (bufferstart
== bufferend
)
960 bufferstart
= bufferend
= 0;
961 return requested_size
;
963 ssize_t
write(const void *from
, unsigned long long requested_size
) APT_MUSTCHECK
965 if (buffersize_max
- size() < requested_size
)
966 requested_size
= buffersize_max
- size();
967 memcpy(buffer
+ bufferend
, from
, requested_size
);
968 bufferend
+= requested_size
;
969 if (bufferstart
== bufferend
)
970 bufferstart
= bufferend
= 0;
971 return requested_size
;
976 class APT_HIDDEN FileFdPrivate
{ /*{{{*/
977 friend class BufferedWriteFileFdPrivate
;
979 FileFd
* const filefd
;
980 simple_buffer buffer
;
982 pid_t compressor_pid
;
984 APT::Configuration::Compressor compressor
;
985 unsigned int openmode
;
986 unsigned long long seekpos
;
989 explicit FileFdPrivate(FileFd
* const pfilefd
) : filefd(pfilefd
),
990 compressed_fd(-1), compressor_pid(-1), is_pipe(false),
991 openmode(0), seekpos(0) {};
992 virtual APT::Configuration::Compressor
get_compressor() const
996 virtual void set_compressor(APT::Configuration::Compressor
const &compressor
)
998 this->compressor
= compressor
;
1000 virtual unsigned int get_openmode() const
1004 virtual void set_openmode(unsigned int openmode
)
1006 this->openmode
= openmode
;
1008 virtual bool get_is_pipe() const
1012 virtual void set_is_pipe(bool is_pipe
)
1014 this->is_pipe
= is_pipe
;
1016 virtual unsigned long long get_seekpos() const
1020 virtual void set_seekpos(unsigned long long seekpos
)
1022 this->seekpos
= seekpos
;
1025 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) = 0;
1026 ssize_t
InternalRead(void * To
, unsigned long long Size
)
1028 // Drain the buffer if needed.
1029 if (buffer
.empty() == false)
1031 return buffer
.read(To
, Size
);
1033 return InternalUnbufferedRead(To
, Size
);
1035 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) = 0;
1036 virtual bool InternalReadError() { return filefd
->FileFdErrno("read",_("Read error")); }
1037 virtual char * InternalReadLine(char * To
, unsigned long long Size
)
1039 if (unlikely(Size
== 0))
1041 // Read one byte less than buffer size to have space for trailing 0.
1044 char * const InitialTo
= To
;
1047 if (buffer
.empty() == true)
1050 unsigned long long actualread
= 0;
1051 if (filefd
->Read(buffer
.get(), buffer
.buffersize_max
, &actualread
) == false)
1053 buffer
.bufferend
= actualread
;
1054 if (buffer
.size() == 0)
1056 if (To
== InitialTo
)
1060 filefd
->Flags
&= ~FileFd::HitEof
;
1063 unsigned long long const OutputSize
= std::min(Size
, buffer
.size());
1064 char const * const newline
= static_cast<char const * const>(memchr(buffer
.get(), '\n', OutputSize
));
1065 // Read until end of line or up to Size bytes from the buffer.
1066 unsigned long long actualread
= buffer
.read(To
,
1067 (newline
!= nullptr)
1068 ? (newline
- buffer
.get()) + 1
1072 if (newline
!= nullptr)
1078 virtual bool InternalFlush()
1082 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) = 0;
1083 virtual bool InternalWriteError() { return filefd
->FileFdErrno("write",_("Write error")); }
1084 virtual bool InternalSeek(unsigned long long const To
)
1086 // Our poor man seeking is costly, so try to avoid it
1087 unsigned long long const iseekpos
= filefd
->Tell();
1090 else if (iseekpos
< To
)
1091 return filefd
->Skip(To
- iseekpos
);
1093 if ((openmode
& FileFd::ReadOnly
) != FileFd::ReadOnly
)
1094 return filefd
->FileFdError("Reopen is only implemented for read-only files!");
1095 InternalClose(filefd
->FileName
);
1096 if (filefd
->iFd
!= -1)
1099 if (filefd
->TemporaryFileName
.empty() == false)
1100 filefd
->iFd
= open(filefd
->TemporaryFileName
.c_str(), O_RDONLY
);
1101 else if (filefd
->FileName
.empty() == false)
1102 filefd
->iFd
= open(filefd
->FileName
.c_str(), O_RDONLY
);
1105 if (compressed_fd
> 0)
1106 if (lseek(compressed_fd
, 0, SEEK_SET
) != 0)
1107 filefd
->iFd
= compressed_fd
;
1108 if (filefd
->iFd
< 0)
1109 return filefd
->FileFdError("Reopen is not implemented for pipes opened with FileFd::OpenDescriptor()!");
1112 if (filefd
->OpenInternDescriptor(openmode
, compressor
) == false)
1113 return filefd
->FileFdError("Seek on file %s because it couldn't be reopened", filefd
->FileName
.c_str());
1117 return filefd
->Skip(To
);
1122 virtual bool InternalSkip(unsigned long long Over
)
1124 unsigned long long constexpr buffersize
= 1024;
1125 char buffer
[buffersize
];
1128 unsigned long long toread
= std::min(buffersize
, Over
);
1129 if (filefd
->Read(buffer
, toread
) == false)
1130 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
1135 virtual bool InternalTruncate(unsigned long long const)
1137 return filefd
->FileFdError("Truncating compressed files is not implemented (%s)", filefd
->FileName
.c_str());
1139 virtual unsigned long long InternalTell()
1141 // In theory, we could just return seekpos here always instead of
1142 // seeking around, but not all users of FileFd use always Seek() and co
1143 // so d->seekpos isn't always true and we can just use it as a hint if
1144 // we have nothing else, but not always as an authority…
1145 return seekpos
- buffer
.size();
1147 virtual unsigned long long InternalSize()
1149 unsigned long long size
= 0;
1150 unsigned long long const oldSeek
= filefd
->Tell();
1151 unsigned long long constexpr ignoresize
= 1024;
1152 char ignore
[ignoresize
];
1153 unsigned long long read
= 0;
1155 if (filefd
->Read(ignore
, ignoresize
, &read
) == false)
1157 filefd
->Seek(oldSeek
);
1161 size
= filefd
->Tell();
1162 filefd
->Seek(oldSeek
);
1165 virtual bool InternalClose(std::string
const &FileName
) = 0;
1166 virtual bool InternalStream() const { return false; }
1167 virtual bool InternalAlwaysAutoClose() const { return true; }
1169 virtual ~FileFdPrivate() {}
1172 class APT_HIDDEN BufferedWriteFileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1174 FileFdPrivate
*wrapped
;
1175 simple_buffer writebuffer
;
1179 explicit BufferedWriteFileFdPrivate(FileFdPrivate
*Priv
) :
1180 FileFdPrivate(Priv
->filefd
), wrapped(Priv
) {};
1182 virtual APT::Configuration::Compressor
get_compressor() const override
1184 return wrapped
->get_compressor();
1186 virtual void set_compressor(APT::Configuration::Compressor
const &compressor
) override
1188 return wrapped
->set_compressor(compressor
);
1190 virtual unsigned int get_openmode() const override
1192 return wrapped
->get_openmode();
1194 virtual void set_openmode(unsigned int openmode
) override
1196 return wrapped
->set_openmode(openmode
);
1198 virtual bool get_is_pipe() const override
1200 return wrapped
->get_is_pipe();
1202 virtual void set_is_pipe(bool is_pipe
) override
1204 FileFdPrivate::set_is_pipe(is_pipe
);
1205 wrapped
->set_is_pipe(is_pipe
);
1207 virtual unsigned long long get_seekpos() const override
1209 return wrapped
->get_seekpos();
1211 virtual void set_seekpos(unsigned long long seekpos
) override
1213 return wrapped
->set_seekpos(seekpos
);
1215 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1217 if (InternalFlush() == false)
1219 return wrapped
->InternalOpen(iFd
, Mode
);
1221 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1223 if (InternalFlush() == false)
1225 return wrapped
->InternalUnbufferedRead(To
, Size
);
1228 virtual bool InternalReadError() override
1230 return wrapped
->InternalReadError();
1232 virtual char * InternalReadLine(char * To
, unsigned long long Size
) override
1234 if (InternalFlush() == false)
1236 return wrapped
->InternalReadLine(To
, Size
);
1238 virtual bool InternalFlush() override
1240 while (writebuffer
.empty() == false) {
1241 auto written
= wrapped
->InternalWrite(writebuffer
.get(),
1242 writebuffer
.size());
1243 // Ignore interrupted syscalls
1244 if (written
< 0 && errno
== EINTR
)
1249 writebuffer
.bufferstart
+= written
;
1252 writebuffer
.reset();
1255 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1259 while (written
< Size
) {
1260 auto buffered
= writebuffer
.write(static_cast<char const*>(From
) + written
, Size
- written
);
1262 written
+= buffered
;
1264 if (writebuffer
.full() && InternalFlush() == false)
1270 virtual bool InternalWriteError()
1272 return wrapped
->InternalWriteError();
1274 virtual bool InternalSeek(unsigned long long const To
)
1276 if (InternalFlush() == false)
1278 return wrapped
->InternalSeek(To
);
1280 virtual bool InternalSkip(unsigned long long Over
)
1282 if (InternalFlush() == false)
1284 return wrapped
->InternalSkip(Over
);
1286 virtual bool InternalTruncate(unsigned long long const Size
)
1288 if (InternalFlush() == false)
1290 return wrapped
->InternalTruncate(Size
);
1292 virtual unsigned long long InternalTell()
1294 if (InternalFlush() == false)
1296 return wrapped
->InternalTell();
1298 virtual unsigned long long InternalSize()
1300 if (InternalFlush() == false)
1302 return wrapped
->InternalSize();
1304 virtual bool InternalClose(std::string
const &FileName
)
1306 return wrapped
->InternalClose(FileName
);
1308 virtual bool InternalAlwaysAutoClose() const
1310 return wrapped
->InternalAlwaysAutoClose();
1312 virtual ~BufferedWriteFileFdPrivate()
1318 class APT_HIDDEN GzipFileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1322 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1324 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1325 gz
= gzdopen(iFd
, "r+");
1326 else if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1327 gz
= gzdopen(iFd
, "w");
1329 gz
= gzdopen(iFd
, "r");
1330 filefd
->Flags
|= FileFd::Compressed
;
1331 return gz
!= nullptr;
1333 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1335 return gzread(gz
, To
, Size
);
1337 virtual bool InternalReadError() override
1340 char const * const errmsg
= gzerror(gz
, &err
);
1342 return filefd
->FileFdError("gzread: %s (%d: %s)", _("Read error"), err
, errmsg
);
1343 return FileFdPrivate::InternalReadError();
1345 virtual char * InternalReadLine(char * To
, unsigned long long Size
) override
1347 return gzgets(gz
, To
, Size
);
1349 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1351 return gzwrite(gz
,From
,Size
);
1353 virtual bool InternalWriteError() override
1356 char const * const errmsg
= gzerror(gz
, &err
);
1358 return filefd
->FileFdError("gzwrite: %s (%d: %s)", _("Write error"), err
, errmsg
);
1359 return FileFdPrivate::InternalWriteError();
1361 virtual bool InternalSeek(unsigned long long const To
) override
1363 off_t
const res
= gzseek(gz
, To
, SEEK_SET
);
1364 if (res
!= (off_t
)To
)
1365 return filefd
->FileFdError("Unable to seek to %llu", To
);
1370 virtual bool InternalSkip(unsigned long long Over
) override
1372 if (Over
>= buffer
.size())
1374 Over
-= buffer
.size();
1379 buffer
.bufferstart
+= Over
;
1384 off_t
const res
= gzseek(gz
, Over
, SEEK_CUR
);
1386 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
1390 virtual unsigned long long InternalTell() override
1392 return gztell(gz
) - buffer
.size();
1394 virtual unsigned long long InternalSize() override
1396 unsigned long long filesize
= FileFdPrivate::InternalSize();
1397 // only check gzsize if we are actually a gzip file, just checking for
1398 // "gz" is not sufficient as uncompressed files could be opened with
1399 // gzopen in "direct" mode as well
1400 if (filesize
== 0 || gzdirect(gz
))
1403 off_t
const oldPos
= lseek(filefd
->iFd
, 0, SEEK_CUR
);
1404 /* unfortunately zlib.h doesn't provide a gzsize(), so we have to do
1405 * this ourselves; the original (uncompressed) file size is the last 32
1406 * bits of the file */
1407 // FIXME: Size for gz-files is limited by 32bit… no largefile support
1408 if (lseek(filefd
->iFd
, -4, SEEK_END
) < 0)
1410 filefd
->FileFdErrno("lseek","Unable to seek to end of gzipped file");
1414 if (read(filefd
->iFd
, &size
, 4) != 4)
1416 filefd
->FileFdErrno("read","Unable to read original size of gzipped file");
1419 size
= le32toh(size
);
1421 if (lseek(filefd
->iFd
, oldPos
, SEEK_SET
) < 0)
1423 filefd
->FileFdErrno("lseek","Unable to seek in gzipped file");
1428 virtual bool InternalClose(std::string
const &FileName
) override
1432 int const e
= gzclose(gz
);
1434 // gzdclose() on empty files always fails with "buffer error" here, ignore that
1435 if (e
!= 0 && e
!= Z_BUF_ERROR
)
1436 return _error
->Errno("close",_("Problem closing the gzip file %s"), FileName
.c_str());
1440 explicit GzipFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), gz(nullptr) {}
1441 virtual ~GzipFileFdPrivate() { InternalClose(""); }
1445 class APT_HIDDEN Bz2FileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1449 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1451 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1452 bz2
= BZ2_bzdopen(iFd
, "r+");
1453 else if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1454 bz2
= BZ2_bzdopen(iFd
, "w");
1456 bz2
= BZ2_bzdopen(iFd
, "r");
1457 filefd
->Flags
|= FileFd::Compressed
;
1458 return bz2
!= nullptr;
1460 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1462 return BZ2_bzread(bz2
, To
, Size
);
1464 virtual bool InternalReadError() override
1467 char const * const errmsg
= BZ2_bzerror(bz2
, &err
);
1468 if (err
!= BZ_IO_ERROR
)
1469 return filefd
->FileFdError("BZ2_bzread: %s %s (%d: %s)", filefd
->FileName
.c_str(), _("Read error"), err
, errmsg
);
1470 return FileFdPrivate::InternalReadError();
1472 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1474 return BZ2_bzwrite(bz2
, (void*)From
, Size
);
1476 virtual bool InternalWriteError() override
1479 char const * const errmsg
= BZ2_bzerror(bz2
, &err
);
1480 if (err
!= BZ_IO_ERROR
)
1481 return filefd
->FileFdError("BZ2_bzwrite: %s %s (%d: %s)", filefd
->FileName
.c_str(), _("Write error"), err
, errmsg
);
1482 return FileFdPrivate::InternalWriteError();
1484 virtual bool InternalStream() const override
{ return true; }
1485 virtual bool InternalClose(std::string
const &) override
1494 explicit Bz2FileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), bz2(nullptr) {}
1495 virtual ~Bz2FileFdPrivate() { InternalClose(""); }
1499 class APT_HIDDEN LzmaFileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1503 uint8_t buffer
[4096];
1509 LZMAFILE() : file(nullptr), eof(false), compressing(false) { buffer
[0] = '\0'; }
1512 if (compressing
== true)
1514 size_t constexpr buffersize
= sizeof(buffer
)/sizeof(buffer
[0]);
1517 stream
.avail_out
= buffersize
;
1518 stream
.next_out
= buffer
;
1519 err
= lzma_code(&stream
, LZMA_FINISH
);
1520 if (err
!= LZMA_OK
&& err
!= LZMA_STREAM_END
)
1522 _error
->Error("~LZMAFILE: Compress finalisation failed");
1525 size_t const n
= buffersize
- stream
.avail_out
;
1526 if (n
&& fwrite(buffer
, 1, n
, file
) != n
)
1528 _error
->Errno("~LZMAFILE",_("Write error"));
1531 if (err
== LZMA_STREAM_END
)
1540 static uint32_t findXZlevel(std::vector
<std::string
> const &Args
)
1542 for (auto a
= Args
.rbegin(); a
!= Args
.rend(); ++a
)
1543 if (a
->empty() == false && (*a
)[0] == '-' && (*a
)[1] != '-')
1545 auto const number
= a
->find_last_of("0123456789");
1546 if (number
== std::string::npos
)
1548 auto const extreme
= a
->find("e", number
);
1549 uint32_t level
= (extreme
!= std::string::npos
) ? LZMA_PRESET_EXTREME
: 0;
1550 switch ((*a
)[number
])
1552 case '0': return level
| 0;
1553 case '1': return level
| 1;
1554 case '2': return level
| 2;
1555 case '3': return level
| 3;
1556 case '4': return level
| 4;
1557 case '5': return level
| 5;
1558 case '6': return level
| 6;
1559 case '7': return level
| 7;
1560 case '8': return level
| 8;
1561 case '9': return level
| 9;
1567 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1569 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1570 return filefd
->FileFdError("ReadWrite mode is not supported for lzma/xz files %s", filefd
->FileName
.c_str());
1572 if (lzma
== nullptr)
1573 lzma
= new LzmaFileFdPrivate::LZMAFILE
;
1574 if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1575 lzma
->file
= fdopen(iFd
, "w");
1577 lzma
->file
= fdopen(iFd
, "r");
1578 filefd
->Flags
|= FileFd::Compressed
;
1579 if (lzma
->file
== nullptr)
1582 lzma_stream tmp_stream
= LZMA_STREAM_INIT
;
1583 lzma
->stream
= tmp_stream
;
1585 if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1587 uint32_t const xzlevel
= findXZlevel(compressor
.CompressArgs
);
1588 if (compressor
.Name
== "xz")
1590 if (lzma_easy_encoder(&lzma
->stream
, xzlevel
, LZMA_CHECK_CRC64
) != LZMA_OK
)
1595 lzma_options_lzma options
;
1596 lzma_lzma_preset(&options
, xzlevel
);
1597 if (lzma_alone_encoder(&lzma
->stream
, &options
) != LZMA_OK
)
1600 lzma
->compressing
= true;
1604 uint64_t const memlimit
= UINT64_MAX
;
1605 if (compressor
.Name
== "xz")
1607 if (lzma_auto_decoder(&lzma
->stream
, memlimit
, 0) != LZMA_OK
)
1612 if (lzma_alone_decoder(&lzma
->stream
, memlimit
) != LZMA_OK
)
1615 lzma
->compressing
= false;
1619 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1622 if (lzma
->eof
== true)
1625 lzma
->stream
.next_out
= (uint8_t *) To
;
1626 lzma
->stream
.avail_out
= Size
;
1627 if (lzma
->stream
.avail_in
== 0)
1629 lzma
->stream
.next_in
= lzma
->buffer
;
1630 lzma
->stream
.avail_in
= fread(lzma
->buffer
, 1, sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]), lzma
->file
);
1632 lzma
->err
= lzma_code(&lzma
->stream
, LZMA_RUN
);
1633 if (lzma
->err
== LZMA_STREAM_END
)
1636 Res
= Size
- lzma
->stream
.avail_out
;
1638 else if (lzma
->err
!= LZMA_OK
)
1645 Res
= Size
- lzma
->stream
.avail_out
;
1648 // lzma run was okay, but produced no output…
1655 virtual bool InternalReadError() override
1657 return filefd
->FileFdError("lzma_read: %s (%d)", _("Read error"), lzma
->err
);
1659 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1661 lzma
->stream
.next_in
= (uint8_t *)From
;
1662 lzma
->stream
.avail_in
= Size
;
1663 lzma
->stream
.next_out
= lzma
->buffer
;
1664 lzma
->stream
.avail_out
= sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]);
1665 lzma
->err
= lzma_code(&lzma
->stream
, LZMA_RUN
);
1666 if (lzma
->err
!= LZMA_OK
)
1668 size_t const n
= sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]) - lzma
->stream
.avail_out
;
1669 size_t const m
= (n
== 0) ? 0 : fwrite(lzma
->buffer
, 1, n
, lzma
->file
);
1673 return Size
- lzma
->stream
.avail_in
;
1675 virtual bool InternalWriteError() override
1677 return filefd
->FileFdError("lzma_write: %s (%d)", _("Write error"), lzma
->err
);
1679 virtual bool InternalStream() const override
{ return true; }
1680 virtual bool InternalClose(std::string
const &) override
1687 explicit LzmaFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), lzma(nullptr) {}
1688 virtual ~LzmaFileFdPrivate() { InternalClose(""); }
1692 class APT_HIDDEN PipedFileFdPrivate
: public FileFdPrivate
/*{{{*/
1693 /* if we don't have a specific class dealing with library calls, we (un)compress
1694 by executing a specified binary and pipe in/out what we need */
1697 virtual bool InternalOpen(int const, unsigned int const Mode
) override
1699 // collect zombies here in case we reopen
1700 if (compressor_pid
> 0)
1701 ExecWait(compressor_pid
, "FileFdCompressor", true);
1703 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1704 return filefd
->FileFdError("ReadWrite mode is not supported for file %s", filefd
->FileName
.c_str());
1706 bool const Comp
= (Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
;
1709 // Handle 'decompression' of empty files
1711 fstat(filefd
->iFd
, &Buf
);
1712 if (Buf
.st_size
== 0 && S_ISFIFO(Buf
.st_mode
) == false)
1715 // We don't need the file open - instead let the compressor open it
1716 // as he properly knows better how to efficiently read from 'his' file
1717 if (filefd
->FileName
.empty() == false)
1724 // Create a data pipe
1725 int Pipe
[2] = {-1,-1};
1726 if (pipe(Pipe
) != 0)
1727 return filefd
->FileFdErrno("pipe",_("Failed to create subprocess IPC"));
1728 for (int J
= 0; J
!= 2; J
++)
1729 SetCloseExec(Pipe
[J
],true);
1731 compressed_fd
= filefd
->iFd
;
1735 filefd
->iFd
= Pipe
[1];
1737 filefd
->iFd
= Pipe
[0];
1740 compressor_pid
= ExecFork();
1741 if (compressor_pid
== 0)
1745 dup2(compressed_fd
,STDOUT_FILENO
);
1746 dup2(Pipe
[0],STDIN_FILENO
);
1750 if (compressed_fd
!= -1)
1751 dup2(compressed_fd
,STDIN_FILENO
);
1752 dup2(Pipe
[1],STDOUT_FILENO
);
1754 int const nullfd
= open("/dev/null", O_WRONLY
);
1757 dup2(nullfd
,STDERR_FILENO
);
1761 SetCloseExec(STDOUT_FILENO
,false);
1762 SetCloseExec(STDIN_FILENO
,false);
1764 std::vector
<char const*> Args
;
1765 Args
.push_back(compressor
.Binary
.c_str());
1766 std::vector
<std::string
> const * const addArgs
=
1767 (Comp
== true) ? &(compressor
.CompressArgs
) : &(compressor
.UncompressArgs
);
1768 for (std::vector
<std::string
>::const_iterator a
= addArgs
->begin();
1769 a
!= addArgs
->end(); ++a
)
1770 Args
.push_back(a
->c_str());
1771 if (Comp
== false && filefd
->FileName
.empty() == false)
1773 // commands not needing arguments, do not need to be told about using standard output
1774 // in reality, only testcases with tools like cat, rev, rot13, … are able to trigger this
1775 if (compressor
.CompressArgs
.empty() == false && compressor
.UncompressArgs
.empty() == false)
1776 Args
.push_back("--stdout");
1777 if (filefd
->TemporaryFileName
.empty() == false)
1778 Args
.push_back(filefd
->TemporaryFileName
.c_str());
1780 Args
.push_back(filefd
->FileName
.c_str());
1782 Args
.push_back(NULL
);
1784 execvp(Args
[0],(char **)&Args
[0]);
1785 cerr
<< _("Failed to exec compressor ") << Args
[0] << endl
;
1795 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1797 return read(filefd
->iFd
, To
, Size
);
1799 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1801 return write(filefd
->iFd
, From
, Size
);
1803 virtual bool InternalClose(std::string
const &) override
1806 if (compressor_pid
> 0)
1807 Ret
&= ExecWait(compressor_pid
, "FileFdCompressor", true);
1808 compressor_pid
= -1;
1811 explicit PipedFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
) {}
1812 virtual ~PipedFileFdPrivate() { InternalClose(""); }
1815 class APT_HIDDEN DirectFileFdPrivate
: public FileFdPrivate
/*{{{*/
1818 virtual bool InternalOpen(int const, unsigned int const) override
{ return true; }
1819 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1821 return read(filefd
->iFd
, To
, Size
);
1823 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1825 // files opened read+write are strange and only really "supported" for direct files
1826 if (buffer
.size() != 0)
1828 lseek(filefd
->iFd
, -buffer
.size(), SEEK_CUR
);
1831 return write(filefd
->iFd
, From
, Size
);
1833 virtual bool InternalSeek(unsigned long long const To
) override
1835 off_t
const res
= lseek(filefd
->iFd
, To
, SEEK_SET
);
1836 if (res
!= (off_t
)To
)
1837 return filefd
->FileFdError("Unable to seek to %llu", To
);
1842 virtual bool InternalSkip(unsigned long long Over
) override
1844 if (Over
>= buffer
.size())
1846 Over
-= buffer
.size();
1851 buffer
.bufferstart
+= Over
;
1856 off_t
const res
= lseek(filefd
->iFd
, Over
, SEEK_CUR
);
1858 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
1862 virtual bool InternalTruncate(unsigned long long const To
) override
1864 if (buffer
.size() != 0)
1866 unsigned long long const seekpos
= lseek(filefd
->iFd
, 0, SEEK_CUR
);
1867 if ((seekpos
- buffer
.size()) >= To
)
1869 else if (seekpos
>= To
)
1870 buffer
.bufferend
= (To
- seekpos
) + buffer
.bufferstart
;
1874 if (ftruncate(filefd
->iFd
, To
) != 0)
1875 return filefd
->FileFdError("Unable to truncate to %llu",To
);
1878 virtual unsigned long long InternalTell() override
1880 return lseek(filefd
->iFd
,0,SEEK_CUR
) - buffer
.size();
1882 virtual unsigned long long InternalSize() override
1884 return filefd
->FileSize();
1886 virtual bool InternalClose(std::string
const &) override
{ return true; }
1887 virtual bool InternalAlwaysAutoClose() const override
{ return false; }
1889 explicit DirectFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
) {}
1890 virtual ~DirectFileFdPrivate() { InternalClose(""); }
1893 // FileFd Constructors /*{{{*/
1894 FileFd::FileFd(std::string FileName
,unsigned int const Mode
,unsigned long AccessMode
) : iFd(-1), Flags(0), d(NULL
)
1896 Open(FileName
,Mode
, None
, AccessMode
);
1898 FileFd::FileFd(std::string FileName
,unsigned int const Mode
, CompressMode Compress
, unsigned long AccessMode
) : iFd(-1), Flags(0), d(NULL
)
1900 Open(FileName
,Mode
, Compress
, AccessMode
);
1902 FileFd::FileFd() : iFd(-1), Flags(AutoClose
), d(NULL
) {}
1903 FileFd::FileFd(int const Fd
, unsigned int const Mode
, CompressMode Compress
) : iFd(-1), Flags(0), d(NULL
)
1905 OpenDescriptor(Fd
, Mode
, Compress
);
1907 FileFd::FileFd(int const Fd
, bool const AutoClose
) : iFd(-1), Flags(0), d(NULL
)
1909 OpenDescriptor(Fd
, ReadWrite
, None
, AutoClose
);
1912 // FileFd::Open - Open a file /*{{{*/
1913 // ---------------------------------------------------------------------
1914 /* The most commonly used open mode combinations are given with Mode */
1915 bool FileFd::Open(string FileName
,unsigned int const Mode
,CompressMode Compress
, unsigned long const AccessMode
)
1917 if (Mode
== ReadOnlyGzip
)
1918 return Open(FileName
, ReadOnly
, Gzip
, AccessMode
);
1920 if (Compress
== Auto
&& (Mode
& WriteOnly
) == WriteOnly
)
1921 return FileFdError("Autodetection on %s only works in ReadOnly openmode!", FileName
.c_str());
1923 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
1924 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
1925 if (Compress
== Auto
)
1927 for (; compressor
!= compressors
.end(); ++compressor
)
1929 std::string file
= FileName
+ compressor
->Extension
;
1930 if (FileExists(file
) == false)
1936 else if (Compress
== Extension
)
1938 std::string::size_type
const found
= FileName
.find_last_of('.');
1940 if (found
!= std::string::npos
)
1942 ext
= FileName
.substr(found
);
1943 if (ext
== ".new" || ext
== ".bak")
1945 std::string::size_type
const found2
= FileName
.find_last_of('.', found
- 1);
1946 if (found2
!= std::string::npos
)
1947 ext
= FileName
.substr(found2
, found
- found2
);
1952 for (; compressor
!= compressors
.end(); ++compressor
)
1953 if (ext
== compressor
->Extension
)
1955 // no matching extension - assume uncompressed (imagine files like 'example.org_Packages')
1956 if (compressor
== compressors
.end())
1957 for (compressor
= compressors
.begin(); compressor
!= compressors
.end(); ++compressor
)
1958 if (compressor
->Name
== ".")
1966 case None
: name
= "."; break;
1967 case Gzip
: name
= "gzip"; break;
1968 case Bzip2
: name
= "bzip2"; break;
1969 case Lzma
: name
= "lzma"; break;
1970 case Xz
: name
= "xz"; break;
1974 return FileFdError("Opening File %s in None, Auto or Extension should be already handled?!?", FileName
.c_str());
1976 for (; compressor
!= compressors
.end(); ++compressor
)
1977 if (compressor
->Name
== name
)
1979 if (compressor
== compressors
.end())
1980 return FileFdError("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
1983 if (compressor
== compressors
.end())
1984 return FileFdError("Can't find a match for specified compressor mode for file %s", FileName
.c_str());
1985 return Open(FileName
, Mode
, *compressor
, AccessMode
);
1987 bool FileFd::Open(string FileName
,unsigned int const Mode
,APT::Configuration::Compressor
const &compressor
, unsigned long const AccessMode
)
1992 if ((Mode
& WriteOnly
) != WriteOnly
&& (Mode
& (Atomic
| Create
| Empty
| Exclusive
)) != 0)
1993 return FileFdError("ReadOnly mode for %s doesn't accept additional flags!", FileName
.c_str());
1994 if ((Mode
& ReadWrite
) == 0)
1995 return FileFdError("No openmode provided in FileFd::Open for %s", FileName
.c_str());
1997 unsigned int OpenMode
= Mode
;
1998 if (FileName
== "/dev/null")
1999 OpenMode
= OpenMode
& ~(Atomic
| Exclusive
| Create
| Empty
);
2001 if ((OpenMode
& Atomic
) == Atomic
)
2005 else if ((OpenMode
& (Exclusive
| Create
)) == (Exclusive
| Create
))
2007 // for atomic, this will be done by rename in Close()
2008 RemoveFile("FileFd::Open", FileName
);
2010 if ((OpenMode
& Empty
) == Empty
)
2013 if (lstat(FileName
.c_str(),&Buf
) == 0 && S_ISLNK(Buf
.st_mode
))
2014 RemoveFile("FileFd::Open", FileName
);
2018 #define if_FLAGGED_SET(FLAG, MODE) if ((OpenMode & FLAG) == FLAG) fileflags |= MODE
2019 if_FLAGGED_SET(ReadWrite
, O_RDWR
);
2020 else if_FLAGGED_SET(ReadOnly
, O_RDONLY
);
2021 else if_FLAGGED_SET(WriteOnly
, O_WRONLY
);
2023 if_FLAGGED_SET(Create
, O_CREAT
);
2024 if_FLAGGED_SET(Empty
, O_TRUNC
);
2025 if_FLAGGED_SET(Exclusive
, O_EXCL
);
2026 #undef if_FLAGGED_SET
2028 if ((OpenMode
& Atomic
) == Atomic
)
2030 char *name
= strdup((FileName
+ ".XXXXXX").c_str());
2032 if((iFd
= mkstemp(name
)) == -1)
2035 return FileFdErrno("mkstemp", "Could not create temporary file for %s", FileName
.c_str());
2038 TemporaryFileName
= string(name
);
2041 // umask() will always set the umask and return the previous value, so
2042 // we first set the umask and then reset it to the old value
2043 mode_t
const CurrentUmask
= umask(0);
2044 umask(CurrentUmask
);
2045 // calculate the actual file permissions (just like open/creat)
2046 mode_t
const FilePermissions
= (AccessMode
& ~CurrentUmask
);
2048 if(fchmod(iFd
, FilePermissions
) == -1)
2049 return FileFdErrno("fchmod", "Could not change permissions for temporary file %s", TemporaryFileName
.c_str());
2052 iFd
= open(FileName
.c_str(), fileflags
, AccessMode
);
2054 this->FileName
= FileName
;
2055 if (iFd
== -1 || OpenInternDescriptor(OpenMode
, compressor
) == false)
2062 return FileFdErrno("open",_("Could not open file %s"), FileName
.c_str());
2065 SetCloseExec(iFd
,true);
2069 // FileFd::OpenDescriptor - Open a filedescriptor /*{{{*/
2070 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, CompressMode Compress
, bool AutoClose
)
2072 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
2073 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
2076 // compat with the old API
2077 if (Mode
== ReadOnlyGzip
&& Compress
== None
)
2082 case None
: name
= "."; break;
2083 case Gzip
: name
= "gzip"; break;
2084 case Bzip2
: name
= "bzip2"; break;
2085 case Lzma
: name
= "lzma"; break;
2086 case Xz
: name
= "xz"; break;
2089 if (AutoClose
== true && Fd
!= -1)
2091 return FileFdError("Opening Fd %d in Auto or Extension compression mode is not supported", Fd
);
2093 for (; compressor
!= compressors
.end(); ++compressor
)
2094 if (compressor
->Name
== name
)
2096 if (compressor
== compressors
.end())
2098 if (AutoClose
== true && Fd
!= -1)
2100 return FileFdError("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
2102 return OpenDescriptor(Fd
, Mode
, *compressor
, AutoClose
);
2104 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
, bool AutoClose
)
2107 Flags
= (AutoClose
) ? FileFd::AutoClose
: 0;
2109 this->FileName
= "";
2110 if (OpenInternDescriptor(Mode
, compressor
) == false)
2113 (Flags
& Compressed
) == Compressed
||
2119 return FileFdError(_("Could not open file descriptor %d"), Fd
);
2123 bool FileFd::OpenInternDescriptor(unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
)
2129 d
->InternalClose(FileName
);
2134 /* dummy so that the rest can be 'else if's */;
2135 #define APT_COMPRESS_INIT(NAME, CONSTRUCTOR) \
2136 else if (compressor.Name == NAME) \
2137 d = new CONSTRUCTOR(this)
2139 APT_COMPRESS_INIT("gzip", GzipFileFdPrivate
);
2142 APT_COMPRESS_INIT("bzip2", Bz2FileFdPrivate
);
2145 APT_COMPRESS_INIT("xz", LzmaFileFdPrivate
);
2146 APT_COMPRESS_INIT("lzma", LzmaFileFdPrivate
);
2148 #undef APT_COMPRESS_INIT
2149 else if (compressor
.Name
== "." || compressor
.Binary
.empty() == true)
2150 d
= new DirectFileFdPrivate(this);
2152 d
= new PipedFileFdPrivate(this);
2154 if (Mode
& BufferedWrite
)
2155 d
= new BufferedWriteFileFdPrivate(d
);
2157 d
->set_openmode(Mode
);
2158 d
->set_compressor(compressor
);
2159 if ((Flags
& AutoClose
) != AutoClose
&& d
->InternalAlwaysAutoClose())
2161 // Need to duplicate fd here or gz/bz2 close for cleanup will close the fd as well
2162 int const internFd
= dup(iFd
);
2164 return FileFdErrno("OpenInternDescriptor", _("Could not open file descriptor %d"), iFd
);
2168 return d
->InternalOpen(iFd
, Mode
);
2171 // FileFd::~File - Closes the file /*{{{*/
2172 // ---------------------------------------------------------------------
2173 /* If the proper modes are selected then we close the Fd and possibly
2174 unlink the file on error. */
2179 d
->InternalClose(FileName
);
2184 // FileFd::Read - Read a bit of the file /*{{{*/
2185 // ---------------------------------------------------------------------
2186 /* We are careful to handle interruption by a signal while reading
2188 bool FileFd::Read(void *To
,unsigned long long Size
,unsigned long long *Actual
)
2196 *((char *)To
) = '\0';
2197 while (Res
> 0 && Size
> 0)
2199 Res
= d
->InternalRead(To
, Size
);
2205 // trick the while-loop into running again
2210 return d
->InternalReadError();
2213 To
= (char *)To
+ Res
;
2216 d
->set_seekpos(d
->get_seekpos() + Res
);
2231 return FileFdError(_("read, still have %llu to read but none left"), Size
);
2234 // FileFd::ReadLine - Read a complete line from the file /*{{{*/
2235 // ---------------------------------------------------------------------
2236 /* Beware: This method can be quite slow for big buffers on UNcompressed
2237 files because of the naive implementation! */
2238 char* FileFd::ReadLine(char *To
, unsigned long long const Size
)
2243 return d
->InternalReadLine(To
, Size
);
2246 // FileFd::Flush - Flush the file /*{{{*/
2247 bool FileFd::Flush()
2252 return d
->InternalFlush();
2255 // FileFd::Write - Write to the file /*{{{*/
2256 bool FileFd::Write(const void *From
,unsigned long long Size
)
2262 while (Res
> 0 && Size
> 0)
2264 Res
= d
->InternalWrite(From
, Size
);
2265 if (Res
< 0 && errno
== EINTR
)
2268 return d
->InternalWriteError();
2270 From
= (char const *)From
+ Res
;
2273 d
->set_seekpos(d
->get_seekpos() + Res
);
2279 return FileFdError(_("write, still have %llu to write but couldn't"), Size
);
2281 bool FileFd::Write(int Fd
, const void *From
, unsigned long long Size
)
2285 while (Res
> 0 && Size
> 0)
2287 Res
= write(Fd
,From
,Size
);
2288 if (Res
< 0 && errno
== EINTR
)
2291 return _error
->Errno("write",_("Write error"));
2293 From
= (char const *)From
+ Res
;
2300 return _error
->Error(_("write, still have %llu to write but couldn't"), Size
);
2303 // FileFd::Seek - Seek in the file /*{{{*/
2304 bool FileFd::Seek(unsigned long long To
)
2309 return d
->InternalSeek(To
);
2312 // FileFd::Skip - Skip over data in the file /*{{{*/
2313 bool FileFd::Skip(unsigned long long Over
)
2317 return d
->InternalSkip(Over
);
2320 // FileFd::Truncate - Truncate the file /*{{{*/
2321 bool FileFd::Truncate(unsigned long long To
)
2325 // truncating /dev/null is always successful - as we get an error otherwise
2326 if (To
== 0 && FileName
== "/dev/null")
2328 return d
->InternalTruncate(To
);
2331 // FileFd::Tell - Current seek position /*{{{*/
2332 // ---------------------------------------------------------------------
2334 unsigned long long FileFd::Tell()
2338 off_t
const Res
= d
->InternalTell();
2339 if (Res
== (off_t
)-1)
2340 FileFdErrno("lseek","Failed to determine the current file position");
2341 d
->set_seekpos(Res
);
2345 static bool StatFileFd(char const * const msg
, int const iFd
, std::string
const &FileName
, struct stat
&Buf
, FileFdPrivate
* const d
) /*{{{*/
2347 bool ispipe
= (d
!= NULL
&& d
->get_is_pipe() == true);
2348 if (ispipe
== false)
2350 if (fstat(iFd
,&Buf
) != 0)
2351 // higher-level code will generate more meaningful messages,
2352 // even translated this would be meaningless for users
2353 return _error
->Errno("fstat", "Unable to determine %s for fd %i", msg
, iFd
);
2354 if (FileName
.empty() == false)
2355 ispipe
= S_ISFIFO(Buf
.st_mode
);
2358 // for compressor pipes st_size is undefined and at 'best' zero
2361 // we set it here, too, as we get the info here for free
2362 // in theory the Open-methods should take care of it already
2364 d
->set_is_pipe(true);
2365 if (stat(FileName
.c_str(), &Buf
) != 0)
2366 return _error
->Errno("fstat", "Unable to determine %s for file %s", msg
, FileName
.c_str());
2371 // FileFd::FileSize - Return the size of the file /*{{{*/
2372 unsigned long long FileFd::FileSize()
2375 if (StatFileFd("file size", iFd
, FileName
, Buf
, d
) == false)
2383 // FileFd::ModificationTime - Return the time of last touch /*{{{*/
2384 time_t FileFd::ModificationTime()
2387 if (StatFileFd("modification time", iFd
, FileName
, Buf
, d
) == false)
2392 return Buf
.st_mtime
;
2395 // FileFd::Size - Return the size of the content in the file /*{{{*/
2396 unsigned long long FileFd::Size()
2400 return d
->InternalSize();
2403 // FileFd::Close - Close the file if the close flag is set /*{{{*/
2404 // ---------------------------------------------------------------------
2406 bool FileFd::Close()
2408 if (Flush() == false)
2414 if ((Flags
& AutoClose
) == AutoClose
)
2416 if ((Flags
& Compressed
) != Compressed
&& iFd
> 0 && close(iFd
) != 0)
2417 Res
&= _error
->Errno("close",_("Problem closing the file %s"), FileName
.c_str());
2422 Res
&= d
->InternalClose(FileName
);
2427 if ((Flags
& Replace
) == Replace
) {
2428 if (rename(TemporaryFileName
.c_str(), FileName
.c_str()) != 0)
2429 Res
&= _error
->Errno("rename",_("Problem renaming the file %s to %s"), TemporaryFileName
.c_str(), FileName
.c_str());
2431 FileName
= TemporaryFileName
; // for the unlink() below.
2432 TemporaryFileName
.clear();
2437 if ((Flags
& Fail
) == Fail
&& (Flags
& DelOnFail
) == DelOnFail
&&
2438 FileName
.empty() == false)
2439 Res
&= RemoveFile("FileFd::Close", FileName
);
2446 // FileFd::Sync - Sync the file /*{{{*/
2447 // ---------------------------------------------------------------------
2451 if (fsync(iFd
) != 0)
2452 return FileFdErrno("sync",_("Problem syncing the file"));
2456 // FileFd::FileFdErrno - set Fail and call _error->Errno *{{{*/
2457 bool FileFd::FileFdErrno(const char *Function
, const char *Description
,...)
2461 size_t msgSize
= 400;
2462 int const errsv
= errno
;
2465 va_start(args
,Description
);
2466 if (_error
->InsertErrno(GlobalError::ERROR
, Function
, Description
, args
, errsv
, msgSize
) == false)
2473 // FileFd::FileFdError - set Fail and call _error->Error *{{{*/
2474 bool FileFd::FileFdError(const char *Description
,...) {
2477 size_t msgSize
= 400;
2480 va_start(args
,Description
);
2481 if (_error
->Insert(GlobalError::ERROR
, Description
, args
, msgSize
) == false)
2488 gzFile
FileFd::gzFd() { /*{{{*/
2490 GzipFileFdPrivate
* const gzipd
= dynamic_cast<GzipFileFdPrivate
*>(d
);
2491 if (gzipd
== nullptr)
2501 // Glob - wrapper around "glob()" /*{{{*/
2502 std::vector
<std::string
> Glob(std::string
const &pattern
, int flags
)
2504 std::vector
<std::string
> result
;
2509 glob_res
= glob(pattern
.c_str(), flags
, NULL
, &globbuf
);
2513 if(glob_res
!= GLOB_NOMATCH
) {
2514 _error
->Errno("glob", "Problem with glob");
2520 for(i
=0;i
<globbuf
.gl_pathc
;i
++)
2521 result
.push_back(string(globbuf
.gl_pathv
[i
]));
2527 std::string
GetTempDir() /*{{{*/
2529 const char *tmpdir
= getenv("TMPDIR");
2537 if (!tmpdir
|| strlen(tmpdir
) == 0 || // tmpdir is set
2538 stat(tmpdir
, &st
) != 0 || (st
.st_mode
& S_IFDIR
) == 0) // exists and is directory
2540 else if (geteuid() != 0 && // root can do everything anyway
2541 faccessat(-1, tmpdir
, R_OK
| W_OK
| X_OK
, AT_EACCESS
| AT_SYMLINK_NOFOLLOW
) != 0) // current user has rwx access to directory
2544 return string(tmpdir
);
2546 std::string
GetTempDir(std::string
const &User
)
2548 // no need/possibility to drop privs
2549 if(getuid() != 0 || User
.empty() || User
== "root")
2550 return GetTempDir();
2552 struct passwd
const * const pw
= getpwnam(User
.c_str());
2554 return GetTempDir();
2556 gid_t
const old_euid
= geteuid();
2557 gid_t
const old_egid
= getegid();
2558 if (setegid(pw
->pw_gid
) != 0)
2559 _error
->Errno("setegid", "setegid %u failed", pw
->pw_gid
);
2560 if (seteuid(pw
->pw_uid
) != 0)
2561 _error
->Errno("seteuid", "seteuid %u failed", pw
->pw_uid
);
2563 std::string
const tmp
= GetTempDir();
2565 if (seteuid(old_euid
) != 0)
2566 _error
->Errno("seteuid", "seteuid %u failed", old_euid
);
2567 if (setegid(old_egid
) != 0)
2568 _error
->Errno("setegid", "setegid %u failed", old_egid
);
2573 FileFd
* GetTempFile(std::string
const &Prefix
, bool ImmediateUnlink
, FileFd
* const TmpFd
) /*{{{*/
2576 FileFd
* const Fd
= TmpFd
== NULL
? new FileFd() : TmpFd
;
2578 std::string
const tempdir
= GetTempDir();
2579 snprintf(fn
, sizeof(fn
), "%s/%s.XXXXXX",
2580 tempdir
.c_str(), Prefix
.c_str());
2581 int const fd
= mkstemp(fn
);
2586 _error
->Errno("GetTempFile",_("Unable to mkstemp %s"), fn
);
2589 if (!Fd
->OpenDescriptor(fd
, FileFd::ReadWrite
, FileFd::None
, true))
2591 _error
->Errno("GetTempFile",_("Unable to write to %s"),fn
);
2597 bool Rename(std::string From
, std::string To
) /*{{{*/
2599 if (rename(From
.c_str(),To
.c_str()) != 0)
2601 _error
->Error(_("rename failed, %s (%s -> %s)."),strerror(errno
),
2602 From
.c_str(),To
.c_str());
2608 bool Popen(const char* Args
[], FileFd
&Fd
, pid_t
&Child
, FileFd::OpenMode Mode
)/*{{{*/
2611 if (Mode
!= FileFd::ReadOnly
&& Mode
!= FileFd::WriteOnly
)
2612 return _error
->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2614 int Pipe
[2] = {-1, -1};
2616 return _error
->Errno("pipe", _("Failed to create subprocess IPC"));
2618 std::set
<int> keep_fds
;
2619 keep_fds
.insert(Pipe
[0]);
2620 keep_fds
.insert(Pipe
[1]);
2621 Child
= ExecFork(keep_fds
);
2623 return _error
->Errno("fork", "Failed to fork");
2626 if(Mode
== FileFd::ReadOnly
)
2631 else if(Mode
== FileFd::WriteOnly
)
2637 if(Mode
== FileFd::ReadOnly
)
2641 } else if(Mode
== FileFd::WriteOnly
)
2644 execv(Args
[0], (char**)Args
);
2647 if(Mode
== FileFd::ReadOnly
)
2652 else if(Mode
== FileFd::WriteOnly
)
2658 return _error
->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2659 Fd
.OpenDescriptor(fd
, Mode
, FileFd::None
, true);
2664 bool DropPrivileges() /*{{{*/
2666 if(_config
->FindB("Debug::NoDropPrivs", false) == true)
2670 #if defined(PR_SET_NO_NEW_PRIVS) && ( PR_SET_NO_NEW_PRIVS != 38 )
2671 #error "PR_SET_NO_NEW_PRIVS is defined, but with a different value than expected!"
2673 // see prctl(2), needs linux3.5 at runtime - magic constant to avoid it at buildtime
2674 int ret
= prctl(38, 1, 0, 0, 0);
2675 // ignore EINVAL - kernel is too old to understand the option
2676 if(ret
< 0 && errno
!= EINVAL
)
2677 _error
->Warning("PR_SET_NO_NEW_PRIVS failed with %i", ret
);
2680 // empty setting disables privilege dropping - this also ensures
2681 // backward compatibility, see bug #764506
2682 const std::string toUser
= _config
->Find("APT::Sandbox::User");
2683 if (toUser
.empty() || toUser
== "root")
2686 // a lot can go wrong trying to drop privileges completely,
2687 // so ideally we would like to verify that we have done it –
2688 // but the verify asks for too much in case of fakeroot (and alike)
2689 // [Specific checks can be overridden with dedicated options]
2690 bool const VerifySandboxing
= _config
->FindB("APT::Sandbox::Verify", false);
2692 // uid will be 0 in the end, but gid might be different anyway
2693 uid_t
const old_uid
= getuid();
2694 gid_t
const old_gid
= getgid();
2699 struct passwd
*pw
= getpwnam(toUser
.c_str());
2701 return _error
->Error("No user %s, can not drop rights", toUser
.c_str());
2703 // Do not change the order here, it might break things
2704 // Get rid of all our supplementary groups first
2705 if (setgroups(1, &pw
->pw_gid
))
2706 return _error
->Errno("setgroups", "Failed to setgroups");
2708 // Now change the group ids to the new user
2709 #ifdef HAVE_SETRESGID
2710 if (setresgid(pw
->pw_gid
, pw
->pw_gid
, pw
->pw_gid
) != 0)
2711 return _error
->Errno("setresgid", "Failed to set new group ids");
2713 if (setegid(pw
->pw_gid
) != 0)
2714 return _error
->Errno("setegid", "Failed to setegid");
2716 if (setgid(pw
->pw_gid
) != 0)
2717 return _error
->Errno("setgid", "Failed to setgid");
2720 // Change the user ids to the new user
2721 #ifdef HAVE_SETRESUID
2722 if (setresuid(pw
->pw_uid
, pw
->pw_uid
, pw
->pw_uid
) != 0)
2723 return _error
->Errno("setresuid", "Failed to set new user ids");
2725 if (setuid(pw
->pw_uid
) != 0)
2726 return _error
->Errno("setuid", "Failed to setuid");
2727 if (seteuid(pw
->pw_uid
) != 0)
2728 return _error
->Errno("seteuid", "Failed to seteuid");
2731 // disabled by default as fakeroot doesn't implement getgroups currently (#806521)
2732 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::Groups", false) == true)
2734 // Verify that the user isn't still in any supplementary groups
2735 long const ngroups_max
= sysconf(_SC_NGROUPS_MAX
);
2736 std::unique_ptr
<gid_t
[]> gidlist(new gid_t
[ngroups_max
]);
2737 if (unlikely(gidlist
== NULL
))
2738 return _error
->Error("Allocation of a list of size %lu for getgroups failed", ngroups_max
);
2740 if ((gidlist_nr
= getgroups(ngroups_max
, gidlist
.get())) < 0)
2741 return _error
->Errno("getgroups", "Could not get new groups (%lu)", ngroups_max
);
2742 for (ssize_t i
= 0; i
< gidlist_nr
; ++i
)
2743 if (gidlist
[i
] != pw
->pw_gid
)
2744 return _error
->Error("Could not switch group, user %s is still in group %d", toUser
.c_str(), gidlist
[i
]);
2747 // enabled by default as all fakeroot-lookalikes should fake that accordingly
2748 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::IDs", true) == true)
2750 // Verify that gid, egid, uid, and euid changed
2751 if (getgid() != pw
->pw_gid
)
2752 return _error
->Error("Could not switch group");
2753 if (getegid() != pw
->pw_gid
)
2754 return _error
->Error("Could not switch effective group");
2755 if (getuid() != pw
->pw_uid
)
2756 return _error
->Error("Could not switch user");
2757 if (geteuid() != pw
->pw_uid
)
2758 return _error
->Error("Could not switch effective user");
2760 #ifdef HAVE_GETRESUID
2761 // verify that the saved set-user-id was changed as well
2765 if (getresuid(&ruid
, &euid
, &suid
))
2766 return _error
->Errno("getresuid", "Could not get saved set-user-ID");
2767 if (suid
!= pw
->pw_uid
)
2768 return _error
->Error("Could not switch saved set-user-ID");
2771 #ifdef HAVE_GETRESGID
2772 // verify that the saved set-group-id was changed as well
2776 if (getresgid(&rgid
, &egid
, &sgid
))
2777 return _error
->Errno("getresuid", "Could not get saved set-group-ID");
2778 if (sgid
!= pw
->pw_gid
)
2779 return _error
->Error("Could not switch saved set-group-ID");
2783 // disabled as fakeroot doesn't forbid (by design) (re)gaining root from unprivileged
2784 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::Regain", false) == true)
2786 // Check that uid and gid changes do not work anymore
2787 if (pw
->pw_gid
!= old_gid
&& (setgid(old_gid
) != -1 || setegid(old_gid
) != -1))
2788 return _error
->Error("Could restore a gid to root, privilege dropping did not work");
2790 if (pw
->pw_uid
!= old_uid
&& (setuid(old_uid
) != -1 || seteuid(old_uid
) != -1))
2791 return _error
->Error("Could restore a uid to root, privilege dropping did not work");