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