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