]> git.saurik.com Git - apt.git/blame - apt-pkg/contrib/fileutl.cc
give a descriptive error for pipe tries with 'false'
[apt.git] / apt-pkg / contrib / fileutl.cc
CommitLineData
578bfd0a
AL
1// -*- mode: cpp; mode: fold -*-
2// Description /*{{{*/
578bfd0a
AL
3/* ######################################################################
4
5 File Utilities
6
7 CopyFile - Buffered copy of a single file
8 GetLock - dpkg compatible lock file manipulation (fcntl)
9
614adaa0
MV
10 Most of this source is placed in the Public Domain, do with it what
11 you will
7da2b375 12 It was originally written by Jason Gunthorpe <jgg@debian.org>.
a3a03f5d 13 FileFd gzip support added by Martin Pitt <martin.pitt@canonical.com>
578bfd0a 14
614adaa0
MV
15 The exception is RunScripts() it is under the GPLv2
16
578bfd0a
AL
17 ##################################################################### */
18 /*}}}*/
19// Include Files /*{{{*/
ea542140
DK
20#include <config.h>
21
094a497d 22#include <apt-pkg/fileutl.h>
1cd1c398 23#include <apt-pkg/strutl.h>
094a497d 24#include <apt-pkg/error.h>
b2e465d6 25#include <apt-pkg/sptr.h>
468720c5 26#include <apt-pkg/aptconfiguration.h>
75ef8f14 27#include <apt-pkg/configuration.h>
453b82a3 28#include <apt-pkg/macros.h>
b2e465d6 29
453b82a3
DK
30#include <ctype.h>
31#include <stdarg.h>
32#include <stddef.h>
33#include <sys/select.h>
34#include <time.h>
35#include <string>
36#include <vector>
152ab79e 37#include <cstdlib>
4f333a8b 38#include <cstring>
3010fb0e 39#include <cstdio>
4d055c05 40#include <iostream>
578bfd0a 41#include <unistd.h>
2c206aa4 42#include <fcntl.h>
578bfd0a 43#include <sys/stat.h>
cc2313b7 44#include <sys/time.h>
1ae93c94 45#include <sys/wait.h>
46e39c8e 46#include <dirent.h>
54676e1a 47#include <signal.h>
65a1e968 48#include <errno.h>
8d01b9d6 49#include <glob.h>
fc1a78d8 50#include <pwd.h>
3927c6da 51#include <grp.h>
8d01b9d6 52
75ef8f14 53#include <set>
46e39c8e 54#include <algorithm>
98cc7fd2 55#include <memory>
2cae0ccb 56
7efb8c8e
DK
57#ifdef HAVE_ZLIB
58 #include <zlib.h>
699b209e 59#endif
c4997486
DK
60#ifdef HAVE_BZ2
61 #include <bzlib.h>
62#endif
7f350a37
DK
63#ifdef HAVE_LZMA
64 #include <lzma.h>
2cae0ccb 65#endif
e3fbd54c
JAK
66#ifdef HAVE_LZ4
67 #include <lz4frame.h>
68#endif
05eab8af
AC
69#include <endian.h>
70#include <stdint.h>
ea542140 71
3927c6da
MV
72#if __gnu_linux__
73#include <sys/prctl.h>
74#endif
75
ea542140 76#include <apti18n.h>
578bfd0a
AL
77 /*}}}*/
78
4d055c05
AL
79using namespace std;
80
40940e63
JAK
81/* Should be a multiple of the common page size (4096) */
82static constexpr unsigned long long APT_BUFFER_SIZE = 64 * 1024;
83
614adaa0
MV
84// RunScripts - Run a set of scripts from a configuration subtree /*{{{*/
85// ---------------------------------------------------------------------
86/* */
87bool RunScripts(const char *Cnf)
88{
89 Configuration::Item const *Opts = _config->Tree(Cnf);
90 if (Opts == 0 || Opts->Child == 0)
91 return true;
92 Opts = Opts->Child;
93
94 // Fork for running the system calls
95 pid_t Child = ExecFork();
96
97 // This is the child
98 if (Child == 0)
99 {
cfba4f69
MV
100 if (_config->FindDir("DPkg::Chroot-Directory","/") != "/")
101 {
102 std::cerr << "Chrooting into "
103 << _config->FindDir("DPkg::Chroot-Directory")
104 << std::endl;
105 if (chroot(_config->FindDir("DPkg::Chroot-Directory","/").c_str()) != 0)
106 _exit(100);
107 }
108
614adaa0
MV
109 if (chdir("/tmp/") != 0)
110 _exit(100);
111
112 unsigned int Count = 1;
113 for (; Opts != 0; Opts = Opts->Next, Count++)
114 {
115 if (Opts->Value.empty() == true)
116 continue;
e5b7e019
MV
117
118 if(_config->FindB("Debug::RunScripts", false) == true)
119 std::clog << "Running external script: '"
120 << Opts->Value << "'" << std::endl;
121
614adaa0
MV
122 if (system(Opts->Value.c_str()) != 0)
123 _exit(100+Count);
124 }
125 _exit(0);
126 }
127
128 // Wait for the child
129 int Status = 0;
130 while (waitpid(Child,&Status,0) != Child)
131 {
132 if (errno == EINTR)
133 continue;
134 return _error->Errno("waitpid","Couldn't wait for subprocess");
135 }
136
137 // Restore sig int/quit
138 signal(SIGQUIT,SIG_DFL);
139 signal(SIGINT,SIG_DFL);
140
141 // Check for an error code.
142 if (WIFEXITED(Status) == 0 || WEXITSTATUS(Status) != 0)
143 {
144 unsigned int Count = WEXITSTATUS(Status);
145 if (Count > 100)
146 {
147 Count -= 100;
148 for (; Opts != 0 && Count != 1; Opts = Opts->Next, Count--);
149 _error->Error("Problem executing scripts %s '%s'",Cnf,Opts->Value.c_str());
150 }
151
152 return _error->Error("Sub-process returned an error code");
153 }
154
155 return true;
156}
157 /*}}}*/
158
578bfd0a
AL
159// CopyFile - Buffered copy of a file /*{{{*/
160// ---------------------------------------------------------------------
161/* The caller is expected to set things so that failure causes erasure */
8b89e57f 162bool CopyFile(FileFd &From,FileFd &To)
578bfd0a 163{
2128d3fc
DK
164 if (From.IsOpen() == false || To.IsOpen() == false ||
165 From.Failed() == true || To.Failed() == true)
578bfd0a 166 return false;
e977b8b9 167
578bfd0a 168 // Buffered copy between fds
40940e63 169 constexpr size_t BufSize = APT_BUFFER_SIZE;
0c93e388 170 std::unique_ptr<unsigned char[]> Buf(new unsigned char[BufSize]);
e977b8b9
DK
171 unsigned long long ToRead = 0;
172 do {
173 if (From.Read(Buf.get(),BufSize, &ToRead) == false ||
5df91bc7 174 To.Write(Buf.get(),ToRead) == false)
578bfd0a 175 return false;
e977b8b9 176 } while (ToRead != 0);
578bfd0a 177
ce1f3a2c
DK
178 return true;
179}
180 /*}}}*/
181bool RemoveFile(char const * const Function, std::string const &FileName)/*{{{*/
182{
183 if (FileName == "/dev/null")
184 return true;
185 errno = 0;
186 if (unlink(FileName.c_str()) != 0)
187 {
188 if (errno == ENOENT)
189 return true;
190
191 return _error->WarningE(Function,_("Problem unlinking the file %s"), FileName.c_str());
192 }
e977b8b9 193 return true;
578bfd0a
AL
194}
195 /*}}}*/
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. */
202int GetLock(string File,bool Errors)
203{
f659b39a
OS
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);
578bfd0a
AL
207 if (FD < 0)
208 {
1e3f4083 209 // Read only .. can't have locking problems there.
b2e465d6
AL
210 if (errno == EROFS)
211 {
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
214 }
215
578bfd0a 216 if (Errors == true)
b2e465d6
AL
217 _error->Errno("open",_("Could not open lock file %s"),File.c_str());
218
219 // Feh.. We do this to distinguish the lock vs open case..
220 errno = EPERM;
578bfd0a
AL
221 return -1;
222 }
b2e465d6
AL
223 SetCloseExec(FD,true);
224
1e3f4083 225 // Acquire a write lock
578bfd0a 226 struct flock fl;
c71bc556
AL
227 fl.l_type = F_WRLCK;
228 fl.l_whence = SEEK_SET;
229 fl.l_start = 0;
230 fl.l_len = 0;
578bfd0a
AL
231 if (fcntl(FD,F_SETLK,&fl) == -1)
232 {
3d165906
MV
233 // always close to not leak resources
234 int Tmp = errno;
235 close(FD);
236 errno = Tmp;
237
d89df07a
AL
238 if (errno == ENOLCK)
239 {
b2e465d6
AL
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
3d165906
MV
242 }
243
578bfd0a 244 if (Errors == true)
b2e465d6
AL
245 _error->Errno("open",_("Could not get lock %s"),File.c_str());
246
578bfd0a
AL
247 return -1;
248 }
249
250 return FD;
251}
252 /*}}}*/
253// FileExists - Check if a file exists /*{{{*/
254// ---------------------------------------------------------------------
36f1098a 255/* Beware: Directories are also files! */
578bfd0a
AL
256bool FileExists(string File)
257{
258 struct stat Buf;
259 if (stat(File.c_str(),&Buf) != 0)
260 return false;
261 return true;
262}
263 /*}}}*/
36f1098a
DK
264// RealFileExists - Check if a file exists and if it is really a file /*{{{*/
265// ---------------------------------------------------------------------
266/* */
267bool RealFileExists(string File)
268{
269 struct stat Buf;
270 if (stat(File.c_str(),&Buf) != 0)
271 return false;
272 return ((Buf.st_mode & S_IFREG) != 0);
273}
274 /*}}}*/
1cd1c398
DK
275// DirectoryExists - Check if a directory exists and is really one /*{{{*/
276// ---------------------------------------------------------------------
277/* */
278bool DirectoryExists(string const &Path)
279{
280 struct stat Buf;
281 if (stat(Path.c_str(),&Buf) != 0)
282 return false;
283 return ((Buf.st_mode & S_IFDIR) != 0);
284}
285 /*}}}*/
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. */
294bool CreateDirectory(string const &Parent, string const &Path)
295{
296 if (Parent.empty() == true || Path.empty() == true)
297 return false;
298
299 if (DirectoryExists(Path) == true)
300 return true;
301
302 if (DirectoryExists(Parent) == false)
303 return false;
304
305 // we are not going to create directories "into the blue"
9ce3cfc9 306 if (Path.compare(0, Parent.length(), Parent) != 0)
1cd1c398
DK
307 return false;
308
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)
312 {
313 if (d->empty() == true)
314 continue;
315
316 progress.append("/").append(*d);
317 if (DirectoryExists(progress) == true)
318 continue;
319
320 if (mkdir(progress.c_str(), 0755) != 0)
321 return false;
322 }
323 return true;
324}
325 /*}}}*/
7753e468 326// CreateAPTDirectoryIfNeeded - ensure that the given directory exists /*{{{*/
b29c3712
DK
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 */
7753e468 330bool CreateAPTDirectoryIfNeeded(string const &Parent, string const &Path)
b29c3712
DK
331{
332 if (DirectoryExists(Path) == true)
333 return true;
334
335 size_t const len = Parent.size();
336 if (len > 5 && Parent.find("/apt/", len - 6, 5) == len - 5)
337 {
338 if (CreateDirectory(Parent.substr(0,len-5), Path) == true)
339 return true;
340 }
341 else if (CreateDirectory(Parent, Path) == true)
342 return true;
343
344 return false;
345}
346 /*}}}*/
46e39c8e
MV
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. */
b39c1859
MV
351std::vector<string> GetListOfFilesInDir(string const &Dir, string const &Ext,
352 bool const &SortList, bool const &AllowNoExt)
353{
354 std::vector<string> ext;
355 ext.reserve(2);
356 if (Ext.empty() == false)
357 ext.push_back(Ext);
358 if (AllowNoExt == true && ext.empty() == false)
359 ext.push_back("");
360 return GetListOfFilesInDir(Dir, ext, SortList);
361}
362std::vector<string> GetListOfFilesInDir(string const &Dir, std::vector<string> const &Ext,
363 bool const &SortList)
364{
365 // Attention debuggers: need to be set with the environment config file!
366 bool const Debug = _config->FindB("Debug::GetListOfFilesInDir", false);
367 if (Debug == true)
368 {
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;
372 else
373 for (std::vector<string>::const_iterator e = Ext.begin();
374 e != Ext.end(); ++e)
375 std::clog << '\t' << (e->empty() == true ? "NO" : *e) << " extension" << std::endl;
376 }
377
46e39c8e 378 std::vector<string> List;
36f1098a 379
69c2ecbd 380 if (DirectoryExists(Dir) == false)
36f1098a
DK
381 {
382 _error->Error(_("List of files can't be created as '%s' is not a directory"), Dir.c_str());
383 return List;
384 }
385
1408e219 386 Configuration::MatchAgainstConfig SilentIgnore("Dir::Ignore-Files-Silently");
46e39c8e
MV
387 DIR *D = opendir(Dir.c_str());
388 if (D == 0)
389 {
390 _error->Errno("opendir",_("Unable to read %s"),Dir.c_str());
391 return List;
392 }
393
394 for (struct dirent *Ent = readdir(D); Ent != 0; Ent = readdir(D))
395 {
b39c1859 396 // skip "hidden" files
46e39c8e
MV
397 if (Ent->d_name[0] == '.')
398 continue;
399
491058e3
DK
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)
404#endif
405 {
69c2ecbd 406 if (RealFileExists(File) == false)
491058e3 407 {
84e254d6
DK
408 // do not show ignoration warnings for directories
409 if (
410#ifdef _DIRENT_HAVE_D_TYPE
411 Ent->d_type == DT_DIR ||
412#endif
69c2ecbd 413 DirectoryExists(File) == true)
84e254d6 414 continue;
491058e3
DK
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());
417 continue;
418 }
419 }
420
b39c1859
MV
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)
425 {
426 string d_ext = flExtension(Ent->d_name);
427 if (d_ext == Ent->d_name) // no extension
428 {
429 if (std::find(Ext.begin(), Ext.end(), "") == Ext.end())
430 {
431 if (Debug == true)
432 std::clog << "Bad file: " << Ent->d_name << " → no extension" << std::endl;
5edc3966 433 if (SilentIgnore.Match(Ent->d_name) == false)
491058e3 434 _error->Notice(_("Ignoring file '%s' in directory '%s' as it has no filename extension"), Ent->d_name, Dir.c_str());
b39c1859
MV
435 continue;
436 }
437 }
438 else if (std::find(Ext.begin(), Ext.end(), d_ext) == Ext.end())
439 {
440 if (Debug == true)
441 std::clog << "Bad file: " << Ent->d_name << " → bad extension »" << flExtension(Ent->d_name) << "«" << std::endl;
1408e219 442 if (SilentIgnore.Match(Ent->d_name) == false)
491058e3 443 _error->Notice(_("Ignoring file '%s' in directory '%s' as it has an invalid filename extension"), Ent->d_name, Dir.c_str());
b39c1859
MV
444 continue;
445 }
446 }
46e39c8e 447
b39c1859 448 // Skip bad filenames ala run-parts
46e39c8e
MV
449 const char *C = Ent->d_name;
450 for (; *C != 0; ++C)
451 if (isalpha(*C) == 0 && isdigit(*C) == 0
9d39208a 452 && *C != '_' && *C != '-' && *C != ':') {
b39c1859
MV
453 // no required extension -> dot is a bad character
454 if (*C == '.' && Ext.empty() == false)
455 continue;
46e39c8e 456 break;
b39c1859 457 }
46e39c8e 458
b39c1859 459 // we don't reach the end of the name -> bad character included
46e39c8e 460 if (*C != 0)
b39c1859
MV
461 {
462 if (Debug == true)
463 std::clog << "Bad file: " << Ent->d_name << " → bad character »"
464 << *C << "« in filename (period allowed: " << (Ext.empty() ? "no" : "yes") << ")" << std::endl;
465 continue;
466 }
467
fbb2c7e0
DK
468 // skip filenames which end with a period. These are never valid
469 if (*(C - 1) == '.')
470 {
471 if (Debug == true)
472 std::clog << "Bad file: " << Ent->d_name << " → Period as last character" << std::endl;
473 continue;
474 }
475
476 if (Debug == true)
477 std::clog << "Accept file: " << Ent->d_name << " in " << Dir << std::endl;
478 List.push_back(File);
479 }
480 closedir(D);
481
482 if (SortList == true)
483 std::sort(List.begin(),List.end());
484 return List;
485}
486std::vector<string> GetListOfFilesInDir(string const &Dir, bool SortList)
487{
488 bool const Debug = _config->FindB("Debug::GetListOfFilesInDir", false);
489 if (Debug == true)
490 std::clog << "Accept in " << Dir << " all regular files" << std::endl;
491
492 std::vector<string> List;
493
69c2ecbd 494 if (DirectoryExists(Dir) == false)
fbb2c7e0
DK
495 {
496 _error->Error(_("List of files can't be created as '%s' is not a directory"), Dir.c_str());
497 return List;
498 }
499
500 DIR *D = opendir(Dir.c_str());
501 if (D == 0)
502 {
503 _error->Errno("opendir",_("Unable to read %s"),Dir.c_str());
504 return List;
505 }
506
507 for (struct dirent *Ent = readdir(D); Ent != 0; Ent = readdir(D))
508 {
509 // skip "hidden" files
510 if (Ent->d_name[0] == '.')
511 continue;
512
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)
517#endif
518 {
69c2ecbd 519 if (RealFileExists(File) == false)
fbb2c7e0
DK
520 {
521 if (Debug == true)
522 std::clog << "Bad file: " << Ent->d_name << " → it is not a real file" << std::endl;
523 continue;
524 }
525 }
526
527 // Skip bad filenames ala run-parts
528 const char *C = Ent->d_name;
529 for (; *C != 0; ++C)
530 if (isalpha(*C) == 0 && isdigit(*C) == 0
531 && *C != '_' && *C != '-' && *C != '.')
532 break;
533
534 // we don't reach the end of the name -> bad character included
535 if (*C != 0)
536 {
537 if (Debug == true)
538 std::clog << "Bad file: " << Ent->d_name << " → bad character »" << *C << "« in filename" << std::endl;
539 continue;
540 }
541
b39c1859
MV
542 // skip filenames which end with a period. These are never valid
543 if (*(C - 1) == '.')
544 {
545 if (Debug == true)
546 std::clog << "Bad file: " << Ent->d_name << " → Period as last character" << std::endl;
46e39c8e 547 continue;
b39c1859 548 }
46e39c8e 549
b39c1859
MV
550 if (Debug == true)
551 std::clog << "Accept file: " << Ent->d_name << " in " << Dir << std::endl;
46e39c8e
MV
552 List.push_back(File);
553 }
554 closedir(D);
555
556 if (SortList == true)
557 std::sort(List.begin(),List.end());
558 return List;
559}
560 /*}}}*/
578bfd0a
AL
561// SafeGetCWD - This is a safer getcwd that returns a dynamic string /*{{{*/
562// ---------------------------------------------------------------------
563/* We return / on failure. */
564string SafeGetCWD()
565{
566 // Stash the current dir.
567 char S[300];
568 S[0] = 0;
7f25bdff 569 if (getcwd(S,sizeof(S)-2) == 0)
578bfd0a 570 return "/";
7f25bdff
AL
571 unsigned int Len = strlen(S);
572 S[Len] = '/';
573 S[Len+1] = 0;
578bfd0a
AL
574 return S;
575}
576 /*}}}*/
2ec858bc
MV
577// GetModificationTime - Get the mtime of the given file or -1 on error /*{{{*/
578// ---------------------------------------------------------------------
579/* We return / on failure. */
580time_t GetModificationTime(string const &Path)
581{
582 struct stat St;
583 if (stat(Path.c_str(), &St) < 0)
584 return -1;
585 return St.st_mtime;
586}
587 /*}}}*/
8ce4327b
AL
588// flNotDir - Strip the directory from the filename /*{{{*/
589// ---------------------------------------------------------------------
590/* */
591string flNotDir(string File)
592{
593 string::size_type Res = File.rfind('/');
594 if (Res == string::npos)
595 return File;
596 Res++;
597 return string(File,Res,Res - File.length());
598}
599 /*}}}*/
d38b7b3d
AL
600// flNotFile - Strip the file from the directory name /*{{{*/
601// ---------------------------------------------------------------------
171c45bc 602/* Result ends in a / */
d38b7b3d
AL
603string flNotFile(string File)
604{
605 string::size_type Res = File.rfind('/');
606 if (Res == string::npos)
171c45bc 607 return "./";
d38b7b3d
AL
608 Res++;
609 return string(File,0,Res);
610}
611 /*}}}*/
b2e465d6
AL
612// flExtension - Return the extension for the file /*{{{*/
613// ---------------------------------------------------------------------
614/* */
615string flExtension(string File)
616{
617 string::size_type Res = File.rfind('.');
618 if (Res == string::npos)
619 return File;
620 Res++;
621 return string(File,Res,Res - File.length());
622}
623 /*}}}*/
421c8d10
AL
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. */
627string flNoLink(string File)
628{
629 struct stat St;
630 if (lstat(File.c_str(),&St) != 0 || S_ISLNK(St.st_mode) == 0)
631 return File;
632 if (stat(File.c_str(),&St) != 0)
633 return File;
634
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
637 circular */
638 char Buffer[1024];
639 string NFile = File;
640 while (1)
641 {
642 // Read the link
3286ad13 643 ssize_t Res;
421c8d10 644 if ((Res = readlink(NFile.c_str(),Buffer,sizeof(Buffer))) <= 0 ||
3286ad13 645 (size_t)Res >= sizeof(Buffer))
421c8d10
AL
646 return File;
647
648 // Append or replace the previous path
649 Buffer[Res] = 0;
650 if (Buffer[0] == '/')
651 NFile = Buffer;
652 else
653 NFile = flNotFile(NFile) + Buffer;
654
655 // See if we are done
656 if (lstat(NFile.c_str(),&St) != 0)
657 return File;
658 if (S_ISLNK(St.st_mode) == 0)
659 return NFile;
660 }
661}
662 /*}}}*/
b2e465d6
AL
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. */
667string flCombine(string Dir,string File)
668{
669 if (File.empty() == true)
670 return string();
671
672 if (File[0] == '/' || Dir.empty() == true)
673 return File;
674 if (File.length() >= 2 && File[0] == '.' && File[1] == '/')
675 return File;
676 if (Dir[Dir.length()-1] == '/')
677 return Dir + File;
678 return Dir + '/' + File;
679}
680 /*}}}*/
53ac87ac
MV
681// flAbsPath - Return the absolute path of the filename /*{{{*/
682// ---------------------------------------------------------------------
683/* */
684string flAbsPath(string File)
685{
686 char *p = realpath(File.c_str(), NULL);
687 if (p == NULL)
688 {
95278287 689 _error->Errno("realpath", "flAbsPath on %s failed", File.c_str());
53ac87ac
MV
690 return "";
691 }
692 std::string AbsPath(p);
693 free(p);
694 return AbsPath;
695}
696 /*}}}*/
3b5421b4
AL
697// SetCloseExec - Set the close on exec flag /*{{{*/
698// ---------------------------------------------------------------------
699/* */
700void SetCloseExec(int Fd,bool Close)
701{
702 if (fcntl(Fd,F_SETFD,(Close == false)?0:FD_CLOEXEC) != 0)
703 {
704 cerr << "FATAL -> Could not set close on exec " << strerror(errno) << endl;
705 exit(100);
706 }
707}
708 /*}}}*/
709// SetNonBlock - Set the nonblocking flag /*{{{*/
710// ---------------------------------------------------------------------
711/* */
712void SetNonBlock(int Fd,bool Block)
713{
0a8a80e5
AL
714 int Flags = fcntl(Fd,F_GETFL) & (~O_NONBLOCK);
715 if (fcntl(Fd,F_SETFL,Flags | ((Block == false)?0:O_NONBLOCK)) != 0)
3b5421b4
AL
716 {
717 cerr << "FATAL -> Could not set non-blocking flag " << strerror(errno) << endl;
718 exit(100);
719 }
720}
721 /*}}}*/
722// WaitFd - Wait for a FD to become readable /*{{{*/
723// ---------------------------------------------------------------------
b2e465d6 724/* This waits for a FD to become readable using select. It is useful for
6d5dd02a
AL
725 applications making use of non-blocking sockets. The timeout is
726 in seconds. */
1084d58a 727bool WaitFd(int Fd,bool write,unsigned long timeout)
3b5421b4
AL
728{
729 fd_set Set;
cc2313b7 730 struct timeval tv;
3b5421b4
AL
731 FD_ZERO(&Set);
732 FD_SET(Fd,&Set);
6d5dd02a
AL
733 tv.tv_sec = timeout;
734 tv.tv_usec = 0;
1084d58a 735 if (write == true)
b0db36b1
AL
736 {
737 int Res;
738 do
739 {
740 Res = select(Fd+1,0,&Set,0,(timeout != 0?&tv:0));
741 }
742 while (Res < 0 && errno == EINTR);
743
744 if (Res <= 0)
745 return false;
1084d58a
AL
746 }
747 else
748 {
b0db36b1
AL
749 int Res;
750 do
751 {
752 Res = select(Fd+1,&Set,0,0,(timeout != 0?&tv:0));
753 }
754 while (Res < 0 && errno == EINTR);
755
756 if (Res <= 0)
757 return false;
cc2313b7 758 }
1084d58a 759
3b5421b4
AL
760 return true;
761}
762 /*}}}*/
96ae6de5 763// MergeKeepFdsFromConfiguration - Merge APT::Keep-Fds configuration /*{{{*/
54676e1a 764// ---------------------------------------------------------------------
96ae6de5
MV
765/* This is used to merge the APT::Keep-Fds with the provided KeepFDs
766 * set.
767 */
768void MergeKeepFdsFromConfiguration(std::set<int> &KeepFDs)
e45c4617 769{
e45c4617
MV
770 Configuration::Item const *Opts = _config->Tree("APT::Keep-Fds");
771 if (Opts != 0 && Opts->Child != 0)
772 {
773 Opts = Opts->Child;
774 for (; Opts != 0; Opts = Opts->Next)
775 {
776 if (Opts->Value.empty() == true)
777 continue;
778 int fd = atoi(Opts->Value.c_str());
779 KeepFDs.insert(fd);
780 }
781 }
96ae6de5
MV
782}
783 /*}}}*/
54676e1a
AL
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. */
75ef8f14 789pid_t ExecFork()
96ae6de5
MV
790{
791 set<int> KeepFDs;
792 // we need to merge the Keep-Fds as external tools like
793 // debconf-apt-progress use it
794 MergeKeepFdsFromConfiguration(KeepFDs);
e45c4617
MV
795 return ExecFork(KeepFDs);
796}
797
798pid_t ExecFork(std::set<int> KeepFDs)
54676e1a
AL
799{
800 // Fork off the process
801 pid_t Process = fork();
802 if (Process < 0)
803 {
804 cerr << "FATAL -> Failed to fork." << endl;
805 exit(100);
806 }
807
808 // Spawn the subprocess
809 if (Process == 0)
810 {
811 // Setup the signals
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);
75ef8f14 818
be4d908f
JAK
819 DIR *dir = opendir("/proc/self/fd");
820 if (dir != NULL)
75ef8f14 821 {
be4d908f
JAK
822 struct dirent *ent;
823 while ((ent = readdir(dir)))
824 {
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);
829 }
830 closedir(dir);
831 } else {
832 long ScOpenMax = sysconf(_SC_OPEN_MAX);
833 // Close all of our FDs - just in case
834 for (int K = 3; K != ScOpenMax; K++)
835 {
836 if(KeepFDs.find(K) == KeepFDs.end())
837 fcntl(K,F_SETFD,FD_CLOEXEC);
838 }
75ef8f14 839 }
54676e1a
AL
840 }
841
842 return Process;
843}
844 /*}}}*/
ddc1d8d0
AL
845// ExecWait - Fancy waitpid /*{{{*/
846// ---------------------------------------------------------------------
2c9a72d1 847/* Waits for the given sub process. If Reap is set then no errors are
ddc1d8d0
AL
848 generated. Otherwise a failed subprocess will generate a proper descriptive
849 message */
3826564e 850bool ExecWait(pid_t Pid,const char *Name,bool Reap)
ddc1d8d0
AL
851{
852 if (Pid <= 1)
853 return true;
854
855 // Wait and collect the error code
856 int Status;
857 while (waitpid(Pid,&Status,0) != Pid)
858 {
859 if (errno == EINTR)
860 continue;
861
862 if (Reap == true)
863 return false;
864
db0db9fe 865 return _error->Error(_("Waited for %s but it wasn't there"),Name);
ddc1d8d0
AL
866 }
867
868
869 // Check for an error code.
870 if (WIFEXITED(Status) == 0 || WEXITSTATUS(Status) != 0)
871 {
872 if (Reap == true)
873 return false;
ab7f4d7c 874 if (WIFSIGNALED(Status) != 0)
40e7fe0e 875 {
ab7f4d7c
MV
876 if( WTERMSIG(Status) == SIGSEGV)
877 return _error->Error(_("Sub-process %s received a segmentation fault."),Name);
878 else
879 return _error->Error(_("Sub-process %s received signal %u."),Name, WTERMSIG(Status));
40e7fe0e 880 }
ddc1d8d0
AL
881
882 if (WIFEXITED(Status) != 0)
b2e465d6 883 return _error->Error(_("Sub-process %s returned an error code (%u)"),Name,WEXITSTATUS(Status));
ddc1d8d0 884
b2e465d6 885 return _error->Error(_("Sub-process %s exited unexpectedly"),Name);
ddc1d8d0
AL
886 }
887
888 return true;
889}
890 /*}}}*/
f8aba23f 891// StartsWithGPGClearTextSignature - Check if a file is Pgp/GPG clearsigned /*{{{*/
fe5804fc 892bool StartsWithGPGClearTextSignature(string const &FileName)
0854ad8b
MV
893{
894 static const char* SIGMSG = "-----BEGIN PGP SIGNED MESSAGE-----\n";
1c89c98a 895 char buffer[strlen(SIGMSG)+1];
0854ad8b
MV
896 FILE* gpg = fopen(FileName.c_str(), "r");
897 if (gpg == NULL)
898 return false;
899
900 char const * const test = fgets(buffer, sizeof(buffer), gpg);
901 fclose(gpg);
902 if (test == NULL || strcmp(buffer, SIGMSG) != 0)
903 return false;
904
905 return true;
906}
f8aba23f 907 /*}}}*/
d84da499
DK
908// ChangeOwnerAndPermissionOfFile - set file attributes to requested values /*{{{*/
909bool ChangeOwnerAndPermissionOfFile(char const * const requester, char const * const file, char const * const user, char const * const group, mode_t const mode)
910{
911 if (strcmp(file, "/dev/null") == 0)
912 return true;
913 bool Res = true;
914 if (getuid() == 0 && strlen(user) != 0 && strlen(group) != 0) // if we aren't root, we can't chown, so don't try it
915 {
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);
921 }
922 if (chmod(file, mode) != 0)
923 Res &= _error->WarningE(requester, "chmod 0%o of file %s failed", mode, file);
924 return Res;
925}
926 /*}}}*/
0854ad8b 927
38dba8cd 928struct APT_HIDDEN simple_buffer { /*{{{*/
5bdba2ca 929 size_t buffersize_max = 0;
38dba8cd
JAK
930 unsigned long long bufferstart = 0;
931 unsigned long long bufferend = 0;
5bdba2ca
JAK
932 char *buffer = nullptr;
933
934 simple_buffer() {
935 reset(4096);
936 }
937 ~simple_buffer() {
ab16ead7 938 delete[] buffer;
5bdba2ca 939 }
38dba8cd 940
ea58d39e 941 const char *get() const { return buffer + bufferstart; }
38dba8cd 942 char *get() { return buffer + bufferstart; }
f1b9bf7a
JAK
943 const char *getend() const { return buffer + bufferend; }
944 char *getend() { return buffer + bufferend; }
ea58d39e 945 bool empty() const { return bufferend <= bufferstart; }
c368b3ab 946 bool full() const { return bufferend == buffersize_max; }
f1b9bf7a 947 unsigned long long free() const { return buffersize_max - bufferend; }
ea58d39e 948 unsigned long long size() const { return bufferend-bufferstart; }
5bdba2ca
JAK
949 void reset(size_t size)
950 {
951 if (size > buffersize_max) {
952 delete[] buffer;
953 buffersize_max = size;
954 buffer = new char[size];
955 }
956 reset();
957 }
38dba8cd
JAK
958 void reset() { bufferend = bufferstart = 0; }
959 ssize_t read(void *to, unsigned long long requested_size) APT_MUSTCHECK
960 {
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;
968 }
c368b3ab
JAK
969 ssize_t write(const void *from, unsigned long long requested_size) APT_MUSTCHECK
970 {
47fcfff8
JAK
971 if (free() < requested_size)
972 requested_size = free();
973 memcpy(getend(), from, requested_size);
c368b3ab
JAK
974 bufferend += requested_size;
975 if (bufferstart == bufferend)
976 bufferstart = bufferend = 0;
977 return requested_size;
978 }
38dba8cd
JAK
979};
980 /*}}}*/
981
65ac6aad 982class APT_HIDDEN FileFdPrivate { /*{{{*/
88749b5d 983 friend class BufferedWriteFileFdPrivate;
fa89055f
DK
984protected:
985 FileFd * const filefd;
38dba8cd 986 simple_buffer buffer;
fa89055f
DK
987 int compressed_fd;
988 pid_t compressor_pid;
989 bool is_pipe;
990 APT::Configuration::Compressor compressor;
991 unsigned int openmode;
992 unsigned long long seekpos;
1d68256d
JAK
993public:
994
83e22e26 995 explicit FileFdPrivate(FileFd * const pfilefd) : filefd(pfilefd),
fa89055f
DK
996 compressed_fd(-1), compressor_pid(-1), is_pipe(false),
997 openmode(0), seekpos(0) {};
1d68256d
JAK
998 virtual APT::Configuration::Compressor get_compressor() const
999 {
1000 return compressor;
1001 }
1002 virtual void set_compressor(APT::Configuration::Compressor const &compressor)
1003 {
1004 this->compressor = compressor;
1005 }
1006 virtual unsigned int get_openmode() const
1007 {
1008 return openmode;
1009 }
1010 virtual void set_openmode(unsigned int openmode)
1011 {
1012 this->openmode = openmode;
1013 }
1014 virtual bool get_is_pipe() const
1015 {
1016 return is_pipe;
1017 }
1018 virtual void set_is_pipe(bool is_pipe)
1019 {
1020 this->is_pipe = is_pipe;
1021 }
1022 virtual unsigned long long get_seekpos() const
1023 {
1024 return seekpos;
1025 }
1026 virtual void set_seekpos(unsigned long long seekpos)
1027 {
1028 this->seekpos = seekpos;
1029 }
fa89055f
DK
1030
1031 virtual bool InternalOpen(int const iFd, unsigned int const Mode) = 0;
f63123c3 1032 ssize_t InternalRead(void * To, unsigned long long Size)
fa89055f 1033 {
83e22e26
JAK
1034 // Drain the buffer if needed.
1035 if (buffer.empty() == false)
fa89055f 1036 {
83e22e26 1037 return buffer.read(To, Size);
fa89055f 1038 }
83e22e26 1039 return InternalUnbufferedRead(To, Size);
f63123c3
DK
1040 }
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)
1044 {
1045 if (unlikely(Size == 0))
1046 return nullptr;
01152444 1047 // Read one byte less than buffer size to have space for trailing 0.
f63123c3 1048 --Size;
01152444 1049
f63123c3
DK
1050 char * const InitialTo = To;
1051
01152444 1052 while (Size > 0) {
83e22e26 1053 if (buffer.empty() == true)
f63123c3 1054 {
83e22e26 1055 buffer.reset();
f63123c3 1056 unsigned long long actualread = 0;
72ed5f14 1057 if (filefd->Read(buffer.getend(), buffer.free(), &actualread) == false)
f63123c3 1058 return nullptr;
83e22e26
JAK
1059 buffer.bufferend = actualread;
1060 if (buffer.size() == 0)
f63123c3
DK
1061 {
1062 if (To == InitialTo)
1063 return nullptr;
1064 break;
1065 }
1066 filefd->Flags &= ~FileFd::HitEof;
1067 }
1068
83e22e26 1069 unsigned long long const OutputSize = std::min(Size, buffer.size());
b3db9d81 1070 char const * const newline = static_cast<char const * const>(memchr(buffer.get(), '\n', OutputSize));
a9024b1b
JAK
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
1075 : OutputSize);
1076 To += actualread;
1077 Size -= actualread;
f63123c3 1078 if (newline != nullptr)
f63123c3 1079 break;
01152444 1080 }
f63123c3
DK
1081 *To = '\0';
1082 return InitialTo;
fa89055f 1083 }
766761fd
JAK
1084 virtual bool InternalFlush()
1085 {
1086 return true;
1087 }
fa89055f
DK
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)
1091 {
1092 // Our poor man seeking is costly, so try to avoid it
1093 unsigned long long const iseekpos = filefd->Tell();
1094 if (iseekpos == To)
1095 return true;
1096 else if (iseekpos < To)
1097 return filefd->Skip(To - iseekpos);
1098
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)
1103 close(filefd->iFd);
1104 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);
1109 else
1110 {
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()!");
1116 }
1117
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());
1120
83e22e26 1121 buffer.reset();
eda0c1ba 1122 set_seekpos(0);
fa89055f
DK
1123 if (To != 0)
1124 return filefd->Skip(To);
1125
1126 seekpos = To;
1127 return true;
1128 }
1129 virtual bool InternalSkip(unsigned long long Over)
1130 {
1131 unsigned long long constexpr buffersize = 1024;
1132 char buffer[buffersize];
1133 while (Over != 0)
1134 {
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);
1138 Over -= toread;
1139 }
1140 return true;
1141 }
1142 virtual bool InternalTruncate(unsigned long long const)
1143 {
1144 return filefd->FileFdError("Truncating compressed files is not implemented (%s)", filefd->FileName.c_str());
1145 }
1146 virtual unsigned long long InternalTell()
1147 {
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…
83e22e26 1152 return seekpos - buffer.size();
fa89055f
DK
1153 }
1154 virtual unsigned long long InternalSize()
1155 {
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;
1161 do {
1162 if (filefd->Read(ignore, ignoresize, &read) == false)
1163 {
1164 filefd->Seek(oldSeek);
1165 return 0;
1166 }
1167 } while(read != 0);
1168 size = filefd->Tell();
1169 filefd->Seek(oldSeek);
1170 return size;
1171 }
1172 virtual bool InternalClose(std::string const &FileName) = 0;
1173 virtual bool InternalStream() const { return false; }
1174 virtual bool InternalAlwaysAutoClose() const { return true; }
1175
1176 virtual ~FileFdPrivate() {}
1177};
1178 /*}}}*/
cabfb880 1179class APT_HIDDEN BufferedWriteFileFdPrivate : public FileFdPrivate { /*{{{*/
88749b5d
JAK
1180protected:
1181 FileFdPrivate *wrapped;
1182 simple_buffer writebuffer;
1183
1184public:
1185
1186 explicit BufferedWriteFileFdPrivate(FileFdPrivate *Priv) :
1187 FileFdPrivate(Priv->filefd), wrapped(Priv) {};
1188
cabfb880 1189 virtual APT::Configuration::Compressor get_compressor() const APT_OVERRIDE
88749b5d
JAK
1190 {
1191 return wrapped->get_compressor();
1192 }
cabfb880 1193 virtual void set_compressor(APT::Configuration::Compressor const &compressor) APT_OVERRIDE
88749b5d
JAK
1194 {
1195 return wrapped->set_compressor(compressor);
1196 }
cabfb880 1197 virtual unsigned int get_openmode() const APT_OVERRIDE
88749b5d
JAK
1198 {
1199 return wrapped->get_openmode();
1200 }
cabfb880 1201 virtual void set_openmode(unsigned int openmode) APT_OVERRIDE
88749b5d
JAK
1202 {
1203 return wrapped->set_openmode(openmode);
1204 }
cabfb880 1205 virtual bool get_is_pipe() const APT_OVERRIDE
88749b5d
JAK
1206 {
1207 return wrapped->get_is_pipe();
1208 }
cabfb880 1209 virtual void set_is_pipe(bool is_pipe) APT_OVERRIDE
88749b5d
JAK
1210 {
1211 FileFdPrivate::set_is_pipe(is_pipe);
1212 wrapped->set_is_pipe(is_pipe);
1213 }
cabfb880 1214 virtual unsigned long long get_seekpos() const APT_OVERRIDE
88749b5d
JAK
1215 {
1216 return wrapped->get_seekpos();
1217 }
cabfb880 1218 virtual void set_seekpos(unsigned long long seekpos) APT_OVERRIDE
88749b5d
JAK
1219 {
1220 return wrapped->set_seekpos(seekpos);
1221 }
cabfb880 1222 virtual bool InternalOpen(int const iFd, unsigned int const Mode) APT_OVERRIDE
88749b5d
JAK
1223 {
1224 if (InternalFlush() == false)
1225 return false;
1226 return wrapped->InternalOpen(iFd, Mode);
1227 }
cabfb880 1228 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) APT_OVERRIDE
88749b5d
JAK
1229 {
1230 if (InternalFlush() == false)
1231 return -1;
1232 return wrapped->InternalUnbufferedRead(To, Size);
1233
1234 }
cabfb880 1235 virtual bool InternalReadError() APT_OVERRIDE
88749b5d
JAK
1236 {
1237 return wrapped->InternalReadError();
1238 }
cabfb880 1239 virtual char * InternalReadLine(char * To, unsigned long long Size) APT_OVERRIDE
88749b5d
JAK
1240 {
1241 if (InternalFlush() == false)
1242 return nullptr;
1243 return wrapped->InternalReadLine(To, Size);
1244 }
cabfb880 1245 virtual bool InternalFlush() APT_OVERRIDE
88749b5d 1246 {
1f5062f6
JAK
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)
1252 continue;
1253 if (written < 0)
1996a6a7 1254 return wrapped->InternalWriteError();
88749b5d 1255
1f5062f6 1256 writebuffer.bufferstart += written;
88749b5d
JAK
1257 }
1258
1259 writebuffer.reset();
1260 return true;
1261 }
cabfb880 1262 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) APT_OVERRIDE
88749b5d 1263 {
f1828e6b
JAK
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);
1268
1269 // Write as much into the buffer as possible and then flush if needed
070ed1c9 1270 auto written = writebuffer.write(From, Size);
88749b5d 1271
070ed1c9
JAK
1272 if (writebuffer.full() && InternalFlush() == false)
1273 return -1;
88749b5d
JAK
1274
1275 return written;
1276 }
cabfb880 1277 virtual bool InternalWriteError() APT_OVERRIDE
88749b5d
JAK
1278 {
1279 return wrapped->InternalWriteError();
1280 }
cabfb880 1281 virtual bool InternalSeek(unsigned long long const To) APT_OVERRIDE
88749b5d
JAK
1282 {
1283 if (InternalFlush() == false)
1284 return false;
1285 return wrapped->InternalSeek(To);
1286 }
cabfb880 1287 virtual bool InternalSkip(unsigned long long Over) APT_OVERRIDE
88749b5d
JAK
1288 {
1289 if (InternalFlush() == false)
1290 return false;
1291 return wrapped->InternalSkip(Over);
1292 }
cabfb880 1293 virtual bool InternalTruncate(unsigned long long const Size) APT_OVERRIDE
88749b5d
JAK
1294 {
1295 if (InternalFlush() == false)
1296 return false;
1297 return wrapped->InternalTruncate(Size);
1298 }
cabfb880 1299 virtual unsigned long long InternalTell() APT_OVERRIDE
88749b5d
JAK
1300 {
1301 if (InternalFlush() == false)
1302 return -1;
1303 return wrapped->InternalTell();
1304 }
cabfb880 1305 virtual unsigned long long InternalSize() APT_OVERRIDE
88749b5d
JAK
1306 {
1307 if (InternalFlush() == false)
1308 return -1;
1309 return wrapped->InternalSize();
1310 }
cabfb880 1311 virtual bool InternalClose(std::string const &FileName) APT_OVERRIDE
88749b5d
JAK
1312 {
1313 return wrapped->InternalClose(FileName);
1314 }
cabfb880 1315 virtual bool InternalAlwaysAutoClose() const APT_OVERRIDE
88749b5d
JAK
1316 {
1317 return wrapped->InternalAlwaysAutoClose();
1318 }
1319 virtual ~BufferedWriteFileFdPrivate()
1320 {
1321 delete wrapped;
1322 }
1323};
1324 /*}}}*/
65ac6aad 1325class APT_HIDDEN GzipFileFdPrivate: public FileFdPrivate { /*{{{*/
4239dbca 1326#ifdef HAVE_ZLIB
fa89055f
DK
1327public:
1328 gzFile gz;
cabfb880 1329 virtual bool InternalOpen(int const iFd, unsigned int const Mode) APT_OVERRIDE
fa89055f
DK
1330 {
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");
1335 else
1336 gz = gzdopen(iFd, "r");
1337 filefd->Flags |= FileFd::Compressed;
1338 return gz != nullptr;
1339 }
cabfb880 1340 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) APT_OVERRIDE
fa89055f
DK
1341 {
1342 return gzread(gz, To, Size);
1343 }
cabfb880 1344 virtual bool InternalReadError() APT_OVERRIDE
fa89055f
DK
1345 {
1346 int err;
1347 char const * const errmsg = gzerror(gz, &err);
1348 if (err != Z_ERRNO)
1349 return filefd->FileFdError("gzread: %s (%d: %s)", _("Read error"), err, errmsg);
1350 return FileFdPrivate::InternalReadError();
1351 }
cabfb880 1352 virtual char * InternalReadLine(char * To, unsigned long long Size) APT_OVERRIDE
fa89055f
DK
1353 {
1354 return gzgets(gz, To, Size);
1355 }
cabfb880 1356 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) APT_OVERRIDE
fa89055f
DK
1357 {
1358 return gzwrite(gz,From,Size);
1359 }
cabfb880 1360 virtual bool InternalWriteError() APT_OVERRIDE
fa89055f
DK
1361 {
1362 int err;
1363 char const * const errmsg = gzerror(gz, &err);
1364 if (err != Z_ERRNO)
1365 return filefd->FileFdError("gzwrite: %s (%d: %s)", _("Write error"), err, errmsg);
1366 return FileFdPrivate::InternalWriteError();
1367 }
cabfb880 1368 virtual bool InternalSeek(unsigned long long const To) APT_OVERRIDE
fa89055f
DK
1369 {
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);
fa89055f 1373 seekpos = To;
83e22e26 1374 buffer.reset();
fa89055f
DK
1375 return true;
1376 }
cabfb880 1377 virtual bool InternalSkip(unsigned long long Over) APT_OVERRIDE
fa89055f 1378 {
83e22e26 1379 if (Over >= buffer.size())
f63123c3 1380 {
83e22e26
JAK
1381 Over -= buffer.size();
1382 buffer.reset();
f63123c3
DK
1383 }
1384 else
1385 {
83e22e26 1386 buffer.bufferstart += Over;
f63123c3
DK
1387 return true;
1388 }
1389 if (Over == 0)
1390 return true;
fa89055f
DK
1391 off_t const res = gzseek(gz, Over, SEEK_CUR);
1392 if (res < 0)
1393 return filefd->FileFdError("Unable to seek ahead %llu",Over);
1394 seekpos = res;
1395 return true;
1396 }
cabfb880 1397 virtual unsigned long long InternalTell() APT_OVERRIDE
fa89055f 1398 {
83e22e26 1399 return gztell(gz) - buffer.size();
fa89055f 1400 }
cabfb880 1401 virtual unsigned long long InternalSize() APT_OVERRIDE
fa89055f
DK
1402 {
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))
1408 return filesize;
1409
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)
1416 {
1417 filefd->FileFdErrno("lseek","Unable to seek to end of gzipped file");
1418 return 0;
1419 }
1420 uint32_t size = 0;
1421 if (read(filefd->iFd, &size, 4) != 4)
1422 {
1423 filefd->FileFdErrno("read","Unable to read original size of gzipped file");
1424 return 0;
1425 }
1426 size = le32toh(size);
1427
1428 if (lseek(filefd->iFd, oldPos, SEEK_SET) < 0)
1429 {
1430 filefd->FileFdErrno("lseek","Unable to seek in gzipped file");
1431 return 0;
1432 }
1433 return size;
1434 }
cabfb880 1435 virtual bool InternalClose(std::string const &FileName) APT_OVERRIDE
fa89055f
DK
1436 {
1437 if (gz == nullptr)
1438 return true;
1439 int const e = gzclose(gz);
1440 gz = nullptr;
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());
1444 return true;
1445 }
1446
11755147 1447 explicit GzipFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd), gz(nullptr) {}
fa89055f 1448 virtual ~GzipFileFdPrivate() { InternalClose(""); }
4239dbca 1449#endif
fa89055f
DK
1450};
1451 /*}}}*/
65ac6aad 1452class APT_HIDDEN Bz2FileFdPrivate: public FileFdPrivate { /*{{{*/
4239dbca 1453#ifdef HAVE_BZ2
fa89055f
DK
1454 BZFILE* bz2;
1455public:
cabfb880 1456 virtual bool InternalOpen(int const iFd, unsigned int const Mode) APT_OVERRIDE
fa89055f
DK
1457 {
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");
1462 else
1463 bz2 = BZ2_bzdopen(iFd, "r");
1464 filefd->Flags |= FileFd::Compressed;
1465 return bz2 != nullptr;
1466 }
cabfb880 1467 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) APT_OVERRIDE
fa89055f
DK
1468 {
1469 return BZ2_bzread(bz2, To, Size);
1470 }
cabfb880 1471 virtual bool InternalReadError() APT_OVERRIDE
fa89055f
DK
1472 {
1473 int err;
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();
1478 }
cabfb880 1479 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) APT_OVERRIDE
fa89055f
DK
1480 {
1481 return BZ2_bzwrite(bz2, (void*)From, Size);
1482 }
cabfb880 1483 virtual bool InternalWriteError() APT_OVERRIDE
fa89055f
DK
1484 {
1485 int err;
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();
1490 }
cabfb880
DK
1491 virtual bool InternalStream() const APT_OVERRIDE { return true; }
1492 virtual bool InternalClose(std::string const &) APT_OVERRIDE
fa89055f
DK
1493 {
1494 if (bz2 == nullptr)
1495 return true;
1496 BZ2_bzclose(bz2);
1497 bz2 = nullptr;
1498 return true;
1499 }
1500
11755147 1501 explicit Bz2FileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd), bz2(nullptr) {}
fa89055f 1502 virtual ~Bz2FileFdPrivate() { InternalClose(""); }
4239dbca 1503#endif
e3fbd54c
JAK
1504};
1505 /*}}}*/
1506class APT_HIDDEN Lz4FileFdPrivate: public FileFdPrivate { /*{{{*/
e3fbd54c
JAK
1507 static constexpr unsigned long long LZ4_HEADER_SIZE = 19;
1508 static constexpr unsigned long long LZ4_FOOTER_SIZE = 4;
1509#ifdef HAVE_LZ4
1510 LZ4F_decompressionContext_t dctx;
1511 LZ4F_compressionContext_t cctx;
1512 LZ4F_errorCode_t res;
1513 FileFd backend;
1514 simple_buffer lz4_buffer;
1515 // Count of bytes that the decompressor expects to read next, or buffer size.
40940e63 1516 size_t next_to_load = APT_BUFFER_SIZE;
e3fbd54c 1517public:
cabfb880 1518 virtual bool InternalOpen(int const iFd, unsigned int const Mode) APT_OVERRIDE
e3fbd54c
JAK
1519 {
1520 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1521 return _error->Error("lz4 only supports write or read mode");
1522
1523 if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly) {
1524 res = LZ4F_createCompressionContext(&cctx, LZ4F_VERSION);
40940e63 1525 lz4_buffer.reset(LZ4F_compressBound(APT_BUFFER_SIZE, nullptr)
e3fbd54c
JAK
1526 + LZ4_HEADER_SIZE + LZ4_FOOTER_SIZE);
1527 } else {
1528 res = LZ4F_createDecompressionContext(&dctx, LZ4F_VERSION);
40940e63 1529 lz4_buffer.reset(APT_BUFFER_SIZE);
e3fbd54c
JAK
1530 }
1531
1532 filefd->Flags |= FileFd::Compressed;
1533
1534 if (LZ4F_isError(res))
1535 return false;
1536
1537 unsigned int flags = (Mode & (FileFd::WriteOnly|FileFd::ReadOnly));
6f35be91 1538 if (backend.OpenDescriptor(iFd, flags, FileFd::None, true) == false)
e3fbd54c
JAK
1539 return false;
1540
1541 // Write the file header
1542 if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1543 {
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)
1546 return false;
1547 }
1548
1549 return true;
1550 }
cabfb880 1551 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) APT_OVERRIDE
e3fbd54c
JAK
1552 {
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)
1561 return -1;
1562 lz4_buffer.bufferend += read;
1563
1564 /* Expected EOF */
1565 if (read == 0) {
1566 res = -1;
1567 return filefd->FileFdError("LZ4F: %s %s",
1568 filefd->FileName.c_str(),
1569 _("Unexpected end of file")), -1;
1570 }
1571 }
1572 // Drain compressed buffer as far as possible.
1573 size_t in = lz4_buffer.size();
1574 size_t out = Size;
1575
1576 res = LZ4F_decompress(dctx, To, &out, lz4_buffer.get(), &in, nullptr);
1577 if (LZ4F_isError(res))
1578 return -1;
1579
1580 next_to_load = res;
1581 lz4_buffer.bufferstart += in;
1582
1583 if (out != 0)
1584 return out;
1585 }
1586
1587 return 0;
1588 }
cabfb880 1589 virtual bool InternalReadError() APT_OVERRIDE
e3fbd54c
JAK
1590 {
1591 char const * const errmsg = LZ4F_getErrorName(res);
1592
1593 return filefd->FileFdError("LZ4F: %s %s (%zu: %s)", filefd->FileName.c_str(), _("Read error"), res, errmsg);
1594 }
cabfb880 1595 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) APT_OVERRIDE
e3fbd54c 1596 {
40940e63 1597 unsigned long long const towrite = std::min(APT_BUFFER_SIZE, Size);
e3fbd54c
JAK
1598
1599 res = LZ4F_compressUpdate(cctx,
1600 lz4_buffer.buffer, lz4_buffer.buffersize_max,
1601 From, towrite, nullptr);
1602
1603 if (LZ4F_isError(res) || backend.Write(lz4_buffer.buffer, res) == false)
1604 return -1;
1605
1606 return towrite;
1607 }
cabfb880 1608 virtual bool InternalWriteError() APT_OVERRIDE
e3fbd54c
JAK
1609 {
1610 char const * const errmsg = LZ4F_getErrorName(res);
1611
1612 return filefd->FileFdError("LZ4F: %s %s (%zu: %s)", filefd->FileName.c_str(), _("Write error"), res, errmsg);
1613 }
cabfb880 1614 virtual bool InternalStream() const APT_OVERRIDE { return true; }
e3fbd54c 1615
cabfb880 1616 virtual bool InternalFlush() APT_OVERRIDE
e3fbd54c
JAK
1617 {
1618 return backend.Flush();
1619 }
1620
cabfb880 1621 virtual bool InternalClose(std::string const &) APT_OVERRIDE
e3fbd54c
JAK
1622 {
1623 /* Reset variables */
1624 res = 0;
40940e63 1625 next_to_load = APT_BUFFER_SIZE;
e3fbd54c
JAK
1626
1627 if (cctx != nullptr)
1628 {
f43dd439
DK
1629 if (filefd->Failed() == false)
1630 {
1631 res = LZ4F_compressEnd(cctx, lz4_buffer.buffer, lz4_buffer.buffersize_max, nullptr);
1632 if (LZ4F_isError(res) || backend.Write(lz4_buffer.buffer, res) == false)
1633 return false;
1634 if (!backend.Flush())
1635 return false;
1636 }
e3fbd54c
JAK
1637 if (!backend.Close())
1638 return false;
1639
1640 res = LZ4F_freeCompressionContext(cctx);
1641 cctx = nullptr;
1642 }
1643
1644 if (dctx != nullptr)
1645 {
1646 res = LZ4F_freeDecompressionContext(dctx);
1647 dctx = nullptr;
1648 }
6f35be91
DK
1649 if (backend.IsOpen())
1650 {
1651 backend.Close();
1652 filefd->iFd = -1;
1653 }
e3fbd54c
JAK
1654
1655 return LZ4F_isError(res) == false;
1656 }
1657
1658 explicit Lz4FileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd), dctx(nullptr), cctx(nullptr) {}
1659 virtual ~Lz4FileFdPrivate() {
1660 InternalClose("");
1661 }
1662#endif
fa89055f
DK
1663};
1664 /*}}}*/
65ac6aad 1665class APT_HIDDEN LzmaFileFdPrivate: public FileFdPrivate { /*{{{*/
4239dbca 1666#ifdef HAVE_LZMA
fa89055f
DK
1667 struct LZMAFILE {
1668 FILE* file;
f43dd439 1669 FileFd * const filefd;
fa89055f
DK
1670 uint8_t buffer[4096];
1671 lzma_stream stream;
1672 lzma_ret err;
1673 bool eof;
1674 bool compressing;
1675
f43dd439 1676 LZMAFILE(FileFd * const fd) : file(nullptr), filefd(fd), eof(false), compressing(false) { buffer[0] = '\0'; }
fa89055f
DK
1677 ~LZMAFILE()
1678 {
f43dd439 1679 if (compressing == true && filefd->Failed() == false)
fa89055f
DK
1680 {
1681 size_t constexpr buffersize = sizeof(buffer)/sizeof(buffer[0]);
1682 while(true)
1683 {
1684 stream.avail_out = buffersize;
1685 stream.next_out = buffer;
1686 err = lzma_code(&stream, LZMA_FINISH);
1687 if (err != LZMA_OK && err != LZMA_STREAM_END)
1688 {
1689 _error->Error("~LZMAFILE: Compress finalisation failed");
1690 break;
1691 }
1692 size_t const n = buffersize - stream.avail_out;
1693 if (n && fwrite(buffer, 1, n, file) != n)
1694 {
1695 _error->Errno("~LZMAFILE",_("Write error"));
1696 break;
1697 }
1698 if (err == LZMA_STREAM_END)
1699 break;
1700 }
1701 }
1702 lzma_end(&stream);
1703 fclose(file);
1704 }
1705 };
1706 LZMAFILE* lzma;
7a68effc
DK
1707 static uint32_t findXZlevel(std::vector<std::string> const &Args)
1708 {
1709 for (auto a = Args.rbegin(); a != Args.rend(); ++a)
1710 if (a->empty() == false && (*a)[0] == '-' && (*a)[1] != '-')
1711 {
1712 auto const number = a->find_last_of("0123456789");
1713 if (number == std::string::npos)
1714 continue;
1715 auto const extreme = a->find("e", number);
1716 uint32_t level = (extreme != std::string::npos) ? LZMA_PRESET_EXTREME : 0;
1717 switch ((*a)[number])
1718 {
1719 case '0': return level | 0;
1720 case '1': return level | 1;
1721 case '2': return level | 2;
1722 case '3': return level | 3;
1723 case '4': return level | 4;
1724 case '5': return level | 5;
1725 case '6': return level | 6;
1726 case '7': return level | 7;
1727 case '8': return level | 8;
1728 case '9': return level | 9;
1729 }
1730 }
1731 return 6;
1732 }
fa89055f 1733public:
cabfb880 1734 virtual bool InternalOpen(int const iFd, unsigned int const Mode) APT_OVERRIDE
fa89055f
DK
1735 {
1736 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1737 return filefd->FileFdError("ReadWrite mode is not supported for lzma/xz files %s", filefd->FileName.c_str());
1738
1739 if (lzma == nullptr)
f43dd439 1740 lzma = new LzmaFileFdPrivate::LZMAFILE(filefd);
fa89055f
DK
1741 if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1742 lzma->file = fdopen(iFd, "w");
1743 else
1744 lzma->file = fdopen(iFd, "r");
1745 filefd->Flags |= FileFd::Compressed;
1746 if (lzma->file == nullptr)
1747 return false;
1748
fa89055f
DK
1749 lzma_stream tmp_stream = LZMA_STREAM_INIT;
1750 lzma->stream = tmp_stream;
1751
1752 if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1753 {
7a68effc 1754 uint32_t const xzlevel = findXZlevel(compressor.CompressArgs);
fa89055f
DK
1755 if (compressor.Name == "xz")
1756 {
885a1ffd 1757 if (lzma_easy_encoder(&lzma->stream, xzlevel, LZMA_CHECK_CRC64) != LZMA_OK)
fa89055f
DK
1758 return false;
1759 }
1760 else
1761 {
1762 lzma_options_lzma options;
1763 lzma_lzma_preset(&options, xzlevel);
1764 if (lzma_alone_encoder(&lzma->stream, &options) != LZMA_OK)
1765 return false;
1766 }
1767 lzma->compressing = true;
1768 }
1769 else
1770 {
7a68effc 1771 uint64_t const memlimit = UINT64_MAX;
fa89055f
DK
1772 if (compressor.Name == "xz")
1773 {
1774 if (lzma_auto_decoder(&lzma->stream, memlimit, 0) != LZMA_OK)
1775 return false;
1776 }
1777 else
1778 {
1779 if (lzma_alone_decoder(&lzma->stream, memlimit) != LZMA_OK)
1780 return false;
1781 }
1782 lzma->compressing = false;
1783 }
1784 return true;
1785 }
cabfb880 1786 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) APT_OVERRIDE
fa89055f
DK
1787 {
1788 ssize_t Res;
1789 if (lzma->eof == true)
1790 return 0;
1791
1792 lzma->stream.next_out = (uint8_t *) To;
1793 lzma->stream.avail_out = Size;
1794 if (lzma->stream.avail_in == 0)
1795 {
1796 lzma->stream.next_in = lzma->buffer;
1797 lzma->stream.avail_in = fread(lzma->buffer, 1, sizeof(lzma->buffer)/sizeof(lzma->buffer[0]), lzma->file);
1798 }
1799 lzma->err = lzma_code(&lzma->stream, LZMA_RUN);
1800 if (lzma->err == LZMA_STREAM_END)
1801 {
1802 lzma->eof = true;
1803 Res = Size - lzma->stream.avail_out;
1804 }
1805 else if (lzma->err != LZMA_OK)
1806 {
1807 Res = -1;
1808 errno = 0;
1809 }
1810 else
1811 {
1812 Res = Size - lzma->stream.avail_out;
1813 if (Res == 0)
1814 {
1815 // lzma run was okay, but produced no output…
1816 Res = -1;
1817 errno = EINTR;
1818 }
1819 }
1820 return Res;
1821 }
cabfb880 1822 virtual bool InternalReadError() APT_OVERRIDE
fa89055f
DK
1823 {
1824 return filefd->FileFdError("lzma_read: %s (%d)", _("Read error"), lzma->err);
1825 }
cabfb880 1826 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) APT_OVERRIDE
fa89055f 1827 {
9a63c3f4 1828 ssize_t Res;
fa89055f
DK
1829 lzma->stream.next_in = (uint8_t *)From;
1830 lzma->stream.avail_in = Size;
1831 lzma->stream.next_out = lzma->buffer;
1832 lzma->stream.avail_out = sizeof(lzma->buffer)/sizeof(lzma->buffer[0]);
1833 lzma->err = lzma_code(&lzma->stream, LZMA_RUN);
1834 if (lzma->err != LZMA_OK)
1835 return -1;
1836 size_t const n = sizeof(lzma->buffer)/sizeof(lzma->buffer[0]) - lzma->stream.avail_out;
1837 size_t const m = (n == 0) ? 0 : fwrite(lzma->buffer, 1, n, lzma->file);
1838 if (m != n)
9a63c3f4
CW
1839 {
1840 Res = -1;
1841 errno = 0;
1842 }
fa89055f 1843 else
9a63c3f4
CW
1844 {
1845 Res = Size - lzma->stream.avail_in;
1846 if (Res == 0)
1847 {
1848 // lzma run was okay, but produced no output…
1849 Res = -1;
1850 errno = EINTR;
1851 }
1852 }
1853 return Res;
fa89055f 1854 }
cabfb880 1855 virtual bool InternalWriteError() APT_OVERRIDE
fa89055f
DK
1856 {
1857 return filefd->FileFdError("lzma_write: %s (%d)", _("Write error"), lzma->err);
1858 }
cabfb880
DK
1859 virtual bool InternalStream() const APT_OVERRIDE { return true; }
1860 virtual bool InternalClose(std::string const &) APT_OVERRIDE
fa89055f
DK
1861 {
1862 delete lzma;
1863 lzma = nullptr;
1864 return true;
1865 }
1866
11755147 1867 explicit LzmaFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd), lzma(nullptr) {}
fa89055f 1868 virtual ~LzmaFileFdPrivate() { InternalClose(""); }
4239dbca 1869#endif
fa89055f
DK
1870};
1871 /*}}}*/
65ac6aad 1872class APT_HIDDEN PipedFileFdPrivate: public FileFdPrivate /*{{{*/
fa89055f
DK
1873/* if we don't have a specific class dealing with library calls, we (un)compress
1874 by executing a specified binary and pipe in/out what we need */
1875{
1876public:
cabfb880 1877 virtual bool InternalOpen(int const, unsigned int const Mode) APT_OVERRIDE
fa89055f
DK
1878 {
1879 // collect zombies here in case we reopen
1880 if (compressor_pid > 0)
1881 ExecWait(compressor_pid, "FileFdCompressor", true);
1882
1883 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1884 return filefd->FileFdError("ReadWrite mode is not supported for file %s", filefd->FileName.c_str());
cc9745a0
DK
1885 if (compressor.Binary == "false")
1886 return filefd->FileFdError("libapt has inbuilt support for the %s compression,"
1887 " but was forced to ignore it in favor of an external binary – which isn't installed.", compressor.Name.c_str());
4239dbca 1888
fa89055f
DK
1889 bool const Comp = (Mode & FileFd::WriteOnly) == FileFd::WriteOnly;
1890 if (Comp == false)
1891 {
1892 // Handle 'decompression' of empty files
1893 struct stat Buf;
1894 fstat(filefd->iFd, &Buf);
1895 if (Buf.st_size == 0 && S_ISFIFO(Buf.st_mode) == false)
1896 return true;
1897
1898 // We don't need the file open - instead let the compressor open it
1899 // as he properly knows better how to efficiently read from 'his' file
1900 if (filefd->FileName.empty() == false)
1901 {
1902 close(filefd->iFd);
1903 filefd->iFd = -1;
1904 }
1905 }
1906
1907 // Create a data pipe
1908 int Pipe[2] = {-1,-1};
1909 if (pipe(Pipe) != 0)
1910 return filefd->FileFdErrno("pipe",_("Failed to create subprocess IPC"));
1911 for (int J = 0; J != 2; J++)
1912 SetCloseExec(Pipe[J],true);
1913
1914 compressed_fd = filefd->iFd;
1d68256d 1915 set_is_pipe(true);
fa89055f
DK
1916
1917 if (Comp == true)
1918 filefd->iFd = Pipe[1];
1919 else
1920 filefd->iFd = Pipe[0];
1921
1922 // The child..
1923 compressor_pid = ExecFork();
1924 if (compressor_pid == 0)
1925 {
1926 if (Comp == true)
1927 {
1928 dup2(compressed_fd,STDOUT_FILENO);
1929 dup2(Pipe[0],STDIN_FILENO);
1930 }
1931 else
1932 {
1933 if (compressed_fd != -1)
1934 dup2(compressed_fd,STDIN_FILENO);
1935 dup2(Pipe[1],STDOUT_FILENO);
1936 }
1937 int const nullfd = open("/dev/null", O_WRONLY);
1938 if (nullfd != -1)
1939 {
1940 dup2(nullfd,STDERR_FILENO);
1941 close(nullfd);
1942 }
1943
1944 SetCloseExec(STDOUT_FILENO,false);
1945 SetCloseExec(STDIN_FILENO,false);
1946
1947 std::vector<char const*> Args;
1948 Args.push_back(compressor.Binary.c_str());
1949 std::vector<std::string> const * const addArgs =
1950 (Comp == true) ? &(compressor.CompressArgs) : &(compressor.UncompressArgs);
1951 for (std::vector<std::string>::const_iterator a = addArgs->begin();
1952 a != addArgs->end(); ++a)
1953 Args.push_back(a->c_str());
1954 if (Comp == false && filefd->FileName.empty() == false)
1955 {
1956 // commands not needing arguments, do not need to be told about using standard output
1957 // in reality, only testcases with tools like cat, rev, rot13, … are able to trigger this
1958 if (compressor.CompressArgs.empty() == false && compressor.UncompressArgs.empty() == false)
1959 Args.push_back("--stdout");
1960 if (filefd->TemporaryFileName.empty() == false)
1961 Args.push_back(filefd->TemporaryFileName.c_str());
1962 else
1963 Args.push_back(filefd->FileName.c_str());
1964 }
1965 Args.push_back(NULL);
1966
1967 execvp(Args[0],(char **)&Args[0]);
1968 cerr << _("Failed to exec compressor ") << Args[0] << endl;
1969 _exit(100);
1970 }
1971 if (Comp == true)
1972 close(Pipe[0]);
1973 else
1974 close(Pipe[1]);
1975
1976 return true;
1977 }
cabfb880 1978 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) APT_OVERRIDE
fa89055f
DK
1979 {
1980 return read(filefd->iFd, To, Size);
1981 }
cabfb880 1982 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) APT_OVERRIDE
fa89055f
DK
1983 {
1984 return write(filefd->iFd, From, Size);
1985 }
cabfb880 1986 virtual bool InternalClose(std::string const &) APT_OVERRIDE
fa89055f
DK
1987 {
1988 bool Ret = true;
bdc42211
DK
1989 if (filefd->iFd != -1)
1990 {
1991 close(filefd->iFd);
1992 filefd->iFd = -1;
1993 }
fa89055f
DK
1994 if (compressor_pid > 0)
1995 Ret &= ExecWait(compressor_pid, "FileFdCompressor", true);
1996 compressor_pid = -1;
1997 return Ret;
1998 }
11755147 1999 explicit PipedFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd) {}
fa89055f
DK
2000 virtual ~PipedFileFdPrivate() { InternalClose(""); }
2001};
2002 /*}}}*/
65ac6aad 2003class APT_HIDDEN DirectFileFdPrivate: public FileFdPrivate /*{{{*/
fa89055f
DK
2004{
2005public:
cabfb880
DK
2006 virtual bool InternalOpen(int const, unsigned int const) APT_OVERRIDE { return true; }
2007 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) APT_OVERRIDE
fa89055f
DK
2008 {
2009 return read(filefd->iFd, To, Size);
2010 }
cabfb880 2011 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) APT_OVERRIDE
fa89055f 2012 {
f63123c3 2013 // files opened read+write are strange and only really "supported" for direct files
83e22e26 2014 if (buffer.size() != 0)
f63123c3 2015 {
83e22e26
JAK
2016 lseek(filefd->iFd, -buffer.size(), SEEK_CUR);
2017 buffer.reset();
f63123c3 2018 }
fa89055f
DK
2019 return write(filefd->iFd, From, Size);
2020 }
cabfb880 2021 virtual bool InternalSeek(unsigned long long const To) APT_OVERRIDE
fa89055f
DK
2022 {
2023 off_t const res = lseek(filefd->iFd, To, SEEK_SET);
2024 if (res != (off_t)To)
2025 return filefd->FileFdError("Unable to seek to %llu", To);
2026 seekpos = To;
83e22e26 2027 buffer.reset();
fa89055f
DK
2028 return true;
2029 }
cabfb880 2030 virtual bool InternalSkip(unsigned long long Over) APT_OVERRIDE
fa89055f 2031 {
83e22e26 2032 if (Over >= buffer.size())
f63123c3 2033 {
83e22e26
JAK
2034 Over -= buffer.size();
2035 buffer.reset();
f63123c3
DK
2036 }
2037 else
2038 {
83e22e26 2039 buffer.bufferstart += Over;
f63123c3
DK
2040 return true;
2041 }
2042 if (Over == 0)
2043 return true;
fa89055f
DK
2044 off_t const res = lseek(filefd->iFd, Over, SEEK_CUR);
2045 if (res < 0)
2046 return filefd->FileFdError("Unable to seek ahead %llu",Over);
2047 seekpos = res;
2048 return true;
2049 }
cabfb880 2050 virtual bool InternalTruncate(unsigned long long const To) APT_OVERRIDE
fa89055f 2051 {
83e22e26 2052 if (buffer.size() != 0)
f63123c3
DK
2053 {
2054 unsigned long long const seekpos = lseek(filefd->iFd, 0, SEEK_CUR);
83e22e26
JAK
2055 if ((seekpos - buffer.size()) >= To)
2056 buffer.reset();
f63123c3 2057 else if (seekpos >= To)
83e22e26 2058 buffer.bufferend = (To - seekpos) + buffer.bufferstart;
f63123c3 2059 else
83e22e26 2060 buffer.reset();
f63123c3 2061 }
fa89055f
DK
2062 if (ftruncate(filefd->iFd, To) != 0)
2063 return filefd->FileFdError("Unable to truncate to %llu",To);
2064 return true;
2065 }
cabfb880 2066 virtual unsigned long long InternalTell() APT_OVERRIDE
fa89055f 2067 {
83e22e26 2068 return lseek(filefd->iFd,0,SEEK_CUR) - buffer.size();
fa89055f 2069 }
cabfb880 2070 virtual unsigned long long InternalSize() APT_OVERRIDE
fa89055f
DK
2071 {
2072 return filefd->FileSize();
2073 }
cabfb880
DK
2074 virtual bool InternalClose(std::string const &) APT_OVERRIDE { return true; }
2075 virtual bool InternalAlwaysAutoClose() const APT_OVERRIDE { return false; }
fa89055f 2076
11755147 2077 explicit DirectFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd) {}
fa89055f 2078 virtual ~DirectFileFdPrivate() { InternalClose(""); }
4239dbca
DK
2079};
2080 /*}}}*/
6c55f07a
DK
2081// FileFd Constructors /*{{{*/
2082FileFd::FileFd(std::string FileName,unsigned int const Mode,unsigned long AccessMode) : iFd(-1), Flags(0), d(NULL)
2083{
2084 Open(FileName,Mode, None, AccessMode);
2085}
2086FileFd::FileFd(std::string FileName,unsigned int const Mode, CompressMode Compress, unsigned long AccessMode) : iFd(-1), Flags(0), d(NULL)
2087{
2088 Open(FileName,Mode, Compress, AccessMode);
2089}
2090FileFd::FileFd() : iFd(-1), Flags(AutoClose), d(NULL) {}
2091FileFd::FileFd(int const Fd, unsigned int const Mode, CompressMode Compress) : iFd(-1), Flags(0), d(NULL)
2092{
2093 OpenDescriptor(Fd, Mode, Compress);
2094}
2095FileFd::FileFd(int const Fd, bool const AutoClose) : iFd(-1), Flags(0), d(NULL)
2096{
2097 OpenDescriptor(Fd, ReadWrite, None, AutoClose);
2098}
2099 /*}}}*/
13d87e2e 2100// FileFd::Open - Open a file /*{{{*/
578bfd0a
AL
2101// ---------------------------------------------------------------------
2102/* The most commonly used open mode combinations are given with Mode */
e5f3f8c1 2103bool FileFd::Open(string FileName,unsigned int const Mode,CompressMode Compress, unsigned long const AccessMode)
578bfd0a 2104{
257e8d66 2105 if (Mode == ReadOnlyGzip)
e5f3f8c1 2106 return Open(FileName, ReadOnly, Gzip, AccessMode);
257e8d66 2107
468720c5 2108 if (Compress == Auto && (Mode & WriteOnly) == WriteOnly)
ae635e3c 2109 return FileFdError("Autodetection on %s only works in ReadOnly openmode!", FileName.c_str());
257e8d66 2110
468720c5
DK
2111 std::vector<APT::Configuration::Compressor> const compressors = APT::Configuration::getCompressors();
2112 std::vector<APT::Configuration::Compressor>::const_iterator compressor = compressors.begin();
2113 if (Compress == Auto)
2114 {
468720c5
DK
2115 for (; compressor != compressors.end(); ++compressor)
2116 {
e788a834 2117 std::string file = FileName + compressor->Extension;
468720c5
DK
2118 if (FileExists(file) == false)
2119 continue;
2120 FileName = file;
468720c5
DK
2121 break;
2122 }
2123 }
2124 else if (Compress == Extension)
2125 {
52b47296
DK
2126 std::string::size_type const found = FileName.find_last_of('.');
2127 std::string ext;
2128 if (found != std::string::npos)
2129 {
2130 ext = FileName.substr(found);
2131 if (ext == ".new" || ext == ".bak")
2132 {
2133 std::string::size_type const found2 = FileName.find_last_of('.', found - 1);
2134 if (found2 != std::string::npos)
2135 ext = FileName.substr(found2, found - found2);
2136 else
2137 ext.clear();
2138 }
2139 }
aee1aac6
DK
2140 for (; compressor != compressors.end(); ++compressor)
2141 if (ext == compressor->Extension)
2142 break;
2143 // no matching extension - assume uncompressed (imagine files like 'example.org_Packages')
2144 if (compressor == compressors.end())
2145 for (compressor = compressors.begin(); compressor != compressors.end(); ++compressor)
2146 if (compressor->Name == ".")
468720c5 2147 break;
468720c5 2148 }
aee1aac6 2149 else
468720c5
DK
2150 {
2151 std::string name;
2152 switch (Compress)
2153 {
aee1aac6 2154 case None: name = "."; break;
468720c5
DK
2155 case Gzip: name = "gzip"; break;
2156 case Bzip2: name = "bzip2"; break;
2157 case Lzma: name = "lzma"; break;
2158 case Xz: name = "xz"; break;
e3fbd54c 2159 case Lz4: name = "lz4"; break;
aee1aac6
DK
2160 case Auto:
2161 case Extension:
52b47296 2162 // Unreachable
ae635e3c 2163 return FileFdError("Opening File %s in None, Auto or Extension should be already handled?!?", FileName.c_str());
468720c5
DK
2164 }
2165 for (; compressor != compressors.end(); ++compressor)
2166 if (compressor->Name == name)
2167 break;
aee1aac6 2168 if (compressor == compressors.end())
ae635e3c 2169 return FileFdError("Can't find a configured compressor %s for file %s", name.c_str(), FileName.c_str());
468720c5
DK
2170 }
2171
aee1aac6 2172 if (compressor == compressors.end())
ae635e3c 2173 return FileFdError("Can't find a match for specified compressor mode for file %s", FileName.c_str());
e5f3f8c1 2174 return Open(FileName, Mode, *compressor, AccessMode);
aee1aac6 2175}
e5f3f8c1 2176bool FileFd::Open(string FileName,unsigned int const Mode,APT::Configuration::Compressor const &compressor, unsigned long const AccessMode)
aee1aac6
DK
2177{
2178 Close();
aee1aac6
DK
2179 Flags = AutoClose;
2180
2181 if ((Mode & WriteOnly) != WriteOnly && (Mode & (Atomic | Create | Empty | Exclusive)) != 0)
ae635e3c 2182 return FileFdError("ReadOnly mode for %s doesn't accept additional flags!", FileName.c_str());
aee1aac6 2183 if ((Mode & ReadWrite) == 0)
ae635e3c 2184 return FileFdError("No openmode provided in FileFd::Open for %s", FileName.c_str());
468720c5 2185
cd46d4eb
DK
2186 unsigned int OpenMode = Mode;
2187 if (FileName == "/dev/null")
2188 OpenMode = OpenMode & ~(Atomic | Exclusive | Create | Empty);
2189
2190 if ((OpenMode & Atomic) == Atomic)
257e8d66
DK
2191 {
2192 Flags |= Replace;
257e8d66 2193 }
cd46d4eb 2194 else if ((OpenMode & (Exclusive | Create)) == (Exclusive | Create))
257e8d66
DK
2195 {
2196 // for atomic, this will be done by rename in Close()
ce1f3a2c 2197 RemoveFile("FileFd::Open", FileName);
257e8d66 2198 }
cd46d4eb 2199 if ((OpenMode & Empty) == Empty)
578bfd0a 2200 {
257e8d66
DK
2201 struct stat Buf;
2202 if (lstat(FileName.c_str(),&Buf) == 0 && S_ISLNK(Buf.st_mode))
ce1f3a2c 2203 RemoveFile("FileFd::Open", FileName);
257e8d66 2204 }
c4fc2fd7 2205
561f860a 2206 int fileflags = 0;
cd46d4eb 2207 #define if_FLAGGED_SET(FLAG, MODE) if ((OpenMode & FLAG) == FLAG) fileflags |= MODE
561f860a
DK
2208 if_FLAGGED_SET(ReadWrite, O_RDWR);
2209 else if_FLAGGED_SET(ReadOnly, O_RDONLY);
2210 else if_FLAGGED_SET(WriteOnly, O_WRONLY);
4a9db827 2211
561f860a
DK
2212 if_FLAGGED_SET(Create, O_CREAT);
2213 if_FLAGGED_SET(Empty, O_TRUNC);
2214 if_FLAGGED_SET(Exclusive, O_EXCL);
561f860a 2215 #undef if_FLAGGED_SET
52b47296 2216
cd46d4eb 2217 if ((OpenMode & Atomic) == Atomic)
7335eebe
AGM
2218 {
2219 char *name = strdup((FileName + ".XXXXXX").c_str());
2220
dc545c0b 2221 if((iFd = mkstemp(name)) == -1)
7335eebe
AGM
2222 {
2223 free(name);
98b69f9d 2224 return FileFdErrno("mkstemp", "Could not create temporary file for %s", FileName.c_str());
7335eebe
AGM
2225 }
2226
2227 TemporaryFileName = string(name);
7335eebe 2228 free(name);
dc545c0b 2229
230e69d7
DK
2230 // umask() will always set the umask and return the previous value, so
2231 // we first set the umask and then reset it to the old value
2232 mode_t const CurrentUmask = umask(0);
2233 umask(CurrentUmask);
2234 // calculate the actual file permissions (just like open/creat)
2235 mode_t const FilePermissions = (AccessMode & ~CurrentUmask);
2236
2237 if(fchmod(iFd, FilePermissions) == -1)
dc545c0b 2238 return FileFdErrno("fchmod", "Could not change permissions for temporary file %s", TemporaryFileName.c_str());
7335eebe 2239 }
468720c5 2240 else
230e69d7 2241 iFd = open(FileName.c_str(), fileflags, AccessMode);
468720c5 2242
b711c01e 2243 this->FileName = FileName;
cd46d4eb 2244 if (iFd == -1 || OpenInternDescriptor(OpenMode, compressor) == false)
561f860a 2245 {
468720c5 2246 if (iFd != -1)
fc81e8f2 2247 {
561f860a
DK
2248 close (iFd);
2249 iFd = -1;
fc81e8f2 2250 }
ae635e3c 2251 return FileFdErrno("open",_("Could not open file %s"), FileName.c_str());
257e8d66 2252 }
578bfd0a 2253
13d87e2e
AL
2254 SetCloseExec(iFd,true);
2255 return true;
578bfd0a 2256}
257e8d66
DK
2257 /*}}}*/
2258// FileFd::OpenDescriptor - Open a filedescriptor /*{{{*/
52b47296 2259bool FileFd::OpenDescriptor(int Fd, unsigned int const Mode, CompressMode Compress, bool AutoClose)
aee1aac6
DK
2260{
2261 std::vector<APT::Configuration::Compressor> const compressors = APT::Configuration::getCompressors();
2262 std::vector<APT::Configuration::Compressor>::const_iterator compressor = compressors.begin();
2263 std::string name;
bce778a3
MV
2264
2265 // compat with the old API
2266 if (Mode == ReadOnlyGzip && Compress == None)
2267 Compress = Gzip;
2268
aee1aac6
DK
2269 switch (Compress)
2270 {
2271 case None: name = "."; break;
2272 case Gzip: name = "gzip"; break;
2273 case Bzip2: name = "bzip2"; break;
2274 case Lzma: name = "lzma"; break;
2275 case Xz: name = "xz"; break;
e3fbd54c 2276 case Lz4: name = "lz4"; break;
aee1aac6
DK
2277 case Auto:
2278 case Extension:
f97bb523
DK
2279 if (AutoClose == true && Fd != -1)
2280 close(Fd);
ae635e3c 2281 return FileFdError("Opening Fd %d in Auto or Extension compression mode is not supported", Fd);
aee1aac6
DK
2282 }
2283 for (; compressor != compressors.end(); ++compressor)
2284 if (compressor->Name == name)
2285 break;
2286 if (compressor == compressors.end())
f97bb523
DK
2287 {
2288 if (AutoClose == true && Fd != -1)
2289 close(Fd);
ae635e3c 2290 return FileFdError("Can't find a configured compressor %s for file %s", name.c_str(), FileName.c_str());
f97bb523 2291 }
aee1aac6
DK
2292 return OpenDescriptor(Fd, Mode, *compressor, AutoClose);
2293}
52b47296 2294bool FileFd::OpenDescriptor(int Fd, unsigned int const Mode, APT::Configuration::Compressor const &compressor, bool AutoClose)
144c0969
JAK
2295{
2296 Close();
2297 Flags = (AutoClose) ? FileFd::AutoClose : 0;
84baaae9 2298 iFd = Fd;
b711c01e 2299 this->FileName = "";
84baaae9 2300 if (OpenInternDescriptor(Mode, compressor) == false)
468720c5 2301 {
f97bb523 2302 if (iFd != -1 && (
84baaae9 2303 (Flags & Compressed) == Compressed ||
f97bb523
DK
2304 AutoClose == true))
2305 {
468720c5 2306 close (iFd);
f97bb523
DK
2307 iFd = -1;
2308 }
2309 return FileFdError(_("Could not open file descriptor %d"), Fd);
144c0969 2310 }
144c0969 2311 return true;
468720c5 2312}
52b47296 2313bool FileFd::OpenInternDescriptor(unsigned int const Mode, APT::Configuration::Compressor const &compressor)
468720c5 2314{
84baaae9
DK
2315 if (iFd == -1)
2316 return false;
ff477ee1 2317
fa89055f
DK
2318 if (d != nullptr)
2319 d->InternalClose(FileName);
2320
2321 if (d == nullptr)
2322 {
2323 if (false)
2324 /* dummy so that the rest can be 'else if's */;
2325#define APT_COMPRESS_INIT(NAME, CONSTRUCTOR) \
2326 else if (compressor.Name == NAME) \
2327 d = new CONSTRUCTOR(this)
69d6988a 2328#ifdef HAVE_ZLIB
fa89055f 2329 APT_COMPRESS_INIT("gzip", GzipFileFdPrivate);
69d6988a
DK
2330#endif
2331#ifdef HAVE_BZ2
fa89055f 2332 APT_COMPRESS_INIT("bzip2", Bz2FileFdPrivate);
69d6988a 2333#endif
7f350a37 2334#ifdef HAVE_LZMA
fa89055f
DK
2335 APT_COMPRESS_INIT("xz", LzmaFileFdPrivate);
2336 APT_COMPRESS_INIT("lzma", LzmaFileFdPrivate);
7f350a37 2337#endif
e3fbd54c
JAK
2338#ifdef HAVE_LZ4
2339 APT_COMPRESS_INIT("lz4", Lz4FileFdPrivate);
2340#endif
69d6988a 2341#undef APT_COMPRESS_INIT
fa89055f
DK
2342 else if (compressor.Name == "." || compressor.Binary.empty() == true)
2343 d = new DirectFileFdPrivate(this);
2344 else
2345 d = new PipedFileFdPrivate(this);
69d6988a 2346
88749b5d
JAK
2347 if (Mode & BufferedWrite)
2348 d = new BufferedWriteFileFdPrivate(d);
2349
1d68256d
JAK
2350 d->set_openmode(Mode);
2351 d->set_compressor(compressor);
fa89055f 2352 if ((Flags & AutoClose) != AutoClose && d->InternalAlwaysAutoClose())
84baaae9
DK
2353 {
2354 // Need to duplicate fd here or gz/bz2 close for cleanup will close the fd as well
2355 int const internFd = dup(iFd);
2356 if (internFd == -1)
2357 return FileFdErrno("OpenInternDescriptor", _("Could not open file descriptor %d"), iFd);
2358 iFd = internFd;
2359 }
561f860a 2360 }
fa89055f 2361 return d->InternalOpen(iFd, Mode);
144c0969 2362}
578bfd0a 2363 /*}}}*/
8e06abb2 2364// FileFd::~File - Closes the file /*{{{*/
578bfd0a
AL
2365// ---------------------------------------------------------------------
2366/* If the proper modes are selected then we close the Fd and possibly
2367 unlink the file on error. */
8e06abb2 2368FileFd::~FileFd()
578bfd0a
AL
2369{
2370 Close();
500400fe 2371 if (d != NULL)
fa89055f 2372 d->InternalClose(FileName);
96ab3c6f
MV
2373 delete d;
2374 d = NULL;
578bfd0a
AL
2375}
2376 /*}}}*/
8e06abb2 2377// FileFd::Read - Read a bit of the file /*{{{*/
578bfd0a 2378// ---------------------------------------------------------------------
1e3f4083 2379/* We are careful to handle interruption by a signal while reading
b0db36b1 2380 gracefully. */
650faab0 2381bool FileFd::Read(void *To,unsigned long long Size,unsigned long long *Actual)
578bfd0a 2382{
fa89055f
DK
2383 if (d == nullptr)
2384 return false;
39e77e45 2385 ssize_t Res = 1;
b0db36b1 2386 errno = 0;
f604cf55
AL
2387 if (Actual != 0)
2388 *Actual = 0;
699b209e 2389 *((char *)To) = '\0';
39e77e45 2390 while (Res > 0 && Size > 0)
578bfd0a 2391 {
fa89055f 2392 Res = d->InternalRead(To, Size);
b711c01e 2393
b0db36b1
AL
2394 if (Res < 0)
2395 {
b711c01e 2396 if (errno == EINTR)
c4b113e6
DK
2397 {
2398 // trick the while-loop into running again
2399 Res = 1;
2400 errno = 0;
b711c01e 2401 continue;
c4b113e6 2402 }
fa89055f 2403 return d->InternalReadError();
b0db36b1 2404 }
578bfd0a 2405
b0db36b1
AL
2406 To = (char *)To + Res;
2407 Size -= Res;
ff477ee1 2408 if (d != NULL)
1d68256d 2409 d->set_seekpos(d->get_seekpos() + Res);
f604cf55
AL
2410 if (Actual != 0)
2411 *Actual += Res;
b0db36b1 2412 }
b0db36b1
AL
2413
2414 if (Size == 0)
2415 return true;
2416
ddc1d8d0 2417 // Eof handling
f604cf55 2418 if (Actual != 0)
ddc1d8d0
AL
2419 {
2420 Flags |= HitEof;
2421 return true;
2422 }
ae635e3c
DK
2423
2424 return FileFdError(_("read, still have %llu to read but none left"), Size);
578bfd0a
AL
2425}
2426 /*}}}*/
032bd56f
DK
2427// FileFd::ReadLine - Read a complete line from the file /*{{{*/
2428// ---------------------------------------------------------------------
fa89055f 2429/* Beware: This method can be quite slow for big buffers on UNcompressed
032bd56f
DK
2430 files because of the naive implementation! */
2431char* FileFd::ReadLine(char *To, unsigned long long const Size)
2432{
699b209e 2433 *To = '\0';
fa89055f
DK
2434 if (d == nullptr)
2435 return nullptr;
2436 return d->InternalReadLine(To, Size);
032bd56f
DK
2437}
2438 /*}}}*/
766761fd
JAK
2439// FileFd::Flush - Flush the file /*{{{*/
2440bool FileFd::Flush()
2441{
2442 if (d == nullptr)
2443 return true;
2444
2445 return d->InternalFlush();
2446}
2447 /*}}}*/
8e06abb2 2448// FileFd::Write - Write to the file /*{{{*/
650faab0 2449bool FileFd::Write(const void *From,unsigned long long Size)
578bfd0a 2450{
fa89055f
DK
2451 if (d == nullptr)
2452 return false;
5df91bc7 2453 ssize_t Res = 1;
b0db36b1 2454 errno = 0;
5df91bc7 2455 while (Res > 0 && Size > 0)
578bfd0a 2456 {
fa89055f 2457 Res = d->InternalWrite(From, Size);
9a63c3f4 2458
b0db36b1 2459 if (Res < 0)
9a63c3f4
CW
2460 {
2461 if (errno == EINTR)
2462 {
2463 // trick the while-loop into running again
2464 Res = 1;
2465 errno = 0;
2466 continue;
2467 }
fa89055f 2468 return d->InternalWriteError();
9a63c3f4 2469 }
fa89055f 2470
cf4ff3b7 2471 From = (char const *)From + Res;
b0db36b1 2472 Size -= Res;
ff477ee1 2473 if (d != NULL)
1d68256d 2474 d->set_seekpos(d->get_seekpos() + Res);
578bfd0a 2475 }
fa89055f 2476
b0db36b1
AL
2477 if (Size == 0)
2478 return true;
ae635e3c
DK
2479
2480 return FileFdError(_("write, still have %llu to write but couldn't"), Size);
d68d65ad
DK
2481}
2482bool FileFd::Write(int Fd, const void *From, unsigned long long Size)
2483{
5df91bc7 2484 ssize_t Res = 1;
d68d65ad 2485 errno = 0;
5df91bc7 2486 while (Res > 0 && Size > 0)
d68d65ad
DK
2487 {
2488 Res = write(Fd,From,Size);
2489 if (Res < 0 && errno == EINTR)
2490 continue;
2491 if (Res < 0)
2492 return _error->Errno("write",_("Write error"));
2493
cf4ff3b7 2494 From = (char const *)From + Res;
d68d65ad
DK
2495 Size -= Res;
2496 }
d68d65ad
DK
2497
2498 if (Size == 0)
2499 return true;
2500
2501 return _error->Error(_("write, still have %llu to write but couldn't"), Size);
578bfd0a
AL
2502}
2503 /*}}}*/
8e06abb2 2504// FileFd::Seek - Seek in the file /*{{{*/
650faab0 2505bool FileFd::Seek(unsigned long long To)
578bfd0a 2506{
fa89055f
DK
2507 if (d == nullptr)
2508 return false;
bb93178b 2509 Flags &= ~HitEof;
fa89055f 2510 return d->InternalSeek(To);
727f18af
AL
2511}
2512 /*}}}*/
fa89055f 2513// FileFd::Skip - Skip over data in the file /*{{{*/
650faab0 2514bool FileFd::Skip(unsigned long long Over)
727f18af 2515{
fa89055f
DK
2516 if (d == nullptr)
2517 return false;
2518 return d->InternalSkip(Over);
6d5dd02a
AL
2519}
2520 /*}}}*/
fa89055f 2521// FileFd::Truncate - Truncate the file /*{{{*/
650faab0 2522bool FileFd::Truncate(unsigned long long To)
6d5dd02a 2523{
fa89055f
DK
2524 if (d == nullptr)
2525 return false;
ad5051ef
DK
2526 // truncating /dev/null is always successful - as we get an error otherwise
2527 if (To == 0 && FileName == "/dev/null")
2528 return true;
fa89055f 2529 return d->InternalTruncate(To);
578bfd0a
AL
2530}
2531 /*}}}*/
7f25bdff
AL
2532// FileFd::Tell - Current seek position /*{{{*/
2533// ---------------------------------------------------------------------
2534/* */
650faab0 2535unsigned long long FileFd::Tell()
7f25bdff 2536{
fa89055f
DK
2537 if (d == nullptr)
2538 return false;
2539 off_t const Res = d->InternalTell();
7f25bdff 2540 if (Res == (off_t)-1)
ae635e3c 2541 FileFdErrno("lseek","Failed to determine the current file position");
1d68256d 2542 d->set_seekpos(Res);
7f25bdff
AL
2543 return Res;
2544}
2545 /*}}}*/
8190b07a 2546static bool StatFileFd(char const * const msg, int const iFd, std::string const &FileName, struct stat &Buf, FileFdPrivate * const d) /*{{{*/
578bfd0a 2547{
1d68256d 2548 bool ispipe = (d != NULL && d->get_is_pipe() == true);
6008b79a
DK
2549 if (ispipe == false)
2550 {
2551 if (fstat(iFd,&Buf) != 0)
8190b07a
DK
2552 // higher-level code will generate more meaningful messages,
2553 // even translated this would be meaningless for users
2554 return _error->Errno("fstat", "Unable to determine %s for fd %i", msg, iFd);
003c40d3
DK
2555 if (FileName.empty() == false)
2556 ispipe = S_ISFIFO(Buf.st_mode);
6008b79a 2557 }
699b209e
DK
2558
2559 // for compressor pipes st_size is undefined and at 'best' zero
6008b79a 2560 if (ispipe == true)
699b209e
DK
2561 {
2562 // we set it here, too, as we get the info here for free
2563 // in theory the Open-methods should take care of it already
ff477ee1 2564 if (d != NULL)
1d68256d 2565 d->set_is_pipe(true);
699b209e 2566 if (stat(FileName.c_str(), &Buf) != 0)
8190b07a
DK
2567 return _error->Errno("fstat", "Unable to determine %s for file %s", msg, FileName.c_str());
2568 }
2569 return true;
2570}
2571 /*}}}*/
2572// FileFd::FileSize - Return the size of the file /*{{{*/
2573unsigned long long FileFd::FileSize()
2574{
2575 struct stat Buf;
2576 if (StatFileFd("file size", iFd, FileName, Buf, d) == false)
2577 {
2578 Flags |= Fail;
2579 return 0;
699b209e 2580 }
4260fd39
DK
2581 return Buf.st_size;
2582}
2583 /*}}}*/
8190b07a
DK
2584// FileFd::ModificationTime - Return the time of last touch /*{{{*/
2585time_t FileFd::ModificationTime()
2586{
2587 struct stat Buf;
2588 if (StatFileFd("modification time", iFd, FileName, Buf, d) == false)
2589 {
2590 Flags |= Fail;
2591 return 0;
2592 }
2593 return Buf.st_mtime;
2594}
2595 /*}}}*/
4260fd39 2596// FileFd::Size - Return the size of the content in the file /*{{{*/
650faab0 2597unsigned long long FileFd::Size()
4260fd39 2598{
fa89055f
DK
2599 if (d == nullptr)
2600 return false;
2601 return d->InternalSize();
578bfd0a
AL
2602}
2603 /*}}}*/
8e06abb2 2604// FileFd::Close - Close the file if the close flag is set /*{{{*/
578bfd0a
AL
2605// ---------------------------------------------------------------------
2606/* */
8e06abb2 2607bool FileFd::Close()
578bfd0a 2608{
f43dd439 2609 if (Failed() == false && Flush() == false)
766761fd 2610 return false;
032bd56f
DK
2611 if (iFd == -1)
2612 return true;
2613
578bfd0a
AL
2614 bool Res = true;
2615 if ((Flags & AutoClose) == AutoClose)
d13c2d3f 2616 {
500400fe
DK
2617 if ((Flags & Compressed) != Compressed && iFd > 0 && close(iFd) != 0)
2618 Res &= _error->Errno("close",_("Problem closing the file %s"), FileName.c_str());
2da8aae5
JAK
2619 }
2620
2621 if (d != NULL)
2622 {
fa89055f 2623 Res &= d->InternalClose(FileName);
2da8aae5
JAK
2624 delete d;
2625 d = NULL;
d13c2d3f 2626 }
3010fb0e 2627
d3aac32e 2628 if ((Flags & Replace) == Replace) {
fc5db01b 2629 if (Failed() == false && rename(TemporaryFileName.c_str(), FileName.c_str()) != 0)
62d073d9
DK
2630 Res &= _error->Errno("rename",_("Problem renaming the file %s to %s"), TemporaryFileName.c_str(), FileName.c_str());
2631
fd3b761e 2632 FileName = TemporaryFileName; // for the unlink() below.
257e8d66 2633 TemporaryFileName.clear();
3010fb0e 2634 }
62d073d9
DK
2635
2636 iFd = -1;
2637
578bfd0a
AL
2638 if ((Flags & Fail) == Fail && (Flags & DelOnFail) == DelOnFail &&
2639 FileName.empty() == false)
ce1f3a2c 2640 Res &= RemoveFile("FileFd::Close", FileName);
3010fb0e 2641
fbb89d94
DK
2642 if (Res == false)
2643 Flags |= Fail;
578bfd0a
AL
2644 return Res;
2645}
2646 /*}}}*/
b2e465d6
AL
2647// FileFd::Sync - Sync the file /*{{{*/
2648// ---------------------------------------------------------------------
2649/* */
2650bool FileFd::Sync()
2651{
b2e465d6 2652 if (fsync(iFd) != 0)
ae635e3c
DK
2653 return FileFdErrno("sync",_("Problem syncing the file"));
2654 return true;
2655}
2656 /*}}}*/
2657// FileFd::FileFdErrno - set Fail and call _error->Errno *{{{*/
2658bool FileFd::FileFdErrno(const char *Function, const char *Description,...)
2659{
2660 Flags |= Fail;
2661 va_list args;
2662 size_t msgSize = 400;
2663 int const errsv = errno;
2664 while (true)
fbb89d94 2665 {
ae635e3c
DK
2666 va_start(args,Description);
2667 if (_error->InsertErrno(GlobalError::ERROR, Function, Description, args, errsv, msgSize) == false)
2668 break;
2669 va_end(args);
fbb89d94 2670 }
ae635e3c
DK
2671 return false;
2672}
2673 /*}}}*/
2674// FileFd::FileFdError - set Fail and call _error->Error *{{{*/
2675bool FileFd::FileFdError(const char *Description,...) {
2676 Flags |= Fail;
2677 va_list args;
2678 size_t msgSize = 400;
2679 while (true)
2680 {
2681 va_start(args,Description);
2682 if (_error->Insert(GlobalError::ERROR, Description, args, msgSize) == false)
2683 break;
2684 va_end(args);
2685 }
2686 return false;
b2e465d6
AL
2687}
2688 /*}}}*/
fa89055f 2689gzFile FileFd::gzFd() { /*{{{*/
7f350a37 2690#ifdef HAVE_ZLIB
fa89055f
DK
2691 GzipFileFdPrivate * const gzipd = dynamic_cast<GzipFileFdPrivate*>(d);
2692 if (gzipd == nullptr)
2693 return nullptr;
2694 else
2695 return gzipd->gz;
7f350a37 2696#else
fa89055f 2697 return nullptr;
7f350a37
DK
2698#endif
2699}
fa89055f 2700 /*}}}*/
8d01b9d6 2701
f8aba23f 2702// Glob - wrapper around "glob()" /*{{{*/
8d01b9d6
MV
2703std::vector<std::string> Glob(std::string const &pattern, int flags)
2704{
2705 std::vector<std::string> result;
2706 glob_t globbuf;
ec4835a1
ÁGM
2707 int glob_res;
2708 unsigned int i;
8d01b9d6
MV
2709
2710 glob_res = glob(pattern.c_str(), flags, NULL, &globbuf);
2711
2712 if (glob_res != 0)
2713 {
2714 if(glob_res != GLOB_NOMATCH) {
2715 _error->Errno("glob", "Problem with glob");
2716 return result;
2717 }
2718 }
2719
2720 // append results
2721 for(i=0;i<globbuf.gl_pathc;i++)
2722 result.push_back(string(globbuf.gl_pathv[i]));
2723
2724 globfree(&globbuf);
2725 return result;
2726}
2727 /*}}}*/
f8aba23f 2728std::string GetTempDir() /*{{{*/
68e01721
MV
2729{
2730 const char *tmpdir = getenv("TMPDIR");
2731
2732#ifdef P_tmpdir
2733 if (!tmpdir)
2734 tmpdir = P_tmpdir;
2735#endif
2736
68e01721 2737 struct stat st;
0d303f17 2738 if (!tmpdir || strlen(tmpdir) == 0 || // tmpdir is set
dd6da7d2
DK
2739 stat(tmpdir, &st) != 0 || (st.st_mode & S_IFDIR) == 0) // exists and is directory
2740 tmpdir = "/tmp";
2741 else if (geteuid() != 0 && // root can do everything anyway
2742 faccessat(-1, tmpdir, R_OK | W_OK | X_OK, AT_EACCESS | AT_SYMLINK_NOFOLLOW) != 0) // current user has rwx access to directory
68e01721
MV
2743 tmpdir = "/tmp";
2744
2745 return string(tmpdir);
dd6da7d2
DK
2746}
2747std::string GetTempDir(std::string const &User)
2748{
2749 // no need/possibility to drop privs
2750 if(getuid() != 0 || User.empty() || User == "root")
2751 return GetTempDir();
2752
2753 struct passwd const * const pw = getpwnam(User.c_str());
2754 if (pw == NULL)
2755 return GetTempDir();
2756
226c0f64
DK
2757 gid_t const old_euid = geteuid();
2758 gid_t const old_egid = getegid();
dd6da7d2
DK
2759 if (setegid(pw->pw_gid) != 0)
2760 _error->Errno("setegid", "setegid %u failed", pw->pw_gid);
2761 if (seteuid(pw->pw_uid) != 0)
2762 _error->Errno("seteuid", "seteuid %u failed", pw->pw_uid);
2763
2764 std::string const tmp = GetTempDir();
2765
226c0f64
DK
2766 if (seteuid(old_euid) != 0)
2767 _error->Errno("seteuid", "seteuid %u failed", old_euid);
2768 if (setegid(old_egid) != 0)
2769 _error->Errno("setegid", "setegid %u failed", old_egid);
dd6da7d2
DK
2770
2771 return tmp;
68e01721 2772}
f8aba23f 2773 /*}}}*/
c9443c01 2774FileFd* GetTempFile(std::string const &Prefix, bool ImmediateUnlink, FileFd * const TmpFd) /*{{{*/
0d29b9d4
MV
2775{
2776 char fn[512];
c9443c01 2777 FileFd * const Fd = TmpFd == NULL ? new FileFd() : TmpFd;
0d29b9d4 2778
c9443c01
DK
2779 std::string const tempdir = GetTempDir();
2780 snprintf(fn, sizeof(fn), "%s/%s.XXXXXX",
0d29b9d4 2781 tempdir.c_str(), Prefix.c_str());
c9443c01 2782 int const fd = mkstemp(fn);
0d29b9d4
MV
2783 if(ImmediateUnlink)
2784 unlink(fn);
c9443c01 2785 if (fd < 0)
0d29b9d4
MV
2786 {
2787 _error->Errno("GetTempFile",_("Unable to mkstemp %s"), fn);
2788 return NULL;
2789 }
c9443c01 2790 if (!Fd->OpenDescriptor(fd, FileFd::ReadWrite, FileFd::None, true))
0d29b9d4
MV
2791 {
2792 _error->Errno("GetTempFile",_("Unable to write to %s"),fn);
2793 return NULL;
2794 }
0d29b9d4
MV
2795 return Fd;
2796}
f8aba23f
DK
2797 /*}}}*/
2798bool Rename(std::string From, std::string To) /*{{{*/
c1409d1b
MV
2799{
2800 if (rename(From.c_str(),To.c_str()) != 0)
2801 {
2802 _error->Error(_("rename failed, %s (%s -> %s)."),strerror(errno),
2803 From.c_str(),To.c_str());
2804 return false;
f8aba23f 2805 }
c1409d1b
MV
2806 return true;
2807}
f8aba23f
DK
2808 /*}}}*/
2809bool Popen(const char* Args[], FileFd &Fd, pid_t &Child, FileFd::OpenMode Mode)/*{{{*/
7ad2a347
MV
2810{
2811 int fd;
2812 if (Mode != FileFd::ReadOnly && Mode != FileFd::WriteOnly)
2813 return _error->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2814
2815 int Pipe[2] = {-1, -1};
2816 if(pipe(Pipe) != 0)
7ad2a347 2817 return _error->Errno("pipe", _("Failed to create subprocess IPC"));
5e49cbb7 2818
7ad2a347
MV
2819 std::set<int> keep_fds;
2820 keep_fds.insert(Pipe[0]);
2821 keep_fds.insert(Pipe[1]);
2822 Child = ExecFork(keep_fds);
2823 if(Child < 0)
2824 return _error->Errno("fork", "Failed to fork");
2825 if(Child == 0)
2826 {
2827 if(Mode == FileFd::ReadOnly)
2828 {
2829 close(Pipe[0]);
2830 fd = Pipe[1];
2831 }
2832 else if(Mode == FileFd::WriteOnly)
2833 {
2834 close(Pipe[1]);
2835 fd = Pipe[0];
2836 }
2837
2838 if(Mode == FileFd::ReadOnly)
2839 {
2840 dup2(fd, 1);
2841 dup2(fd, 2);
2842 } else if(Mode == FileFd::WriteOnly)
2843 dup2(fd, 0);
2844
2845 execv(Args[0], (char**)Args);
2846 _exit(100);
2847 }
2848 if(Mode == FileFd::ReadOnly)
2849 {
2850 close(Pipe[1]);
2851 fd = Pipe[0];
8f5b67ae
DK
2852 }
2853 else if(Mode == FileFd::WriteOnly)
7ad2a347
MV
2854 {
2855 close(Pipe[0]);
2856 fd = Pipe[1];
2857 }
8f5b67ae
DK
2858 else
2859 return _error->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
7ad2a347
MV
2860 Fd.OpenDescriptor(fd, Mode, FileFd::None, true);
2861
2862 return true;
2863}
f8aba23f
DK
2864 /*}}}*/
2865bool DropPrivileges() /*{{{*/
fc1a78d8 2866{
8f45798d
DK
2867 if(_config->FindB("Debug::NoDropPrivs", false) == true)
2868 return true;
2869
2870#if __gnu_linux__
2871#if defined(PR_SET_NO_NEW_PRIVS) && ( PR_SET_NO_NEW_PRIVS != 38 )
2872#error "PR_SET_NO_NEW_PRIVS is defined, but with a different value than expected!"
2873#endif
2874 // see prctl(2), needs linux3.5 at runtime - magic constant to avoid it at buildtime
2875 int ret = prctl(38, 1, 0, 0, 0);
2876 // ignore EINVAL - kernel is too old to understand the option
2877 if(ret < 0 && errno != EINVAL)
2878 _error->Warning("PR_SET_NO_NEW_PRIVS failed with %i", ret);
2879#endif
2880
990dd78a
DK
2881 // empty setting disables privilege dropping - this also ensures
2882 // backward compatibility, see bug #764506
2883 const std::string toUser = _config->Find("APT::Sandbox::User");
514a25cb 2884 if (toUser.empty() || toUser == "root")
990dd78a
DK
2885 return true;
2886
ebca2f25
DK
2887 // a lot can go wrong trying to drop privileges completely,
2888 // so ideally we would like to verify that we have done it –
2889 // but the verify asks for too much in case of fakeroot (and alike)
2890 // [Specific checks can be overridden with dedicated options]
2891 bool const VerifySandboxing = _config->FindB("APT::Sandbox::Verify", false);
2892
f1e3c8f0 2893 // uid will be 0 in the end, but gid might be different anyway
8f45798d
DK
2894 uid_t const old_uid = getuid();
2895 gid_t const old_gid = getgid();
fc1a78d8 2896
5f2047ec
JAK
2897 if (old_uid != 0)
2898 return true;
3927c6da 2899
b8dae9a1 2900 struct passwd *pw = getpwnam(toUser.c_str());
fc1a78d8 2901 if (pw == NULL)
b8dae9a1 2902 return _error->Error("No user %s, can not drop rights", toUser.c_str());
3927c6da 2903
f1e3c8f0 2904 // Do not change the order here, it might break things
5a326439 2905 // Get rid of all our supplementary groups first
3b084f06 2906 if (setgroups(1, &pw->pw_gid))
3927c6da
MV
2907 return _error->Errno("setgroups", "Failed to setgroups");
2908
5a326439
JAK
2909 // Now change the group ids to the new user
2910#ifdef HAVE_SETRESGID
2911 if (setresgid(pw->pw_gid, pw->pw_gid, pw->pw_gid) != 0)
2912 return _error->Errno("setresgid", "Failed to set new group ids");
2913#else
3927c6da 2914 if (setegid(pw->pw_gid) != 0)
5f2047ec
JAK
2915 return _error->Errno("setegid", "Failed to setegid");
2916
fc1a78d8
MV
2917 if (setgid(pw->pw_gid) != 0)
2918 return _error->Errno("setgid", "Failed to setgid");
5a326439 2919#endif
5f2047ec 2920
5a326439
JAK
2921 // Change the user ids to the new user
2922#ifdef HAVE_SETRESUID
2923 if (setresuid(pw->pw_uid, pw->pw_uid, pw->pw_uid) != 0)
2924 return _error->Errno("setresuid", "Failed to set new user ids");
2925#else
fc1a78d8
MV
2926 if (setuid(pw->pw_uid) != 0)
2927 return _error->Errno("setuid", "Failed to setuid");
5f2047ec
JAK
2928 if (seteuid(pw->pw_uid) != 0)
2929 return _error->Errno("seteuid", "Failed to seteuid");
5a326439 2930#endif
5f2047ec 2931
ebca2f25
DK
2932 // disabled by default as fakeroot doesn't implement getgroups currently (#806521)
2933 if (VerifySandboxing == true || _config->FindB("APT::Sandbox::Verify::Groups", false) == true)
2934 {
2935 // Verify that the user isn't still in any supplementary groups
2936 long const ngroups_max = sysconf(_SC_NGROUPS_MAX);
2937 std::unique_ptr<gid_t[]> gidlist(new gid_t[ngroups_max]);
2938 if (unlikely(gidlist == NULL))
2939 return _error->Error("Allocation of a list of size %lu for getgroups failed", ngroups_max);
2940 ssize_t gidlist_nr;
2941 if ((gidlist_nr = getgroups(ngroups_max, gidlist.get())) < 0)
2942 return _error->Errno("getgroups", "Could not get new groups (%lu)", ngroups_max);
2943 for (ssize_t i = 0; i < gidlist_nr; ++i)
2944 if (gidlist[i] != pw->pw_gid)
2945 return _error->Error("Could not switch group, user %s is still in group %d", toUser.c_str(), gidlist[i]);
2946 }
2947
2948 // enabled by default as all fakeroot-lookalikes should fake that accordingly
2949 if (VerifySandboxing == true || _config->FindB("APT::Sandbox::Verify::IDs", true) == true)
2950 {
2951 // Verify that gid, egid, uid, and euid changed
2952 if (getgid() != pw->pw_gid)
2953 return _error->Error("Could not switch group");
2954 if (getegid() != pw->pw_gid)
2955 return _error->Error("Could not switch effective group");
2956 if (getuid() != pw->pw_uid)
2957 return _error->Error("Could not switch user");
2958 if (geteuid() != pw->pw_uid)
2959 return _error->Error("Could not switch effective user");
5f2047ec 2960
550ab420 2961#ifdef HAVE_GETRESUID
ebca2f25
DK
2962 // verify that the saved set-user-id was changed as well
2963 uid_t ruid = 0;
2964 uid_t euid = 0;
2965 uid_t suid = 0;
2966 if (getresuid(&ruid, &euid, &suid))
2967 return _error->Errno("getresuid", "Could not get saved set-user-ID");
2968 if (suid != pw->pw_uid)
2969 return _error->Error("Could not switch saved set-user-ID");
550ab420
JAK
2970#endif
2971
2972#ifdef HAVE_GETRESGID
ebca2f25
DK
2973 // verify that the saved set-group-id was changed as well
2974 gid_t rgid = 0;
2975 gid_t egid = 0;
2976 gid_t sgid = 0;
2977 if (getresgid(&rgid, &egid, &sgid))
2978 return _error->Errno("getresuid", "Could not get saved set-group-ID");
2979 if (sgid != pw->pw_gid)
2980 return _error->Error("Could not switch saved set-group-ID");
550ab420 2981#endif
ebca2f25 2982 }
550ab420 2983
ebca2f25
DK
2984 // disabled as fakeroot doesn't forbid (by design) (re)gaining root from unprivileged
2985 if (VerifySandboxing == true || _config->FindB("APT::Sandbox::Verify::Regain", false) == true)
2986 {
2987 // Check that uid and gid changes do not work anymore
2988 if (pw->pw_gid != old_gid && (setgid(old_gid) != -1 || setegid(old_gid) != -1))
2989 return _error->Error("Could restore a gid to root, privilege dropping did not work");
bdc00df5 2990
ebca2f25
DK
2991 if (pw->pw_uid != old_uid && (setuid(old_uid) != -1 || seteuid(old_uid) != -1))
2992 return _error->Error("Could restore a uid to root, privilege dropping did not work");
2993 }
bdc00df5 2994
fc1a78d8
MV
2995 return true;
2996}
f8aba23f 2997 /*}}}*/