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