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.
  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         FileName filename;
 147         string from;
 148         bool const success = pimpl_->tryDisplayFormat(filename, from);
 149         if (!success)
 150                 pimpl_->reset();
 151         return success;
 152 }
 153
 154
 155 void CacheItem::startLoading() const
 156 {
 157         pimpl_->startLoading();
 158 }
 159
 160
 161 void CacheItem::startMonitoring() const
 162 {
 163         if (!pimpl_->monitor_.monitoring())
 164                 pimpl_->monitor_.start();
 165 }
 166
 167
 168 bool CacheItem::monitoring() const
 169 {
 170         return pimpl_->monitor_.monitoring();
 171 }
 172
 173
 174 unsigned long CacheItem::checksum() const
 175 {
 176         return pimpl_->monitor_.checksum();
 177 }
 178
 179
 180 Image const * CacheItem::image() const
 181 {
 182         return pimpl_->image_.get();
 183 }
 184
 185
 186 ImageStatus CacheItem::status() const
 187 {
 188         return pimpl_->status_;
 189 }
 190
 191
 192 boost::signals::connection CacheItem::connect(slot_type const & slot) const
 193 {
 194         return pimpl_->statusChanged.connect(slot);
 195 }
 196
 197
 198 //------------------------------
 199 // Implementation details follow
 200 //------------------------------
 201
 202
 203 CacheItem::Impl::Impl(FileName const & file)
 204         : filename_(file),
 205           monitor_(file, 2000),
 206           zipped_(false),
 207           remove_loaded_file_(false),
 208           status_(WaitingToLoad)
 209 {
 210         monitor_.connect(boost::bind(&Impl::startLoading, this));
 211 }
 212
 213
 214 void CacheItem::Impl::startLoading()
 215 {
 216         if (status_ != WaitingToLoad)
 217                 reset();
 218
 219         convertToDisplayFormat();
 220 }
 221
 222
 223 void CacheItem::Impl::reset()
 224 {
 225         zipped_ = false;
 226         if (!unzipped_filename_.empty())
 227                 unzipped_filename_.removeFile();
 228         unzipped_filename_.erase();
 229
 230         if (remove_loaded_file_ && !file_to_load_.empty())
 231                 file_to_load_.removeFile();
 232         remove_loaded_file_ = false;
 233         file_to_load_.erase();
 234         to_.erase();
 235
 236         if (image_.get())
 237                 image_.reset();
 238
 239         status_ = WaitingToLoad;
 240
 241         if (cc_.connected())
 242                 cc_.disconnect();
 243
 244         if (converter_.get())
 245                 converter_.reset();
 246 }
 247
 248
 249 void CacheItem::Impl::setStatus(ImageStatus new_status)
 250 {
 251         if (status_ == new_status)
 252                 return;
 253
 254         status_ = new_status;
 255         statusChanged();
 256 }
 257
 258
 259 void CacheItem::Impl::imageConverted(bool success)
 260 {
 261         string const text = success ? "succeeded" : "failed";
 262         LYXERR(Debug::GRAPHICS, "Image conversion " << text << '.');
 263
 264         file_to_load_ = converter_.get() ?
 265                 FileName(converter_->convertedFile()) : FileName();
 266         converter_.reset();
 267         cc_.disconnect();
 268
 269         success = !file_to_load_.empty() && file_to_load_.isReadableFile();
 270
 271         if (!success) {
 272                 LYXERR(Debug::GRAPHICS, "Unable to find converted file!");
 273                 setStatus(ErrorConverting);
 274
 275                 if (zipped_)
 276                         unzipped_filename_.removeFile();
 277
 278                 return;
 279         }
 280
 281         // Add the converted file to the file cache
 282         ConverterCache::get().add(filename_, to_, file_to_load_);
 283
 284         setStatus(loadImage() ? Loaded : ErrorLoading);
 285 }
 286
 287
 288 // This function gets called from the callback after the image has been
 289 // converted successfully.
 290 bool CacheItem::Impl::loadImage()
 291 {
 292         LYXERR(Debug::GRAPHICS, "Loading image.");
 293
 294         image_.reset(newImage());
 295
 296         bool success = image_->load(file_to_load_);
 297         string const text = success ? "succeeded" : "failed";
 298         LYXERR(Debug::GRAPHICS, "Image loading " << text << '.');
 299
 300         // Clean up after loading.
 301         if (zipped_)
 302                 unzipped_filename_.removeFile();
 303
 304         if (remove_loaded_file_ && unzipped_filename_ != file_to_load_)
 305                 file_to_load_.removeFile();
 306
 307         return success;
 308 }
 309
 310
 311 static string const findTargetFormat(string const & from)
 312 {
 313         typedef vector<string> FormatList;
 314         FormatList const & formats = Cache::get().loadableFormats();
 315
 316          // There must be a format to load from.
 317         LASSERT(!formats.empty(), /**/);
 318
 319         // Use the standard converter if we don't know the format to load
 320         // from.
 321         if (from.empty())
 322                 return string("ppm");
 323
 324         // First ascertain if we can load directly with no conversion
 325         FormatList::const_iterator it  = formats.begin();
 326         FormatList::const_iterator end = formats.end();
 327         for (; it != end; ++it) {
 328                 if (from == *it)
 329                         return *it;
 330         }
 331
 332         // So, we have to convert to a loadable format. Can we?
 333         it = formats.begin();
 334         for (; it != end; ++it) {
 335                 if (lyx::graphics::Converter::isReachable(from, *it))
 336                         return *it;
 337                 else
 338                         LYXERR(Debug::GRAPHICS, "Unable to convert from " << from
 339                                 << " to " << *it);
 340         }
 341
 342         // Failed! so we have to try to convert it to PPM format
 343         // with the standard converter
 344         return string("ppm");
 345 }
 346
 347
 348 bool CacheItem::Impl::tryDisplayFormat(FileName & filename, string & from)
 349 {
 350         // First, check that the file exists!
 351         if (!filename_.isReadableFile()) {
 352                 if (status_ != ErrorNoFile) {
 353                         status_ = ErrorNoFile;
 354                         LYXERR(Debug::GRAPHICS, "\tThe file is not readable");
 355                 }
 356                 return true;
 357         }
 358
 359         zipped_ = filename_.isZippedFile();
 360         if (zipped_) {
 361                 unzipped_filename_ = FileName::tempName(
 362                         filename_.toFilesystemEncoding());
 363                 if (unzipped_filename_.empty()) {
 364                         status_ = ErrorConverting;
 365                         LYXERR(Debug::GRAPHICS, "\tCould not create temporary file.");
 366                         return true;
 367                 }
 368                 filename = unzipFile(filename_, unzipped_filename_.toFilesystemEncoding());
 369         } else {
 370                 filename = filename_;
 371         }
 372
 373         docstring const displayed_filename = makeDisplayPath(filename_.absFilename());
 374         LYXERR(Debug::GRAPHICS, "[CacheItem::Impl::convertToDisplayFormat]\n"
 375                 << "\tAttempting to convert image file: " << filename
 376                 << "\n\twith displayed filename: " << to_utf8(displayed_filename));
 377
 378         from = formats.getFormatFromFile(filename);
 379         if (from.empty()) {
 380                 status_ = ErrorConverting;
 381                 LYXERR(Debug::GRAPHICS, "\tCould not determine file format.");
 382         }
 383         LYXERR(Debug::GRAPHICS, "\n\tThe file contains " << from << " format data.");
 384         to_ = findTargetFormat(from);
 385
 386         if (from == to_) {
 387                 // No conversion needed!
 388                 LYXERR(Debug::GRAPHICS, "\tNo conversion needed (from == to)!");
 389                 file_to_load_ = filename;
 390                 status_ = loadImage() ? Loaded : ErrorLoading;
 391                 return true;
 392         }
 393
 394         if (ConverterCache::get().inCache(filename, to_)) {
 395                 LYXERR(Debug::GRAPHICS, "\tNo conversion needed (file in file cache)!");
 396                 file_to_load_ = ConverterCache::get().cacheName(filename, to_);
 397                 status_ = loadImage() ? Loaded : ErrorLoading;
 398                 return true;
 399         }
 400         return false;
 401 }
 402
 403
 404 void CacheItem::Impl::convertToDisplayFormat()
 405 {
 406         LYXERR(Debug::GRAPHICS, "\tConverting it to " << to_ << " format.");
 407
 408         // Make a local copy in case we unzip it
 409         FileName filename;
 410         string from;
 411         if (tryDisplayFormat(filename, from)) {
 412                 // The image status has changed, tell it to the outside world.
 413                 statusChanged();
 414                 return;
 415         }
 416
 417         // We will need a conversion, tell it to the outside world.
 418         setStatus(Converting);
 419
 420         // Add some stuff to create a uniquely named temporary file.
 421         // This file is deleted in loadImage after it is loaded into memory.
 422         FileName const to_file_base = FileName::tempName("CacheItem");
 423         remove_loaded_file_ = true;
 424
 425         // Connect a signal to this->imageConverted and pass this signal to
 426         // the graphics converter so that we can load the modified file
 427         // on completion of the conversion process.
 428         converter_.reset(new Converter(filename, to_file_base.absFilename(), from, to_));
 429         converter_->connect(boost::bind(&Impl::imageConverted, this, _1));
 430         converter_->startConversion();
 431 }
 432
 433 } // namespace graphics
 434 } // namespace lyx