ignore the order used for the 'apt' package as long as it is valid either way
[ntk/apt.git] / apt-pkg / contrib / fileutl.cc
CommitLineData
578bfd0a
AL
1// -*- mode: cpp; mode: fold -*-
2// Description /*{{{*/
7da2b375 3// $Id: fileutl.cc,v 1.42 2002/09/14 05:29:22 jgg Exp $
578bfd0a
AL
4/* ######################################################################
5
6 File Utilities
7
8 CopyFile - Buffered copy of a single file
9 GetLock - dpkg compatible lock file manipulation (fcntl)
10
614adaa0
MV
11 Most of this source is placed in the Public Domain, do with it what
12 you will
7da2b375 13 It was originally written by Jason Gunthorpe <jgg@debian.org>.
a3a03f5d 14 FileFd gzip support added by Martin Pitt <martin.pitt@canonical.com>
578bfd0a 15
614adaa0
MV
16 The exception is RunScripts() it is under the GPLv2
17
578bfd0a
AL
18 ##################################################################### */
19 /*}}}*/
20// Include Files /*{{{*/
ea542140
DK
21#include <config.h>
22
094a497d 23#include <apt-pkg/fileutl.h>
1cd1c398 24#include <apt-pkg/strutl.h>
094a497d 25#include <apt-pkg/error.h>
b2e465d6 26#include <apt-pkg/sptr.h>
468720c5 27#include <apt-pkg/aptconfiguration.h>
75ef8f14 28#include <apt-pkg/configuration.h>
b2e465d6 29
152ab79e 30#include <cstdlib>
4f333a8b 31#include <cstring>
3010fb0e 32#include <cstdio>
4f333a8b 33
4d055c05 34#include <iostream>
578bfd0a 35#include <unistd.h>
2c206aa4 36#include <fcntl.h>
578bfd0a 37#include <sys/stat.h>
578bfd0a 38#include <sys/types.h>
cc2313b7 39#include <sys/time.h>
1ae93c94 40#include <sys/wait.h>
46e39c8e 41#include <dirent.h>
54676e1a 42#include <signal.h>
65a1e968 43#include <errno.h>
75ef8f14 44#include <set>
46e39c8e 45#include <algorithm>
2cae0ccb 46
7efb8c8e
DK
47#ifdef HAVE_ZLIB
48 #include <zlib.h>
699b209e 49#endif
c4997486
DK
50#ifdef HAVE_BZ2
51 #include <bzlib.h>
52#endif
032bd56f 53
2a79d5b5 54#ifdef WORDS_BIGENDIAN
2cae0ccb
DK
55#include <inttypes.h>
56#endif
ea542140
DK
57
58#include <apti18n.h>
578bfd0a
AL
59 /*}}}*/
60
4d055c05
AL
61using namespace std;
62
032bd56f
DK
63class FileFdPrivate {
64 public:
7efb8c8e 65#ifdef HAVE_ZLIB
032bd56f 66 gzFile gz;
699b209e
DK
67#else
68 void* gz;
c4997486
DK
69#endif
70#ifdef HAVE_BZ2
71 BZFILE* bz2;
72#else
73 void* bz2;
699b209e 74#endif
561f860a 75 int compressed_fd;
699b209e
DK
76 pid_t compressor_pid;
77 bool pipe;
78 APT::Configuration::Compressor compressor;
52b47296 79 unsigned int openmode;
1abbc47c 80 unsigned long long seekpos;
c4997486
DK
81 FileFdPrivate() : gz(NULL), bz2(NULL),
82 compressed_fd(-1), compressor_pid(-1), pipe(false),
1abbc47c 83 openmode(0), seekpos(0) {};
032bd56f
DK
84};
85
614adaa0
MV
86// RunScripts - Run a set of scripts from a configuration subtree /*{{{*/
87// ---------------------------------------------------------------------
88/* */
89bool RunScripts(const char *Cnf)
90{
91 Configuration::Item const *Opts = _config->Tree(Cnf);
92 if (Opts == 0 || Opts->Child == 0)
93 return true;
94 Opts = Opts->Child;
95
96 // Fork for running the system calls
97 pid_t Child = ExecFork();
98
99 // This is the child
100 if (Child == 0)
101 {
cfba4f69
MV
102 if (_config->FindDir("DPkg::Chroot-Directory","/") != "/")
103 {
104 std::cerr << "Chrooting into "
105 << _config->FindDir("DPkg::Chroot-Directory")
106 << std::endl;
107 if (chroot(_config->FindDir("DPkg::Chroot-Directory","/").c_str()) != 0)
108 _exit(100);
109 }
110
614adaa0
MV
111 if (chdir("/tmp/") != 0)
112 _exit(100);
113
114 unsigned int Count = 1;
115 for (; Opts != 0; Opts = Opts->Next, Count++)
116 {
117 if (Opts->Value.empty() == true)
118 continue;
119
120 if (system(Opts->Value.c_str()) != 0)
121 _exit(100+Count);
122 }
123 _exit(0);
124 }
125
126 // Wait for the child
127 int Status = 0;
128 while (waitpid(Child,&Status,0) != Child)
129 {
130 if (errno == EINTR)
131 continue;
132 return _error->Errno("waitpid","Couldn't wait for subprocess");
133 }
134
135 // Restore sig int/quit
136 signal(SIGQUIT,SIG_DFL);
137 signal(SIGINT,SIG_DFL);
138
139 // Check for an error code.
140 if (WIFEXITED(Status) == 0 || WEXITSTATUS(Status) != 0)
141 {
142 unsigned int Count = WEXITSTATUS(Status);
143 if (Count > 100)
144 {
145 Count -= 100;
146 for (; Opts != 0 && Count != 1; Opts = Opts->Next, Count--);
147 _error->Error("Problem executing scripts %s '%s'",Cnf,Opts->Value.c_str());
148 }
149
150 return _error->Error("Sub-process returned an error code");
151 }
152
153 return true;
154}
155 /*}}}*/
156
578bfd0a
AL
157// CopyFile - Buffered copy of a file /*{{{*/
158// ---------------------------------------------------------------------
159/* The caller is expected to set things so that failure causes erasure */
8b89e57f 160bool CopyFile(FileFd &From,FileFd &To)
578bfd0a
AL
161{
162 if (From.IsOpen() == false || To.IsOpen() == false)
163 return false;
164
165 // Buffered copy between fds
b2e465d6 166 SPtrArray<unsigned char> Buf = new unsigned char[64000];
650faab0 167 unsigned long long Size = From.Size();
b0db36b1 168 while (Size != 0)
578bfd0a 169 {
650faab0 170 unsigned long long ToRead = Size;
b0db36b1
AL
171 if (Size > 64000)
172 ToRead = 64000;
173
4a6d5862 174 if (From.Read(Buf,ToRead) == false ||
b0db36b1 175 To.Write(Buf,ToRead) == false)
578bfd0a 176 return false;
b0db36b1
AL
177
178 Size -= ToRead;
578bfd0a
AL
179 }
180
578bfd0a
AL
181 return true;
182}
183 /*}}}*/
184// GetLock - Gets a lock file /*{{{*/
185// ---------------------------------------------------------------------
186/* This will create an empty file of the given name and lock it. Once this
187 is done all other calls to GetLock in any other process will fail with
188 -1. The return result is the fd of the file, the call should call
189 close at some time. */
190int GetLock(string File,bool Errors)
191{
f659b39a
OS
192 // GetLock() is used in aptitude on directories with public-write access
193 // Use O_NOFOLLOW here to prevent symlink traversal attacks
194 int FD = open(File.c_str(),O_RDWR | O_CREAT | O_NOFOLLOW,0640);
578bfd0a
AL
195 if (FD < 0)
196 {
b2e465d6
AL
197 // Read only .. cant have locking problems there.
198 if (errno == EROFS)
199 {
200 _error->Warning(_("Not using locking for read only lock file %s"),File.c_str());
201 return dup(0); // Need something for the caller to close
202 }
203
578bfd0a 204 if (Errors == true)
b2e465d6
AL
205 _error->Errno("open",_("Could not open lock file %s"),File.c_str());
206
207 // Feh.. We do this to distinguish the lock vs open case..
208 errno = EPERM;
578bfd0a
AL
209 return -1;
210 }
b2e465d6
AL
211 SetCloseExec(FD,true);
212
578bfd0a
AL
213 // Aquire a write lock
214 struct flock fl;
c71bc556
AL
215 fl.l_type = F_WRLCK;
216 fl.l_whence = SEEK_SET;
217 fl.l_start = 0;
218 fl.l_len = 0;
578bfd0a
AL
219 if (fcntl(FD,F_SETLK,&fl) == -1)
220 {
d89df07a
AL
221 if (errno == ENOLCK)
222 {
b2e465d6
AL
223 _error->Warning(_("Not using locking for nfs mounted lock file %s"),File.c_str());
224 return dup(0); // Need something for the caller to close
d89df07a 225 }
578bfd0a 226 if (Errors == true)
b2e465d6
AL
227 _error->Errno("open",_("Could not get lock %s"),File.c_str());
228
229 int Tmp = errno;
578bfd0a 230 close(FD);
b2e465d6 231 errno = Tmp;
578bfd0a
AL
232 return -1;
233 }
234
235 return FD;
236}
237 /*}}}*/
238// FileExists - Check if a file exists /*{{{*/
239// ---------------------------------------------------------------------
36f1098a 240/* Beware: Directories are also files! */
578bfd0a
AL
241bool FileExists(string File)
242{
243 struct stat Buf;
244 if (stat(File.c_str(),&Buf) != 0)
245 return false;
246 return true;
247}
248 /*}}}*/
36f1098a
DK
249// RealFileExists - Check if a file exists and if it is really a file /*{{{*/
250// ---------------------------------------------------------------------
251/* */
252bool RealFileExists(string File)
253{
254 struct stat Buf;
255 if (stat(File.c_str(),&Buf) != 0)
256 return false;
257 return ((Buf.st_mode & S_IFREG) != 0);
258}
259 /*}}}*/
1cd1c398
DK
260// DirectoryExists - Check if a directory exists and is really one /*{{{*/
261// ---------------------------------------------------------------------
262/* */
263bool DirectoryExists(string const &Path)
264{
265 struct stat Buf;
266 if (stat(Path.c_str(),&Buf) != 0)
267 return false;
268 return ((Buf.st_mode & S_IFDIR) != 0);
269}
270 /*}}}*/
271// CreateDirectory - poor man's mkdir -p guarded by a parent directory /*{{{*/
272// ---------------------------------------------------------------------
273/* This method will create all directories needed for path in good old
274 mkdir -p style but refuses to do this if Parent is not a prefix of
275 this Path. Example: /var/cache/ and /var/cache/apt/archives are given,
276 so it will create apt/archives if /var/cache exists - on the other
277 hand if the parent is /var/lib the creation will fail as this path
278 is not a parent of the path to be generated. */
279bool CreateDirectory(string const &Parent, string const &Path)
280{
281 if (Parent.empty() == true || Path.empty() == true)
282 return false;
283
284 if (DirectoryExists(Path) == true)
285 return true;
286
287 if (DirectoryExists(Parent) == false)
288 return false;
289
290 // we are not going to create directories "into the blue"
291 if (Path.find(Parent, 0) != 0)
292 return false;
293
294 vector<string> const dirs = VectorizeString(Path.substr(Parent.size()), '/');
295 string progress = Parent;
296 for (vector<string>::const_iterator d = dirs.begin(); d != dirs.end(); ++d)
297 {
298 if (d->empty() == true)
299 continue;
300
301 progress.append("/").append(*d);
302 if (DirectoryExists(progress) == true)
303 continue;
304
305 if (mkdir(progress.c_str(), 0755) != 0)
306 return false;
307 }
308 return true;
309}
310 /*}}}*/
7753e468 311// CreateAPTDirectoryIfNeeded - ensure that the given directory exists /*{{{*/
b29c3712
DK
312// ---------------------------------------------------------------------
313/* a small wrapper around CreateDirectory to check if it exists and to
314 remove the trailing "/apt/" from the parent directory if needed */
7753e468 315bool CreateAPTDirectoryIfNeeded(string const &Parent, string const &Path)
b29c3712
DK
316{
317 if (DirectoryExists(Path) == true)
318 return true;
319
320 size_t const len = Parent.size();
321 if (len > 5 && Parent.find("/apt/", len - 6, 5) == len - 5)
322 {
323 if (CreateDirectory(Parent.substr(0,len-5), Path) == true)
324 return true;
325 }
326 else if (CreateDirectory(Parent, Path) == true)
327 return true;
328
329 return false;
330}
331 /*}}}*/
46e39c8e
MV
332// GetListOfFilesInDir - returns a vector of files in the given dir /*{{{*/
333// ---------------------------------------------------------------------
334/* If an extension is given only files with this extension are included
335 in the returned vector, otherwise every "normal" file is included. */
b39c1859
MV
336std::vector<string> GetListOfFilesInDir(string const &Dir, string const &Ext,
337 bool const &SortList, bool const &AllowNoExt)
338{
339 std::vector<string> ext;
340 ext.reserve(2);
341 if (Ext.empty() == false)
342 ext.push_back(Ext);
343 if (AllowNoExt == true && ext.empty() == false)
344 ext.push_back("");
345 return GetListOfFilesInDir(Dir, ext, SortList);
346}
347std::vector<string> GetListOfFilesInDir(string const &Dir, std::vector<string> const &Ext,
348 bool const &SortList)
349{
350 // Attention debuggers: need to be set with the environment config file!
351 bool const Debug = _config->FindB("Debug::GetListOfFilesInDir", false);
352 if (Debug == true)
353 {
354 std::clog << "Accept in " << Dir << " only files with the following " << Ext.size() << " extensions:" << std::endl;
355 if (Ext.empty() == true)
356 std::clog << "\tNO extension" << std::endl;
357 else
358 for (std::vector<string>::const_iterator e = Ext.begin();
359 e != Ext.end(); ++e)
360 std::clog << '\t' << (e->empty() == true ? "NO" : *e) << " extension" << std::endl;
361 }
362
46e39c8e 363 std::vector<string> List;
36f1098a
DK
364
365 if (DirectoryExists(Dir.c_str()) == false)
366 {
367 _error->Error(_("List of files can't be created as '%s' is not a directory"), Dir.c_str());
368 return List;
369 }
370
1408e219 371 Configuration::MatchAgainstConfig SilentIgnore("Dir::Ignore-Files-Silently");
46e39c8e
MV
372 DIR *D = opendir(Dir.c_str());
373 if (D == 0)
374 {
375 _error->Errno("opendir",_("Unable to read %s"),Dir.c_str());
376 return List;
377 }
378
379 for (struct dirent *Ent = readdir(D); Ent != 0; Ent = readdir(D))
380 {
b39c1859 381 // skip "hidden" files
46e39c8e
MV
382 if (Ent->d_name[0] == '.')
383 continue;
384
491058e3
DK
385 // Make sure it is a file and not something else
386 string const File = flCombine(Dir,Ent->d_name);
387#ifdef _DIRENT_HAVE_D_TYPE
388 if (Ent->d_type != DT_REG)
389#endif
390 {
391 if (RealFileExists(File.c_str()) == false)
392 {
84e254d6
DK
393 // do not show ignoration warnings for directories
394 if (
395#ifdef _DIRENT_HAVE_D_TYPE
396 Ent->d_type == DT_DIR ||
397#endif
398 DirectoryExists(File.c_str()) == true)
399 continue;
491058e3
DK
400 if (SilentIgnore.Match(Ent->d_name) == false)
401 _error->Notice(_("Ignoring '%s' in directory '%s' as it is not a regular file"), Ent->d_name, Dir.c_str());
402 continue;
403 }
404 }
405
b39c1859
MV
406 // check for accepted extension:
407 // no extension given -> periods are bad as hell!
408 // extensions given -> "" extension allows no extension
409 if (Ext.empty() == false)
410 {
411 string d_ext = flExtension(Ent->d_name);
412 if (d_ext == Ent->d_name) // no extension
413 {
414 if (std::find(Ext.begin(), Ext.end(), "") == Ext.end())
415 {
416 if (Debug == true)
417 std::clog << "Bad file: " << Ent->d_name << " → no extension" << std::endl;
5edc3966 418 if (SilentIgnore.Match(Ent->d_name) == false)
491058e3 419 _error->Notice(_("Ignoring file '%s' in directory '%s' as it has no filename extension"), Ent->d_name, Dir.c_str());
b39c1859
MV
420 continue;
421 }
422 }
423 else if (std::find(Ext.begin(), Ext.end(), d_ext) == Ext.end())
424 {
425 if (Debug == true)
426 std::clog << "Bad file: " << Ent->d_name << " → bad extension »" << flExtension(Ent->d_name) << "«" << std::endl;
1408e219 427 if (SilentIgnore.Match(Ent->d_name) == false)
491058e3 428 _error->Notice(_("Ignoring file '%s' in directory '%s' as it has an invalid filename extension"), Ent->d_name, Dir.c_str());
b39c1859
MV
429 continue;
430 }
431 }
46e39c8e 432
b39c1859 433 // Skip bad filenames ala run-parts
46e39c8e
MV
434 const char *C = Ent->d_name;
435 for (; *C != 0; ++C)
436 if (isalpha(*C) == 0 && isdigit(*C) == 0
b39c1859
MV
437 && *C != '_' && *C != '-') {
438 // no required extension -> dot is a bad character
439 if (*C == '.' && Ext.empty() == false)
440 continue;
46e39c8e 441 break;
b39c1859 442 }
46e39c8e 443
b39c1859 444 // we don't reach the end of the name -> bad character included
46e39c8e 445 if (*C != 0)
b39c1859
MV
446 {
447 if (Debug == true)
448 std::clog << "Bad file: " << Ent->d_name << " → bad character »"
449 << *C << "« in filename (period allowed: " << (Ext.empty() ? "no" : "yes") << ")" << std::endl;
450 continue;
451 }
452
fbb2c7e0
DK
453 // skip filenames which end with a period. These are never valid
454 if (*(C - 1) == '.')
455 {
456 if (Debug == true)
457 std::clog << "Bad file: " << Ent->d_name << " → Period as last character" << std::endl;
458 continue;
459 }
460
461 if (Debug == true)
462 std::clog << "Accept file: " << Ent->d_name << " in " << Dir << std::endl;
463 List.push_back(File);
464 }
465 closedir(D);
466
467 if (SortList == true)
468 std::sort(List.begin(),List.end());
469 return List;
470}
471std::vector<string> GetListOfFilesInDir(string const &Dir, bool SortList)
472{
473 bool const Debug = _config->FindB("Debug::GetListOfFilesInDir", false);
474 if (Debug == true)
475 std::clog << "Accept in " << Dir << " all regular files" << std::endl;
476
477 std::vector<string> List;
478
479 if (DirectoryExists(Dir.c_str()) == false)
480 {
481 _error->Error(_("List of files can't be created as '%s' is not a directory"), Dir.c_str());
482 return List;
483 }
484
485 DIR *D = opendir(Dir.c_str());
486 if (D == 0)
487 {
488 _error->Errno("opendir",_("Unable to read %s"),Dir.c_str());
489 return List;
490 }
491
492 for (struct dirent *Ent = readdir(D); Ent != 0; Ent = readdir(D))
493 {
494 // skip "hidden" files
495 if (Ent->d_name[0] == '.')
496 continue;
497
498 // Make sure it is a file and not something else
499 string const File = flCombine(Dir,Ent->d_name);
500#ifdef _DIRENT_HAVE_D_TYPE
501 if (Ent->d_type != DT_REG)
502#endif
503 {
504 if (RealFileExists(File.c_str()) == false)
505 {
506 if (Debug == true)
507 std::clog << "Bad file: " << Ent->d_name << " → it is not a real file" << std::endl;
508 continue;
509 }
510 }
511
512 // Skip bad filenames ala run-parts
513 const char *C = Ent->d_name;
514 for (; *C != 0; ++C)
515 if (isalpha(*C) == 0 && isdigit(*C) == 0
516 && *C != '_' && *C != '-' && *C != '.')
517 break;
518
519 // we don't reach the end of the name -> bad character included
520 if (*C != 0)
521 {
522 if (Debug == true)
523 std::clog << "Bad file: " << Ent->d_name << " → bad character »" << *C << "« in filename" << std::endl;
524 continue;
525 }
526
b39c1859
MV
527 // skip filenames which end with a period. These are never valid
528 if (*(C - 1) == '.')
529 {
530 if (Debug == true)
531 std::clog << "Bad file: " << Ent->d_name << " → Period as last character" << std::endl;
46e39c8e 532 continue;
b39c1859 533 }
46e39c8e 534
b39c1859
MV
535 if (Debug == true)
536 std::clog << "Accept file: " << Ent->d_name << " in " << Dir << std::endl;
46e39c8e
MV
537 List.push_back(File);
538 }
539 closedir(D);
540
541 if (SortList == true)
542 std::sort(List.begin(),List.end());
543 return List;
544}
545 /*}}}*/
578bfd0a
AL
546// SafeGetCWD - This is a safer getcwd that returns a dynamic string /*{{{*/
547// ---------------------------------------------------------------------
548/* We return / on failure. */
549string SafeGetCWD()
550{
551 // Stash the current dir.
552 char S[300];
553 S[0] = 0;
7f25bdff 554 if (getcwd(S,sizeof(S)-2) == 0)
578bfd0a 555 return "/";
7f25bdff
AL
556 unsigned int Len = strlen(S);
557 S[Len] = '/';
558 S[Len+1] = 0;
578bfd0a
AL
559 return S;
560}
561 /*}}}*/
2ec858bc
MV
562// GetModificationTime - Get the mtime of the given file or -1 on error /*{{{*/
563// ---------------------------------------------------------------------
564/* We return / on failure. */
565time_t GetModificationTime(string const &Path)
566{
567 struct stat St;
568 if (stat(Path.c_str(), &St) < 0)
569 return -1;
570 return St.st_mtime;
571}
572 /*}}}*/
8ce4327b
AL
573// flNotDir - Strip the directory from the filename /*{{{*/
574// ---------------------------------------------------------------------
575/* */
576string flNotDir(string File)
577{
578 string::size_type Res = File.rfind('/');
579 if (Res == string::npos)
580 return File;
581 Res++;
582 return string(File,Res,Res - File.length());
583}
584 /*}}}*/
d38b7b3d
AL
585// flNotFile - Strip the file from the directory name /*{{{*/
586// ---------------------------------------------------------------------
171c45bc 587/* Result ends in a / */
d38b7b3d
AL
588string flNotFile(string File)
589{
590 string::size_type Res = File.rfind('/');
591 if (Res == string::npos)
171c45bc 592 return "./";
d38b7b3d
AL
593 Res++;
594 return string(File,0,Res);
595}
596 /*}}}*/
b2e465d6
AL
597// flExtension - Return the extension for the file /*{{{*/
598// ---------------------------------------------------------------------
599/* */
600string flExtension(string File)
601{
602 string::size_type Res = File.rfind('.');
603 if (Res == string::npos)
604 return File;
605 Res++;
606 return string(File,Res,Res - File.length());
607}
608 /*}}}*/
421c8d10
AL
609// flNoLink - If file is a symlink then deref it /*{{{*/
610// ---------------------------------------------------------------------
611/* If the name is not a link then the returned path is the input. */
612string flNoLink(string File)
613{
614 struct stat St;
615 if (lstat(File.c_str(),&St) != 0 || S_ISLNK(St.st_mode) == 0)
616 return File;
617 if (stat(File.c_str(),&St) != 0)
618 return File;
619
620 /* Loop resolving the link. There is no need to limit the number of
621 loops because the stat call above ensures that the symlink is not
622 circular */
623 char Buffer[1024];
624 string NFile = File;
625 while (1)
626 {
627 // Read the link
628 int Res;
629 if ((Res = readlink(NFile.c_str(),Buffer,sizeof(Buffer))) <= 0 ||
630 (unsigned)Res >= sizeof(Buffer))
631 return File;
632
633 // Append or replace the previous path
634 Buffer[Res] = 0;
635 if (Buffer[0] == '/')
636 NFile = Buffer;
637 else
638 NFile = flNotFile(NFile) + Buffer;
639
640 // See if we are done
641 if (lstat(NFile.c_str(),&St) != 0)
642 return File;
643 if (S_ISLNK(St.st_mode) == 0)
644 return NFile;
645 }
646}
647 /*}}}*/
b2e465d6
AL
648// flCombine - Combine a file and a directory /*{{{*/
649// ---------------------------------------------------------------------
650/* If the file is an absolute path then it is just returned, otherwise
651 the directory is pre-pended to it. */
652string flCombine(string Dir,string File)
653{
654 if (File.empty() == true)
655 return string();
656
657 if (File[0] == '/' || Dir.empty() == true)
658 return File;
659 if (File.length() >= 2 && File[0] == '.' && File[1] == '/')
660 return File;
661 if (Dir[Dir.length()-1] == '/')
662 return Dir + File;
663 return Dir + '/' + File;
664}
665 /*}}}*/
3b5421b4
AL
666// SetCloseExec - Set the close on exec flag /*{{{*/
667// ---------------------------------------------------------------------
668/* */
669void SetCloseExec(int Fd,bool Close)
670{
671 if (fcntl(Fd,F_SETFD,(Close == false)?0:FD_CLOEXEC) != 0)
672 {
673 cerr << "FATAL -> Could not set close on exec " << strerror(errno) << endl;
674 exit(100);
675 }
676}
677 /*}}}*/
678// SetNonBlock - Set the nonblocking flag /*{{{*/
679// ---------------------------------------------------------------------
680/* */
681void SetNonBlock(int Fd,bool Block)
682{
0a8a80e5
AL
683 int Flags = fcntl(Fd,F_GETFL) & (~O_NONBLOCK);
684 if (fcntl(Fd,F_SETFL,Flags | ((Block == false)?0:O_NONBLOCK)) != 0)
3b5421b4
AL
685 {
686 cerr << "FATAL -> Could not set non-blocking flag " << strerror(errno) << endl;
687 exit(100);
688 }
689}
690 /*}}}*/
691// WaitFd - Wait for a FD to become readable /*{{{*/
692// ---------------------------------------------------------------------
b2e465d6 693/* This waits for a FD to become readable using select. It is useful for
6d5dd02a
AL
694 applications making use of non-blocking sockets. The timeout is
695 in seconds. */
1084d58a 696bool WaitFd(int Fd,bool write,unsigned long timeout)
3b5421b4
AL
697{
698 fd_set Set;
cc2313b7 699 struct timeval tv;
3b5421b4
AL
700 FD_ZERO(&Set);
701 FD_SET(Fd,&Set);
6d5dd02a
AL
702 tv.tv_sec = timeout;
703 tv.tv_usec = 0;
1084d58a 704 if (write == true)
b0db36b1
AL
705 {
706 int Res;
707 do
708 {
709 Res = select(Fd+1,0,&Set,0,(timeout != 0?&tv:0));
710 }
711 while (Res < 0 && errno == EINTR);
712
713 if (Res <= 0)
714 return false;
1084d58a
AL
715 }
716 else
717 {
b0db36b1
AL
718 int Res;
719 do
720 {
721 Res = select(Fd+1,&Set,0,0,(timeout != 0?&tv:0));
722 }
723 while (Res < 0 && errno == EINTR);
724
725 if (Res <= 0)
726 return false;
cc2313b7 727 }
1084d58a 728
3b5421b4
AL
729 return true;
730}
731 /*}}}*/
54676e1a
AL
732// ExecFork - Magical fork that sanitizes the context before execing /*{{{*/
733// ---------------------------------------------------------------------
734/* This is used if you want to cleanse the environment for the forked
735 child, it fixes up the important signals and nukes all of the fds,
736 otherwise acts like normal fork. */
75ef8f14 737pid_t ExecFork()
54676e1a
AL
738{
739 // Fork off the process
740 pid_t Process = fork();
741 if (Process < 0)
742 {
743 cerr << "FATAL -> Failed to fork." << endl;
744 exit(100);
745 }
746
747 // Spawn the subprocess
748 if (Process == 0)
749 {
750 // Setup the signals
751 signal(SIGPIPE,SIG_DFL);
752 signal(SIGQUIT,SIG_DFL);
753 signal(SIGINT,SIG_DFL);
754 signal(SIGWINCH,SIG_DFL);
755 signal(SIGCONT,SIG_DFL);
756 signal(SIGTSTP,SIG_DFL);
75ef8f14
MV
757
758 set<int> KeepFDs;
759 Configuration::Item const *Opts = _config->Tree("APT::Keep-Fds");
760 if (Opts != 0 && Opts->Child != 0)
761 {
762 Opts = Opts->Child;
763 for (; Opts != 0; Opts = Opts->Next)
764 {
765 if (Opts->Value.empty() == true)
766 continue;
767 int fd = atoi(Opts->Value.c_str());
768 KeepFDs.insert(fd);
769 }
770 }
771
54676e1a
AL
772 // Close all of our FDs - just in case
773 for (int K = 3; K != 40; K++)
75ef8f14
MV
774 {
775 if(KeepFDs.find(K) == KeepFDs.end())
007dc9e0 776 fcntl(K,F_SETFD,FD_CLOEXEC);
75ef8f14 777 }
54676e1a
AL
778 }
779
780 return Process;
781}
782 /*}}}*/
ddc1d8d0
AL
783// ExecWait - Fancy waitpid /*{{{*/
784// ---------------------------------------------------------------------
2c9a72d1 785/* Waits for the given sub process. If Reap is set then no errors are
ddc1d8d0
AL
786 generated. Otherwise a failed subprocess will generate a proper descriptive
787 message */
3826564e 788bool ExecWait(pid_t Pid,const char *Name,bool Reap)
ddc1d8d0
AL
789{
790 if (Pid <= 1)
791 return true;
792
793 // Wait and collect the error code
794 int Status;
795 while (waitpid(Pid,&Status,0) != Pid)
796 {
797 if (errno == EINTR)
798 continue;
799
800 if (Reap == true)
801 return false;
802
db0db9fe 803 return _error->Error(_("Waited for %s but it wasn't there"),Name);
ddc1d8d0
AL
804 }
805
806
807 // Check for an error code.
808 if (WIFEXITED(Status) == 0 || WEXITSTATUS(Status) != 0)
809 {
810 if (Reap == true)
811 return false;
ab7f4d7c 812 if (WIFSIGNALED(Status) != 0)
40e7fe0e 813 {
ab7f4d7c
MV
814 if( WTERMSIG(Status) == SIGSEGV)
815 return _error->Error(_("Sub-process %s received a segmentation fault."),Name);
816 else
817 return _error->Error(_("Sub-process %s received signal %u."),Name, WTERMSIG(Status));
40e7fe0e 818 }
ddc1d8d0
AL
819
820 if (WIFEXITED(Status) != 0)
b2e465d6 821 return _error->Error(_("Sub-process %s returned an error code (%u)"),Name,WEXITSTATUS(Status));
ddc1d8d0 822
b2e465d6 823 return _error->Error(_("Sub-process %s exited unexpectedly"),Name);
ddc1d8d0
AL
824 }
825
826 return true;
827}
828 /*}}}*/
578bfd0a 829
13d87e2e 830// FileFd::Open - Open a file /*{{{*/
578bfd0a
AL
831// ---------------------------------------------------------------------
832/* The most commonly used open mode combinations are given with Mode */
52b47296 833bool FileFd::Open(string FileName,unsigned int const Mode,CompressMode Compress, unsigned long const Perms)
578bfd0a 834{
257e8d66
DK
835 if (Mode == ReadOnlyGzip)
836 return Open(FileName, ReadOnly, Gzip, Perms);
257e8d66 837
468720c5
DK
838 if (Compress == Auto && (Mode & WriteOnly) == WriteOnly)
839 return _error->Error("Autodetection on %s only works in ReadOnly openmode!", FileName.c_str());
257e8d66 840
468720c5
DK
841 std::vector<APT::Configuration::Compressor> const compressors = APT::Configuration::getCompressors();
842 std::vector<APT::Configuration::Compressor>::const_iterator compressor = compressors.begin();
843 if (Compress == Auto)
844 {
468720c5
DK
845 for (; compressor != compressors.end(); ++compressor)
846 {
847 std::string file = std::string(FileName).append(compressor->Extension);
848 if (FileExists(file) == false)
849 continue;
850 FileName = file;
468720c5
DK
851 break;
852 }
853 }
854 else if (Compress == Extension)
855 {
52b47296
DK
856 std::string::size_type const found = FileName.find_last_of('.');
857 std::string ext;
858 if (found != std::string::npos)
859 {
860 ext = FileName.substr(found);
861 if (ext == ".new" || ext == ".bak")
862 {
863 std::string::size_type const found2 = FileName.find_last_of('.', found - 1);
864 if (found2 != std::string::npos)
865 ext = FileName.substr(found2, found - found2);
866 else
867 ext.clear();
868 }
869 }
aee1aac6
DK
870 for (; compressor != compressors.end(); ++compressor)
871 if (ext == compressor->Extension)
872 break;
873 // no matching extension - assume uncompressed (imagine files like 'example.org_Packages')
874 if (compressor == compressors.end())
875 for (compressor = compressors.begin(); compressor != compressors.end(); ++compressor)
876 if (compressor->Name == ".")
468720c5 877 break;
468720c5 878 }
aee1aac6 879 else
468720c5
DK
880 {
881 std::string name;
882 switch (Compress)
883 {
aee1aac6 884 case None: name = "."; break;
468720c5
DK
885 case Gzip: name = "gzip"; break;
886 case Bzip2: name = "bzip2"; break;
887 case Lzma: name = "lzma"; break;
888 case Xz: name = "xz"; break;
aee1aac6
DK
889 case Auto:
890 case Extension:
52b47296
DK
891 // Unreachable
892 return _error->Error("Opening File %s in None, Auto or Extension should be already handled?!?", FileName.c_str());
468720c5
DK
893 }
894 for (; compressor != compressors.end(); ++compressor)
895 if (compressor->Name == name)
896 break;
aee1aac6 897 if (compressor == compressors.end())
468720c5
DK
898 return _error->Error("Can't find a configured compressor %s for file %s", name.c_str(), FileName.c_str());
899 }
900
aee1aac6
DK
901 if (compressor == compressors.end())
902 return _error->Error("Can't find a match for specified compressor mode for file %s", FileName.c_str());
903 return Open(FileName, Mode, *compressor, Perms);
904}
52b47296 905bool FileFd::Open(string FileName,unsigned int const Mode,APT::Configuration::Compressor const &compressor, unsigned long const Perms)
aee1aac6
DK
906{
907 Close();
908 d = new FileFdPrivate;
909 d->openmode = Mode;
910 Flags = AutoClose;
911
912 if ((Mode & WriteOnly) != WriteOnly && (Mode & (Atomic | Create | Empty | Exclusive)) != 0)
913 return _error->Error("ReadOnly mode for %s doesn't accept additional flags!", FileName.c_str());
914 if ((Mode & ReadWrite) == 0)
915 return _error->Error("No openmode provided in FileFd::Open for %s", FileName.c_str());
468720c5 916
257e8d66
DK
917 if ((Mode & Atomic) == Atomic)
918 {
919 Flags |= Replace;
920 char *name = strdup((FileName + ".XXXXXX").c_str());
921 TemporaryFileName = string(mktemp(name));
922 free(name);
923 }
924 else if ((Mode & (Exclusive | Create)) == (Exclusive | Create))
925 {
926 // for atomic, this will be done by rename in Close()
927 unlink(FileName.c_str());
928 }
929 if ((Mode & Empty) == Empty)
578bfd0a 930 {
257e8d66
DK
931 struct stat Buf;
932 if (lstat(FileName.c_str(),&Buf) == 0 && S_ISLNK(Buf.st_mode))
933 unlink(FileName.c_str());
934 }
c4fc2fd7 935
561f860a
DK
936 int fileflags = 0;
937 #define if_FLAGGED_SET(FLAG, MODE) if ((Mode & FLAG) == FLAG) fileflags |= MODE
938 if_FLAGGED_SET(ReadWrite, O_RDWR);
939 else if_FLAGGED_SET(ReadOnly, O_RDONLY);
940 else if_FLAGGED_SET(WriteOnly, O_WRONLY);
4a9db827 941
561f860a
DK
942 if_FLAGGED_SET(Create, O_CREAT);
943 if_FLAGGED_SET(Empty, O_TRUNC);
944 if_FLAGGED_SET(Exclusive, O_EXCL);
945 else if_FLAGGED_SET(Atomic, O_EXCL);
946 #undef if_FLAGGED_SET
52b47296 947
561f860a
DK
948 if (TemporaryFileName.empty() == false)
949 iFd = open(TemporaryFileName.c_str(), fileflags, Perms);
468720c5 950 else
561f860a 951 iFd = open(FileName.c_str(), fileflags, Perms);
468720c5 952
b711c01e 953 this->FileName = FileName;
561f860a
DK
954 if (iFd == -1 || OpenInternDescriptor(Mode, compressor) == false)
955 {
468720c5 956 if (iFd != -1)
fc81e8f2 957 {
561f860a
DK
958 close (iFd);
959 iFd = -1;
fc81e8f2 960 }
561f860a 961 return _error->Errno("open",_("Could not open file %s"), FileName.c_str());
257e8d66 962 }
578bfd0a 963
13d87e2e
AL
964 SetCloseExec(iFd,true);
965 return true;
578bfd0a 966}
257e8d66
DK
967 /*}}}*/
968// FileFd::OpenDescriptor - Open a filedescriptor /*{{{*/
969// ---------------------------------------------------------------------
970/* */
52b47296 971bool FileFd::OpenDescriptor(int Fd, unsigned int const Mode, CompressMode Compress, bool AutoClose)
aee1aac6
DK
972{
973 std::vector<APT::Configuration::Compressor> const compressors = APT::Configuration::getCompressors();
974 std::vector<APT::Configuration::Compressor>::const_iterator compressor = compressors.begin();
975 std::string name;
bce778a3
MV
976
977 // compat with the old API
978 if (Mode == ReadOnlyGzip && Compress == None)
979 Compress = Gzip;
980
aee1aac6
DK
981 switch (Compress)
982 {
983 case None: name = "."; break;
984 case Gzip: name = "gzip"; break;
985 case Bzip2: name = "bzip2"; break;
986 case Lzma: name = "lzma"; break;
987 case Xz: name = "xz"; break;
988 case Auto:
989 case Extension:
990 return _error->Error("Opening Fd %d in Auto or Extension compression mode is not supported", Fd);
991 }
992 for (; compressor != compressors.end(); ++compressor)
993 if (compressor->Name == name)
994 break;
995 if (compressor == compressors.end())
996 return _error->Error("Can't find a configured compressor %s for file %s", name.c_str(), FileName.c_str());
997
998 return OpenDescriptor(Fd, Mode, *compressor, AutoClose);
999}
52b47296 1000bool FileFd::OpenDescriptor(int Fd, unsigned int const Mode, APT::Configuration::Compressor const &compressor, bool AutoClose)
144c0969
JAK
1001{
1002 Close();
032bd56f 1003 d = new FileFdPrivate;
699b209e 1004 d->openmode = Mode;
144c0969
JAK
1005 Flags = (AutoClose) ? FileFd::AutoClose : 0;
1006 iFd = Fd;
b711c01e 1007 this->FileName = "";
aee1aac6 1008 if (OpenInternDescriptor(Mode, compressor) == false)
468720c5
DK
1009 {
1010 if (AutoClose)
1011 close (iFd);
1012 return _error->Errno("gzdopen",_("Could not open file descriptor %d"), Fd);
144c0969 1013 }
144c0969 1014 return true;
468720c5 1015}
52b47296 1016bool FileFd::OpenInternDescriptor(unsigned int const Mode, APT::Configuration::Compressor const &compressor)
468720c5 1017{
561f860a
DK
1018 d->compressor = compressor;
1019 if (compressor.Name == "." || compressor.Binary.empty() == true)
468720c5 1020 return true;
7efb8c8e 1021#ifdef HAVE_ZLIB
aee1aac6 1022 else if (compressor.Name == "gzip")
468720c5
DK
1023 {
1024 if ((Mode & ReadWrite) == ReadWrite)
032bd56f 1025 d->gz = gzdopen(iFd, "r+");
468720c5 1026 else if ((Mode & WriteOnly) == WriteOnly)
032bd56f 1027 d->gz = gzdopen(iFd, "w");
468720c5 1028 else
c4997486 1029 d->gz = gzdopen(iFd, "r");
032bd56f 1030 if (d->gz == NULL)
468720c5 1031 return false;
032bd56f 1032 Flags |= Compressed;
561f860a 1033 return true;
468720c5 1034 }
699b209e 1035#endif
c4997486
DK
1036#ifdef HAVE_BZ2
1037 else if (compressor.Name == "bzip2")
1038 {
1039 if ((Mode & ReadWrite) == ReadWrite)
1040 d->bz2 = BZ2_bzdopen(iFd, "r+");
1041 else if ((Mode & WriteOnly) == WriteOnly)
1042 d->bz2 = BZ2_bzdopen(iFd, "w");
1043 else
1044 d->bz2 = BZ2_bzdopen(iFd, "r");
1045 if (d->bz2 == NULL)
1046 return false;
1047 Flags |= Compressed;
1048 return true;
1049 }
1050#endif
1051
561f860a
DK
1052
1053 if ((Mode & ReadWrite) == ReadWrite)
1054 return _error->Error("ReadWrite mode is not supported for file %s", FileName.c_str());
1055
1056 bool const Comp = (Mode & WriteOnly) == WriteOnly;
1057 // Handle 'decompression' of empty files
1058 if (Comp == false)
1059 {
1060 struct stat Buf;
1061 fstat(iFd, &Buf);
1062 if (Buf.st_size == 0 && S_ISFIFO(Buf.st_mode) == false)
1063 return true;
1064
1065 // We don't need the file open - instead let the compressor open it
1066 // as he properly knows better how to efficiently read from 'his' file
1067 if (FileName.empty() == false)
1068 close(iFd);
1069 }
1070
1071 // Create a data pipe
1072 int Pipe[2] = {-1,-1};
1073 if (pipe(Pipe) != 0)
1074 return _error->Errno("pipe",_("Failed to create subprocess IPC"));
1075 for (int J = 0; J != 2; J++)
1076 SetCloseExec(Pipe[J],true);
1077
1078 d->compressed_fd = iFd;
1079 d->pipe = true;
1080
1081 if (Comp == true)
1082 iFd = Pipe[1];
1083 else
1084 iFd = Pipe[0];
1085
1086 // The child..
1087 d->compressor_pid = ExecFork();
1088 if (d->compressor_pid == 0)
1089 {
1090 if (Comp == true)
1091 {
1092 dup2(d->compressed_fd,STDOUT_FILENO);
1093 dup2(Pipe[0],STDIN_FILENO);
1094 }
1095 else
1096 {
1097 if (FileName.empty() == true)
1098 dup2(d->compressed_fd,STDIN_FILENO);
1099 dup2(Pipe[1],STDOUT_FILENO);
1100 }
1101
1102 SetCloseExec(STDOUT_FILENO,false);
1103 SetCloseExec(STDIN_FILENO,false);
1104
1105 std::vector<char const*> Args;
1106 Args.push_back(compressor.Binary.c_str());
1107 std::vector<std::string> const * const addArgs =
1108 (Comp == true) ? &(compressor.CompressArgs) : &(compressor.UncompressArgs);
1109 for (std::vector<std::string>::const_iterator a = addArgs->begin();
1110 a != addArgs->end(); ++a)
1111 Args.push_back(a->c_str());
1112 if (Comp == false && FileName.empty() == false)
1113 {
1114 Args.push_back("--stdout");
1115 if (TemporaryFileName.empty() == false)
1116 Args.push_back(TemporaryFileName.c_str());
1117 else
1118 Args.push_back(FileName.c_str());
1119 }
1120 Args.push_back(NULL);
1121
1122 execvp(Args[0],(char **)&Args[0]);
1123 cerr << _("Failed to exec compressor ") << Args[0] << endl;
1124 _exit(100);
1125 }
1126 if (Comp == true)
1127 close(Pipe[0]);
468720c5 1128 else
561f860a
DK
1129 close(Pipe[1]);
1130 if (Comp == true || FileName.empty() == true)
1131 close(d->compressed_fd);
1132
468720c5 1133 return true;
144c0969 1134}
578bfd0a 1135 /*}}}*/
8e06abb2 1136// FileFd::~File - Closes the file /*{{{*/
578bfd0a
AL
1137// ---------------------------------------------------------------------
1138/* If the proper modes are selected then we close the Fd and possibly
1139 unlink the file on error. */
8e06abb2 1140FileFd::~FileFd()
578bfd0a
AL
1141{
1142 Close();
1143}
1144 /*}}}*/
8e06abb2 1145// FileFd::Read - Read a bit of the file /*{{{*/
578bfd0a 1146// ---------------------------------------------------------------------
b0db36b1
AL
1147/* We are carefull to handle interruption by a signal while reading
1148 gracefully. */
650faab0 1149bool FileFd::Read(void *To,unsigned long long Size,unsigned long long *Actual)
578bfd0a 1150{
b0db36b1
AL
1151 int Res;
1152 errno = 0;
f604cf55
AL
1153 if (Actual != 0)
1154 *Actual = 0;
699b209e 1155 *((char *)To) = '\0';
b0db36b1 1156 do
578bfd0a 1157 {
7efb8c8e 1158#ifdef HAVE_ZLIB
032bd56f 1159 if (d->gz != NULL)
c4997486
DK
1160 Res = gzread(d->gz,To,Size);
1161 else
1162#endif
1163#ifdef HAVE_BZ2
1164 if (d->bz2 != NULL)
1165 Res = BZ2_bzread(d->bz2,To,Size);
a3a03f5d 1166 else
699b209e 1167#endif
a3a03f5d 1168 Res = read(iFd,To,Size);
b711c01e 1169
b0db36b1
AL
1170 if (Res < 0)
1171 {
b711c01e
DK
1172 if (errno == EINTR)
1173 continue;
b0db36b1 1174 Flags |= Fail;
7efb8c8e 1175#ifdef HAVE_ZLIB
b711c01e
DK
1176 if (d->gz != NULL)
1177 {
1178 int err;
1179 char const * const errmsg = gzerror(d->gz, &err);
1180 if (err != Z_ERRNO)
1181 return _error->Error("gzread: %s (%d: %s)", _("Read error"), err, errmsg);
1182 }
c4997486
DK
1183#endif
1184#ifdef HAVE_BZ2
1185 if (d->bz2 != NULL)
1186 {
1187 int err;
1188 char const * const errmsg = BZ2_bzerror(d->bz2, &err);
1189 if (err != BZ_IO_ERROR)
1190 return _error->Error("BZ2_bzread: %s (%d: %s)", _("Read error"), err, errmsg);
1191 }
b711c01e 1192#endif
b2e465d6 1193 return _error->Errno("read",_("Read error"));
b0db36b1 1194 }
578bfd0a 1195
b0db36b1
AL
1196 To = (char *)To + Res;
1197 Size -= Res;
1abbc47c 1198 d->seekpos += Res;
f604cf55
AL
1199 if (Actual != 0)
1200 *Actual += Res;
b0db36b1
AL
1201 }
1202 while (Res > 0 && Size > 0);
1203
1204 if (Size == 0)
1205 return true;
1206
ddc1d8d0 1207 // Eof handling
f604cf55 1208 if (Actual != 0)
ddc1d8d0
AL
1209 {
1210 Flags |= HitEof;
1211 return true;
1212 }
1213
b0db36b1 1214 Flags |= Fail;
650faab0 1215 return _error->Error(_("read, still have %llu to read but none left"), Size);
578bfd0a
AL
1216}
1217 /*}}}*/
032bd56f
DK
1218// FileFd::ReadLine - Read a complete line from the file /*{{{*/
1219// ---------------------------------------------------------------------
1220/* Beware: This method can be quiet slow for big buffers on UNcompressed
1221 files because of the naive implementation! */
1222char* FileFd::ReadLine(char *To, unsigned long long const Size)
1223{
699b209e 1224 *To = '\0';
7efb8c8e 1225#ifdef HAVE_ZLIB
032bd56f
DK
1226 if (d->gz != NULL)
1227 return gzgets(d->gz, To, Size);
699b209e 1228#endif
032bd56f
DK
1229
1230 unsigned long long read = 0;
40468850
DK
1231 while ((Size - 1) != read)
1232 {
1233 unsigned long long done = 0;
1234 if (Read(To + read, 1, &done) == false)
1235 return NULL;
1236 if (done == 0)
1237 break;
1238 if (To[read++] == '\n')
1239 break;
1240 }
1241 if (read == 0)
032bd56f 1242 return NULL;
40468850 1243 To[read] = '\0';
032bd56f
DK
1244 return To;
1245}
1246 /*}}}*/
8e06abb2 1247// FileFd::Write - Write to the file /*{{{*/
578bfd0a
AL
1248// ---------------------------------------------------------------------
1249/* */
650faab0 1250bool FileFd::Write(const void *From,unsigned long long Size)
578bfd0a 1251{
b0db36b1
AL
1252 int Res;
1253 errno = 0;
1254 do
578bfd0a 1255 {
7efb8c8e 1256#ifdef HAVE_ZLIB
032bd56f
DK
1257 if (d->gz != NULL)
1258 Res = gzwrite(d->gz,From,Size);
a3a03f5d 1259 else
c4997486
DK
1260#endif
1261#ifdef HAVE_BZ2
1262 if (d->bz2 != NULL)
1263 Res = BZ2_bzwrite(d->bz2,(void*)From,Size);
1264 else
699b209e 1265#endif
a3a03f5d 1266 Res = write(iFd,From,Size);
b0db36b1
AL
1267 if (Res < 0 && errno == EINTR)
1268 continue;
1269 if (Res < 0)
1270 {
1271 Flags |= Fail;
c4997486
DK
1272#ifdef HAVE_ZLIB
1273 if (d->gz != NULL)
1274 {
1275 int err;
1276 char const * const errmsg = gzerror(d->gz, &err);
1277 if (err != Z_ERRNO)
1278 return _error->Error("gzwrite: %s (%d: %s)", _("Write error"), err, errmsg);
1279 }
1280#endif
1281#ifdef HAVE_BZ2
1282 if (d->bz2 != NULL)
1283 {
1284 int err;
1285 char const * const errmsg = BZ2_bzerror(d->bz2, &err);
1286 if (err != BZ_IO_ERROR)
1287 return _error->Error("BZ2_bzwrite: %s (%d: %s)", _("Write error"), err, errmsg);
1288 }
1289#endif
b2e465d6 1290 return _error->Errno("write",_("Write error"));
b0db36b1
AL
1291 }
1292
1293 From = (char *)From + Res;
1294 Size -= Res;
1abbc47c 1295 d->seekpos += Res;
578bfd0a 1296 }
b0db36b1 1297 while (Res > 0 && Size > 0);
578bfd0a 1298
b0db36b1
AL
1299 if (Size == 0)
1300 return true;
1301
1302 Flags |= Fail;
650faab0 1303 return _error->Error(_("write, still have %llu to write but couldn't"), Size);
d68d65ad
DK
1304}
1305bool FileFd::Write(int Fd, const void *From, unsigned long long Size)
1306{
1307 int Res;
1308 errno = 0;
1309 do
1310 {
1311 Res = write(Fd,From,Size);
1312 if (Res < 0 && errno == EINTR)
1313 continue;
1314 if (Res < 0)
1315 return _error->Errno("write",_("Write error"));
1316
1317 From = (char *)From + Res;
1318 Size -= Res;
1319 }
1320 while (Res > 0 && Size > 0);
1321
1322 if (Size == 0)
1323 return true;
1324
1325 return _error->Error(_("write, still have %llu to write but couldn't"), Size);
578bfd0a
AL
1326}
1327 /*}}}*/
8e06abb2 1328// FileFd::Seek - Seek in the file /*{{{*/
578bfd0a
AL
1329// ---------------------------------------------------------------------
1330/* */
650faab0 1331bool FileFd::Seek(unsigned long long To)
578bfd0a 1332{
c4997486
DK
1333 if (d->pipe == true
1334#ifdef HAVE_BZ2
1335 || d->bz2 != NULL
1336#endif
1337 )
699b209e 1338 {
1abbc47c
DK
1339 // Our poor man seeking in pipes is costly, so try to avoid it
1340 unsigned long long seekpos = Tell();
1341 if (seekpos == To)
1342 return true;
1343 else if (seekpos < To)
1344 return Skip(To - seekpos);
1345
561f860a
DK
1346 if ((d->openmode & ReadOnly) != ReadOnly)
1347 return _error->Error("Reopen is only implemented for read-only files!");
c4997486
DK
1348#ifdef HAVE_BZ2
1349 if (d->bz2 != NULL)
1350 BZ2_bzclose(d->bz2);
1351#endif
699b209e 1352 close(iFd);
6fd947bd 1353 iFd = 0;
561f860a
DK
1354 if (TemporaryFileName.empty() == false)
1355 iFd = open(TemporaryFileName.c_str(), O_RDONLY);
1356 else if (FileName.empty() == false)
1357 iFd = open(FileName.c_str(), O_RDONLY);
1358 else
6fd947bd
DK
1359 {
1360 if (d->compressed_fd > 0)
1361 if (lseek(d->compressed_fd, 0, SEEK_SET) != 0)
1362 iFd = d->compressed_fd;
1363 if (iFd <= 0)
1364 return _error->Error("Reopen is not implemented for pipes opened with FileFd::OpenDescriptor()!");
1365 }
561f860a
DK
1366
1367 if (OpenInternDescriptor(d->openmode, d->compressor) == false)
1368 return _error->Error("Seek on file %s because it couldn't be reopened", FileName.c_str());
1369
1370 if (To != 0)
1371 return Skip(To);
1abbc47c
DK
1372
1373 d->seekpos = To;
561f860a 1374 return true;
699b209e 1375 }
a3a03f5d 1376 int res;
7efb8c8e 1377#ifdef HAVE_ZLIB
032bd56f
DK
1378 if (d->gz)
1379 res = gzseek(d->gz,To,SEEK_SET);
a3a03f5d 1380 else
699b209e 1381#endif
a3a03f5d 1382 res = lseek(iFd,To,SEEK_SET);
1383 if (res != (signed)To)
578bfd0a
AL
1384 {
1385 Flags |= Fail;
650faab0 1386 return _error->Error("Unable to seek to %llu", To);
578bfd0a 1387 }
1abbc47c
DK
1388
1389 d->seekpos = To;
727f18af
AL
1390 return true;
1391}
1392 /*}}}*/
1393// FileFd::Skip - Seek in the file /*{{{*/
1394// ---------------------------------------------------------------------
1395/* */
650faab0 1396bool FileFd::Skip(unsigned long long Over)
727f18af 1397{
c4997486
DK
1398 if (d->pipe == true
1399#ifdef HAVE_BZ2
1400 || d->bz2 != NULL
1401#endif
1402 )
40468850
DK
1403 {
1404 d->seekpos += Over;
1405 char buffer[1024];
1406 while (Over != 0)
1407 {
1408 unsigned long long toread = std::min((unsigned long long) sizeof(buffer), Over);
1409 if (Read(buffer, toread) == false)
1410 return _error->Error("Unable to seek ahead %llu",Over);
1411 Over -= toread;
1412 }
1413 return true;
1414 }
1415
a3a03f5d 1416 int res;
7efb8c8e 1417#ifdef HAVE_ZLIB
032bd56f
DK
1418 if (d->gz != NULL)
1419 res = gzseek(d->gz,Over,SEEK_CUR);
a3a03f5d 1420 else
699b209e 1421#endif
a3a03f5d 1422 res = lseek(iFd,Over,SEEK_CUR);
1423 if (res < 0)
727f18af
AL
1424 {
1425 Flags |= Fail;
650faab0 1426 return _error->Error("Unable to seek ahead %llu",Over);
727f18af 1427 }
1abbc47c
DK
1428 d->seekpos = res;
1429
6d5dd02a
AL
1430 return true;
1431}
1432 /*}}}*/
1433// FileFd::Truncate - Truncate the file /*{{{*/
1434// ---------------------------------------------------------------------
1435/* */
650faab0 1436bool FileFd::Truncate(unsigned long long To)
6d5dd02a 1437{
c4997486
DK
1438#if defined HAVE_ZLIB || defined HAVE_BZ2
1439 if (d->gz != NULL || d->bz2 != NULL)
a3a03f5d 1440 {
1441 Flags |= Fail;
c4997486 1442 return _error->Error("Truncating compressed files is not implemented (%s)", FileName.c_str());
a3a03f5d 1443 }
c4997486 1444#endif
6d5dd02a
AL
1445 if (ftruncate(iFd,To) != 0)
1446 {
1447 Flags |= Fail;
650faab0 1448 return _error->Error("Unable to truncate to %llu",To);
6d5dd02a
AL
1449 }
1450
578bfd0a
AL
1451 return true;
1452}
1453 /*}}}*/
7f25bdff
AL
1454// FileFd::Tell - Current seek position /*{{{*/
1455// ---------------------------------------------------------------------
1456/* */
650faab0 1457unsigned long long FileFd::Tell()
7f25bdff 1458{
1abbc47c
DK
1459 // In theory, we could just return seekpos here always instead of
1460 // seeking around, but not all users of FileFd use always Seek() and co
1461 // so d->seekpos isn't always true and we can just use it as a hint if
1462 // we have nothing else, but not always as an authority…
c4997486
DK
1463 if (d->pipe == true
1464#ifdef HAVE_BZ2
1465 || d->bz2 != NULL
1466#endif
1467 )
1abbc47c
DK
1468 return d->seekpos;
1469
a3a03f5d 1470 off_t Res;
7efb8c8e 1471#ifdef HAVE_ZLIB
032bd56f
DK
1472 if (d->gz != NULL)
1473 Res = gztell(d->gz);
a3a03f5d 1474 else
699b209e 1475#endif
a3a03f5d 1476 Res = lseek(iFd,0,SEEK_CUR);
7f25bdff
AL
1477 if (Res == (off_t)-1)
1478 _error->Errno("lseek","Failed to determine the current file position");
1abbc47c 1479 d->seekpos = Res;
7f25bdff
AL
1480 return Res;
1481}
1482 /*}}}*/
4260fd39 1483// FileFd::FileSize - Return the size of the file /*{{{*/
578bfd0a
AL
1484// ---------------------------------------------------------------------
1485/* */
650faab0 1486unsigned long long FileFd::FileSize()
578bfd0a
AL
1487{
1488 struct stat Buf;
699b209e 1489 if (d->pipe == false && fstat(iFd,&Buf) != 0)
44dc669e 1490 return _error->Errno("fstat","Unable to determine the file size");
699b209e
DK
1491
1492 // for compressor pipes st_size is undefined and at 'best' zero
1493 if (d->pipe == true || S_ISFIFO(Buf.st_mode))
1494 {
1495 // we set it here, too, as we get the info here for free
1496 // in theory the Open-methods should take care of it already
1497 d->pipe = true;
1498 if (stat(FileName.c_str(), &Buf) != 0)
1499 return _error->Errno("stat","Unable to determine the file size");
1500 }
1501
4260fd39
DK
1502 return Buf.st_size;
1503}
1504 /*}}}*/
1505// FileFd::Size - Return the size of the content in the file /*{{{*/
1506// ---------------------------------------------------------------------
1507/* */
650faab0 1508unsigned long long FileFd::Size()
4260fd39 1509{
650faab0 1510 unsigned long long size = FileSize();
44dc669e 1511
699b209e
DK
1512 // for compressor pipes st_size is undefined and at 'best' zero,
1513 // so we 'read' the content and 'seek' back - see there
c4997486
DK
1514 if (d->pipe == true
1515#ifdef HAVE_BZ2
1516 || (d->bz2 && size > 0)
1517#endif
1518 )
699b209e 1519 {
1abbc47c 1520 unsigned long long const oldSeek = Tell();
699b209e
DK
1521 char ignore[1000];
1522 unsigned long long read = 0;
1523 do {
1524 Read(ignore, sizeof(ignore), &read);
699b209e 1525 } while(read != 0);
1abbc47c
DK
1526 size = Tell();
1527 Seek(oldSeek);
699b209e 1528 }
7efb8c8e 1529#ifdef HAVE_ZLIB
44dc669e 1530 // only check gzsize if we are actually a gzip file, just checking for
032bd56f 1531 // "gz" is not sufficient as uncompressed files could be opened with
44dc669e 1532 // gzopen in "direct" mode as well
699b209e 1533 else if (d->gz && !gzdirect(d->gz) && size > 0)
9c182afa 1534 {
65c72a4b 1535 off_t const oldPos = lseek(iFd,0,SEEK_CUR);
9c182afa
MP
1536 /* unfortunately zlib.h doesn't provide a gzsize(), so we have to do
1537 * this ourselves; the original (uncompressed) file size is the last 32
1538 * bits of the file */
650faab0 1539 // FIXME: Size for gz-files is limited by 32bit… no largefile support
9c182afa
MP
1540 if (lseek(iFd, -4, SEEK_END) < 0)
1541 return _error->Errno("lseek","Unable to seek to end of gzipped file");
f330c0f3 1542 size = 0L;
9c182afa
MP
1543 if (read(iFd, &size, 4) != 4)
1544 return _error->Errno("read","Unable to read original size of gzipped file");
f330c0f3
DK
1545
1546#ifdef WORDS_BIGENDIAN
2cae0ccb
DK
1547 uint32_t tmp_size = size;
1548 uint8_t const * const p = (uint8_t const * const) &tmp_size;
1549 tmp_size = (p[3] << 24) | (p[2] << 16) | (p[1] << 8) | p[0];
1550 size = tmp_size;
f330c0f3 1551#endif
9c182afa 1552
65c72a4b 1553 if (lseek(iFd, oldPos, SEEK_SET) < 0)
9c182afa 1554 return _error->Errno("lseek","Unable to seek in gzipped file");
65c72a4b 1555
9c182afa
MP
1556 return size;
1557 }
699b209e 1558#endif
9c182afa 1559
44dc669e 1560 return size;
578bfd0a
AL
1561}
1562 /*}}}*/
76a763e1
DK
1563// FileFd::ModificationTime - Return the time of last touch /*{{{*/
1564// ---------------------------------------------------------------------
1565/* */
1566time_t FileFd::ModificationTime()
1567{
1568 struct stat Buf;
699b209e 1569 if (d->pipe == false && fstat(iFd,&Buf) != 0)
76a763e1
DK
1570 {
1571 _error->Errno("fstat","Unable to determine the modification time of file %s", FileName.c_str());
1572 return 0;
1573 }
699b209e
DK
1574
1575 // for compressor pipes st_size is undefined and at 'best' zero
1576 if (d->pipe == true || S_ISFIFO(Buf.st_mode))
1577 {
1578 // we set it here, too, as we get the info here for free
1579 // in theory the Open-methods should take care of it already
1580 d->pipe = true;
1581 if (stat(FileName.c_str(), &Buf) != 0)
1582 {
1583 _error->Errno("fstat","Unable to determine the modification time of file %s", FileName.c_str());
1584 return 0;
1585 }
1586 }
1587
76a763e1
DK
1588 return Buf.st_mtime;
1589}
1590 /*}}}*/
8e06abb2 1591// FileFd::Close - Close the file if the close flag is set /*{{{*/
578bfd0a
AL
1592// ---------------------------------------------------------------------
1593/* */
8e06abb2 1594bool FileFd::Close()
578bfd0a 1595{
032bd56f
DK
1596 if (iFd == -1)
1597 return true;
1598
578bfd0a
AL
1599 bool Res = true;
1600 if ((Flags & AutoClose) == AutoClose)
d13c2d3f 1601 {
7efb8c8e 1602#ifdef HAVE_ZLIB
032bd56f
DK
1603 if (d != NULL && d->gz != NULL) {
1604 int const e = gzclose(d->gz);
b711c01e 1605 // gzdclose() on empty files always fails with "buffer error" here, ignore that
d13c2d3f 1606 if (e != 0 && e != Z_BUF_ERROR)
3184b4cf 1607 Res &= _error->Errno("close",_("Problem closing the gzip file %s"), FileName.c_str());
d13c2d3f 1608 } else
c4997486
DK
1609#endif
1610#ifdef HAVE_BZ2
1611 if (d != NULL && d->bz2 != NULL)
1612 BZ2_bzclose(d->bz2);
1613 else
699b209e 1614#endif
d13c2d3f 1615 if (iFd > 0 && close(iFd) != 0)
3184b4cf 1616 Res &= _error->Errno("close",_("Problem closing the file %s"), FileName.c_str());
d13c2d3f 1617 }
3010fb0e 1618
62d073d9 1619 if ((Flags & Replace) == Replace && iFd >= 0) {
3010fb0e 1620 if (rename(TemporaryFileName.c_str(), FileName.c_str()) != 0)
62d073d9
DK
1621 Res &= _error->Errno("rename",_("Problem renaming the file %s to %s"), TemporaryFileName.c_str(), FileName.c_str());
1622
fd3b761e 1623 FileName = TemporaryFileName; // for the unlink() below.
257e8d66 1624 TemporaryFileName.clear();
3010fb0e 1625 }
62d073d9
DK
1626
1627 iFd = -1;
1628
578bfd0a
AL
1629 if ((Flags & Fail) == Fail && (Flags & DelOnFail) == DelOnFail &&
1630 FileName.empty() == false)
1631 if (unlink(FileName.c_str()) != 0)
62d073d9 1632 Res &= _error->WarningE("unlnk",_("Problem unlinking the file %s"), FileName.c_str());
3010fb0e 1633
032bd56f
DK
1634 if (d != NULL)
1635 {
561f860a 1636 if (d->compressor_pid > 0)
52b47296 1637 ExecWait(d->compressor_pid, "FileFdCompressor", true);
032bd56f
DK
1638 delete d;
1639 d = NULL;
1640 }
3010fb0e 1641
578bfd0a
AL
1642 return Res;
1643}
1644 /*}}}*/
b2e465d6
AL
1645// FileFd::Sync - Sync the file /*{{{*/
1646// ---------------------------------------------------------------------
1647/* */
1648bool FileFd::Sync()
1649{
1650#ifdef _POSIX_SYNCHRONIZED_IO
1651 if (fsync(iFd) != 0)
1652 return _error->Errno("sync",_("Problem syncing the file"));
1653#endif
1654 return true;
1655}
1656 /*}}}*/
699b209e
DK
1657
1658gzFile FileFd::gzFd() { return (gzFile) d->gz; }