src/ConverterCache.cpp

   1 /**
   2  * \file ConverterCache.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Baruch Even
   7  * \author Angus Leeming
   8  * \author Georg Baum
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #include <config.h>
  14
  15 #include "ConverterCache.h"
  16
  17 #include "Format.h"
  18 #include "Lexer.h"
  19 #include "LyXRC.h"
  20 #include "Mover.h"
  21
  22 #include "support/convert.h"
  23 #include "support/debug.h"
  24 #include "support/filetools.h"
  25 #include "support/lyxtime.h"
  26 #include "support/Package.h"
  27
  28 #include "support/lassert.h"
  29 #include <boost/crc.hpp>
  30
  31 #include <algorithm>
  32 #include <fstream>
  33 #include <iomanip>
  34 #include <map>
  35 #include <sstream>
  36
  37 using namespace std;
  38 using namespace lyx::support;
  39
  40 namespace lyx {
  41
  42 namespace {
  43
  44 unsigned long do_crc(string const & s)
  45 {
  46         boost::crc_32_type crc;
  47         crc = for_each(s.begin(), s.end(), crc);
  48         return crc.checksum();
  49 }
  50
  51
  52 static FileName cache_dir;
  53
  54
  55 class CacheItem {
  56 public:
  57         CacheItem() {}
  58         CacheItem(FileName const & orig_from, string const & to_format,
  59                   time_t t, unsigned long c)
  60                 : timestamp(t), checksum(c)
  61         {
  62                 ostringstream os;
  63                 os << setw(10) << setfill('0') << do_crc(orig_from.absFilename())
  64                    << '-' << to_format;
  65                 cache_name = FileName(addName(cache_dir.absFilename(), os.str()));
  66                 LYXERR(Debug::FILES, "Add file cache item " << orig_from
  67                                      << ' ' << to_format << ' ' << cache_name
  68                                      << ' ' << long(timestamp) << ' ' << checksum << '.');
  69         }
  70         ~CacheItem() {}
  71         FileName cache_name;
  72         time_t timestamp;
  73         unsigned long checksum;
  74 };
  75
  76 }
  77
  78
  79 /** The cache contains one item per orig file and target format, so use a
  80  *  nested map to find the cache item quickly by filename and format.
  81  */
  82 typedef map<string, CacheItem> FormatCacheType;
  83 class FormatCache {
  84 public:
  85         /// Format of the source file
  86         string from_format;
  87         /// Cache target format -> item to quickly find the item by format
  88         FormatCacheType cache;
  89 };
  90 typedef map<FileName, FormatCache> CacheType;
  91
  92
  93 class ConverterCache::Impl {
  94 public:
  95         ///
  96         void readIndex();
  97         ///
  98         void writeIndex();
  99         ///
 100         CacheItem * find(FileName const & from, string const & format);
 101         CacheType cache;
 102 };
 103
 104
 105 void ConverterCache::Impl::readIndex()
 106 {
 107         time_t const now = current_time();
 108         FileName const index(addName(cache_dir.absFilename(), "index"));
 109         ifstream is(index.toFilesystemEncoding().c_str());
 110         Lexer lex;
 111         lex.setStream(is);
 112         while (lex.isOK()) {
 113                 if (!lex.next(true))
 114                         break;
 115                 string const orig_from = lex.getString();
 116                 if (!lex.next())
 117                         break;
 118                 string const to_format = lex.getString();
 119                 if (!lex.next())
 120                         break;
 121                 time_t const timestamp =
 122                         convert<unsigned long>(lex.getString());
 123                 if (!lex.next())
 124                         break;
 125                 unsigned long const checksum =
 126                         convert<unsigned long>(lex.getString());
 127                 FileName const orig_from_name(orig_from);
 128                 CacheItem item(orig_from_name, to_format, timestamp, checksum);
 129
 130                 // Don't cache files that do not exist anymore
 131                 if (!orig_from_name.exists()) {
 132                         LYXERR(Debug::FILES, "Not caching file `"
 133                                 << orig_from << "' (does not exist anymore).");
 134                         item.cache_name.removeFile();
 135                         continue;
 136                 }
 137
 138                 // Don't add items that are not in the cache anymore
 139                 // This can happen if two instances of LyX are running
 140                 // at the same time and update the index file independantly.
 141                 if (!item.cache_name.exists()) {
 142                         LYXERR(Debug::FILES, "Not caching file `" << orig_from
 143                                 << "' (cached copy does not exist anymore).");
 144                         continue;
 145                 }
 146
 147                 // Delete the cached file if it is too old
 148                 if (difftime(now, item.cache_name.lastModified())
 149                                 > lyxrc.converter_cache_maxage) {
 150                         LYXERR(Debug::FILES, "Not caching file `"
 151                                 << orig_from << "' (too old).");
 152                         item.cache_name.removeFile();
 153                         continue;
 154                 }
 155
 156                 FormatCache & format_cache = cache[orig_from_name];
 157                 if (format_cache.from_format.empty())
 158                         format_cache.from_format =
 159                                 formats.getFormatFromFile(orig_from_name);
 160                 format_cache.cache[to_format] = item;
 161         }
 162         is.close();
 163 }
 164
 165
 166 void ConverterCache::Impl::writeIndex()
 167 {
 168         FileName const index(addName(cache_dir.absFilename(), "index"));
 169         ofstream os(index.toFilesystemEncoding().c_str());
 170         os.close();
 171         if (!index.changePermission(0600))
 172                 return;
 173         os.open(index.toFilesystemEncoding().c_str());
 174         CacheType::iterator it1 = cache.begin();
 175         CacheType::iterator const end1 = cache.end();
 176         for (; it1 != end1; ++it1) {
 177                 FormatCacheType const & format_cache = it1->second.cache;
 178                 FormatCacheType::const_iterator it2 = format_cache.begin();
 179                 FormatCacheType::const_iterator const end2 = format_cache.end();
 180                 for (; it2 != end2; ++it2)
 181                         os << Lexer::quoteString(it1->first.absFilename())
 182                            << ' ' << it2->first << ' '
 183                            << it2->second.timestamp << ' '
 184                            << it2->second.checksum << '\n';
 185         }
 186         os.close();
 187 }
 188
 189
 190 CacheItem * ConverterCache::Impl::find(FileName const & from,
 191                 string const & format)
 192 {
 193         if (!lyxrc.use_converter_cache)
 194                 return 0;
 195         CacheType::iterator const it1 = cache.find(from);
 196         if (it1 == cache.end())
 197                 return 0;
 198         FormatCacheType & format_cache = it1->second.cache;
 199         FormatCacheType::iterator const it2 = format_cache.find(format);
 200         if (it2 == format_cache.end())
 201                 return 0;
 202         return &(it2->second);
 203 }
 204
 205
 206 /////////////////////////////////////////////////////////////////////
 207 //
 208 // ConverterCache
 209 //
 210 /////////////////////////////////////////////////////////////////////
 211
 212 ConverterCache::ConverterCache()
 213         : pimpl_(new Impl)
 214 {}
 215
 216
 217 ConverterCache::~ConverterCache()
 218 {
 219         delete pimpl_;
 220 }
 221
 222
 223 ConverterCache & ConverterCache::get()
 224 {
 225         // Now return the cache
 226         static ConverterCache singleton;
 227         return singleton;
 228 }
 229
 230
 231 void ConverterCache::init()
 232 {
 233         if (!lyxrc.use_converter_cache)
 234                 return;
 235         // We do this here and not in the constructor because package() gets
 236         // initialized after all static variables.
 237         cache_dir = FileName(addName(package().user_support().absFilename(), "cache"));
 238         if (!cache_dir.exists())
 239                 if (!cache_dir.createDirectory(0700)) {
 240                         lyxerr << "Could not create cache directory `"
 241                                << cache_dir << "'." << endl;
 242                         exit(EXIT_FAILURE);
 243                 }
 244         get().pimpl_->readIndex();
 245 }
 246
 247
 248 void ConverterCache::writeIndex() const
 249 {
 250         pimpl_->writeIndex();
 251 }
 252
 253
 254 void ConverterCache::add(FileName const & orig_from, string const & to_format,
 255                 FileName const & converted_file) const
 256 {
 257         if (!lyxrc.use_converter_cache || orig_from.empty() ||
 258             converted_file.empty())
 259                 return;
 260         LYXERR(Debug::FILES, ' ' << orig_from
 261                              << ' ' << to_format << ' ' << converted_file);
 262
 263         // FIXME: Should not hardcode this (see bug 3819 for details)
 264         if (to_format == "pstex") {
 265                 FileName const converted_eps(changeExtension(converted_file.absFilename(), "eps"));
 266                 add(orig_from, "eps", converted_eps);
 267         } else if (to_format == "pdftex") {
 268                 FileName const converted_pdf(changeExtension(converted_file.absFilename(), "pdf"));
 269                 add(orig_from, "pdf", converted_pdf);
 270         }
 271
 272         // Is the file in the cache already?
 273         CacheItem * item = pimpl_->find(orig_from, to_format);
 274
 275         time_t const timestamp = orig_from.lastModified();
 276         Mover const & mover = getMover(to_format);
 277         if (item) {
 278                 LYXERR(Debug::FILES, "ConverterCache::add(" << orig_from << "):\n"
 279                                         "The file is already in the cache.");
 280                 // First test for timestamp
 281                 if (timestamp == item->timestamp) {
 282                         LYXERR(Debug::FILES, "Same timestamp.");
 283                         return;
 284                 }
 285                 // Maybe the contents is still the same?
 286                 item->timestamp = timestamp;
 287                 unsigned long const checksum = orig_from.checksum();
 288                 if (checksum == item->checksum) {
 289                         LYXERR(Debug::FILES, "Same checksum.");
 290                         return;
 291                 }
 292                 item->checksum = checksum;
 293                 if (!mover.copy(converted_file, item->cache_name,
 294                               onlyFilename(item->cache_name.absFilename()))) {
 295                         LYXERR(Debug::FILES, "Could not copy file " << orig_from << " to "
 296                                 << item->cache_name);
 297                 } else if (!item->cache_name.changePermission(0600)) {
 298                         LYXERR(Debug::FILES, "Could not change file mode"
 299                                 << item->cache_name);
 300                 }
 301         } else {
 302                 CacheItem new_item(orig_from, to_format, timestamp,
 303                                 orig_from.checksum());
 304                 if (mover.copy(converted_file, new_item.cache_name,
 305                               onlyFilename(new_item.cache_name.absFilename()))) {
 306                         if (!new_item.cache_name.changePermission(0600)) {
 307                                 LYXERR(Debug::FILES, "Could not change file mode"
 308                                         << new_item.cache_name);
 309                         }
 310                         FormatCache & format_cache = pimpl_->cache[orig_from];
 311                         if (format_cache.from_format.empty())
 312                                 format_cache.from_format =
 313                                         formats.getFormatFromFile(orig_from);
 314                         format_cache.cache[to_format] = new_item;
 315                 } else
 316                         LYXERR(Debug::FILES, "ConverterCache::add(" << orig_from << "):\n"
 317                                                 "Could not copy file.");
 318         }
 319 }
 320
 321
 322 void ConverterCache::remove(FileName const & orig_from,
 323                 string const & to_format) const
 324 {
 325         if (!lyxrc.use_converter_cache || orig_from.empty())
 326                 return;
 327         LYXERR(Debug::FILES, orig_from << ' ' << to_format);
 328
 329         CacheType::iterator const it1 = pimpl_->cache.find(orig_from);
 330         if (it1 == pimpl_->cache.end())
 331                 return;
 332         FormatCacheType & format_cache = it1->second.cache;
 333         FormatCacheType::iterator const it2 = format_cache.find(to_format);
 334         if (it2 == format_cache.end())
 335                 return;
 336
 337         format_cache.erase(it2);
 338         if (format_cache.empty())
 339                 pimpl_->cache.erase(it1);
 340 }
 341
 342
 343 void ConverterCache::remove_all(string const & from_format,
 344                 string const & to_format) const
 345 {
 346         if (!lyxrc.use_converter_cache)
 347                 return;
 348         CacheType::iterator it1 = pimpl_->cache.begin();
 349         while (it1 != pimpl_->cache.end()) {
 350                 if (it1->second.from_format != from_format) {
 351                         ++it1;
 352                         continue;
 353                 }
 354                 FormatCacheType & format_cache = it1->second.cache;
 355                 FormatCacheType::iterator it2 = format_cache.begin();
 356                 while (it2 != format_cache.end()) {
 357                         if (it2->first == to_format) {
 358                                 LYXERR(Debug::FILES, "Removing file cache item "
 359                                         << it1->first << ' ' << to_format);
 360                                 it2->second.cache_name.removeFile();
 361                                 format_cache.erase(it2);
 362                                 // Have to start over again since items in a
 363                                 // map are not ordered
 364                                 it2 = format_cache.begin();
 365                         } else {
 366                                 ++it2;
 367                         }
 368                 }
 369                 if (format_cache.empty()) {
 370                         pimpl_->cache.erase(it1);
 371                         // Have to start over again since items in a map are
 372                         // not ordered
 373                         it1 = pimpl_->cache.begin();
 374                 } else {
 375                         ++it1;
 376                 }
 377         }
 378         pimpl_->writeIndex();
 379 }
 380
 381
 382 bool ConverterCache::inCache(FileName const & orig_from,
 383                 string const & to_format) const
 384 {
 385         if (!lyxrc.use_converter_cache || orig_from.empty())
 386                 return false;
 387         LYXERR(Debug::FILES, orig_from << ' ' << to_format);
 388
 389         CacheItem * const item = pimpl_->find(orig_from, to_format);
 390         if (!item) {
 391                 LYXERR(Debug::FILES, "not in cache.");
 392                 return false;
 393         }
 394         time_t const timestamp = orig_from.lastModified();
 395         if (item->timestamp == timestamp) {
 396                 LYXERR(Debug::FILES, "identical timestamp.");
 397                 return true;
 398         }
 399         if (item->checksum == orig_from.checksum()) {
 400                 item->timestamp = timestamp;
 401                 LYXERR(Debug::FILES, "identical checksum.");
 402                 return true;
 403         }
 404         LYXERR(Debug::FILES, "in cache, but too old.");
 405         return false;
 406 }
 407
 408
 409 FileName const & ConverterCache::cacheName(FileName const & orig_from,
 410                 string const & to_format) const
 411 {
 412         LYXERR(Debug::FILES, orig_from << ' ' << to_format);
 413
 414         CacheItem * const item = pimpl_->find(orig_from, to_format);
 415         LASSERT(item, /**/);
 416         return item->cache_name;
 417 }
 418
 419
 420 bool ConverterCache::copy(FileName const & orig_from, string const & to_format,
 421                 FileName const & dest) const
 422 {
 423         if (!lyxrc.use_converter_cache || orig_from.empty() || dest.empty())
 424                 return false;
 425         LYXERR(Debug::FILES, orig_from << ' ' << to_format << ' ' << dest);
 426
 427         // FIXME: Should not hardcode this (see bug 3819 for details)
 428         if (to_format == "pstex") {
 429                 FileName const dest_eps(changeExtension(dest.absFilename(), "eps"));
 430                 if (!copy(orig_from, "eps", dest_eps))
 431                         return false;
 432         } else if (to_format == "pdftex") {
 433                 FileName const dest_pdf(changeExtension(dest.absFilename(), "pdf"));
 434                 if (!copy(orig_from, "pdf", dest_pdf))
 435                         return false;
 436         }
 437
 438         CacheItem * const item = pimpl_->find(orig_from, to_format);
 439         LASSERT(item, /**/);
 440         Mover const & mover = getMover(to_format);
 441         return mover.copy(item->cache_name, dest,
 442                           onlyFilename(dest.absFilename()));
 443 }
 444
 445 } // namespace lyx