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