X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fgraphics%2FGraphicsConverter.cpp;h=6c3e48d93ad34a2cba1024ccbd829118f831b2d3;hb=38c2cde0d8695ac5287bae218c4a33a2acf18ef8;hp=6fafbf2679d25ccc0c8c7c87dbfc8e2fe8f4a5fb;hpb=138b23fac84930cdbfada0067c61480989041113;p=lyx.git diff --git a/src/graphics/GraphicsConverter.cpp b/src/graphics/GraphicsConverter.cpp index 6fafbf2679..6c3e48d93a 100644 --- a/src/graphics/GraphicsConverter.cpp +++ b/src/graphics/GraphicsConverter.cpp @@ -12,52 +12,39 @@ #include "GraphicsConverter.h" +#include "Buffer.h" #include "Converter.h" -#include "debug.h" #include "Format.h" +#include "LyXRC.h" -#include "support/filetools.h" -#include "support/ForkedCallQueue.h" +#include "frontends/alert.h" +#include "support/lassert.h" #include "support/convert.h" +#include "support/debug.h" +#include "support/FileName.h" +#include "support/filetools.h" +#include "support/ForkedCalls.h" #include "support/lstrings.h" -#include "support/lyxlib.h" #include "support/os.h" -#include +#include "support/TempFile.h" #include #include -namespace support = lyx::support; - -using support::addExtension; -using support::changeExtension; -using support::FileName; -using support::Forkedcall; -using support::ForkedCallQueue; -using support::getExtension; -using support::libScriptSearch; -using support::onlyPath; -using support::onlyFilename; -using support::quoteName; -using support::quote_python; -using support::subst; -using support::tempName; -using support::unlink; - -using std::endl; -using std::ostream; -using std::ostringstream; -using std::string; - +using namespace std; +using namespace lyx::support; namespace lyx { + namespace graphics { -class Converter::Impl : public boost::signals::trackable { +class Converter::Impl { public: /// - Impl(FileName const &, string const &, string const &, string const &); + Impl(FileName const & doc_fname, + FileName const & from_file, string const & to_file_base, + string const & from_format, string const & to_format); /// void startConversion(); @@ -72,10 +59,12 @@ public: /** At the end of the conversion process inform the outside world * by emitting a signal. */ - typedef boost::signal SignalType; + typedef signals2::signal sig; /// - SignalType finishedConversion; + sig finishedConversion; + /// + FileName const doc_fname_; /// string script_command_; /// @@ -86,6 +75,8 @@ public: bool valid_process_; /// bool finished_; + /// + Trackable tracker_; }; @@ -96,15 +87,17 @@ bool Converter::isReachable(string const & from_format_name, } -Converter::Converter(FileName const & from_file, string const & to_file_base, - string const & from_format, string const & to_format) - : pimpl_(new Impl(from_file, to_file_base, from_format, to_format)) +Converter::Converter(FileName const & doc_fname, + FileName const & from_file, string const & to_file_base, + string const & from_format, string const & to_format) + : pimpl_(new Impl(doc_fname, from_file, to_file_base, from_format, to_format)) {} -// Empty d-tor out-of-line to keep boost::scoped_ptr happy. Converter::~Converter() -{} +{ + delete pimpl_; +} void Converter::startConversion() const @@ -113,7 +106,7 @@ void Converter::startConversion() const } -boost::signals::connection Converter::connect(slot_type const & slot) const +signals2::connection Converter::connect(slot_type const & slot) const { return pimpl_->finishedConversion.connect(slot); } @@ -128,45 +121,50 @@ FileName const & Converter::convertedFile() const /** Build the conversion script. * The script is output to the stream \p script. */ -static void build_script(FileName const & from_file, string const & to_file_base, +static void build_script(string const & doc_fname, + string const & from_file, string const & to_file_base, string const & from_format, string const & to_format, ostream & script); -Converter::Impl::Impl(FileName const & from_file, string const & to_file_base, +Converter::Impl::Impl(FileName const & doc_fname, + FileName const & from_file, string const & to_file_base, string const & from_format, string const & to_format) - : valid_process_(false), finished_(false) + : doc_fname_(doc_fname), valid_process_(false), finished_(false) { - LYXERR(Debug::GRAPHICS) << "Converter c-tor:\n" - << "\tfrom_file: " << from_file + LYXERR(Debug::GRAPHICS, "Converter c-tor:\n" + << "doc_fname: " << doc_fname + << "\n\tfrom_file: " << from_file << "\n\tto_file_base: " << to_file_base << "\n\tfrom_format: " << from_format - << "\n\tto_format: " << to_format << endl; + << "\n\tto_format: " << to_format); // The converted image is to be stored in this file (we do not // use ChangeExtension because this is a basename which may // nevertheless contain a '.') - to_file_ = FileName(to_file_base + '.' + formats.extension(to_format)); + to_file_ = FileName(to_file_base + '.' + theFormats().extension(to_format)); // The conversion commands are stored in a stringstream ostringstream script; - build_script(from_file, to_file_base, from_format, to_format, script); - LYXERR(Debug::GRAPHICS) << "\tConversion script:" - << "\n--------------------------------------\n" + build_script(doc_fname_.absFileName(), from_file.toFilesystemEncoding(), + to_file_.toFilesystemEncoding(), + from_format, to_format, script); + LYXERR(Debug::GRAPHICS, "\tConversion script:" + "\n--------------------------------------\n" << script.str() - << "\n--------------------------------------\n"; + << "\n--------------------------------------\n"); // Output the script to file. - static int counter = 0; - script_file_ = FileName(onlyPath(to_file_base) + "lyxconvert" + - convert(counter++) + ".py"); + TempFile tempfile(to_file_.onlyPath(), "lyxconvertXXXXXX.py"); + tempfile.setAutoRemove(false); + script_file_ = tempfile.name(); - std::ofstream fs(script_file_.toFilesystemEncoding().c_str()); + ofstream fs(script_file_.toFilesystemEncoding().c_str()); if (!fs.good()) { lyxerr << "Unable to write the conversion script to \"" << script_file_ << '\n' << "Please check your directory permissions." - << std::endl; + << endl; return; } @@ -177,9 +175,9 @@ Converter::Impl::Impl(FileName const & from_file, string const & to_file_base, // We create a dummy command for ease of understanding of the // list of forked processes. // Note: 'python ' is absolutely essential, or execvp will fail. - script_command_ = support::os::python() + ' ' + + script_command_ = os::python() + ' ' + quoteName(script_file_.toFilesystemEncoding()) + ' ' + - quoteName(onlyFilename(from_file.toFilesystemEncoding())) + ' ' + + quoteName(onlyFileName(from_file.toFilesystemEncoding())) + ' ' + quoteName(to_format); // All is ready to go valid_process_ = true; @@ -193,13 +191,13 @@ void Converter::Impl::startConversion() return; } - Forkedcall::SignalTypePtr - ptr = ForkedCallQueue::get().add(script_command_); - - ptr->connect(boost::bind(&Impl::converted, this, _1, _2)); - + ForkedCall::sigPtr ptr = ForkedCallQueue::add(script_command_); + ptr->connect(ForkedCall::slot([this](pid_t pid, int retval){ + converted(pid, retval); + }).track_foreign(tracker_.p())); } + void Converter::Impl::converted(pid_t /* pid */, int retval) { if (finished_) @@ -208,10 +206,10 @@ void Converter::Impl::converted(pid_t /* pid */, int retval) finished_ = true; // Clean-up behind ourselves - unlink(script_file_); + script_file_.removeFile(); if (retval > 0) { - unlink(to_file_); + to_file_.removeFile(); to_file_.erase(); finishedConversion(false); } else { @@ -244,7 +242,7 @@ static string const move_file(string const & from_file, string const & to_file) static void build_conversion_command(string const & command, ostream & script) { // Store in the python script - script << "\nif os.system(r'" << command << "') != 0:\n"; + script << "\nif os.system(r'" << commandPrep(command) << "') != 0:\n"; // Test that this was successful. If not, remove // ${outfile} and exit the python script @@ -257,115 +255,112 @@ static void build_conversion_command(string const & command, ostream & script) // If this occurs, move ${outfile}.0 to ${outfile} // and delete ${outfile}.? (ignore errors) script << "if not os.path.isfile(outfile):\n" - " if os.path.isfile(outfile + '.0'):\n" - " os.rename(outfile + '.0', outfile)\n" - " import glob\n" - " for file in glob.glob(outfile + '.?'):\n" - " unlinkNoThrow(file)\n" - " else:\n" - " sys.exit(1)\n\n"; + " if os.path.isfile(outfile + '.0'):\n" + " os.rename(outfile + '.0', outfile)\n" + " import glob\n" + " for file in glob.glob(outfile + '.?'):\n" + " unlinkNoThrow(file)\n" + " else:\n" + " sys.exit(1)\n\n"; // Delete the infile - script << "unlinkNoThrow(infile)\n\n"; + script << "if infile != outfile:\n" + " unlinkNoThrow(infile)\n\n"; +} + + +static string const strip_digit(string const & format) +{ + // Strip trailing digits from format names e.g. "pdf6" -> "pdf" + return format.substr(0, format.find_last_not_of("0123456789") + 1); } -static void build_script(FileName const & from_file, - string const & to_file_base, +static void build_script(string const & doc_fname, + string const & from_file, + string const & to_file, string const & from_format, string const & to_format, ostream & script) { - BOOST_ASSERT(from_format != to_format); - LYXERR(Debug::GRAPHICS) << "build_script ... "; - typedef Converters::EdgePath EdgePath; - - script << "#!/usr/bin/env python\n" - "# -*- coding: utf-8 -*-\n" - "import os, shutil, sys, locale\n\n" - "def unlinkNoThrow(file):\n" - " ''' remove a file, do not throw if an error occurs '''\n" - " try:\n" - " os.unlink(file)\n" - " except:\n" - " pass\n\n" - "def utf8ToDefaultEncoding(file):\n" - " ''' if possible, convert to the default encoding '''\n" - " try:\n" - " language, output_encoding = locale.getdefaultlocale()\n" - " if output_encoding == None:\n" - " output_encoding = 'latin1'\n" - " return unicode(file, 'utf8').encode(output_encoding)\n" - " except:\n" - " return file\n\n"; - - // we do not use ChangeExtension because this is a basename - // which may nevertheless contain a '.' - string const to_file = to_file_base + '.' - + formats.extension(to_format); + LASSERT(from_format != to_format, return); + LYXERR(Debug::GRAPHICS, "build_script ... "); + typedef Graph::EdgePath EdgePath; + + script << "# -*- coding: utf-8 -*-\n" + "import os, shutil, sys\n\n" + "def unlinkNoThrow(file):\n" + " ''' remove a file, do not throw if an error occurs '''\n" + " try:\n" + " os.unlink(file)\n" + " except:\n" + " pass\n\n"; EdgePath const edgepath = from_format.empty() ? EdgePath() : theConverters().getPath(from_format, to_format); // Create a temporary base file-name for all intermediate steps. - // Remember to remove the temp file because we only want the name... - static int counter = 0; - string const tmp = "gconvert" + convert(counter++); - FileName const to_base(tempName(FileName(), tmp)); - unlink(to_base); + string const from_ext = getExtension(from_file); + TempFile tempfile(addExtension("gconvertXXXXXX", from_ext)); + tempfile.setAutoRemove(false); + string outfile = tempfile.name().toFilesystemEncoding(); + string const to_base = from_ext.empty() ? outfile : removeExtension(outfile); // Create a copy of the file in case the original name contains // problematic characters like ' or ". We can work around that problem // in python, but the converters might be shell scripts and have more // troubles with it. - string outfile = addExtension(to_base.absFilename(), getExtension(from_file.absFilename())); - script << "infile = utf8ToDefaultEncoding(" - << quoteName(from_file.absFilename(), quote_python) - << ")\n" - "outfile = " << quoteName(outfile, quote_python) << "\n" - "shutil.copy(infile, outfile)\n"; + script << "infile = " + << quoteName(from_file, quote_python) + << "\n" + "outfile = " + << quoteName(outfile, quote_python) << "\n" + "shutil.copy(infile, outfile)\n"; // Some converters (e.g. lilypond) can only output files to the // current directory, so we need to change the current directory. // This has the added benefit that all other files that may be // generated by the converter are deleted when LyX closes and do not // clutter the real working directory. - script << "os.chdir(" << quoteName(onlyPath(outfile)) << ")\n"; + script << "os.chdir(" + << quoteName(onlyPath(outfile)) << ")\n"; if (edgepath.empty()) { // Either from_format is unknown or we don't have a // converter path from from_format to to_format, so we use // the default converter. script << "infile = outfile\n" - << "outfile = " << quoteName(to_file, quote_python) - << '\n'; + << "outfile = " + << quoteName(to_file, quote_python) << "\n"; ostringstream os; - os << support::os::python() << ' ' - << libScriptSearch("$$s/scripts/convertDefault.py", - quote_python) << ' '; - if (!from_format.empty()) - os << from_format << ':'; + os << os::python() << ' ' + << commandPrep("$$s/scripts/convertDefault.py") << ' '; + if (from_format.empty()) + os << "unknown "; + else + os << strip_digit(from_format) << ' '; // The extra " quotes around infile and outfile are needed // because the filename may contain spaces and it is used // as argument of os.system(). os << "' + '\"' + infile + '\"' + ' " - << to_format << ":' + '\"' + outfile + '\"' + '"; + << strip_digit(to_format) << " ' + '\"' + outfile + '\"' + '"; string const command = os.str(); - LYXERR(Debug::GRAPHICS) - << "\tNo converter defined! I use convertDefault.py\n\t" - << command << endl; + LYXERR(Debug::GRAPHICS, + "\tNo converter defined! I use convertDefault.py\n\t" + << command); build_conversion_command(command, script); } // The conversion commands may contain these tokens that need to be - // changed to infile, infile_base, outfile respectively. - string const token_from("$$i"); - string const token_base("$$b"); - string const token_to("$$o"); + // changed to infile, infile_base, outfile and output directory respectively. + string const token_from = "$$i"; + string const token_base = "$$b"; + string const token_to = "$$o"; + string const token_todir = "$$d"; EdgePath::const_iterator it = edgepath.begin(); EdgePath::const_iterator end = edgepath.end(); @@ -376,29 +371,47 @@ static void build_script(FileName const & from_file, // Build the conversion command string const infile = outfile; string const infile_base = changeExtension(infile, string()); - outfile = addExtension(to_base.absFilename(), conv.To->extension()); + outfile = conv.result_file().empty() + ? addExtension(to_base, conv.To()->extension()) + : addName(subst(conv.result_dir(), + token_base, infile_base), + subst(conv.result_file(), + token_base, onlyFileName(infile_base))); + + // If two formats share the same extension we may get identical names + if (outfile == infile && conv.result_file().empty()) { + TempFile tmpfile(addExtension("gconvertXXXXXX", conv.To()->extension())); + tmpfile.setAutoRemove(false); + outfile = tmpfile.name().toFilesystemEncoding(); + } + + if (!theConverters().checkAuth(conv, doc_fname)) + return; // Store these names in the python script - script << "infile = " << quoteName(infile, quote_python) << "\n" - "infile_base = " << quoteName(infile_base, quote_python) << "\n" - "outfile = " << quoteName(outfile, quote_python) << '\n'; + script << "infile = " + << quoteName(infile, quote_python) << "\n" + "infile_base = " + << quoteName(infile_base, quote_python) << "\n" + "outfile = " + << quoteName(outfile, quote_python) << "\n" + "outdir = os.path.dirname(outfile)\n" ; // See comment about extra " quotes above (although that // applies only for the first loop run here). - string command = conv.command; - command = subst(command, token_from, "' + '\"' + infile + '\"' + '"); - command = subst(command, token_base, "' + '\"' + infile_base + '\"' + '"); - command = subst(command, token_to, "' + '\"' + outfile + '\"' + '"); - command = libScriptSearch(command, quote_python); + string command = conv.command(); + command = subst(command, token_from, "' + '\"' + infile + '\"' + '"); + command = subst(command, token_base, "' + '\"' + infile_base + '\"' + '"); + command = subst(command, token_to, "' + '\"' + outfile + '\"' + '"); + command = subst(command, token_todir, "' + '\"' + outdir + '\"' + '"); build_conversion_command(command, script); } // Move the final outfile to to_file script << move_file("outfile", quoteName(to_file, quote_python)); - LYXERR(Debug::GRAPHICS) << "ready!" << endl; + LYXERR(Debug::GRAPHICS, "ready!"); } } // namespace graphics - } // namespace lyx