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 #include "support/filetools.h"
  15 #include "support/lstrings.h"
  16 #include "support/os.h"
  17 #include "support/qstring_helpers.h"
  18
  19 #include <QFile>
  20 #include <QFileInfo>
  21
  22 #include <boost/filesystem/exception.hpp>
  23 #include <boost/filesystem/operations.hpp>
  24
  25 #include <map>
  26 #include <sstream>
  27 #include <algorithm>
  28
  29
  30 using std::map;
  31 using std::string;
  32
  33 namespace lyx {
  34 namespace support {
  35
  36
  37 /////////////////////////////////////////////////////////////////////
  38 //
  39 // FileName
  40 //
  41 /////////////////////////////////////////////////////////////////////
  42
  43
  44 FileName::FileName(string const & abs_filename)
  45         : name_(abs_filename)
  46 {
  47         BOOST_ASSERT(empty() || absolutePath(name_));
  48 #if defined(_WIN32)
  49         BOOST_ASSERT(!contains(name_, '\\'));
  50 #endif
  51 }
  52
  53
  54 void FileName::set(string const & name)
  55 {
  56         name_ = name;
  57         BOOST_ASSERT(absolutePath(name_));
  58 #if defined(_WIN32)
  59         BOOST_ASSERT(!contains(name_, '\\'));
  60 #endif
  61 }
  62
  63
  64 void FileName::erase()
  65 {
  66         name_.erase();
  67 }
  68
  69
  70 string const FileName::toFilesystemEncoding() const
  71 {
  72         QByteArray const encoded = QFile::encodeName(toqstr(name_));
  73         return string(encoded.begin(), encoded.end());
  74 }
  75
  76
  77 FileName const FileName::fromFilesystemEncoding(string const & name)
  78 {
  79         QByteArray const encoded(name.c_str(), name.length());
  80         return FileName(fromqstr(QFile::decodeName(encoded)));
  81 }
  82
  83
  84 bool FileName::exists() const
  85 {
  86         return QFileInfo(toqstr(name_)).exists();
  87 }
  88
  89
  90 bool FileName::isDir() const
  91 {
  92         return QFileInfo(toqstr(name_)).isDir();
  93 }
  94
  95
  96 bool FileName::isReadOnly() const
  97 {
  98         QFileInfo const fi(toqstr(name_));
  99         return fi.isReadable() && !fi.isWritable();
 100 }
 101
 102
 103 std::time_t FileName::lastModified() const
 104 {
 105         return boost::filesystem::last_write_time(toFilesystemEncoding());
 106 }
 107
 108
 109 bool operator==(FileName const & lhs, FileName const & rhs)
 110 {
 111         return lhs.absFilename() == rhs.absFilename();
 112 }
 113
 114
 115 bool operator!=(FileName const & lhs, FileName const & rhs)
 116 {
 117         return lhs.absFilename() != rhs.absFilename();
 118 }
 119
 120
 121 bool operator<(FileName const & lhs, FileName const & rhs)
 122 {
 123         return lhs.absFilename() < rhs.absFilename();
 124 }
 125
 126
 127 bool operator>(FileName const & lhs, FileName const & rhs)
 128 {
 129         return lhs.absFilename() > rhs.absFilename();
 130 }
 131
 132
 133 std::ostream & operator<<(std::ostream & os, FileName const & filename)
 134 {
 135         return os << filename.absFilename();
 136 }
 137
 138
 139 /////////////////////////////////////////////////////////////////////
 140 //
 141 // DocFileName
 142 //
 143 /////////////////////////////////////////////////////////////////////
 144
 145
 146 DocFileName::DocFileName()
 147         : save_abs_path_(true)
 148 {}
 149
 150
 151 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
 152         : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
 153 {}
 154
 155
 156 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
 157         : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
 158 {}
 159
 160
 161 void DocFileName::set(string const & name, string const & buffer_path)
 162 {
 163         save_abs_path_ = absolutePath(name);
 164         name_ = save_abs_path_ ? name : makeAbsPath(name, buffer_path).absFilename();
 165         zipped_valid_ = false;
 166 }
 167
 168
 169 void DocFileName::erase()
 170 {
 171         name_.erase();
 172         zipped_valid_ = false;
 173 }
 174
 175
 176 string const DocFileName::relFilename(string const & path) const
 177 {
 178         // FIXME UNICODE
 179         return to_utf8(makeRelPath(from_utf8(name_), from_utf8(path)));
 180 }
 181
 182
 183 string const DocFileName::outputFilename(string const & path) const
 184 {
 185         // FIXME UNICODE
 186         return save_abs_path_ ? name_ : to_utf8(makeRelPath(from_utf8(name_), from_utf8(path)));
 187 }
 188
 189
 190 string const DocFileName::mangledFilename(std::string const & dir) const
 191 {
 192         // We need to make sure that every DocFileName instance for a given
 193         // filename returns the same mangled name.
 194         typedef map<string, string> MangledMap;
 195         static MangledMap mangledNames;
 196         MangledMap::const_iterator const it = mangledNames.find(name_);
 197         if (it != mangledNames.end())
 198                 return (*it).second;
 199
 200         // Now the real work
 201         string mname = os::internal_path(name_);
 202         // Remove the extension.
 203         mname = changeExtension(name_, string());
 204         // The mangled name must be a valid LaTeX name.
 205         // The list of characters to keep is probably over-restrictive,
 206         // but it is not really a problem.
 207         // Apart from non-ASCII characters, at least the following characters
 208         // are forbidden: '/', '.', ' ', and ':'.
 209         // On windows it is not possible to create files with '<', '>' or '?'
 210         // in the name.
 211         static string const keep = "abcdefghijklmnopqrstuvwxyz"
 212                                    "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 213                                    "+,-0123456789;=";
 214         string::size_type pos = 0;
 215         while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
 216                 mname[pos++] = '_';
 217         // Add the extension back on
 218         mname = changeExtension(mname, getExtension(name_));
 219
 220         // Prepend a counter to the filename. This is necessary to make
 221         // the mangled name unique.
 222         static int counter = 0;
 223         std::ostringstream s;
 224         s << counter++ << mname;
 225         mname = s.str();
 226
 227         // MiKTeX's YAP (version 2.4.1803) crashes if the file name
 228         // is longer than about 160 characters. MiKTeX's pdflatex
 229         // is even pickier. A maximum length of 100 has been proven to work.
 230         // If dir.size() > max length, all bets are off for YAP. We truncate
 231         // the filename nevertheless, keeping a minimum of 10 chars.
 232
 233         string::size_type max_length = std::max(100 - ((int)dir.size() + 1), 10);
 234
 235         // If the mangled file name is too long, hack it to fit.
 236         // We know we're guaranteed to have a unique file name because
 237         // of the counter.
 238         if (mname.size() > max_length) {
 239                 int const half = (int(max_length) / 2) - 2;
 240                 if (half > 0) {
 241                         mname = mname.substr(0, half) + "___" +
 242                                 mname.substr(mname.size() - half);
 243                 }
 244         }
 245
 246         mangledNames[name_] = mname;
 247         return mname;
 248 }
 249
 250
 251 bool DocFileName::isZipped() const
 252 {
 253         if (!zipped_valid_) {
 254                 zipped_ = zippedFile(*this);
 255                 zipped_valid_ = true;
 256         }
 257         return zipped_;
 258 }
 259
 260
 261 string const DocFileName::unzippedFilename() const
 262 {
 263         return unzippedFileName(name_);
 264 }
 265
 266
 267 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
 268 {
 269         return lhs.absFilename() == rhs.absFilename() &&
 270                 lhs.saveAbsPath() == rhs.saveAbsPath();
 271 }
 272
 273
 274 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
 275 {
 276         return !(lhs == rhs);
 277 }
 278
 279 } // namespace support
 280 } // namespace lyx