src/support/FileName.cpp

   1 /**
   2  * \file FileName.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Angus Leeming
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "support/FileName.h"
  14
  15 #include "support/debug.h"
  16 #include "support/filetools.h"
  17 #include "support/lstrings.h"
  18 #include "support/lyxlib.h"
  19 #include "support/os.h"
  20 #include "support/qstring_helpers.h"
  21
  22 #include <QDateTime>
  23 #include <QDir>
  24 #include <QFile>
  25 #include <QFileInfo>
  26 #include <QList>
  27
  28 #include <boost/assert.hpp>
  29
  30 #include <map>
  31 #include <sstream>
  32 #include <fstream>
  33 #include <algorithm>
  34
  35 #ifdef HAVE_SYS_TYPES_H
  36 # include <sys/types.h>
  37 #endif
  38 #ifdef HAVE_SYS_STAT_H
  39 # include <sys/stat.h>
  40 #endif
  41 #include <cerrno>
  42 #include <fcntl.h>
  43
  44
  45 using std::map;
  46 using std::string;
  47 using std::ifstream;
  48 using std::ostringstream;
  49 using std::endl;
  50
  51 namespace lyx {
  52 namespace support {
  53
  54
  55 /////////////////////////////////////////////////////////////////////
  56 //
  57 // FileName::Private
  58 //
  59 /////////////////////////////////////////////////////////////////////
  60
  61 struct FileName::Private
  62 {
  63         Private() {}
  64
  65         Private(string const & abs_filename) : fi(toqstr(abs_filename))
  66         {}
  67         ///
  68         QFileInfo fi;
  69 };
  70
  71 /////////////////////////////////////////////////////////////////////
  72 //
  73 // FileName
  74 //
  75 /////////////////////////////////////////////////////////////////////
  76
  77
  78 FileName::FileName() : d(new Private)
  79 {
  80 }
  81
  82
  83 FileName::FileName(string const & abs_filename)
  84         : d(abs_filename.empty() ? new Private : new Private(abs_filename))
  85 {
  86 }
  87
  88
  89 FileName::~FileName()
  90 {
  91         delete d;
  92 }
  93
  94
  95 FileName::FileName(FileName const & rhs) : d(new Private)
  96 {
  97         d->fi = rhs.d->fi;
  98 }
  99
 100
 101 FileName & FileName::operator=(FileName const & rhs)
 102 {
 103         d->fi = rhs.d->fi;
 104         return *this;
 105 }
 106
 107
 108 bool FileName::empty() const
 109 {
 110         return d->fi.absoluteFilePath().isEmpty();
 111 }
 112
 113
 114 string FileName::absFilename() const
 115 {
 116         return fromqstr(d->fi.absoluteFilePath());
 117 }
 118
 119
 120 void FileName::set(string const & name)
 121 {
 122         d->fi.setFile(toqstr(name));
 123         BOOST_ASSERT(d->fi.isAbsolute());
 124 }
 125
 126
 127 void FileName::erase()
 128 {
 129         d->fi = QFileInfo();
 130 }
 131
 132
 133 bool FileName::copyTo(FileName const & name, bool overwrite) const
 134 {
 135         if (overwrite)
 136                 QFile::remove(name.d->fi.absoluteFilePath());
 137         bool success = QFile::copy(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath());
 138         if (!success)
 139                 lyxerr << "FileName::copyTo(): Could not copy file "
 140                         << *this << " to " << name << endl;
 141         return success;
 142 }
 143
 144
 145 string FileName::toFilesystemEncoding() const
 146 {
 147         QByteArray const encoded = QFile::encodeName(d->fi.absoluteFilePath());
 148         return string(encoded.begin(), encoded.end());
 149 }
 150
 151
 152 FileName FileName::fromFilesystemEncoding(string const & name)
 153 {
 154         QByteArray const encoded(name.c_str(), name.length());
 155         return FileName(fromqstr(QFile::decodeName(encoded)));
 156 }
 157
 158
 159 bool FileName::exists() const
 160 {
 161         return d->fi.exists();
 162 }
 163
 164
 165 bool FileName::isSymLink() const
 166 {
 167         return d->fi.isSymLink();
 168 }
 169
 170
 171 bool FileName::isFileEmpty() const
 172 {
 173         return d->fi.size() == 0;
 174 }
 175
 176
 177 bool FileName::isDirectory() const
 178 {
 179         return d->fi.isDir();
 180 }
 181
 182
 183 bool FileName::isReadOnly() const
 184 {
 185         return d->fi.isReadable() && !d->fi.isWritable();
 186 }
 187
 188
 189 bool FileName::isReadableDirectory() const
 190 {
 191         return d->fi.isDir() && d->fi.isReadable();
 192 }
 193
 194
 195 std::string FileName::onlyFileName() const
 196 {
 197         return support::onlyFilename(absFilename());
 198 }
 199
 200
 201 FileName FileName::onlyPath() const
 202 {
 203         return FileName(support::onlyPath(absFilename()));
 204 }
 205
 206
 207 bool FileName::isReadableFile() const
 208 {
 209         return d->fi.isFile() && d->fi.isReadable();
 210 }
 211
 212
 213 bool FileName::isWritable() const
 214 {
 215         return d->fi.isWritable();
 216 }
 217
 218
 219 bool FileName::isDirWritable() const
 220 {
 221         LYXERR(Debug::FILES, "isDirWriteable: " << *this);
 222
 223         FileName const tmpfl(tempName(*this, "lyxwritetest"));
 224
 225         if (tmpfl.empty())
 226                 return false;
 227
 228         tmpfl.removeFile();
 229         return true;
 230 }
 231
 232
 233 FileName FileName::tempName(FileName const & dir, std::string const & mask)
 234 {
 235         return support::tempName(dir, mask);
 236 }
 237
 238
 239 std::time_t FileName::lastModified() const
 240 {
 241         return d->fi.lastModified().toTime_t();
 242 }
 243
 244
 245 bool FileName::chdir() const
 246 {
 247         return QDir::setCurrent(d->fi.absoluteFilePath());
 248 }
 249
 250
 251 extern unsigned long sum(char const * file);
 252
 253 unsigned long FileName::checksum() const
 254 {
 255         if (!exists()) {
 256                 LYXERR0("File \"" << absFilename() << "\" does not exist!");
 257                 return 0;
 258         }
 259         // a directory may be passed here so we need to test it. (bug 3622)
 260         if (isDirectory()) {
 261                 LYXERR0('\\' << absFilename() << "\" is a directory!");
 262                 return 0;
 263         }
 264         LYXERR0("Checksumming \"" << absFilename() << "\".");
 265         return sum(absFilename().c_str());
 266 }
 267
 268
 269 bool FileName::removeFile() const
 270 {
 271         bool const success = QFile::remove(d->fi.absoluteFilePath());
 272         if (!success && exists())
 273                 lyxerr << "FileName::removeFile(): Could not delete file "
 274                         << *this << "." << endl;
 275         return success;
 276 }
 277
 278
 279 static bool rmdir(QFileInfo const & fi)
 280 {
 281         QDir dir(fi.absoluteFilePath());
 282         QFileInfoList list = dir.entryInfoList();
 283         bool global_success = true;
 284         for (int i = 0; i != list.size(); ++i) {
 285                 if (list.at(i).fileName() == ".")
 286                         continue;
 287                 if (list.at(i).fileName() == "..")
 288                         continue;
 289                 bool success;
 290                 if (list.at(i).isDir()) {
 291                         LYXERR(Debug::FILES, "Erasing dir "
 292                                 << fromqstr(list.at(i).absoluteFilePath()));
 293                         success = rmdir(list.at(i));
 294                 }
 295                 else {
 296                         LYXERR(Debug::FILES, "Erasing file "
 297                                 << fromqstr(list.at(i).absoluteFilePath()));
 298                         success = dir.remove(list.at(i).fileName());
 299                 }
 300                 if (!success) {
 301                         global_success = false;
 302                         lyxerr << "Could not delete "
 303                                 << fromqstr(list.at(i).absoluteFilePath()) << "." << endl;
 304                 }
 305         }
 306         QDir parent = fi.absolutePath();
 307         global_success |= parent.rmdir(fi.fileName());
 308         return global_success;
 309 }
 310
 311
 312 bool FileName::destroyDirectory() const
 313 {
 314         bool const success = rmdir(d->fi);
 315         if (!success)
 316                 lyxerr << "Could not delete " << *this << "." << endl;
 317
 318         return success;
 319 }
 320
 321
 322 bool FileName::createDirectory(int permission) const
 323 {
 324         BOOST_ASSERT(!empty());
 325         return mkdir(*this, permission) == 0;
 326 }
 327
 328
 329 docstring const FileName::absoluteFilePath() const
 330 {
 331         return qstring_to_ucs4(d->fi.absoluteFilePath());
 332 }
 333
 334
 335 docstring FileName::displayName(int threshold) const
 336 {
 337         return makeDisplayPath(absFilename(), threshold);
 338 }
 339
 340
 341 string FileName::fileContents() const
 342 {
 343         if (exists()) {
 344                 string const encodedname = toFilesystemEncoding();
 345                 ifstream ifs(encodedname.c_str());
 346                 ostringstream ofs;
 347                 if (ifs && ofs) {
 348                         ofs << ifs.rdbuf();
 349                         ifs.close();
 350                         return ofs.str();
 351                 }
 352         }
 353         lyxerr << "LyX was not able to read file '" << *this << '\'' << std::endl;
 354         return string();
 355 }
 356
 357
 358 void FileName::changeExtension(std::string const & extension)
 359 {
 360         // FIXME: use Qt native methods...
 361         string const oldname = absFilename();
 362         string::size_type const last_slash = oldname.rfind('/');
 363         string::size_type last_dot = oldname.rfind('.');
 364         if (last_dot < last_slash && last_slash != string::npos)
 365                 last_dot = string::npos;
 366
 367         string ext;
 368         // Make sure the extension starts with a dot
 369         if (!extension.empty() && extension[0] != '.')
 370                 ext= '.' + extension;
 371         else
 372                 ext = extension;
 373
 374         set(oldname.substr(0, last_dot) + ext);
 375 }
 376
 377
 378 string FileName::guessFormatFromContents() const
 379 {
 380         // the different filetypes and what they contain in one of the first lines
 381         // (dots are any characters).           (Herbert 20020131)
 382         // AGR  Grace...
 383         // BMP  BM...
 384         // EPS  %!PS-Adobe-3.0 EPSF...
 385         // FIG  #FIG...
 386         // FITS ...BITPIX...
 387         // GIF  GIF...
 388         // JPG  JFIF
 389         // PDF  %PDF-...
 390         // PNG  .PNG...
 391         // PBM  P1... or P4     (B/W)
 392         // PGM  P2... or P5     (Grayscale)
 393         // PPM  P3... or P6     (color)
 394         // PS   %!PS-Adobe-2.0 or 1.0,  no "EPSF"!
 395         // SGI  \001\332...     (decimal 474)
 396         // TGIF %TGIF...
 397         // TIFF II... or MM...
 398         // XBM  ..._bits[]...
 399         // XPM  /* XPM */    sometimes missing (f.ex. tgif-export)
 400         //      ...static char *...
 401         // XWD  \000\000\000\151        (0x00006900) decimal 105
 402         //
 403         // GZIP \037\213        http://www.ietf.org/rfc/rfc1952.txt
 404         // ZIP  PK...                   http://www.halyava.ru/document/ind_arch.htm
 405         // Z    \037\235                UNIX compress
 406         // paranoia check
 407
 408         if (empty() || !isReadableFile())
 409                 return string();
 410
 411         ifstream ifs(toFilesystemEncoding().c_str());
 412         if (!ifs)
 413                 // Couldn't open file...
 414                 return string();
 415
 416         // gnuzip
 417         static string const gzipStamp = "\037\213";
 418
 419         // PKZIP
 420         static string const zipStamp = "PK";
 421
 422         // compress
 423         static string const compressStamp = "\037\235";
 424
 425         // Maximum strings to read
 426         int const max_count = 50;
 427         int count = 0;
 428
 429         string str;
 430         string format;
 431         bool firstLine = true;
 432         while ((count++ < max_count) && format.empty()) {
 433                 if (ifs.eof()) {
 434                         LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
 435                                 << "\tFile type not recognised before EOF!");
 436                         break;
 437                 }
 438
 439                 getline(ifs, str);
 440                 string const stamp = str.substr(0, 2);
 441                 if (firstLine && str.size() >= 2) {
 442                         // at first we check for a zipped file, because this
 443                         // information is saved in the first bytes of the file!
 444                         // also some graphic formats which save the information
 445                         // in the first line, too.
 446                         if (prefixIs(str, gzipStamp)) {
 447                                 format =  "gzip";
 448
 449                         } else if (stamp == zipStamp) {
 450                                 format =  "zip";
 451
 452                         } else if (stamp == compressStamp) {
 453                                 format =  "compress";
 454
 455                         // the graphics part
 456                         } else if (stamp == "BM") {
 457                                 format =  "bmp";
 458
 459                         } else if (stamp == "\001\332") {
 460                                 format =  "sgi";
 461
 462                         // PBM family
 463                         // Don't need to use str.at(0), str.at(1) because
 464                         // we already know that str.size() >= 2
 465                         } else if (str[0] == 'P') {
 466                                 switch (str[1]) {
 467                                 case '1':
 468                                 case '4':
 469                                         format =  "pbm";
 470                                     break;
 471                                 case '2':
 472                                 case '5':
 473                                         format =  "pgm";
 474                                     break;
 475                                 case '3':
 476                                 case '6':
 477                                         format =  "ppm";
 478                                 }
 479                                 break;
 480
 481                         } else if ((stamp == "II") || (stamp == "MM")) {
 482                                 format =  "tiff";
 483
 484                         } else if (prefixIs(str,"%TGIF")) {
 485                                 format =  "tgif";
 486
 487                         } else if (prefixIs(str,"#FIG")) {
 488                                 format =  "fig";
 489
 490                         } else if (prefixIs(str,"GIF")) {
 491                                 format =  "gif";
 492
 493                         } else if (str.size() > 3) {
 494                                 int const c = ((str[0] << 24) & (str[1] << 16) &
 495                                                (str[2] << 8)  & str[3]);
 496                                 if (c == 105) {
 497                                         format =  "xwd";
 498                                 }
 499                         }
 500
 501                         firstLine = false;
 502                 }
 503
 504                 if (!format.empty())
 505                     break;
 506                 else if (contains(str,"EPSF"))
 507                         // dummy, if we have wrong file description like
 508                         // %!PS-Adobe-2.0EPSF"
 509                         format = "eps";
 510
 511                 else if (contains(str, "Grace"))
 512                         format = "agr";
 513
 514                 else if (contains(str, "JFIF"))
 515                         format = "jpg";
 516
 517                 else if (contains(str, "%PDF"))
 518                         format = "pdf";
 519
 520                 else if (contains(str, "PNG"))
 521                         format = "png";
 522
 523                 else if (contains(str, "%!PS-Adobe")) {
 524                         // eps or ps
 525                         ifs >> str;
 526                         if (contains(str,"EPSF"))
 527                                 format = "eps";
 528                         else
 529                             format = "ps";
 530                 }
 531
 532                 else if (contains(str, "_bits[]"))
 533                         format = "xbm";
 534
 535                 else if (contains(str, "XPM") || contains(str, "static char *"))
 536                         format = "xpm";
 537
 538                 else if (contains(str, "BITPIX"))
 539                         format = "fits";
 540         }
 541
 542         if (!format.empty()) {
 543                 LYXERR(Debug::GRAPHICS, "Recognised Fileformat: " << format);
 544                 return format;
 545         }
 546
 547         LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
 548                 << "\tCouldn't find a known format!");
 549         return string();
 550 }
 551
 552
 553 bool FileName::isZippedFile() const
 554 {
 555         string const type = guessFormatFromContents();
 556         return contains("gzip zip compress", type) && !type.empty();
 557 }
 558
 559
 560 docstring const FileName::relPath(string const & path) const
 561 {
 562         // FIXME UNICODE
 563         return makeRelPath(absoluteFilePath(), from_utf8(path));
 564 }
 565
 566
 567 bool operator==(FileName const & lhs, FileName const & rhs)
 568 {
 569         return lhs.absFilename() == rhs.absFilename();
 570 }
 571
 572
 573 bool operator!=(FileName const & lhs, FileName const & rhs)
 574 {
 575         return lhs.absFilename() != rhs.absFilename();
 576 }
 577
 578
 579 bool operator<(FileName const & lhs, FileName const & rhs)
 580 {
 581         return lhs.absFilename() < rhs.absFilename();
 582 }
 583
 584
 585 bool operator>(FileName const & lhs, FileName const & rhs)
 586 {
 587         return lhs.absFilename() > rhs.absFilename();
 588 }
 589
 590
 591 std::ostream & operator<<(std::ostream & os, FileName const & filename)
 592 {
 593         return os << filename.absFilename();
 594 }
 595
 596
 597 /////////////////////////////////////////////////////////////////////
 598 //
 599 // DocFileName
 600 //
 601 /////////////////////////////////////////////////////////////////////
 602
 603
 604 DocFileName::DocFileName()
 605         : save_abs_path_(true)
 606 {}
 607
 608
 609 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
 610         : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
 611 {}
 612
 613
 614 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
 615         : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
 616 {}
 617
 618
 619 void DocFileName::set(string const & name, string const & buffer_path)
 620 {
 621         save_abs_path_ = absolutePath(name);
 622         FileName::set(save_abs_path_ ? name : makeAbsPath(name, buffer_path).absFilename());
 623         zipped_valid_ = false;
 624 }
 625
 626
 627 void DocFileName::erase()
 628 {
 629         FileName::erase();
 630         zipped_valid_ = false;
 631 }
 632
 633
 634 string DocFileName::relFilename(string const & path) const
 635 {
 636         // FIXME UNICODE
 637         return to_utf8(relPath(path));
 638 }
 639
 640
 641 string DocFileName::outputFilename(string const & path) const
 642 {
 643         return save_abs_path_ ? absFilename() : relFilename(path);
 644 }
 645
 646
 647 string DocFileName::mangledFilename(std::string const & dir) const
 648 {
 649         // We need to make sure that every DocFileName instance for a given
 650         // filename returns the same mangled name.
 651         typedef map<string, string> MangledMap;
 652         static MangledMap mangledNames;
 653         MangledMap::const_iterator const it = mangledNames.find(absFilename());
 654         if (it != mangledNames.end())
 655                 return (*it).second;
 656
 657         string const name = absFilename();
 658         // Now the real work
 659         string mname = os::internal_path(name);
 660         // Remove the extension.
 661         mname = support::changeExtension(name, string());
 662         // The mangled name must be a valid LaTeX name.
 663         // The list of characters to keep is probably over-restrictive,
 664         // but it is not really a problem.
 665         // Apart from non-ASCII characters, at least the following characters
 666         // are forbidden: '/', '.', ' ', and ':'.
 667         // On windows it is not possible to create files with '<', '>' or '?'
 668         // in the name.
 669         static string const keep = "abcdefghijklmnopqrstuvwxyz"
 670                                    "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 671                                    "+,-0123456789;=";
 672         string::size_type pos = 0;
 673         while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
 674                 mname[pos++] = '_';
 675         // Add the extension back on
 676         mname = support::changeExtension(mname, getExtension(name));
 677
 678         // Prepend a counter to the filename. This is necessary to make
 679         // the mangled name unique.
 680         static int counter = 0;
 681         std::ostringstream s;
 682         s << counter++ << mname;
 683         mname = s.str();
 684
 685         // MiKTeX's YAP (version 2.4.1803) crashes if the file name
 686         // is longer than about 160 characters. MiKTeX's pdflatex
 687         // is even pickier. A maximum length of 100 has been proven to work.
 688         // If dir.size() > max length, all bets are off for YAP. We truncate
 689         // the filename nevertheless, keeping a minimum of 10 chars.
 690
 691         string::size_type max_length = std::max(100 - ((int)dir.size() + 1), 10);
 692
 693         // If the mangled file name is too long, hack it to fit.
 694         // We know we're guaranteed to have a unique file name because
 695         // of the counter.
 696         if (mname.size() > max_length) {
 697                 int const half = (int(max_length) / 2) - 2;
 698                 if (half > 0) {
 699                         mname = mname.substr(0, half) + "___" +
 700                                 mname.substr(mname.size() - half);
 701                 }
 702         }
 703
 704         mangledNames[absFilename()] = mname;
 705         return mname;
 706 }
 707
 708
 709 bool DocFileName::isZipped() const
 710 {
 711         if (!zipped_valid_) {
 712                 zipped_ = isZippedFile();
 713                 zipped_valid_ = true;
 714         }
 715         return zipped_;
 716 }
 717
 718
 719 string DocFileName::unzippedFilename() const
 720 {
 721         return unzippedFileName(absFilename());
 722 }
 723
 724
 725 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
 726 {
 727         return lhs.absFilename() == rhs.absFilename()
 728                 && lhs.saveAbsPath() == rhs.saveAbsPath();
 729 }
 730
 731
 732 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
 733 {
 734         return !(lhs == rhs);
 735 }
 736
 737 } // namespace support
 738 } // namespace lyx