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