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