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"
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::unlink;
38 using support::unzipFile;
46 class CacheItem::Impl : public boost::signals::trackable {
50 Impl(FileName const & file);
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.
59 * If no file conversion is needed, then convertToDisplayFormat() calls
60 * loadImage() directly.
62 * convertToDisplayFormat() will set the loading status flag as
63 * approriate through calls to setStatus().
65 void convertToDisplayFormat();
67 /** Load the image into memory. This is called either from
68 * convertToDisplayFormat() direct or from imageConverted().
72 /** Get a notification when the image conversion is done.
73 * Connected to a signal on_finish_ which is passed to
76 void imageConverted(bool);
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.
82 void imageLoaded(bool);
84 /** Sets the status of the loading process. Also notifies
85 * listeners that the status has changed.
87 void setStatus(ImageStatus new_status);
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).
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.
101 /// The filename we refer too.
102 FileName const filename_;
104 FileMonitor const monitor_;
106 /// Is the file compressed?
108 /// If so, store the uncompressed file in this temporary file.
109 FileName unzipped_filename_;
110 /// The target format
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.
117 bool remove_loaded_file_;
119 /// The image and its loading status.
120 boost::shared_ptr<Image> image_;
124 /// This signal is emitted when the image loading status changes.
125 boost::signal<void()> statusChanged;
127 /// The connection to the signal Image::finishedLoading
128 boost::signals::connection cl_;
130 /// The connection of the signal ConvProcess::finishedConversion,
131 boost::signals::connection cc_;
134 boost::scoped_ptr<Converter> converter_;
138 CacheItem::CacheItem(FileName const & file)
139 : pimpl_(new Impl(file))
143 CacheItem::~CacheItem()
147 FileName const & CacheItem::filename() const
149 return pimpl_->filename_;
153 void CacheItem::startLoading() const
155 pimpl_->startLoading();
159 void CacheItem::startMonitoring() const
161 if (!pimpl_->monitor_.monitoring())
162 pimpl_->monitor_.start();
166 bool CacheItem::monitoring() const
168 return pimpl_->monitor_.monitoring();
172 unsigned long CacheItem::checksum() const
174 return pimpl_->monitor_.checksum();
178 Image const * CacheItem::image() const
180 return pimpl_->image_.get();
184 ImageStatus CacheItem::status() const
186 return pimpl_->status_;
190 boost::signals::connection CacheItem::connect(slot_type const & slot) const
192 return pimpl_->statusChanged.connect(slot);
196 //------------------------------
197 // Implementation details follow
198 //------------------------------
201 CacheItem::Impl::Impl(FileName const & file)
203 monitor_(file, 2000),
205 remove_loaded_file_(false),
206 status_(WaitingToLoad)
208 monitor_.connect(boost::bind(&Impl::startLoading, this));
212 void CacheItem::Impl::startLoading()
214 if (status_ != WaitingToLoad)
217 convertToDisplayFormat();
221 void CacheItem::Impl::reset()
224 if (!unzipped_filename_.empty())
225 unlink(unzipped_filename_);
226 unzipped_filename_.erase();
228 if (remove_loaded_file_ && !file_to_load_.empty())
229 unlink(file_to_load_);
230 remove_loaded_file_ = false;
231 file_to_load_.erase();
237 status_ = WaitingToLoad;
245 if (converter_.get())
250 void CacheItem::Impl::setStatus(ImageStatus new_status)
252 if (status_ == new_status)
255 status_ = new_status;
260 void CacheItem::Impl::imageConverted(bool success)
262 string const text = success ? "succeeded" : "failed";
263 LYXERR(Debug::GRAPHICS, "Image conversion " << text << '.');
265 file_to_load_ = converter_.get() ?
266 FileName(converter_->convertedFile()) : FileName();
270 success = !file_to_load_.empty() && file_to_load_.isFileReadable();
273 LYXERR(Debug::GRAPHICS, "Unable to find converted file!");
274 setStatus(ErrorConverting);
277 unlink(unzipped_filename_);
282 // Add the converted file to the file cache
283 ConverterCache::get().add(filename_, to_, file_to_load_);
289 // This function gets called from the callback after the image has been
290 // converted successfully.
291 void CacheItem::Impl::loadImage()
294 LYXERR(Debug::GRAPHICS, "Loading image.");
296 image_ = Image::newImage();
299 cl_ = image_->finishedLoading.connect(
300 boost::bind(&Impl::imageLoaded, this, _1));
301 image_->load(file_to_load_);
305 void CacheItem::Impl::imageLoaded(bool success)
307 string const text = success ? "succeeded" : "failed";
308 LYXERR(Debug::GRAPHICS, "Image loading " << text << '.');
310 // Clean up after loading.
312 unlink(unzipped_filename_);
314 if (remove_loaded_file_ && unzipped_filename_ != file_to_load_)
315 unlink(file_to_load_);
320 setStatus(ErrorLoading);
324 // Inform the outside world.
329 static string const findTargetFormat(string const & from)
331 typedef lyx::graphics::Image::FormatList FormatList;
332 FormatList const formats = lyx::graphics::Image::loadableFormats();
334 // There must be a format to load from.
335 BOOST_ASSERT(!formats.empty());
337 // Use the standard converter if we don't know the format to load
340 return string("ppm");
342 // First ascertain if we can load directly with no conversion
343 FormatList::const_iterator it = formats.begin();
344 FormatList::const_iterator end = formats.end();
345 for (; it != end; ++it) {
350 // So, we have to convert to a loadable format. Can we?
351 it = formats.begin();
352 for (; it != end; ++it) {
353 if (lyx::graphics::Converter::isReachable(from, *it))
356 LYXERR(Debug::GRAPHICS, "Unable to convert from " << from
360 // Failed! so we have to try to convert it to PPM format
361 // with the standard converter
362 return string("ppm");
366 void CacheItem::Impl::convertToDisplayFormat()
368 setStatus(Converting);
370 // First, check that the file exists!
371 if (!filename_.isFileReadable()) {
372 if (status_ != ErrorNoFile) {
373 setStatus(ErrorNoFile);
374 LYXERR(Debug::GRAPHICS, "\tThe file is not readable");
379 // Make a local copy in case we unzip it
381 zipped_ = filename_.isZippedFile();
383 unzipped_filename_ = tempName(FileName(), filename_.toFilesystemEncoding());
384 if (unzipped_filename_.empty()) {
385 setStatus(ErrorConverting);
386 LYXERR(Debug::GRAPHICS, "\tCould not create temporary file.");
389 filename = unzipFile(filename_, unzipped_filename_.toFilesystemEncoding());
391 filename = filename_;
394 docstring const displayed_filename = makeDisplayPath(filename_.absFilename());
395 LYXERR(Debug::GRAPHICS, "[CacheItem::Impl::convertToDisplayFormat]\n"
396 << "\tAttempting to convert image file: " << filename
397 << "\n\twith displayed filename: " << to_utf8(displayed_filename));
399 string const from = formats.getFormatFromFile(filename);
401 setStatus(ErrorConverting);
402 LYXERR(Debug::GRAPHICS, "\tCould not determine file format.");
404 LYXERR(Debug::GRAPHICS, "\n\tThe file contains " << from << " format data.");
405 to_ = findTargetFormat(from);
408 // No conversion needed!
409 LYXERR(Debug::GRAPHICS, "\tNo conversion needed (from == to)!");
410 file_to_load_ = filename;
415 if (ConverterCache::get().inCache(filename, to_)) {
416 LYXERR(Debug::GRAPHICS, "\tNo conversion needed (file in file cache)!");
417 file_to_load_ = ConverterCache::get().cacheName(filename, to_);
422 LYXERR(Debug::GRAPHICS, "\tConverting it to " << to_ << " format.");
424 // Add some stuff to create a uniquely named temporary file.
425 // This file is deleted in loadImage after it is loaded into memory.
426 FileName const to_file_base(tempName(FileName(), "CacheItem"));
427 remove_loaded_file_ = true;
429 // Remove the temp file, we only want the name...
430 // FIXME: This is unsafe!
431 unlink(to_file_base);
433 // Connect a signal to this->imageConverted and pass this signal to
434 // the graphics converter so that we can load the modified file
435 // on completion of the conversion process.
436 converter_.reset(new Converter(filename, to_file_base.absFilename(), from, to_));
437 converter_->connect(boost::bind(&Impl::imageConverted, this, _1));
438 converter_->startConversion();
441 } // namespace graphics