]> git.saurik.com Git - apt.git/blame - apt-pkg/contrib/fileutl.cc
FileFd: Add a buffered writing mode
[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
38dba8cd
JAK
922struct APT_HIDDEN simple_buffer { /*{{{*/
923 static constexpr size_t buffersize_max = 4096;
924 unsigned long long bufferstart = 0;
925 unsigned long long bufferend = 0;
926 char buffer[buffersize_max];
927
ea58d39e 928 const char *get() const { return buffer + bufferstart; }
38dba8cd 929 char *get() { return buffer + bufferstart; }
ea58d39e 930 bool empty() const { return bufferend <= bufferstart; }
c368b3ab 931 bool full() const { return bufferend == buffersize_max; }
ea58d39e 932 unsigned long long size() const { return bufferend-bufferstart; }
38dba8cd
JAK
933 void reset() { bufferend = bufferstart = 0; }
934 ssize_t read(void *to, unsigned long long requested_size) APT_MUSTCHECK
935 {
936 if (size() < requested_size)
937 requested_size = size();
938 memcpy(to, buffer + bufferstart, requested_size);
939 bufferstart += requested_size;
940 if (bufferstart == bufferend)
941 bufferstart = bufferend = 0;
942 return requested_size;
943 }
c368b3ab
JAK
944 ssize_t write(const void *from, unsigned long long requested_size) APT_MUSTCHECK
945 {
946 if (buffersize_max - size() < requested_size)
947 requested_size = buffersize_max - size();
948 memcpy(buffer + bufferend, from, requested_size);
949 bufferend += requested_size;
950 if (bufferstart == bufferend)
951 bufferstart = bufferend = 0;
952 return requested_size;
953 }
38dba8cd
JAK
954};
955 /*}}}*/
956
65ac6aad 957class APT_HIDDEN FileFdPrivate { /*{{{*/
88749b5d 958 friend class BufferedWriteFileFdPrivate;
fa89055f
DK
959protected:
960 FileFd * const filefd;
38dba8cd 961 simple_buffer buffer;
fa89055f
DK
962 int compressed_fd;
963 pid_t compressor_pid;
964 bool is_pipe;
965 APT::Configuration::Compressor compressor;
966 unsigned int openmode;
967 unsigned long long seekpos;
1d68256d
JAK
968public:
969
83e22e26 970 explicit FileFdPrivate(FileFd * const pfilefd) : filefd(pfilefd),
fa89055f
DK
971 compressed_fd(-1), compressor_pid(-1), is_pipe(false),
972 openmode(0), seekpos(0) {};
1d68256d
JAK
973 virtual APT::Configuration::Compressor get_compressor() const
974 {
975 return compressor;
976 }
977 virtual void set_compressor(APT::Configuration::Compressor const &compressor)
978 {
979 this->compressor = compressor;
980 }
981 virtual unsigned int get_openmode() const
982 {
983 return openmode;
984 }
985 virtual void set_openmode(unsigned int openmode)
986 {
987 this->openmode = openmode;
988 }
989 virtual bool get_is_pipe() const
990 {
991 return is_pipe;
992 }
993 virtual void set_is_pipe(bool is_pipe)
994 {
995 this->is_pipe = is_pipe;
996 }
997 virtual unsigned long long get_seekpos() const
998 {
999 return seekpos;
1000 }
1001 virtual void set_seekpos(unsigned long long seekpos)
1002 {
1003 this->seekpos = seekpos;
1004 }
fa89055f
DK
1005
1006 virtual bool InternalOpen(int const iFd, unsigned int const Mode) = 0;
f63123c3 1007 ssize_t InternalRead(void * To, unsigned long long Size)
fa89055f 1008 {
83e22e26
JAK
1009 // Drain the buffer if needed.
1010 if (buffer.empty() == false)
fa89055f 1011 {
83e22e26 1012 return buffer.read(To, Size);
fa89055f 1013 }
83e22e26 1014 return InternalUnbufferedRead(To, Size);
f63123c3
DK
1015 }
1016 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) = 0;
1017 virtual bool InternalReadError() { return filefd->FileFdErrno("read",_("Read error")); }
1018 virtual char * InternalReadLine(char * To, unsigned long long Size)
1019 {
1020 if (unlikely(Size == 0))
1021 return nullptr;
01152444 1022 // Read one byte less than buffer size to have space for trailing 0.
f63123c3 1023 --Size;
01152444 1024
f63123c3
DK
1025 char * const InitialTo = To;
1026
01152444 1027 while (Size > 0) {
83e22e26 1028 if (buffer.empty() == true)
f63123c3 1029 {
83e22e26 1030 buffer.reset();
f63123c3 1031 unsigned long long actualread = 0;
83e22e26 1032 if (filefd->Read(buffer.get(), buffer.buffersize_max, &actualread) == false)
f63123c3 1033 return nullptr;
83e22e26
JAK
1034 buffer.bufferend = actualread;
1035 if (buffer.size() == 0)
f63123c3
DK
1036 {
1037 if (To == InitialTo)
1038 return nullptr;
1039 break;
1040 }
1041 filefd->Flags &= ~FileFd::HitEof;
1042 }
1043
83e22e26 1044 unsigned long long const OutputSize = std::min(Size, buffer.size());
b3db9d81 1045 char const * const newline = static_cast<char const * const>(memchr(buffer.get(), '\n', OutputSize));
a9024b1b
JAK
1046 // Read until end of line or up to Size bytes from the buffer.
1047 unsigned long long actualread = buffer.read(To,
1048 (newline != nullptr)
1049 ? (newline - buffer.get()) + 1
1050 : OutputSize);
1051 To += actualread;
1052 Size -= actualread;
f63123c3 1053 if (newline != nullptr)
f63123c3 1054 break;
01152444 1055 }
f63123c3
DK
1056 *To = '\0';
1057 return InitialTo;
fa89055f 1058 }
766761fd
JAK
1059 virtual bool InternalFlush()
1060 {
1061 return true;
1062 }
fa89055f
DK
1063 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) = 0;
1064 virtual bool InternalWriteError() { return filefd->FileFdErrno("write",_("Write error")); }
1065 virtual bool InternalSeek(unsigned long long const To)
1066 {
1067 // Our poor man seeking is costly, so try to avoid it
1068 unsigned long long const iseekpos = filefd->Tell();
1069 if (iseekpos == To)
1070 return true;
1071 else if (iseekpos < To)
1072 return filefd->Skip(To - iseekpos);
1073
1074 if ((openmode & FileFd::ReadOnly) != FileFd::ReadOnly)
1075 return filefd->FileFdError("Reopen is only implemented for read-only files!");
1076 InternalClose(filefd->FileName);
1077 if (filefd->iFd != -1)
1078 close(filefd->iFd);
1079 filefd->iFd = -1;
1080 if (filefd->TemporaryFileName.empty() == false)
1081 filefd->iFd = open(filefd->TemporaryFileName.c_str(), O_RDONLY);
1082 else if (filefd->FileName.empty() == false)
1083 filefd->iFd = open(filefd->FileName.c_str(), O_RDONLY);
1084 else
1085 {
1086 if (compressed_fd > 0)
1087 if (lseek(compressed_fd, 0, SEEK_SET) != 0)
1088 filefd->iFd = compressed_fd;
1089 if (filefd->iFd < 0)
1090 return filefd->FileFdError("Reopen is not implemented for pipes opened with FileFd::OpenDescriptor()!");
1091 }
1092
1093 if (filefd->OpenInternDescriptor(openmode, compressor) == false)
1094 return filefd->FileFdError("Seek on file %s because it couldn't be reopened", filefd->FileName.c_str());
1095
83e22e26 1096 buffer.reset();
fa89055f
DK
1097 if (To != 0)
1098 return filefd->Skip(To);
1099
1100 seekpos = To;
1101 return true;
1102 }
1103 virtual bool InternalSkip(unsigned long long Over)
1104 {
1105 unsigned long long constexpr buffersize = 1024;
1106 char buffer[buffersize];
1107 while (Over != 0)
1108 {
1109 unsigned long long toread = std::min(buffersize, Over);
1110 if (filefd->Read(buffer, toread) == false)
1111 return filefd->FileFdError("Unable to seek ahead %llu",Over);
1112 Over -= toread;
1113 }
1114 return true;
1115 }
1116 virtual bool InternalTruncate(unsigned long long const)
1117 {
1118 return filefd->FileFdError("Truncating compressed files is not implemented (%s)", filefd->FileName.c_str());
1119 }
1120 virtual unsigned long long InternalTell()
1121 {
1122 // In theory, we could just return seekpos here always instead of
1123 // seeking around, but not all users of FileFd use always Seek() and co
1124 // so d->seekpos isn't always true and we can just use it as a hint if
1125 // we have nothing else, but not always as an authority…
83e22e26 1126 return seekpos - buffer.size();
fa89055f
DK
1127 }
1128 virtual unsigned long long InternalSize()
1129 {
1130 unsigned long long size = 0;
1131 unsigned long long const oldSeek = filefd->Tell();
1132 unsigned long long constexpr ignoresize = 1024;
1133 char ignore[ignoresize];
1134 unsigned long long read = 0;
1135 do {
1136 if (filefd->Read(ignore, ignoresize, &read) == false)
1137 {
1138 filefd->Seek(oldSeek);
1139 return 0;
1140 }
1141 } while(read != 0);
1142 size = filefd->Tell();
1143 filefd->Seek(oldSeek);
1144 return size;
1145 }
1146 virtual bool InternalClose(std::string const &FileName) = 0;
1147 virtual bool InternalStream() const { return false; }
1148 virtual bool InternalAlwaysAutoClose() const { return true; }
1149
1150 virtual ~FileFdPrivate() {}
1151};
1152 /*}}}*/
88749b5d
JAK
1153class APT_HIDDEN BufferedWriteFileFdPrivate : public FileFdPrivate { /*{{{*/
1154protected:
1155 FileFdPrivate *wrapped;
1156 simple_buffer writebuffer;
1157
1158public:
1159
1160 explicit BufferedWriteFileFdPrivate(FileFdPrivate *Priv) :
1161 FileFdPrivate(Priv->filefd), wrapped(Priv) {};
1162
1163 virtual APT::Configuration::Compressor get_compressor() const override
1164 {
1165 return wrapped->get_compressor();
1166 }
1167 virtual void set_compressor(APT::Configuration::Compressor const &compressor) override
1168 {
1169 return wrapped->set_compressor(compressor);
1170 }
1171 virtual unsigned int get_openmode() const override
1172 {
1173 return wrapped->get_openmode();
1174 }
1175 virtual void set_openmode(unsigned int openmode) override
1176 {
1177 return wrapped->set_openmode(openmode);
1178 }
1179 virtual bool get_is_pipe() const override
1180 {
1181 return wrapped->get_is_pipe();
1182 }
1183 virtual void set_is_pipe(bool is_pipe) override
1184 {
1185 FileFdPrivate::set_is_pipe(is_pipe);
1186 wrapped->set_is_pipe(is_pipe);
1187 }
1188 virtual unsigned long long get_seekpos() const override
1189 {
1190 return wrapped->get_seekpos();
1191 }
1192 virtual void set_seekpos(unsigned long long seekpos) override
1193 {
1194 return wrapped->set_seekpos(seekpos);
1195 }
1196 virtual bool InternalOpen(int const iFd, unsigned int const Mode) override
1197 {
1198 if (InternalFlush() == false)
1199 return false;
1200 return wrapped->InternalOpen(iFd, Mode);
1201 }
1202 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) override
1203 {
1204 if (InternalFlush() == false)
1205 return -1;
1206 return wrapped->InternalUnbufferedRead(To, Size);
1207
1208 }
1209 virtual bool InternalReadError() override
1210 {
1211 return wrapped->InternalReadError();
1212 }
1213 virtual char * InternalReadLine(char * To, unsigned long long Size) override
1214 {
1215 if (InternalFlush() == false)
1216 return nullptr;
1217 return wrapped->InternalReadLine(To, Size);
1218 }
1219 virtual bool InternalFlush() override
1220 {
1221 size_t written = 0;
1222 char *data = writebuffer.get();
1223 auto size = writebuffer.size();
1224
1225 while (written <= size) {
1226 auto written_this_time = wrapped->InternalWrite(data + written, size - written);
1227 if (written_this_time < 0)
1228 return false;
1229 if (written_this_time == 0)
1230 break;
1231
1232 written += written_this_time;
1233 }
1234
1235 writebuffer.reset();
1236 return true;
1237 }
1238 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) override
1239 {
1240 size_t written = 0;
1241
1242 while (written < Size) {
1243 auto buffered = writebuffer.write(static_cast<char const*>(From) + written, Size - written);
1244
1245 written += buffered;
1246
1247 if (writebuffer.full() && InternalFlush() == false)
1248 return -1;
1249 }
1250
1251 return written;
1252 }
1253 virtual bool InternalWriteError()
1254 {
1255 return wrapped->InternalWriteError();
1256 }
1257 virtual bool InternalSeek(unsigned long long const To)
1258 {
1259 if (InternalFlush() == false)
1260 return false;
1261 return wrapped->InternalSeek(To);
1262 }
1263 virtual bool InternalSkip(unsigned long long Over)
1264 {
1265 if (InternalFlush() == false)
1266 return false;
1267 return wrapped->InternalSkip(Over);
1268 }
1269 virtual bool InternalTruncate(unsigned long long const Size)
1270 {
1271 if (InternalFlush() == false)
1272 return false;
1273 return wrapped->InternalTruncate(Size);
1274 }
1275 virtual unsigned long long InternalTell()
1276 {
1277 if (InternalFlush() == false)
1278 return -1;
1279 return wrapped->InternalTell();
1280 }
1281 virtual unsigned long long InternalSize()
1282 {
1283 if (InternalFlush() == false)
1284 return -1;
1285 return wrapped->InternalSize();
1286 }
1287 virtual bool InternalClose(std::string const &FileName)
1288 {
1289 return wrapped->InternalClose(FileName);
1290 }
1291 virtual bool InternalAlwaysAutoClose() const
1292 {
1293 return wrapped->InternalAlwaysAutoClose();
1294 }
1295 virtual ~BufferedWriteFileFdPrivate()
1296 {
1297 delete wrapped;
1298 }
1299};
1300 /*}}}*/
65ac6aad 1301class APT_HIDDEN GzipFileFdPrivate: public FileFdPrivate { /*{{{*/
4239dbca 1302#ifdef HAVE_ZLIB
fa89055f
DK
1303public:
1304 gzFile gz;
1305 virtual bool InternalOpen(int const iFd, unsigned int const Mode) override
1306 {
1307 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1308 gz = gzdopen(iFd, "r+");
1309 else if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1310 gz = gzdopen(iFd, "w");
1311 else
1312 gz = gzdopen(iFd, "r");
1313 filefd->Flags |= FileFd::Compressed;
1314 return gz != nullptr;
1315 }
f63123c3 1316 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) override
fa89055f
DK
1317 {
1318 return gzread(gz, To, Size);
1319 }
1320 virtual bool InternalReadError() override
1321 {
1322 int err;
1323 char const * const errmsg = gzerror(gz, &err);
1324 if (err != Z_ERRNO)
1325 return filefd->FileFdError("gzread: %s (%d: %s)", _("Read error"), err, errmsg);
1326 return FileFdPrivate::InternalReadError();
1327 }
f63123c3 1328 virtual char * InternalReadLine(char * To, unsigned long long Size) override
fa89055f
DK
1329 {
1330 return gzgets(gz, To, Size);
1331 }
1332 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) override
1333 {
1334 return gzwrite(gz,From,Size);
1335 }
1336 virtual bool InternalWriteError() override
1337 {
1338 int err;
1339 char const * const errmsg = gzerror(gz, &err);
1340 if (err != Z_ERRNO)
1341 return filefd->FileFdError("gzwrite: %s (%d: %s)", _("Write error"), err, errmsg);
1342 return FileFdPrivate::InternalWriteError();
1343 }
1344 virtual bool InternalSeek(unsigned long long const To) override
1345 {
1346 off_t const res = gzseek(gz, To, SEEK_SET);
1347 if (res != (off_t)To)
1348 return filefd->FileFdError("Unable to seek to %llu", To);
fa89055f 1349 seekpos = To;
83e22e26 1350 buffer.reset();
fa89055f
DK
1351 return true;
1352 }
1353 virtual bool InternalSkip(unsigned long long Over) override
1354 {
83e22e26 1355 if (Over >= buffer.size())
f63123c3 1356 {
83e22e26
JAK
1357 Over -= buffer.size();
1358 buffer.reset();
f63123c3
DK
1359 }
1360 else
1361 {
83e22e26 1362 buffer.bufferstart += Over;
f63123c3
DK
1363 return true;
1364 }
1365 if (Over == 0)
1366 return true;
fa89055f
DK
1367 off_t const res = gzseek(gz, Over, SEEK_CUR);
1368 if (res < 0)
1369 return filefd->FileFdError("Unable to seek ahead %llu",Over);
1370 seekpos = res;
1371 return true;
1372 }
1373 virtual unsigned long long InternalTell() override
1374 {
83e22e26 1375 return gztell(gz) - buffer.size();
fa89055f
DK
1376 }
1377 virtual unsigned long long InternalSize() override
1378 {
1379 unsigned long long filesize = FileFdPrivate::InternalSize();
1380 // only check gzsize if we are actually a gzip file, just checking for
1381 // "gz" is not sufficient as uncompressed files could be opened with
1382 // gzopen in "direct" mode as well
1383 if (filesize == 0 || gzdirect(gz))
1384 return filesize;
1385
1386 off_t const oldPos = lseek(filefd->iFd, 0, SEEK_CUR);
1387 /* unfortunately zlib.h doesn't provide a gzsize(), so we have to do
1388 * this ourselves; the original (uncompressed) file size is the last 32
1389 * bits of the file */
1390 // FIXME: Size for gz-files is limited by 32bit… no largefile support
1391 if (lseek(filefd->iFd, -4, SEEK_END) < 0)
1392 {
1393 filefd->FileFdErrno("lseek","Unable to seek to end of gzipped file");
1394 return 0;
1395 }
1396 uint32_t size = 0;
1397 if (read(filefd->iFd, &size, 4) != 4)
1398 {
1399 filefd->FileFdErrno("read","Unable to read original size of gzipped file");
1400 return 0;
1401 }
1402 size = le32toh(size);
1403
1404 if (lseek(filefd->iFd, oldPos, SEEK_SET) < 0)
1405 {
1406 filefd->FileFdErrno("lseek","Unable to seek in gzipped file");
1407 return 0;
1408 }
1409 return size;
1410 }
1411 virtual bool InternalClose(std::string const &FileName) override
1412 {
1413 if (gz == nullptr)
1414 return true;
1415 int const e = gzclose(gz);
1416 gz = nullptr;
1417 // gzdclose() on empty files always fails with "buffer error" here, ignore that
1418 if (e != 0 && e != Z_BUF_ERROR)
1419 return _error->Errno("close",_("Problem closing the gzip file %s"), FileName.c_str());
1420 return true;
1421 }
1422
11755147 1423 explicit GzipFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd), gz(nullptr) {}
fa89055f 1424 virtual ~GzipFileFdPrivate() { InternalClose(""); }
4239dbca 1425#endif
fa89055f
DK
1426};
1427 /*}}}*/
65ac6aad 1428class APT_HIDDEN Bz2FileFdPrivate: public FileFdPrivate { /*{{{*/
4239dbca 1429#ifdef HAVE_BZ2
fa89055f
DK
1430 BZFILE* bz2;
1431public:
1432 virtual bool InternalOpen(int const iFd, unsigned int const Mode) override
1433 {
1434 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1435 bz2 = BZ2_bzdopen(iFd, "r+");
1436 else if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1437 bz2 = BZ2_bzdopen(iFd, "w");
1438 else
1439 bz2 = BZ2_bzdopen(iFd, "r");
1440 filefd->Flags |= FileFd::Compressed;
1441 return bz2 != nullptr;
1442 }
f63123c3 1443 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) override
fa89055f
DK
1444 {
1445 return BZ2_bzread(bz2, To, Size);
1446 }
1447 virtual bool InternalReadError() override
1448 {
1449 int err;
1450 char const * const errmsg = BZ2_bzerror(bz2, &err);
1451 if (err != BZ_IO_ERROR)
1452 return filefd->FileFdError("BZ2_bzread: %s %s (%d: %s)", filefd->FileName.c_str(), _("Read error"), err, errmsg);
1453 return FileFdPrivate::InternalReadError();
1454 }
1455 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) override
1456 {
1457 return BZ2_bzwrite(bz2, (void*)From, Size);
1458 }
1459 virtual bool InternalWriteError() override
1460 {
1461 int err;
1462 char const * const errmsg = BZ2_bzerror(bz2, &err);
1463 if (err != BZ_IO_ERROR)
1464 return filefd->FileFdError("BZ2_bzwrite: %s %s (%d: %s)", filefd->FileName.c_str(), _("Write error"), err, errmsg);
1465 return FileFdPrivate::InternalWriteError();
1466 }
1467 virtual bool InternalStream() const override { return true; }
1468 virtual bool InternalClose(std::string const &) override
1469 {
1470 if (bz2 == nullptr)
1471 return true;
1472 BZ2_bzclose(bz2);
1473 bz2 = nullptr;
1474 return true;
1475 }
1476
11755147 1477 explicit Bz2FileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd), bz2(nullptr) {}
fa89055f 1478 virtual ~Bz2FileFdPrivate() { InternalClose(""); }
4239dbca 1479#endif
fa89055f
DK
1480};
1481 /*}}}*/
65ac6aad 1482class APT_HIDDEN LzmaFileFdPrivate: public FileFdPrivate { /*{{{*/
4239dbca 1483#ifdef HAVE_LZMA
fa89055f
DK
1484 struct LZMAFILE {
1485 FILE* file;
1486 uint8_t buffer[4096];
1487 lzma_stream stream;
1488 lzma_ret err;
1489 bool eof;
1490 bool compressing;
1491
1492 LZMAFILE() : file(nullptr), eof(false), compressing(false) { buffer[0] = '\0'; }
1493 ~LZMAFILE()
1494 {
1495 if (compressing == true)
1496 {
1497 size_t constexpr buffersize = sizeof(buffer)/sizeof(buffer[0]);
1498 while(true)
1499 {
1500 stream.avail_out = buffersize;
1501 stream.next_out = buffer;
1502 err = lzma_code(&stream, LZMA_FINISH);
1503 if (err != LZMA_OK && err != LZMA_STREAM_END)
1504 {
1505 _error->Error("~LZMAFILE: Compress finalisation failed");
1506 break;
1507 }
1508 size_t const n = buffersize - stream.avail_out;
1509 if (n && fwrite(buffer, 1, n, file) != n)
1510 {
1511 _error->Errno("~LZMAFILE",_("Write error"));
1512 break;
1513 }
1514 if (err == LZMA_STREAM_END)
1515 break;
1516 }
1517 }
1518 lzma_end(&stream);
1519 fclose(file);
1520 }
1521 };
1522 LZMAFILE* lzma;
7a68effc
DK
1523 static uint32_t findXZlevel(std::vector<std::string> const &Args)
1524 {
1525 for (auto a = Args.rbegin(); a != Args.rend(); ++a)
1526 if (a->empty() == false && (*a)[0] == '-' && (*a)[1] != '-')
1527 {
1528 auto const number = a->find_last_of("0123456789");
1529 if (number == std::string::npos)
1530 continue;
1531 auto const extreme = a->find("e", number);
1532 uint32_t level = (extreme != std::string::npos) ? LZMA_PRESET_EXTREME : 0;
1533 switch ((*a)[number])
1534 {
1535 case '0': return level | 0;
1536 case '1': return level | 1;
1537 case '2': return level | 2;
1538 case '3': return level | 3;
1539 case '4': return level | 4;
1540 case '5': return level | 5;
1541 case '6': return level | 6;
1542 case '7': return level | 7;
1543 case '8': return level | 8;
1544 case '9': return level | 9;
1545 }
1546 }
1547 return 6;
1548 }
fa89055f
DK
1549public:
1550 virtual bool InternalOpen(int const iFd, unsigned int const Mode) override
1551 {
1552 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1553 return filefd->FileFdError("ReadWrite mode is not supported for lzma/xz files %s", filefd->FileName.c_str());
1554
1555 if (lzma == nullptr)
1556 lzma = new LzmaFileFdPrivate::LZMAFILE;
1557 if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1558 lzma->file = fdopen(iFd, "w");
1559 else
1560 lzma->file = fdopen(iFd, "r");
1561 filefd->Flags |= FileFd::Compressed;
1562 if (lzma->file == nullptr)
1563 return false;
1564
fa89055f
DK
1565 lzma_stream tmp_stream = LZMA_STREAM_INIT;
1566 lzma->stream = tmp_stream;
1567
1568 if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1569 {
7a68effc 1570 uint32_t const xzlevel = findXZlevel(compressor.CompressArgs);
fa89055f
DK
1571 if (compressor.Name == "xz")
1572 {
885a1ffd 1573 if (lzma_easy_encoder(&lzma->stream, xzlevel, LZMA_CHECK_CRC64) != LZMA_OK)
fa89055f
DK
1574 return false;
1575 }
1576 else
1577 {
1578 lzma_options_lzma options;
1579 lzma_lzma_preset(&options, xzlevel);
1580 if (lzma_alone_encoder(&lzma->stream, &options) != LZMA_OK)
1581 return false;
1582 }
1583 lzma->compressing = true;
1584 }
1585 else
1586 {
7a68effc 1587 uint64_t const memlimit = UINT64_MAX;
fa89055f
DK
1588 if (compressor.Name == "xz")
1589 {
1590 if (lzma_auto_decoder(&lzma->stream, memlimit, 0) != LZMA_OK)
1591 return false;
1592 }
1593 else
1594 {
1595 if (lzma_alone_decoder(&lzma->stream, memlimit) != LZMA_OK)
1596 return false;
1597 }
1598 lzma->compressing = false;
1599 }
1600 return true;
1601 }
f63123c3 1602 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) override
fa89055f
DK
1603 {
1604 ssize_t Res;
1605 if (lzma->eof == true)
1606 return 0;
1607
1608 lzma->stream.next_out = (uint8_t *) To;
1609 lzma->stream.avail_out = Size;
1610 if (lzma->stream.avail_in == 0)
1611 {
1612 lzma->stream.next_in = lzma->buffer;
1613 lzma->stream.avail_in = fread(lzma->buffer, 1, sizeof(lzma->buffer)/sizeof(lzma->buffer[0]), lzma->file);
1614 }
1615 lzma->err = lzma_code(&lzma->stream, LZMA_RUN);
1616 if (lzma->err == LZMA_STREAM_END)
1617 {
1618 lzma->eof = true;
1619 Res = Size - lzma->stream.avail_out;
1620 }
1621 else if (lzma->err != LZMA_OK)
1622 {
1623 Res = -1;
1624 errno = 0;
1625 }
1626 else
1627 {
1628 Res = Size - lzma->stream.avail_out;
1629 if (Res == 0)
1630 {
1631 // lzma run was okay, but produced no output…
1632 Res = -1;
1633 errno = EINTR;
1634 }
1635 }
1636 return Res;
1637 }
1638 virtual bool InternalReadError() override
1639 {
1640 return filefd->FileFdError("lzma_read: %s (%d)", _("Read error"), lzma->err);
1641 }
1642 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) override
1643 {
1644 lzma->stream.next_in = (uint8_t *)From;
1645 lzma->stream.avail_in = Size;
1646 lzma->stream.next_out = lzma->buffer;
1647 lzma->stream.avail_out = sizeof(lzma->buffer)/sizeof(lzma->buffer[0]);
1648 lzma->err = lzma_code(&lzma->stream, LZMA_RUN);
1649 if (lzma->err != LZMA_OK)
1650 return -1;
1651 size_t const n = sizeof(lzma->buffer)/sizeof(lzma->buffer[0]) - lzma->stream.avail_out;
1652 size_t const m = (n == 0) ? 0 : fwrite(lzma->buffer, 1, n, lzma->file);
1653 if (m != n)
1654 return -1;
1655 else
1656 return Size - lzma->stream.avail_in;
1657 }
1658 virtual bool InternalWriteError() override
1659 {
1660 return filefd->FileFdError("lzma_write: %s (%d)", _("Write error"), lzma->err);
1661 }
1662 virtual bool InternalStream() const override { return true; }
1663 virtual bool InternalClose(std::string const &) override
1664 {
1665 delete lzma;
1666 lzma = nullptr;
1667 return true;
1668 }
1669
11755147 1670 explicit LzmaFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd), lzma(nullptr) {}
fa89055f 1671 virtual ~LzmaFileFdPrivate() { InternalClose(""); }
4239dbca 1672#endif
fa89055f
DK
1673};
1674 /*}}}*/
65ac6aad 1675class APT_HIDDEN PipedFileFdPrivate: public FileFdPrivate /*{{{*/
fa89055f
DK
1676/* if we don't have a specific class dealing with library calls, we (un)compress
1677 by executing a specified binary and pipe in/out what we need */
1678{
1679public:
1680 virtual bool InternalOpen(int const, unsigned int const Mode) override
1681 {
1682 // collect zombies here in case we reopen
1683 if (compressor_pid > 0)
1684 ExecWait(compressor_pid, "FileFdCompressor", true);
1685
1686 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1687 return filefd->FileFdError("ReadWrite mode is not supported for file %s", filefd->FileName.c_str());
4239dbca 1688
fa89055f
DK
1689 bool const Comp = (Mode & FileFd::WriteOnly) == FileFd::WriteOnly;
1690 if (Comp == false)
1691 {
1692 // Handle 'decompression' of empty files
1693 struct stat Buf;
1694 fstat(filefd->iFd, &Buf);
1695 if (Buf.st_size == 0 && S_ISFIFO(Buf.st_mode) == false)
1696 return true;
1697
1698 // We don't need the file open - instead let the compressor open it
1699 // as he properly knows better how to efficiently read from 'his' file
1700 if (filefd->FileName.empty() == false)
1701 {
1702 close(filefd->iFd);
1703 filefd->iFd = -1;
1704 }
1705 }
1706
1707 // Create a data pipe
1708 int Pipe[2] = {-1,-1};
1709 if (pipe(Pipe) != 0)
1710 return filefd->FileFdErrno("pipe",_("Failed to create subprocess IPC"));
1711 for (int J = 0; J != 2; J++)
1712 SetCloseExec(Pipe[J],true);
1713
1714 compressed_fd = filefd->iFd;
1d68256d 1715 set_is_pipe(true);
fa89055f
DK
1716
1717 if (Comp == true)
1718 filefd->iFd = Pipe[1];
1719 else
1720 filefd->iFd = Pipe[0];
1721
1722 // The child..
1723 compressor_pid = ExecFork();
1724 if (compressor_pid == 0)
1725 {
1726 if (Comp == true)
1727 {
1728 dup2(compressed_fd,STDOUT_FILENO);
1729 dup2(Pipe[0],STDIN_FILENO);
1730 }
1731 else
1732 {
1733 if (compressed_fd != -1)
1734 dup2(compressed_fd,STDIN_FILENO);
1735 dup2(Pipe[1],STDOUT_FILENO);
1736 }
1737 int const nullfd = open("/dev/null", O_WRONLY);
1738 if (nullfd != -1)
1739 {
1740 dup2(nullfd,STDERR_FILENO);
1741 close(nullfd);
1742 }
1743
1744 SetCloseExec(STDOUT_FILENO,false);
1745 SetCloseExec(STDIN_FILENO,false);
1746
1747 std::vector<char const*> Args;
1748 Args.push_back(compressor.Binary.c_str());
1749 std::vector<std::string> const * const addArgs =
1750 (Comp == true) ? &(compressor.CompressArgs) : &(compressor.UncompressArgs);
1751 for (std::vector<std::string>::const_iterator a = addArgs->begin();
1752 a != addArgs->end(); ++a)
1753 Args.push_back(a->c_str());
1754 if (Comp == false && filefd->FileName.empty() == false)
1755 {
1756 // commands not needing arguments, do not need to be told about using standard output
1757 // in reality, only testcases with tools like cat, rev, rot13, … are able to trigger this
1758 if (compressor.CompressArgs.empty() == false && compressor.UncompressArgs.empty() == false)
1759 Args.push_back("--stdout");
1760 if (filefd->TemporaryFileName.empty() == false)
1761 Args.push_back(filefd->TemporaryFileName.c_str());
1762 else
1763 Args.push_back(filefd->FileName.c_str());
1764 }
1765 Args.push_back(NULL);
1766
1767 execvp(Args[0],(char **)&Args[0]);
1768 cerr << _("Failed to exec compressor ") << Args[0] << endl;
1769 _exit(100);
1770 }
1771 if (Comp == true)
1772 close(Pipe[0]);
1773 else
1774 close(Pipe[1]);
1775
1776 return true;
1777 }
f63123c3 1778 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) override
fa89055f
DK
1779 {
1780 return read(filefd->iFd, To, Size);
1781 }
1782 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) override
1783 {
1784 return write(filefd->iFd, From, Size);
1785 }
1786 virtual bool InternalClose(std::string const &) override
1787 {
1788 bool Ret = true;
1789 if (compressor_pid > 0)
1790 Ret &= ExecWait(compressor_pid, "FileFdCompressor", true);
1791 compressor_pid = -1;
1792 return Ret;
1793 }
11755147 1794 explicit PipedFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd) {}
fa89055f
DK
1795 virtual ~PipedFileFdPrivate() { InternalClose(""); }
1796};
1797 /*}}}*/
65ac6aad 1798class APT_HIDDEN DirectFileFdPrivate: public FileFdPrivate /*{{{*/
fa89055f
DK
1799{
1800public:
1801 virtual bool InternalOpen(int const, unsigned int const) override { return true; }
f63123c3 1802 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) override
fa89055f
DK
1803 {
1804 return read(filefd->iFd, To, Size);
1805 }
fa89055f
DK
1806 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) override
1807 {
f63123c3 1808 // files opened read+write are strange and only really "supported" for direct files
83e22e26 1809 if (buffer.size() != 0)
f63123c3 1810 {
83e22e26
JAK
1811 lseek(filefd->iFd, -buffer.size(), SEEK_CUR);
1812 buffer.reset();
f63123c3 1813 }
fa89055f
DK
1814 return write(filefd->iFd, From, Size);
1815 }
1816 virtual bool InternalSeek(unsigned long long const To) override
1817 {
1818 off_t const res = lseek(filefd->iFd, To, SEEK_SET);
1819 if (res != (off_t)To)
1820 return filefd->FileFdError("Unable to seek to %llu", To);
1821 seekpos = To;
83e22e26 1822 buffer.reset();
fa89055f
DK
1823 return true;
1824 }
1825 virtual bool InternalSkip(unsigned long long Over) override
1826 {
83e22e26 1827 if (Over >= buffer.size())
f63123c3 1828 {
83e22e26
JAK
1829 Over -= buffer.size();
1830 buffer.reset();
f63123c3
DK
1831 }
1832 else
1833 {
83e22e26 1834 buffer.bufferstart += Over;
f63123c3
DK
1835 return true;
1836 }
1837 if (Over == 0)
1838 return true;
fa89055f
DK
1839 off_t const res = lseek(filefd->iFd, Over, SEEK_CUR);
1840 if (res < 0)
1841 return filefd->FileFdError("Unable to seek ahead %llu",Over);
1842 seekpos = res;
1843 return true;
1844 }
1845 virtual bool InternalTruncate(unsigned long long const To) override
1846 {
83e22e26 1847 if (buffer.size() != 0)
f63123c3
DK
1848 {
1849 unsigned long long const seekpos = lseek(filefd->iFd, 0, SEEK_CUR);
83e22e26
JAK
1850 if ((seekpos - buffer.size()) >= To)
1851 buffer.reset();
f63123c3 1852 else if (seekpos >= To)
83e22e26 1853 buffer.bufferend = (To - seekpos) + buffer.bufferstart;
f63123c3 1854 else
83e22e26 1855 buffer.reset();
f63123c3 1856 }
fa89055f
DK
1857 if (ftruncate(filefd->iFd, To) != 0)
1858 return filefd->FileFdError("Unable to truncate to %llu",To);
1859 return true;
1860 }
1861 virtual unsigned long long InternalTell() override
1862 {
83e22e26 1863 return lseek(filefd->iFd,0,SEEK_CUR) - buffer.size();
fa89055f
DK
1864 }
1865 virtual unsigned long long InternalSize() override
1866 {
1867 return filefd->FileSize();
1868 }
1869 virtual bool InternalClose(std::string const &) override { return true; }
1870 virtual bool InternalAlwaysAutoClose() const override { return false; }
1871
11755147 1872 explicit DirectFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd) {}
fa89055f 1873 virtual ~DirectFileFdPrivate() { InternalClose(""); }
4239dbca
DK
1874};
1875 /*}}}*/
6c55f07a
DK
1876// FileFd Constructors /*{{{*/
1877FileFd::FileFd(std::string FileName,unsigned int const Mode,unsigned long AccessMode) : iFd(-1), Flags(0), d(NULL)
1878{
1879 Open(FileName,Mode, None, AccessMode);
1880}
1881FileFd::FileFd(std::string FileName,unsigned int const Mode, CompressMode Compress, unsigned long AccessMode) : iFd(-1), Flags(0), d(NULL)
1882{
1883 Open(FileName,Mode, Compress, AccessMode);
1884}
1885FileFd::FileFd() : iFd(-1), Flags(AutoClose), d(NULL) {}
1886FileFd::FileFd(int const Fd, unsigned int const Mode, CompressMode Compress) : iFd(-1), Flags(0), d(NULL)
1887{
1888 OpenDescriptor(Fd, Mode, Compress);
1889}
1890FileFd::FileFd(int const Fd, bool const AutoClose) : iFd(-1), Flags(0), d(NULL)
1891{
1892 OpenDescriptor(Fd, ReadWrite, None, AutoClose);
1893}
1894 /*}}}*/
13d87e2e 1895// FileFd::Open - Open a file /*{{{*/
578bfd0a
AL
1896// ---------------------------------------------------------------------
1897/* The most commonly used open mode combinations are given with Mode */
e5f3f8c1 1898bool FileFd::Open(string FileName,unsigned int const Mode,CompressMode Compress, unsigned long const AccessMode)
578bfd0a 1899{
257e8d66 1900 if (Mode == ReadOnlyGzip)
e5f3f8c1 1901 return Open(FileName, ReadOnly, Gzip, AccessMode);
257e8d66 1902
468720c5 1903 if (Compress == Auto && (Mode & WriteOnly) == WriteOnly)
ae635e3c 1904 return FileFdError("Autodetection on %s only works in ReadOnly openmode!", FileName.c_str());
257e8d66 1905
468720c5
DK
1906 std::vector<APT::Configuration::Compressor> const compressors = APT::Configuration::getCompressors();
1907 std::vector<APT::Configuration::Compressor>::const_iterator compressor = compressors.begin();
1908 if (Compress == Auto)
1909 {
468720c5
DK
1910 for (; compressor != compressors.end(); ++compressor)
1911 {
e788a834 1912 std::string file = FileName + compressor->Extension;
468720c5
DK
1913 if (FileExists(file) == false)
1914 continue;
1915 FileName = file;
468720c5
DK
1916 break;
1917 }
1918 }
1919 else if (Compress == Extension)
1920 {
52b47296
DK
1921 std::string::size_type const found = FileName.find_last_of('.');
1922 std::string ext;
1923 if (found != std::string::npos)
1924 {
1925 ext = FileName.substr(found);
1926 if (ext == ".new" || ext == ".bak")
1927 {
1928 std::string::size_type const found2 = FileName.find_last_of('.', found - 1);
1929 if (found2 != std::string::npos)
1930 ext = FileName.substr(found2, found - found2);
1931 else
1932 ext.clear();
1933 }
1934 }
aee1aac6
DK
1935 for (; compressor != compressors.end(); ++compressor)
1936 if (ext == compressor->Extension)
1937 break;
1938 // no matching extension - assume uncompressed (imagine files like 'example.org_Packages')
1939 if (compressor == compressors.end())
1940 for (compressor = compressors.begin(); compressor != compressors.end(); ++compressor)
1941 if (compressor->Name == ".")
468720c5 1942 break;
468720c5 1943 }
aee1aac6 1944 else
468720c5
DK
1945 {
1946 std::string name;
1947 switch (Compress)
1948 {
aee1aac6 1949 case None: name = "."; break;
468720c5
DK
1950 case Gzip: name = "gzip"; break;
1951 case Bzip2: name = "bzip2"; break;
1952 case Lzma: name = "lzma"; break;
1953 case Xz: name = "xz"; break;
aee1aac6
DK
1954 case Auto:
1955 case Extension:
52b47296 1956 // Unreachable
ae635e3c 1957 return FileFdError("Opening File %s in None, Auto or Extension should be already handled?!?", FileName.c_str());
468720c5
DK
1958 }
1959 for (; compressor != compressors.end(); ++compressor)
1960 if (compressor->Name == name)
1961 break;
aee1aac6 1962 if (compressor == compressors.end())
ae635e3c 1963 return FileFdError("Can't find a configured compressor %s for file %s", name.c_str(), FileName.c_str());
468720c5
DK
1964 }
1965
aee1aac6 1966 if (compressor == compressors.end())
ae635e3c 1967 return FileFdError("Can't find a match for specified compressor mode for file %s", FileName.c_str());
e5f3f8c1 1968 return Open(FileName, Mode, *compressor, AccessMode);
aee1aac6 1969}
e5f3f8c1 1970bool FileFd::Open(string FileName,unsigned int const Mode,APT::Configuration::Compressor const &compressor, unsigned long const AccessMode)
aee1aac6
DK
1971{
1972 Close();
aee1aac6
DK
1973 Flags = AutoClose;
1974
1975 if ((Mode & WriteOnly) != WriteOnly && (Mode & (Atomic | Create | Empty | Exclusive)) != 0)
ae635e3c 1976 return FileFdError("ReadOnly mode for %s doesn't accept additional flags!", FileName.c_str());
aee1aac6 1977 if ((Mode & ReadWrite) == 0)
ae635e3c 1978 return FileFdError("No openmode provided in FileFd::Open for %s", FileName.c_str());
468720c5 1979
cd46d4eb
DK
1980 unsigned int OpenMode = Mode;
1981 if (FileName == "/dev/null")
1982 OpenMode = OpenMode & ~(Atomic | Exclusive | Create | Empty);
1983
1984 if ((OpenMode & Atomic) == Atomic)
257e8d66
DK
1985 {
1986 Flags |= Replace;
257e8d66 1987 }
cd46d4eb 1988 else if ((OpenMode & (Exclusive | Create)) == (Exclusive | Create))
257e8d66
DK
1989 {
1990 // for atomic, this will be done by rename in Close()
ce1f3a2c 1991 RemoveFile("FileFd::Open", FileName);
257e8d66 1992 }
cd46d4eb 1993 if ((OpenMode & Empty) == Empty)
578bfd0a 1994 {
257e8d66
DK
1995 struct stat Buf;
1996 if (lstat(FileName.c_str(),&Buf) == 0 && S_ISLNK(Buf.st_mode))
ce1f3a2c 1997 RemoveFile("FileFd::Open", FileName);
257e8d66 1998 }
c4fc2fd7 1999
561f860a 2000 int fileflags = 0;
cd46d4eb 2001 #define if_FLAGGED_SET(FLAG, MODE) if ((OpenMode & FLAG) == FLAG) fileflags |= MODE
561f860a
DK
2002 if_FLAGGED_SET(ReadWrite, O_RDWR);
2003 else if_FLAGGED_SET(ReadOnly, O_RDONLY);
2004 else if_FLAGGED_SET(WriteOnly, O_WRONLY);
4a9db827 2005
561f860a
DK
2006 if_FLAGGED_SET(Create, O_CREAT);
2007 if_FLAGGED_SET(Empty, O_TRUNC);
2008 if_FLAGGED_SET(Exclusive, O_EXCL);
561f860a 2009 #undef if_FLAGGED_SET
52b47296 2010
cd46d4eb 2011 if ((OpenMode & Atomic) == Atomic)
7335eebe
AGM
2012 {
2013 char *name = strdup((FileName + ".XXXXXX").c_str());
2014
dc545c0b 2015 if((iFd = mkstemp(name)) == -1)
7335eebe
AGM
2016 {
2017 free(name);
98b69f9d 2018 return FileFdErrno("mkstemp", "Could not create temporary file for %s", FileName.c_str());
7335eebe
AGM
2019 }
2020
2021 TemporaryFileName = string(name);
7335eebe 2022 free(name);
dc545c0b 2023
230e69d7
DK
2024 // umask() will always set the umask and return the previous value, so
2025 // we first set the umask and then reset it to the old value
2026 mode_t const CurrentUmask = umask(0);
2027 umask(CurrentUmask);
2028 // calculate the actual file permissions (just like open/creat)
2029 mode_t const FilePermissions = (AccessMode & ~CurrentUmask);
2030
2031 if(fchmod(iFd, FilePermissions) == -1)
dc545c0b 2032 return FileFdErrno("fchmod", "Could not change permissions for temporary file %s", TemporaryFileName.c_str());
7335eebe 2033 }
468720c5 2034 else
230e69d7 2035 iFd = open(FileName.c_str(), fileflags, AccessMode);
468720c5 2036
b711c01e 2037 this->FileName = FileName;
cd46d4eb 2038 if (iFd == -1 || OpenInternDescriptor(OpenMode, compressor) == false)
561f860a 2039 {
468720c5 2040 if (iFd != -1)
fc81e8f2 2041 {
561f860a
DK
2042 close (iFd);
2043 iFd = -1;
fc81e8f2 2044 }
ae635e3c 2045 return FileFdErrno("open",_("Could not open file %s"), FileName.c_str());
257e8d66 2046 }
578bfd0a 2047
13d87e2e
AL
2048 SetCloseExec(iFd,true);
2049 return true;
578bfd0a 2050}
257e8d66
DK
2051 /*}}}*/
2052// FileFd::OpenDescriptor - Open a filedescriptor /*{{{*/
52b47296 2053bool FileFd::OpenDescriptor(int Fd, unsigned int const Mode, CompressMode Compress, bool AutoClose)
aee1aac6
DK
2054{
2055 std::vector<APT::Configuration::Compressor> const compressors = APT::Configuration::getCompressors();
2056 std::vector<APT::Configuration::Compressor>::const_iterator compressor = compressors.begin();
2057 std::string name;
bce778a3
MV
2058
2059 // compat with the old API
2060 if (Mode == ReadOnlyGzip && Compress == None)
2061 Compress = Gzip;
2062
aee1aac6
DK
2063 switch (Compress)
2064 {
2065 case None: name = "."; break;
2066 case Gzip: name = "gzip"; break;
2067 case Bzip2: name = "bzip2"; break;
2068 case Lzma: name = "lzma"; break;
2069 case Xz: name = "xz"; break;
2070 case Auto:
2071 case Extension:
f97bb523
DK
2072 if (AutoClose == true && Fd != -1)
2073 close(Fd);
ae635e3c 2074 return FileFdError("Opening Fd %d in Auto or Extension compression mode is not supported", Fd);
aee1aac6
DK
2075 }
2076 for (; compressor != compressors.end(); ++compressor)
2077 if (compressor->Name == name)
2078 break;
2079 if (compressor == compressors.end())
f97bb523
DK
2080 {
2081 if (AutoClose == true && Fd != -1)
2082 close(Fd);
ae635e3c 2083 return FileFdError("Can't find a configured compressor %s for file %s", name.c_str(), FileName.c_str());
f97bb523 2084 }
aee1aac6
DK
2085 return OpenDescriptor(Fd, Mode, *compressor, AutoClose);
2086}
52b47296 2087bool FileFd::OpenDescriptor(int Fd, unsigned int const Mode, APT::Configuration::Compressor const &compressor, bool AutoClose)
144c0969
JAK
2088{
2089 Close();
2090 Flags = (AutoClose) ? FileFd::AutoClose : 0;
84baaae9 2091 iFd = Fd;
b711c01e 2092 this->FileName = "";
84baaae9 2093 if (OpenInternDescriptor(Mode, compressor) == false)
468720c5 2094 {
f97bb523 2095 if (iFd != -1 && (
84baaae9 2096 (Flags & Compressed) == Compressed ||
f97bb523
DK
2097 AutoClose == true))
2098 {
468720c5 2099 close (iFd);
f97bb523
DK
2100 iFd = -1;
2101 }
2102 return FileFdError(_("Could not open file descriptor %d"), Fd);
144c0969 2103 }
144c0969 2104 return true;
468720c5 2105}
52b47296 2106bool FileFd::OpenInternDescriptor(unsigned int const Mode, APT::Configuration::Compressor const &compressor)
468720c5 2107{
84baaae9
DK
2108 if (iFd == -1)
2109 return false;
ff477ee1 2110
fa89055f
DK
2111 if (d != nullptr)
2112 d->InternalClose(FileName);
2113
2114 if (d == nullptr)
2115 {
2116 if (false)
2117 /* dummy so that the rest can be 'else if's */;
2118#define APT_COMPRESS_INIT(NAME, CONSTRUCTOR) \
2119 else if (compressor.Name == NAME) \
2120 d = new CONSTRUCTOR(this)
69d6988a 2121#ifdef HAVE_ZLIB
fa89055f 2122 APT_COMPRESS_INIT("gzip", GzipFileFdPrivate);
69d6988a
DK
2123#endif
2124#ifdef HAVE_BZ2
fa89055f 2125 APT_COMPRESS_INIT("bzip2", Bz2FileFdPrivate);
69d6988a 2126#endif
7f350a37 2127#ifdef HAVE_LZMA
fa89055f
DK
2128 APT_COMPRESS_INIT("xz", LzmaFileFdPrivate);
2129 APT_COMPRESS_INIT("lzma", LzmaFileFdPrivate);
7f350a37 2130#endif
69d6988a 2131#undef APT_COMPRESS_INIT
fa89055f
DK
2132 else if (compressor.Name == "." || compressor.Binary.empty() == true)
2133 d = new DirectFileFdPrivate(this);
2134 else
2135 d = new PipedFileFdPrivate(this);
69d6988a 2136
88749b5d
JAK
2137 if (Mode & BufferedWrite)
2138 d = new BufferedWriteFileFdPrivate(d);
2139
1d68256d
JAK
2140 d->set_openmode(Mode);
2141 d->set_compressor(compressor);
fa89055f 2142 if ((Flags & AutoClose) != AutoClose && d->InternalAlwaysAutoClose())
84baaae9
DK
2143 {
2144 // Need to duplicate fd here or gz/bz2 close for cleanup will close the fd as well
2145 int const internFd = dup(iFd);
2146 if (internFd == -1)
2147 return FileFdErrno("OpenInternDescriptor", _("Could not open file descriptor %d"), iFd);
2148 iFd = internFd;
2149 }
561f860a 2150 }
fa89055f 2151 return d->InternalOpen(iFd, Mode);
144c0969 2152}
578bfd0a 2153 /*}}}*/
8e06abb2 2154// FileFd::~File - Closes the file /*{{{*/
578bfd0a
AL
2155// ---------------------------------------------------------------------
2156/* If the proper modes are selected then we close the Fd and possibly
2157 unlink the file on error. */
8e06abb2 2158FileFd::~FileFd()
578bfd0a
AL
2159{
2160 Close();
500400fe 2161 if (d != NULL)
fa89055f 2162 d->InternalClose(FileName);
96ab3c6f
MV
2163 delete d;
2164 d = NULL;
578bfd0a
AL
2165}
2166 /*}}}*/
8e06abb2 2167// FileFd::Read - Read a bit of the file /*{{{*/
578bfd0a 2168// ---------------------------------------------------------------------
1e3f4083 2169/* We are careful to handle interruption by a signal while reading
b0db36b1 2170 gracefully. */
650faab0 2171bool FileFd::Read(void *To,unsigned long long Size,unsigned long long *Actual)
578bfd0a 2172{
fa89055f
DK
2173 if (d == nullptr)
2174 return false;
39e77e45 2175 ssize_t Res = 1;
b0db36b1 2176 errno = 0;
f604cf55
AL
2177 if (Actual != 0)
2178 *Actual = 0;
699b209e 2179 *((char *)To) = '\0';
39e77e45 2180 while (Res > 0 && Size > 0)
578bfd0a 2181 {
fa89055f 2182 Res = d->InternalRead(To, Size);
b711c01e 2183
b0db36b1
AL
2184 if (Res < 0)
2185 {
b711c01e 2186 if (errno == EINTR)
c4b113e6
DK
2187 {
2188 // trick the while-loop into running again
2189 Res = 1;
2190 errno = 0;
b711c01e 2191 continue;
c4b113e6 2192 }
fa89055f 2193 return d->InternalReadError();
b0db36b1 2194 }
578bfd0a 2195
b0db36b1
AL
2196 To = (char *)To + Res;
2197 Size -= Res;
ff477ee1 2198 if (d != NULL)
1d68256d 2199 d->set_seekpos(d->get_seekpos() + Res);
f604cf55
AL
2200 if (Actual != 0)
2201 *Actual += Res;
b0db36b1 2202 }
b0db36b1
AL
2203
2204 if (Size == 0)
2205 return true;
2206
ddc1d8d0 2207 // Eof handling
f604cf55 2208 if (Actual != 0)
ddc1d8d0
AL
2209 {
2210 Flags |= HitEof;
2211 return true;
2212 }
ae635e3c
DK
2213
2214 return FileFdError(_("read, still have %llu to read but none left"), Size);
578bfd0a
AL
2215}
2216 /*}}}*/
032bd56f
DK
2217// FileFd::ReadLine - Read a complete line from the file /*{{{*/
2218// ---------------------------------------------------------------------
fa89055f 2219/* Beware: This method can be quite slow for big buffers on UNcompressed
032bd56f
DK
2220 files because of the naive implementation! */
2221char* FileFd::ReadLine(char *To, unsigned long long const Size)
2222{
699b209e 2223 *To = '\0';
fa89055f
DK
2224 if (d == nullptr)
2225 return nullptr;
2226 return d->InternalReadLine(To, Size);
032bd56f
DK
2227}
2228 /*}}}*/
766761fd
JAK
2229// FileFd::Flush - Flush the file /*{{{*/
2230bool FileFd::Flush()
2231{
2232 if (d == nullptr)
2233 return true;
2234
2235 return d->InternalFlush();
2236}
2237 /*}}}*/
8e06abb2 2238// FileFd::Write - Write to the file /*{{{*/
650faab0 2239bool FileFd::Write(const void *From,unsigned long long Size)
578bfd0a 2240{
fa89055f
DK
2241 if (d == nullptr)
2242 return false;
5df91bc7 2243 ssize_t Res = 1;
b0db36b1 2244 errno = 0;
5df91bc7 2245 while (Res > 0 && Size > 0)
578bfd0a 2246 {
fa89055f 2247 Res = d->InternalWrite(From, Size);
b0db36b1
AL
2248 if (Res < 0 && errno == EINTR)
2249 continue;
2250 if (Res < 0)
fa89055f
DK
2251 return d->InternalWriteError();
2252
cf4ff3b7 2253 From = (char const *)From + Res;
b0db36b1 2254 Size -= Res;
ff477ee1 2255 if (d != NULL)
1d68256d 2256 d->set_seekpos(d->get_seekpos() + Res);
578bfd0a 2257 }
fa89055f 2258
b0db36b1
AL
2259 if (Size == 0)
2260 return true;
ae635e3c
DK
2261
2262 return FileFdError(_("write, still have %llu to write but couldn't"), Size);
d68d65ad
DK
2263}
2264bool FileFd::Write(int Fd, const void *From, unsigned long long Size)
2265{
5df91bc7 2266 ssize_t Res = 1;
d68d65ad 2267 errno = 0;
5df91bc7 2268 while (Res > 0 && Size > 0)
d68d65ad
DK
2269 {
2270 Res = write(Fd,From,Size);
2271 if (Res < 0 && errno == EINTR)
2272 continue;
2273 if (Res < 0)
2274 return _error->Errno("write",_("Write error"));
2275
cf4ff3b7 2276 From = (char const *)From + Res;
d68d65ad
DK
2277 Size -= Res;
2278 }
d68d65ad
DK
2279
2280 if (Size == 0)
2281 return true;
2282
2283 return _error->Error(_("write, still have %llu to write but couldn't"), Size);
578bfd0a
AL
2284}
2285 /*}}}*/
8e06abb2 2286// FileFd::Seek - Seek in the file /*{{{*/
650faab0 2287bool FileFd::Seek(unsigned long long To)
578bfd0a 2288{
fa89055f
DK
2289 if (d == nullptr)
2290 return false;
bb93178b 2291 Flags &= ~HitEof;
fa89055f 2292 return d->InternalSeek(To);
727f18af
AL
2293}
2294 /*}}}*/
fa89055f 2295// FileFd::Skip - Skip over data in the file /*{{{*/
650faab0 2296bool FileFd::Skip(unsigned long long Over)
727f18af 2297{
fa89055f
DK
2298 if (d == nullptr)
2299 return false;
2300 return d->InternalSkip(Over);
6d5dd02a
AL
2301}
2302 /*}}}*/
fa89055f 2303// FileFd::Truncate - Truncate the file /*{{{*/
650faab0 2304bool FileFd::Truncate(unsigned long long To)
6d5dd02a 2305{
fa89055f
DK
2306 if (d == nullptr)
2307 return false;
ad5051ef
DK
2308 // truncating /dev/null is always successful - as we get an error otherwise
2309 if (To == 0 && FileName == "/dev/null")
2310 return true;
fa89055f 2311 return d->InternalTruncate(To);
578bfd0a
AL
2312}
2313 /*}}}*/
7f25bdff
AL
2314// FileFd::Tell - Current seek position /*{{{*/
2315// ---------------------------------------------------------------------
2316/* */
650faab0 2317unsigned long long FileFd::Tell()
7f25bdff 2318{
fa89055f
DK
2319 if (d == nullptr)
2320 return false;
2321 off_t const Res = d->InternalTell();
7f25bdff 2322 if (Res == (off_t)-1)
ae635e3c 2323 FileFdErrno("lseek","Failed to determine the current file position");
1d68256d 2324 d->set_seekpos(Res);
7f25bdff
AL
2325 return Res;
2326}
2327 /*}}}*/
8190b07a 2328static bool StatFileFd(char const * const msg, int const iFd, std::string const &FileName, struct stat &Buf, FileFdPrivate * const d) /*{{{*/
578bfd0a 2329{
1d68256d 2330 bool ispipe = (d != NULL && d->get_is_pipe() == true);
6008b79a
DK
2331 if (ispipe == false)
2332 {
2333 if (fstat(iFd,&Buf) != 0)
8190b07a
DK
2334 // higher-level code will generate more meaningful messages,
2335 // even translated this would be meaningless for users
2336 return _error->Errno("fstat", "Unable to determine %s for fd %i", msg, iFd);
003c40d3
DK
2337 if (FileName.empty() == false)
2338 ispipe = S_ISFIFO(Buf.st_mode);
6008b79a 2339 }
699b209e
DK
2340
2341 // for compressor pipes st_size is undefined and at 'best' zero
6008b79a 2342 if (ispipe == true)
699b209e
DK
2343 {
2344 // we set it here, too, as we get the info here for free
2345 // in theory the Open-methods should take care of it already
ff477ee1 2346 if (d != NULL)
1d68256d 2347 d->set_is_pipe(true);
699b209e 2348 if (stat(FileName.c_str(), &Buf) != 0)
8190b07a
DK
2349 return _error->Errno("fstat", "Unable to determine %s for file %s", msg, FileName.c_str());
2350 }
2351 return true;
2352}
2353 /*}}}*/
2354// FileFd::FileSize - Return the size of the file /*{{{*/
2355unsigned long long FileFd::FileSize()
2356{
2357 struct stat Buf;
2358 if (StatFileFd("file size", iFd, FileName, Buf, d) == false)
2359 {
2360 Flags |= Fail;
2361 return 0;
699b209e 2362 }
4260fd39
DK
2363 return Buf.st_size;
2364}
2365 /*}}}*/
8190b07a
DK
2366// FileFd::ModificationTime - Return the time of last touch /*{{{*/
2367time_t FileFd::ModificationTime()
2368{
2369 struct stat Buf;
2370 if (StatFileFd("modification time", iFd, FileName, Buf, d) == false)
2371 {
2372 Flags |= Fail;
2373 return 0;
2374 }
2375 return Buf.st_mtime;
2376}
2377 /*}}}*/
4260fd39 2378// FileFd::Size - Return the size of the content in the file /*{{{*/
650faab0 2379unsigned long long FileFd::Size()
4260fd39 2380{
fa89055f
DK
2381 if (d == nullptr)
2382 return false;
2383 return d->InternalSize();
578bfd0a
AL
2384}
2385 /*}}}*/
8e06abb2 2386// FileFd::Close - Close the file if the close flag is set /*{{{*/
578bfd0a
AL
2387// ---------------------------------------------------------------------
2388/* */
8e06abb2 2389bool FileFd::Close()
578bfd0a 2390{
766761fd
JAK
2391 if (Flush() == false)
2392 return false;
032bd56f
DK
2393 if (iFd == -1)
2394 return true;
2395
578bfd0a
AL
2396 bool Res = true;
2397 if ((Flags & AutoClose) == AutoClose)
d13c2d3f 2398 {
500400fe
DK
2399 if ((Flags & Compressed) != Compressed && iFd > 0 && close(iFd) != 0)
2400 Res &= _error->Errno("close",_("Problem closing the file %s"), FileName.c_str());
2da8aae5
JAK
2401 }
2402
2403 if (d != NULL)
2404 {
fa89055f 2405 Res &= d->InternalClose(FileName);
2da8aae5
JAK
2406 delete d;
2407 d = NULL;
d13c2d3f 2408 }
3010fb0e 2409
d3aac32e 2410 if ((Flags & Replace) == Replace) {
3010fb0e 2411 if (rename(TemporaryFileName.c_str(), FileName.c_str()) != 0)
62d073d9
DK
2412 Res &= _error->Errno("rename",_("Problem renaming the file %s to %s"), TemporaryFileName.c_str(), FileName.c_str());
2413
fd3b761e 2414 FileName = TemporaryFileName; // for the unlink() below.
257e8d66 2415 TemporaryFileName.clear();
3010fb0e 2416 }
62d073d9
DK
2417
2418 iFd = -1;
2419
578bfd0a
AL
2420 if ((Flags & Fail) == Fail && (Flags & DelOnFail) == DelOnFail &&
2421 FileName.empty() == false)
ce1f3a2c 2422 Res &= RemoveFile("FileFd::Close", FileName);
3010fb0e 2423
fbb89d94
DK
2424 if (Res == false)
2425 Flags |= Fail;
578bfd0a
AL
2426 return Res;
2427}
2428 /*}}}*/
b2e465d6
AL
2429// FileFd::Sync - Sync the file /*{{{*/
2430// ---------------------------------------------------------------------
2431/* */
2432bool FileFd::Sync()
2433{
b2e465d6 2434 if (fsync(iFd) != 0)
ae635e3c
DK
2435 return FileFdErrno("sync",_("Problem syncing the file"));
2436 return true;
2437}
2438 /*}}}*/
2439// FileFd::FileFdErrno - set Fail and call _error->Errno *{{{*/
2440bool FileFd::FileFdErrno(const char *Function, const char *Description,...)
2441{
2442 Flags |= Fail;
2443 va_list args;
2444 size_t msgSize = 400;
2445 int const errsv = errno;
2446 while (true)
fbb89d94 2447 {
ae635e3c
DK
2448 va_start(args,Description);
2449 if (_error->InsertErrno(GlobalError::ERROR, Function, Description, args, errsv, msgSize) == false)
2450 break;
2451 va_end(args);
fbb89d94 2452 }
ae635e3c
DK
2453 return false;
2454}
2455 /*}}}*/
2456// FileFd::FileFdError - set Fail and call _error->Error *{{{*/
2457bool FileFd::FileFdError(const char *Description,...) {
2458 Flags |= Fail;
2459 va_list args;
2460 size_t msgSize = 400;
2461 while (true)
2462 {
2463 va_start(args,Description);
2464 if (_error->Insert(GlobalError::ERROR, Description, args, msgSize) == false)
2465 break;
2466 va_end(args);
2467 }
2468 return false;
b2e465d6
AL
2469}
2470 /*}}}*/
fa89055f 2471gzFile FileFd::gzFd() { /*{{{*/
7f350a37 2472#ifdef HAVE_ZLIB
fa89055f
DK
2473 GzipFileFdPrivate * const gzipd = dynamic_cast<GzipFileFdPrivate*>(d);
2474 if (gzipd == nullptr)
2475 return nullptr;
2476 else
2477 return gzipd->gz;
7f350a37 2478#else
fa89055f 2479 return nullptr;
7f350a37
DK
2480#endif
2481}
fa89055f 2482 /*}}}*/
8d01b9d6 2483
f8aba23f 2484// Glob - wrapper around "glob()" /*{{{*/
8d01b9d6
MV
2485std::vector<std::string> Glob(std::string const &pattern, int flags)
2486{
2487 std::vector<std::string> result;
2488 glob_t globbuf;
ec4835a1
ÁGM
2489 int glob_res;
2490 unsigned int i;
8d01b9d6
MV
2491
2492 glob_res = glob(pattern.c_str(), flags, NULL, &globbuf);
2493
2494 if (glob_res != 0)
2495 {
2496 if(glob_res != GLOB_NOMATCH) {
2497 _error->Errno("glob", "Problem with glob");
2498 return result;
2499 }
2500 }
2501
2502 // append results
2503 for(i=0;i<globbuf.gl_pathc;i++)
2504 result.push_back(string(globbuf.gl_pathv[i]));
2505
2506 globfree(&globbuf);
2507 return result;
2508}
2509 /*}}}*/
f8aba23f 2510std::string GetTempDir() /*{{{*/
68e01721
MV
2511{
2512 const char *tmpdir = getenv("TMPDIR");
2513
2514#ifdef P_tmpdir
2515 if (!tmpdir)
2516 tmpdir = P_tmpdir;
2517#endif
2518
68e01721 2519 struct stat st;
0d303f17 2520 if (!tmpdir || strlen(tmpdir) == 0 || // tmpdir is set
dd6da7d2
DK
2521 stat(tmpdir, &st) != 0 || (st.st_mode & S_IFDIR) == 0) // exists and is directory
2522 tmpdir = "/tmp";
2523 else if (geteuid() != 0 && // root can do everything anyway
2524 faccessat(-1, tmpdir, R_OK | W_OK | X_OK, AT_EACCESS | AT_SYMLINK_NOFOLLOW) != 0) // current user has rwx access to directory
68e01721
MV
2525 tmpdir = "/tmp";
2526
2527 return string(tmpdir);
dd6da7d2
DK
2528}
2529std::string GetTempDir(std::string const &User)
2530{
2531 // no need/possibility to drop privs
2532 if(getuid() != 0 || User.empty() || User == "root")
2533 return GetTempDir();
2534
2535 struct passwd const * const pw = getpwnam(User.c_str());
2536 if (pw == NULL)
2537 return GetTempDir();
2538
226c0f64
DK
2539 gid_t const old_euid = geteuid();
2540 gid_t const old_egid = getegid();
dd6da7d2
DK
2541 if (setegid(pw->pw_gid) != 0)
2542 _error->Errno("setegid", "setegid %u failed", pw->pw_gid);
2543 if (seteuid(pw->pw_uid) != 0)
2544 _error->Errno("seteuid", "seteuid %u failed", pw->pw_uid);
2545
2546 std::string const tmp = GetTempDir();
2547
226c0f64
DK
2548 if (seteuid(old_euid) != 0)
2549 _error->Errno("seteuid", "seteuid %u failed", old_euid);
2550 if (setegid(old_egid) != 0)
2551 _error->Errno("setegid", "setegid %u failed", old_egid);
dd6da7d2
DK
2552
2553 return tmp;
68e01721 2554}
f8aba23f 2555 /*}}}*/
c9443c01 2556FileFd* GetTempFile(std::string const &Prefix, bool ImmediateUnlink, FileFd * const TmpFd) /*{{{*/
0d29b9d4
MV
2557{
2558 char fn[512];
c9443c01 2559 FileFd * const Fd = TmpFd == NULL ? new FileFd() : TmpFd;
0d29b9d4 2560
c9443c01
DK
2561 std::string const tempdir = GetTempDir();
2562 snprintf(fn, sizeof(fn), "%s/%s.XXXXXX",
0d29b9d4 2563 tempdir.c_str(), Prefix.c_str());
c9443c01 2564 int const fd = mkstemp(fn);
0d29b9d4
MV
2565 if(ImmediateUnlink)
2566 unlink(fn);
c9443c01 2567 if (fd < 0)
0d29b9d4
MV
2568 {
2569 _error->Errno("GetTempFile",_("Unable to mkstemp %s"), fn);
2570 return NULL;
2571 }
c9443c01 2572 if (!Fd->OpenDescriptor(fd, FileFd::ReadWrite, FileFd::None, true))
0d29b9d4
MV
2573 {
2574 _error->Errno("GetTempFile",_("Unable to write to %s"),fn);
2575 return NULL;
2576 }
0d29b9d4
MV
2577 return Fd;
2578}
f8aba23f
DK
2579 /*}}}*/
2580bool Rename(std::string From, std::string To) /*{{{*/
c1409d1b
MV
2581{
2582 if (rename(From.c_str(),To.c_str()) != 0)
2583 {
2584 _error->Error(_("rename failed, %s (%s -> %s)."),strerror(errno),
2585 From.c_str(),To.c_str());
2586 return false;
f8aba23f 2587 }
c1409d1b
MV
2588 return true;
2589}
f8aba23f
DK
2590 /*}}}*/
2591bool Popen(const char* Args[], FileFd &Fd, pid_t &Child, FileFd::OpenMode Mode)/*{{{*/
7ad2a347
MV
2592{
2593 int fd;
2594 if (Mode != FileFd::ReadOnly && Mode != FileFd::WriteOnly)
2595 return _error->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2596
2597 int Pipe[2] = {-1, -1};
2598 if(pipe(Pipe) != 0)
7ad2a347 2599 return _error->Errno("pipe", _("Failed to create subprocess IPC"));
5e49cbb7 2600
7ad2a347
MV
2601 std::set<int> keep_fds;
2602 keep_fds.insert(Pipe[0]);
2603 keep_fds.insert(Pipe[1]);
2604 Child = ExecFork(keep_fds);
2605 if(Child < 0)
2606 return _error->Errno("fork", "Failed to fork");
2607 if(Child == 0)
2608 {
2609 if(Mode == FileFd::ReadOnly)
2610 {
2611 close(Pipe[0]);
2612 fd = Pipe[1];
2613 }
2614 else if(Mode == FileFd::WriteOnly)
2615 {
2616 close(Pipe[1]);
2617 fd = Pipe[0];
2618 }
2619
2620 if(Mode == FileFd::ReadOnly)
2621 {
2622 dup2(fd, 1);
2623 dup2(fd, 2);
2624 } else if(Mode == FileFd::WriteOnly)
2625 dup2(fd, 0);
2626
2627 execv(Args[0], (char**)Args);
2628 _exit(100);
2629 }
2630 if(Mode == FileFd::ReadOnly)
2631 {
2632 close(Pipe[1]);
2633 fd = Pipe[0];
8f5b67ae
DK
2634 }
2635 else if(Mode == FileFd::WriteOnly)
7ad2a347
MV
2636 {
2637 close(Pipe[0]);
2638 fd = Pipe[1];
2639 }
8f5b67ae
DK
2640 else
2641 return _error->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
7ad2a347
MV
2642 Fd.OpenDescriptor(fd, Mode, FileFd::None, true);
2643
2644 return true;
2645}
f8aba23f
DK
2646 /*}}}*/
2647bool DropPrivileges() /*{{{*/
fc1a78d8 2648{
8f45798d
DK
2649 if(_config->FindB("Debug::NoDropPrivs", false) == true)
2650 return true;
2651
2652#if __gnu_linux__
2653#if defined(PR_SET_NO_NEW_PRIVS) && ( PR_SET_NO_NEW_PRIVS != 38 )
2654#error "PR_SET_NO_NEW_PRIVS is defined, but with a different value than expected!"
2655#endif
2656 // see prctl(2), needs linux3.5 at runtime - magic constant to avoid it at buildtime
2657 int ret = prctl(38, 1, 0, 0, 0);
2658 // ignore EINVAL - kernel is too old to understand the option
2659 if(ret < 0 && errno != EINVAL)
2660 _error->Warning("PR_SET_NO_NEW_PRIVS failed with %i", ret);
2661#endif
2662
990dd78a
DK
2663 // empty setting disables privilege dropping - this also ensures
2664 // backward compatibility, see bug #764506
2665 const std::string toUser = _config->Find("APT::Sandbox::User");
514a25cb 2666 if (toUser.empty() || toUser == "root")
990dd78a
DK
2667 return true;
2668
ebca2f25
DK
2669 // a lot can go wrong trying to drop privileges completely,
2670 // so ideally we would like to verify that we have done it –
2671 // but the verify asks for too much in case of fakeroot (and alike)
2672 // [Specific checks can be overridden with dedicated options]
2673 bool const VerifySandboxing = _config->FindB("APT::Sandbox::Verify", false);
2674
f1e3c8f0 2675 // uid will be 0 in the end, but gid might be different anyway
8f45798d
DK
2676 uid_t const old_uid = getuid();
2677 gid_t const old_gid = getgid();
fc1a78d8 2678
5f2047ec
JAK
2679 if (old_uid != 0)
2680 return true;
3927c6da 2681
b8dae9a1 2682 struct passwd *pw = getpwnam(toUser.c_str());
fc1a78d8 2683 if (pw == NULL)
b8dae9a1 2684 return _error->Error("No user %s, can not drop rights", toUser.c_str());
3927c6da 2685
f1e3c8f0 2686 // Do not change the order here, it might break things
5a326439 2687 // Get rid of all our supplementary groups first
3b084f06 2688 if (setgroups(1, &pw->pw_gid))
3927c6da
MV
2689 return _error->Errno("setgroups", "Failed to setgroups");
2690
5a326439
JAK
2691 // Now change the group ids to the new user
2692#ifdef HAVE_SETRESGID
2693 if (setresgid(pw->pw_gid, pw->pw_gid, pw->pw_gid) != 0)
2694 return _error->Errno("setresgid", "Failed to set new group ids");
2695#else
3927c6da 2696 if (setegid(pw->pw_gid) != 0)
5f2047ec
JAK
2697 return _error->Errno("setegid", "Failed to setegid");
2698
fc1a78d8
MV
2699 if (setgid(pw->pw_gid) != 0)
2700 return _error->Errno("setgid", "Failed to setgid");
5a326439 2701#endif
5f2047ec 2702
5a326439
JAK
2703 // Change the user ids to the new user
2704#ifdef HAVE_SETRESUID
2705 if (setresuid(pw->pw_uid, pw->pw_uid, pw->pw_uid) != 0)
2706 return _error->Errno("setresuid", "Failed to set new user ids");
2707#else
fc1a78d8
MV
2708 if (setuid(pw->pw_uid) != 0)
2709 return _error->Errno("setuid", "Failed to setuid");
5f2047ec
JAK
2710 if (seteuid(pw->pw_uid) != 0)
2711 return _error->Errno("seteuid", "Failed to seteuid");
5a326439 2712#endif
5f2047ec 2713
ebca2f25
DK
2714 // disabled by default as fakeroot doesn't implement getgroups currently (#806521)
2715 if (VerifySandboxing == true || _config->FindB("APT::Sandbox::Verify::Groups", false) == true)
2716 {
2717 // Verify that the user isn't still in any supplementary groups
2718 long const ngroups_max = sysconf(_SC_NGROUPS_MAX);
2719 std::unique_ptr<gid_t[]> gidlist(new gid_t[ngroups_max]);
2720 if (unlikely(gidlist == NULL))
2721 return _error->Error("Allocation of a list of size %lu for getgroups failed", ngroups_max);
2722 ssize_t gidlist_nr;
2723 if ((gidlist_nr = getgroups(ngroups_max, gidlist.get())) < 0)
2724 return _error->Errno("getgroups", "Could not get new groups (%lu)", ngroups_max);
2725 for (ssize_t i = 0; i < gidlist_nr; ++i)
2726 if (gidlist[i] != pw->pw_gid)
2727 return _error->Error("Could not switch group, user %s is still in group %d", toUser.c_str(), gidlist[i]);
2728 }
2729
2730 // enabled by default as all fakeroot-lookalikes should fake that accordingly
2731 if (VerifySandboxing == true || _config->FindB("APT::Sandbox::Verify::IDs", true) == true)
2732 {
2733 // Verify that gid, egid, uid, and euid changed
2734 if (getgid() != pw->pw_gid)
2735 return _error->Error("Could not switch group");
2736 if (getegid() != pw->pw_gid)
2737 return _error->Error("Could not switch effective group");
2738 if (getuid() != pw->pw_uid)
2739 return _error->Error("Could not switch user");
2740 if (geteuid() != pw->pw_uid)
2741 return _error->Error("Could not switch effective user");
5f2047ec 2742
550ab420 2743#ifdef HAVE_GETRESUID
ebca2f25
DK
2744 // verify that the saved set-user-id was changed as well
2745 uid_t ruid = 0;
2746 uid_t euid = 0;
2747 uid_t suid = 0;
2748 if (getresuid(&ruid, &euid, &suid))
2749 return _error->Errno("getresuid", "Could not get saved set-user-ID");
2750 if (suid != pw->pw_uid)
2751 return _error->Error("Could not switch saved set-user-ID");
550ab420
JAK
2752#endif
2753
2754#ifdef HAVE_GETRESGID
ebca2f25
DK
2755 // verify that the saved set-group-id was changed as well
2756 gid_t rgid = 0;
2757 gid_t egid = 0;
2758 gid_t sgid = 0;
2759 if (getresgid(&rgid, &egid, &sgid))
2760 return _error->Errno("getresuid", "Could not get saved set-group-ID");
2761 if (sgid != pw->pw_gid)
2762 return _error->Error("Could not switch saved set-group-ID");
550ab420 2763#endif
ebca2f25 2764 }
550ab420 2765
ebca2f25
DK
2766 // disabled as fakeroot doesn't forbid (by design) (re)gaining root from unprivileged
2767 if (VerifySandboxing == true || _config->FindB("APT::Sandbox::Verify::Regain", false) == true)
2768 {
2769 // Check that uid and gid changes do not work anymore
2770 if (pw->pw_gid != old_gid && (setgid(old_gid) != -1 || setegid(old_gid) != -1))
2771 return _error->Error("Could restore a gid to root, privilege dropping did not work");
bdc00df5 2772
ebca2f25
DK
2773 if (pw->pw_uid != old_uid && (setuid(old_uid) != -1 || seteuid(old_uid) != -1))
2774 return _error->Error("Could restore a uid to root, privilege dropping did not work");
2775 }
bdc00df5 2776
fc1a78d8
MV
2777 return true;
2778}
f8aba23f 2779 /*}}}*/