2 * \file GraphicsConverter.C
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Angus Leeming
8 * Full author contact details are available in file CREDITS.
13 #include "GraphicsConverter.h"
15 #include "converter.h"
19 #include "support/filetools.h"
20 #include "support/forkedcallqueue.h"
21 #include "support/convert.h"
22 #include "support/lstrings.h"
23 #include "support/lyxlib.h"
25 #include <boost/bind.hpp>
30 namespace support = lyx::support;
32 using support::ChangeExtension;
33 using support::Forkedcall;
34 using support::ForkedCallQueue;
35 using support::LibFileSearch;
36 using support::LibScriptSearch;
37 using support::OnlyPath;
38 using support::OnlyFilename;
39 using support::QuoteName;
41 using support::tempName;
42 using support::unlink;
46 using std::ostringstream;
53 class Converter::Impl : public boost::signals::trackable {
56 Impl(string const &, string const &, string const &, string const &);
59 void startConversion();
61 /** This method is connected to a signal passed to the forked call
62 * class, passing control back here when the conversion is completed.
63 * Cleans-up the temporary files, emits the finishedConversion
64 * signal and removes the Converter from the list of all processes.
66 void converted(pid_t pid, int retval);
68 /** At the end of the conversion process inform the outside world
69 * by emitting a signal.
71 typedef boost::signal<void(bool)> SignalType;
73 SignalType finishedConversion;
76 string script_command_;
88 bool Converter::isReachable(string const & from_format_name,
89 string const & to_format_name)
91 return converters.isReachable(from_format_name, to_format_name);
95 Converter::Converter(string const & from_file, string const & to_file_base,
96 string const & from_format, string const & to_format)
97 : pimpl_(new Impl(from_file, to_file_base, from_format, to_format))
101 // Empty d-tor out-of-line to keep boost::scoped_ptr happy.
102 Converter::~Converter()
106 void Converter::startConversion() const
108 pimpl_->startConversion();
112 boost::signals::connection Converter::connect(slot_type const & slot) const
114 return pimpl_->finishedConversion.connect(slot);
118 string const & Converter::convertedFile() const
120 static string const empty;
121 return pimpl_->finished_ ? pimpl_->to_file_ : empty;
124 } // namespace graphics
128 //------------------------------
129 // Implementation details follow
130 //------------------------------
134 /** Build the conversion script, returning true if able to build it.
135 * The script is output to the ostringstream 'script'.
137 bool build_script(string const & from_file, string const & to_file_base,
138 string const & from_format, string const & to_format,
147 Converter::Impl::Impl(string const & from_file, string const & to_file_base,
148 string const & from_format, string const & to_format)
149 : valid_process_(false), finished_(false)
151 lyxerr[Debug::GRAPHICS] << "Converter c-tor:\n"
152 << "\tfrom_file: " << from_file
153 << "\n\tto_file_base: " << to_file_base
154 << "\n\tfrom_format: " << from_format
155 << "\n\tto_format: " << to_format << endl;
157 // The converted image is to be stored in this file (we do not
158 // use ChangeExtension because this is a basename which may
159 // nevertheless contain a '.')
160 to_file_ = to_file_base + '.' + formats.extension(to_format);
162 // The conversion commands are stored in a stringstream
163 ostringstream script;
164 script << "#!/bin/sh\n";
165 bool const success = build_script(from_file, to_file_base,
166 from_format, to_format, script);
170 "sh " + LibFileSearch("scripts", "convertDefault.sh") +
171 ' ' + from_format + ':' + from_file + ' ' +
172 to_format + ':' + to_file_;
174 lyxerr[Debug::GRAPHICS]
175 << "\tNo converter defined! I use convertDefault.sh\n\t"
176 << script_command_ << endl;
180 lyxerr[Debug::GRAPHICS] << "\tConversion script:"
181 << "\n--------------------------------------\n"
183 << "\n--------------------------------------\n";
185 // Output the script to file.
186 static int counter = 0;
187 script_file_ = OnlyPath(to_file_base) + "lyxconvert" +
188 convert<string>(counter++) + ".sh";
190 std::ofstream fs(script_file_.c_str());
192 lyxerr << "Unable to write the conversion script to \""
193 << script_file_ << '\n'
194 << "Please check your directory permissions."
202 // The command needed to run the conversion process
203 // We create a dummy command for ease of understanding of the
204 // list of forked processes.
205 // Note: 'sh ' is absolutely essential, or execvp will fail.
206 script_command_ = "sh " + script_file_ + ' ' +
207 OnlyFilename(from_file) + ' ' + to_format;
209 // All is ready to go
210 valid_process_ = true;
214 void Converter::Impl::startConversion()
216 if (!valid_process_) {
221 Forkedcall::SignalTypePtr
222 ptr = ForkedCallQueue::get().add(script_command_);
224 ptr->connect(boost::bind(&Impl::converted, this, _1, _2));
228 void Converter::Impl::converted(pid_t /* pid */, int retval)
231 // We're done already!
235 // Clean-up behind ourselves
236 unlink(script_file_);
241 finishedConversion(false);
243 finishedConversion(true);
247 } // namespace graphics
252 string const move_file(string const & from_file, string const & to_file)
254 if (from_file == to_file)
257 ostringstream command;
258 command << "fromfile=" << from_file << "\n"
259 << "tofile=" << to_file << "\n\n"
260 << "'mv' -f \"${fromfile}\" \"${tofile}\" ||\n"
262 << "\t'cp' -f \"${fromfile}\" \"${tofile}\" ||\n"
266 << "\t'rm' -f \"${fromfile}\"\n"
269 return command.str();
273 bool build_script(string const & from_file,
274 string const & to_file_base,
275 string const & from_format,
276 string const & to_format,
279 lyxerr[Debug::GRAPHICS] << "build_script ... ";
280 typedef Converters::EdgePath EdgePath;
282 // we do not use ChangeExtension because this is a basename
283 // which may nevertheless contain a '.'
284 string const to_file = to_file_base + '.'
285 + formats.extension(to_format);
287 if (from_format == to_format) {
288 script << move_file(QuoteName(from_file), QuoteName(to_file));
289 lyxerr[Debug::GRAPHICS] << "ready (from == to)" << endl;
293 EdgePath edgepath = converters.getPath(from_format, to_format);
295 if (edgepath.empty()) {
296 lyxerr[Debug::GRAPHICS] << "ready (edgepath.empty())" << endl;
300 // Create a temporary base file-name for all intermediate steps.
301 // Remember to remove the temp file because we only want the name...
302 static int counter = 0;
303 string const tmp = "gconvert" + convert<string>(counter++);
304 string const to_base = tempName(string(), tmp);
307 string outfile = from_file;
309 // The conversion commands may contain these tokens that need to be
310 // changed to infile, infile_base, outfile respectively.
311 string const token_from("$$i");
312 string const token_base("$$b");
313 string const token_to("$$o");
315 EdgePath::const_iterator it = edgepath.begin();
316 EdgePath::const_iterator end = edgepath.end();
318 for (; it != end; ++it) {
319 ::Converter const & conv = converters.get(*it);
321 // Build the conversion command
322 string const infile = outfile;
323 string const infile_base = ChangeExtension(infile, string());
324 outfile = ChangeExtension(to_base, conv.To->extension());
326 // Store these names in the shell script
327 script << "infile=" << QuoteName(infile) << '\n'
328 << "infile_base=" << QuoteName(infile_base) << '\n'
329 << "outfile=" << QuoteName(outfile) << '\n';
331 string command = conv.command;
332 command = subst(command, token_from, "\"${infile}\"");
333 command = subst(command, token_base, "\"${infile_base}\"");
334 command = subst(command, token_to, "\"${outfile}\"");
335 command = LibScriptSearch(command);
337 // Store in the shell script
338 script << "\n" << command << " ||\n";
340 // Test that this was successful. If not, remove
341 // ${outfile} and exit the shell script
343 << "\t'rm' -f \"${outfile}\"\n"
347 // Test that the outfile exists.
348 // ImageMagick's convert will often create ${outfile}.0,
350 // If this occurs, move ${outfile}.0 to ${outfile}
351 // and delete ${outfile}.?
352 script << "if [ ! -f \"${outfile}\" ]; then\n"
353 << "\tif [ -f \"${outfile}\".0 ]; then\n"
354 << "\t\t'mv' -f \"${outfile}\".0 \"${outfile}\"\n"
355 << "\t\t'rm' -f \"${outfile}\".?\n"
361 // Delete the infile, if it isn't the original, from_file.
362 if (infile != from_file) {
363 script << "'rm' -f \"${infile}\"\n\n";
367 // Move the final outfile to to_file
368 script << move_file("\"${outfile}\"", QuoteName(to_file));
369 lyxerr[Debug::GRAPHICS] << "ready!" << endl;