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>
73 #include <sys/prctl.h>
81 /* Should be a multiple of the common page size (4096) */
82 static constexpr unsigned long long APT_BUFFER_SIZE
= 64 * 1024;
84 // RunScripts - Run a set of scripts from a configuration subtree /*{{{*/
85 // ---------------------------------------------------------------------
87 bool RunScripts(const char *Cnf
)
89 Configuration::Item
const *Opts
= _config
->Tree(Cnf
);
90 if (Opts
== 0 || Opts
->Child
== 0)
94 // Fork for running the system calls
95 pid_t Child
= ExecFork();
100 if (_config
->FindDir("DPkg::Chroot-Directory","/") != "/")
102 std::cerr
<< "Chrooting into "
103 << _config
->FindDir("DPkg::Chroot-Directory")
105 if (chroot(_config
->FindDir("DPkg::Chroot-Directory","/").c_str()) != 0)
109 if (chdir("/tmp/") != 0)
112 unsigned int Count
= 1;
113 for (; Opts
!= 0; Opts
= Opts
->Next
, Count
++)
115 if (Opts
->Value
.empty() == true)
118 if(_config
->FindB("Debug::RunScripts", false) == true)
119 std::clog
<< "Running external script: '"
120 << Opts
->Value
<< "'" << std::endl
;
122 if (system(Opts
->Value
.c_str()) != 0)
128 // Wait for the child
130 while (waitpid(Child
,&Status
,0) != Child
)
134 return _error
->Errno("waitpid","Couldn't wait for subprocess");
137 // Restore sig int/quit
138 signal(SIGQUIT
,SIG_DFL
);
139 signal(SIGINT
,SIG_DFL
);
141 // Check for an error code.
142 if (WIFEXITED(Status
) == 0 || WEXITSTATUS(Status
) != 0)
144 unsigned int Count
= WEXITSTATUS(Status
);
148 for (; Opts
!= 0 && Count
!= 1; Opts
= Opts
->Next
, Count
--);
149 _error
->Error("Problem executing scripts %s '%s'",Cnf
,Opts
->Value
.c_str());
152 return _error
->Error("Sub-process returned an error code");
159 // CopyFile - Buffered copy of a file /*{{{*/
160 // ---------------------------------------------------------------------
161 /* The caller is expected to set things so that failure causes erasure */
162 bool CopyFile(FileFd
&From
,FileFd
&To
)
164 if (From
.IsOpen() == false || To
.IsOpen() == false ||
165 From
.Failed() == true || To
.Failed() == true)
168 // Buffered copy between fds
169 constexpr size_t BufSize
= APT_BUFFER_SIZE
;
170 std::unique_ptr
<unsigned char[]> Buf(new unsigned char[BufSize
]);
171 unsigned long long ToRead
= 0;
173 if (From
.Read(Buf
.get(),BufSize
, &ToRead
) == false ||
174 To
.Write(Buf
.get(),ToRead
) == false)
176 } while (ToRead
!= 0);
181 bool RemoveFile(char const * const Function
, std::string
const &FileName
)/*{{{*/
183 if (FileName
== "/dev/null")
186 if (unlink(FileName
.c_str()) != 0)
191 return _error
->WarningE(Function
,_("Problem unlinking the file %s"), FileName
.c_str());
196 // GetLock - Gets a lock file /*{{{*/
197 // ---------------------------------------------------------------------
198 /* This will create an empty file of the given name and lock it. Once this
199 is done all other calls to GetLock in any other process will fail with
200 -1. The return result is the fd of the file, the call should call
201 close at some time. */
202 int GetLock(string File
,bool Errors
)
204 // GetLock() is used in aptitude on directories with public-write access
205 // Use O_NOFOLLOW here to prevent symlink traversal attacks
206 int FD
= open(File
.c_str(),O_RDWR
| O_CREAT
| O_NOFOLLOW
,0640);
209 // Read only .. can't have locking problems there.
212 _error
->Warning(_("Not using locking for read only lock file %s"),File
.c_str());
213 return dup(0); // Need something for the caller to close
217 _error
->Errno("open",_("Could not open lock file %s"),File
.c_str());
219 // Feh.. We do this to distinguish the lock vs open case..
223 SetCloseExec(FD
,true);
225 // Acquire a write lock
228 fl
.l_whence
= SEEK_SET
;
231 if (fcntl(FD
,F_SETLK
,&fl
) == -1)
233 // always close to not leak resources
240 _error
->Warning(_("Not using locking for nfs mounted lock file %s"),File
.c_str());
241 return dup(0); // Need something for the caller to close
245 _error
->Errno("open",_("Could not get lock %s"),File
.c_str());
253 // FileExists - Check if a file exists /*{{{*/
254 // ---------------------------------------------------------------------
255 /* Beware: Directories are also files! */
256 bool FileExists(string File
)
259 if (stat(File
.c_str(),&Buf
) != 0)
264 // RealFileExists - Check if a file exists and if it is really a file /*{{{*/
265 // ---------------------------------------------------------------------
267 bool RealFileExists(string File
)
270 if (stat(File
.c_str(),&Buf
) != 0)
272 return ((Buf
.st_mode
& S_IFREG
) != 0);
275 // DirectoryExists - Check if a directory exists and is really one /*{{{*/
276 // ---------------------------------------------------------------------
278 bool DirectoryExists(string
const &Path
)
281 if (stat(Path
.c_str(),&Buf
) != 0)
283 return ((Buf
.st_mode
& S_IFDIR
) != 0);
286 // CreateDirectory - poor man's mkdir -p guarded by a parent directory /*{{{*/
287 // ---------------------------------------------------------------------
288 /* This method will create all directories needed for path in good old
289 mkdir -p style but refuses to do this if Parent is not a prefix of
290 this Path. Example: /var/cache/ and /var/cache/apt/archives are given,
291 so it will create apt/archives if /var/cache exists - on the other
292 hand if the parent is /var/lib the creation will fail as this path
293 is not a parent of the path to be generated. */
294 bool CreateDirectory(string
const &Parent
, string
const &Path
)
296 if (Parent
.empty() == true || Path
.empty() == true)
299 if (DirectoryExists(Path
) == true)
302 if (DirectoryExists(Parent
) == false)
305 // we are not going to create directories "into the blue"
306 if (Path
.compare(0, Parent
.length(), Parent
) != 0)
309 vector
<string
> const dirs
= VectorizeString(Path
.substr(Parent
.size()), '/');
310 string progress
= Parent
;
311 for (vector
<string
>::const_iterator d
= dirs
.begin(); d
!= dirs
.end(); ++d
)
313 if (d
->empty() == true)
316 progress
.append("/").append(*d
);
317 if (DirectoryExists(progress
) == true)
320 if (mkdir(progress
.c_str(), 0755) != 0)
326 // CreateAPTDirectoryIfNeeded - ensure that the given directory exists /*{{{*/
327 // ---------------------------------------------------------------------
328 /* a small wrapper around CreateDirectory to check if it exists and to
329 remove the trailing "/apt/" from the parent directory if needed */
330 bool CreateAPTDirectoryIfNeeded(string
const &Parent
, string
const &Path
)
332 if (DirectoryExists(Path
) == true)
335 size_t const len
= Parent
.size();
336 if (len
> 5 && Parent
.find("/apt/", len
- 6, 5) == len
- 5)
338 if (CreateDirectory(Parent
.substr(0,len
-5), Path
) == true)
341 else if (CreateDirectory(Parent
, Path
) == true)
347 // GetListOfFilesInDir - returns a vector of files in the given dir /*{{{*/
348 // ---------------------------------------------------------------------
349 /* If an extension is given only files with this extension are included
350 in the returned vector, otherwise every "normal" file is included. */
351 std::vector
<string
> GetListOfFilesInDir(string
const &Dir
, string
const &Ext
,
352 bool const &SortList
, bool const &AllowNoExt
)
354 std::vector
<string
> ext
;
356 if (Ext
.empty() == false)
358 if (AllowNoExt
== true && ext
.empty() == false)
360 return GetListOfFilesInDir(Dir
, ext
, SortList
);
362 std::vector
<string
> GetListOfFilesInDir(string
const &Dir
, std::vector
<string
> const &Ext
,
363 bool const &SortList
)
365 // Attention debuggers: need to be set with the environment config file!
366 bool const Debug
= _config
->FindB("Debug::GetListOfFilesInDir", false);
369 std::clog
<< "Accept in " << Dir
<< " only files with the following " << Ext
.size() << " extensions:" << std::endl
;
370 if (Ext
.empty() == true)
371 std::clog
<< "\tNO extension" << std::endl
;
373 for (std::vector
<string
>::const_iterator e
= Ext
.begin();
375 std::clog
<< '\t' << (e
->empty() == true ? "NO" : *e
) << " extension" << std::endl
;
378 std::vector
<string
> List
;
380 if (DirectoryExists(Dir
) == false)
382 _error
->Error(_("List of files can't be created as '%s' is not a directory"), Dir
.c_str());
386 Configuration::MatchAgainstConfig
SilentIgnore("Dir::Ignore-Files-Silently");
387 DIR *D
= opendir(Dir
.c_str());
390 _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
394 for (struct dirent
*Ent
= readdir(D
); Ent
!= 0; Ent
= readdir(D
))
396 // skip "hidden" files
397 if (Ent
->d_name
[0] == '.')
400 // Make sure it is a file and not something else
401 string
const File
= flCombine(Dir
,Ent
->d_name
);
402 #ifdef _DIRENT_HAVE_D_TYPE
403 if (Ent
->d_type
!= DT_REG
)
406 if (RealFileExists(File
) == false)
408 // do not show ignoration warnings for directories
410 #ifdef _DIRENT_HAVE_D_TYPE
411 Ent
->d_type
== DT_DIR
||
413 DirectoryExists(File
) == true)
415 if (SilentIgnore
.Match(Ent
->d_name
) == false)
416 _error
->Notice(_("Ignoring '%s' in directory '%s' as it is not a regular file"), Ent
->d_name
, Dir
.c_str());
421 // check for accepted extension:
422 // no extension given -> periods are bad as hell!
423 // extensions given -> "" extension allows no extension
424 if (Ext
.empty() == false)
426 string d_ext
= flExtension(Ent
->d_name
);
427 if (d_ext
== Ent
->d_name
) // no extension
429 if (std::find(Ext
.begin(), Ext
.end(), "") == Ext
.end())
432 std::clog
<< "Bad file: " << Ent
->d_name
<< " → no extension" << std::endl
;
433 if (SilentIgnore
.Match(Ent
->d_name
) == false)
434 _error
->Notice(_("Ignoring file '%s' in directory '%s' as it has no filename extension"), Ent
->d_name
, Dir
.c_str());
438 else if (std::find(Ext
.begin(), Ext
.end(), d_ext
) == Ext
.end())
441 std::clog
<< "Bad file: " << Ent
->d_name
<< " → bad extension »" << flExtension(Ent
->d_name
) << "«" << std::endl
;
442 if (SilentIgnore
.Match(Ent
->d_name
) == false)
443 _error
->Notice(_("Ignoring file '%s' in directory '%s' as it has an invalid filename extension"), Ent
->d_name
, Dir
.c_str());
448 // Skip bad filenames ala run-parts
449 const char *C
= Ent
->d_name
;
451 if (isalpha(*C
) == 0 && isdigit(*C
) == 0
452 && *C
!= '_' && *C
!= '-' && *C
!= ':') {
453 // no required extension -> dot is a bad character
454 if (*C
== '.' && Ext
.empty() == false)
459 // we don't reach the end of the name -> bad character included
463 std::clog
<< "Bad file: " << Ent
->d_name
<< " → bad character »"
464 << *C
<< "« in filename (period allowed: " << (Ext
.empty() ? "no" : "yes") << ")" << std::endl
;
468 // skip filenames which end with a period. These are never valid
472 std::clog
<< "Bad file: " << Ent
->d_name
<< " → Period as last character" << std::endl
;
477 std::clog
<< "Accept file: " << Ent
->d_name
<< " in " << Dir
<< std::endl
;
478 List
.push_back(File
);
482 if (SortList
== true)
483 std::sort(List
.begin(),List
.end());
486 std::vector
<string
> GetListOfFilesInDir(string
const &Dir
, bool SortList
)
488 bool const Debug
= _config
->FindB("Debug::GetListOfFilesInDir", false);
490 std::clog
<< "Accept in " << Dir
<< " all regular files" << std::endl
;
492 std::vector
<string
> List
;
494 if (DirectoryExists(Dir
) == false)
496 _error
->Error(_("List of files can't be created as '%s' is not a directory"), Dir
.c_str());
500 DIR *D
= opendir(Dir
.c_str());
503 _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
507 for (struct dirent
*Ent
= readdir(D
); Ent
!= 0; Ent
= readdir(D
))
509 // skip "hidden" files
510 if (Ent
->d_name
[0] == '.')
513 // Make sure it is a file and not something else
514 string
const File
= flCombine(Dir
,Ent
->d_name
);
515 #ifdef _DIRENT_HAVE_D_TYPE
516 if (Ent
->d_type
!= DT_REG
)
519 if (RealFileExists(File
) == false)
522 std::clog
<< "Bad file: " << Ent
->d_name
<< " → it is not a real file" << std::endl
;
527 // Skip bad filenames ala run-parts
528 const char *C
= Ent
->d_name
;
530 if (isalpha(*C
) == 0 && isdigit(*C
) == 0
531 && *C
!= '_' && *C
!= '-' && *C
!= '.')
534 // we don't reach the end of the name -> bad character included
538 std::clog
<< "Bad file: " << Ent
->d_name
<< " → bad character »" << *C
<< "« in filename" << std::endl
;
542 // skip filenames which end with a period. These are never valid
546 std::clog
<< "Bad file: " << Ent
->d_name
<< " → Period as last character" << std::endl
;
551 std::clog
<< "Accept file: " << Ent
->d_name
<< " in " << Dir
<< std::endl
;
552 List
.push_back(File
);
556 if (SortList
== true)
557 std::sort(List
.begin(),List
.end());
561 // SafeGetCWD - This is a safer getcwd that returns a dynamic string /*{{{*/
562 // ---------------------------------------------------------------------
563 /* We return / on failure. */
566 // Stash the current dir.
569 if (getcwd(S
,sizeof(S
)-2) == 0)
571 unsigned int Len
= strlen(S
);
577 // GetModificationTime - Get the mtime of the given file or -1 on error /*{{{*/
578 // ---------------------------------------------------------------------
579 /* We return / on failure. */
580 time_t GetModificationTime(string
const &Path
)
583 if (stat(Path
.c_str(), &St
) < 0)
588 // flNotDir - Strip the directory from the filename /*{{{*/
589 // ---------------------------------------------------------------------
591 string
flNotDir(string File
)
593 string::size_type Res
= File
.rfind('/');
594 if (Res
== string::npos
)
597 return string(File
,Res
,Res
- File
.length());
600 // flNotFile - Strip the file from the directory name /*{{{*/
601 // ---------------------------------------------------------------------
602 /* Result ends in a / */
603 string
flNotFile(string File
)
605 string::size_type Res
= File
.rfind('/');
606 if (Res
== string::npos
)
609 return string(File
,0,Res
);
612 // flExtension - Return the extension for the file /*{{{*/
613 // ---------------------------------------------------------------------
615 string
flExtension(string File
)
617 string::size_type Res
= File
.rfind('.');
618 if (Res
== string::npos
)
621 return string(File
,Res
,Res
- File
.length());
624 // flNoLink - If file is a symlink then deref it /*{{{*/
625 // ---------------------------------------------------------------------
626 /* If the name is not a link then the returned path is the input. */
627 string
flNoLink(string File
)
630 if (lstat(File
.c_str(),&St
) != 0 || S_ISLNK(St
.st_mode
) == 0)
632 if (stat(File
.c_str(),&St
) != 0)
635 /* Loop resolving the link. There is no need to limit the number of
636 loops because the stat call above ensures that the symlink is not
644 if ((Res
= readlink(NFile
.c_str(),Buffer
,sizeof(Buffer
))) <= 0 ||
645 (size_t)Res
>= sizeof(Buffer
))
648 // Append or replace the previous path
650 if (Buffer
[0] == '/')
653 NFile
= flNotFile(NFile
) + Buffer
;
655 // See if we are done
656 if (lstat(NFile
.c_str(),&St
) != 0)
658 if (S_ISLNK(St
.st_mode
) == 0)
663 // flCombine - Combine a file and a directory /*{{{*/
664 // ---------------------------------------------------------------------
665 /* If the file is an absolute path then it is just returned, otherwise
666 the directory is pre-pended to it. */
667 string
flCombine(string Dir
,string File
)
669 if (File
.empty() == true)
672 if (File
[0] == '/' || Dir
.empty() == true)
674 if (File
.length() >= 2 && File
[0] == '.' && File
[1] == '/')
676 if (Dir
[Dir
.length()-1] == '/')
678 return Dir
+ '/' + File
;
681 // flAbsPath - Return the absolute path of the filename /*{{{*/
682 // ---------------------------------------------------------------------
684 string
flAbsPath(string File
)
686 char *p
= realpath(File
.c_str(), NULL
);
689 _error
->Errno("realpath", "flAbsPath on %s failed", File
.c_str());
692 std::string
AbsPath(p
);
697 // SetCloseExec - Set the close on exec flag /*{{{*/
698 // ---------------------------------------------------------------------
700 void SetCloseExec(int Fd
,bool Close
)
702 if (fcntl(Fd
,F_SETFD
,(Close
== false)?0:FD_CLOEXEC
) != 0)
704 cerr
<< "FATAL -> Could not set close on exec " << strerror(errno
) << endl
;
709 // SetNonBlock - Set the nonblocking flag /*{{{*/
710 // ---------------------------------------------------------------------
712 void SetNonBlock(int Fd
,bool Block
)
714 int Flags
= fcntl(Fd
,F_GETFL
) & (~O_NONBLOCK
);
715 if (fcntl(Fd
,F_SETFL
,Flags
| ((Block
== false)?0:O_NONBLOCK
)) != 0)
717 cerr
<< "FATAL -> Could not set non-blocking flag " << strerror(errno
) << endl
;
722 // WaitFd - Wait for a FD to become readable /*{{{*/
723 // ---------------------------------------------------------------------
724 /* This waits for a FD to become readable using select. It is useful for
725 applications making use of non-blocking sockets. The timeout is
727 bool WaitFd(int Fd
,bool write
,unsigned long timeout
)
740 Res
= select(Fd
+1,0,&Set
,0,(timeout
!= 0?&tv
:0));
742 while (Res
< 0 && errno
== EINTR
);
752 Res
= select(Fd
+1,&Set
,0,0,(timeout
!= 0?&tv
:0));
754 while (Res
< 0 && errno
== EINTR
);
763 // MergeKeepFdsFromConfiguration - Merge APT::Keep-Fds configuration /*{{{*/
764 // ---------------------------------------------------------------------
765 /* This is used to merge the APT::Keep-Fds with the provided KeepFDs
768 void MergeKeepFdsFromConfiguration(std::set
<int> &KeepFDs
)
770 Configuration::Item
const *Opts
= _config
->Tree("APT::Keep-Fds");
771 if (Opts
!= 0 && Opts
->Child
!= 0)
774 for (; Opts
!= 0; Opts
= Opts
->Next
)
776 if (Opts
->Value
.empty() == true)
778 int fd
= atoi(Opts
->Value
.c_str());
784 // ExecFork - Magical fork that sanitizes the context before execing /*{{{*/
785 // ---------------------------------------------------------------------
786 /* This is used if you want to cleanse the environment for the forked
787 child, it fixes up the important signals and nukes all of the fds,
788 otherwise acts like normal fork. */
792 // we need to merge the Keep-Fds as external tools like
793 // debconf-apt-progress use it
794 MergeKeepFdsFromConfiguration(KeepFDs
);
795 return ExecFork(KeepFDs
);
798 pid_t
ExecFork(std::set
<int> KeepFDs
)
800 // Fork off the process
801 pid_t Process
= fork();
804 cerr
<< "FATAL -> Failed to fork." << endl
;
808 // Spawn the subprocess
812 signal(SIGPIPE
,SIG_DFL
);
813 signal(SIGQUIT
,SIG_DFL
);
814 signal(SIGINT
,SIG_DFL
);
815 signal(SIGWINCH
,SIG_DFL
);
816 signal(SIGCONT
,SIG_DFL
);
817 signal(SIGTSTP
,SIG_DFL
);
819 DIR *dir
= opendir("/proc/self/fd");
823 while ((ent
= readdir(dir
)))
825 int fd
= atoi(ent
->d_name
);
826 // If fd > 0, it was a fd number and not . or ..
827 if (fd
>= 3 && KeepFDs
.find(fd
) == KeepFDs
.end())
828 fcntl(fd
,F_SETFD
,FD_CLOEXEC
);
832 long ScOpenMax
= sysconf(_SC_OPEN_MAX
);
833 // Close all of our FDs - just in case
834 for (int K
= 3; K
!= ScOpenMax
; K
++)
836 if(KeepFDs
.find(K
) == KeepFDs
.end())
837 fcntl(K
,F_SETFD
,FD_CLOEXEC
);
845 // ExecWait - Fancy waitpid /*{{{*/
846 // ---------------------------------------------------------------------
847 /* Waits for the given sub process. If Reap is set then no errors are
848 generated. Otherwise a failed subprocess will generate a proper descriptive
850 bool ExecWait(pid_t Pid
,const char *Name
,bool Reap
)
855 // Wait and collect the error code
857 while (waitpid(Pid
,&Status
,0) != Pid
)
865 return _error
->Error(_("Waited for %s but it wasn't there"),Name
);
869 // Check for an error code.
870 if (WIFEXITED(Status
) == 0 || WEXITSTATUS(Status
) != 0)
874 if (WIFSIGNALED(Status
) != 0)
876 if( WTERMSIG(Status
) == SIGSEGV
)
877 return _error
->Error(_("Sub-process %s received a segmentation fault."),Name
);
879 return _error
->Error(_("Sub-process %s received signal %u."),Name
, WTERMSIG(Status
));
882 if (WIFEXITED(Status
) != 0)
883 return _error
->Error(_("Sub-process %s returned an error code (%u)"),Name
,WEXITSTATUS(Status
));
885 return _error
->Error(_("Sub-process %s exited unexpectedly"),Name
);
891 // StartsWithGPGClearTextSignature - Check if a file is Pgp/GPG clearsigned /*{{{*/
892 bool StartsWithGPGClearTextSignature(string
const &FileName
)
894 static const char* SIGMSG
= "-----BEGIN PGP SIGNED MESSAGE-----\n";
895 char buffer
[strlen(SIGMSG
)+1];
896 FILE* gpg
= fopen(FileName
.c_str(), "r");
900 char const * const test
= fgets(buffer
, sizeof(buffer
), gpg
);
902 if (test
== NULL
|| strcmp(buffer
, SIGMSG
) != 0)
908 // ChangeOwnerAndPermissionOfFile - set file attributes to requested values /*{{{*/
909 bool ChangeOwnerAndPermissionOfFile(char const * const requester
, char const * const file
, char const * const user
, char const * const group
, mode_t
const mode
)
911 if (strcmp(file
, "/dev/null") == 0)
914 if (getuid() == 0 && strlen(user
) != 0 && strlen(group
) != 0) // if we aren't root, we can't chown, so don't try it
916 // ensure the file is owned by root and has good permissions
917 struct passwd
const * const pw
= getpwnam(user
);
918 struct group
const * const gr
= getgrnam(group
);
919 if (pw
!= NULL
&& gr
!= NULL
&& chown(file
, pw
->pw_uid
, gr
->gr_gid
) != 0)
920 Res
&= _error
->WarningE(requester
, "chown to %s:%s of file %s failed", user
, group
, file
);
922 if (chmod(file
, mode
) != 0)
923 Res
&= _error
->WarningE(requester
, "chmod 0%o of file %s failed", mode
, file
);
928 struct APT_HIDDEN simple_buffer
{ /*{{{*/
929 size_t buffersize_max
= 0;
930 unsigned long long bufferstart
= 0;
931 unsigned long long bufferend
= 0;
932 char *buffer
= nullptr;
941 const char *get() const { return buffer
+ bufferstart
; }
942 char *get() { return buffer
+ bufferstart
; }
943 const char *getend() const { return buffer
+ bufferend
; }
944 char *getend() { return buffer
+ bufferend
; }
945 bool empty() const { return bufferend
<= bufferstart
; }
946 bool full() const { return bufferend
== buffersize_max
; }
947 unsigned long long free() const { return buffersize_max
- bufferend
; }
948 unsigned long long size() const { return bufferend
-bufferstart
; }
949 void reset(size_t size
)
951 if (size
> buffersize_max
) {
953 buffersize_max
= size
;
954 buffer
= new char[size
];
958 void reset() { bufferend
= bufferstart
= 0; }
959 ssize_t
read(void *to
, unsigned long long requested_size
) APT_MUSTCHECK
961 if (size() < requested_size
)
962 requested_size
= size();
963 memcpy(to
, buffer
+ bufferstart
, requested_size
);
964 bufferstart
+= requested_size
;
965 if (bufferstart
== bufferend
)
966 bufferstart
= bufferend
= 0;
967 return requested_size
;
969 ssize_t
write(const void *from
, unsigned long long requested_size
) APT_MUSTCHECK
971 if (free() < requested_size
)
972 requested_size
= free();
973 memcpy(getend(), from
, requested_size
);
974 bufferend
+= requested_size
;
975 if (bufferstart
== bufferend
)
976 bufferstart
= bufferend
= 0;
977 return requested_size
;
982 class APT_HIDDEN FileFdPrivate
{ /*{{{*/
983 friend class BufferedWriteFileFdPrivate
;
985 FileFd
* const filefd
;
986 simple_buffer buffer
;
988 pid_t compressor_pid
;
990 APT::Configuration::Compressor compressor
;
991 unsigned int openmode
;
992 unsigned long long seekpos
;
995 explicit FileFdPrivate(FileFd
* const pfilefd
) : filefd(pfilefd
),
996 compressed_fd(-1), compressor_pid(-1), is_pipe(false),
997 openmode(0), seekpos(0) {};
998 virtual APT::Configuration::Compressor
get_compressor() const
1002 virtual void set_compressor(APT::Configuration::Compressor
const &compressor
)
1004 this->compressor
= compressor
;
1006 virtual unsigned int get_openmode() const
1010 virtual void set_openmode(unsigned int openmode
)
1012 this->openmode
= openmode
;
1014 virtual bool get_is_pipe() const
1018 virtual void set_is_pipe(bool is_pipe
)
1020 this->is_pipe
= is_pipe
;
1022 virtual unsigned long long get_seekpos() const
1026 virtual void set_seekpos(unsigned long long seekpos
)
1028 this->seekpos
= seekpos
;
1031 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) = 0;
1032 ssize_t
InternalRead(void * To
, unsigned long long Size
)
1034 // Drain the buffer if needed.
1035 if (buffer
.empty() == false)
1037 return buffer
.read(To
, Size
);
1039 return InternalUnbufferedRead(To
, Size
);
1041 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) = 0;
1042 virtual bool InternalReadError() { return filefd
->FileFdErrno("read",_("Read error")); }
1043 virtual char * InternalReadLine(char * To
, unsigned long long Size
)
1045 if (unlikely(Size
== 0))
1047 // Read one byte less than buffer size to have space for trailing 0.
1050 char * const InitialTo
= To
;
1053 if (buffer
.empty() == true)
1056 unsigned long long actualread
= 0;
1057 if (filefd
->Read(buffer
.getend(), buffer
.free(), &actualread
) == false)
1059 buffer
.bufferend
= actualread
;
1060 if (buffer
.size() == 0)
1062 if (To
== InitialTo
)
1066 filefd
->Flags
&= ~FileFd::HitEof
;
1069 unsigned long long const OutputSize
= std::min(Size
, buffer
.size());
1070 char const * const newline
= static_cast<char const * const>(memchr(buffer
.get(), '\n', OutputSize
));
1071 // Read until end of line or up to Size bytes from the buffer.
1072 unsigned long long actualread
= buffer
.read(To
,
1073 (newline
!= nullptr)
1074 ? (newline
- buffer
.get()) + 1
1078 if (newline
!= nullptr)
1084 virtual bool InternalFlush()
1088 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) = 0;
1089 virtual bool InternalWriteError() { return filefd
->FileFdErrno("write",_("Write error")); }
1090 virtual bool InternalSeek(unsigned long long const To
)
1092 // Our poor man seeking is costly, so try to avoid it
1093 unsigned long long const iseekpos
= filefd
->Tell();
1096 else if (iseekpos
< To
)
1097 return filefd
->Skip(To
- iseekpos
);
1099 if ((openmode
& FileFd::ReadOnly
) != FileFd::ReadOnly
)
1100 return filefd
->FileFdError("Reopen is only implemented for read-only files!");
1101 InternalClose(filefd
->FileName
);
1102 if (filefd
->iFd
!= -1)
1105 if (filefd
->TemporaryFileName
.empty() == false)
1106 filefd
->iFd
= open(filefd
->TemporaryFileName
.c_str(), O_RDONLY
);
1107 else if (filefd
->FileName
.empty() == false)
1108 filefd
->iFd
= open(filefd
->FileName
.c_str(), O_RDONLY
);
1111 if (compressed_fd
> 0)
1112 if (lseek(compressed_fd
, 0, SEEK_SET
) != 0)
1113 filefd
->iFd
= compressed_fd
;
1114 if (filefd
->iFd
< 0)
1115 return filefd
->FileFdError("Reopen is not implemented for pipes opened with FileFd::OpenDescriptor()!");
1118 if (filefd
->OpenInternDescriptor(openmode
, compressor
) == false)
1119 return filefd
->FileFdError("Seek on file %s because it couldn't be reopened", filefd
->FileName
.c_str());
1123 return filefd
->Skip(To
);
1128 virtual bool InternalSkip(unsigned long long Over
)
1130 unsigned long long constexpr buffersize
= 1024;
1131 char buffer
[buffersize
];
1134 unsigned long long toread
= std::min(buffersize
, Over
);
1135 if (filefd
->Read(buffer
, toread
) == false)
1136 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
1141 virtual bool InternalTruncate(unsigned long long const)
1143 return filefd
->FileFdError("Truncating compressed files is not implemented (%s)", filefd
->FileName
.c_str());
1145 virtual unsigned long long InternalTell()
1147 // In theory, we could just return seekpos here always instead of
1148 // seeking around, but not all users of FileFd use always Seek() and co
1149 // so d->seekpos isn't always true and we can just use it as a hint if
1150 // we have nothing else, but not always as an authority…
1151 return seekpos
- buffer
.size();
1153 virtual unsigned long long InternalSize()
1155 unsigned long long size
= 0;
1156 unsigned long long const oldSeek
= filefd
->Tell();
1157 unsigned long long constexpr ignoresize
= 1024;
1158 char ignore
[ignoresize
];
1159 unsigned long long read
= 0;
1161 if (filefd
->Read(ignore
, ignoresize
, &read
) == false)
1163 filefd
->Seek(oldSeek
);
1167 size
= filefd
->Tell();
1168 filefd
->Seek(oldSeek
);
1171 virtual bool InternalClose(std::string
const &FileName
) = 0;
1172 virtual bool InternalStream() const { return false; }
1173 virtual bool InternalAlwaysAutoClose() const { return true; }
1175 virtual ~FileFdPrivate() {}
1178 class APT_HIDDEN BufferedWriteFileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1180 FileFdPrivate
*wrapped
;
1181 simple_buffer writebuffer
;
1185 explicit BufferedWriteFileFdPrivate(FileFdPrivate
*Priv
) :
1186 FileFdPrivate(Priv
->filefd
), wrapped(Priv
) {};
1188 virtual APT::Configuration::Compressor
get_compressor() const override
1190 return wrapped
->get_compressor();
1192 virtual void set_compressor(APT::Configuration::Compressor
const &compressor
) override
1194 return wrapped
->set_compressor(compressor
);
1196 virtual unsigned int get_openmode() const override
1198 return wrapped
->get_openmode();
1200 virtual void set_openmode(unsigned int openmode
) override
1202 return wrapped
->set_openmode(openmode
);
1204 virtual bool get_is_pipe() const override
1206 return wrapped
->get_is_pipe();
1208 virtual void set_is_pipe(bool is_pipe
) override
1210 FileFdPrivate::set_is_pipe(is_pipe
);
1211 wrapped
->set_is_pipe(is_pipe
);
1213 virtual unsigned long long get_seekpos() const override
1215 return wrapped
->get_seekpos();
1217 virtual void set_seekpos(unsigned long long seekpos
) override
1219 return wrapped
->set_seekpos(seekpos
);
1221 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1223 if (InternalFlush() == false)
1225 return wrapped
->InternalOpen(iFd
, Mode
);
1227 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1229 if (InternalFlush() == false)
1231 return wrapped
->InternalUnbufferedRead(To
, Size
);
1234 virtual bool InternalReadError() override
1236 return wrapped
->InternalReadError();
1238 virtual char * InternalReadLine(char * To
, unsigned long long Size
) override
1240 if (InternalFlush() == false)
1242 return wrapped
->InternalReadLine(To
, Size
);
1244 virtual bool InternalFlush() override
1246 while (writebuffer
.empty() == false) {
1247 auto written
= wrapped
->InternalWrite(writebuffer
.get(),
1248 writebuffer
.size());
1249 // Ignore interrupted syscalls
1250 if (written
< 0 && errno
== EINTR
)
1253 return wrapped
->InternalWriteError();
1255 writebuffer
.bufferstart
+= written
;
1258 writebuffer
.reset();
1261 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1263 // Optimisation: If the buffer is empty and we have more to write than
1264 // would fit in the buffer (or equal number of bytes), write directly.
1265 if (writebuffer
.empty() == true && Size
>= writebuffer
.free())
1266 return wrapped
->InternalWrite(From
, Size
);
1268 // Write as much into the buffer as possible and then flush if needed
1269 auto written
= writebuffer
.write(From
, Size
);
1271 if (writebuffer
.full() && InternalFlush() == false)
1276 virtual bool InternalWriteError()
1278 return wrapped
->InternalWriteError();
1280 virtual bool InternalSeek(unsigned long long const To
)
1282 if (InternalFlush() == false)
1284 return wrapped
->InternalSeek(To
);
1286 virtual bool InternalSkip(unsigned long long Over
)
1288 if (InternalFlush() == false)
1290 return wrapped
->InternalSkip(Over
);
1292 virtual bool InternalTruncate(unsigned long long const Size
)
1294 if (InternalFlush() == false)
1296 return wrapped
->InternalTruncate(Size
);
1298 virtual unsigned long long InternalTell()
1300 if (InternalFlush() == false)
1302 return wrapped
->InternalTell();
1304 virtual unsigned long long InternalSize()
1306 if (InternalFlush() == false)
1308 return wrapped
->InternalSize();
1310 virtual bool InternalClose(std::string
const &FileName
)
1312 return wrapped
->InternalClose(FileName
);
1314 virtual bool InternalAlwaysAutoClose() const
1316 return wrapped
->InternalAlwaysAutoClose();
1318 virtual ~BufferedWriteFileFdPrivate()
1324 class APT_HIDDEN GzipFileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1328 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1330 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1331 gz
= gzdopen(iFd
, "r+");
1332 else if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1333 gz
= gzdopen(iFd
, "w");
1335 gz
= gzdopen(iFd
, "r");
1336 filefd
->Flags
|= FileFd::Compressed
;
1337 return gz
!= nullptr;
1339 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1341 return gzread(gz
, To
, Size
);
1343 virtual bool InternalReadError() override
1346 char const * const errmsg
= gzerror(gz
, &err
);
1348 return filefd
->FileFdError("gzread: %s (%d: %s)", _("Read error"), err
, errmsg
);
1349 return FileFdPrivate::InternalReadError();
1351 virtual char * InternalReadLine(char * To
, unsigned long long Size
) override
1353 return gzgets(gz
, To
, Size
);
1355 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1357 return gzwrite(gz
,From
,Size
);
1359 virtual bool InternalWriteError() override
1362 char const * const errmsg
= gzerror(gz
, &err
);
1364 return filefd
->FileFdError("gzwrite: %s (%d: %s)", _("Write error"), err
, errmsg
);
1365 return FileFdPrivate::InternalWriteError();
1367 virtual bool InternalSeek(unsigned long long const To
) override
1369 off_t
const res
= gzseek(gz
, To
, SEEK_SET
);
1370 if (res
!= (off_t
)To
)
1371 return filefd
->FileFdError("Unable to seek to %llu", To
);
1376 virtual bool InternalSkip(unsigned long long Over
) override
1378 if (Over
>= buffer
.size())
1380 Over
-= buffer
.size();
1385 buffer
.bufferstart
+= Over
;
1390 off_t
const res
= gzseek(gz
, Over
, SEEK_CUR
);
1392 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
1396 virtual unsigned long long InternalTell() override
1398 return gztell(gz
) - buffer
.size();
1400 virtual unsigned long long InternalSize() override
1402 unsigned long long filesize
= FileFdPrivate::InternalSize();
1403 // only check gzsize if we are actually a gzip file, just checking for
1404 // "gz" is not sufficient as uncompressed files could be opened with
1405 // gzopen in "direct" mode as well
1406 if (filesize
== 0 || gzdirect(gz
))
1409 off_t
const oldPos
= lseek(filefd
->iFd
, 0, SEEK_CUR
);
1410 /* unfortunately zlib.h doesn't provide a gzsize(), so we have to do
1411 * this ourselves; the original (uncompressed) file size is the last 32
1412 * bits of the file */
1413 // FIXME: Size for gz-files is limited by 32bit… no largefile support
1414 if (lseek(filefd
->iFd
, -4, SEEK_END
) < 0)
1416 filefd
->FileFdErrno("lseek","Unable to seek to end of gzipped file");
1420 if (read(filefd
->iFd
, &size
, 4) != 4)
1422 filefd
->FileFdErrno("read","Unable to read original size of gzipped file");
1425 size
= le32toh(size
);
1427 if (lseek(filefd
->iFd
, oldPos
, SEEK_SET
) < 0)
1429 filefd
->FileFdErrno("lseek","Unable to seek in gzipped file");
1434 virtual bool InternalClose(std::string
const &FileName
) override
1438 int const e
= gzclose(gz
);
1440 // gzdclose() on empty files always fails with "buffer error" here, ignore that
1441 if (e
!= 0 && e
!= Z_BUF_ERROR
)
1442 return _error
->Errno("close",_("Problem closing the gzip file %s"), FileName
.c_str());
1446 explicit GzipFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), gz(nullptr) {}
1447 virtual ~GzipFileFdPrivate() { InternalClose(""); }
1451 class APT_HIDDEN Bz2FileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1455 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1457 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1458 bz2
= BZ2_bzdopen(iFd
, "r+");
1459 else if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1460 bz2
= BZ2_bzdopen(iFd
, "w");
1462 bz2
= BZ2_bzdopen(iFd
, "r");
1463 filefd
->Flags
|= FileFd::Compressed
;
1464 return bz2
!= nullptr;
1466 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1468 return BZ2_bzread(bz2
, To
, Size
);
1470 virtual bool InternalReadError() override
1473 char const * const errmsg
= BZ2_bzerror(bz2
, &err
);
1474 if (err
!= BZ_IO_ERROR
)
1475 return filefd
->FileFdError("BZ2_bzread: %s %s (%d: %s)", filefd
->FileName
.c_str(), _("Read error"), err
, errmsg
);
1476 return FileFdPrivate::InternalReadError();
1478 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1480 return BZ2_bzwrite(bz2
, (void*)From
, Size
);
1482 virtual bool InternalWriteError() override
1485 char const * const errmsg
= BZ2_bzerror(bz2
, &err
);
1486 if (err
!= BZ_IO_ERROR
)
1487 return filefd
->FileFdError("BZ2_bzwrite: %s %s (%d: %s)", filefd
->FileName
.c_str(), _("Write error"), err
, errmsg
);
1488 return FileFdPrivate::InternalWriteError();
1490 virtual bool InternalStream() const override
{ return true; }
1491 virtual bool InternalClose(std::string
const &) override
1500 explicit Bz2FileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), bz2(nullptr) {}
1501 virtual ~Bz2FileFdPrivate() { InternalClose(""); }
1505 class APT_HIDDEN Lz4FileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1506 static constexpr unsigned long long LZ4_HEADER_SIZE
= 19;
1507 static constexpr unsigned long long LZ4_FOOTER_SIZE
= 4;
1509 LZ4F_decompressionContext_t dctx
;
1510 LZ4F_compressionContext_t cctx
;
1511 LZ4F_errorCode_t res
;
1513 simple_buffer lz4_buffer
;
1514 // Count of bytes that the decompressor expects to read next, or buffer size.
1515 size_t next_to_load
= APT_BUFFER_SIZE
;
1517 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1519 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1520 return _error
->Error("lz4 only supports write or read mode");
1522 if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
) {
1523 res
= LZ4F_createCompressionContext(&cctx
, LZ4F_VERSION
);
1524 lz4_buffer
.reset(LZ4F_compressBound(APT_BUFFER_SIZE
, nullptr)
1525 + LZ4_HEADER_SIZE
+ LZ4_FOOTER_SIZE
);
1527 res
= LZ4F_createDecompressionContext(&dctx
, LZ4F_VERSION
);
1528 lz4_buffer
.reset(APT_BUFFER_SIZE
);
1531 filefd
->Flags
|= FileFd::Compressed
;
1533 if (LZ4F_isError(res
))
1536 unsigned int flags
= (Mode
& (FileFd::WriteOnly
|FileFd::ReadOnly
));
1537 if (backend
.OpenDescriptor(iFd
, flags
) == false)
1540 // Write the file header
1541 if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1543 res
= LZ4F_compressBegin(cctx
, lz4_buffer
.buffer
, lz4_buffer
.buffersize_max
, nullptr);
1544 if (LZ4F_isError(res
) || backend
.Write(lz4_buffer
.buffer
, res
) == false)
1550 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1552 /* Keep reading as long as the compressor still wants to read */
1553 while (next_to_load
) {
1554 // Fill compressed buffer;
1555 if (lz4_buffer
.empty()) {
1556 unsigned long long read
;
1557 /* Reset - if LZ4 decompressor wants to read more, allocate more */
1558 lz4_buffer
.reset(next_to_load
);
1559 if (backend
.Read(lz4_buffer
.getend(), lz4_buffer
.free(), &read
) == false)
1561 lz4_buffer
.bufferend
+= read
;
1566 return filefd
->FileFdError("LZ4F: %s %s",
1567 filefd
->FileName
.c_str(),
1568 _("Unexpected end of file")), -1;
1571 // Drain compressed buffer as far as possible.
1572 size_t in
= lz4_buffer
.size();
1575 res
= LZ4F_decompress(dctx
, To
, &out
, lz4_buffer
.get(), &in
, nullptr);
1576 if (LZ4F_isError(res
))
1580 lz4_buffer
.bufferstart
+= in
;
1588 virtual bool InternalReadError() override
1590 char const * const errmsg
= LZ4F_getErrorName(res
);
1592 return filefd
->FileFdError("LZ4F: %s %s (%zu: %s)", filefd
->FileName
.c_str(), _("Read error"), res
, errmsg
);
1594 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1596 unsigned long long const towrite
= std::min(APT_BUFFER_SIZE
, Size
);
1598 res
= LZ4F_compressUpdate(cctx
,
1599 lz4_buffer
.buffer
, lz4_buffer
.buffersize_max
,
1600 From
, towrite
, nullptr);
1602 if (LZ4F_isError(res
) || backend
.Write(lz4_buffer
.buffer
, res
) == false)
1607 virtual bool InternalWriteError() override
1609 char const * const errmsg
= LZ4F_getErrorName(res
);
1611 return filefd
->FileFdError("LZ4F: %s %s (%zu: %s)", filefd
->FileName
.c_str(), _("Write error"), res
, errmsg
);
1613 virtual bool InternalStream() const override
{ return true; }
1615 virtual bool InternalFlush() override
1617 return backend
.Flush();
1620 virtual bool InternalClose(std::string
const &) override
1622 /* Reset variables */
1624 next_to_load
= APT_BUFFER_SIZE
;
1626 if (cctx
!= nullptr)
1628 res
= LZ4F_compressEnd(cctx
, lz4_buffer
.buffer
, lz4_buffer
.buffersize_max
, nullptr);
1629 if (LZ4F_isError(res
) || backend
.Write(lz4_buffer
.buffer
, res
) == false)
1631 if (!backend
.Flush())
1633 if (!backend
.Close())
1636 res
= LZ4F_freeCompressionContext(cctx
);
1640 if (dctx
!= nullptr)
1642 res
= LZ4F_freeDecompressionContext(dctx
);
1646 return LZ4F_isError(res
) == false;
1649 explicit Lz4FileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), dctx(nullptr), cctx(nullptr) {}
1650 virtual ~Lz4FileFdPrivate() {
1656 class APT_HIDDEN LzmaFileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1660 uint8_t buffer
[4096];
1666 LZMAFILE() : file(nullptr), eof(false), compressing(false) { buffer
[0] = '\0'; }
1669 if (compressing
== true)
1671 size_t constexpr buffersize
= sizeof(buffer
)/sizeof(buffer
[0]);
1674 stream
.avail_out
= buffersize
;
1675 stream
.next_out
= buffer
;
1676 err
= lzma_code(&stream
, LZMA_FINISH
);
1677 if (err
!= LZMA_OK
&& err
!= LZMA_STREAM_END
)
1679 _error
->Error("~LZMAFILE: Compress finalisation failed");
1682 size_t const n
= buffersize
- stream
.avail_out
;
1683 if (n
&& fwrite(buffer
, 1, n
, file
) != n
)
1685 _error
->Errno("~LZMAFILE",_("Write error"));
1688 if (err
== LZMA_STREAM_END
)
1697 static uint32_t findXZlevel(std::vector
<std::string
> const &Args
)
1699 for (auto a
= Args
.rbegin(); a
!= Args
.rend(); ++a
)
1700 if (a
->empty() == false && (*a
)[0] == '-' && (*a
)[1] != '-')
1702 auto const number
= a
->find_last_of("0123456789");
1703 if (number
== std::string::npos
)
1705 auto const extreme
= a
->find("e", number
);
1706 uint32_t level
= (extreme
!= std::string::npos
) ? LZMA_PRESET_EXTREME
: 0;
1707 switch ((*a
)[number
])
1709 case '0': return level
| 0;
1710 case '1': return level
| 1;
1711 case '2': return level
| 2;
1712 case '3': return level
| 3;
1713 case '4': return level
| 4;
1714 case '5': return level
| 5;
1715 case '6': return level
| 6;
1716 case '7': return level
| 7;
1717 case '8': return level
| 8;
1718 case '9': return level
| 9;
1724 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1726 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1727 return filefd
->FileFdError("ReadWrite mode is not supported for lzma/xz files %s", filefd
->FileName
.c_str());
1729 if (lzma
== nullptr)
1730 lzma
= new LzmaFileFdPrivate::LZMAFILE
;
1731 if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1732 lzma
->file
= fdopen(iFd
, "w");
1734 lzma
->file
= fdopen(iFd
, "r");
1735 filefd
->Flags
|= FileFd::Compressed
;
1736 if (lzma
->file
== nullptr)
1739 lzma_stream tmp_stream
= LZMA_STREAM_INIT
;
1740 lzma
->stream
= tmp_stream
;
1742 if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1744 uint32_t const xzlevel
= findXZlevel(compressor
.CompressArgs
);
1745 if (compressor
.Name
== "xz")
1747 if (lzma_easy_encoder(&lzma
->stream
, xzlevel
, LZMA_CHECK_CRC64
) != LZMA_OK
)
1752 lzma_options_lzma options
;
1753 lzma_lzma_preset(&options
, xzlevel
);
1754 if (lzma_alone_encoder(&lzma
->stream
, &options
) != LZMA_OK
)
1757 lzma
->compressing
= true;
1761 uint64_t const memlimit
= UINT64_MAX
;
1762 if (compressor
.Name
== "xz")
1764 if (lzma_auto_decoder(&lzma
->stream
, memlimit
, 0) != LZMA_OK
)
1769 if (lzma_alone_decoder(&lzma
->stream
, memlimit
) != LZMA_OK
)
1772 lzma
->compressing
= false;
1776 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1779 if (lzma
->eof
== true)
1782 lzma
->stream
.next_out
= (uint8_t *) To
;
1783 lzma
->stream
.avail_out
= Size
;
1784 if (lzma
->stream
.avail_in
== 0)
1786 lzma
->stream
.next_in
= lzma
->buffer
;
1787 lzma
->stream
.avail_in
= fread(lzma
->buffer
, 1, sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]), lzma
->file
);
1789 lzma
->err
= lzma_code(&lzma
->stream
, LZMA_RUN
);
1790 if (lzma
->err
== LZMA_STREAM_END
)
1793 Res
= Size
- lzma
->stream
.avail_out
;
1795 else if (lzma
->err
!= LZMA_OK
)
1802 Res
= Size
- lzma
->stream
.avail_out
;
1805 // lzma run was okay, but produced no output…
1812 virtual bool InternalReadError() override
1814 return filefd
->FileFdError("lzma_read: %s (%d)", _("Read error"), lzma
->err
);
1816 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1818 lzma
->stream
.next_in
= (uint8_t *)From
;
1819 lzma
->stream
.avail_in
= Size
;
1820 lzma
->stream
.next_out
= lzma
->buffer
;
1821 lzma
->stream
.avail_out
= sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]);
1822 lzma
->err
= lzma_code(&lzma
->stream
, LZMA_RUN
);
1823 if (lzma
->err
!= LZMA_OK
)
1825 size_t const n
= sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]) - lzma
->stream
.avail_out
;
1826 size_t const m
= (n
== 0) ? 0 : fwrite(lzma
->buffer
, 1, n
, lzma
->file
);
1830 return Size
- lzma
->stream
.avail_in
;
1832 virtual bool InternalWriteError() override
1834 return filefd
->FileFdError("lzma_write: %s (%d)", _("Write error"), lzma
->err
);
1836 virtual bool InternalStream() const override
{ return true; }
1837 virtual bool InternalClose(std::string
const &) override
1844 explicit LzmaFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), lzma(nullptr) {}
1845 virtual ~LzmaFileFdPrivate() { InternalClose(""); }
1849 class APT_HIDDEN PipedFileFdPrivate
: public FileFdPrivate
/*{{{*/
1850 /* if we don't have a specific class dealing with library calls, we (un)compress
1851 by executing a specified binary and pipe in/out what we need */
1854 virtual bool InternalOpen(int const, unsigned int const Mode
) override
1856 // collect zombies here in case we reopen
1857 if (compressor_pid
> 0)
1858 ExecWait(compressor_pid
, "FileFdCompressor", true);
1860 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1861 return filefd
->FileFdError("ReadWrite mode is not supported for file %s", filefd
->FileName
.c_str());
1863 bool const Comp
= (Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
;
1866 // Handle 'decompression' of empty files
1868 fstat(filefd
->iFd
, &Buf
);
1869 if (Buf
.st_size
== 0 && S_ISFIFO(Buf
.st_mode
) == false)
1872 // We don't need the file open - instead let the compressor open it
1873 // as he properly knows better how to efficiently read from 'his' file
1874 if (filefd
->FileName
.empty() == false)
1881 // Create a data pipe
1882 int Pipe
[2] = {-1,-1};
1883 if (pipe(Pipe
) != 0)
1884 return filefd
->FileFdErrno("pipe",_("Failed to create subprocess IPC"));
1885 for (int J
= 0; J
!= 2; J
++)
1886 SetCloseExec(Pipe
[J
],true);
1888 compressed_fd
= filefd
->iFd
;
1892 filefd
->iFd
= Pipe
[1];
1894 filefd
->iFd
= Pipe
[0];
1897 compressor_pid
= ExecFork();
1898 if (compressor_pid
== 0)
1902 dup2(compressed_fd
,STDOUT_FILENO
);
1903 dup2(Pipe
[0],STDIN_FILENO
);
1907 if (compressed_fd
!= -1)
1908 dup2(compressed_fd
,STDIN_FILENO
);
1909 dup2(Pipe
[1],STDOUT_FILENO
);
1911 int const nullfd
= open("/dev/null", O_WRONLY
);
1914 dup2(nullfd
,STDERR_FILENO
);
1918 SetCloseExec(STDOUT_FILENO
,false);
1919 SetCloseExec(STDIN_FILENO
,false);
1921 std::vector
<char const*> Args
;
1922 Args
.push_back(compressor
.Binary
.c_str());
1923 std::vector
<std::string
> const * const addArgs
=
1924 (Comp
== true) ? &(compressor
.CompressArgs
) : &(compressor
.UncompressArgs
);
1925 for (std::vector
<std::string
>::const_iterator a
= addArgs
->begin();
1926 a
!= addArgs
->end(); ++a
)
1927 Args
.push_back(a
->c_str());
1928 if (Comp
== false && filefd
->FileName
.empty() == false)
1930 // commands not needing arguments, do not need to be told about using standard output
1931 // in reality, only testcases with tools like cat, rev, rot13, … are able to trigger this
1932 if (compressor
.CompressArgs
.empty() == false && compressor
.UncompressArgs
.empty() == false)
1933 Args
.push_back("--stdout");
1934 if (filefd
->TemporaryFileName
.empty() == false)
1935 Args
.push_back(filefd
->TemporaryFileName
.c_str());
1937 Args
.push_back(filefd
->FileName
.c_str());
1939 Args
.push_back(NULL
);
1941 execvp(Args
[0],(char **)&Args
[0]);
1942 cerr
<< _("Failed to exec compressor ") << Args
[0] << endl
;
1952 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1954 return read(filefd
->iFd
, To
, Size
);
1956 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1958 return write(filefd
->iFd
, From
, Size
);
1960 virtual bool InternalClose(std::string
const &) override
1963 if (compressor_pid
> 0)
1964 Ret
&= ExecWait(compressor_pid
, "FileFdCompressor", true);
1965 compressor_pid
= -1;
1968 explicit PipedFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
) {}
1969 virtual ~PipedFileFdPrivate() { InternalClose(""); }
1972 class APT_HIDDEN DirectFileFdPrivate
: public FileFdPrivate
/*{{{*/
1975 virtual bool InternalOpen(int const, unsigned int const) override
{ return true; }
1976 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1978 return read(filefd
->iFd
, To
, Size
);
1980 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1982 // files opened read+write are strange and only really "supported" for direct files
1983 if (buffer
.size() != 0)
1985 lseek(filefd
->iFd
, -buffer
.size(), SEEK_CUR
);
1988 return write(filefd
->iFd
, From
, Size
);
1990 virtual bool InternalSeek(unsigned long long const To
) override
1992 off_t
const res
= lseek(filefd
->iFd
, To
, SEEK_SET
);
1993 if (res
!= (off_t
)To
)
1994 return filefd
->FileFdError("Unable to seek to %llu", To
);
1999 virtual bool InternalSkip(unsigned long long Over
) override
2001 if (Over
>= buffer
.size())
2003 Over
-= buffer
.size();
2008 buffer
.bufferstart
+= Over
;
2013 off_t
const res
= lseek(filefd
->iFd
, Over
, SEEK_CUR
);
2015 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
2019 virtual bool InternalTruncate(unsigned long long const To
) override
2021 if (buffer
.size() != 0)
2023 unsigned long long const seekpos
= lseek(filefd
->iFd
, 0, SEEK_CUR
);
2024 if ((seekpos
- buffer
.size()) >= To
)
2026 else if (seekpos
>= To
)
2027 buffer
.bufferend
= (To
- seekpos
) + buffer
.bufferstart
;
2031 if (ftruncate(filefd
->iFd
, To
) != 0)
2032 return filefd
->FileFdError("Unable to truncate to %llu",To
);
2035 virtual unsigned long long InternalTell() override
2037 return lseek(filefd
->iFd
,0,SEEK_CUR
) - buffer
.size();
2039 virtual unsigned long long InternalSize() override
2041 return filefd
->FileSize();
2043 virtual bool InternalClose(std::string
const &) override
{ return true; }
2044 virtual bool InternalAlwaysAutoClose() const override
{ return false; }
2046 explicit DirectFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
) {}
2047 virtual ~DirectFileFdPrivate() { InternalClose(""); }
2050 // FileFd Constructors /*{{{*/
2051 FileFd::FileFd(std::string FileName
,unsigned int const Mode
,unsigned long AccessMode
) : iFd(-1), Flags(0), d(NULL
)
2053 Open(FileName
,Mode
, None
, AccessMode
);
2055 FileFd::FileFd(std::string FileName
,unsigned int const Mode
, CompressMode Compress
, unsigned long AccessMode
) : iFd(-1), Flags(0), d(NULL
)
2057 Open(FileName
,Mode
, Compress
, AccessMode
);
2059 FileFd::FileFd() : iFd(-1), Flags(AutoClose
), d(NULL
) {}
2060 FileFd::FileFd(int const Fd
, unsigned int const Mode
, CompressMode Compress
) : iFd(-1), Flags(0), d(NULL
)
2062 OpenDescriptor(Fd
, Mode
, Compress
);
2064 FileFd::FileFd(int const Fd
, bool const AutoClose
) : iFd(-1), Flags(0), d(NULL
)
2066 OpenDescriptor(Fd
, ReadWrite
, None
, AutoClose
);
2069 // FileFd::Open - Open a file /*{{{*/
2070 // ---------------------------------------------------------------------
2071 /* The most commonly used open mode combinations are given with Mode */
2072 bool FileFd::Open(string FileName
,unsigned int const Mode
,CompressMode Compress
, unsigned long const AccessMode
)
2074 if (Mode
== ReadOnlyGzip
)
2075 return Open(FileName
, ReadOnly
, Gzip
, AccessMode
);
2077 if (Compress
== Auto
&& (Mode
& WriteOnly
) == WriteOnly
)
2078 return FileFdError("Autodetection on %s only works in ReadOnly openmode!", FileName
.c_str());
2080 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
2081 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
2082 if (Compress
== Auto
)
2084 for (; compressor
!= compressors
.end(); ++compressor
)
2086 std::string file
= FileName
+ compressor
->Extension
;
2087 if (FileExists(file
) == false)
2093 else if (Compress
== Extension
)
2095 std::string::size_type
const found
= FileName
.find_last_of('.');
2097 if (found
!= std::string::npos
)
2099 ext
= FileName
.substr(found
);
2100 if (ext
== ".new" || ext
== ".bak")
2102 std::string::size_type
const found2
= FileName
.find_last_of('.', found
- 1);
2103 if (found2
!= std::string::npos
)
2104 ext
= FileName
.substr(found2
, found
- found2
);
2109 for (; compressor
!= compressors
.end(); ++compressor
)
2110 if (ext
== compressor
->Extension
)
2112 // no matching extension - assume uncompressed (imagine files like 'example.org_Packages')
2113 if (compressor
== compressors
.end())
2114 for (compressor
= compressors
.begin(); compressor
!= compressors
.end(); ++compressor
)
2115 if (compressor
->Name
== ".")
2123 case None
: name
= "."; break;
2124 case Gzip
: name
= "gzip"; break;
2125 case Bzip2
: name
= "bzip2"; break;
2126 case Lzma
: name
= "lzma"; break;
2127 case Xz
: name
= "xz"; break;
2128 case Lz4
: name
= "lz4"; break;
2132 return FileFdError("Opening File %s in None, Auto or Extension should be already handled?!?", FileName
.c_str());
2134 for (; compressor
!= compressors
.end(); ++compressor
)
2135 if (compressor
->Name
== name
)
2137 if (compressor
== compressors
.end())
2138 return FileFdError("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
2141 if (compressor
== compressors
.end())
2142 return FileFdError("Can't find a match for specified compressor mode for file %s", FileName
.c_str());
2143 return Open(FileName
, Mode
, *compressor
, AccessMode
);
2145 bool FileFd::Open(string FileName
,unsigned int const Mode
,APT::Configuration::Compressor
const &compressor
, unsigned long const AccessMode
)
2150 if ((Mode
& WriteOnly
) != WriteOnly
&& (Mode
& (Atomic
| Create
| Empty
| Exclusive
)) != 0)
2151 return FileFdError("ReadOnly mode for %s doesn't accept additional flags!", FileName
.c_str());
2152 if ((Mode
& ReadWrite
) == 0)
2153 return FileFdError("No openmode provided in FileFd::Open for %s", FileName
.c_str());
2155 unsigned int OpenMode
= Mode
;
2156 if (FileName
== "/dev/null")
2157 OpenMode
= OpenMode
& ~(Atomic
| Exclusive
| Create
| Empty
);
2159 if ((OpenMode
& Atomic
) == Atomic
)
2163 else if ((OpenMode
& (Exclusive
| Create
)) == (Exclusive
| Create
))
2165 // for atomic, this will be done by rename in Close()
2166 RemoveFile("FileFd::Open", FileName
);
2168 if ((OpenMode
& Empty
) == Empty
)
2171 if (lstat(FileName
.c_str(),&Buf
) == 0 && S_ISLNK(Buf
.st_mode
))
2172 RemoveFile("FileFd::Open", FileName
);
2176 #define if_FLAGGED_SET(FLAG, MODE) if ((OpenMode & FLAG) == FLAG) fileflags |= MODE
2177 if_FLAGGED_SET(ReadWrite
, O_RDWR
);
2178 else if_FLAGGED_SET(ReadOnly
, O_RDONLY
);
2179 else if_FLAGGED_SET(WriteOnly
, O_WRONLY
);
2181 if_FLAGGED_SET(Create
, O_CREAT
);
2182 if_FLAGGED_SET(Empty
, O_TRUNC
);
2183 if_FLAGGED_SET(Exclusive
, O_EXCL
);
2184 #undef if_FLAGGED_SET
2186 if ((OpenMode
& Atomic
) == Atomic
)
2188 char *name
= strdup((FileName
+ ".XXXXXX").c_str());
2190 if((iFd
= mkstemp(name
)) == -1)
2193 return FileFdErrno("mkstemp", "Could not create temporary file for %s", FileName
.c_str());
2196 TemporaryFileName
= string(name
);
2199 // umask() will always set the umask and return the previous value, so
2200 // we first set the umask and then reset it to the old value
2201 mode_t
const CurrentUmask
= umask(0);
2202 umask(CurrentUmask
);
2203 // calculate the actual file permissions (just like open/creat)
2204 mode_t
const FilePermissions
= (AccessMode
& ~CurrentUmask
);
2206 if(fchmod(iFd
, FilePermissions
) == -1)
2207 return FileFdErrno("fchmod", "Could not change permissions for temporary file %s", TemporaryFileName
.c_str());
2210 iFd
= open(FileName
.c_str(), fileflags
, AccessMode
);
2212 this->FileName
= FileName
;
2213 if (iFd
== -1 || OpenInternDescriptor(OpenMode
, compressor
) == false)
2220 return FileFdErrno("open",_("Could not open file %s"), FileName
.c_str());
2223 SetCloseExec(iFd
,true);
2227 // FileFd::OpenDescriptor - Open a filedescriptor /*{{{*/
2228 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, CompressMode Compress
, bool AutoClose
)
2230 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
2231 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
2234 // compat with the old API
2235 if (Mode
== ReadOnlyGzip
&& Compress
== None
)
2240 case None
: name
= "."; break;
2241 case Gzip
: name
= "gzip"; break;
2242 case Bzip2
: name
= "bzip2"; break;
2243 case Lzma
: name
= "lzma"; break;
2244 case Xz
: name
= "xz"; break;
2245 case Lz4
: name
= "lz4"; break;
2248 if (AutoClose
== true && Fd
!= -1)
2250 return FileFdError("Opening Fd %d in Auto or Extension compression mode is not supported", Fd
);
2252 for (; compressor
!= compressors
.end(); ++compressor
)
2253 if (compressor
->Name
== name
)
2255 if (compressor
== compressors
.end())
2257 if (AutoClose
== true && Fd
!= -1)
2259 return FileFdError("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
2261 return OpenDescriptor(Fd
, Mode
, *compressor
, AutoClose
);
2263 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
, bool AutoClose
)
2266 Flags
= (AutoClose
) ? FileFd::AutoClose
: 0;
2268 this->FileName
= "";
2269 if (OpenInternDescriptor(Mode
, compressor
) == false)
2272 (Flags
& Compressed
) == Compressed
||
2278 return FileFdError(_("Could not open file descriptor %d"), Fd
);
2282 bool FileFd::OpenInternDescriptor(unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
)
2288 d
->InternalClose(FileName
);
2293 /* dummy so that the rest can be 'else if's */;
2294 #define APT_COMPRESS_INIT(NAME, CONSTRUCTOR) \
2295 else if (compressor.Name == NAME) \
2296 d = new CONSTRUCTOR(this)
2298 APT_COMPRESS_INIT("gzip", GzipFileFdPrivate
);
2301 APT_COMPRESS_INIT("bzip2", Bz2FileFdPrivate
);
2304 APT_COMPRESS_INIT("xz", LzmaFileFdPrivate
);
2305 APT_COMPRESS_INIT("lzma", LzmaFileFdPrivate
);
2308 APT_COMPRESS_INIT("lz4", Lz4FileFdPrivate
);
2310 #undef APT_COMPRESS_INIT
2311 else if (compressor
.Name
== "." || compressor
.Binary
.empty() == true)
2312 d
= new DirectFileFdPrivate(this);
2314 d
= new PipedFileFdPrivate(this);
2316 if (Mode
& BufferedWrite
)
2317 d
= new BufferedWriteFileFdPrivate(d
);
2319 d
->set_openmode(Mode
);
2320 d
->set_compressor(compressor
);
2321 if ((Flags
& AutoClose
) != AutoClose
&& d
->InternalAlwaysAutoClose())
2323 // Need to duplicate fd here or gz/bz2 close for cleanup will close the fd as well
2324 int const internFd
= dup(iFd
);
2326 return FileFdErrno("OpenInternDescriptor", _("Could not open file descriptor %d"), iFd
);
2330 return d
->InternalOpen(iFd
, Mode
);
2333 // FileFd::~File - Closes the file /*{{{*/
2334 // ---------------------------------------------------------------------
2335 /* If the proper modes are selected then we close the Fd and possibly
2336 unlink the file on error. */
2341 d
->InternalClose(FileName
);
2346 // FileFd::Read - Read a bit of the file /*{{{*/
2347 // ---------------------------------------------------------------------
2348 /* We are careful to handle interruption by a signal while reading
2350 bool FileFd::Read(void *To
,unsigned long long Size
,unsigned long long *Actual
)
2358 *((char *)To
) = '\0';
2359 while (Res
> 0 && Size
> 0)
2361 Res
= d
->InternalRead(To
, Size
);
2367 // trick the while-loop into running again
2372 return d
->InternalReadError();
2375 To
= (char *)To
+ Res
;
2378 d
->set_seekpos(d
->get_seekpos() + Res
);
2393 return FileFdError(_("read, still have %llu to read but none left"), Size
);
2396 // FileFd::ReadLine - Read a complete line from the file /*{{{*/
2397 // ---------------------------------------------------------------------
2398 /* Beware: This method can be quite slow for big buffers on UNcompressed
2399 files because of the naive implementation! */
2400 char* FileFd::ReadLine(char *To
, unsigned long long const Size
)
2405 return d
->InternalReadLine(To
, Size
);
2408 // FileFd::Flush - Flush the file /*{{{*/
2409 bool FileFd::Flush()
2414 return d
->InternalFlush();
2417 // FileFd::Write - Write to the file /*{{{*/
2418 bool FileFd::Write(const void *From
,unsigned long long Size
)
2424 while (Res
> 0 && Size
> 0)
2426 Res
= d
->InternalWrite(From
, Size
);
2427 if (Res
< 0 && errno
== EINTR
)
2430 return d
->InternalWriteError();
2432 From
= (char const *)From
+ Res
;
2435 d
->set_seekpos(d
->get_seekpos() + Res
);
2441 return FileFdError(_("write, still have %llu to write but couldn't"), Size
);
2443 bool FileFd::Write(int Fd
, const void *From
, unsigned long long Size
)
2447 while (Res
> 0 && Size
> 0)
2449 Res
= write(Fd
,From
,Size
);
2450 if (Res
< 0 && errno
== EINTR
)
2453 return _error
->Errno("write",_("Write error"));
2455 From
= (char const *)From
+ Res
;
2462 return _error
->Error(_("write, still have %llu to write but couldn't"), Size
);
2465 // FileFd::Seek - Seek in the file /*{{{*/
2466 bool FileFd::Seek(unsigned long long To
)
2471 return d
->InternalSeek(To
);
2474 // FileFd::Skip - Skip over data in the file /*{{{*/
2475 bool FileFd::Skip(unsigned long long Over
)
2479 return d
->InternalSkip(Over
);
2482 // FileFd::Truncate - Truncate the file /*{{{*/
2483 bool FileFd::Truncate(unsigned long long To
)
2487 // truncating /dev/null is always successful - as we get an error otherwise
2488 if (To
== 0 && FileName
== "/dev/null")
2490 return d
->InternalTruncate(To
);
2493 // FileFd::Tell - Current seek position /*{{{*/
2494 // ---------------------------------------------------------------------
2496 unsigned long long FileFd::Tell()
2500 off_t
const Res
= d
->InternalTell();
2501 if (Res
== (off_t
)-1)
2502 FileFdErrno("lseek","Failed to determine the current file position");
2503 d
->set_seekpos(Res
);
2507 static bool StatFileFd(char const * const msg
, int const iFd
, std::string
const &FileName
, struct stat
&Buf
, FileFdPrivate
* const d
) /*{{{*/
2509 bool ispipe
= (d
!= NULL
&& d
->get_is_pipe() == true);
2510 if (ispipe
== false)
2512 if (fstat(iFd
,&Buf
) != 0)
2513 // higher-level code will generate more meaningful messages,
2514 // even translated this would be meaningless for users
2515 return _error
->Errno("fstat", "Unable to determine %s for fd %i", msg
, iFd
);
2516 if (FileName
.empty() == false)
2517 ispipe
= S_ISFIFO(Buf
.st_mode
);
2520 // for compressor pipes st_size is undefined and at 'best' zero
2523 // we set it here, too, as we get the info here for free
2524 // in theory the Open-methods should take care of it already
2526 d
->set_is_pipe(true);
2527 if (stat(FileName
.c_str(), &Buf
) != 0)
2528 return _error
->Errno("fstat", "Unable to determine %s for file %s", msg
, FileName
.c_str());
2533 // FileFd::FileSize - Return the size of the file /*{{{*/
2534 unsigned long long FileFd::FileSize()
2537 if (StatFileFd("file size", iFd
, FileName
, Buf
, d
) == false)
2545 // FileFd::ModificationTime - Return the time of last touch /*{{{*/
2546 time_t FileFd::ModificationTime()
2549 if (StatFileFd("modification time", iFd
, FileName
, Buf
, d
) == false)
2554 return Buf
.st_mtime
;
2557 // FileFd::Size - Return the size of the content in the file /*{{{*/
2558 unsigned long long FileFd::Size()
2562 return d
->InternalSize();
2565 // FileFd::Close - Close the file if the close flag is set /*{{{*/
2566 // ---------------------------------------------------------------------
2568 bool FileFd::Close()
2570 if (Flush() == false)
2576 if ((Flags
& AutoClose
) == AutoClose
)
2578 if ((Flags
& Compressed
) != Compressed
&& iFd
> 0 && close(iFd
) != 0)
2579 Res
&= _error
->Errno("close",_("Problem closing the file %s"), FileName
.c_str());
2584 Res
&= d
->InternalClose(FileName
);
2589 if ((Flags
& Replace
) == Replace
) {
2590 if (rename(TemporaryFileName
.c_str(), FileName
.c_str()) != 0)
2591 Res
&= _error
->Errno("rename",_("Problem renaming the file %s to %s"), TemporaryFileName
.c_str(), FileName
.c_str());
2593 FileName
= TemporaryFileName
; // for the unlink() below.
2594 TemporaryFileName
.clear();
2599 if ((Flags
& Fail
) == Fail
&& (Flags
& DelOnFail
) == DelOnFail
&&
2600 FileName
.empty() == false)
2601 Res
&= RemoveFile("FileFd::Close", FileName
);
2608 // FileFd::Sync - Sync the file /*{{{*/
2609 // ---------------------------------------------------------------------
2613 if (fsync(iFd
) != 0)
2614 return FileFdErrno("sync",_("Problem syncing the file"));
2618 // FileFd::FileFdErrno - set Fail and call _error->Errno *{{{*/
2619 bool FileFd::FileFdErrno(const char *Function
, const char *Description
,...)
2623 size_t msgSize
= 400;
2624 int const errsv
= errno
;
2627 va_start(args
,Description
);
2628 if (_error
->InsertErrno(GlobalError::ERROR
, Function
, Description
, args
, errsv
, msgSize
) == false)
2635 // FileFd::FileFdError - set Fail and call _error->Error *{{{*/
2636 bool FileFd::FileFdError(const char *Description
,...) {
2639 size_t msgSize
= 400;
2642 va_start(args
,Description
);
2643 if (_error
->Insert(GlobalError::ERROR
, Description
, args
, msgSize
) == false)
2650 gzFile
FileFd::gzFd() { /*{{{*/
2652 GzipFileFdPrivate
* const gzipd
= dynamic_cast<GzipFileFdPrivate
*>(d
);
2653 if (gzipd
== nullptr)
2663 // Glob - wrapper around "glob()" /*{{{*/
2664 std::vector
<std::string
> Glob(std::string
const &pattern
, int flags
)
2666 std::vector
<std::string
> result
;
2671 glob_res
= glob(pattern
.c_str(), flags
, NULL
, &globbuf
);
2675 if(glob_res
!= GLOB_NOMATCH
) {
2676 _error
->Errno("glob", "Problem with glob");
2682 for(i
=0;i
<globbuf
.gl_pathc
;i
++)
2683 result
.push_back(string(globbuf
.gl_pathv
[i
]));
2689 std::string
GetTempDir() /*{{{*/
2691 const char *tmpdir
= getenv("TMPDIR");
2699 if (!tmpdir
|| strlen(tmpdir
) == 0 || // tmpdir is set
2700 stat(tmpdir
, &st
) != 0 || (st
.st_mode
& S_IFDIR
) == 0) // exists and is directory
2702 else if (geteuid() != 0 && // root can do everything anyway
2703 faccessat(-1, tmpdir
, R_OK
| W_OK
| X_OK
, AT_EACCESS
| AT_SYMLINK_NOFOLLOW
) != 0) // current user has rwx access to directory
2706 return string(tmpdir
);
2708 std::string
GetTempDir(std::string
const &User
)
2710 // no need/possibility to drop privs
2711 if(getuid() != 0 || User
.empty() || User
== "root")
2712 return GetTempDir();
2714 struct passwd
const * const pw
= getpwnam(User
.c_str());
2716 return GetTempDir();
2718 gid_t
const old_euid
= geteuid();
2719 gid_t
const old_egid
= getegid();
2720 if (setegid(pw
->pw_gid
) != 0)
2721 _error
->Errno("setegid", "setegid %u failed", pw
->pw_gid
);
2722 if (seteuid(pw
->pw_uid
) != 0)
2723 _error
->Errno("seteuid", "seteuid %u failed", pw
->pw_uid
);
2725 std::string
const tmp
= GetTempDir();
2727 if (seteuid(old_euid
) != 0)
2728 _error
->Errno("seteuid", "seteuid %u failed", old_euid
);
2729 if (setegid(old_egid
) != 0)
2730 _error
->Errno("setegid", "setegid %u failed", old_egid
);
2735 FileFd
* GetTempFile(std::string
const &Prefix
, bool ImmediateUnlink
, FileFd
* const TmpFd
) /*{{{*/
2738 FileFd
* const Fd
= TmpFd
== NULL
? new FileFd() : TmpFd
;
2740 std::string
const tempdir
= GetTempDir();
2741 snprintf(fn
, sizeof(fn
), "%s/%s.XXXXXX",
2742 tempdir
.c_str(), Prefix
.c_str());
2743 int const fd
= mkstemp(fn
);
2748 _error
->Errno("GetTempFile",_("Unable to mkstemp %s"), fn
);
2751 if (!Fd
->OpenDescriptor(fd
, FileFd::ReadWrite
, FileFd::None
, true))
2753 _error
->Errno("GetTempFile",_("Unable to write to %s"),fn
);
2759 bool Rename(std::string From
, std::string To
) /*{{{*/
2761 if (rename(From
.c_str(),To
.c_str()) != 0)
2763 _error
->Error(_("rename failed, %s (%s -> %s)."),strerror(errno
),
2764 From
.c_str(),To
.c_str());
2770 bool Popen(const char* Args
[], FileFd
&Fd
, pid_t
&Child
, FileFd::OpenMode Mode
)/*{{{*/
2773 if (Mode
!= FileFd::ReadOnly
&& Mode
!= FileFd::WriteOnly
)
2774 return _error
->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2776 int Pipe
[2] = {-1, -1};
2778 return _error
->Errno("pipe", _("Failed to create subprocess IPC"));
2780 std::set
<int> keep_fds
;
2781 keep_fds
.insert(Pipe
[0]);
2782 keep_fds
.insert(Pipe
[1]);
2783 Child
= ExecFork(keep_fds
);
2785 return _error
->Errno("fork", "Failed to fork");
2788 if(Mode
== FileFd::ReadOnly
)
2793 else if(Mode
== FileFd::WriteOnly
)
2799 if(Mode
== FileFd::ReadOnly
)
2803 } else if(Mode
== FileFd::WriteOnly
)
2806 execv(Args
[0], (char**)Args
);
2809 if(Mode
== FileFd::ReadOnly
)
2814 else if(Mode
== FileFd::WriteOnly
)
2820 return _error
->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2821 Fd
.OpenDescriptor(fd
, Mode
, FileFd::None
, true);
2826 bool DropPrivileges() /*{{{*/
2828 if(_config
->FindB("Debug::NoDropPrivs", false) == true)
2832 #if defined(PR_SET_NO_NEW_PRIVS) && ( PR_SET_NO_NEW_PRIVS != 38 )
2833 #error "PR_SET_NO_NEW_PRIVS is defined, but with a different value than expected!"
2835 // see prctl(2), needs linux3.5 at runtime - magic constant to avoid it at buildtime
2836 int ret
= prctl(38, 1, 0, 0, 0);
2837 // ignore EINVAL - kernel is too old to understand the option
2838 if(ret
< 0 && errno
!= EINVAL
)
2839 _error
->Warning("PR_SET_NO_NEW_PRIVS failed with %i", ret
);
2842 // empty setting disables privilege dropping - this also ensures
2843 // backward compatibility, see bug #764506
2844 const std::string toUser
= _config
->Find("APT::Sandbox::User");
2845 if (toUser
.empty() || toUser
== "root")
2848 // a lot can go wrong trying to drop privileges completely,
2849 // so ideally we would like to verify that we have done it –
2850 // but the verify asks for too much in case of fakeroot (and alike)
2851 // [Specific checks can be overridden with dedicated options]
2852 bool const VerifySandboxing
= _config
->FindB("APT::Sandbox::Verify", false);
2854 // uid will be 0 in the end, but gid might be different anyway
2855 uid_t
const old_uid
= getuid();
2856 gid_t
const old_gid
= getgid();
2861 struct passwd
*pw
= getpwnam(toUser
.c_str());
2863 return _error
->Error("No user %s, can not drop rights", toUser
.c_str());
2865 // Do not change the order here, it might break things
2866 // Get rid of all our supplementary groups first
2867 if (setgroups(1, &pw
->pw_gid
))
2868 return _error
->Errno("setgroups", "Failed to setgroups");
2870 // Now change the group ids to the new user
2871 #ifdef HAVE_SETRESGID
2872 if (setresgid(pw
->pw_gid
, pw
->pw_gid
, pw
->pw_gid
) != 0)
2873 return _error
->Errno("setresgid", "Failed to set new group ids");
2875 if (setegid(pw
->pw_gid
) != 0)
2876 return _error
->Errno("setegid", "Failed to setegid");
2878 if (setgid(pw
->pw_gid
) != 0)
2879 return _error
->Errno("setgid", "Failed to setgid");
2882 // Change the user ids to the new user
2883 #ifdef HAVE_SETRESUID
2884 if (setresuid(pw
->pw_uid
, pw
->pw_uid
, pw
->pw_uid
) != 0)
2885 return _error
->Errno("setresuid", "Failed to set new user ids");
2887 if (setuid(pw
->pw_uid
) != 0)
2888 return _error
->Errno("setuid", "Failed to setuid");
2889 if (seteuid(pw
->pw_uid
) != 0)
2890 return _error
->Errno("seteuid", "Failed to seteuid");
2893 // disabled by default as fakeroot doesn't implement getgroups currently (#806521)
2894 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::Groups", false) == true)
2896 // Verify that the user isn't still in any supplementary groups
2897 long const ngroups_max
= sysconf(_SC_NGROUPS_MAX
);
2898 std::unique_ptr
<gid_t
[]> gidlist(new gid_t
[ngroups_max
]);
2899 if (unlikely(gidlist
== NULL
))
2900 return _error
->Error("Allocation of a list of size %lu for getgroups failed", ngroups_max
);
2902 if ((gidlist_nr
= getgroups(ngroups_max
, gidlist
.get())) < 0)
2903 return _error
->Errno("getgroups", "Could not get new groups (%lu)", ngroups_max
);
2904 for (ssize_t i
= 0; i
< gidlist_nr
; ++i
)
2905 if (gidlist
[i
] != pw
->pw_gid
)
2906 return _error
->Error("Could not switch group, user %s is still in group %d", toUser
.c_str(), gidlist
[i
]);
2909 // enabled by default as all fakeroot-lookalikes should fake that accordingly
2910 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::IDs", true) == true)
2912 // Verify that gid, egid, uid, and euid changed
2913 if (getgid() != pw
->pw_gid
)
2914 return _error
->Error("Could not switch group");
2915 if (getegid() != pw
->pw_gid
)
2916 return _error
->Error("Could not switch effective group");
2917 if (getuid() != pw
->pw_uid
)
2918 return _error
->Error("Could not switch user");
2919 if (geteuid() != pw
->pw_uid
)
2920 return _error
->Error("Could not switch effective user");
2922 #ifdef HAVE_GETRESUID
2923 // verify that the saved set-user-id was changed as well
2927 if (getresuid(&ruid
, &euid
, &suid
))
2928 return _error
->Errno("getresuid", "Could not get saved set-user-ID");
2929 if (suid
!= pw
->pw_uid
)
2930 return _error
->Error("Could not switch saved set-user-ID");
2933 #ifdef HAVE_GETRESGID
2934 // verify that the saved set-group-id was changed as well
2938 if (getresgid(&rgid
, &egid
, &sgid
))
2939 return _error
->Errno("getresuid", "Could not get saved set-group-ID");
2940 if (sgid
!= pw
->pw_gid
)
2941 return _error
->Error("Could not switch saved set-group-ID");
2945 // disabled as fakeroot doesn't forbid (by design) (re)gaining root from unprivileged
2946 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::Regain", false) == true)
2948 // Check that uid and gid changes do not work anymore
2949 if (pw
->pw_gid
!= old_gid
&& (setgid(old_gid
) != -1 || setegid(old_gid
) != -1))
2950 return _error
->Error("Could restore a gid to root, privilege dropping did not work");
2952 if (pw
->pw_uid
!= old_uid
&& (setuid(old_uid
) != -1 || seteuid(old_uid
) != -1))
2953 return _error
->Error("Could restore a uid to root, privilege dropping did not work");