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