1 // -*- mode: cpp; mode: fold -*-
3 /* ######################################################################
7 CopyFile - Buffered copy of a single file
8 GetLock - dpkg compatible lock file manipulation (fcntl)
10 Most of this source is placed in the Public Domain, do with it what
12 It was originally written by Jason Gunthorpe <jgg@debian.org>.
13 FileFd gzip support added by Martin Pitt <martin.pitt@canonical.com>
15 The exception is RunScripts() it is under the GPLv2
17 ##################################################################### */
19 // Include Files /*{{{*/
22 #include <apt-pkg/fileutl.h>
23 #include <apt-pkg/strutl.h>
24 #include <apt-pkg/error.h>
25 #include <apt-pkg/sptr.h>
26 #include <apt-pkg/aptconfiguration.h>
27 #include <apt-pkg/configuration.h>
28 #include <apt-pkg/macros.h>
33 #include <sys/select.h>
70 #include <sys/prctl.h>
78 // RunScripts - Run a set of scripts from a configuration subtree /*{{{*/
79 // ---------------------------------------------------------------------
81 bool RunScripts(const char *Cnf
)
83 Configuration::Item
const *Opts
= _config
->Tree(Cnf
);
84 if (Opts
== 0 || Opts
->Child
== 0)
88 // Fork for running the system calls
89 pid_t Child
= ExecFork();
94 if (_config
->FindDir("DPkg::Chroot-Directory","/") != "/")
96 std::cerr
<< "Chrooting into "
97 << _config
->FindDir("DPkg::Chroot-Directory")
99 if (chroot(_config
->FindDir("DPkg::Chroot-Directory","/").c_str()) != 0)
103 if (chdir("/tmp/") != 0)
106 unsigned int Count
= 1;
107 for (; Opts
!= 0; Opts
= Opts
->Next
, Count
++)
109 if (Opts
->Value
.empty() == true)
112 if(_config
->FindB("Debug::RunScripts", false) == true)
113 std::clog
<< "Running external script: '"
114 << Opts
->Value
<< "'" << std::endl
;
116 if (system(Opts
->Value
.c_str()) != 0)
122 // Wait for the child
124 while (waitpid(Child
,&Status
,0) != Child
)
128 return _error
->Errno("waitpid","Couldn't wait for subprocess");
131 // Restore sig int/quit
132 signal(SIGQUIT
,SIG_DFL
);
133 signal(SIGINT
,SIG_DFL
);
135 // Check for an error code.
136 if (WIFEXITED(Status
) == 0 || WEXITSTATUS(Status
) != 0)
138 unsigned int Count
= WEXITSTATUS(Status
);
142 for (; Opts
!= 0 && Count
!= 1; Opts
= Opts
->Next
, Count
--);
143 _error
->Error("Problem executing scripts %s '%s'",Cnf
,Opts
->Value
.c_str());
146 return _error
->Error("Sub-process returned an error code");
153 // CopyFile - Buffered copy of a file /*{{{*/
154 // ---------------------------------------------------------------------
155 /* The caller is expected to set things so that failure causes erasure */
156 bool CopyFile(FileFd
&From
,FileFd
&To
)
158 if (From
.IsOpen() == false || To
.IsOpen() == false ||
159 From
.Failed() == true || To
.Failed() == true)
162 // Buffered copy between fds
163 constexpr size_t BufSize
= 64000;
164 std::unique_ptr
<unsigned char[]> Buf(new unsigned char[BufSize
]);
165 unsigned long long ToRead
= 0;
167 if (From
.Read(Buf
.get(),BufSize
, &ToRead
) == false ||
168 To
.Write(Buf
.get(),ToRead
) == false)
170 } while (ToRead
!= 0);
175 bool RemoveFile(char const * const Function
, std::string
const &FileName
)/*{{{*/
177 if (FileName
== "/dev/null")
180 if (unlink(FileName
.c_str()) != 0)
185 return _error
->WarningE(Function
,_("Problem unlinking the file %s"), FileName
.c_str());
190 // GetLock - Gets a lock file /*{{{*/
191 // ---------------------------------------------------------------------
192 /* This will create an empty file of the given name and lock it. Once this
193 is done all other calls to GetLock in any other process will fail with
194 -1. The return result is the fd of the file, the call should call
195 close at some time. */
196 int GetLock(string File
,bool Errors
)
198 // GetLock() is used in aptitude on directories with public-write access
199 // Use O_NOFOLLOW here to prevent symlink traversal attacks
200 int FD
= open(File
.c_str(),O_RDWR
| O_CREAT
| O_NOFOLLOW
,0640);
203 // Read only .. can't have locking problems there.
206 _error
->Warning(_("Not using locking for read only lock file %s"),File
.c_str());
207 return dup(0); // Need something for the caller to close
211 _error
->Errno("open",_("Could not open lock file %s"),File
.c_str());
213 // Feh.. We do this to distinguish the lock vs open case..
217 SetCloseExec(FD
,true);
219 // Acquire a write lock
222 fl
.l_whence
= SEEK_SET
;
225 if (fcntl(FD
,F_SETLK
,&fl
) == -1)
227 // always close to not leak resources
234 _error
->Warning(_("Not using locking for nfs mounted lock file %s"),File
.c_str());
235 return dup(0); // Need something for the caller to close
239 _error
->Errno("open",_("Could not get lock %s"),File
.c_str());
247 // FileExists - Check if a file exists /*{{{*/
248 // ---------------------------------------------------------------------
249 /* Beware: Directories are also files! */
250 bool FileExists(string File
)
253 if (stat(File
.c_str(),&Buf
) != 0)
258 // RealFileExists - Check if a file exists and if it is really a file /*{{{*/
259 // ---------------------------------------------------------------------
261 bool RealFileExists(string File
)
264 if (stat(File
.c_str(),&Buf
) != 0)
266 return ((Buf
.st_mode
& S_IFREG
) != 0);
269 // DirectoryExists - Check if a directory exists and is really one /*{{{*/
270 // ---------------------------------------------------------------------
272 bool DirectoryExists(string
const &Path
)
275 if (stat(Path
.c_str(),&Buf
) != 0)
277 return ((Buf
.st_mode
& S_IFDIR
) != 0);
280 // CreateDirectory - poor man's mkdir -p guarded by a parent directory /*{{{*/
281 // ---------------------------------------------------------------------
282 /* This method will create all directories needed for path in good old
283 mkdir -p style but refuses to do this if Parent is not a prefix of
284 this Path. Example: /var/cache/ and /var/cache/apt/archives are given,
285 so it will create apt/archives if /var/cache exists - on the other
286 hand if the parent is /var/lib the creation will fail as this path
287 is not a parent of the path to be generated. */
288 bool CreateDirectory(string
const &Parent
, string
const &Path
)
290 if (Parent
.empty() == true || Path
.empty() == true)
293 if (DirectoryExists(Path
) == true)
296 if (DirectoryExists(Parent
) == false)
299 // we are not going to create directories "into the blue"
300 if (Path
.compare(0, Parent
.length(), Parent
) != 0)
303 vector
<string
> const dirs
= VectorizeString(Path
.substr(Parent
.size()), '/');
304 string progress
= Parent
;
305 for (vector
<string
>::const_iterator d
= dirs
.begin(); d
!= dirs
.end(); ++d
)
307 if (d
->empty() == true)
310 progress
.append("/").append(*d
);
311 if (DirectoryExists(progress
) == true)
314 if (mkdir(progress
.c_str(), 0755) != 0)
320 // CreateAPTDirectoryIfNeeded - ensure that the given directory exists /*{{{*/
321 // ---------------------------------------------------------------------
322 /* a small wrapper around CreateDirectory to check if it exists and to
323 remove the trailing "/apt/" from the parent directory if needed */
324 bool CreateAPTDirectoryIfNeeded(string
const &Parent
, string
const &Path
)
326 if (DirectoryExists(Path
) == true)
329 size_t const len
= Parent
.size();
330 if (len
> 5 && Parent
.find("/apt/", len
- 6, 5) == len
- 5)
332 if (CreateDirectory(Parent
.substr(0,len
-5), Path
) == true)
335 else if (CreateDirectory(Parent
, Path
) == true)
341 // GetListOfFilesInDir - returns a vector of files in the given dir /*{{{*/
342 // ---------------------------------------------------------------------
343 /* If an extension is given only files with this extension are included
344 in the returned vector, otherwise every "normal" file is included. */
345 std::vector
<string
> GetListOfFilesInDir(string
const &Dir
, string
const &Ext
,
346 bool const &SortList
, bool const &AllowNoExt
)
348 std::vector
<string
> ext
;
350 if (Ext
.empty() == false)
352 if (AllowNoExt
== true && ext
.empty() == false)
354 return GetListOfFilesInDir(Dir
, ext
, SortList
);
356 std::vector
<string
> GetListOfFilesInDir(string
const &Dir
, std::vector
<string
> const &Ext
,
357 bool const &SortList
)
359 // Attention debuggers: need to be set with the environment config file!
360 bool const Debug
= _config
->FindB("Debug::GetListOfFilesInDir", false);
363 std::clog
<< "Accept in " << Dir
<< " only files with the following " << Ext
.size() << " extensions:" << std::endl
;
364 if (Ext
.empty() == true)
365 std::clog
<< "\tNO extension" << std::endl
;
367 for (std::vector
<string
>::const_iterator e
= Ext
.begin();
369 std::clog
<< '\t' << (e
->empty() == true ? "NO" : *e
) << " extension" << std::endl
;
372 std::vector
<string
> List
;
374 if (DirectoryExists(Dir
) == false)
376 _error
->Error(_("List of files can't be created as '%s' is not a directory"), Dir
.c_str());
380 Configuration::MatchAgainstConfig
SilentIgnore("Dir::Ignore-Files-Silently");
381 DIR *D
= opendir(Dir
.c_str());
384 _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
388 for (struct dirent
*Ent
= readdir(D
); Ent
!= 0; Ent
= readdir(D
))
390 // skip "hidden" files
391 if (Ent
->d_name
[0] == '.')
394 // Make sure it is a file and not something else
395 string
const File
= flCombine(Dir
,Ent
->d_name
);
396 #ifdef _DIRENT_HAVE_D_TYPE
397 if (Ent
->d_type
!= DT_REG
)
400 if (RealFileExists(File
) == false)
402 // do not show ignoration warnings for directories
404 #ifdef _DIRENT_HAVE_D_TYPE
405 Ent
->d_type
== DT_DIR
||
407 DirectoryExists(File
) == true)
409 if (SilentIgnore
.Match(Ent
->d_name
) == false)
410 _error
->Notice(_("Ignoring '%s' in directory '%s' as it is not a regular file"), Ent
->d_name
, Dir
.c_str());
415 // check for accepted extension:
416 // no extension given -> periods are bad as hell!
417 // extensions given -> "" extension allows no extension
418 if (Ext
.empty() == false)
420 string d_ext
= flExtension(Ent
->d_name
);
421 if (d_ext
== Ent
->d_name
) // no extension
423 if (std::find(Ext
.begin(), Ext
.end(), "") == Ext
.end())
426 std::clog
<< "Bad file: " << Ent
->d_name
<< " → no extension" << std::endl
;
427 if (SilentIgnore
.Match(Ent
->d_name
) == false)
428 _error
->Notice(_("Ignoring file '%s' in directory '%s' as it has no filename extension"), Ent
->d_name
, Dir
.c_str());
432 else if (std::find(Ext
.begin(), Ext
.end(), d_ext
) == Ext
.end())
435 std::clog
<< "Bad file: " << Ent
->d_name
<< " → bad extension »" << flExtension(Ent
->d_name
) << "«" << std::endl
;
436 if (SilentIgnore
.Match(Ent
->d_name
) == false)
437 _error
->Notice(_("Ignoring file '%s' in directory '%s' as it has an invalid filename extension"), Ent
->d_name
, Dir
.c_str());
442 // Skip bad filenames ala run-parts
443 const char *C
= Ent
->d_name
;
445 if (isalpha(*C
) == 0 && isdigit(*C
) == 0
446 && *C
!= '_' && *C
!= '-' && *C
!= ':') {
447 // no required extension -> dot is a bad character
448 if (*C
== '.' && Ext
.empty() == false)
453 // we don't reach the end of the name -> bad character included
457 std::clog
<< "Bad file: " << Ent
->d_name
<< " → bad character »"
458 << *C
<< "« in filename (period allowed: " << (Ext
.empty() ? "no" : "yes") << ")" << std::endl
;
462 // skip filenames which end with a period. These are never valid
466 std::clog
<< "Bad file: " << Ent
->d_name
<< " → Period as last character" << std::endl
;
471 std::clog
<< "Accept file: " << Ent
->d_name
<< " in " << Dir
<< std::endl
;
472 List
.push_back(File
);
476 if (SortList
== true)
477 std::sort(List
.begin(),List
.end());
480 std::vector
<string
> GetListOfFilesInDir(string
const &Dir
, bool SortList
)
482 bool const Debug
= _config
->FindB("Debug::GetListOfFilesInDir", false);
484 std::clog
<< "Accept in " << Dir
<< " all regular files" << std::endl
;
486 std::vector
<string
> List
;
488 if (DirectoryExists(Dir
) == false)
490 _error
->Error(_("List of files can't be created as '%s' is not a directory"), Dir
.c_str());
494 DIR *D
= opendir(Dir
.c_str());
497 _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
501 for (struct dirent
*Ent
= readdir(D
); Ent
!= 0; Ent
= readdir(D
))
503 // skip "hidden" files
504 if (Ent
->d_name
[0] == '.')
507 // Make sure it is a file and not something else
508 string
const File
= flCombine(Dir
,Ent
->d_name
);
509 #ifdef _DIRENT_HAVE_D_TYPE
510 if (Ent
->d_type
!= DT_REG
)
513 if (RealFileExists(File
) == false)
516 std::clog
<< "Bad file: " << Ent
->d_name
<< " → it is not a real file" << std::endl
;
521 // Skip bad filenames ala run-parts
522 const char *C
= Ent
->d_name
;
524 if (isalpha(*C
) == 0 && isdigit(*C
) == 0
525 && *C
!= '_' && *C
!= '-' && *C
!= '.')
528 // we don't reach the end of the name -> bad character included
532 std::clog
<< "Bad file: " << Ent
->d_name
<< " → bad character »" << *C
<< "« in filename" << std::endl
;
536 // skip filenames which end with a period. These are never valid
540 std::clog
<< "Bad file: " << Ent
->d_name
<< " → Period as last character" << std::endl
;
545 std::clog
<< "Accept file: " << Ent
->d_name
<< " in " << Dir
<< std::endl
;
546 List
.push_back(File
);
550 if (SortList
== true)
551 std::sort(List
.begin(),List
.end());
555 // SafeGetCWD - This is a safer getcwd that returns a dynamic string /*{{{*/
556 // ---------------------------------------------------------------------
557 /* We return / on failure. */
560 // Stash the current dir.
563 if (getcwd(S
,sizeof(S
)-2) == 0)
565 unsigned int Len
= strlen(S
);
571 // GetModificationTime - Get the mtime of the given file or -1 on error /*{{{*/
572 // ---------------------------------------------------------------------
573 /* We return / on failure. */
574 time_t GetModificationTime(string
const &Path
)
577 if (stat(Path
.c_str(), &St
) < 0)
582 // flNotDir - Strip the directory from the filename /*{{{*/
583 // ---------------------------------------------------------------------
585 string
flNotDir(string File
)
587 string::size_type Res
= File
.rfind('/');
588 if (Res
== string::npos
)
591 return string(File
,Res
,Res
- File
.length());
594 // flNotFile - Strip the file from the directory name /*{{{*/
595 // ---------------------------------------------------------------------
596 /* Result ends in a / */
597 string
flNotFile(string File
)
599 string::size_type Res
= File
.rfind('/');
600 if (Res
== string::npos
)
603 return string(File
,0,Res
);
606 // flExtension - Return the extension for the file /*{{{*/
607 // ---------------------------------------------------------------------
609 string
flExtension(string File
)
611 string::size_type Res
= File
.rfind('.');
612 if (Res
== string::npos
)
615 return string(File
,Res
,Res
- File
.length());
618 // flNoLink - If file is a symlink then deref it /*{{{*/
619 // ---------------------------------------------------------------------
620 /* If the name is not a link then the returned path is the input. */
621 string
flNoLink(string File
)
624 if (lstat(File
.c_str(),&St
) != 0 || S_ISLNK(St
.st_mode
) == 0)
626 if (stat(File
.c_str(),&St
) != 0)
629 /* Loop resolving the link. There is no need to limit the number of
630 loops because the stat call above ensures that the symlink is not
638 if ((Res
= readlink(NFile
.c_str(),Buffer
,sizeof(Buffer
))) <= 0 ||
639 (size_t)Res
>= sizeof(Buffer
))
642 // Append or replace the previous path
644 if (Buffer
[0] == '/')
647 NFile
= flNotFile(NFile
) + Buffer
;
649 // See if we are done
650 if (lstat(NFile
.c_str(),&St
) != 0)
652 if (S_ISLNK(St
.st_mode
) == 0)
657 // flCombine - Combine a file and a directory /*{{{*/
658 // ---------------------------------------------------------------------
659 /* If the file is an absolute path then it is just returned, otherwise
660 the directory is pre-pended to it. */
661 string
flCombine(string Dir
,string File
)
663 if (File
.empty() == true)
666 if (File
[0] == '/' || Dir
.empty() == true)
668 if (File
.length() >= 2 && File
[0] == '.' && File
[1] == '/')
670 if (Dir
[Dir
.length()-1] == '/')
672 return Dir
+ '/' + File
;
675 // flAbsPath - Return the absolute path of the filename /*{{{*/
676 // ---------------------------------------------------------------------
678 string
flAbsPath(string File
)
680 char *p
= realpath(File
.c_str(), NULL
);
683 _error
->Errno("realpath", "flAbsPath on %s failed", File
.c_str());
686 std::string
AbsPath(p
);
691 // SetCloseExec - Set the close on exec flag /*{{{*/
692 // ---------------------------------------------------------------------
694 void SetCloseExec(int Fd
,bool Close
)
696 if (fcntl(Fd
,F_SETFD
,(Close
== false)?0:FD_CLOEXEC
) != 0)
698 cerr
<< "FATAL -> Could not set close on exec " << strerror(errno
) << endl
;
703 // SetNonBlock - Set the nonblocking flag /*{{{*/
704 // ---------------------------------------------------------------------
706 void SetNonBlock(int Fd
,bool Block
)
708 int Flags
= fcntl(Fd
,F_GETFL
) & (~O_NONBLOCK
);
709 if (fcntl(Fd
,F_SETFL
,Flags
| ((Block
== false)?0:O_NONBLOCK
)) != 0)
711 cerr
<< "FATAL -> Could not set non-blocking flag " << strerror(errno
) << endl
;
716 // WaitFd - Wait for a FD to become readable /*{{{*/
717 // ---------------------------------------------------------------------
718 /* This waits for a FD to become readable using select. It is useful for
719 applications making use of non-blocking sockets. The timeout is
721 bool WaitFd(int Fd
,bool write
,unsigned long timeout
)
734 Res
= select(Fd
+1,0,&Set
,0,(timeout
!= 0?&tv
:0));
736 while (Res
< 0 && errno
== EINTR
);
746 Res
= select(Fd
+1,&Set
,0,0,(timeout
!= 0?&tv
:0));
748 while (Res
< 0 && errno
== EINTR
);
757 // MergeKeepFdsFromConfiguration - Merge APT::Keep-Fds configuration /*{{{*/
758 // ---------------------------------------------------------------------
759 /* This is used to merge the APT::Keep-Fds with the provided KeepFDs
762 void MergeKeepFdsFromConfiguration(std::set
<int> &KeepFDs
)
764 Configuration::Item
const *Opts
= _config
->Tree("APT::Keep-Fds");
765 if (Opts
!= 0 && Opts
->Child
!= 0)
768 for (; Opts
!= 0; Opts
= Opts
->Next
)
770 if (Opts
->Value
.empty() == true)
772 int fd
= atoi(Opts
->Value
.c_str());
778 // ExecFork - Magical fork that sanitizes the context before execing /*{{{*/
779 // ---------------------------------------------------------------------
780 /* This is used if you want to cleanse the environment for the forked
781 child, it fixes up the important signals and nukes all of the fds,
782 otherwise acts like normal fork. */
786 // we need to merge the Keep-Fds as external tools like
787 // debconf-apt-progress use it
788 MergeKeepFdsFromConfiguration(KeepFDs
);
789 return ExecFork(KeepFDs
);
792 pid_t
ExecFork(std::set
<int> KeepFDs
)
794 // Fork off the process
795 pid_t Process
= fork();
798 cerr
<< "FATAL -> Failed to fork." << endl
;
802 // Spawn the subprocess
806 signal(SIGPIPE
,SIG_DFL
);
807 signal(SIGQUIT
,SIG_DFL
);
808 signal(SIGINT
,SIG_DFL
);
809 signal(SIGWINCH
,SIG_DFL
);
810 signal(SIGCONT
,SIG_DFL
);
811 signal(SIGTSTP
,SIG_DFL
);
813 DIR *dir
= opendir("/proc/self/fd");
817 while ((ent
= readdir(dir
)))
819 int fd
= atoi(ent
->d_name
);
820 // If fd > 0, it was a fd number and not . or ..
821 if (fd
>= 3 && KeepFDs
.find(fd
) == KeepFDs
.end())
822 fcntl(fd
,F_SETFD
,FD_CLOEXEC
);
826 long ScOpenMax
= sysconf(_SC_OPEN_MAX
);
827 // Close all of our FDs - just in case
828 for (int K
= 3; K
!= ScOpenMax
; K
++)
830 if(KeepFDs
.find(K
) == KeepFDs
.end())
831 fcntl(K
,F_SETFD
,FD_CLOEXEC
);
839 // ExecWait - Fancy waitpid /*{{{*/
840 // ---------------------------------------------------------------------
841 /* Waits for the given sub process. If Reap is set then no errors are
842 generated. Otherwise a failed subprocess will generate a proper descriptive
844 bool ExecWait(pid_t Pid
,const char *Name
,bool Reap
)
849 // Wait and collect the error code
851 while (waitpid(Pid
,&Status
,0) != Pid
)
859 return _error
->Error(_("Waited for %s but it wasn't there"),Name
);
863 // Check for an error code.
864 if (WIFEXITED(Status
) == 0 || WEXITSTATUS(Status
) != 0)
868 if (WIFSIGNALED(Status
) != 0)
870 if( WTERMSIG(Status
) == SIGSEGV
)
871 return _error
->Error(_("Sub-process %s received a segmentation fault."),Name
);
873 return _error
->Error(_("Sub-process %s received signal %u."),Name
, WTERMSIG(Status
));
876 if (WIFEXITED(Status
) != 0)
877 return _error
->Error(_("Sub-process %s returned an error code (%u)"),Name
,WEXITSTATUS(Status
));
879 return _error
->Error(_("Sub-process %s exited unexpectedly"),Name
);
885 // StartsWithGPGClearTextSignature - Check if a file is Pgp/GPG clearsigned /*{{{*/
886 bool StartsWithGPGClearTextSignature(string
const &FileName
)
888 static const char* SIGMSG
= "-----BEGIN PGP SIGNED MESSAGE-----\n";
889 char buffer
[strlen(SIGMSG
)+1];
890 FILE* gpg
= fopen(FileName
.c_str(), "r");
894 char const * const test
= fgets(buffer
, sizeof(buffer
), gpg
);
896 if (test
== NULL
|| strcmp(buffer
, SIGMSG
) != 0)
902 // ChangeOwnerAndPermissionOfFile - set file attributes to requested values /*{{{*/
903 bool ChangeOwnerAndPermissionOfFile(char const * const requester
, char const * const file
, char const * const user
, char const * const group
, mode_t
const mode
)
905 if (strcmp(file
, "/dev/null") == 0)
908 if (getuid() == 0 && strlen(user
) != 0 && strlen(group
) != 0) // if we aren't root, we can't chown, so don't try it
910 // ensure the file is owned by root and has good permissions
911 struct passwd
const * const pw
= getpwnam(user
);
912 struct group
const * const gr
= getgrnam(group
);
913 if (pw
!= NULL
&& gr
!= NULL
&& chown(file
, pw
->pw_uid
, gr
->gr_gid
) != 0)
914 Res
&= _error
->WarningE(requester
, "chown to %s:%s of file %s failed", user
, group
, file
);
916 if (chmod(file
, mode
) != 0)
917 Res
&= _error
->WarningE(requester
, "chmod 0%o of file %s failed", mode
, file
);
922 class FileFdPrivate
{ /*{{{*/
924 FileFd
* const filefd
;
927 pid_t compressor_pid
;
929 APT::Configuration::Compressor compressor
;
930 unsigned int openmode
;
931 unsigned long long seekpos
;
932 FileFdPrivate(FileFd
* const pfilefd
) : filefd(pfilefd
),
933 compressed_fd(-1), compressor_pid(-1), is_pipe(false),
934 openmode(0), seekpos(0) {};
936 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) = 0;
937 virtual ssize_t
InternalRead(void * const To
, unsigned long long const Size
) = 0;
938 virtual bool InternalReadError() { return filefd
->FileFdErrno("read",_("Read error")); }
939 virtual char * InternalReadLine(char * const To
, unsigned long long const Size
)
941 unsigned long long read
= 0;
942 while ((Size
- 1) != read
)
944 unsigned long long done
= 0;
945 if (filefd
->Read(To
+ read
, 1, &done
) == false)
949 if (To
[read
++] == '\n')
957 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) = 0;
958 virtual bool InternalWriteError() { return filefd
->FileFdErrno("write",_("Write error")); }
959 virtual bool InternalSeek(unsigned long long const To
)
961 // Our poor man seeking is costly, so try to avoid it
962 unsigned long long const iseekpos
= filefd
->Tell();
965 else if (iseekpos
< To
)
966 return filefd
->Skip(To
- iseekpos
);
968 if ((openmode
& FileFd::ReadOnly
) != FileFd::ReadOnly
)
969 return filefd
->FileFdError("Reopen is only implemented for read-only files!");
970 InternalClose(filefd
->FileName
);
971 if (filefd
->iFd
!= -1)
974 if (filefd
->TemporaryFileName
.empty() == false)
975 filefd
->iFd
= open(filefd
->TemporaryFileName
.c_str(), O_RDONLY
);
976 else if (filefd
->FileName
.empty() == false)
977 filefd
->iFd
= open(filefd
->FileName
.c_str(), O_RDONLY
);
980 if (compressed_fd
> 0)
981 if (lseek(compressed_fd
, 0, SEEK_SET
) != 0)
982 filefd
->iFd
= compressed_fd
;
984 return filefd
->FileFdError("Reopen is not implemented for pipes opened with FileFd::OpenDescriptor()!");
987 if (filefd
->OpenInternDescriptor(openmode
, compressor
) == false)
988 return filefd
->FileFdError("Seek on file %s because it couldn't be reopened", filefd
->FileName
.c_str());
991 return filefd
->Skip(To
);
996 virtual bool InternalSkip(unsigned long long Over
)
998 unsigned long long constexpr buffersize
= 1024;
999 char buffer
[buffersize
];
1002 unsigned long long toread
= std::min(buffersize
, Over
);
1003 if (filefd
->Read(buffer
, toread
) == false)
1004 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
1009 virtual bool InternalTruncate(unsigned long long const)
1011 return filefd
->FileFdError("Truncating compressed files is not implemented (%s)", filefd
->FileName
.c_str());
1013 virtual unsigned long long InternalTell()
1015 // In theory, we could just return seekpos here always instead of
1016 // seeking around, but not all users of FileFd use always Seek() and co
1017 // so d->seekpos isn't always true and we can just use it as a hint if
1018 // we have nothing else, but not always as an authority…
1021 virtual unsigned long long InternalSize()
1023 unsigned long long size
= 0;
1024 unsigned long long const oldSeek
= filefd
->Tell();
1025 unsigned long long constexpr ignoresize
= 1024;
1026 char ignore
[ignoresize
];
1027 unsigned long long read
= 0;
1029 if (filefd
->Read(ignore
, ignoresize
, &read
) == false)
1031 filefd
->Seek(oldSeek
);
1035 size
= filefd
->Tell();
1036 filefd
->Seek(oldSeek
);
1039 virtual bool InternalClose(std::string
const &FileName
) = 0;
1040 virtual bool InternalStream() const { return false; }
1041 virtual bool InternalAlwaysAutoClose() const { return true; }
1043 virtual ~FileFdPrivate() {}
1046 class GzipFileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1050 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1052 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1053 gz
= gzdopen(iFd
, "r+");
1054 else if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1055 gz
= gzdopen(iFd
, "w");
1057 gz
= gzdopen(iFd
, "r");
1058 filefd
->Flags
|= FileFd::Compressed
;
1059 return gz
!= nullptr;
1061 virtual ssize_t
InternalRead(void * const To
, unsigned long long const Size
) override
1063 return gzread(gz
, To
, Size
);
1065 virtual bool InternalReadError() override
1068 char const * const errmsg
= gzerror(gz
, &err
);
1070 return filefd
->FileFdError("gzread: %s (%d: %s)", _("Read error"), err
, errmsg
);
1071 return FileFdPrivate::InternalReadError();
1073 virtual char * InternalReadLine(char * const To
, unsigned long long const Size
) override
1075 return gzgets(gz
, To
, Size
);
1077 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1079 return gzwrite(gz
,From
,Size
);
1081 virtual bool InternalWriteError() override
1084 char const * const errmsg
= gzerror(gz
, &err
);
1086 return filefd
->FileFdError("gzwrite: %s (%d: %s)", _("Write error"), err
, errmsg
);
1087 return FileFdPrivate::InternalWriteError();
1089 virtual bool InternalSeek(unsigned long long const To
) override
1091 off_t
const res
= gzseek(gz
, To
, SEEK_SET
);
1092 if (res
!= (off_t
)To
)
1093 return filefd
->FileFdError("Unable to seek to %llu", To
);
1098 virtual bool InternalSkip(unsigned long long Over
) override
1100 off_t
const res
= gzseek(gz
, Over
, SEEK_CUR
);
1102 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
1106 virtual unsigned long long InternalTell() override
1110 virtual unsigned long long InternalSize() override
1112 unsigned long long filesize
= FileFdPrivate::InternalSize();
1113 // only check gzsize if we are actually a gzip file, just checking for
1114 // "gz" is not sufficient as uncompressed files could be opened with
1115 // gzopen in "direct" mode as well
1116 if (filesize
== 0 || gzdirect(gz
))
1119 off_t
const oldPos
= lseek(filefd
->iFd
, 0, SEEK_CUR
);
1120 /* unfortunately zlib.h doesn't provide a gzsize(), so we have to do
1121 * this ourselves; the original (uncompressed) file size is the last 32
1122 * bits of the file */
1123 // FIXME: Size for gz-files is limited by 32bit… no largefile support
1124 if (lseek(filefd
->iFd
, -4, SEEK_END
) < 0)
1126 filefd
->FileFdErrno("lseek","Unable to seek to end of gzipped file");
1130 if (read(filefd
->iFd
, &size
, 4) != 4)
1132 filefd
->FileFdErrno("read","Unable to read original size of gzipped file");
1135 size
= le32toh(size
);
1137 if (lseek(filefd
->iFd
, oldPos
, SEEK_SET
) < 0)
1139 filefd
->FileFdErrno("lseek","Unable to seek in gzipped file");
1144 virtual bool InternalClose(std::string
const &FileName
) override
1148 int const e
= gzclose(gz
);
1150 // gzdclose() on empty files always fails with "buffer error" here, ignore that
1151 if (e
!= 0 && e
!= Z_BUF_ERROR
)
1152 return _error
->Errno("close",_("Problem closing the gzip file %s"), FileName
.c_str());
1156 GzipFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), gz(nullptr) {}
1157 virtual ~GzipFileFdPrivate() { InternalClose(""); }
1161 class Bz2FileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1165 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1167 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1168 bz2
= BZ2_bzdopen(iFd
, "r+");
1169 else if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1170 bz2
= BZ2_bzdopen(iFd
, "w");
1172 bz2
= BZ2_bzdopen(iFd
, "r");
1173 filefd
->Flags
|= FileFd::Compressed
;
1174 return bz2
!= nullptr;
1176 virtual ssize_t
InternalRead(void * const To
, unsigned long long const Size
) override
1178 return BZ2_bzread(bz2
, To
, Size
);
1180 virtual bool InternalReadError() override
1183 char const * const errmsg
= BZ2_bzerror(bz2
, &err
);
1184 if (err
!= BZ_IO_ERROR
)
1185 return filefd
->FileFdError("BZ2_bzread: %s %s (%d: %s)", filefd
->FileName
.c_str(), _("Read error"), err
, errmsg
);
1186 return FileFdPrivate::InternalReadError();
1188 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1190 return BZ2_bzwrite(bz2
, (void*)From
, Size
);
1192 virtual bool InternalWriteError() override
1195 char const * const errmsg
= BZ2_bzerror(bz2
, &err
);
1196 if (err
!= BZ_IO_ERROR
)
1197 return filefd
->FileFdError("BZ2_bzwrite: %s %s (%d: %s)", filefd
->FileName
.c_str(), _("Write error"), err
, errmsg
);
1198 return FileFdPrivate::InternalWriteError();
1200 virtual bool InternalStream() const override
{ return true; }
1201 virtual bool InternalClose(std::string
const &) override
1210 Bz2FileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), bz2(nullptr) {}
1211 virtual ~Bz2FileFdPrivate() { InternalClose(""); }
1215 class LzmaFileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1219 uint8_t buffer
[4096];
1225 LZMAFILE() : file(nullptr), eof(false), compressing(false) { buffer
[0] = '\0'; }
1228 if (compressing
== true)
1230 size_t constexpr buffersize
= sizeof(buffer
)/sizeof(buffer
[0]);
1233 stream
.avail_out
= buffersize
;
1234 stream
.next_out
= buffer
;
1235 err
= lzma_code(&stream
, LZMA_FINISH
);
1236 if (err
!= LZMA_OK
&& err
!= LZMA_STREAM_END
)
1238 _error
->Error("~LZMAFILE: Compress finalisation failed");
1241 size_t const n
= buffersize
- stream
.avail_out
;
1242 if (n
&& fwrite(buffer
, 1, n
, file
) != n
)
1244 _error
->Errno("~LZMAFILE",_("Write error"));
1247 if (err
== LZMA_STREAM_END
)
1257 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1259 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1260 return filefd
->FileFdError("ReadWrite mode is not supported for lzma/xz files %s", filefd
->FileName
.c_str());
1262 if (lzma
== nullptr)
1263 lzma
= new LzmaFileFdPrivate::LZMAFILE
;
1264 if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1265 lzma
->file
= fdopen(iFd
, "w");
1267 lzma
->file
= fdopen(iFd
, "r");
1268 filefd
->Flags
|= FileFd::Compressed
;
1269 if (lzma
->file
== nullptr)
1272 uint32_t const xzlevel
= 6;
1273 uint64_t const memlimit
= UINT64_MAX
;
1274 lzma_stream tmp_stream
= LZMA_STREAM_INIT
;
1275 lzma
->stream
= tmp_stream
;
1277 if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1279 if (compressor
.Name
== "xz")
1281 if (lzma_easy_encoder(&lzma
->stream
, xzlevel
, LZMA_CHECK_CRC32
) != LZMA_OK
)
1286 lzma_options_lzma options
;
1287 lzma_lzma_preset(&options
, xzlevel
);
1288 if (lzma_alone_encoder(&lzma
->stream
, &options
) != LZMA_OK
)
1291 lzma
->compressing
= true;
1295 if (compressor
.Name
== "xz")
1297 if (lzma_auto_decoder(&lzma
->stream
, memlimit
, 0) != LZMA_OK
)
1302 if (lzma_alone_decoder(&lzma
->stream
, memlimit
) != LZMA_OK
)
1305 lzma
->compressing
= false;
1309 virtual ssize_t
InternalRead(void * const To
, unsigned long long const Size
) override
1312 if (lzma
->eof
== true)
1315 lzma
->stream
.next_out
= (uint8_t *) To
;
1316 lzma
->stream
.avail_out
= Size
;
1317 if (lzma
->stream
.avail_in
== 0)
1319 lzma
->stream
.next_in
= lzma
->buffer
;
1320 lzma
->stream
.avail_in
= fread(lzma
->buffer
, 1, sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]), lzma
->file
);
1322 lzma
->err
= lzma_code(&lzma
->stream
, LZMA_RUN
);
1323 if (lzma
->err
== LZMA_STREAM_END
)
1326 Res
= Size
- lzma
->stream
.avail_out
;
1328 else if (lzma
->err
!= LZMA_OK
)
1335 Res
= Size
- lzma
->stream
.avail_out
;
1338 // lzma run was okay, but produced no output…
1345 virtual bool InternalReadError() override
1347 return filefd
->FileFdError("lzma_read: %s (%d)", _("Read error"), lzma
->err
);
1349 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1351 lzma
->stream
.next_in
= (uint8_t *)From
;
1352 lzma
->stream
.avail_in
= Size
;
1353 lzma
->stream
.next_out
= lzma
->buffer
;
1354 lzma
->stream
.avail_out
= sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]);
1355 lzma
->err
= lzma_code(&lzma
->stream
, LZMA_RUN
);
1356 if (lzma
->err
!= LZMA_OK
)
1358 size_t const n
= sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]) - lzma
->stream
.avail_out
;
1359 size_t const m
= (n
== 0) ? 0 : fwrite(lzma
->buffer
, 1, n
, lzma
->file
);
1363 return Size
- lzma
->stream
.avail_in
;
1365 virtual bool InternalWriteError() override
1367 return filefd
->FileFdError("lzma_write: %s (%d)", _("Write error"), lzma
->err
);
1369 virtual bool InternalStream() const override
{ return true; }
1370 virtual bool InternalClose(std::string
const &) override
1377 LzmaFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), lzma(nullptr) {}
1378 virtual ~LzmaFileFdPrivate() { InternalClose(""); }
1382 class PipedFileFdPrivate
: public FileFdPrivate
/*{{{*/
1383 /* if we don't have a specific class dealing with library calls, we (un)compress
1384 by executing a specified binary and pipe in/out what we need */
1387 virtual bool InternalOpen(int const, unsigned int const Mode
) override
1389 // collect zombies here in case we reopen
1390 if (compressor_pid
> 0)
1391 ExecWait(compressor_pid
, "FileFdCompressor", true);
1393 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1394 return filefd
->FileFdError("ReadWrite mode is not supported for file %s", filefd
->FileName
.c_str());
1396 bool const Comp
= (Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
;
1399 // Handle 'decompression' of empty files
1401 fstat(filefd
->iFd
, &Buf
);
1402 if (Buf
.st_size
== 0 && S_ISFIFO(Buf
.st_mode
) == false)
1405 // We don't need the file open - instead let the compressor open it
1406 // as he properly knows better how to efficiently read from 'his' file
1407 if (filefd
->FileName
.empty() == false)
1414 // Create a data pipe
1415 int Pipe
[2] = {-1,-1};
1416 if (pipe(Pipe
) != 0)
1417 return filefd
->FileFdErrno("pipe",_("Failed to create subprocess IPC"));
1418 for (int J
= 0; J
!= 2; J
++)
1419 SetCloseExec(Pipe
[J
],true);
1421 compressed_fd
= filefd
->iFd
;
1425 filefd
->iFd
= Pipe
[1];
1427 filefd
->iFd
= Pipe
[0];
1430 compressor_pid
= ExecFork();
1431 if (compressor_pid
== 0)
1435 dup2(compressed_fd
,STDOUT_FILENO
);
1436 dup2(Pipe
[0],STDIN_FILENO
);
1440 if (compressed_fd
!= -1)
1441 dup2(compressed_fd
,STDIN_FILENO
);
1442 dup2(Pipe
[1],STDOUT_FILENO
);
1444 int const nullfd
= open("/dev/null", O_WRONLY
);
1447 dup2(nullfd
,STDERR_FILENO
);
1451 SetCloseExec(STDOUT_FILENO
,false);
1452 SetCloseExec(STDIN_FILENO
,false);
1454 std::vector
<char const*> Args
;
1455 Args
.push_back(compressor
.Binary
.c_str());
1456 std::vector
<std::string
> const * const addArgs
=
1457 (Comp
== true) ? &(compressor
.CompressArgs
) : &(compressor
.UncompressArgs
);
1458 for (std::vector
<std::string
>::const_iterator a
= addArgs
->begin();
1459 a
!= addArgs
->end(); ++a
)
1460 Args
.push_back(a
->c_str());
1461 if (Comp
== false && filefd
->FileName
.empty() == false)
1463 // commands not needing arguments, do not need to be told about using standard output
1464 // in reality, only testcases with tools like cat, rev, rot13, … are able to trigger this
1465 if (compressor
.CompressArgs
.empty() == false && compressor
.UncompressArgs
.empty() == false)
1466 Args
.push_back("--stdout");
1467 if (filefd
->TemporaryFileName
.empty() == false)
1468 Args
.push_back(filefd
->TemporaryFileName
.c_str());
1470 Args
.push_back(filefd
->FileName
.c_str());
1472 Args
.push_back(NULL
);
1474 execvp(Args
[0],(char **)&Args
[0]);
1475 cerr
<< _("Failed to exec compressor ") << Args
[0] << endl
;
1485 virtual ssize_t
InternalRead(void * const To
, unsigned long long const Size
) override
1487 return read(filefd
->iFd
, To
, Size
);
1489 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1491 return write(filefd
->iFd
, From
, Size
);
1493 virtual bool InternalClose(std::string
const &) override
1496 if (compressor_pid
> 0)
1497 Ret
&= ExecWait(compressor_pid
, "FileFdCompressor", true);
1498 compressor_pid
= -1;
1501 PipedFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
) {}
1502 virtual ~PipedFileFdPrivate() { InternalClose(""); }
1505 class DirectFileFdPrivate
: public FileFdPrivate
/*{{{*/
1508 virtual bool InternalOpen(int const, unsigned int const) override
{ return true; }
1509 virtual ssize_t
InternalRead(void * const To
, unsigned long long const Size
) override
1511 return read(filefd
->iFd
, To
, Size
);
1514 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1516 return write(filefd
->iFd
, From
, Size
);
1518 virtual bool InternalSeek(unsigned long long const To
) override
1520 off_t
const res
= lseek(filefd
->iFd
, To
, SEEK_SET
);
1521 if (res
!= (off_t
)To
)
1522 return filefd
->FileFdError("Unable to seek to %llu", To
);
1526 virtual bool InternalSkip(unsigned long long Over
) override
1528 off_t
const res
= lseek(filefd
->iFd
, Over
, SEEK_CUR
);
1530 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
1534 virtual bool InternalTruncate(unsigned long long const To
) override
1536 if (ftruncate(filefd
->iFd
, To
) != 0)
1537 return filefd
->FileFdError("Unable to truncate to %llu",To
);
1540 virtual unsigned long long InternalTell() override
1542 return lseek(filefd
->iFd
,0,SEEK_CUR
);
1544 virtual unsigned long long InternalSize() override
1546 return filefd
->FileSize();
1548 virtual bool InternalClose(std::string
const &) override
{ return true; }
1549 virtual bool InternalAlwaysAutoClose() const override
{ return false; }
1551 DirectFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
) {}
1552 virtual ~DirectFileFdPrivate() { InternalClose(""); }
1555 // FileFd Constructors /*{{{*/
1556 FileFd::FileFd(std::string FileName
,unsigned int const Mode
,unsigned long AccessMode
) : iFd(-1), Flags(0), d(NULL
)
1558 Open(FileName
,Mode
, None
, AccessMode
);
1560 FileFd::FileFd(std::string FileName
,unsigned int const Mode
, CompressMode Compress
, unsigned long AccessMode
) : iFd(-1), Flags(0), d(NULL
)
1562 Open(FileName
,Mode
, Compress
, AccessMode
);
1564 FileFd::FileFd() : iFd(-1), Flags(AutoClose
), d(NULL
) {}
1565 FileFd::FileFd(int const Fd
, unsigned int const Mode
, CompressMode Compress
) : iFd(-1), Flags(0), d(NULL
)
1567 OpenDescriptor(Fd
, Mode
, Compress
);
1569 FileFd::FileFd(int const Fd
, bool const AutoClose
) : iFd(-1), Flags(0), d(NULL
)
1571 OpenDescriptor(Fd
, ReadWrite
, None
, AutoClose
);
1574 // FileFd::Open - Open a file /*{{{*/
1575 // ---------------------------------------------------------------------
1576 /* The most commonly used open mode combinations are given with Mode */
1577 bool FileFd::Open(string FileName
,unsigned int const Mode
,CompressMode Compress
, unsigned long const AccessMode
)
1579 if (Mode
== ReadOnlyGzip
)
1580 return Open(FileName
, ReadOnly
, Gzip
, AccessMode
);
1582 if (Compress
== Auto
&& (Mode
& WriteOnly
) == WriteOnly
)
1583 return FileFdError("Autodetection on %s only works in ReadOnly openmode!", FileName
.c_str());
1585 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
1586 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
1587 if (Compress
== Auto
)
1589 for (; compressor
!= compressors
.end(); ++compressor
)
1591 std::string file
= FileName
+ compressor
->Extension
;
1592 if (FileExists(file
) == false)
1598 else if (Compress
== Extension
)
1600 std::string::size_type
const found
= FileName
.find_last_of('.');
1602 if (found
!= std::string::npos
)
1604 ext
= FileName
.substr(found
);
1605 if (ext
== ".new" || ext
== ".bak")
1607 std::string::size_type
const found2
= FileName
.find_last_of('.', found
- 1);
1608 if (found2
!= std::string::npos
)
1609 ext
= FileName
.substr(found2
, found
- found2
);
1614 for (; compressor
!= compressors
.end(); ++compressor
)
1615 if (ext
== compressor
->Extension
)
1617 // no matching extension - assume uncompressed (imagine files like 'example.org_Packages')
1618 if (compressor
== compressors
.end())
1619 for (compressor
= compressors
.begin(); compressor
!= compressors
.end(); ++compressor
)
1620 if (compressor
->Name
== ".")
1628 case None
: name
= "."; break;
1629 case Gzip
: name
= "gzip"; break;
1630 case Bzip2
: name
= "bzip2"; break;
1631 case Lzma
: name
= "lzma"; break;
1632 case Xz
: name
= "xz"; break;
1636 return FileFdError("Opening File %s in None, Auto or Extension should be already handled?!?", FileName
.c_str());
1638 for (; compressor
!= compressors
.end(); ++compressor
)
1639 if (compressor
->Name
== name
)
1641 if (compressor
== compressors
.end())
1642 return FileFdError("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
1645 if (compressor
== compressors
.end())
1646 return FileFdError("Can't find a match for specified compressor mode for file %s", FileName
.c_str());
1647 return Open(FileName
, Mode
, *compressor
, AccessMode
);
1649 bool FileFd::Open(string FileName
,unsigned int const Mode
,APT::Configuration::Compressor
const &compressor
, unsigned long const AccessMode
)
1654 if ((Mode
& WriteOnly
) != WriteOnly
&& (Mode
& (Atomic
| Create
| Empty
| Exclusive
)) != 0)
1655 return FileFdError("ReadOnly mode for %s doesn't accept additional flags!", FileName
.c_str());
1656 if ((Mode
& ReadWrite
) == 0)
1657 return FileFdError("No openmode provided in FileFd::Open for %s", FileName
.c_str());
1659 unsigned int OpenMode
= Mode
;
1660 if (FileName
== "/dev/null")
1661 OpenMode
= OpenMode
& ~(Atomic
| Exclusive
| Create
| Empty
);
1663 if ((OpenMode
& Atomic
) == Atomic
)
1667 else if ((OpenMode
& (Exclusive
| Create
)) == (Exclusive
| Create
))
1669 // for atomic, this will be done by rename in Close()
1670 RemoveFile("FileFd::Open", FileName
);
1672 if ((OpenMode
& Empty
) == Empty
)
1675 if (lstat(FileName
.c_str(),&Buf
) == 0 && S_ISLNK(Buf
.st_mode
))
1676 RemoveFile("FileFd::Open", FileName
);
1680 #define if_FLAGGED_SET(FLAG, MODE) if ((OpenMode & FLAG) == FLAG) fileflags |= MODE
1681 if_FLAGGED_SET(ReadWrite
, O_RDWR
);
1682 else if_FLAGGED_SET(ReadOnly
, O_RDONLY
);
1683 else if_FLAGGED_SET(WriteOnly
, O_WRONLY
);
1685 if_FLAGGED_SET(Create
, O_CREAT
);
1686 if_FLAGGED_SET(Empty
, O_TRUNC
);
1687 if_FLAGGED_SET(Exclusive
, O_EXCL
);
1688 #undef if_FLAGGED_SET
1690 if ((OpenMode
& Atomic
) == Atomic
)
1692 char *name
= strdup((FileName
+ ".XXXXXX").c_str());
1694 if((iFd
= mkstemp(name
)) == -1)
1697 return FileFdErrno("mkstemp", "Could not create temporary file for %s", FileName
.c_str());
1700 TemporaryFileName
= string(name
);
1703 // umask() will always set the umask and return the previous value, so
1704 // we first set the umask and then reset it to the old value
1705 mode_t
const CurrentUmask
= umask(0);
1706 umask(CurrentUmask
);
1707 // calculate the actual file permissions (just like open/creat)
1708 mode_t
const FilePermissions
= (AccessMode
& ~CurrentUmask
);
1710 if(fchmod(iFd
, FilePermissions
) == -1)
1711 return FileFdErrno("fchmod", "Could not change permissions for temporary file %s", TemporaryFileName
.c_str());
1714 iFd
= open(FileName
.c_str(), fileflags
, AccessMode
);
1716 this->FileName
= FileName
;
1717 if (iFd
== -1 || OpenInternDescriptor(OpenMode
, compressor
) == false)
1724 return FileFdErrno("open",_("Could not open file %s"), FileName
.c_str());
1727 SetCloseExec(iFd
,true);
1731 // FileFd::OpenDescriptor - Open a filedescriptor /*{{{*/
1732 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, CompressMode Compress
, bool AutoClose
)
1734 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
1735 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
1738 // compat with the old API
1739 if (Mode
== ReadOnlyGzip
&& Compress
== None
)
1744 case None
: name
= "."; break;
1745 case Gzip
: name
= "gzip"; break;
1746 case Bzip2
: name
= "bzip2"; break;
1747 case Lzma
: name
= "lzma"; break;
1748 case Xz
: name
= "xz"; break;
1751 if (AutoClose
== true && Fd
!= -1)
1753 return FileFdError("Opening Fd %d in Auto or Extension compression mode is not supported", Fd
);
1755 for (; compressor
!= compressors
.end(); ++compressor
)
1756 if (compressor
->Name
== name
)
1758 if (compressor
== compressors
.end())
1760 if (AutoClose
== true && Fd
!= -1)
1762 return FileFdError("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
1764 return OpenDescriptor(Fd
, Mode
, *compressor
, AutoClose
);
1766 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
, bool AutoClose
)
1769 Flags
= (AutoClose
) ? FileFd::AutoClose
: 0;
1771 this->FileName
= "";
1772 if (OpenInternDescriptor(Mode
, compressor
) == false)
1775 (Flags
& Compressed
) == Compressed
||
1781 return FileFdError(_("Could not open file descriptor %d"), Fd
);
1785 bool FileFd::OpenInternDescriptor(unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
)
1791 d
->InternalClose(FileName
);
1796 /* dummy so that the rest can be 'else if's */;
1797 #define APT_COMPRESS_INIT(NAME, CONSTRUCTOR) \
1798 else if (compressor.Name == NAME) \
1799 d = new CONSTRUCTOR(this)
1801 APT_COMPRESS_INIT("gzip", GzipFileFdPrivate
);
1804 APT_COMPRESS_INIT("bzip2", Bz2FileFdPrivate
);
1807 APT_COMPRESS_INIT("xz", LzmaFileFdPrivate
);
1808 APT_COMPRESS_INIT("lzma", LzmaFileFdPrivate
);
1810 #undef APT_COMPRESS_INIT
1811 else if (compressor
.Name
== "." || compressor
.Binary
.empty() == true)
1812 d
= new DirectFileFdPrivate(this);
1814 d
= new PipedFileFdPrivate(this);
1817 d
->compressor
= compressor
;
1818 if ((Flags
& AutoClose
) != AutoClose
&& d
->InternalAlwaysAutoClose())
1820 // Need to duplicate fd here or gz/bz2 close for cleanup will close the fd as well
1821 int const internFd
= dup(iFd
);
1823 return FileFdErrno("OpenInternDescriptor", _("Could not open file descriptor %d"), iFd
);
1827 return d
->InternalOpen(iFd
, Mode
);
1830 // FileFd::~File - Closes the file /*{{{*/
1831 // ---------------------------------------------------------------------
1832 /* If the proper modes are selected then we close the Fd and possibly
1833 unlink the file on error. */
1838 d
->InternalClose(FileName
);
1843 // FileFd::Read - Read a bit of the file /*{{{*/
1844 // ---------------------------------------------------------------------
1845 /* We are careful to handle interruption by a signal while reading
1847 bool FileFd::Read(void *To
,unsigned long long Size
,unsigned long long *Actual
)
1855 *((char *)To
) = '\0';
1856 while (Res
> 0 && Size
> 0)
1858 Res
= d
->InternalRead(To
, Size
);
1864 // trick the while-loop into running again
1869 return d
->InternalReadError();
1872 To
= (char *)To
+ Res
;
1890 return FileFdError(_("read, still have %llu to read but none left"), Size
);
1893 // FileFd::ReadLine - Read a complete line from the file /*{{{*/
1894 // ---------------------------------------------------------------------
1895 /* Beware: This method can be quite slow for big buffers on UNcompressed
1896 files because of the naive implementation! */
1897 char* FileFd::ReadLine(char *To
, unsigned long long const Size
)
1902 return d
->InternalReadLine(To
, Size
);
1905 // FileFd::Write - Write to the file /*{{{*/
1906 bool FileFd::Write(const void *From
,unsigned long long Size
)
1912 while (Res
> 0 && Size
> 0)
1914 Res
= d
->InternalWrite(From
, Size
);
1915 if (Res
< 0 && errno
== EINTR
)
1918 return d
->InternalWriteError();
1920 From
= (char const *)From
+ Res
;
1929 return FileFdError(_("write, still have %llu to write but couldn't"), Size
);
1931 bool FileFd::Write(int Fd
, const void *From
, unsigned long long Size
)
1935 while (Res
> 0 && Size
> 0)
1937 Res
= write(Fd
,From
,Size
);
1938 if (Res
< 0 && errno
== EINTR
)
1941 return _error
->Errno("write",_("Write error"));
1943 From
= (char const *)From
+ Res
;
1950 return _error
->Error(_("write, still have %llu to write but couldn't"), Size
);
1953 // FileFd::Seek - Seek in the file /*{{{*/
1954 bool FileFd::Seek(unsigned long long To
)
1959 return d
->InternalSeek(To
);
1962 // FileFd::Skip - Skip over data in the file /*{{{*/
1963 bool FileFd::Skip(unsigned long long Over
)
1967 return d
->InternalSkip(Over
);
1970 // FileFd::Truncate - Truncate the file /*{{{*/
1971 bool FileFd::Truncate(unsigned long long To
)
1975 // truncating /dev/null is always successful - as we get an error otherwise
1976 if (To
== 0 && FileName
== "/dev/null")
1978 return d
->InternalTruncate(To
);
1981 // FileFd::Tell - Current seek position /*{{{*/
1982 // ---------------------------------------------------------------------
1984 unsigned long long FileFd::Tell()
1988 off_t
const Res
= d
->InternalTell();
1989 if (Res
== (off_t
)-1)
1990 FileFdErrno("lseek","Failed to determine the current file position");
1995 static bool StatFileFd(char const * const msg
, int const iFd
, std::string
const &FileName
, struct stat
&Buf
, FileFdPrivate
* const d
) /*{{{*/
1997 bool ispipe
= (d
!= NULL
&& d
->is_pipe
== true);
1998 if (ispipe
== false)
2000 if (fstat(iFd
,&Buf
) != 0)
2001 // higher-level code will generate more meaningful messages,
2002 // even translated this would be meaningless for users
2003 return _error
->Errno("fstat", "Unable to determine %s for fd %i", msg
, iFd
);
2004 if (FileName
.empty() == false)
2005 ispipe
= S_ISFIFO(Buf
.st_mode
);
2008 // for compressor pipes st_size is undefined and at 'best' zero
2011 // we set it here, too, as we get the info here for free
2012 // in theory the Open-methods should take care of it already
2015 if (stat(FileName
.c_str(), &Buf
) != 0)
2016 return _error
->Errno("fstat", "Unable to determine %s for file %s", msg
, FileName
.c_str());
2021 // FileFd::FileSize - Return the size of the file /*{{{*/
2022 unsigned long long FileFd::FileSize()
2025 if (StatFileFd("file size", iFd
, FileName
, Buf
, d
) == false)
2033 // FileFd::ModificationTime - Return the time of last touch /*{{{*/
2034 time_t FileFd::ModificationTime()
2037 if (StatFileFd("modification time", iFd
, FileName
, Buf
, d
) == false)
2042 return Buf
.st_mtime
;
2045 // FileFd::Size - Return the size of the content in the file /*{{{*/
2046 unsigned long long FileFd::Size()
2050 return d
->InternalSize();
2053 // FileFd::Close - Close the file if the close flag is set /*{{{*/
2054 // ---------------------------------------------------------------------
2056 bool FileFd::Close()
2062 if ((Flags
& AutoClose
) == AutoClose
)
2064 if ((Flags
& Compressed
) != Compressed
&& iFd
> 0 && close(iFd
) != 0)
2065 Res
&= _error
->Errno("close",_("Problem closing the file %s"), FileName
.c_str());
2070 Res
&= d
->InternalClose(FileName
);
2075 if ((Flags
& Replace
) == Replace
) {
2076 if (rename(TemporaryFileName
.c_str(), FileName
.c_str()) != 0)
2077 Res
&= _error
->Errno("rename",_("Problem renaming the file %s to %s"), TemporaryFileName
.c_str(), FileName
.c_str());
2079 FileName
= TemporaryFileName
; // for the unlink() below.
2080 TemporaryFileName
.clear();
2085 if ((Flags
& Fail
) == Fail
&& (Flags
& DelOnFail
) == DelOnFail
&&
2086 FileName
.empty() == false)
2087 Res
&= RemoveFile("FileFd::Close", FileName
);
2094 // FileFd::Sync - Sync the file /*{{{*/
2095 // ---------------------------------------------------------------------
2099 if (fsync(iFd
) != 0)
2100 return FileFdErrno("sync",_("Problem syncing the file"));
2104 // FileFd::FileFdErrno - set Fail and call _error->Errno *{{{*/
2105 bool FileFd::FileFdErrno(const char *Function
, const char *Description
,...)
2109 size_t msgSize
= 400;
2110 int const errsv
= errno
;
2113 va_start(args
,Description
);
2114 if (_error
->InsertErrno(GlobalError::ERROR
, Function
, Description
, args
, errsv
, msgSize
) == false)
2121 // FileFd::FileFdError - set Fail and call _error->Error *{{{*/
2122 bool FileFd::FileFdError(const char *Description
,...) {
2125 size_t msgSize
= 400;
2128 va_start(args
,Description
);
2129 if (_error
->Insert(GlobalError::ERROR
, Description
, args
, msgSize
) == false)
2136 gzFile
FileFd::gzFd() { /*{{{*/
2138 GzipFileFdPrivate
* const gzipd
= dynamic_cast<GzipFileFdPrivate
*>(d
);
2139 if (gzipd
== nullptr)
2149 // Glob - wrapper around "glob()" /*{{{*/
2150 std::vector
<std::string
> Glob(std::string
const &pattern
, int flags
)
2152 std::vector
<std::string
> result
;
2157 glob_res
= glob(pattern
.c_str(), flags
, NULL
, &globbuf
);
2161 if(glob_res
!= GLOB_NOMATCH
) {
2162 _error
->Errno("glob", "Problem with glob");
2168 for(i
=0;i
<globbuf
.gl_pathc
;i
++)
2169 result
.push_back(string(globbuf
.gl_pathv
[i
]));
2175 std::string
GetTempDir() /*{{{*/
2177 const char *tmpdir
= getenv("TMPDIR");
2185 if (!tmpdir
|| strlen(tmpdir
) == 0 || // tmpdir is set
2186 stat(tmpdir
, &st
) != 0 || (st
.st_mode
& S_IFDIR
) == 0) // exists and is directory
2188 else if (geteuid() != 0 && // root can do everything anyway
2189 faccessat(-1, tmpdir
, R_OK
| W_OK
| X_OK
, AT_EACCESS
| AT_SYMLINK_NOFOLLOW
) != 0) // current user has rwx access to directory
2192 return string(tmpdir
);
2194 std::string
GetTempDir(std::string
const &User
)
2196 // no need/possibility to drop privs
2197 if(getuid() != 0 || User
.empty() || User
== "root")
2198 return GetTempDir();
2200 struct passwd
const * const pw
= getpwnam(User
.c_str());
2202 return GetTempDir();
2204 gid_t
const old_euid
= geteuid();
2205 gid_t
const old_egid
= getegid();
2206 if (setegid(pw
->pw_gid
) != 0)
2207 _error
->Errno("setegid", "setegid %u failed", pw
->pw_gid
);
2208 if (seteuid(pw
->pw_uid
) != 0)
2209 _error
->Errno("seteuid", "seteuid %u failed", pw
->pw_uid
);
2211 std::string
const tmp
= GetTempDir();
2213 if (seteuid(old_euid
) != 0)
2214 _error
->Errno("seteuid", "seteuid %u failed", old_euid
);
2215 if (setegid(old_egid
) != 0)
2216 _error
->Errno("setegid", "setegid %u failed", old_egid
);
2221 FileFd
* GetTempFile(std::string
const &Prefix
, bool ImmediateUnlink
, FileFd
* const TmpFd
) /*{{{*/
2224 FileFd
* const Fd
= TmpFd
== NULL
? new FileFd() : TmpFd
;
2226 std::string
const tempdir
= GetTempDir();
2227 snprintf(fn
, sizeof(fn
), "%s/%s.XXXXXX",
2228 tempdir
.c_str(), Prefix
.c_str());
2229 int const fd
= mkstemp(fn
);
2234 _error
->Errno("GetTempFile",_("Unable to mkstemp %s"), fn
);
2237 if (!Fd
->OpenDescriptor(fd
, FileFd::ReadWrite
, FileFd::None
, true))
2239 _error
->Errno("GetTempFile",_("Unable to write to %s"),fn
);
2245 bool Rename(std::string From
, std::string To
) /*{{{*/
2247 if (rename(From
.c_str(),To
.c_str()) != 0)
2249 _error
->Error(_("rename failed, %s (%s -> %s)."),strerror(errno
),
2250 From
.c_str(),To
.c_str());
2256 bool Popen(const char* Args
[], FileFd
&Fd
, pid_t
&Child
, FileFd::OpenMode Mode
)/*{{{*/
2259 if (Mode
!= FileFd::ReadOnly
&& Mode
!= FileFd::WriteOnly
)
2260 return _error
->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2262 int Pipe
[2] = {-1, -1};
2264 return _error
->Errno("pipe", _("Failed to create subprocess IPC"));
2266 std::set
<int> keep_fds
;
2267 keep_fds
.insert(Pipe
[0]);
2268 keep_fds
.insert(Pipe
[1]);
2269 Child
= ExecFork(keep_fds
);
2271 return _error
->Errno("fork", "Failed to fork");
2274 if(Mode
== FileFd::ReadOnly
)
2279 else if(Mode
== FileFd::WriteOnly
)
2285 if(Mode
== FileFd::ReadOnly
)
2289 } else if(Mode
== FileFd::WriteOnly
)
2292 execv(Args
[0], (char**)Args
);
2295 if(Mode
== FileFd::ReadOnly
)
2300 else if(Mode
== FileFd::WriteOnly
)
2306 return _error
->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2307 Fd
.OpenDescriptor(fd
, Mode
, FileFd::None
, true);
2312 bool DropPrivileges() /*{{{*/
2314 if(_config
->FindB("Debug::NoDropPrivs", false) == true)
2318 #if defined(PR_SET_NO_NEW_PRIVS) && ( PR_SET_NO_NEW_PRIVS != 38 )
2319 #error "PR_SET_NO_NEW_PRIVS is defined, but with a different value than expected!"
2321 // see prctl(2), needs linux3.5 at runtime - magic constant to avoid it at buildtime
2322 int ret
= prctl(38, 1, 0, 0, 0);
2323 // ignore EINVAL - kernel is too old to understand the option
2324 if(ret
< 0 && errno
!= EINVAL
)
2325 _error
->Warning("PR_SET_NO_NEW_PRIVS failed with %i", ret
);
2328 // empty setting disables privilege dropping - this also ensures
2329 // backward compatibility, see bug #764506
2330 const std::string toUser
= _config
->Find("APT::Sandbox::User");
2331 if (toUser
.empty() || toUser
== "root")
2334 // a lot can go wrong trying to drop privileges completely,
2335 // so ideally we would like to verify that we have done it –
2336 // but the verify asks for too much in case of fakeroot (and alike)
2337 // [Specific checks can be overridden with dedicated options]
2338 bool const VerifySandboxing
= _config
->FindB("APT::Sandbox::Verify", false);
2340 // uid will be 0 in the end, but gid might be different anyway
2341 uid_t
const old_uid
= getuid();
2342 gid_t
const old_gid
= getgid();
2347 struct passwd
*pw
= getpwnam(toUser
.c_str());
2349 return _error
->Error("No user %s, can not drop rights", toUser
.c_str());
2351 // Do not change the order here, it might break things
2352 // Get rid of all our supplementary groups first
2353 if (setgroups(1, &pw
->pw_gid
))
2354 return _error
->Errno("setgroups", "Failed to setgroups");
2356 // Now change the group ids to the new user
2357 #ifdef HAVE_SETRESGID
2358 if (setresgid(pw
->pw_gid
, pw
->pw_gid
, pw
->pw_gid
) != 0)
2359 return _error
->Errno("setresgid", "Failed to set new group ids");
2361 if (setegid(pw
->pw_gid
) != 0)
2362 return _error
->Errno("setegid", "Failed to setegid");
2364 if (setgid(pw
->pw_gid
) != 0)
2365 return _error
->Errno("setgid", "Failed to setgid");
2368 // Change the user ids to the new user
2369 #ifdef HAVE_SETRESUID
2370 if (setresuid(pw
->pw_uid
, pw
->pw_uid
, pw
->pw_uid
) != 0)
2371 return _error
->Errno("setresuid", "Failed to set new user ids");
2373 if (setuid(pw
->pw_uid
) != 0)
2374 return _error
->Errno("setuid", "Failed to setuid");
2375 if (seteuid(pw
->pw_uid
) != 0)
2376 return _error
->Errno("seteuid", "Failed to seteuid");
2379 // disabled by default as fakeroot doesn't implement getgroups currently (#806521)
2380 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::Groups", false) == true)
2382 // Verify that the user isn't still in any supplementary groups
2383 long const ngroups_max
= sysconf(_SC_NGROUPS_MAX
);
2384 std::unique_ptr
<gid_t
[]> gidlist(new gid_t
[ngroups_max
]);
2385 if (unlikely(gidlist
== NULL
))
2386 return _error
->Error("Allocation of a list of size %lu for getgroups failed", ngroups_max
);
2388 if ((gidlist_nr
= getgroups(ngroups_max
, gidlist
.get())) < 0)
2389 return _error
->Errno("getgroups", "Could not get new groups (%lu)", ngroups_max
);
2390 for (ssize_t i
= 0; i
< gidlist_nr
; ++i
)
2391 if (gidlist
[i
] != pw
->pw_gid
)
2392 return _error
->Error("Could not switch group, user %s is still in group %d", toUser
.c_str(), gidlist
[i
]);
2395 // enabled by default as all fakeroot-lookalikes should fake that accordingly
2396 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::IDs", true) == true)
2398 // Verify that gid, egid, uid, and euid changed
2399 if (getgid() != pw
->pw_gid
)
2400 return _error
->Error("Could not switch group");
2401 if (getegid() != pw
->pw_gid
)
2402 return _error
->Error("Could not switch effective group");
2403 if (getuid() != pw
->pw_uid
)
2404 return _error
->Error("Could not switch user");
2405 if (geteuid() != pw
->pw_uid
)
2406 return _error
->Error("Could not switch effective user");
2408 #ifdef HAVE_GETRESUID
2409 // verify that the saved set-user-id was changed as well
2413 if (getresuid(&ruid
, &euid
, &suid
))
2414 return _error
->Errno("getresuid", "Could not get saved set-user-ID");
2415 if (suid
!= pw
->pw_uid
)
2416 return _error
->Error("Could not switch saved set-user-ID");
2419 #ifdef HAVE_GETRESGID
2420 // verify that the saved set-group-id was changed as well
2424 if (getresgid(&rgid
, &egid
, &sgid
))
2425 return _error
->Errno("getresuid", "Could not get saved set-group-ID");
2426 if (sgid
!= pw
->pw_gid
)
2427 return _error
->Error("Could not switch saved set-group-ID");
2431 // disabled as fakeroot doesn't forbid (by design) (re)gaining root from unprivileged
2432 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::Regain", false) == true)
2434 // Check that uid and gid changes do not work anymore
2435 if (pw
->pw_gid
!= old_gid
&& (setgid(old_gid
) != -1 || setegid(old_gid
) != -1))
2436 return _error
->Error("Could restore a gid to root, privilege dropping did not work");
2438 if (pw
->pw_uid
!= old_uid
&& (setuid(old_uid
) != -1 || seteuid(old_uid
) != -1))
2439 return _error
->Error("Could restore a uid to root, privilege dropping did not work");