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()
149 FileName const & CacheItem::filename() const
151 return pimpl_->filename_;
155 void CacheItem::startLoading() const
157 pimpl_->startLoading();
161 void CacheItem::startMonitoring() const
163 if (!pimpl_->monitor_.monitoring())
164 pimpl_->monitor_.start();
168 bool CacheItem::monitoring() const
170 return pimpl_->monitor_.monitoring();
174 unsigned long CacheItem::checksum() const
176 return pimpl_->monitor_.checksum();
180 Image const * CacheItem::image() const
182 return pimpl_->image_.get();
186 ImageStatus CacheItem::status() const
188 return pimpl_->status_;
192 boost::signals::connection CacheItem::connect(slot_type const & slot) const
194 return pimpl_->statusChanged.connect(slot);
198 //------------------------------
199 // Implementation details follow
200 //------------------------------
203 CacheItem::Impl::Impl(FileName const & file)
205 monitor_(file, 2000),
207 remove_loaded_file_(false),
208 status_(WaitingToLoad)
210 monitor_.connect(boost::bind(&Impl::startLoading, this));
214 void CacheItem::Impl::startLoading()
216 if (status_ != WaitingToLoad)
219 convertToDisplayFormat();
223 void CacheItem::Impl::reset()
226 if (!unzipped_filename_.empty())
227 unlink(unzipped_filename_);
228 unzipped_filename_.erase();
230 if (remove_loaded_file_ && !file_to_load_.empty())
231 unlink(file_to_load_);
232 remove_loaded_file_ = false;
233 file_to_load_.erase();
239 status_ = WaitingToLoad;
247 if (converter_.get())
252 void CacheItem::Impl::setStatus(ImageStatus new_status)
254 if (status_ == new_status)
257 status_ = new_status;
262 void CacheItem::Impl::imageConverted(bool success)
264 string const text = success ? "succeeded" : "failed";
265 LYXERR(Debug::GRAPHICS, "Image conversion " << text << '.');
267 file_to_load_ = converter_.get() ?
268 FileName(converter_->convertedFile()) : FileName();
272 success = !file_to_load_.empty() && file_to_load_.isFileReadable();
275 LYXERR(Debug::GRAPHICS, "Unable to find converted file!");
276 setStatus(ErrorConverting);
279 unlink(unzipped_filename_);
284 // Add the converted file to the file cache
285 ConverterCache::get().add(filename_, to_, file_to_load_);
291 // This function gets called from the callback after the image has been
292 // converted successfully.
293 void CacheItem::Impl::loadImage()
296 LYXERR(Debug::GRAPHICS, "Loading image.");
298 image_.reset(Image::newImage());
301 cl_ = image_->finishedLoading.connect(
302 boost::bind(&Impl::imageLoaded, this, _1));
303 image_->load(file_to_load_);
307 void CacheItem::Impl::imageLoaded(bool success)
309 string const text = success ? "succeeded" : "failed";
310 LYXERR(Debug::GRAPHICS, "Image loading " << text << '.');
312 // Clean up after loading.
314 unlink(unzipped_filename_);
316 if (remove_loaded_file_ && unzipped_filename_ != file_to_load_)
317 unlink(file_to_load_);
322 setStatus(ErrorLoading);
326 // Inform the outside world.
331 static string const findTargetFormat(string const & from)
333 typedef lyx::graphics::Image::FormatList FormatList;
334 FormatList const formats = lyx::graphics::Image::loadableFormats();
336 // There must be a format to load from.
337 BOOST_ASSERT(!formats.empty());
339 // Use the standard converter if we don't know the format to load
342 return string("ppm");
344 // First ascertain if we can load directly with no conversion
345 FormatList::const_iterator it = formats.begin();
346 FormatList::const_iterator end = formats.end();
347 for (; it != end; ++it) {
352 // So, we have to convert to a loadable format. Can we?
353 it = formats.begin();
354 for (; it != end; ++it) {
355 if (lyx::graphics::Converter::isReachable(from, *it))
358 LYXERR(Debug::GRAPHICS, "Unable to convert from " << from
362 // Failed! so we have to try to convert it to PPM format
363 // with the standard converter
364 return string("ppm");
368 void CacheItem::Impl::convertToDisplayFormat()
370 setStatus(Converting);
372 // First, check that the file exists!
373 if (!filename_.isFileReadable()) {
374 if (status_ != ErrorNoFile) {
375 setStatus(ErrorNoFile);
376 LYXERR(Debug::GRAPHICS, "\tThe file is not readable");
381 // Make a local copy in case we unzip it
383 zipped_ = filename_.isZippedFile();
385 unzipped_filename_ = tempName(FileName(), filename_.toFilesystemEncoding());
386 if (unzipped_filename_.empty()) {
387 setStatus(ErrorConverting);
388 LYXERR(Debug::GRAPHICS, "\tCould not create temporary file.");
391 filename = unzipFile(filename_, unzipped_filename_.toFilesystemEncoding());
393 filename = filename_;
396 docstring const displayed_filename = makeDisplayPath(filename_.absFilename());
397 LYXERR(Debug::GRAPHICS, "[CacheItem::Impl::convertToDisplayFormat]\n"
398 << "\tAttempting to convert image file: " << filename
399 << "\n\twith displayed filename: " << to_utf8(displayed_filename));
401 string const from = formats.getFormatFromFile(filename);
403 setStatus(ErrorConverting);
404 LYXERR(Debug::GRAPHICS, "\tCould not determine file format.");
406 LYXERR(Debug::GRAPHICS, "\n\tThe file contains " << from << " format data.");
407 to_ = findTargetFormat(from);
410 // No conversion needed!
411 LYXERR(Debug::GRAPHICS, "\tNo conversion needed (from == to)!");
412 file_to_load_ = filename;
417 if (ConverterCache::get().inCache(filename, to_)) {
418 LYXERR(Debug::GRAPHICS, "\tNo conversion needed (file in file cache)!");
419 file_to_load_ = ConverterCache::get().cacheName(filename, to_);
424 LYXERR(Debug::GRAPHICS, "\tConverting it to " << to_ << " format.");
426 // Add some stuff to create a uniquely named temporary file.
427 // This file is deleted in loadImage after it is loaded into memory.
428 FileName const to_file_base(tempName(FileName(), "CacheItem"));
429 remove_loaded_file_ = true;
431 // Remove the temp file, we only want the name...
432 // FIXME: This is unsafe!
433 unlink(to_file_base);
435 // Connect a signal to this->imageConverted and pass this signal to
436 // the graphics converter so that we can load the modified file
437 // on completion of the conversion process.
438 converter_.reset(new Converter(filename, to_file_base.absFilename(), from, to_));
439 converter_->connect(boost::bind(&Impl::imageConverted, this, _1));
440 converter_->startConversion();
443 } // namespace graphics