3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * parts Copyright 1985, 1990, 1993 Free Software Foundation, Inc.
8 * \author Ivan Schreter
9 * \author Dirk Niggemann
10 * \author Asger Alstrup
11 * \author Lars Gullik Bjønnes
12 * \author Jean-Marc Lasgouttes
13 * \author Angus Leeming
17 * Full author contact details are available in file CREDITS.
19 * General path-mangling functions
24 #include "support/filetools.h"
26 #include "support/debug.h"
27 #include "support/environment.h"
28 #include "support/gettext.h"
29 #include "support/lstrings.h"
30 #include "support/os.h"
31 #include "support/Package.h"
32 #include "support/Path.h"
33 #include "support/Systemcall.h"
34 #include "support/qstring_helpers.h"
38 #include "support/lassert.h"
39 #include <boost/regex.hpp>
58 bool isLyXFilename(string const & filename)
60 return suffixIs(ascii_lowercase(filename), ".lyx");
64 bool isSGMLFilename(string const & filename)
66 return suffixIs(ascii_lowercase(filename), ".sgml");
70 bool isValidLaTeXFilename(string const & filename)
72 string const invalid_chars("#$%{}()[]\"^");
73 return filename.find_first_of(invalid_chars) == string::npos;
77 string const latex_path(string const & original_path,
78 latex_path_extension extension,
81 // On cygwin, we may need windows or posix style paths.
82 string path = os::latex_path(original_path);
83 path = subst(path, "~", "\\string~");
84 if (path.find(' ') != string::npos) {
85 // We can't use '"' because " is sometimes active (e.g. if
86 // babel is loaded with the "german" option)
87 if (extension == EXCLUDE_EXTENSION) {
88 // ChangeExtension calls os::internal_path internally
89 // so don't use it to remove the extension.
90 string const ext = getExtension(path);
91 string const base = ext.empty() ?
93 path.substr(0, path.length() - ext.length() - 1);
94 // ChangeExtension calls os::internal_path internally
95 // so don't use it to re-add the extension.
96 path = "\\string\"" + base + "\\string\"." + ext;
98 path = "\\string\"" + path + "\\string\"";
102 return dots == ESCAPE_DOTS ? subst(path, ".", "\\lyxdot ") : path;
106 // Substitutes spaces with underscores in filename (and path)
107 FileName const makeLatexName(FileName const & file)
109 string name = file.onlyFileName();
110 string const path = file.onlyPath().absFilename() + "/";
112 // ok so we scan through the string twice, but who cares.
113 // FIXME: in Unicode time this will break for sure! There is
114 // a non-latin world out there...
115 string const keep = "abcdefghijklmnopqrstuvwxyz"
116 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
117 "@!'()*+,-./0123456789:;<=>?[]`|";
119 string::size_type pos = 0;
120 while ((pos = name.find_first_not_of(keep, pos)) != string::npos)
123 FileName latex_name(path + name);
124 latex_name.changeExtension(".tex");
129 string const quoteName(string const & name, quote_style style)
133 // This does not work for filenames containing " (windows)
134 // or ' (all other OSes). This can't be changed easily, since
135 // we would need to adapt the command line parser in
136 // Forkedcall::generateChild. Therefore we don't pass user
137 // filenames to child processes if possible. We store them in
138 // a python script instead, where we don't have these
141 return (os::shell() == os::UNIX) ?
145 // According to the QProcess parser, a single double
146 // quote is represented by three consecutive ones.
147 return '"' + subst(name, "\"", "\"\"\"") + '"';
150 return "\"" + subst(subst(name, "\\", "\\\\"), "\"", "\\\"")
153 // shut up stupid compiler
159 // Uses a string of paths separated by ";"s to find a file to open.
160 // Can't cope with pathnames with a ';' in them. Returns full path to file.
161 // If path entry begins with $$LyX/, use system_lyxdir
162 // If path entry begins with $$User/, use user_lyxdir
163 // Example: "$$User/doc;$$LyX/doc"
164 FileName const fileOpenSearch(string const & path, string const & name,
169 bool notfound = true;
170 string tmppath = split(path, path_element, ';');
172 while (notfound && !path_element.empty()) {
173 path_element = os::internal_path(path_element);
174 if (!suffixIs(path_element, '/'))
176 path_element = subst(path_element, "$$LyX",
177 package().system_support().absFilename());
178 path_element = subst(path_element, "$$User",
179 package().user_support().absFilename());
181 real_file = fileSearch(path_element, name, ext);
183 if (real_file.empty()) {
185 tmppath = split(tmppath, path_element, ';');
186 } while (!tmppath.empty() && path_element.empty());
196 // Returns the real name of file name in directory path, with optional
198 FileName const fileSearch(string const & path, string const & name,
199 string const & ext, search_mode mode)
201 // if `name' is an absolute path, we ignore the setting of `path'
202 // Expand Environmentvariables in 'name'
203 string const tmpname = replaceEnvironmentPath(name);
204 FileName fullname(makeAbsPath(tmpname, path));
205 // search first without extension, then with it.
206 if (fullname.isReadableFile())
210 return mode == may_not_exist ? fullname : FileName();
211 // Only add the extension if it is not already the extension of
213 if (getExtension(fullname.absFilename()) != ext)
214 fullname = FileName(addExtension(fullname.absFilename(), ext));
215 if (fullname.isReadableFile() || mode == may_not_exist)
221 // Search the file name.ext in the subdirectory dir of
223 // 2) build_lyxdir (if not empty)
225 FileName const libFileSearch(string const & dir, string const & name,
228 FileName fullname = fileSearch(addPath(package().user_support().absFilename(), dir),
230 if (!fullname.empty())
233 if (!package().build_support().empty())
234 fullname = fileSearch(addPath(package().build_support().absFilename(), dir),
236 if (!fullname.empty())
239 return fileSearch(addPath(package().system_support().absFilename(), dir), name, ext);
243 FileName const i18nLibFileSearch(string const & dir, string const & name,
246 /* The highest priority value is the `LANGUAGE' environment
247 variable. But we don't use the value if the currently
248 selected locale is the C locale. This is a GNU extension.
250 Otherwise, w use a trick to guess what support/gettext.has done:
251 each po file is able to tell us its name. (JMarc)
254 string lang = to_ascii(_("[[Replace with the code of your language]]"));
255 string const language = getEnv("LANGUAGE");
256 if (!lang.empty() && !language.empty())
260 lang = split(lang, l, ':');
263 // First try with the full name
264 tmp = libFileSearch(addPath(dir, l), name, ext);
268 // Then the name without country code
269 string const shortl = token(l, '_', 0);
271 tmp = libFileSearch(addPath(dir, shortl), name, ext);
277 // For compatibility, to be removed later (JMarc)
278 tmp = libFileSearch(dir, token(l, '_', 0) + '_' + name,
281 lyxerr << "i18nLibFileSearch: File `" << tmp
282 << "' has been found by the old method" <<endl;
286 lang = split(lang, l, ':');
289 return libFileSearch(dir, name, ext);
293 string const libScriptSearch(string const & command_in, quote_style style)
295 static string const token_scriptpath = "$$s/";
297 string command = command_in;
298 // Find the starting position of "$$s/"
299 string::size_type const pos1 = command.find(token_scriptpath);
300 if (pos1 == string::npos)
302 // Find the end of the "$$s/some_subdir/some_script" word within
303 // command. Assumes that the script name does not contain spaces.
304 string::size_type const start_script = pos1 + 4;
305 string::size_type const pos2 = command.find(' ', start_script);
306 string::size_type const size_script = pos2 == string::npos?
307 (command.size() - start_script) : pos2 - start_script;
309 // Does this script file exist?
310 string const script =
311 libFileSearch(".", command.substr(start_script, size_script)).absFilename();
313 if (script.empty()) {
314 // Replace "$$s/" with ""
315 command.erase(pos1, 4);
317 // Replace "$$s/foo/some_script" with "<path to>/some_script".
318 string::size_type const size_replace = size_script + 4;
319 command.replace(pos1, size_replace, quoteName(script, style));
326 static FileName createTmpDir(FileName const & tempdir, string const & mask)
328 LYXERR(Debug::FILES, "createTmpDir: tempdir=`" << tempdir << "'\n"
329 << "createTmpDir: mask=`" << mask << '\'');
331 FileName const tmpfl = FileName::tempName(tempdir, mask);
333 if (tmpfl.empty() || !tmpfl.createDirectory(0700)) {
334 LYXERR0("LyX could not create temporary directory in " << tempdir
343 FileName const createLyXTmpDir(FileName const & deflt)
345 if (deflt.empty() || deflt == package().system_temp_dir())
346 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
348 if (deflt.createDirectory(0777))
351 if (deflt.isDirWritable()) {
352 // deflt could not be created because it
353 // did exist already, so let's create our own
355 return createTmpDir(deflt, "lyx_tmpdir");
357 // some other error occured.
358 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
363 // Strip filename from path name
364 string const onlyPath(string const & filename)
366 // If empty filename, return empty
367 if (filename.empty())
370 // Find last / or start of filename
371 size_t j = filename.rfind('/');
372 return j == string::npos ? "./" : filename.substr(0, j + 1);
376 // Convert relative path into absolute path based on a basepath.
377 // If relpath is absolute, just use that.
378 // If basepath is empty, use CWD as base.
379 // Note that basePath can be a relative path, in the sense that it may
380 // not begin with "/" (e.g.), but it should NOT contain such constructs
382 // FIXME It might be nice if the code didn't simply assume that.
383 FileName const makeAbsPath(string const & relPath, string const & basePath)
385 // checks for already absolute path
386 if (FileName::isAbsolute(relPath))
387 return FileName(relPath);
389 // Copies given paths
390 string tempRel = os::internal_path(relPath);
391 // Since TempRel is NOT absolute, we can safely replace "//" with "/"
392 tempRel = subst(tempRel, "//", "/");
396 if (FileName::isAbsolute(basePath))
399 tempBase = addPath(FileName::getcwd().absFilename(), basePath);
401 // Handle /./ at the end of the path
402 while (suffixIs(tempBase, "/./"))
403 tempBase.erase(tempBase.length() - 2);
405 // processes relative path
406 string rTemp = tempRel;
409 // Check for a leading "~"
411 rTemp = split(rTemp, temp, '/');
413 tempBase = package().home_dir().absFilename();
418 while (!rTemp.empty()) {
420 rTemp = split(rTemp, temp, '/');
422 if (temp == ".") continue;
424 // Remove one level of TempBase
425 if (tempBase.length() <= 1) {
426 //this is supposed to be an absolute path, so...
430 //erase a trailing slash if there is one
431 if (suffixIs(tempBase, "/"))
432 tempBase.erase(tempBase.length() - 1, string::npos);
434 string::size_type i = tempBase.length() - 1;
435 while (i > 0 && tempBase[i] != '/')
438 tempBase.erase(i, string::npos);
441 } else if (temp.empty() && !rTemp.empty()) {
442 tempBase = os::current_root() + rTemp;
445 // Add this piece to TempBase
446 if (!suffixIs(tempBase, '/'))
452 // returns absolute path
453 return FileName(tempBase);
457 // Correctly append filename to the pathname.
458 // If pathname is '.', then don't use pathname.
459 // Chops any path of filename.
460 string const addName(string const & path, string const & fname)
462 string const basename = onlyFilename(fname);
465 if (path != "." && path != "./" && !path.empty()) {
466 buf = os::internal_path(path);
467 if (!suffixIs(path, '/'))
471 return buf + basename;
475 // Strips path from filename
476 string const onlyFilename(string const & fname)
481 string::size_type j = fname.rfind('/');
482 if (j == string::npos) // no '/' in fname
486 return fname.substr(j + 1);
490 // Create absolute path. If impossible, don't do anything
491 // Supports ./ and ~/. Later we can add support for ~logname/. (Asger)
492 string const expandPath(string const & path)
494 // checks for already absolute path
495 string rTemp = replaceEnvironmentPath(path);
496 if (FileName::isAbsolute(rTemp))
500 string const copy = rTemp;
503 rTemp = split(rTemp, temp, '/');
506 return FileName::getcwd().absFilename() + '/' + rTemp;
509 return package().home_dir().absFilename() + '/' + rTemp;
512 return makeAbsPath(copy).absFilename();
514 // Don't know how to handle this
519 // Search the string for ${VAR} and $VAR and replace VAR using getenv.
520 string const replaceEnvironmentPath(string const & path)
522 // ${VAR} is defined as
523 // $\{[A-Za-z_][A-Za-z_0-9]*\}
524 static string const envvar_br = "[$]\\{([A-Za-z_][A-Za-z_0-9]*)\\}";
526 // $VAR is defined as:
527 // $\{[A-Za-z_][A-Za-z_0-9]*\}
528 static string const envvar = "[$]([A-Za-z_][A-Za-z_0-9]*)";
530 static boost::regex envvar_br_re("(.*)" + envvar_br + "(.*)");
531 static boost::regex envvar_re("(.*)" + envvar + "(.*)");
534 string remaining = path;
536 regex_match(remaining, what, envvar_br_re);
537 if (!what[0].matched) {
538 regex_match(remaining, what, envvar_re);
539 if (!what[0].matched) {
544 string env_var = getEnv(what.str(2));
545 if (!env_var.empty())
546 result += what.str(1) + env_var;
548 result += what.str(1) + "$" + what.str(2);
549 remaining = what.str(3);
555 // Make relative path out of two absolute paths
556 docstring const makeRelPath(docstring const & abspath, docstring const & basepath)
557 // Makes relative path out of absolute path. If it is deeper than basepath,
558 // it's easy. If basepath and abspath share something (they are all deeper
559 // than some directory), it'll be rendered using ..'s. If they are completely
560 // different, then the absolute path will be used as relative path.
562 docstring::size_type const abslen = abspath.length();
563 docstring::size_type const baselen = basepath.length();
565 docstring::size_type i = os::common_path(abspath, basepath);
568 // actually no match - cannot make it relative
572 // Count how many dirs there are in basepath above match
573 // and append as many '..''s into relpath
575 docstring::size_type j = i;
576 while (j < baselen) {
577 if (basepath[j] == '/') {
578 if (j + 1 == baselen)
585 // Append relative stuff from common directory to abspath
586 if (abspath[i] == '/')
588 for (; i < abslen; ++i)
591 if (suffixIs(buf, '/'))
592 buf.erase(buf.length() - 1);
593 // Substitute empty with .
600 // Append sub-directory(ies) to a path in an intelligent way
601 string const addPath(string const & path, string const & path_2)
604 string const path2 = os::internal_path(path_2);
606 if (!path.empty() && path != "." && path != "./") {
607 buf = os::internal_path(path);
608 if (path[path.length() - 1] != '/')
612 if (!path2.empty()) {
613 string::size_type const p2start = path2.find_first_not_of('/');
614 string::size_type const p2end = path2.find_last_not_of('/');
615 string const tmp = path2.substr(p2start, p2end - p2start + 1);
622 string const changeExtension(string const & oldname, string const & extension)
624 string::size_type const last_slash = oldname.rfind('/');
625 string::size_type last_dot = oldname.rfind('.');
626 if (last_dot < last_slash && last_slash != string::npos)
627 last_dot = string::npos;
630 // Make sure the extension starts with a dot
631 if (!extension.empty() && extension[0] != '.')
632 ext= '.' + extension;
636 return os::internal_path(oldname.substr(0, last_dot) + ext);
640 string const removeExtension(string const & name)
642 return changeExtension(name, string());
646 string const addExtension(string const & name, string const & extension)
648 if (!extension.empty() && extension[0] != '.')
649 return name + '.' + extension;
650 return name + extension;
654 /// Return the extension of the file (not including the .)
655 string const getExtension(string const & name)
657 string::size_type const last_slash = name.rfind('/');
658 string::size_type const last_dot = name.rfind('.');
659 if (last_dot != string::npos &&
660 (last_slash == string::npos || last_dot > last_slash))
661 return name.substr(last_dot + 1,
662 name.length() - (last_dot + 1));
668 string const unzippedFileName(string const & zipped_file)
670 string const ext = getExtension(zipped_file);
671 if (ext == "gz" || ext == "z" || ext == "Z")
672 return changeExtension(zipped_file, string());
673 return onlyPath(zipped_file) + "unzipped_" + onlyFilename(zipped_file);
677 FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
679 FileName const tempfile = FileName(unzipped_file.empty() ?
680 unzippedFileName(zipped_file.toFilesystemEncoding()) :
683 string const command = "gunzip -c " +
684 zipped_file.toFilesystemEncoding() + " > " +
685 tempfile.toFilesystemEncoding();
687 one.startscript(Systemcall::Wait, command);
688 // test that command was executed successfully (anon)
689 // yes, please do. (Lgb)
694 docstring const makeDisplayPath(string const & path, unsigned int threshold)
698 // If file is from LyXDir, display it as if it were relative.
699 string const system = package().system_support().absFilename();
700 if (prefixIs(str, system) && str != system)
701 return from_utf8("[" + str.erase(0, system.length()) + "]");
703 // replace /home/blah with ~/
704 string const home = package().home_dir().absFilename();
705 if (!home.empty() && prefixIs(str, home))
706 str = subst(str, home, "~");
708 if (str.length() <= threshold)
709 return from_utf8(os::external_path(str));
711 string const prefix = ".../";
714 while (str.length() > threshold)
715 str = split(str, temp, '/');
717 // Did we shorten everything away?
719 // Yes, filename itself is too long.
720 // Pick the start and the end of the filename.
721 str = onlyFilename(path);
722 string const head = str.substr(0, threshold / 2 - 3);
724 string::size_type len = str.length();
726 str.substr(len - threshold / 2 - 2, len - 1);
727 str = head + "..." + tail;
730 return from_utf8(os::external_path(prefix + str));
734 bool readLink(FileName const & file, FileName & link)
737 char linkbuffer[512];
738 // Should be PATH_MAX but that needs autconf support
739 string const encoded = file.toFilesystemEncoding();
740 int const nRead = ::readlink(encoded.c_str(),
741 linkbuffer, sizeof(linkbuffer) - 1);
744 linkbuffer[nRead] = '\0'; // terminator
745 link = makeAbsPath(linkbuffer, onlyPath(file.absFilename()));
753 cmd_ret const runCommand(string const & cmd)
755 // FIXME: replace all calls to RunCommand with ForkedCall
756 // (if the output is not needed) or the code in ISpell.cpp
757 // (if the output is needed).
759 // One question is if we should use popen or
760 // create our own popen based on fork, exec, pipe
761 // of course the best would be to have a
762 // pstream (process stream), with the
763 // variants ipstream, opstream
765 #if defined (HAVE_POPEN)
766 FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
767 #elif defined (HAVE__POPEN)
768 FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
770 #error No popen() function.
773 // (Claus Hentschel) Check if popen was succesful ;-)
775 lyxerr << "RunCommand:: could not start child process" << endl;
776 return make_pair(-1, string());
782 ret += static_cast<char>(c);
786 #if defined (HAVE_PCLOSE)
787 int const pret = pclose(inf);
788 #elif defined (HAVE__PCLOSE)
789 int const pret = _pclose(inf);
791 #error No pclose() function.
795 perror("RunCommand:: could not terminate child process");
797 return make_pair(pret, ret);
801 FileName const findtexfile(string const & fil, string const & /*format*/)
803 /* There is no problem to extend this function too use other
804 methods to look for files. It could be setup to look
805 in environment paths and also if wanted as a last resort
806 to a recursive find. One of the easier extensions would
807 perhaps be to use the LyX file lookup methods. But! I am
808 going to implement this until I see some demand for it.
812 // If the file can be found directly, we just return a
813 // absolute path version of it.
814 FileName const absfile(makeAbsPath(fil));
815 if (absfile.exists())
818 // Now we try to find it using kpsewhich.
819 // It seems from the kpsewhich manual page that it is safe to use
820 // kpsewhich without --format: "When the --format option is not
821 // given, the search path used when looking for a file is inferred
822 // from the name given, by looking for a known extension. If no
823 // known extension is found, the search path for TeX source files
825 // However, we want to take advantage of the format sine almost all
826 // the different formats has environment variables that can be used
827 // to controll which paths to search. f.ex. bib looks in
828 // BIBINPUTS and TEXBIB. Small list follows:
829 // bib - BIBINPUTS, TEXBIB
831 // graphic/figure - TEXPICTS, TEXINPUTS
832 // ist - TEXINDEXSTYLE, INDEXSTYLE
833 // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
835 // tfm - TFMFONTS, TEXFONTS
836 // This means that to use kpsewhich in the best possible way we
837 // should help it by setting additional path in the approp. envir.var.
838 string const kpsecmd = "kpsewhich " + fil;
840 cmd_ret const c = runCommand(kpsecmd);
842 LYXERR(Debug::LATEX, "kpse status = " << c.first << '\n'
843 << "kpse result = `" << rtrim(c.second, "\n\r") << '\'');
845 return FileName(rtrim(to_utf8(from_filesystem8bit(c.second)), "\n\r"));
851 void readBB_lyxerrMessage(FileName const & file, bool & zipped,
852 string const & message)
854 LYXERR(Debug::GRAPHICS, "[readBB_from_PSFile] " << message);
855 // FIXME: Why is this func deleting a file? (Lgb)
861 string const readBB_from_PSFile(FileName const & file)
863 // in a (e)ps-file it's an entry like %%BoundingBox:23 45 321 345
864 // It seems that every command in the header has an own line,
865 // getline() should work for all files.
866 // On the other hand some plot programs write the bb at the
867 // end of the file. Than we have in the header:
868 // %%BoundingBox: (atend)
869 // In this case we must check the end.
870 bool zipped = file.isZippedFile();
871 FileName const file_ = zipped ? unzipFile(file) : file;
872 string const format = file_.guessFormatFromContents();
874 if (format != "eps" && format != "ps") {
875 readBB_lyxerrMessage(file_, zipped,"no(e)ps-format");
879 static boost::regex bbox_re(
880 "^%%BoundingBox:\\s*([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)");
881 ifstream is(file_.toFilesystemEncoding().c_str());
886 if (regex_match(s, what, bbox_re)) {
887 // Our callers expect the tokens in the string
888 // separated by single spaces.
889 // FIXME: change return type from string to something
892 os << what.str(1) << ' ' << what.str(2) << ' '
893 << what.str(3) << ' ' << what.str(4);
894 string const bb = os.str();
895 readBB_lyxerrMessage(file_, zipped, bb);
899 readBB_lyxerrMessage(file_, zipped, "no bb found");
904 int compare_timestamps(FileName const & file1, FileName const & file2)
906 // If the original is newer than the copy, then copy the original
907 // to the new directory.
910 if (file1.exists() && file2.exists()) {
911 double const tmp = difftime(file1.lastModified(), file2.lastModified());
913 cmp = tmp > 0 ? 1 : -1;
915 } else if (file1.exists()) {
917 } else if (file2.exists()) {
925 } //namespace support