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