]> git.saurik.com Git - apt.git/blob - apt-pkg/contrib/fileutl.cc
fa0930dff9e717a89a587590f304d06afbdab3bc
[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
1281 writebuffer.reset();
1282 return true;
1283 }
1284 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) APT_OVERRIDE
1285 {
1286 // Optimisation: If the buffer is empty and we have more to write than
1287 // would fit in the buffer (or equal number of bytes), write directly.
1288 if (writebuffer.empty() == true && Size >= writebuffer.free())
1289 return wrapped->InternalWrite(From, Size);
1290
1291 // Write as much into the buffer as possible and then flush if needed
1292 auto written = writebuffer.write(From, Size);
1293
1294 if (writebuffer.full() && InternalFlush() == false)
1295 return -1;
1296
1297 return written;
1298 }
1299 virtual bool InternalWriteError() APT_OVERRIDE
1300 {
1301 return wrapped->InternalWriteError();
1302 }
1303 virtual bool InternalSeek(unsigned long long const To) APT_OVERRIDE
1304 {
1305 if (InternalFlush() == false)
1306 return false;
1307 return wrapped->InternalSeek(To);
1308 }
1309 virtual bool InternalSkip(unsigned long long Over) APT_OVERRIDE
1310 {
1311 if (InternalFlush() == false)
1312 return false;
1313 return wrapped->InternalSkip(Over);
1314 }
1315 virtual bool InternalTruncate(unsigned long long const Size) APT_OVERRIDE
1316 {
1317 if (InternalFlush() == false)
1318 return false;
1319 return wrapped->InternalTruncate(Size);
1320 }
1321 virtual unsigned long long InternalTell() APT_OVERRIDE
1322 {
1323 if (InternalFlush() == false)
1324 return -1;
1325 return wrapped->InternalTell();
1326 }
1327 virtual unsigned long long InternalSize() APT_OVERRIDE
1328 {
1329 if (InternalFlush() == false)
1330 return -1;
1331 return wrapped->InternalSize();
1332 }
1333 virtual bool InternalClose(std::string const &FileName) APT_OVERRIDE
1334 {
1335 return wrapped->InternalClose(FileName);
1336 }
1337 virtual bool InternalAlwaysAutoClose() const APT_OVERRIDE
1338 {
1339 return wrapped->InternalAlwaysAutoClose();
1340 }
1341 virtual ~BufferedWriteFileFdPrivate()
1342 {
1343 delete wrapped;
1344 }
1345 };
1346 /*}}}*/
1347 class APT_HIDDEN GzipFileFdPrivate: public FileFdPrivate { /*{{{*/
1348 #ifdef HAVE_ZLIB
1349 public:
1350 gzFile gz;
1351 virtual bool InternalOpen(int const iFd, unsigned int const Mode) APT_OVERRIDE
1352 {
1353 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1354 gz = gzdopen(iFd, "r+");
1355 else if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1356 gz = gzdopen(iFd, "w");
1357 else
1358 gz = gzdopen(iFd, "r");
1359 filefd->Flags |= FileFd::Compressed;
1360 return gz != nullptr;
1361 }
1362 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) APT_OVERRIDE
1363 {
1364 return gzread(gz, To, Size);
1365 }
1366 virtual bool InternalReadError() APT_OVERRIDE
1367 {
1368 int err;
1369 char const * const errmsg = gzerror(gz, &err);
1370 if (err != Z_ERRNO)
1371 return filefd->FileFdError("gzread: %s (%d: %s)", _("Read error"), err, errmsg);
1372 return FileFdPrivate::InternalReadError();
1373 }
1374 virtual char * InternalReadLine(char * To, unsigned long long Size) APT_OVERRIDE
1375 {
1376 return gzgets(gz, To, Size);
1377 }
1378 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) APT_OVERRIDE
1379 {
1380 return gzwrite(gz,From,Size);
1381 }
1382 virtual bool InternalWriteError() APT_OVERRIDE
1383 {
1384 int err;
1385 char const * const errmsg = gzerror(gz, &err);
1386 if (err != Z_ERRNO)
1387 return filefd->FileFdError("gzwrite: %s (%d: %s)", _("Write error"), err, errmsg);
1388 return FileFdPrivate::InternalWriteError();
1389 }
1390 virtual bool InternalSeek(unsigned long long const To) APT_OVERRIDE
1391 {
1392 off_t const res = gzseek(gz, To, SEEK_SET);
1393 if (res != (off_t)To)
1394 return filefd->FileFdError("Unable to seek to %llu", To);
1395 seekpos = To;
1396 buffer.reset();
1397 return true;
1398 }
1399 virtual bool InternalSkip(unsigned long long Over) APT_OVERRIDE
1400 {
1401 if (Over >= buffer.size())
1402 {
1403 Over -= buffer.size();
1404 buffer.reset();
1405 }
1406 else
1407 {
1408 buffer.bufferstart += Over;
1409 return true;
1410 }
1411 if (Over == 0)
1412 return true;
1413 off_t const res = gzseek(gz, Over, SEEK_CUR);
1414 if (res < 0)
1415 return filefd->FileFdError("Unable to seek ahead %llu",Over);
1416 seekpos = res;
1417 return true;
1418 }
1419 virtual unsigned long long InternalTell() APT_OVERRIDE
1420 {
1421 return gztell(gz) - buffer.size();
1422 }
1423 virtual unsigned long long InternalSize() APT_OVERRIDE
1424 {
1425 unsigned long long filesize = FileFdPrivate::InternalSize();
1426 // only check gzsize if we are actually a gzip file, just checking for
1427 // "gz" is not sufficient as uncompressed files could be opened with
1428 // gzopen in "direct" mode as well
1429 if (filesize == 0 || gzdirect(gz))
1430 return filesize;
1431
1432 off_t const oldPos = lseek(filefd->iFd, 0, SEEK_CUR);
1433 /* unfortunately zlib.h doesn't provide a gzsize(), so we have to do
1434 * this ourselves; the original (uncompressed) file size is the last 32
1435 * bits of the file */
1436 // FIXME: Size for gz-files is limited by 32bit… no largefile support
1437 if (lseek(filefd->iFd, -4, SEEK_END) < 0)
1438 {
1439 filefd->FileFdErrno("lseek","Unable to seek to end of gzipped file");
1440 return 0;
1441 }
1442 uint32_t size = 0;
1443 if (read(filefd->iFd, &size, 4) != 4)
1444 {
1445 filefd->FileFdErrno("read","Unable to read original size of gzipped file");
1446 return 0;
1447 }
1448 size = le32toh(size);
1449
1450 if (lseek(filefd->iFd, oldPos, SEEK_SET) < 0)
1451 {
1452 filefd->FileFdErrno("lseek","Unable to seek in gzipped file");
1453 return 0;
1454 }
1455 return size;
1456 }
1457 virtual bool InternalClose(std::string const &FileName) APT_OVERRIDE
1458 {
1459 if (gz == nullptr)
1460 return true;
1461 int const e = gzclose(gz);
1462 gz = nullptr;
1463 // gzdclose() on empty files always fails with "buffer error" here, ignore that
1464 if (e != 0 && e != Z_BUF_ERROR)
1465 return _error->Errno("close",_("Problem closing the gzip file %s"), FileName.c_str());
1466 return true;
1467 }
1468
1469 explicit GzipFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd), gz(nullptr) {}
1470 virtual ~GzipFileFdPrivate() { InternalClose(""); }
1471 #endif
1472 };
1473 /*}}}*/
1474 class APT_HIDDEN Bz2FileFdPrivate: public FileFdPrivate { /*{{{*/
1475 #ifdef HAVE_BZ2
1476 BZFILE* bz2;
1477 public:
1478 virtual bool InternalOpen(int const iFd, unsigned int const Mode) APT_OVERRIDE
1479 {
1480 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1481 bz2 = BZ2_bzdopen(iFd, "r+");
1482 else if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1483 bz2 = BZ2_bzdopen(iFd, "w");
1484 else
1485 bz2 = BZ2_bzdopen(iFd, "r");
1486 filefd->Flags |= FileFd::Compressed;
1487 return bz2 != nullptr;
1488 }
1489 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) APT_OVERRIDE
1490 {
1491 return BZ2_bzread(bz2, To, Size);
1492 }
1493 virtual bool InternalReadError() APT_OVERRIDE
1494 {
1495 int err;
1496 char const * const errmsg = BZ2_bzerror(bz2, &err);
1497 if (err != BZ_IO_ERROR)
1498 return filefd->FileFdError("BZ2_bzread: %s %s (%d: %s)", filefd->FileName.c_str(), _("Read error"), err, errmsg);
1499 return FileFdPrivate::InternalReadError();
1500 }
1501 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) APT_OVERRIDE
1502 {
1503 return BZ2_bzwrite(bz2, (void*)From, Size);
1504 }
1505 virtual bool InternalWriteError() APT_OVERRIDE
1506 {
1507 int err;
1508 char const * const errmsg = BZ2_bzerror(bz2, &err);
1509 if (err != BZ_IO_ERROR)
1510 return filefd->FileFdError("BZ2_bzwrite: %s %s (%d: %s)", filefd->FileName.c_str(), _("Write error"), err, errmsg);
1511 return FileFdPrivate::InternalWriteError();
1512 }
1513 virtual bool InternalStream() const APT_OVERRIDE { return true; }
1514 virtual bool InternalClose(std::string const &) APT_OVERRIDE
1515 {
1516 if (bz2 == nullptr)
1517 return true;
1518 BZ2_bzclose(bz2);
1519 bz2 = nullptr;
1520 return true;
1521 }
1522
1523 explicit Bz2FileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd), bz2(nullptr) {}
1524 virtual ~Bz2FileFdPrivate() { InternalClose(""); }
1525 #endif
1526 };
1527 /*}}}*/
1528 class APT_HIDDEN Lz4FileFdPrivate: public FileFdPrivate { /*{{{*/
1529 static constexpr unsigned long long LZ4_HEADER_SIZE = 19;
1530 static constexpr unsigned long long LZ4_FOOTER_SIZE = 4;
1531 #ifdef HAVE_LZ4
1532 LZ4F_decompressionContext_t dctx;
1533 LZ4F_compressionContext_t cctx;
1534 LZ4F_errorCode_t res;
1535 FileFd backend;
1536 simple_buffer lz4_buffer;
1537 // Count of bytes that the decompressor expects to read next, or buffer size.
1538 size_t next_to_load = APT_BUFFER_SIZE;
1539 public:
1540 virtual bool InternalOpen(int const iFd, unsigned int const Mode) APT_OVERRIDE
1541 {
1542 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1543 return _error->Error("lz4 only supports write or read mode");
1544
1545 if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly) {
1546 res = LZ4F_createCompressionContext(&cctx, LZ4F_VERSION);
1547 lz4_buffer.reset(LZ4F_compressBound(APT_BUFFER_SIZE, nullptr)
1548 + LZ4_HEADER_SIZE + LZ4_FOOTER_SIZE);
1549 } else {
1550 res = LZ4F_createDecompressionContext(&dctx, LZ4F_VERSION);
1551 lz4_buffer.reset(APT_BUFFER_SIZE);
1552 }
1553
1554 filefd->Flags |= FileFd::Compressed;
1555
1556 if (LZ4F_isError(res))
1557 return false;
1558
1559 unsigned int flags = (Mode & (FileFd::WriteOnly|FileFd::ReadOnly));
1560 if (backend.OpenDescriptor(iFd, flags, FileFd::None, true) == false)
1561 return false;
1562
1563 // Write the file header
1564 if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1565 {
1566 res = LZ4F_compressBegin(cctx, lz4_buffer.buffer, lz4_buffer.buffersize_max, nullptr);
1567 if (LZ4F_isError(res) || backend.Write(lz4_buffer.buffer, res) == false)
1568 return false;
1569 }
1570
1571 return true;
1572 }
1573 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) APT_OVERRIDE
1574 {
1575 /* Keep reading as long as the compressor still wants to read */
1576 while (next_to_load) {
1577 // Fill compressed buffer;
1578 if (lz4_buffer.empty()) {
1579 unsigned long long read;
1580 /* Reset - if LZ4 decompressor wants to read more, allocate more */
1581 lz4_buffer.reset(next_to_load);
1582 if (backend.Read(lz4_buffer.getend(), lz4_buffer.free(), &read) == false)
1583 return -1;
1584 lz4_buffer.bufferend += read;
1585
1586 /* Expected EOF */
1587 if (read == 0) {
1588 res = -1;
1589 return filefd->FileFdError("LZ4F: %s %s",
1590 filefd->FileName.c_str(),
1591 _("Unexpected end of file")), -1;
1592 }
1593 }
1594 // Drain compressed buffer as far as possible.
1595 size_t in = lz4_buffer.size();
1596 size_t out = Size;
1597
1598 res = LZ4F_decompress(dctx, To, &out, lz4_buffer.get(), &in, nullptr);
1599 if (LZ4F_isError(res))
1600 return -1;
1601
1602 next_to_load = res;
1603 lz4_buffer.bufferstart += in;
1604
1605 if (out != 0)
1606 return out;
1607 }
1608
1609 return 0;
1610 }
1611 virtual bool InternalReadError() APT_OVERRIDE
1612 {
1613 char const * const errmsg = LZ4F_getErrorName(res);
1614
1615 return filefd->FileFdError("LZ4F: %s %s (%zu: %s)", filefd->FileName.c_str(), _("Read error"), res, errmsg);
1616 }
1617 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) APT_OVERRIDE
1618 {
1619 unsigned long long const towrite = std::min(APT_BUFFER_SIZE, Size);
1620
1621 res = LZ4F_compressUpdate(cctx,
1622 lz4_buffer.buffer, lz4_buffer.buffersize_max,
1623 From, towrite, nullptr);
1624
1625 if (LZ4F_isError(res) || backend.Write(lz4_buffer.buffer, res) == false)
1626 return -1;
1627
1628 return towrite;
1629 }
1630 virtual bool InternalWriteError() APT_OVERRIDE
1631 {
1632 char const * const errmsg = LZ4F_getErrorName(res);
1633
1634 return filefd->FileFdError("LZ4F: %s %s (%zu: %s)", filefd->FileName.c_str(), _("Write error"), res, errmsg);
1635 }
1636 virtual bool InternalStream() const APT_OVERRIDE { return true; }
1637
1638 virtual bool InternalFlush() APT_OVERRIDE
1639 {
1640 return backend.Flush();
1641 }
1642
1643 virtual bool InternalClose(std::string const &) APT_OVERRIDE
1644 {
1645 /* Reset variables */
1646 res = 0;
1647 next_to_load = APT_BUFFER_SIZE;
1648
1649 if (cctx != nullptr)
1650 {
1651 if (filefd->Failed() == false)
1652 {
1653 res = LZ4F_compressEnd(cctx, lz4_buffer.buffer, lz4_buffer.buffersize_max, nullptr);
1654 if (LZ4F_isError(res) || backend.Write(lz4_buffer.buffer, res) == false)
1655 return false;
1656 if (!backend.Flush())
1657 return false;
1658 }
1659 if (!backend.Close())
1660 return false;
1661
1662 res = LZ4F_freeCompressionContext(cctx);
1663 cctx = nullptr;
1664 }
1665
1666 if (dctx != nullptr)
1667 {
1668 res = LZ4F_freeDecompressionContext(dctx);
1669 dctx = nullptr;
1670 }
1671 if (backend.IsOpen())
1672 {
1673 backend.Close();
1674 filefd->iFd = -1;
1675 }
1676
1677 return LZ4F_isError(res) == false;
1678 }
1679
1680 explicit Lz4FileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd), dctx(nullptr), cctx(nullptr) {}
1681 virtual ~Lz4FileFdPrivate() {
1682 InternalClose("");
1683 }
1684 #endif
1685 };
1686 /*}}}*/
1687 class APT_HIDDEN LzmaFileFdPrivate: public FileFdPrivate { /*{{{*/
1688 #ifdef HAVE_LZMA
1689 struct LZMAFILE {
1690 FILE* file;
1691 FileFd * const filefd;
1692 uint8_t buffer[4096];
1693 lzma_stream stream;
1694 lzma_ret err;
1695 bool eof;
1696 bool compressing;
1697
1698 LZMAFILE(FileFd * const fd) : file(nullptr), filefd(fd), eof(false), compressing(false) { buffer[0] = '\0'; }
1699 ~LZMAFILE()
1700 {
1701 if (compressing == true && filefd->Failed() == false)
1702 {
1703 size_t constexpr buffersize = sizeof(buffer)/sizeof(buffer[0]);
1704 while(true)
1705 {
1706 stream.avail_out = buffersize;
1707 stream.next_out = buffer;
1708 err = lzma_code(&stream, LZMA_FINISH);
1709 if (err != LZMA_OK && err != LZMA_STREAM_END)
1710 {
1711 _error->Error("~LZMAFILE: Compress finalisation failed");
1712 break;
1713 }
1714 size_t const n = buffersize - stream.avail_out;
1715 if (n && fwrite(buffer, 1, n, file) != n)
1716 {
1717 _error->Errno("~LZMAFILE",_("Write error"));
1718 break;
1719 }
1720 if (err == LZMA_STREAM_END)
1721 break;
1722 }
1723 }
1724 lzma_end(&stream);
1725 fclose(file);
1726 }
1727 };
1728 LZMAFILE* lzma;
1729 static uint32_t findXZlevel(std::vector<std::string> const &Args)
1730 {
1731 for (auto a = Args.rbegin(); a != Args.rend(); ++a)
1732 if (a->empty() == false && (*a)[0] == '-' && (*a)[1] != '-')
1733 {
1734 auto const number = a->find_last_of("0123456789");
1735 if (number == std::string::npos)
1736 continue;
1737 auto const extreme = a->find("e", number);
1738 uint32_t level = (extreme != std::string::npos) ? LZMA_PRESET_EXTREME : 0;
1739 switch ((*a)[number])
1740 {
1741 case '0': return level | 0;
1742 case '1': return level | 1;
1743 case '2': return level | 2;
1744 case '3': return level | 3;
1745 case '4': return level | 4;
1746 case '5': return level | 5;
1747 case '6': return level | 6;
1748 case '7': return level | 7;
1749 case '8': return level | 8;
1750 case '9': return level | 9;
1751 }
1752 }
1753 return 6;
1754 }
1755 public:
1756 virtual bool InternalOpen(int const iFd, unsigned int const Mode) APT_OVERRIDE
1757 {
1758 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1759 return filefd->FileFdError("ReadWrite mode is not supported for lzma/xz files %s", filefd->FileName.c_str());
1760
1761 if (lzma == nullptr)
1762 lzma = new LzmaFileFdPrivate::LZMAFILE(filefd);
1763 if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1764 lzma->file = fdopen(iFd, "w");
1765 else
1766 lzma->file = fdopen(iFd, "r");
1767 filefd->Flags |= FileFd::Compressed;
1768 if (lzma->file == nullptr)
1769 return false;
1770
1771 lzma_stream tmp_stream = LZMA_STREAM_INIT;
1772 lzma->stream = tmp_stream;
1773
1774 if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1775 {
1776 uint32_t const xzlevel = findXZlevel(compressor.CompressArgs);
1777 if (compressor.Name == "xz")
1778 {
1779 if (lzma_easy_encoder(&lzma->stream, xzlevel, LZMA_CHECK_CRC64) != LZMA_OK)
1780 return false;
1781 }
1782 else
1783 {
1784 lzma_options_lzma options;
1785 lzma_lzma_preset(&options, xzlevel);
1786 if (lzma_alone_encoder(&lzma->stream, &options) != LZMA_OK)
1787 return false;
1788 }
1789 lzma->compressing = true;
1790 }
1791 else
1792 {
1793 uint64_t const memlimit = UINT64_MAX;
1794 if (compressor.Name == "xz")
1795 {
1796 if (lzma_auto_decoder(&lzma->stream, memlimit, 0) != LZMA_OK)
1797 return false;
1798 }
1799 else
1800 {
1801 if (lzma_alone_decoder(&lzma->stream, memlimit) != LZMA_OK)
1802 return false;
1803 }
1804 lzma->compressing = false;
1805 }
1806 return true;
1807 }
1808 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) APT_OVERRIDE
1809 {
1810 ssize_t Res;
1811 if (lzma->eof == true)
1812 return 0;
1813
1814 lzma->stream.next_out = (uint8_t *) To;
1815 lzma->stream.avail_out = Size;
1816 if (lzma->stream.avail_in == 0)
1817 {
1818 lzma->stream.next_in = lzma->buffer;
1819 lzma->stream.avail_in = fread(lzma->buffer, 1, sizeof(lzma->buffer)/sizeof(lzma->buffer[0]), lzma->file);
1820 }
1821 lzma->err = lzma_code(&lzma->stream, LZMA_RUN);
1822 if (lzma->err == LZMA_STREAM_END)
1823 {
1824 lzma->eof = true;
1825 Res = Size - lzma->stream.avail_out;
1826 }
1827 else if (lzma->err != LZMA_OK)
1828 {
1829 Res = -1;
1830 errno = 0;
1831 }
1832 else
1833 {
1834 Res = Size - lzma->stream.avail_out;
1835 if (Res == 0)
1836 {
1837 // lzma run was okay, but produced no output…
1838 Res = -1;
1839 errno = EINTR;
1840 }
1841 }
1842 return Res;
1843 }
1844 virtual bool InternalReadError() APT_OVERRIDE
1845 {
1846 return filefd->FileFdError("lzma_read: %s (%d)", _("Read error"), lzma->err);
1847 }
1848 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) APT_OVERRIDE
1849 {
1850 ssize_t Res;
1851 lzma->stream.next_in = (uint8_t *)From;
1852 lzma->stream.avail_in = Size;
1853 lzma->stream.next_out = lzma->buffer;
1854 lzma->stream.avail_out = sizeof(lzma->buffer)/sizeof(lzma->buffer[0]);
1855 lzma->err = lzma_code(&lzma->stream, LZMA_RUN);
1856 if (lzma->err != LZMA_OK)
1857 return -1;
1858 size_t const n = sizeof(lzma->buffer)/sizeof(lzma->buffer[0]) - lzma->stream.avail_out;
1859 size_t const m = (n == 0) ? 0 : fwrite(lzma->buffer, 1, n, lzma->file);
1860 if (m != n)
1861 {
1862 Res = -1;
1863 errno = 0;
1864 }
1865 else
1866 {
1867 Res = Size - lzma->stream.avail_in;
1868 if (Res == 0)
1869 {
1870 // lzma run was okay, but produced no output…
1871 Res = -1;
1872 errno = EINTR;
1873 }
1874 }
1875 return Res;
1876 }
1877 virtual bool InternalWriteError() APT_OVERRIDE
1878 {
1879 return filefd->FileFdError("lzma_write: %s (%d)", _("Write error"), lzma->err);
1880 }
1881 virtual bool InternalStream() const APT_OVERRIDE { return true; }
1882 virtual bool InternalClose(std::string const &) APT_OVERRIDE
1883 {
1884 delete lzma;
1885 lzma = nullptr;
1886 return true;
1887 }
1888
1889 explicit LzmaFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd), lzma(nullptr) {}
1890 virtual ~LzmaFileFdPrivate() { InternalClose(""); }
1891 #endif
1892 };
1893 /*}}}*/
1894 class APT_HIDDEN PipedFileFdPrivate: public FileFdPrivate /*{{{*/
1895 /* if we don't have a specific class dealing with library calls, we (un)compress
1896 by executing a specified binary and pipe in/out what we need */
1897 {
1898 public:
1899 virtual bool InternalOpen(int const, unsigned int const Mode) APT_OVERRIDE
1900 {
1901 // collect zombies here in case we reopen
1902 if (compressor_pid > 0)
1903 ExecWait(compressor_pid, "FileFdCompressor", true);
1904
1905 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1906 return filefd->FileFdError("ReadWrite mode is not supported for file %s", filefd->FileName.c_str());
1907 if (compressor.Binary == "false")
1908 return filefd->FileFdError("libapt has inbuilt support for the %s compression,"
1909 " but was forced to ignore it in favor of an external binary – which isn't installed.", compressor.Name.c_str());
1910
1911 bool const Comp = (Mode & FileFd::WriteOnly) == FileFd::WriteOnly;
1912 if (Comp == false)
1913 {
1914 // Handle 'decompression' of empty files
1915 struct stat Buf;
1916 fstat(filefd->iFd, &Buf);
1917 if (Buf.st_size == 0 && S_ISFIFO(Buf.st_mode) == false)
1918 return true;
1919
1920 // We don't need the file open - instead let the compressor open it
1921 // as he properly knows better how to efficiently read from 'his' file
1922 if (filefd->FileName.empty() == false)
1923 {
1924 close(filefd->iFd);
1925 filefd->iFd = -1;
1926 }
1927 }
1928
1929 // Create a data pipe
1930 int Pipe[2] = {-1,-1};
1931 if (pipe(Pipe) != 0)
1932 return filefd->FileFdErrno("pipe",_("Failed to create subprocess IPC"));
1933 for (int J = 0; J != 2; J++)
1934 SetCloseExec(Pipe[J],true);
1935
1936 compressed_fd = filefd->iFd;
1937 set_is_pipe(true);
1938
1939 if (Comp == true)
1940 filefd->iFd = Pipe[1];
1941 else
1942 filefd->iFd = Pipe[0];
1943
1944 // The child..
1945 compressor_pid = ExecFork();
1946 if (compressor_pid == 0)
1947 {
1948 if (Comp == true)
1949 {
1950 dup2(compressed_fd,STDOUT_FILENO);
1951 dup2(Pipe[0],STDIN_FILENO);
1952 }
1953 else
1954 {
1955 if (compressed_fd != -1)
1956 dup2(compressed_fd,STDIN_FILENO);
1957 dup2(Pipe[1],STDOUT_FILENO);
1958 }
1959 int const nullfd = open("/dev/null", O_WRONLY);
1960 if (nullfd != -1)
1961 {
1962 dup2(nullfd,STDERR_FILENO);
1963 close(nullfd);
1964 }
1965
1966 SetCloseExec(STDOUT_FILENO,false);
1967 SetCloseExec(STDIN_FILENO,false);
1968
1969 std::vector<char const*> Args;
1970 Args.push_back(compressor.Binary.c_str());
1971 std::vector<std::string> const * const addArgs =
1972 (Comp == true) ? &(compressor.CompressArgs) : &(compressor.UncompressArgs);
1973 for (std::vector<std::string>::const_iterator a = addArgs->begin();
1974 a != addArgs->end(); ++a)
1975 Args.push_back(a->c_str());
1976 if (Comp == false && filefd->FileName.empty() == false)
1977 {
1978 // commands not needing arguments, do not need to be told about using standard output
1979 // in reality, only testcases with tools like cat, rev, rot13, … are able to trigger this
1980 if (compressor.CompressArgs.empty() == false && compressor.UncompressArgs.empty() == false)
1981 Args.push_back("--stdout");
1982 if (filefd->TemporaryFileName.empty() == false)
1983 Args.push_back(filefd->TemporaryFileName.c_str());
1984 else
1985 Args.push_back(filefd->FileName.c_str());
1986 }
1987 Args.push_back(NULL);
1988
1989 execvp(Args[0],(char **)&Args[0]);
1990 cerr << _("Failed to exec compressor ") << Args[0] << endl;
1991 _exit(100);
1992 }
1993 if (Comp == true)
1994 close(Pipe[0]);
1995 else
1996 close(Pipe[1]);
1997
1998 return true;
1999 }
2000 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) APT_OVERRIDE
2001 {
2002 return read(filefd->iFd, To, Size);
2003 }
2004 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) APT_OVERRIDE
2005 {
2006 return write(filefd->iFd, From, Size);
2007 }
2008 virtual bool InternalClose(std::string const &) APT_OVERRIDE
2009 {
2010 bool Ret = true;
2011 if (filefd->iFd != -1)
2012 {
2013 close(filefd->iFd);
2014 filefd->iFd = -1;
2015 }
2016 if (compressor_pid > 0)
2017 Ret &= ExecWait(compressor_pid, "FileFdCompressor", true);
2018 compressor_pid = -1;
2019 return Ret;
2020 }
2021 explicit PipedFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd) {}
2022 virtual ~PipedFileFdPrivate() { InternalClose(""); }
2023 };
2024 /*}}}*/
2025 class APT_HIDDEN DirectFileFdPrivate: public FileFdPrivate /*{{{*/
2026 {
2027 public:
2028 virtual bool InternalOpen(int const, unsigned int const) APT_OVERRIDE { return true; }
2029 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) APT_OVERRIDE
2030 {
2031 return read(filefd->iFd, To, Size);
2032 }
2033 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) APT_OVERRIDE
2034 {
2035 // files opened read+write are strange and only really "supported" for direct files
2036 if (buffer.size() != 0)
2037 {
2038 lseek(filefd->iFd, -buffer.size(), SEEK_CUR);
2039 buffer.reset();
2040 }
2041 return write(filefd->iFd, From, Size);
2042 }
2043 virtual bool InternalSeek(unsigned long long const To) APT_OVERRIDE
2044 {
2045 off_t const res = lseek(filefd->iFd, To, SEEK_SET);
2046 if (res != (off_t)To)
2047 return filefd->FileFdError("Unable to seek to %llu", To);
2048 seekpos = To;
2049 buffer.reset();
2050 return true;
2051 }
2052 virtual bool InternalSkip(unsigned long long Over) APT_OVERRIDE
2053 {
2054 if (Over >= buffer.size())
2055 {
2056 Over -= buffer.size();
2057 buffer.reset();
2058 }
2059 else
2060 {
2061 buffer.bufferstart += Over;
2062 return true;
2063 }
2064 if (Over == 0)
2065 return true;
2066 off_t const res = lseek(filefd->iFd, Over, SEEK_CUR);
2067 if (res < 0)
2068 return filefd->FileFdError("Unable to seek ahead %llu",Over);
2069 seekpos = res;
2070 return true;
2071 }
2072 virtual bool InternalTruncate(unsigned long long const To) APT_OVERRIDE
2073 {
2074 if (buffer.size() != 0)
2075 {
2076 unsigned long long const seekpos = lseek(filefd->iFd, 0, SEEK_CUR);
2077 if ((seekpos - buffer.size()) >= To)
2078 buffer.reset();
2079 else if (seekpos >= To)
2080 buffer.bufferend = (To - seekpos) + buffer.bufferstart;
2081 else
2082 buffer.reset();
2083 }
2084 if (ftruncate(filefd->iFd, To) != 0)
2085 return filefd->FileFdError("Unable to truncate to %llu",To);
2086 return true;
2087 }
2088 virtual unsigned long long InternalTell() APT_OVERRIDE
2089 {
2090 return lseek(filefd->iFd,0,SEEK_CUR) - buffer.size();
2091 }
2092 virtual unsigned long long InternalSize() APT_OVERRIDE
2093 {
2094 return filefd->FileSize();
2095 }
2096 virtual bool InternalClose(std::string const &) APT_OVERRIDE { return true; }
2097 virtual bool InternalAlwaysAutoClose() const APT_OVERRIDE { return false; }
2098
2099 explicit DirectFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd) {}
2100 virtual ~DirectFileFdPrivate() { InternalClose(""); }
2101 };
2102 /*}}}*/
2103 // FileFd Constructors /*{{{*/
2104 FileFd::FileFd(std::string FileName,unsigned int const Mode,unsigned long AccessMode) : iFd(-1), Flags(0), d(NULL)
2105 {
2106 Open(FileName,Mode, None, AccessMode);
2107 }
2108 FileFd::FileFd(std::string FileName,unsigned int const Mode, CompressMode Compress, unsigned long AccessMode) : iFd(-1), Flags(0), d(NULL)
2109 {
2110 Open(FileName,Mode, Compress, AccessMode);
2111 }
2112 FileFd::FileFd() : iFd(-1), Flags(AutoClose), d(NULL) {}
2113 FileFd::FileFd(int const Fd, unsigned int const Mode, CompressMode Compress) : iFd(-1), Flags(0), d(NULL)
2114 {
2115 OpenDescriptor(Fd, Mode, Compress);
2116 }
2117 FileFd::FileFd(int const Fd, bool const AutoClose) : iFd(-1), Flags(0), d(NULL)
2118 {
2119 OpenDescriptor(Fd, ReadWrite, None, AutoClose);
2120 }
2121 /*}}}*/
2122 // FileFd::Open - Open a file /*{{{*/
2123 // ---------------------------------------------------------------------
2124 /* The most commonly used open mode combinations are given with Mode */
2125 bool FileFd::Open(string FileName,unsigned int const Mode,CompressMode Compress, unsigned long const AccessMode)
2126 {
2127 if (Mode == ReadOnlyGzip)
2128 return Open(FileName, ReadOnly, Gzip, AccessMode);
2129
2130 if (Compress == Auto && (Mode & WriteOnly) == WriteOnly)
2131 return FileFdError("Autodetection on %s only works in ReadOnly openmode!", FileName.c_str());
2132
2133 std::vector<APT::Configuration::Compressor> const compressors = APT::Configuration::getCompressors();
2134 std::vector<APT::Configuration::Compressor>::const_iterator compressor = compressors.begin();
2135 if (Compress == Auto)
2136 {
2137 for (; compressor != compressors.end(); ++compressor)
2138 {
2139 std::string file = FileName + compressor->Extension;
2140 if (FileExists(file) == false)
2141 continue;
2142 FileName = file;
2143 break;
2144 }
2145 }
2146 else if (Compress == Extension)
2147 {
2148 std::string::size_type const found = FileName.find_last_of('.');
2149 std::string ext;
2150 if (found != std::string::npos)
2151 {
2152 ext = FileName.substr(found);
2153 if (ext == ".new" || ext == ".bak")
2154 {
2155 std::string::size_type const found2 = FileName.find_last_of('.', found - 1);
2156 if (found2 != std::string::npos)
2157 ext = FileName.substr(found2, found - found2);
2158 else
2159 ext.clear();
2160 }
2161 }
2162 for (; compressor != compressors.end(); ++compressor)
2163 if (ext == compressor->Extension)
2164 break;
2165 // no matching extension - assume uncompressed (imagine files like 'example.org_Packages')
2166 if (compressor == compressors.end())
2167 for (compressor = compressors.begin(); compressor != compressors.end(); ++compressor)
2168 if (compressor->Name == ".")
2169 break;
2170 }
2171 else
2172 {
2173 std::string name;
2174 switch (Compress)
2175 {
2176 case None: name = "."; break;
2177 case Gzip: name = "gzip"; break;
2178 case Bzip2: name = "bzip2"; break;
2179 case Lzma: name = "lzma"; break;
2180 case Xz: name = "xz"; break;
2181 case Lz4: name = "lz4"; break;
2182 case Auto:
2183 case Extension:
2184 // Unreachable
2185 return FileFdError("Opening File %s in None, Auto or Extension should be already handled?!?", FileName.c_str());
2186 }
2187 for (; compressor != compressors.end(); ++compressor)
2188 if (compressor->Name == name)
2189 break;
2190 if (compressor == compressors.end())
2191 return FileFdError("Can't find a configured compressor %s for file %s", name.c_str(), FileName.c_str());
2192 }
2193
2194 if (compressor == compressors.end())
2195 return FileFdError("Can't find a match for specified compressor mode for file %s", FileName.c_str());
2196 return Open(FileName, Mode, *compressor, AccessMode);
2197 }
2198 bool FileFd::Open(string FileName,unsigned int const Mode,APT::Configuration::Compressor const &compressor, unsigned long const AccessMode)
2199 {
2200 Close();
2201 Flags = AutoClose;
2202
2203 if ((Mode & WriteOnly) != WriteOnly && (Mode & (Atomic | Create | Empty | Exclusive)) != 0)
2204 return FileFdError("ReadOnly mode for %s doesn't accept additional flags!", FileName.c_str());
2205 if ((Mode & ReadWrite) == 0)
2206 return FileFdError("No openmode provided in FileFd::Open for %s", FileName.c_str());
2207
2208 unsigned int OpenMode = Mode;
2209 if (FileName == "/dev/null")
2210 OpenMode = OpenMode & ~(Atomic | Exclusive | Create | Empty);
2211
2212 if ((OpenMode & Atomic) == Atomic)
2213 {
2214 Flags |= Replace;
2215 }
2216 else if ((OpenMode & (Exclusive | Create)) == (Exclusive | Create))
2217 {
2218 // for atomic, this will be done by rename in Close()
2219 RemoveFile("FileFd::Open", FileName);
2220 }
2221 if ((OpenMode & Empty) == Empty)
2222 {
2223 struct stat Buf;
2224 if (lstat(FileName.c_str(),&Buf) == 0 && S_ISLNK(Buf.st_mode))
2225 RemoveFile("FileFd::Open", FileName);
2226 }
2227
2228 int fileflags = 0;
2229 #define if_FLAGGED_SET(FLAG, MODE) if ((OpenMode & FLAG) == FLAG) fileflags |= MODE
2230 if_FLAGGED_SET(ReadWrite, O_RDWR);
2231 else if_FLAGGED_SET(ReadOnly, O_RDONLY);
2232 else if_FLAGGED_SET(WriteOnly, O_WRONLY);
2233
2234 if_FLAGGED_SET(Create, O_CREAT);
2235 if_FLAGGED_SET(Empty, O_TRUNC);
2236 if_FLAGGED_SET(Exclusive, O_EXCL);
2237 #undef if_FLAGGED_SET
2238
2239 if ((OpenMode & Atomic) == Atomic)
2240 {
2241 char *name = strdup((FileName + ".XXXXXX").c_str());
2242
2243 if((iFd = mkstemp(name)) == -1)
2244 {
2245 free(name);
2246 return FileFdErrno("mkstemp", "Could not create temporary file for %s", FileName.c_str());
2247 }
2248
2249 TemporaryFileName = string(name);
2250 free(name);
2251
2252 // umask() will always set the umask and return the previous value, so
2253 // we first set the umask and then reset it to the old value
2254 mode_t const CurrentUmask = umask(0);
2255 umask(CurrentUmask);
2256 // calculate the actual file permissions (just like open/creat)
2257 mode_t const FilePermissions = (AccessMode & ~CurrentUmask);
2258
2259 if(fchmod(iFd, FilePermissions) == -1)
2260 return FileFdErrno("fchmod", "Could not change permissions for temporary file %s", TemporaryFileName.c_str());
2261 }
2262 else
2263 iFd = open(FileName.c_str(), fileflags, AccessMode);
2264
2265 this->FileName = FileName;
2266 if (iFd == -1 || OpenInternDescriptor(OpenMode, compressor) == false)
2267 {
2268 if (iFd != -1)
2269 {
2270 close (iFd);
2271 iFd = -1;
2272 }
2273 return FileFdErrno("open",_("Could not open file %s"), FileName.c_str());
2274 }
2275
2276 SetCloseExec(iFd,true);
2277 return true;
2278 }
2279 /*}}}*/
2280 // FileFd::OpenDescriptor - Open a filedescriptor /*{{{*/
2281 bool FileFd::OpenDescriptor(int Fd, unsigned int const Mode, CompressMode Compress, bool AutoClose)
2282 {
2283 std::vector<APT::Configuration::Compressor> const compressors = APT::Configuration::getCompressors();
2284 std::vector<APT::Configuration::Compressor>::const_iterator compressor = compressors.begin();
2285 std::string name;
2286
2287 // compat with the old API
2288 if (Mode == ReadOnlyGzip && Compress == None)
2289 Compress = Gzip;
2290
2291 switch (Compress)
2292 {
2293 case None: name = "."; break;
2294 case Gzip: name = "gzip"; break;
2295 case Bzip2: name = "bzip2"; break;
2296 case Lzma: name = "lzma"; break;
2297 case Xz: name = "xz"; break;
2298 case Lz4: name = "lz4"; break;
2299 case Auto:
2300 case Extension:
2301 if (AutoClose == true && Fd != -1)
2302 close(Fd);
2303 return FileFdError("Opening Fd %d in Auto or Extension compression mode is not supported", Fd);
2304 }
2305 for (; compressor != compressors.end(); ++compressor)
2306 if (compressor->Name == name)
2307 break;
2308 if (compressor == compressors.end())
2309 {
2310 if (AutoClose == true && Fd != -1)
2311 close(Fd);
2312 return FileFdError("Can't find a configured compressor %s for file %s", name.c_str(), FileName.c_str());
2313 }
2314 return OpenDescriptor(Fd, Mode, *compressor, AutoClose);
2315 }
2316 bool FileFd::OpenDescriptor(int Fd, unsigned int const Mode, APT::Configuration::Compressor const &compressor, bool AutoClose)
2317 {
2318 Close();
2319 Flags = (AutoClose) ? FileFd::AutoClose : 0;
2320 iFd = Fd;
2321 this->FileName = "";
2322 if (OpenInternDescriptor(Mode, compressor) == false)
2323 {
2324 if (iFd != -1 && (
2325 (Flags & Compressed) == Compressed ||
2326 AutoClose == true))
2327 {
2328 close (iFd);
2329 iFd = -1;
2330 }
2331 return FileFdError(_("Could not open file descriptor %d"), Fd);
2332 }
2333 return true;
2334 }
2335 bool FileFd::OpenInternDescriptor(unsigned int const Mode, APT::Configuration::Compressor const &compressor)
2336 {
2337 if (iFd == -1)
2338 return false;
2339
2340 if (d != nullptr)
2341 d->InternalClose(FileName);
2342
2343 if (d == nullptr)
2344 {
2345 if (false)
2346 /* dummy so that the rest can be 'else if's */;
2347 #define APT_COMPRESS_INIT(NAME, CONSTRUCTOR) \
2348 else if (compressor.Name == NAME) \
2349 d = new CONSTRUCTOR(this)
2350 #ifdef HAVE_ZLIB
2351 APT_COMPRESS_INIT("gzip", GzipFileFdPrivate);
2352 #endif
2353 #ifdef HAVE_BZ2
2354 APT_COMPRESS_INIT("bzip2", Bz2FileFdPrivate);
2355 #endif
2356 #ifdef HAVE_LZMA
2357 APT_COMPRESS_INIT("xz", LzmaFileFdPrivate);
2358 APT_COMPRESS_INIT("lzma", LzmaFileFdPrivate);
2359 #endif
2360 #ifdef HAVE_LZ4
2361 APT_COMPRESS_INIT("lz4", Lz4FileFdPrivate);
2362 #endif
2363 #undef APT_COMPRESS_INIT
2364 else if (compressor.Name == "." || compressor.Binary.empty() == true)
2365 d = new DirectFileFdPrivate(this);
2366 else
2367 d = new PipedFileFdPrivate(this);
2368
2369 if (Mode & BufferedWrite)
2370 d = new BufferedWriteFileFdPrivate(d);
2371
2372 d->set_openmode(Mode);
2373 d->set_compressor(compressor);
2374 if ((Flags & AutoClose) != AutoClose && d->InternalAlwaysAutoClose())
2375 {
2376 // Need to duplicate fd here or gz/bz2 close for cleanup will close the fd as well
2377 int const internFd = dup(iFd);
2378 if (internFd == -1)
2379 return FileFdErrno("OpenInternDescriptor", _("Could not open file descriptor %d"), iFd);
2380 iFd = internFd;
2381 }
2382 }
2383 return d->InternalOpen(iFd, Mode);
2384 }
2385 /*}}}*/
2386 // FileFd::~File - Closes the file /*{{{*/
2387 // ---------------------------------------------------------------------
2388 /* If the proper modes are selected then we close the Fd and possibly
2389 unlink the file on error. */
2390 FileFd::~FileFd()
2391 {
2392 Close();
2393 if (d != NULL)
2394 d->InternalClose(FileName);
2395 delete d;
2396 d = NULL;
2397 }
2398 /*}}}*/
2399 // FileFd::Read - Read a bit of the file /*{{{*/
2400 // ---------------------------------------------------------------------
2401 /* We are careful to handle interruption by a signal while reading
2402 gracefully. */
2403 bool FileFd::Read(void *To,unsigned long long Size,unsigned long long *Actual)
2404 {
2405 if (d == nullptr)
2406 return false;
2407 ssize_t Res = 1;
2408 errno = 0;
2409 if (Actual != 0)
2410 *Actual = 0;
2411 *((char *)To) = '\0';
2412 while (Res > 0 && Size > 0)
2413 {
2414 Res = d->InternalRead(To, Size);
2415
2416 if (Res < 0)
2417 {
2418 if (errno == EINTR)
2419 {
2420 // trick the while-loop into running again
2421 Res = 1;
2422 errno = 0;
2423 continue;
2424 }
2425 return d->InternalReadError();
2426 }
2427
2428 To = (char *)To + Res;
2429 Size -= Res;
2430 if (d != NULL)
2431 d->set_seekpos(d->get_seekpos() + Res);
2432 if (Actual != 0)
2433 *Actual += Res;
2434 }
2435
2436 if (Size == 0)
2437 return true;
2438
2439 // Eof handling
2440 if (Actual != 0)
2441 {
2442 Flags |= HitEof;
2443 return true;
2444 }
2445
2446 return FileFdError(_("read, still have %llu to read but none left"), Size);
2447 }
2448 /*}}}*/
2449 // FileFd::ReadLine - Read a complete line from the file /*{{{*/
2450 // ---------------------------------------------------------------------
2451 /* Beware: This method can be quite slow for big buffers on UNcompressed
2452 files because of the naive implementation! */
2453 char* FileFd::ReadLine(char *To, unsigned long long const Size)
2454 {
2455 *To = '\0';
2456 if (d == nullptr)
2457 return nullptr;
2458 return d->InternalReadLine(To, Size);
2459 }
2460 /*}}}*/
2461 // FileFd::Flush - Flush the file /*{{{*/
2462 bool FileFd::Flush()
2463 {
2464 if (d == nullptr)
2465 return true;
2466
2467 return d->InternalFlush();
2468 }
2469 /*}}}*/
2470 // FileFd::Write - Write to the file /*{{{*/
2471 bool FileFd::Write(const void *From,unsigned long long Size)
2472 {
2473 if (d == nullptr)
2474 return false;
2475 ssize_t Res = 1;
2476 errno = 0;
2477 while (Res > 0 && Size > 0)
2478 {
2479 Res = d->InternalWrite(From, Size);
2480
2481 if (Res < 0)
2482 {
2483 if (errno == EINTR)
2484 {
2485 // trick the while-loop into running again
2486 Res = 1;
2487 errno = 0;
2488 continue;
2489 }
2490 return d->InternalWriteError();
2491 }
2492
2493 From = (char const *)From + Res;
2494 Size -= Res;
2495 if (d != NULL)
2496 d->set_seekpos(d->get_seekpos() + Res);
2497 }
2498
2499 if (Size == 0)
2500 return true;
2501
2502 return FileFdError(_("write, still have %llu to write but couldn't"), Size);
2503 }
2504 bool FileFd::Write(int Fd, const void *From, unsigned long long Size)
2505 {
2506 ssize_t Res = 1;
2507 errno = 0;
2508 while (Res > 0 && Size > 0)
2509 {
2510 Res = write(Fd,From,Size);
2511 if (Res < 0 && errno == EINTR)
2512 continue;
2513 if (Res < 0)
2514 return _error->Errno("write",_("Write error"));
2515
2516 From = (char const *)From + Res;
2517 Size -= Res;
2518 }
2519
2520 if (Size == 0)
2521 return true;
2522
2523 return _error->Error(_("write, still have %llu to write but couldn't"), Size);
2524 }
2525 /*}}}*/
2526 // FileFd::Seek - Seek in the file /*{{{*/
2527 bool FileFd::Seek(unsigned long long To)
2528 {
2529 if (d == nullptr)
2530 return false;
2531 Flags &= ~HitEof;
2532 return d->InternalSeek(To);
2533 }
2534 /*}}}*/
2535 // FileFd::Skip - Skip over data in the file /*{{{*/
2536 bool FileFd::Skip(unsigned long long Over)
2537 {
2538 if (d == nullptr)
2539 return false;
2540 return d->InternalSkip(Over);
2541 }
2542 /*}}}*/
2543 // FileFd::Truncate - Truncate the file /*{{{*/
2544 bool FileFd::Truncate(unsigned long long To)
2545 {
2546 if (d == nullptr)
2547 return false;
2548 // truncating /dev/null is always successful - as we get an error otherwise
2549 if (To == 0 && FileName == "/dev/null")
2550 return true;
2551 return d->InternalTruncate(To);
2552 }
2553 /*}}}*/
2554 // FileFd::Tell - Current seek position /*{{{*/
2555 // ---------------------------------------------------------------------
2556 /* */
2557 unsigned long long FileFd::Tell()
2558 {
2559 if (d == nullptr)
2560 return false;
2561 off_t const Res = d->InternalTell();
2562 if (Res == (off_t)-1)
2563 FileFdErrno("lseek","Failed to determine the current file position");
2564 d->set_seekpos(Res);
2565 return Res;
2566 }
2567 /*}}}*/
2568 static bool StatFileFd(char const * const msg, int const iFd, std::string const &FileName, struct stat &Buf, FileFdPrivate * const d) /*{{{*/
2569 {
2570 bool ispipe = (d != NULL && d->get_is_pipe() == true);
2571 if (ispipe == false)
2572 {
2573 if (fstat(iFd,&Buf) != 0)
2574 // higher-level code will generate more meaningful messages,
2575 // even translated this would be meaningless for users
2576 return _error->Errno("fstat", "Unable to determine %s for fd %i", msg, iFd);
2577 if (FileName.empty() == false)
2578 ispipe = S_ISFIFO(Buf.st_mode);
2579 }
2580
2581 // for compressor pipes st_size is undefined and at 'best' zero
2582 if (ispipe == true)
2583 {
2584 // we set it here, too, as we get the info here for free
2585 // in theory the Open-methods should take care of it already
2586 if (d != NULL)
2587 d->set_is_pipe(true);
2588 if (stat(FileName.c_str(), &Buf) != 0)
2589 return _error->Errno("fstat", "Unable to determine %s for file %s", msg, FileName.c_str());
2590 }
2591 return true;
2592 }
2593 /*}}}*/
2594 // FileFd::FileSize - Return the size of the file /*{{{*/
2595 unsigned long long FileFd::FileSize()
2596 {
2597 struct stat Buf;
2598 if (StatFileFd("file size", iFd, FileName, Buf, d) == false)
2599 {
2600 Flags |= Fail;
2601 return 0;
2602 }
2603 return Buf.st_size;
2604 }
2605 /*}}}*/
2606 // FileFd::ModificationTime - Return the time of last touch /*{{{*/
2607 time_t FileFd::ModificationTime()
2608 {
2609 struct stat Buf;
2610 if (StatFileFd("modification time", iFd, FileName, Buf, d) == false)
2611 {
2612 Flags |= Fail;
2613 return 0;
2614 }
2615 return Buf.st_mtime;
2616 }
2617 /*}}}*/
2618 // FileFd::Size - Return the size of the content in the file /*{{{*/
2619 unsigned long long FileFd::Size()
2620 {
2621 if (d == nullptr)
2622 return false;
2623 return d->InternalSize();
2624 }
2625 /*}}}*/
2626 // FileFd::Close - Close the file if the close flag is set /*{{{*/
2627 // ---------------------------------------------------------------------
2628 /* */
2629 bool FileFd::Close()
2630 {
2631 if (Failed() == false && Flush() == false)
2632 return false;
2633 if (iFd == -1)
2634 return true;
2635
2636 bool Res = true;
2637 if ((Flags & AutoClose) == AutoClose)
2638 {
2639 if ((Flags & Compressed) != Compressed && iFd > 0 && close(iFd) != 0)
2640 Res &= _error->Errno("close",_("Problem closing the file %s"), FileName.c_str());
2641 }
2642
2643 if (d != NULL)
2644 {
2645 Res &= d->InternalClose(FileName);
2646 delete d;
2647 d = NULL;
2648 }
2649
2650 if ((Flags & Replace) == Replace) {
2651 if (Failed() == false && rename(TemporaryFileName.c_str(), FileName.c_str()) != 0)
2652 Res &= _error->Errno("rename",_("Problem renaming the file %s to %s"), TemporaryFileName.c_str(), FileName.c_str());
2653
2654 FileName = TemporaryFileName; // for the unlink() below.
2655 TemporaryFileName.clear();
2656 }
2657
2658 iFd = -1;
2659
2660 if ((Flags & Fail) == Fail && (Flags & DelOnFail) == DelOnFail &&
2661 FileName.empty() == false)
2662 Res &= RemoveFile("FileFd::Close", FileName);
2663
2664 if (Res == false)
2665 Flags |= Fail;
2666 return Res;
2667 }
2668 /*}}}*/
2669 // FileFd::Sync - Sync the file /*{{{*/
2670 // ---------------------------------------------------------------------
2671 /* */
2672 bool FileFd::Sync()
2673 {
2674 if (fsync(iFd) != 0)
2675 return FileFdErrno("sync",_("Problem syncing the file"));
2676 return true;
2677 }
2678 /*}}}*/
2679 // FileFd::FileFdErrno - set Fail and call _error->Errno *{{{*/
2680 bool FileFd::FileFdErrno(const char *Function, const char *Description,...)
2681 {
2682 Flags |= Fail;
2683 va_list args;
2684 size_t msgSize = 400;
2685 int const errsv = errno;
2686 while (true)
2687 {
2688 va_start(args,Description);
2689 if (_error->InsertErrno(GlobalError::ERROR, Function, Description, args, errsv, msgSize) == false)
2690 break;
2691 va_end(args);
2692 }
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 while (true)
2702 {
2703 va_start(args,Description);
2704 if (_error->Insert(GlobalError::ERROR, Description, args, msgSize) == false)
2705 break;
2706 va_end(args);
2707 }
2708 return false;
2709 }
2710 /*}}}*/
2711 gzFile FileFd::gzFd() { /*{{{*/
2712 #ifdef HAVE_ZLIB
2713 GzipFileFdPrivate * const gzipd = dynamic_cast<GzipFileFdPrivate*>(d);
2714 if (gzipd == nullptr)
2715 return nullptr;
2716 else
2717 return gzipd->gz;
2718 #else
2719 return nullptr;
2720 #endif
2721 }
2722 /*}}}*/
2723
2724 // Glob - wrapper around "glob()" /*{{{*/
2725 std::vector<std::string> Glob(std::string const &pattern, int flags)
2726 {
2727 std::vector<std::string> result;
2728 glob_t globbuf;
2729 int glob_res;
2730 unsigned int i;
2731
2732 glob_res = glob(pattern.c_str(), flags, NULL, &globbuf);
2733
2734 if (glob_res != 0)
2735 {
2736 if(glob_res != GLOB_NOMATCH) {
2737 _error->Errno("glob", "Problem with glob");
2738 return result;
2739 }
2740 }
2741
2742 // append results
2743 for(i=0;i<globbuf.gl_pathc;i++)
2744 result.push_back(string(globbuf.gl_pathv[i]));
2745
2746 globfree(&globbuf);
2747 return result;
2748 }
2749 /*}}}*/
2750 std::string GetTempDir() /*{{{*/
2751 {
2752 const char *tmpdir = getenv("TMPDIR");
2753
2754 #ifdef P_tmpdir
2755 if (!tmpdir)
2756 tmpdir = P_tmpdir;
2757 #endif
2758
2759 struct stat st;
2760 if (!tmpdir || strlen(tmpdir) == 0 || // tmpdir is set
2761 stat(tmpdir, &st) != 0 || (st.st_mode & S_IFDIR) == 0) // exists and is directory
2762 tmpdir = "/tmp";
2763 else if (geteuid() != 0 && // root can do everything anyway
2764 faccessat(-1, tmpdir, R_OK | W_OK | X_OK, AT_EACCESS | AT_SYMLINK_NOFOLLOW) != 0) // current user has rwx access to directory
2765 tmpdir = "/tmp";
2766
2767 return string(tmpdir);
2768 }
2769 std::string GetTempDir(std::string const &User)
2770 {
2771 // no need/possibility to drop privs
2772 if(getuid() != 0 || User.empty() || User == "root")
2773 return GetTempDir();
2774
2775 struct passwd const * const pw = getpwnam(User.c_str());
2776 if (pw == NULL)
2777 return GetTempDir();
2778
2779 gid_t const old_euid = geteuid();
2780 gid_t const old_egid = getegid();
2781 if (setegid(pw->pw_gid) != 0)
2782 _error->Errno("setegid", "setegid %u failed", pw->pw_gid);
2783 if (seteuid(pw->pw_uid) != 0)
2784 _error->Errno("seteuid", "seteuid %u failed", pw->pw_uid);
2785
2786 std::string const tmp = GetTempDir();
2787
2788 if (seteuid(old_euid) != 0)
2789 _error->Errno("seteuid", "seteuid %u failed", old_euid);
2790 if (setegid(old_egid) != 0)
2791 _error->Errno("setegid", "setegid %u failed", old_egid);
2792
2793 return tmp;
2794 }
2795 /*}}}*/
2796 FileFd* GetTempFile(std::string const &Prefix, bool ImmediateUnlink, FileFd * const TmpFd) /*{{{*/
2797 {
2798 char fn[512];
2799 FileFd * const Fd = TmpFd == NULL ? new FileFd() : TmpFd;
2800
2801 std::string const tempdir = GetTempDir();
2802 snprintf(fn, sizeof(fn), "%s/%s.XXXXXX",
2803 tempdir.c_str(), Prefix.c_str());
2804 int const fd = mkstemp(fn);
2805 if(ImmediateUnlink)
2806 unlink(fn);
2807 if (fd < 0)
2808 {
2809 _error->Errno("GetTempFile",_("Unable to mkstemp %s"), fn);
2810 return NULL;
2811 }
2812 if (!Fd->OpenDescriptor(fd, FileFd::ReadWrite, FileFd::None, true))
2813 {
2814 _error->Errno("GetTempFile",_("Unable to write to %s"),fn);
2815 return NULL;
2816 }
2817 return Fd;
2818 }
2819 /*}}}*/
2820 bool Rename(std::string From, std::string To) /*{{{*/
2821 {
2822 if (rename(From.c_str(),To.c_str()) != 0)
2823 {
2824 _error->Error(_("rename failed, %s (%s -> %s)."),strerror(errno),
2825 From.c_str(),To.c_str());
2826 return false;
2827 }
2828 return true;
2829 }
2830 /*}}}*/
2831 bool Popen(const char* Args[], FileFd &Fd, pid_t &Child, FileFd::OpenMode Mode)/*{{{*/
2832 {
2833 int fd;
2834 if (Mode != FileFd::ReadOnly && Mode != FileFd::WriteOnly)
2835 return _error->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2836
2837 int Pipe[2] = {-1, -1};
2838 if(pipe(Pipe) != 0)
2839 return _error->Errno("pipe", _("Failed to create subprocess IPC"));
2840
2841 std::set<int> keep_fds;
2842 keep_fds.insert(Pipe[0]);
2843 keep_fds.insert(Pipe[1]);
2844 Child = ExecFork(keep_fds);
2845 if(Child < 0)
2846 return _error->Errno("fork", "Failed to fork");
2847 if(Child == 0)
2848 {
2849 if(Mode == FileFd::ReadOnly)
2850 {
2851 close(Pipe[0]);
2852 fd = Pipe[1];
2853 }
2854 else if(Mode == FileFd::WriteOnly)
2855 {
2856 close(Pipe[1]);
2857 fd = Pipe[0];
2858 }
2859
2860 if(Mode == FileFd::ReadOnly)
2861 {
2862 dup2(fd, 1);
2863 dup2(fd, 2);
2864 } else if(Mode == FileFd::WriteOnly)
2865 dup2(fd, 0);
2866
2867 execv(Args[0], (char**)Args);
2868 _exit(100);
2869 }
2870 if(Mode == FileFd::ReadOnly)
2871 {
2872 close(Pipe[1]);
2873 fd = Pipe[0];
2874 }
2875 else if(Mode == FileFd::WriteOnly)
2876 {
2877 close(Pipe[0]);
2878 fd = Pipe[1];
2879 }
2880 else
2881 return _error->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2882 Fd.OpenDescriptor(fd, Mode, FileFd::None, true);
2883
2884 return true;
2885 }
2886 /*}}}*/
2887 bool DropPrivileges() /*{{{*/
2888 {
2889 if(_config->FindB("Debug::NoDropPrivs", false) == true)
2890 return true;
2891
2892 #if __gnu_linux__
2893 #if defined(PR_SET_NO_NEW_PRIVS) && ( PR_SET_NO_NEW_PRIVS != 38 )
2894 #error "PR_SET_NO_NEW_PRIVS is defined, but with a different value than expected!"
2895 #endif
2896 // see prctl(2), needs linux3.5 at runtime - magic constant to avoid it at buildtime
2897 int ret = prctl(38, 1, 0, 0, 0);
2898 // ignore EINVAL - kernel is too old to understand the option
2899 if(ret < 0 && errno != EINVAL)
2900 _error->Warning("PR_SET_NO_NEW_PRIVS failed with %i", ret);
2901 #endif
2902
2903 // empty setting disables privilege dropping - this also ensures
2904 // backward compatibility, see bug #764506
2905 const std::string toUser = _config->Find("APT::Sandbox::User");
2906 if (toUser.empty() || toUser == "root")
2907 return true;
2908
2909 // a lot can go wrong trying to drop privileges completely,
2910 // so ideally we would like to verify that we have done it –
2911 // but the verify asks for too much in case of fakeroot (and alike)
2912 // [Specific checks can be overridden with dedicated options]
2913 bool const VerifySandboxing = _config->FindB("APT::Sandbox::Verify", false);
2914
2915 // uid will be 0 in the end, but gid might be different anyway
2916 uid_t const old_uid = getuid();
2917 gid_t const old_gid = getgid();
2918
2919 if (old_uid != 0)
2920 return true;
2921
2922 struct passwd *pw = getpwnam(toUser.c_str());
2923 if (pw == NULL)
2924 return _error->Error("No user %s, can not drop rights", toUser.c_str());
2925
2926 // Do not change the order here, it might break things
2927 // Get rid of all our supplementary groups first
2928 if (setgroups(1, &pw->pw_gid))
2929 return _error->Errno("setgroups", "Failed to setgroups");
2930
2931 // Now change the group ids to the new user
2932 #ifdef HAVE_SETRESGID
2933 if (setresgid(pw->pw_gid, pw->pw_gid, pw->pw_gid) != 0)
2934 return _error->Errno("setresgid", "Failed to set new group ids");
2935 #else
2936 if (setegid(pw->pw_gid) != 0)
2937 return _error->Errno("setegid", "Failed to setegid");
2938
2939 if (setgid(pw->pw_gid) != 0)
2940 return _error->Errno("setgid", "Failed to setgid");
2941 #endif
2942
2943 // Change the user ids to the new user
2944 #ifdef HAVE_SETRESUID
2945 if (setresuid(pw->pw_uid, pw->pw_uid, pw->pw_uid) != 0)
2946 return _error->Errno("setresuid", "Failed to set new user ids");
2947 #else
2948 if (setuid(pw->pw_uid) != 0)
2949 return _error->Errno("setuid", "Failed to setuid");
2950 if (seteuid(pw->pw_uid) != 0)
2951 return _error->Errno("seteuid", "Failed to seteuid");
2952 #endif
2953
2954 // disabled by default as fakeroot doesn't implement getgroups currently (#806521)
2955 if (VerifySandboxing == true || _config->FindB("APT::Sandbox::Verify::Groups", false) == true)
2956 {
2957 // Verify that the user isn't still in any supplementary groups
2958 long const ngroups_max = sysconf(_SC_NGROUPS_MAX);
2959 std::unique_ptr<gid_t[]> gidlist(new gid_t[ngroups_max]);
2960 if (unlikely(gidlist == NULL))
2961 return _error->Error("Allocation of a list of size %lu for getgroups failed", ngroups_max);
2962 ssize_t gidlist_nr;
2963 if ((gidlist_nr = getgroups(ngroups_max, gidlist.get())) < 0)
2964 return _error->Errno("getgroups", "Could not get new groups (%lu)", ngroups_max);
2965 for (ssize_t i = 0; i < gidlist_nr; ++i)
2966 if (gidlist[i] != pw->pw_gid)
2967 return _error->Error("Could not switch group, user %s is still in group %d", toUser.c_str(), gidlist[i]);
2968 }
2969
2970 // enabled by default as all fakeroot-lookalikes should fake that accordingly
2971 if (VerifySandboxing == true || _config->FindB("APT::Sandbox::Verify::IDs", true) == true)
2972 {
2973 // Verify that gid, egid, uid, and euid changed
2974 if (getgid() != pw->pw_gid)
2975 return _error->Error("Could not switch group");
2976 if (getegid() != pw->pw_gid)
2977 return _error->Error("Could not switch effective group");
2978 if (getuid() != pw->pw_uid)
2979 return _error->Error("Could not switch user");
2980 if (geteuid() != pw->pw_uid)
2981 return _error->Error("Could not switch effective user");
2982
2983 #ifdef HAVE_GETRESUID
2984 // verify that the saved set-user-id was changed as well
2985 uid_t ruid = 0;
2986 uid_t euid = 0;
2987 uid_t suid = 0;
2988 if (getresuid(&ruid, &euid, &suid))
2989 return _error->Errno("getresuid", "Could not get saved set-user-ID");
2990 if (suid != pw->pw_uid)
2991 return _error->Error("Could not switch saved set-user-ID");
2992 #endif
2993
2994 #ifdef HAVE_GETRESGID
2995 // verify that the saved set-group-id was changed as well
2996 gid_t rgid = 0;
2997 gid_t egid = 0;
2998 gid_t sgid = 0;
2999 if (getresgid(&rgid, &egid, &sgid))
3000 return _error->Errno("getresuid", "Could not get saved set-group-ID");
3001 if (sgid != pw->pw_gid)
3002 return _error->Error("Could not switch saved set-group-ID");
3003 #endif
3004 }
3005
3006 // disabled as fakeroot doesn't forbid (by design) (re)gaining root from unprivileged
3007 if (VerifySandboxing == true || _config->FindB("APT::Sandbox::Verify::Regain", false) == true)
3008 {
3009 // Check that uid and gid changes do not work anymore
3010 if (pw->pw_gid != old_gid && (setgid(old_gid) != -1 || setegid(old_gid) != -1))
3011 return _error->Error("Could restore a gid to root, privilege dropping did not work");
3012
3013 if (pw->pw_uid != old_uid && (setuid(old_uid) != -1 || seteuid(old_uid) != -1))
3014 return _error->Error("Could restore a uid to root, privilege dropping did not work");
3015 }
3016
3017 return true;
3018 }
3019 /*}}}*/