src/graphics/GraphicsCacheItem.cpp

   1 /**
   2  * \file GraphicsCacheItem.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 Herbert Voß
   8  * \author Angus Leeming
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #include <config.h>
  14
  15 #include "GraphicsCacheItem.h"
  16
  17 #include "GraphicsCache.h"
  18 #include "GraphicsConverter.h"
  19 #include "GraphicsImage.h"
  20
  21 #include "ConverterCache.h"
  22 #include "Format.h"
  23
  24 #include "support/debug.h"
  25 #include "support/FileName.h"
  26 #include "support/filetools.h"
  27 #include "support/FileMonitor.h"
  28
  29 #include <boost/bind.hpp>
  30
  31 using namespace std;
  32 using namespace lyx::support;
  33
  34 namespace lyx {
  35
  36 namespace graphics {
  37
  38 class CacheItem::Impl : public boost::signals::trackable {
  39 public:
  40
  41         ///
  42         Impl(FileName const & file);
  43
  44         /**
  45          *  If no file conversion is needed, then tryDisplayFormat() calls
  46          *  loadImage() directly.
  47          * \return true if a conversion is necessary and no error occurred.
  48          */
  49         bool tryDisplayFormat(FileName & filename, string & from);
  50
  51         /** Start the image conversion process, checking first that it is
  52          *  necessary. If it is necessary, then a conversion task is started.
  53          *  CacheItem asumes that the conversion is asynchronous and so
  54          *  passes a Signal to the converting routine. When the conversion
  55          *  is finished, this Signal is emitted, returning the converted
  56          *  file to this->imageConverted.
  57          *
  58          *  convertToDisplayFormat() will set the loading status flag as
  59          *  approriate through calls to setStatus().
  60          */
  61         void convertToDisplayFormat();
  62
  63         /** Load the image into memory. This is called either from
  64          *  convertToDisplayFormat() direct or from imageConverted().
  65          */
  66         bool loadImage();
  67
  68         /** Get a notification when the image conversion is done.
  69          *  Connected to a signal on_finish_ which is passed to
  70          *  Converter::convert.
  71          */
  72         void imageConverted(bool);
  73
  74         /** Sets the status of the loading process. Also notifies
  75          *  listeners that the status has changed.
  76          */
  77         void setStatus(ImageStatus new_status);
  78
  79         /** Can be invoked directly by the user, but is also connected to the
  80          *  FileMonitor and so is invoked when the file is changed
  81          *  (if monitoring is taking place).
  82          */
  83         void startLoading();
  84
  85         /** If we are asked to load the file for a second or further time,
  86          *  (because the file has changed), then we'll have to first reset
  87          *  many of the variables below.
  88          */
  89         void reset();
  90
  91         /// The filename we refer too.
  92         FileName const filename_;
  93         ///
  94         FileMonitor const monitor_;
  95
  96         /// Is the file compressed?
  97         bool zipped_;
  98         /// If so, store the uncompressed file in this temporary file.
  99         FileName unzipped_filename_;
 100         /// The target format
 101         string to_;
 102         /// What file are we trying to load?
 103         FileName file_to_load_;
 104         /** Should we delete the file after loading? True if the file is
 105          *  the result of a conversion process.
 106          */
 107         bool remove_loaded_file_;
 108
 109         /// The image and its loading status.
 110         boost::shared_ptr<Image> image_;
 111         ///
 112         ImageStatus status_;
 113
 114         /// This signal is emitted when the image loading status changes.
 115         boost::signal<void()> statusChanged;
 116
 117         /// The connection of the signal ConvProcess::finishedConversion,
 118         boost::signals::connection cc_;
 119
 120         ///
 121         boost::scoped_ptr<Converter> converter_;
 122 };
 123
 124
 125 CacheItem::CacheItem(FileName const & file)
 126         : pimpl_(new Impl(file))
 127 {}
 128
 129
 130 CacheItem::~CacheItem()
 131 {
 132         delete pimpl_;
 133 }
 134
 135
 136 FileName const & CacheItem::filename() const
 137 {
 138         return pimpl_->filename_;
 139 }
 140
 141
 142 bool CacheItem::tryDisplayFormat() const
 143 {
 144         if (pimpl_->status_ != WaitingToLoad)
 145                 pimpl_->reset();
 146         bool const conversion_needed = pimpl_->tryDisplayFormat(FileName(), string());
 147         bool const success = status() == Loaded && !conversion_needed;
 148         if (!success)
 149                 pimpl_->reset();
 150         return success;
 151 }
 152
 153
 154 void CacheItem::startLoading() const
 155 {
 156         pimpl_->startLoading();
 157 }
 158
 159
 160 void CacheItem::startMonitoring() const
 161 {
 162         if (!pimpl_->monitor_.monitoring())
 163                 pimpl_->monitor_.start();
 164 }
 165
 166
 167 bool CacheItem::monitoring() const
 168 {
 169         return pimpl_->monitor_.monitoring();
 170 }
 171
 172
 173 unsigned long CacheItem::checksum() const
 174 {
 175         return pimpl_->monitor_.checksum();
 176 }
 177
 178
 179 Image const * CacheItem::image() const
 180 {
 181         return pimpl_->image_.get();
 182 }
 183
 184
 185 ImageStatus CacheItem::status() const
 186 {
 187         return pimpl_->status_;
 188 }
 189
 190
 191 boost::signals::connection CacheItem::connect(slot_type const & slot) const
 192 {
 193         return pimpl_->statusChanged.connect(slot);
 194 }
 195
 196
 197 //------------------------------
 198 // Implementation details follow
 199 //------------------------------
 200
 201
 202 CacheItem::Impl::Impl(FileName const & file)
 203         : filename_(file),
 204           monitor_(file, 2000),
 205           zipped_(false),
 206           remove_loaded_file_(false),
 207           status_(WaitingToLoad)
 208 {
 209         monitor_.connect(boost::bind(&Impl::startLoading, this));
 210 }
 211
 212
 213 void CacheItem::Impl::startLoading()
 214 {
 215         if (status_ != WaitingToLoad)
 216                 reset();
 217
 218         convertToDisplayFormat();
 219 }
 220
 221
 222 void CacheItem::Impl::reset()
 223 {
 224         zipped_ = false;
 225         if (!unzipped_filename_.empty())
 226                 unzipped_filename_.removeFile();
 227         unzipped_filename_.erase();
 228
 229         if (remove_loaded_file_ && !file_to_load_.empty())
 230                 file_to_load_.removeFile();
 231         remove_loaded_file_ = false;
 232         file_to_load_.erase();
 233         to_.erase();
 234
 235         if (image_.get())
 236                 image_.reset();
 237
 238         status_ = WaitingToLoad;
 239
 240         if (cc_.connected())
 241                 cc_.disconnect();
 242
 243         if (converter_.get())
 244                 converter_.reset();
 245 }
 246
 247
 248 void CacheItem::Impl::setStatus(ImageStatus new_status)
 249 {
 250         if (status_ == new_status)
 251                 return;
 252
 253         status_ = new_status;
 254         statusChanged();
 255 }
 256
 257
 258 void CacheItem::Impl::imageConverted(bool success)
 259 {
 260         string const text = success ? "succeeded" : "failed";
 261         LYXERR(Debug::GRAPHICS, "Image conversion " << text << '.');
 262
 263         file_to_load_ = converter_.get() ?
 264                 FileName(converter_->convertedFile()) : FileName();
 265         converter_.reset();
 266         cc_.disconnect();
 267
 268         success = !file_to_load_.empty() && file_to_load_.isReadableFile();
 269
 270         if (!success) {
 271                 LYXERR(Debug::GRAPHICS, "Unable to find converted file!");
 272                 setStatus(ErrorConverting);
 273
 274                 if (zipped_)
 275                         unzipped_filename_.removeFile();
 276
 277                 return;
 278         }
 279
 280         // Add the converted file to the file cache
 281         ConverterCache::get().add(filename_, to_, file_to_load_);
 282
 283         setStatus(loadImage() ? Loaded : ErrorLoading);
 284 }
 285
 286
 287 // This function gets called from the callback after the image has been
 288 // converted successfully.
 289 bool CacheItem::Impl::loadImage()
 290 {
 291         LYXERR(Debug::GRAPHICS, "Loading image.");
 292
 293         image_.reset(newImage());
 294
 295         bool success = image_->load(file_to_load_);
 296         string const text = success ? "succeeded" : "failed";
 297         LYXERR(Debug::GRAPHICS, "Image loading " << text << '.');
 298
 299         // Clean up after loading.
 300         if (zipped_)
 301                 unzipped_filename_.removeFile();
 302
 303         if (remove_loaded_file_ && unzipped_filename_ != file_to_load_)
 304                 file_to_load_.removeFile();
 305
 306         return success;
 307 }
 308
 309
 310 static string const findTargetFormat(string const & from)
 311 {
 312         typedef vector<string> FormatList;
 313         FormatList const & formats = Cache::get().loadableFormats();
 314
 315          // There must be a format to load from.
 316         LASSERT(!formats.empty(), /**/);
 317
 318         // Use the standard converter if we don't know the format to load
 319         // from.
 320         if (from.empty())
 321                 return string("ppm");
 322
 323         // First ascertain if we can load directly with no conversion
 324         FormatList::const_iterator it  = formats.begin();
 325         FormatList::const_iterator end = formats.end();
 326         for (; it != end; ++it) {
 327                 if (from == *it)
 328                         return *it;
 329         }
 330
 331         // So, we have to convert to a loadable format. Can we?
 332         it = formats.begin();
 333         for (; it != end; ++it) {
 334                 if (lyx::graphics::Converter::isReachable(from, *it))
 335                         return *it;
 336                 else
 337                         LYXERR(Debug::GRAPHICS, "Unable to convert from " << from
 338                                 << " to " << *it);
 339         }
 340
 341         // Failed! so we have to try to convert it to PPM format
 342         // with the standard converter
 343         return string("ppm");
 344 }
 345
 346
 347 bool CacheItem::Impl::tryDisplayFormat(FileName & filename, string & from)
 348 {
 349         // First, check that the file exists!
 350         if (!filename_.isReadableFile()) {
 351                 if (status_ != ErrorNoFile) {
 352                         status_ = ErrorNoFile;
 353                         LYXERR(Debug::GRAPHICS, "\tThe file is not readable");
 354                 }
 355                 return false;
 356         }
 357
 358         zipped_ = filename_.isZippedFile();
 359         if (zipped_) {
 360                 unzipped_filename_ = FileName::tempName(
 361                         filename_.toFilesystemEncoding());
 362                 if (unzipped_filename_.empty()) {
 363                         status_ = ErrorConverting;
 364                         LYXERR(Debug::GRAPHICS, "\tCould not create temporary file.");
 365                         return false;
 366                 }
 367                 filename = unzipFile(filename_, unzipped_filename_.toFilesystemEncoding());
 368         } else {
 369                 filename = filename_;
 370         }
 371
 372         docstring const displayed_filename = makeDisplayPath(filename_.absFilename());
 373         LYXERR(Debug::GRAPHICS, "[CacheItem::Impl::convertToDisplayFormat]\n"
 374                 << "\tAttempting to convert image file: " << filename
 375                 << "\n\twith displayed filename: " << to_utf8(displayed_filename));
 376
 377         from = formats.getFormatFromFile(filename);
 378         if (from.empty()) {
 379                 status_ = ErrorConverting;
 380                 LYXERR(Debug::GRAPHICS, "\tCould not determine file format.");
 381         }
 382         LYXERR(Debug::GRAPHICS, "\n\tThe file contains " << from << " format data.");
 383         to_ = findTargetFormat(from);
 384
 385         if (from == to_) {
 386                 // No conversion needed!
 387                 LYXERR(Debug::GRAPHICS, "\tNo conversion needed (from == to)!");
 388                 file_to_load_ = filename;
 389                 status_ = loadImage() ? Loaded : ErrorLoading;
 390                 return false;
 391         }
 392
 393         if (ConverterCache::get().inCache(filename, to_)) {
 394                 LYXERR(Debug::GRAPHICS, "\tNo conversion needed (file in file cache)!");
 395                 file_to_load_ = ConverterCache::get().cacheName(filename, to_);
 396                 status_ = loadImage() ? Loaded : ErrorLoading;
 397                 return false;
 398         }
 399         return true;
 400 }
 401
 402
 403 void CacheItem::Impl::convertToDisplayFormat()
 404 {
 405         LYXERR(Debug::GRAPHICS, "\tConverting it to " << to_ << " format.");
 406
 407         // Make a local copy in case we unzip it
 408         FileName filename;
 409         string from;
 410         if (!tryDisplayFormat(filename, from)) {
 411                 // The image status has changed, tell it to the outside world.
 412                 statusChanged();
 413                 return;
 414         }
 415
 416         // We will need a conversion, tell it to the outside world.
 417         setStatus(Converting);
 418
 419         // Add some stuff to create a uniquely named temporary file.
 420         // This file is deleted in loadImage after it is loaded into memory.
 421         FileName const to_file_base = FileName::tempName("CacheItem");
 422         remove_loaded_file_ = true;
 423
 424         // Connect a signal to this->imageConverted and pass this signal to
 425         // the graphics converter so that we can load the modified file
 426         // on completion of the conversion process.
 427         converter_.reset(new Converter(filename, to_file_base.absFilename(), from, to_));
 428         converter_->connect(boost::bind(&Impl::imageConverted, this, _1));
 429         converter_->startConversion();
 430 }
 431
 432 } // namespace graphics
 433 } // namespace lyx