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