src/exporter.C

   1 /**
   2  * \file exporter.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author unknown
   7  * \author Alfredo Braunstein
   8  * \author Lars Gullik Bjønnes
   9  * \author Jean Marc Lasgouttes
  10  * \author Angus Leeming
  11  * \author John Levon
  12  * \author André Pönitz
  13  *
  14  * Full author contact details are available in file CREDITS.
  15  */
  16
  17 #include <config.h>
  18
  19 #include "exporter.h"
  20
  21 #include "buffer.h"
  22 #include "buffer_funcs.h"
  23 #include "bufferparams.h"
  24 #include "converter.h"
  25 #include "format.h"
  26 #include "gettext.h"
  27 #include "lyxrc.h"
  28 #include "mover.h"
  29 #include "output_plaintext.h"
  30 #include "outputparams.h"
  31 #include "frontends/Alert.h"
  32
  33 #include "support/filetools.h"
  34 #include "support/lyxlib.h"
  35 #include "support/package.h"
  36
  37 #include <boost/filesystem/operations.hpp>
  38
  39 using lyx::support::addName;
  40 using lyx::support::bformat;
  41 using lyx::support::changeExtension;
  42 using lyx::support::contains;
  43 using lyx::support::makeAbsPath;
  44 using lyx::support::makeDisplayPath;
  45 using lyx::support::onlyFilename;
  46 using lyx::support::onlyPath;
  47 using lyx::support::package;
  48 using lyx::support::prefixIs;
  49
  50 using std::find;
  51 using std::string;
  52 using std::vector;
  53
  54 namespace fs = boost::filesystem;
  55
  56 namespace {
  57
  58 vector<string> const Backends(Buffer const & buffer)
  59 {
  60         vector<string> v;
  61         if (buffer.params().getLyXTextClass().isTeXClassAvailable()) {
  62                 v.push_back(bufferFormat(buffer));
  63                 // FIXME: Don't hardcode format names here, but use a flag
  64                 if (v.back() == "latex")
  65                         v.push_back("pdflatex");
  66         }
  67         v.push_back("text");
  68         v.push_back("lyx");
  69         return v;
  70 }
  71
  72
  73 /// ask the user what to do if a file already exists
  74 int checkOverwrite(string const & filename)
  75 {
  76         if (fs::exists(filename)) {
  77                 string text = bformat(_("The file %1$s already exists.\n\n"
  78                                         "Do you want to over-write that file?"),
  79                                       makeDisplayPath(filename));
  80                 return Alert::prompt(_("Over-write file?"),
  81                                      text, 0, 2,
  82                                      _("&Over-write"), _("Over-write &all"),
  83                                      _("&Cancel export"));
  84         }
  85         return 0;
  86 }
  87
  88
  89 enum CopyStatus {
  90         SUCCESS,
  91         FORCE,
  92         CANCEL
  93 };
  94
  95
  96 /** copy file \p sourceFile to \p destFile. If \p force is false, the user
  97  *  will be asked before existing files are overwritten.
  98  *  \return
  99  *  - SUCCESS if this file got copied
 100  *  - FORCE   if subsequent calls should not ask for confirmation before
 101  *            overwriting files anymore.
 102  *  - CANCEL  if the export should be cancelled
 103  */
 104 CopyStatus copyFile(string const & format,
 105                     string const & sourceFile, string const & destFile,
 106                     string const & latexFile, bool force)
 107 {
 108         CopyStatus ret = force ? FORCE : SUCCESS;
 109
 110         // Only copy files that are in our tmp dir, all other files would
 111         // overwrite themselves. This check could be changed to
 112         // boost::filesystem::equivalent(sourceFile, destFile) if export to
 113         // other directories than the document directory is desired.
 114         if (!prefixIs(onlyPath(sourceFile), package().temp_dir()))
 115                 return ret;
 116
 117         if (!force) {
 118                 switch(checkOverwrite(destFile)) {
 119                 case 0:
 120                         ret = SUCCESS;
 121                         break;
 122                 case 1:
 123                         ret = FORCE;
 124                         break;
 125                 default:
 126                         return CANCEL;
 127                 }
 128         }
 129
 130         Mover const & mover = movers(format);
 131         if (!mover.copy(sourceFile, destFile, latexFile))
 132                 Alert::error(_("Couldn't copy file"),
 133                              bformat(_("Copying %1$s to %2$s failed."),
 134                                      makeDisplayPath(sourceFile),
 135                                      makeDisplayPath(destFile)));
 136
 137         return ret;
 138 }
 139
 140 } //namespace anon
 141
 142
 143 bool Exporter::Export(Buffer * buffer, string const & format,
 144                       bool put_in_tempdir, string & result_file)
 145 {
 146         string backend_format;
 147         OutputParams runparams;
 148         runparams.flavor = OutputParams::LATEX;
 149         runparams.linelen = lyxrc.ascii_linelen;
 150         vector<string> backends = Backends(*buffer);
 151         // FIXME: Without this test export to lyx13 would be through
 152         // latex -> lyx -> lyx13, because the first backend below with a
 153         // working conversion path is used. We should replace this test and
 154         // the explicit loop below with a method
 155         // getShortestPath(vector<string> const & from, string const & to)
 156         // which returns the shortest path from one of the formats in 'from'
 157         // to 'to'.
 158         if (format == "lyx13x" && !converters.getPath("lyx", format).empty())
 159                 backend_format = "lyx";
 160         else if (find(backends.begin(), backends.end(), format) == backends.end()) {
 161                 for (vector<string>::const_iterator it = backends.begin();
 162                      it != backends.end(); ++it) {
 163                         Graph::EdgePath p = converters.getPath(*it, format);
 164                         if (!p.empty()) {
 165                                 runparams.flavor = converters.getFlavor(p);
 166                                 backend_format = *it;
 167                                 break;
 168                         }
 169                 }
 170                 if (backend_format.empty()) {
 171                         Alert::error(_("Couldn't export file"),
 172                                 bformat(_("No information for exporting the format %1$s."),
 173                                    formats.prettyName(format)));
 174                         return false;
 175                 }
 176         } else {
 177                 backend_format = format;
 178                 // FIXME: Don't hardcode format names here, but use a flag
 179                 if (backend_format == "pdflatex")
 180                         runparams.flavor = OutputParams::PDFLATEX;
 181         }
 182
 183         string filename = buffer->getLatexName(false);
 184         filename = addName(buffer->temppath(), filename);
 185         filename = changeExtension(filename,
 186                                    formats.extension(backend_format));
 187
 188         // Ascii backend
 189         if (backend_format == "text")
 190                 writeFileAscii(*buffer, filename, runparams);
 191         // no backend
 192         else if (backend_format == "lyx")
 193                 buffer->writeFile(filename);
 194         // Docbook backend
 195         else if (buffer->isDocBook()) {
 196                 runparams.nice = !put_in_tempdir;
 197                 buffer->makeDocBookFile(filename, runparams);
 198         }
 199         // LaTeX backend
 200         else if (backend_format == format) {
 201                 runparams.nice = true;
 202                 buffer->makeLaTeXFile(filename, string(), runparams);
 203         } else if (!lyxrc.tex_allows_spaces
 204                    && contains(buffer->filePath(), ' ')) {
 205                 Alert::error(_("File name error"),
 206                            _("The directory path to the document cannot contain spaces."));
 207                 return false;
 208         } else {
 209                 runparams.nice = false;
 210                 buffer->makeLaTeXFile(filename, buffer->filePath(), runparams);
 211         }
 212
 213         string const error_type = (format == "program")? "Build" : bufferFormat(*buffer);
 214         bool const success = converters.convert(buffer, filename, filename,
 215                 backend_format, format, result_file,
 216                 buffer->errorList(error_type));
 217         // Emit the signal to show the error list.
 218         buffer->errors(error_type);
 219         if (!success)
 220                 return false;
 221
 222         if (!put_in_tempdir) {
 223                 string const tmp_result_file = result_file;
 224                 result_file = changeExtension(buffer->fileName(),
 225                                               formats.extension(format));
 226                 // We need to copy referenced files (e. g. included graphics
 227                 // if format == "dvi") to the result dir.
 228                 vector<ExportedFile> const files =
 229                         runparams.exportdata->externalFiles(format);
 230                 string const dest = onlyPath(result_file);
 231                 CopyStatus status = SUCCESS;
 232                 for (vector<ExportedFile>::const_iterator it = files.begin();
 233                                 it != files.end() && status != CANCEL; ++it) {
 234                         string const fmt =
 235                                 formats.getFormatFromFile(it->sourceName);
 236                         status = copyFile(fmt, it->sourceName,
 237                                           makeAbsPath(it->exportName, dest),
 238                                           it->exportName, status == FORCE);
 239                 }
 240                 if (status == CANCEL) {
 241                         buffer->message(_("Document export cancelled."));
 242                 } else if (fs::exists(tmp_result_file)) {
 243                         // Finally copy the main file
 244                         status = copyFile(format, tmp_result_file,
 245                                           result_file, result_file,
 246                                           status == FORCE);
 247                         buffer->message(bformat(_("Document exported as %1$s "
 248                                                   "to file `%2$s'"),
 249                                                 formats.prettyName(format),
 250                                                 makeDisplayPath(result_file)));
 251                 } else {
 252                         // This must be a dummy converter like fax (bug 1888)
 253                         buffer->message(bformat(_("Document exported as %1$s"),
 254                                                 formats.prettyName(format)));
 255                 }
 256         }
 257
 258         return true;
 259 }
 260
 261
 262 bool Exporter::Export(Buffer * buffer, string const & format,
 263                       bool put_in_tempdir)
 264 {
 265         string result_file;
 266         return Export(buffer, format, put_in_tempdir, result_file);
 267 }
 268
 269
 270 bool Exporter::preview(Buffer * buffer, string const & format)
 271 {
 272         string result_file;
 273         if (!Export(buffer, format, true, result_file))
 274                 return false;
 275         return formats.view(*buffer, result_file, format);
 276 }
 277
 278
 279 bool Exporter::isExportable(Buffer const & buffer, string const & format)
 280 {
 281         vector<string> backends = Backends(buffer);
 282         for (vector<string>::const_iterator it = backends.begin();
 283              it != backends.end(); ++it)
 284                 if (converters.isReachable(*it, format))
 285                         return true;
 286         return false;
 287 }
 288
 289
 290 vector<Format const *> const
 291 Exporter::getExportableFormats(Buffer const & buffer, bool only_viewable)
 292 {
 293         vector<string> backends = Backends(buffer);
 294         vector<Format const *> result =
 295                 converters.getReachable(backends[0], only_viewable, true);
 296         for (vector<string>::const_iterator it = backends.begin() + 1;
 297              it != backends.end(); ++it) {
 298                 vector<Format const *>  r =
 299                         converters.getReachable(*it, only_viewable, false);
 300                 result.insert(result.end(), r.begin(), r.end());
 301         }
 302         return result;
 303 }
 304
 305
 306 ExportedFile::ExportedFile(string const & s, string const & e) :
 307         sourceName(s), exportName(e) {}
 308
 309
 310 bool operator==(ExportedFile const & f1, ExportedFile const & f2)
 311 {
 312         return f1.sourceName == f2.sourceName &&
 313                f1.exportName == f2.exportName;
 314
 315 }
 316
 317
 318 void ExportData::addExternalFile(string const & format,
 319                                  string const & sourceName,
 320                                  string const & exportName)
 321 {
 322         BOOST_ASSERT(lyx::support::absolutePath(sourceName));
 323
 324         // Make sure that we have every file only once, otherwise copyFile()
 325         // would ask several times if it should overwrite a file.
 326         vector<ExportedFile> & files = externalfiles[format];
 327         ExportedFile file(sourceName, exportName);
 328         if (find(files.begin(), files.end(), file) == files.end())
 329                 files.push_back(file);
 330 }
 331
 332
 333 void ExportData::addExternalFile(string const & format,
 334                                  string const & sourceName)
 335 {
 336         addExternalFile(format, sourceName, onlyFilename(sourceName));
 337 }
 338
 339
 340 vector<ExportedFile> const
 341 ExportData::externalFiles(string const & format) const
 342 {
 343         FileMap::const_iterator cit = externalfiles.find(format);
 344         if (cit != externalfiles.end())
 345                 return cit->second;
 346         return vector<ExportedFile>();
 347 }