2 * \file GraphicsCacheItem.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * \author Angus Leeming
10 * Full author contact details are available in file CREDITS.
15 #include "GraphicsCacheItem.h"
16 #include "GraphicsConverter.h"
17 #include "GraphicsImage.h"
19 #include "ConverterCache.h"
20 #include "support/debug.h"
23 #include "support/filetools.h"
24 #include "support/FileMonitor.h"
25 #include "support/lyxlib.h"
27 #include <boost/bind.hpp>
32 using support::FileMonitor;
33 using support::FileName;
34 using support::makeDisplayPath;
35 using support::onlyFilename;
36 using support::tempName;
37 using support::unzipFile;
45 class CacheItem::Impl : public boost::signals::trackable {
49 Impl(FileName const & file);
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.
58 * If no file conversion is needed, then convertToDisplayFormat() calls
59 * loadImage() directly.
61 * convertToDisplayFormat() will set the loading status flag as
62 * approriate through calls to setStatus().
64 void convertToDisplayFormat();
66 /** Load the image into memory. This is called either from
67 * convertToDisplayFormat() direct or from imageConverted().
71 /** Get a notification when the image conversion is done.
72 * Connected to a signal on_finish_ which is passed to
75 void imageConverted(bool);
77 /** Get a notification when the image loading is done.
78 * Connected to a signal on_finish_ which is passed to
79 * lyx::graphics::Image::loadImage.
81 void imageLoaded(bool);
83 /** Sets the status of the loading process. Also notifies
84 * listeners that the status has changed.
86 void setStatus(ImageStatus new_status);
88 /** Can be invoked directly by the user, but is also connected to the
89 * FileMonitor and so is invoked when the file is changed
90 * (if monitoring is taking place).
94 /** If we are asked to load the file for a second or further time,
95 * (because the file has changed), then we'll have to first reset
96 * many of the variables below.
100 /// The filename we refer too.
101 FileName const filename_;
103 FileMonitor const monitor_;
105 /// Is the file compressed?
107 /// If so, store the uncompressed file in this temporary file.
108 FileName unzipped_filename_;
109 /// The target format
111 /// What file are we trying to load?
112 FileName file_to_load_;
113 /** Should we delete the file after loading? True if the file is
114 * the result of a conversion process.
116 bool remove_loaded_file_;
118 /// The image and its loading status.
119 boost::shared_ptr<Image> image_;
123 /// This signal is emitted when the image loading status changes.
124 boost::signal<void()> statusChanged;
126 /// The connection to the signal Image::finishedLoading
127 boost::signals::connection cl_;
129 /// The connection of the signal ConvProcess::finishedConversion,
130 boost::signals::connection cc_;
133 boost::scoped_ptr<Converter> converter_;
137 CacheItem::CacheItem(FileName const & file)
138 : pimpl_(new Impl(file))
142 CacheItem::~CacheItem()
148 FileName const & CacheItem::filename() const
150 return pimpl_->filename_;
154 void CacheItem::startLoading() const
156 pimpl_->startLoading();
160 void CacheItem::startMonitoring() const
162 if (!pimpl_->monitor_.monitoring())
163 pimpl_->monitor_.start();
167 bool CacheItem::monitoring() const
169 return pimpl_->monitor_.monitoring();
173 unsigned long CacheItem::checksum() const
175 return pimpl_->monitor_.checksum();
179 Image const * CacheItem::image() const
181 return pimpl_->image_.get();
185 ImageStatus CacheItem::status() const
187 return pimpl_->status_;
191 boost::signals::connection CacheItem::connect(slot_type const & slot) const
193 return pimpl_->statusChanged.connect(slot);
197 //------------------------------
198 // Implementation details follow
199 //------------------------------
202 CacheItem::Impl::Impl(FileName const & file)
204 monitor_(file, 2000),
206 remove_loaded_file_(false),
207 status_(WaitingToLoad)
209 monitor_.connect(boost::bind(&Impl::startLoading, this));
213 void CacheItem::Impl::startLoading()
215 if (status_ != WaitingToLoad)
218 convertToDisplayFormat();
222 void CacheItem::Impl::reset()
225 if (!unzipped_filename_.empty())
226 unzipped_filename_.removeFile();
227 unzipped_filename_.erase();
229 if (remove_loaded_file_ && !file_to_load_.empty())
230 file_to_load_.removeFile();
231 remove_loaded_file_ = false;
232 file_to_load_.erase();
238 status_ = WaitingToLoad;
246 if (converter_.get())
251 void CacheItem::Impl::setStatus(ImageStatus new_status)
253 if (status_ == new_status)
256 status_ = new_status;
261 void CacheItem::Impl::imageConverted(bool success)
263 string const text = success ? "succeeded" : "failed";
264 LYXERR(Debug::GRAPHICS, "Image conversion " << text << '.');
266 file_to_load_ = converter_.get() ?
267 FileName(converter_->convertedFile()) : FileName();
271 success = !file_to_load_.empty() && file_to_load_.isReadableFile();
274 LYXERR(Debug::GRAPHICS, "Unable to find converted file!");
275 setStatus(ErrorConverting);
278 unzipped_filename_.removeFile();
283 // Add the converted file to the file cache
284 ConverterCache::get().add(filename_, to_, file_to_load_);
290 // This function gets called from the callback after the image has been
291 // converted successfully.
292 void CacheItem::Impl::loadImage()
295 LYXERR(Debug::GRAPHICS, "Loading image.");
297 image_.reset(Image::newImage());
300 cl_ = image_->finishedLoading.connect(
301 boost::bind(&Impl::imageLoaded, this, _1));
302 image_->load(file_to_load_);
306 void CacheItem::Impl::imageLoaded(bool success)
308 string const text = success ? "succeeded" : "failed";
309 LYXERR(Debug::GRAPHICS, "Image loading " << text << '.');
311 // Clean up after loading.
313 unzipped_filename_.removeFile();
315 if (remove_loaded_file_ && unzipped_filename_ != file_to_load_)
316 file_to_load_.removeFile();
321 setStatus(ErrorLoading);
325 // Inform the outside world.
330 static string const findTargetFormat(string const & from)
332 typedef lyx::graphics::Image::FormatList FormatList;
333 FormatList const formats = lyx::graphics::Image::loadableFormats();
335 // There must be a format to load from.
336 BOOST_ASSERT(!formats.empty());
338 // Use the standard converter if we don't know the format to load
341 return string("ppm");
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) {
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))
357 LYXERR(Debug::GRAPHICS, "Unable to convert from " << from
361 // Failed! so we have to try to convert it to PPM format
362 // with the standard converter
363 return string("ppm");
367 void CacheItem::Impl::convertToDisplayFormat()
369 setStatus(Converting);
371 // First, check that the file exists!
372 if (!filename_.isReadableFile()) {
373 if (status_ != ErrorNoFile) {
374 setStatus(ErrorNoFile);
375 LYXERR(Debug::GRAPHICS, "\tThe file is not readable");
380 // Make a local copy in case we unzip it
382 zipped_ = filename_.isZippedFile();
384 unzipped_filename_ = tempName(FileName(), filename_.toFilesystemEncoding());
385 if (unzipped_filename_.empty()) {
386 setStatus(ErrorConverting);
387 LYXERR(Debug::GRAPHICS, "\tCould not create temporary file.");
390 filename = unzipFile(filename_, unzipped_filename_.toFilesystemEncoding());
392 filename = filename_;
395 docstring const displayed_filename = makeDisplayPath(filename_.absFilename());
396 LYXERR(Debug::GRAPHICS, "[CacheItem::Impl::convertToDisplayFormat]\n"
397 << "\tAttempting to convert image file: " << filename
398 << "\n\twith displayed filename: " << to_utf8(displayed_filename));
400 string const from = formats.getFormatFromFile(filename);
402 setStatus(ErrorConverting);
403 LYXERR(Debug::GRAPHICS, "\tCould not determine file format.");
405 LYXERR(Debug::GRAPHICS, "\n\tThe file contains " << from << " format data.");
406 to_ = findTargetFormat(from);
409 // No conversion needed!
410 LYXERR(Debug::GRAPHICS, "\tNo conversion needed (from == to)!");
411 file_to_load_ = filename;
416 if (ConverterCache::get().inCache(filename, to_)) {
417 LYXERR(Debug::GRAPHICS, "\tNo conversion needed (file in file cache)!");
418 file_to_load_ = ConverterCache::get().cacheName(filename, to_);
423 LYXERR(Debug::GRAPHICS, "\tConverting it to " << to_ << " format.");
425 // Add some stuff to create a uniquely named temporary file.
426 // This file is deleted in loadImage after it is loaded into memory.
427 FileName const to_file_base(tempName(FileName(), "CacheItem"));
428 remove_loaded_file_ = true;
430 // Remove the temp file, we only want the name...
431 // FIXME: This is unsafe!
432 to_file_base.removeFile();
434 // Connect a signal to this->imageConverted and pass this signal to
435 // the graphics converter so that we can load the modified file
436 // on completion of the conversion process.
437 converter_.reset(new Converter(filename, to_file_base.absFilename(), from, to_));
438 converter_->connect(boost::bind(&Impl::imageConverted, this, _1));
439 converter_->startConversion();
442 } // namespace graphics