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