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());
1124 return filefd
->Skip(To
);
1129 virtual bool InternalSkip(unsigned long long Over
)
1131 unsigned long long constexpr buffersize
= 1024;
1132 char buffer
[buffersize
];
1135 unsigned long long toread
= std::min(buffersize
, Over
);
1136 if (filefd
->Read(buffer
, toread
) == false)
1137 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
1142 virtual bool InternalTruncate(unsigned long long const)
1144 return filefd
->FileFdError("Truncating compressed files is not implemented (%s)", filefd
->FileName
.c_str());
1146 virtual unsigned long long InternalTell()
1148 // In theory, we could just return seekpos here always instead of
1149 // seeking around, but not all users of FileFd use always Seek() and co
1150 // so d->seekpos isn't always true and we can just use it as a hint if
1151 // we have nothing else, but not always as an authority…
1152 return seekpos
- buffer
.size();
1154 virtual unsigned long long InternalSize()
1156 unsigned long long size
= 0;
1157 unsigned long long const oldSeek
= filefd
->Tell();
1158 unsigned long long constexpr ignoresize
= 1024;
1159 char ignore
[ignoresize
];
1160 unsigned long long read
= 0;
1162 if (filefd
->Read(ignore
, ignoresize
, &read
) == false)
1164 filefd
->Seek(oldSeek
);
1168 size
= filefd
->Tell();
1169 filefd
->Seek(oldSeek
);
1172 virtual bool InternalClose(std::string
const &FileName
) = 0;
1173 virtual bool InternalStream() const { return false; }
1174 virtual bool InternalAlwaysAutoClose() const { return true; }
1176 virtual ~FileFdPrivate() {}
1179 class APT_HIDDEN BufferedWriteFileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1181 FileFdPrivate
*wrapped
;
1182 simple_buffer writebuffer
;
1186 explicit BufferedWriteFileFdPrivate(FileFdPrivate
*Priv
) :
1187 FileFdPrivate(Priv
->filefd
), wrapped(Priv
) {};
1189 virtual APT::Configuration::Compressor
get_compressor() const APT_OVERRIDE
1191 return wrapped
->get_compressor();
1193 virtual void set_compressor(APT::Configuration::Compressor
const &compressor
) APT_OVERRIDE
1195 return wrapped
->set_compressor(compressor
);
1197 virtual unsigned int get_openmode() const APT_OVERRIDE
1199 return wrapped
->get_openmode();
1201 virtual void set_openmode(unsigned int openmode
) APT_OVERRIDE
1203 return wrapped
->set_openmode(openmode
);
1205 virtual bool get_is_pipe() const APT_OVERRIDE
1207 return wrapped
->get_is_pipe();
1209 virtual void set_is_pipe(bool is_pipe
) APT_OVERRIDE
1211 FileFdPrivate::set_is_pipe(is_pipe
);
1212 wrapped
->set_is_pipe(is_pipe
);
1214 virtual unsigned long long get_seekpos() const APT_OVERRIDE
1216 return wrapped
->get_seekpos();
1218 virtual void set_seekpos(unsigned long long seekpos
) APT_OVERRIDE
1220 return wrapped
->set_seekpos(seekpos
);
1222 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) APT_OVERRIDE
1224 if (InternalFlush() == false)
1226 return wrapped
->InternalOpen(iFd
, Mode
);
1228 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) APT_OVERRIDE
1230 if (InternalFlush() == false)
1232 return wrapped
->InternalUnbufferedRead(To
, Size
);
1235 virtual bool InternalReadError() APT_OVERRIDE
1237 return wrapped
->InternalReadError();
1239 virtual char * InternalReadLine(char * To
, unsigned long long Size
) APT_OVERRIDE
1241 if (InternalFlush() == false)
1243 return wrapped
->InternalReadLine(To
, Size
);
1245 virtual bool InternalFlush() APT_OVERRIDE
1247 while (writebuffer
.empty() == false) {
1248 auto written
= wrapped
->InternalWrite(writebuffer
.get(),
1249 writebuffer
.size());
1250 // Ignore interrupted syscalls
1251 if (written
< 0 && errno
== EINTR
)
1254 return wrapped
->InternalWriteError();
1256 writebuffer
.bufferstart
+= written
;
1259 writebuffer
.reset();
1262 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) APT_OVERRIDE
1264 // Optimisation: If the buffer is empty and we have more to write than
1265 // would fit in the buffer (or equal number of bytes), write directly.
1266 if (writebuffer
.empty() == true && Size
>= writebuffer
.free())
1267 return wrapped
->InternalWrite(From
, Size
);
1269 // Write as much into the buffer as possible and then flush if needed
1270 auto written
= writebuffer
.write(From
, Size
);
1272 if (writebuffer
.full() && InternalFlush() == false)
1277 virtual bool InternalWriteError() APT_OVERRIDE
1279 return wrapped
->InternalWriteError();
1281 virtual bool InternalSeek(unsigned long long const To
) APT_OVERRIDE
1283 if (InternalFlush() == false)
1285 return wrapped
->InternalSeek(To
);
1287 virtual bool InternalSkip(unsigned long long Over
) APT_OVERRIDE
1289 if (InternalFlush() == false)
1291 return wrapped
->InternalSkip(Over
);
1293 virtual bool InternalTruncate(unsigned long long const Size
) APT_OVERRIDE
1295 if (InternalFlush() == false)
1297 return wrapped
->InternalTruncate(Size
);
1299 virtual unsigned long long InternalTell() APT_OVERRIDE
1301 if (InternalFlush() == false)
1303 return wrapped
->InternalTell();
1305 virtual unsigned long long InternalSize() APT_OVERRIDE
1307 if (InternalFlush() == false)
1309 return wrapped
->InternalSize();
1311 virtual bool InternalClose(std::string
const &FileName
) APT_OVERRIDE
1313 return wrapped
->InternalClose(FileName
);
1315 virtual bool InternalAlwaysAutoClose() const APT_OVERRIDE
1317 return wrapped
->InternalAlwaysAutoClose();
1319 virtual ~BufferedWriteFileFdPrivate()
1325 class APT_HIDDEN GzipFileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1329 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) APT_OVERRIDE
1331 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1332 gz
= gzdopen(iFd
, "r+");
1333 else if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1334 gz
= gzdopen(iFd
, "w");
1336 gz
= gzdopen(iFd
, "r");
1337 filefd
->Flags
|= FileFd::Compressed
;
1338 return gz
!= nullptr;
1340 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) APT_OVERRIDE
1342 return gzread(gz
, To
, Size
);
1344 virtual bool InternalReadError() APT_OVERRIDE
1347 char const * const errmsg
= gzerror(gz
, &err
);
1349 return filefd
->FileFdError("gzread: %s (%d: %s)", _("Read error"), err
, errmsg
);
1350 return FileFdPrivate::InternalReadError();
1352 virtual char * InternalReadLine(char * To
, unsigned long long Size
) APT_OVERRIDE
1354 return gzgets(gz
, To
, Size
);
1356 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) APT_OVERRIDE
1358 return gzwrite(gz
,From
,Size
);
1360 virtual bool InternalWriteError() APT_OVERRIDE
1363 char const * const errmsg
= gzerror(gz
, &err
);
1365 return filefd
->FileFdError("gzwrite: %s (%d: %s)", _("Write error"), err
, errmsg
);
1366 return FileFdPrivate::InternalWriteError();
1368 virtual bool InternalSeek(unsigned long long const To
) APT_OVERRIDE
1370 off_t
const res
= gzseek(gz
, To
, SEEK_SET
);
1371 if (res
!= (off_t
)To
)
1372 return filefd
->FileFdError("Unable to seek to %llu", To
);
1377 virtual bool InternalSkip(unsigned long long Over
) APT_OVERRIDE
1379 if (Over
>= buffer
.size())
1381 Over
-= buffer
.size();
1386 buffer
.bufferstart
+= Over
;
1391 off_t
const res
= gzseek(gz
, Over
, SEEK_CUR
);
1393 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
1397 virtual unsigned long long InternalTell() APT_OVERRIDE
1399 return gztell(gz
) - buffer
.size();
1401 virtual unsigned long long InternalSize() APT_OVERRIDE
1403 unsigned long long filesize
= FileFdPrivate::InternalSize();
1404 // only check gzsize if we are actually a gzip file, just checking for
1405 // "gz" is not sufficient as uncompressed files could be opened with
1406 // gzopen in "direct" mode as well
1407 if (filesize
== 0 || gzdirect(gz
))
1410 off_t
const oldPos
= lseek(filefd
->iFd
, 0, SEEK_CUR
);
1411 /* unfortunately zlib.h doesn't provide a gzsize(), so we have to do
1412 * this ourselves; the original (uncompressed) file size is the last 32
1413 * bits of the file */
1414 // FIXME: Size for gz-files is limited by 32bit… no largefile support
1415 if (lseek(filefd
->iFd
, -4, SEEK_END
) < 0)
1417 filefd
->FileFdErrno("lseek","Unable to seek to end of gzipped file");
1421 if (read(filefd
->iFd
, &size
, 4) != 4)
1423 filefd
->FileFdErrno("read","Unable to read original size of gzipped file");
1426 size
= le32toh(size
);
1428 if (lseek(filefd
->iFd
, oldPos
, SEEK_SET
) < 0)
1430 filefd
->FileFdErrno("lseek","Unable to seek in gzipped file");
1435 virtual bool InternalClose(std::string
const &FileName
) APT_OVERRIDE
1439 int const e
= gzclose(gz
);
1441 // gzdclose() on empty files always fails with "buffer error" here, ignore that
1442 if (e
!= 0 && e
!= Z_BUF_ERROR
)
1443 return _error
->Errno("close",_("Problem closing the gzip file %s"), FileName
.c_str());
1447 explicit GzipFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), gz(nullptr) {}
1448 virtual ~GzipFileFdPrivate() { InternalClose(""); }
1452 class APT_HIDDEN Bz2FileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1456 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) APT_OVERRIDE
1458 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1459 bz2
= BZ2_bzdopen(iFd
, "r+");
1460 else if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1461 bz2
= BZ2_bzdopen(iFd
, "w");
1463 bz2
= BZ2_bzdopen(iFd
, "r");
1464 filefd
->Flags
|= FileFd::Compressed
;
1465 return bz2
!= nullptr;
1467 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) APT_OVERRIDE
1469 return BZ2_bzread(bz2
, To
, Size
);
1471 virtual bool InternalReadError() APT_OVERRIDE
1474 char const * const errmsg
= BZ2_bzerror(bz2
, &err
);
1475 if (err
!= BZ_IO_ERROR
)
1476 return filefd
->FileFdError("BZ2_bzread: %s %s (%d: %s)", filefd
->FileName
.c_str(), _("Read error"), err
, errmsg
);
1477 return FileFdPrivate::InternalReadError();
1479 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) APT_OVERRIDE
1481 return BZ2_bzwrite(bz2
, (void*)From
, Size
);
1483 virtual bool InternalWriteError() APT_OVERRIDE
1486 char const * const errmsg
= BZ2_bzerror(bz2
, &err
);
1487 if (err
!= BZ_IO_ERROR
)
1488 return filefd
->FileFdError("BZ2_bzwrite: %s %s (%d: %s)", filefd
->FileName
.c_str(), _("Write error"), err
, errmsg
);
1489 return FileFdPrivate::InternalWriteError();
1491 virtual bool InternalStream() const APT_OVERRIDE
{ return true; }
1492 virtual bool InternalClose(std::string
const &) APT_OVERRIDE
1501 explicit Bz2FileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), bz2(nullptr) {}
1502 virtual ~Bz2FileFdPrivate() { InternalClose(""); }
1506 class APT_HIDDEN Lz4FileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1507 static constexpr unsigned long long LZ4_HEADER_SIZE
= 19;
1508 static constexpr unsigned long long LZ4_FOOTER_SIZE
= 4;
1510 LZ4F_decompressionContext_t dctx
;
1511 LZ4F_compressionContext_t cctx
;
1512 LZ4F_errorCode_t res
;
1514 simple_buffer lz4_buffer
;
1515 // Count of bytes that the decompressor expects to read next, or buffer size.
1516 size_t next_to_load
= APT_BUFFER_SIZE
;
1518 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) APT_OVERRIDE
1520 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1521 return _error
->Error("lz4 only supports write or read mode");
1523 if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
) {
1524 res
= LZ4F_createCompressionContext(&cctx
, LZ4F_VERSION
);
1525 lz4_buffer
.reset(LZ4F_compressBound(APT_BUFFER_SIZE
, nullptr)
1526 + LZ4_HEADER_SIZE
+ LZ4_FOOTER_SIZE
);
1528 res
= LZ4F_createDecompressionContext(&dctx
, LZ4F_VERSION
);
1529 lz4_buffer
.reset(APT_BUFFER_SIZE
);
1532 filefd
->Flags
|= FileFd::Compressed
;
1534 if (LZ4F_isError(res
))
1537 unsigned int flags
= (Mode
& (FileFd::WriteOnly
|FileFd::ReadOnly
));
1538 if (backend
.OpenDescriptor(iFd
, flags
) == false)
1541 // Write the file header
1542 if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1544 res
= LZ4F_compressBegin(cctx
, lz4_buffer
.buffer
, lz4_buffer
.buffersize_max
, nullptr);
1545 if (LZ4F_isError(res
) || backend
.Write(lz4_buffer
.buffer
, res
) == false)
1551 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) APT_OVERRIDE
1553 /* Keep reading as long as the compressor still wants to read */
1554 while (next_to_load
) {
1555 // Fill compressed buffer;
1556 if (lz4_buffer
.empty()) {
1557 unsigned long long read
;
1558 /* Reset - if LZ4 decompressor wants to read more, allocate more */
1559 lz4_buffer
.reset(next_to_load
);
1560 if (backend
.Read(lz4_buffer
.getend(), lz4_buffer
.free(), &read
) == false)
1562 lz4_buffer
.bufferend
+= read
;
1567 return filefd
->FileFdError("LZ4F: %s %s",
1568 filefd
->FileName
.c_str(),
1569 _("Unexpected end of file")), -1;
1572 // Drain compressed buffer as far as possible.
1573 size_t in
= lz4_buffer
.size();
1576 res
= LZ4F_decompress(dctx
, To
, &out
, lz4_buffer
.get(), &in
, nullptr);
1577 if (LZ4F_isError(res
))
1581 lz4_buffer
.bufferstart
+= in
;
1589 virtual bool InternalReadError() APT_OVERRIDE
1591 char const * const errmsg
= LZ4F_getErrorName(res
);
1593 return filefd
->FileFdError("LZ4F: %s %s (%zu: %s)", filefd
->FileName
.c_str(), _("Read error"), res
, errmsg
);
1595 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) APT_OVERRIDE
1597 unsigned long long const towrite
= std::min(APT_BUFFER_SIZE
, Size
);
1599 res
= LZ4F_compressUpdate(cctx
,
1600 lz4_buffer
.buffer
, lz4_buffer
.buffersize_max
,
1601 From
, towrite
, nullptr);
1603 if (LZ4F_isError(res
) || backend
.Write(lz4_buffer
.buffer
, res
) == false)
1608 virtual bool InternalWriteError() APT_OVERRIDE
1610 char const * const errmsg
= LZ4F_getErrorName(res
);
1612 return filefd
->FileFdError("LZ4F: %s %s (%zu: %s)", filefd
->FileName
.c_str(), _("Write error"), res
, errmsg
);
1614 virtual bool InternalStream() const APT_OVERRIDE
{ return true; }
1616 virtual bool InternalFlush() APT_OVERRIDE
1618 return backend
.Flush();
1621 virtual bool InternalClose(std::string
const &) APT_OVERRIDE
1623 /* Reset variables */
1625 next_to_load
= APT_BUFFER_SIZE
;
1627 if (cctx
!= nullptr)
1629 res
= LZ4F_compressEnd(cctx
, lz4_buffer
.buffer
, lz4_buffer
.buffersize_max
, nullptr);
1630 if (LZ4F_isError(res
) || backend
.Write(lz4_buffer
.buffer
, res
) == false)
1632 if (!backend
.Flush())
1634 if (!backend
.Close())
1637 res
= LZ4F_freeCompressionContext(cctx
);
1641 if (dctx
!= nullptr)
1643 res
= LZ4F_freeDecompressionContext(dctx
);
1647 return LZ4F_isError(res
) == false;
1650 explicit Lz4FileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), dctx(nullptr), cctx(nullptr) {}
1651 virtual ~Lz4FileFdPrivate() {
1657 class APT_HIDDEN LzmaFileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1661 uint8_t buffer
[4096];
1667 LZMAFILE() : file(nullptr), eof(false), compressing(false) { buffer
[0] = '\0'; }
1670 if (compressing
== true)
1672 size_t constexpr buffersize
= sizeof(buffer
)/sizeof(buffer
[0]);
1675 stream
.avail_out
= buffersize
;
1676 stream
.next_out
= buffer
;
1677 err
= lzma_code(&stream
, LZMA_FINISH
);
1678 if (err
!= LZMA_OK
&& err
!= LZMA_STREAM_END
)
1680 _error
->Error("~LZMAFILE: Compress finalisation failed");
1683 size_t const n
= buffersize
- stream
.avail_out
;
1684 if (n
&& fwrite(buffer
, 1, n
, file
) != n
)
1686 _error
->Errno("~LZMAFILE",_("Write error"));
1689 if (err
== LZMA_STREAM_END
)
1698 static uint32_t findXZlevel(std::vector
<std::string
> const &Args
)
1700 for (auto a
= Args
.rbegin(); a
!= Args
.rend(); ++a
)
1701 if (a
->empty() == false && (*a
)[0] == '-' && (*a
)[1] != '-')
1703 auto const number
= a
->find_last_of("0123456789");
1704 if (number
== std::string::npos
)
1706 auto const extreme
= a
->find("e", number
);
1707 uint32_t level
= (extreme
!= std::string::npos
) ? LZMA_PRESET_EXTREME
: 0;
1708 switch ((*a
)[number
])
1710 case '0': return level
| 0;
1711 case '1': return level
| 1;
1712 case '2': return level
| 2;
1713 case '3': return level
| 3;
1714 case '4': return level
| 4;
1715 case '5': return level
| 5;
1716 case '6': return level
| 6;
1717 case '7': return level
| 7;
1718 case '8': return level
| 8;
1719 case '9': return level
| 9;
1725 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) APT_OVERRIDE
1727 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1728 return filefd
->FileFdError("ReadWrite mode is not supported for lzma/xz files %s", filefd
->FileName
.c_str());
1730 if (lzma
== nullptr)
1731 lzma
= new LzmaFileFdPrivate::LZMAFILE
;
1732 if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1733 lzma
->file
= fdopen(iFd
, "w");
1735 lzma
->file
= fdopen(iFd
, "r");
1736 filefd
->Flags
|= FileFd::Compressed
;
1737 if (lzma
->file
== nullptr)
1740 lzma_stream tmp_stream
= LZMA_STREAM_INIT
;
1741 lzma
->stream
= tmp_stream
;
1743 if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1745 uint32_t const xzlevel
= findXZlevel(compressor
.CompressArgs
);
1746 if (compressor
.Name
== "xz")
1748 if (lzma_easy_encoder(&lzma
->stream
, xzlevel
, LZMA_CHECK_CRC64
) != LZMA_OK
)
1753 lzma_options_lzma options
;
1754 lzma_lzma_preset(&options
, xzlevel
);
1755 if (lzma_alone_encoder(&lzma
->stream
, &options
) != LZMA_OK
)
1758 lzma
->compressing
= true;
1762 uint64_t const memlimit
= UINT64_MAX
;
1763 if (compressor
.Name
== "xz")
1765 if (lzma_auto_decoder(&lzma
->stream
, memlimit
, 0) != LZMA_OK
)
1770 if (lzma_alone_decoder(&lzma
->stream
, memlimit
) != LZMA_OK
)
1773 lzma
->compressing
= false;
1777 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) APT_OVERRIDE
1780 if (lzma
->eof
== true)
1783 lzma
->stream
.next_out
= (uint8_t *) To
;
1784 lzma
->stream
.avail_out
= Size
;
1785 if (lzma
->stream
.avail_in
== 0)
1787 lzma
->stream
.next_in
= lzma
->buffer
;
1788 lzma
->stream
.avail_in
= fread(lzma
->buffer
, 1, sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]), lzma
->file
);
1790 lzma
->err
= lzma_code(&lzma
->stream
, LZMA_RUN
);
1791 if (lzma
->err
== LZMA_STREAM_END
)
1794 Res
= Size
- lzma
->stream
.avail_out
;
1796 else if (lzma
->err
!= LZMA_OK
)
1803 Res
= Size
- lzma
->stream
.avail_out
;
1806 // lzma run was okay, but produced no output…
1813 virtual bool InternalReadError() APT_OVERRIDE
1815 return filefd
->FileFdError("lzma_read: %s (%d)", _("Read error"), lzma
->err
);
1817 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) APT_OVERRIDE
1820 lzma
->stream
.next_in
= (uint8_t *)From
;
1821 lzma
->stream
.avail_in
= Size
;
1822 lzma
->stream
.next_out
= lzma
->buffer
;
1823 lzma
->stream
.avail_out
= sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]);
1824 lzma
->err
= lzma_code(&lzma
->stream
, LZMA_RUN
);
1825 if (lzma
->err
!= LZMA_OK
)
1827 size_t const n
= sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]) - lzma
->stream
.avail_out
;
1828 size_t const m
= (n
== 0) ? 0 : fwrite(lzma
->buffer
, 1, n
, lzma
->file
);
1836 Res
= Size
- lzma
->stream
.avail_in
;
1839 // lzma run was okay, but produced no output…
1846 virtual bool InternalWriteError() APT_OVERRIDE
1848 return filefd
->FileFdError("lzma_write: %s (%d)", _("Write error"), lzma
->err
);
1850 virtual bool InternalStream() const APT_OVERRIDE
{ return true; }
1851 virtual bool InternalClose(std::string
const &) APT_OVERRIDE
1858 explicit LzmaFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), lzma(nullptr) {}
1859 virtual ~LzmaFileFdPrivate() { InternalClose(""); }
1863 class APT_HIDDEN PipedFileFdPrivate
: public FileFdPrivate
/*{{{*/
1864 /* if we don't have a specific class dealing with library calls, we (un)compress
1865 by executing a specified binary and pipe in/out what we need */
1868 virtual bool InternalOpen(int const, unsigned int const Mode
) APT_OVERRIDE
1870 // collect zombies here in case we reopen
1871 if (compressor_pid
> 0)
1872 ExecWait(compressor_pid
, "FileFdCompressor", true);
1874 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1875 return filefd
->FileFdError("ReadWrite mode is not supported for file %s", filefd
->FileName
.c_str());
1877 bool const Comp
= (Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
;
1880 // Handle 'decompression' of empty files
1882 fstat(filefd
->iFd
, &Buf
);
1883 if (Buf
.st_size
== 0 && S_ISFIFO(Buf
.st_mode
) == false)
1886 // We don't need the file open - instead let the compressor open it
1887 // as he properly knows better how to efficiently read from 'his' file
1888 if (filefd
->FileName
.empty() == false)
1895 // Create a data pipe
1896 int Pipe
[2] = {-1,-1};
1897 if (pipe(Pipe
) != 0)
1898 return filefd
->FileFdErrno("pipe",_("Failed to create subprocess IPC"));
1899 for (int J
= 0; J
!= 2; J
++)
1900 SetCloseExec(Pipe
[J
],true);
1902 compressed_fd
= filefd
->iFd
;
1906 filefd
->iFd
= Pipe
[1];
1908 filefd
->iFd
= Pipe
[0];
1911 compressor_pid
= ExecFork();
1912 if (compressor_pid
== 0)
1916 dup2(compressed_fd
,STDOUT_FILENO
);
1917 dup2(Pipe
[0],STDIN_FILENO
);
1921 if (compressed_fd
!= -1)
1922 dup2(compressed_fd
,STDIN_FILENO
);
1923 dup2(Pipe
[1],STDOUT_FILENO
);
1925 int const nullfd
= open("/dev/null", O_WRONLY
);
1928 dup2(nullfd
,STDERR_FILENO
);
1932 SetCloseExec(STDOUT_FILENO
,false);
1933 SetCloseExec(STDIN_FILENO
,false);
1935 std::vector
<char const*> Args
;
1936 Args
.push_back(compressor
.Binary
.c_str());
1937 std::vector
<std::string
> const * const addArgs
=
1938 (Comp
== true) ? &(compressor
.CompressArgs
) : &(compressor
.UncompressArgs
);
1939 for (std::vector
<std::string
>::const_iterator a
= addArgs
->begin();
1940 a
!= addArgs
->end(); ++a
)
1941 Args
.push_back(a
->c_str());
1942 if (Comp
== false && filefd
->FileName
.empty() == false)
1944 // commands not needing arguments, do not need to be told about using standard output
1945 // in reality, only testcases with tools like cat, rev, rot13, … are able to trigger this
1946 if (compressor
.CompressArgs
.empty() == false && compressor
.UncompressArgs
.empty() == false)
1947 Args
.push_back("--stdout");
1948 if (filefd
->TemporaryFileName
.empty() == false)
1949 Args
.push_back(filefd
->TemporaryFileName
.c_str());
1951 Args
.push_back(filefd
->FileName
.c_str());
1953 Args
.push_back(NULL
);
1955 execvp(Args
[0],(char **)&Args
[0]);
1956 cerr
<< _("Failed to exec compressor ") << Args
[0] << endl
;
1966 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) APT_OVERRIDE
1968 return read(filefd
->iFd
, To
, Size
);
1970 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) APT_OVERRIDE
1972 return write(filefd
->iFd
, From
, Size
);
1974 virtual bool InternalClose(std::string
const &) APT_OVERRIDE
1977 if (compressor_pid
> 0)
1978 Ret
&= ExecWait(compressor_pid
, "FileFdCompressor", true);
1979 compressor_pid
= -1;
1982 explicit PipedFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
) {}
1983 virtual ~PipedFileFdPrivate() { InternalClose(""); }
1986 class APT_HIDDEN DirectFileFdPrivate
: public FileFdPrivate
/*{{{*/
1989 virtual bool InternalOpen(int const, unsigned int const) APT_OVERRIDE
{ return true; }
1990 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) APT_OVERRIDE
1992 return read(filefd
->iFd
, To
, Size
);
1994 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) APT_OVERRIDE
1996 // files opened read+write are strange and only really "supported" for direct files
1997 if (buffer
.size() != 0)
1999 lseek(filefd
->iFd
, -buffer
.size(), SEEK_CUR
);
2002 return write(filefd
->iFd
, From
, Size
);
2004 virtual bool InternalSeek(unsigned long long const To
) APT_OVERRIDE
2006 off_t
const res
= lseek(filefd
->iFd
, To
, SEEK_SET
);
2007 if (res
!= (off_t
)To
)
2008 return filefd
->FileFdError("Unable to seek to %llu", To
);
2013 virtual bool InternalSkip(unsigned long long Over
) APT_OVERRIDE
2015 if (Over
>= buffer
.size())
2017 Over
-= buffer
.size();
2022 buffer
.bufferstart
+= Over
;
2027 off_t
const res
= lseek(filefd
->iFd
, Over
, SEEK_CUR
);
2029 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
2033 virtual bool InternalTruncate(unsigned long long const To
) APT_OVERRIDE
2035 if (buffer
.size() != 0)
2037 unsigned long long const seekpos
= lseek(filefd
->iFd
, 0, SEEK_CUR
);
2038 if ((seekpos
- buffer
.size()) >= To
)
2040 else if (seekpos
>= To
)
2041 buffer
.bufferend
= (To
- seekpos
) + buffer
.bufferstart
;
2045 if (ftruncate(filefd
->iFd
, To
) != 0)
2046 return filefd
->FileFdError("Unable to truncate to %llu",To
);
2049 virtual unsigned long long InternalTell() APT_OVERRIDE
2051 return lseek(filefd
->iFd
,0,SEEK_CUR
) - buffer
.size();
2053 virtual unsigned long long InternalSize() APT_OVERRIDE
2055 return filefd
->FileSize();
2057 virtual bool InternalClose(std::string
const &) APT_OVERRIDE
{ return true; }
2058 virtual bool InternalAlwaysAutoClose() const APT_OVERRIDE
{ return false; }
2060 explicit DirectFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
) {}
2061 virtual ~DirectFileFdPrivate() { InternalClose(""); }
2064 // FileFd Constructors /*{{{*/
2065 FileFd::FileFd(std::string FileName
,unsigned int const Mode
,unsigned long AccessMode
) : iFd(-1), Flags(0), d(NULL
)
2067 Open(FileName
,Mode
, None
, AccessMode
);
2069 FileFd::FileFd(std::string FileName
,unsigned int const Mode
, CompressMode Compress
, unsigned long AccessMode
) : iFd(-1), Flags(0), d(NULL
)
2071 Open(FileName
,Mode
, Compress
, AccessMode
);
2073 FileFd::FileFd() : iFd(-1), Flags(AutoClose
), d(NULL
) {}
2074 FileFd::FileFd(int const Fd
, unsigned int const Mode
, CompressMode Compress
) : iFd(-1), Flags(0), d(NULL
)
2076 OpenDescriptor(Fd
, Mode
, Compress
);
2078 FileFd::FileFd(int const Fd
, bool const AutoClose
) : iFd(-1), Flags(0), d(NULL
)
2080 OpenDescriptor(Fd
, ReadWrite
, None
, AutoClose
);
2083 // FileFd::Open - Open a file /*{{{*/
2084 // ---------------------------------------------------------------------
2085 /* The most commonly used open mode combinations are given with Mode */
2086 bool FileFd::Open(string FileName
,unsigned int const Mode
,CompressMode Compress
, unsigned long const AccessMode
)
2088 if (Mode
== ReadOnlyGzip
)
2089 return Open(FileName
, ReadOnly
, Gzip
, AccessMode
);
2091 if (Compress
== Auto
&& (Mode
& WriteOnly
) == WriteOnly
)
2092 return FileFdError("Autodetection on %s only works in ReadOnly openmode!", FileName
.c_str());
2094 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
2095 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
2096 if (Compress
== Auto
)
2098 for (; compressor
!= compressors
.end(); ++compressor
)
2100 std::string file
= FileName
+ compressor
->Extension
;
2101 if (FileExists(file
) == false)
2107 else if (Compress
== Extension
)
2109 std::string::size_type
const found
= FileName
.find_last_of('.');
2111 if (found
!= std::string::npos
)
2113 ext
= FileName
.substr(found
);
2114 if (ext
== ".new" || ext
== ".bak")
2116 std::string::size_type
const found2
= FileName
.find_last_of('.', found
- 1);
2117 if (found2
!= std::string::npos
)
2118 ext
= FileName
.substr(found2
, found
- found2
);
2123 for (; compressor
!= compressors
.end(); ++compressor
)
2124 if (ext
== compressor
->Extension
)
2126 // no matching extension - assume uncompressed (imagine files like 'example.org_Packages')
2127 if (compressor
== compressors
.end())
2128 for (compressor
= compressors
.begin(); compressor
!= compressors
.end(); ++compressor
)
2129 if (compressor
->Name
== ".")
2137 case None
: name
= "."; break;
2138 case Gzip
: name
= "gzip"; break;
2139 case Bzip2
: name
= "bzip2"; break;
2140 case Lzma
: name
= "lzma"; break;
2141 case Xz
: name
= "xz"; break;
2142 case Lz4
: name
= "lz4"; break;
2146 return FileFdError("Opening File %s in None, Auto or Extension should be already handled?!?", FileName
.c_str());
2148 for (; compressor
!= compressors
.end(); ++compressor
)
2149 if (compressor
->Name
== name
)
2151 if (compressor
== compressors
.end())
2152 return FileFdError("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
2155 if (compressor
== compressors
.end())
2156 return FileFdError("Can't find a match for specified compressor mode for file %s", FileName
.c_str());
2157 return Open(FileName
, Mode
, *compressor
, AccessMode
);
2159 bool FileFd::Open(string FileName
,unsigned int const Mode
,APT::Configuration::Compressor
const &compressor
, unsigned long const AccessMode
)
2164 if ((Mode
& WriteOnly
) != WriteOnly
&& (Mode
& (Atomic
| Create
| Empty
| Exclusive
)) != 0)
2165 return FileFdError("ReadOnly mode for %s doesn't accept additional flags!", FileName
.c_str());
2166 if ((Mode
& ReadWrite
) == 0)
2167 return FileFdError("No openmode provided in FileFd::Open for %s", FileName
.c_str());
2169 unsigned int OpenMode
= Mode
;
2170 if (FileName
== "/dev/null")
2171 OpenMode
= OpenMode
& ~(Atomic
| Exclusive
| Create
| Empty
);
2173 if ((OpenMode
& Atomic
) == Atomic
)
2177 else if ((OpenMode
& (Exclusive
| Create
)) == (Exclusive
| Create
))
2179 // for atomic, this will be done by rename in Close()
2180 RemoveFile("FileFd::Open", FileName
);
2182 if ((OpenMode
& Empty
) == Empty
)
2185 if (lstat(FileName
.c_str(),&Buf
) == 0 && S_ISLNK(Buf
.st_mode
))
2186 RemoveFile("FileFd::Open", FileName
);
2190 #define if_FLAGGED_SET(FLAG, MODE) if ((OpenMode & FLAG) == FLAG) fileflags |= MODE
2191 if_FLAGGED_SET(ReadWrite
, O_RDWR
);
2192 else if_FLAGGED_SET(ReadOnly
, O_RDONLY
);
2193 else if_FLAGGED_SET(WriteOnly
, O_WRONLY
);
2195 if_FLAGGED_SET(Create
, O_CREAT
);
2196 if_FLAGGED_SET(Empty
, O_TRUNC
);
2197 if_FLAGGED_SET(Exclusive
, O_EXCL
);
2198 #undef if_FLAGGED_SET
2200 if ((OpenMode
& Atomic
) == Atomic
)
2202 char *name
= strdup((FileName
+ ".XXXXXX").c_str());
2204 if((iFd
= mkstemp(name
)) == -1)
2207 return FileFdErrno("mkstemp", "Could not create temporary file for %s", FileName
.c_str());
2210 TemporaryFileName
= string(name
);
2213 // umask() will always set the umask and return the previous value, so
2214 // we first set the umask and then reset it to the old value
2215 mode_t
const CurrentUmask
= umask(0);
2216 umask(CurrentUmask
);
2217 // calculate the actual file permissions (just like open/creat)
2218 mode_t
const FilePermissions
= (AccessMode
& ~CurrentUmask
);
2220 if(fchmod(iFd
, FilePermissions
) == -1)
2221 return FileFdErrno("fchmod", "Could not change permissions for temporary file %s", TemporaryFileName
.c_str());
2224 iFd
= open(FileName
.c_str(), fileflags
, AccessMode
);
2226 this->FileName
= FileName
;
2227 if (iFd
== -1 || OpenInternDescriptor(OpenMode
, compressor
) == false)
2234 return FileFdErrno("open",_("Could not open file %s"), FileName
.c_str());
2237 SetCloseExec(iFd
,true);
2241 // FileFd::OpenDescriptor - Open a filedescriptor /*{{{*/
2242 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, CompressMode Compress
, bool AutoClose
)
2244 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
2245 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
2248 // compat with the old API
2249 if (Mode
== ReadOnlyGzip
&& Compress
== None
)
2254 case None
: name
= "."; break;
2255 case Gzip
: name
= "gzip"; break;
2256 case Bzip2
: name
= "bzip2"; break;
2257 case Lzma
: name
= "lzma"; break;
2258 case Xz
: name
= "xz"; break;
2259 case Lz4
: name
= "lz4"; break;
2262 if (AutoClose
== true && Fd
!= -1)
2264 return FileFdError("Opening Fd %d in Auto or Extension compression mode is not supported", Fd
);
2266 for (; compressor
!= compressors
.end(); ++compressor
)
2267 if (compressor
->Name
== name
)
2269 if (compressor
== compressors
.end())
2271 if (AutoClose
== true && Fd
!= -1)
2273 return FileFdError("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
2275 return OpenDescriptor(Fd
, Mode
, *compressor
, AutoClose
);
2277 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
, bool AutoClose
)
2280 Flags
= (AutoClose
) ? FileFd::AutoClose
: 0;
2282 this->FileName
= "";
2283 if (OpenInternDescriptor(Mode
, compressor
) == false)
2286 (Flags
& Compressed
) == Compressed
||
2292 return FileFdError(_("Could not open file descriptor %d"), Fd
);
2296 bool FileFd::OpenInternDescriptor(unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
)
2302 d
->InternalClose(FileName
);
2307 /* dummy so that the rest can be 'else if's */;
2308 #define APT_COMPRESS_INIT(NAME, CONSTRUCTOR) \
2309 else if (compressor.Name == NAME) \
2310 d = new CONSTRUCTOR(this)
2312 APT_COMPRESS_INIT("gzip", GzipFileFdPrivate
);
2315 APT_COMPRESS_INIT("bzip2", Bz2FileFdPrivate
);
2318 APT_COMPRESS_INIT("xz", LzmaFileFdPrivate
);
2319 APT_COMPRESS_INIT("lzma", LzmaFileFdPrivate
);
2322 APT_COMPRESS_INIT("lz4", Lz4FileFdPrivate
);
2324 #undef APT_COMPRESS_INIT
2325 else if (compressor
.Name
== "." || compressor
.Binary
.empty() == true)
2326 d
= new DirectFileFdPrivate(this);
2328 d
= new PipedFileFdPrivate(this);
2330 if (Mode
& BufferedWrite
)
2331 d
= new BufferedWriteFileFdPrivate(d
);
2333 d
->set_openmode(Mode
);
2334 d
->set_compressor(compressor
);
2335 if ((Flags
& AutoClose
) != AutoClose
&& d
->InternalAlwaysAutoClose())
2337 // Need to duplicate fd here or gz/bz2 close for cleanup will close the fd as well
2338 int const internFd
= dup(iFd
);
2340 return FileFdErrno("OpenInternDescriptor", _("Could not open file descriptor %d"), iFd
);
2344 return d
->InternalOpen(iFd
, Mode
);
2347 // FileFd::~File - Closes the file /*{{{*/
2348 // ---------------------------------------------------------------------
2349 /* If the proper modes are selected then we close the Fd and possibly
2350 unlink the file on error. */
2355 d
->InternalClose(FileName
);
2360 // FileFd::Read - Read a bit of the file /*{{{*/
2361 // ---------------------------------------------------------------------
2362 /* We are careful to handle interruption by a signal while reading
2364 bool FileFd::Read(void *To
,unsigned long long Size
,unsigned long long *Actual
)
2372 *((char *)To
) = '\0';
2373 while (Res
> 0 && Size
> 0)
2375 Res
= d
->InternalRead(To
, Size
);
2381 // trick the while-loop into running again
2386 return d
->InternalReadError();
2389 To
= (char *)To
+ Res
;
2392 d
->set_seekpos(d
->get_seekpos() + Res
);
2407 return FileFdError(_("read, still have %llu to read but none left"), Size
);
2410 // FileFd::ReadLine - Read a complete line from the file /*{{{*/
2411 // ---------------------------------------------------------------------
2412 /* Beware: This method can be quite slow for big buffers on UNcompressed
2413 files because of the naive implementation! */
2414 char* FileFd::ReadLine(char *To
, unsigned long long const Size
)
2419 return d
->InternalReadLine(To
, Size
);
2422 // FileFd::Flush - Flush the file /*{{{*/
2423 bool FileFd::Flush()
2428 return d
->InternalFlush();
2431 // FileFd::Write - Write to the file /*{{{*/
2432 bool FileFd::Write(const void *From
,unsigned long long Size
)
2438 while (Res
> 0 && Size
> 0)
2440 Res
= d
->InternalWrite(From
, Size
);
2446 // trick the while-loop into running again
2451 return d
->InternalWriteError();
2454 From
= (char const *)From
+ Res
;
2457 d
->set_seekpos(d
->get_seekpos() + Res
);
2463 return FileFdError(_("write, still have %llu to write but couldn't"), Size
);
2465 bool FileFd::Write(int Fd
, const void *From
, unsigned long long Size
)
2469 while (Res
> 0 && Size
> 0)
2471 Res
= write(Fd
,From
,Size
);
2472 if (Res
< 0 && errno
== EINTR
)
2475 return _error
->Errno("write",_("Write error"));
2477 From
= (char const *)From
+ Res
;
2484 return _error
->Error(_("write, still have %llu to write but couldn't"), Size
);
2487 // FileFd::Seek - Seek in the file /*{{{*/
2488 bool FileFd::Seek(unsigned long long To
)
2493 return d
->InternalSeek(To
);
2496 // FileFd::Skip - Skip over data in the file /*{{{*/
2497 bool FileFd::Skip(unsigned long long Over
)
2501 return d
->InternalSkip(Over
);
2504 // FileFd::Truncate - Truncate the file /*{{{*/
2505 bool FileFd::Truncate(unsigned long long To
)
2509 // truncating /dev/null is always successful - as we get an error otherwise
2510 if (To
== 0 && FileName
== "/dev/null")
2512 return d
->InternalTruncate(To
);
2515 // FileFd::Tell - Current seek position /*{{{*/
2516 // ---------------------------------------------------------------------
2518 unsigned long long FileFd::Tell()
2522 off_t
const Res
= d
->InternalTell();
2523 if (Res
== (off_t
)-1)
2524 FileFdErrno("lseek","Failed to determine the current file position");
2525 d
->set_seekpos(Res
);
2529 static bool StatFileFd(char const * const msg
, int const iFd
, std::string
const &FileName
, struct stat
&Buf
, FileFdPrivate
* const d
) /*{{{*/
2531 bool ispipe
= (d
!= NULL
&& d
->get_is_pipe() == true);
2532 if (ispipe
== false)
2534 if (fstat(iFd
,&Buf
) != 0)
2535 // higher-level code will generate more meaningful messages,
2536 // even translated this would be meaningless for users
2537 return _error
->Errno("fstat", "Unable to determine %s for fd %i", msg
, iFd
);
2538 if (FileName
.empty() == false)
2539 ispipe
= S_ISFIFO(Buf
.st_mode
);
2542 // for compressor pipes st_size is undefined and at 'best' zero
2545 // we set it here, too, as we get the info here for free
2546 // in theory the Open-methods should take care of it already
2548 d
->set_is_pipe(true);
2549 if (stat(FileName
.c_str(), &Buf
) != 0)
2550 return _error
->Errno("fstat", "Unable to determine %s for file %s", msg
, FileName
.c_str());
2555 // FileFd::FileSize - Return the size of the file /*{{{*/
2556 unsigned long long FileFd::FileSize()
2559 if (StatFileFd("file size", iFd
, FileName
, Buf
, d
) == false)
2567 // FileFd::ModificationTime - Return the time of last touch /*{{{*/
2568 time_t FileFd::ModificationTime()
2571 if (StatFileFd("modification time", iFd
, FileName
, Buf
, d
) == false)
2576 return Buf
.st_mtime
;
2579 // FileFd::Size - Return the size of the content in the file /*{{{*/
2580 unsigned long long FileFd::Size()
2584 return d
->InternalSize();
2587 // FileFd::Close - Close the file if the close flag is set /*{{{*/
2588 // ---------------------------------------------------------------------
2590 bool FileFd::Close()
2592 if (Flush() == false)
2598 if ((Flags
& AutoClose
) == AutoClose
)
2600 if ((Flags
& Compressed
) != Compressed
&& iFd
> 0 && close(iFd
) != 0)
2601 Res
&= _error
->Errno("close",_("Problem closing the file %s"), FileName
.c_str());
2606 Res
&= d
->InternalClose(FileName
);
2611 if ((Flags
& Replace
) == Replace
) {
2612 if (rename(TemporaryFileName
.c_str(), FileName
.c_str()) != 0)
2613 Res
&= _error
->Errno("rename",_("Problem renaming the file %s to %s"), TemporaryFileName
.c_str(), FileName
.c_str());
2615 FileName
= TemporaryFileName
; // for the unlink() below.
2616 TemporaryFileName
.clear();
2621 if ((Flags
& Fail
) == Fail
&& (Flags
& DelOnFail
) == DelOnFail
&&
2622 FileName
.empty() == false)
2623 Res
&= RemoveFile("FileFd::Close", FileName
);
2630 // FileFd::Sync - Sync the file /*{{{*/
2631 // ---------------------------------------------------------------------
2635 if (fsync(iFd
) != 0)
2636 return FileFdErrno("sync",_("Problem syncing the file"));
2640 // FileFd::FileFdErrno - set Fail and call _error->Errno *{{{*/
2641 bool FileFd::FileFdErrno(const char *Function
, const char *Description
,...)
2645 size_t msgSize
= 400;
2646 int const errsv
= errno
;
2649 va_start(args
,Description
);
2650 if (_error
->InsertErrno(GlobalError::ERROR
, Function
, Description
, args
, errsv
, msgSize
) == false)
2657 // FileFd::FileFdError - set Fail and call _error->Error *{{{*/
2658 bool FileFd::FileFdError(const char *Description
,...) {
2661 size_t msgSize
= 400;
2664 va_start(args
,Description
);
2665 if (_error
->Insert(GlobalError::ERROR
, Description
, args
, msgSize
) == false)
2672 gzFile
FileFd::gzFd() { /*{{{*/
2674 GzipFileFdPrivate
* const gzipd
= dynamic_cast<GzipFileFdPrivate
*>(d
);
2675 if (gzipd
== nullptr)
2685 // Glob - wrapper around "glob()" /*{{{*/
2686 std::vector
<std::string
> Glob(std::string
const &pattern
, int flags
)
2688 std::vector
<std::string
> result
;
2693 glob_res
= glob(pattern
.c_str(), flags
, NULL
, &globbuf
);
2697 if(glob_res
!= GLOB_NOMATCH
) {
2698 _error
->Errno("glob", "Problem with glob");
2704 for(i
=0;i
<globbuf
.gl_pathc
;i
++)
2705 result
.push_back(string(globbuf
.gl_pathv
[i
]));
2711 std::string
GetTempDir() /*{{{*/
2713 const char *tmpdir
= getenv("TMPDIR");
2721 if (!tmpdir
|| strlen(tmpdir
) == 0 || // tmpdir is set
2722 stat(tmpdir
, &st
) != 0 || (st
.st_mode
& S_IFDIR
) == 0) // exists and is directory
2724 else if (geteuid() != 0 && // root can do everything anyway
2725 faccessat(-1, tmpdir
, R_OK
| W_OK
| X_OK
, AT_EACCESS
| AT_SYMLINK_NOFOLLOW
) != 0) // current user has rwx access to directory
2728 return string(tmpdir
);
2730 std::string
GetTempDir(std::string
const &User
)
2732 // no need/possibility to drop privs
2733 if(getuid() != 0 || User
.empty() || User
== "root")
2734 return GetTempDir();
2736 struct passwd
const * const pw
= getpwnam(User
.c_str());
2738 return GetTempDir();
2740 gid_t
const old_euid
= geteuid();
2741 gid_t
const old_egid
= getegid();
2742 if (setegid(pw
->pw_gid
) != 0)
2743 _error
->Errno("setegid", "setegid %u failed", pw
->pw_gid
);
2744 if (seteuid(pw
->pw_uid
) != 0)
2745 _error
->Errno("seteuid", "seteuid %u failed", pw
->pw_uid
);
2747 std::string
const tmp
= GetTempDir();
2749 if (seteuid(old_euid
) != 0)
2750 _error
->Errno("seteuid", "seteuid %u failed", old_euid
);
2751 if (setegid(old_egid
) != 0)
2752 _error
->Errno("setegid", "setegid %u failed", old_egid
);
2757 FileFd
* GetTempFile(std::string
const &Prefix
, bool ImmediateUnlink
, FileFd
* const TmpFd
) /*{{{*/
2760 FileFd
* const Fd
= TmpFd
== NULL
? new FileFd() : TmpFd
;
2762 std::string
const tempdir
= GetTempDir();
2763 snprintf(fn
, sizeof(fn
), "%s/%s.XXXXXX",
2764 tempdir
.c_str(), Prefix
.c_str());
2765 int const fd
= mkstemp(fn
);
2770 _error
->Errno("GetTempFile",_("Unable to mkstemp %s"), fn
);
2773 if (!Fd
->OpenDescriptor(fd
, FileFd::ReadWrite
, FileFd::None
, true))
2775 _error
->Errno("GetTempFile",_("Unable to write to %s"),fn
);
2781 bool Rename(std::string From
, std::string To
) /*{{{*/
2783 if (rename(From
.c_str(),To
.c_str()) != 0)
2785 _error
->Error(_("rename failed, %s (%s -> %s)."),strerror(errno
),
2786 From
.c_str(),To
.c_str());
2792 bool Popen(const char* Args
[], FileFd
&Fd
, pid_t
&Child
, FileFd::OpenMode Mode
)/*{{{*/
2795 if (Mode
!= FileFd::ReadOnly
&& Mode
!= FileFd::WriteOnly
)
2796 return _error
->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2798 int Pipe
[2] = {-1, -1};
2800 return _error
->Errno("pipe", _("Failed to create subprocess IPC"));
2802 std::set
<int> keep_fds
;
2803 keep_fds
.insert(Pipe
[0]);
2804 keep_fds
.insert(Pipe
[1]);
2805 Child
= ExecFork(keep_fds
);
2807 return _error
->Errno("fork", "Failed to fork");
2810 if(Mode
== FileFd::ReadOnly
)
2815 else if(Mode
== FileFd::WriteOnly
)
2821 if(Mode
== FileFd::ReadOnly
)
2825 } else if(Mode
== FileFd::WriteOnly
)
2828 execv(Args
[0], (char**)Args
);
2831 if(Mode
== FileFd::ReadOnly
)
2836 else if(Mode
== FileFd::WriteOnly
)
2842 return _error
->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2843 Fd
.OpenDescriptor(fd
, Mode
, FileFd::None
, true);
2848 bool DropPrivileges() /*{{{*/
2850 if(_config
->FindB("Debug::NoDropPrivs", false) == true)
2854 #if defined(PR_SET_NO_NEW_PRIVS) && ( PR_SET_NO_NEW_PRIVS != 38 )
2855 #error "PR_SET_NO_NEW_PRIVS is defined, but with a different value than expected!"
2857 // see prctl(2), needs linux3.5 at runtime - magic constant to avoid it at buildtime
2858 int ret
= prctl(38, 1, 0, 0, 0);
2859 // ignore EINVAL - kernel is too old to understand the option
2860 if(ret
< 0 && errno
!= EINVAL
)
2861 _error
->Warning("PR_SET_NO_NEW_PRIVS failed with %i", ret
);
2864 // empty setting disables privilege dropping - this also ensures
2865 // backward compatibility, see bug #764506
2866 const std::string toUser
= _config
->Find("APT::Sandbox::User");
2867 if (toUser
.empty() || toUser
== "root")
2870 // a lot can go wrong trying to drop privileges completely,
2871 // so ideally we would like to verify that we have done it –
2872 // but the verify asks for too much in case of fakeroot (and alike)
2873 // [Specific checks can be overridden with dedicated options]
2874 bool const VerifySandboxing
= _config
->FindB("APT::Sandbox::Verify", false);
2876 // uid will be 0 in the end, but gid might be different anyway
2877 uid_t
const old_uid
= getuid();
2878 gid_t
const old_gid
= getgid();
2883 struct passwd
*pw
= getpwnam(toUser
.c_str());
2885 return _error
->Error("No user %s, can not drop rights", toUser
.c_str());
2887 // Do not change the order here, it might break things
2888 // Get rid of all our supplementary groups first
2889 if (setgroups(1, &pw
->pw_gid
))
2890 return _error
->Errno("setgroups", "Failed to setgroups");
2892 // Now change the group ids to the new user
2893 #ifdef HAVE_SETRESGID
2894 if (setresgid(pw
->pw_gid
, pw
->pw_gid
, pw
->pw_gid
) != 0)
2895 return _error
->Errno("setresgid", "Failed to set new group ids");
2897 if (setegid(pw
->pw_gid
) != 0)
2898 return _error
->Errno("setegid", "Failed to setegid");
2900 if (setgid(pw
->pw_gid
) != 0)
2901 return _error
->Errno("setgid", "Failed to setgid");
2904 // Change the user ids to the new user
2905 #ifdef HAVE_SETRESUID
2906 if (setresuid(pw
->pw_uid
, pw
->pw_uid
, pw
->pw_uid
) != 0)
2907 return _error
->Errno("setresuid", "Failed to set new user ids");
2909 if (setuid(pw
->pw_uid
) != 0)
2910 return _error
->Errno("setuid", "Failed to setuid");
2911 if (seteuid(pw
->pw_uid
) != 0)
2912 return _error
->Errno("seteuid", "Failed to seteuid");
2915 // disabled by default as fakeroot doesn't implement getgroups currently (#806521)
2916 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::Groups", false) == true)
2918 // Verify that the user isn't still in any supplementary groups
2919 long const ngroups_max
= sysconf(_SC_NGROUPS_MAX
);
2920 std::unique_ptr
<gid_t
[]> gidlist(new gid_t
[ngroups_max
]);
2921 if (unlikely(gidlist
== NULL
))
2922 return _error
->Error("Allocation of a list of size %lu for getgroups failed", ngroups_max
);
2924 if ((gidlist_nr
= getgroups(ngroups_max
, gidlist
.get())) < 0)
2925 return _error
->Errno("getgroups", "Could not get new groups (%lu)", ngroups_max
);
2926 for (ssize_t i
= 0; i
< gidlist_nr
; ++i
)
2927 if (gidlist
[i
] != pw
->pw_gid
)
2928 return _error
->Error("Could not switch group, user %s is still in group %d", toUser
.c_str(), gidlist
[i
]);
2931 // enabled by default as all fakeroot-lookalikes should fake that accordingly
2932 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::IDs", true) == true)
2934 // Verify that gid, egid, uid, and euid changed
2935 if (getgid() != pw
->pw_gid
)
2936 return _error
->Error("Could not switch group");
2937 if (getegid() != pw
->pw_gid
)
2938 return _error
->Error("Could not switch effective group");
2939 if (getuid() != pw
->pw_uid
)
2940 return _error
->Error("Could not switch user");
2941 if (geteuid() != pw
->pw_uid
)
2942 return _error
->Error("Could not switch effective user");
2944 #ifdef HAVE_GETRESUID
2945 // verify that the saved set-user-id was changed as well
2949 if (getresuid(&ruid
, &euid
, &suid
))
2950 return _error
->Errno("getresuid", "Could not get saved set-user-ID");
2951 if (suid
!= pw
->pw_uid
)
2952 return _error
->Error("Could not switch saved set-user-ID");
2955 #ifdef HAVE_GETRESGID
2956 // verify that the saved set-group-id was changed as well
2960 if (getresgid(&rgid
, &egid
, &sgid
))
2961 return _error
->Errno("getresuid", "Could not get saved set-group-ID");
2962 if (sgid
!= pw
->pw_gid
)
2963 return _error
->Error("Could not switch saved set-group-ID");
2967 // disabled as fakeroot doesn't forbid (by design) (re)gaining root from unprivileged
2968 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::Regain", false) == true)
2970 // Check that uid and gid changes do not work anymore
2971 if (pw
->pw_gid
!= old_gid
&& (setgid(old_gid
) != -1 || setegid(old_gid
) != -1))
2972 return _error
->Error("Could restore a gid to root, privilege dropping did not work");
2974 if (pw
->pw_uid
!= old_uid
&& (setuid(old_uid
) != -1 || seteuid(old_uid
) != -1))
2975 return _error
->Error("Could restore a uid to root, privilege dropping did not work");