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/convert.h"
27 #include "support/debug.h"
28 #include "support/environment.h"
29 #include "support/gettext.h"
30 #include "support/lstrings.h"
31 #include "support/os.h"
32 #include "support/Package.h"
33 #include "support/Path.h"
34 #include "support/Systemcall.h"
35 #include "support/qstring_helpers.h"
39 #include <boost/assert.hpp>
40 #include <boost/regex.hpp>
57 bool isLyXFilename(string const & filename)
59 return suffixIs(ascii_lowercase(filename), ".lyx");
63 bool isSGMLFilename(string const & filename)
65 return suffixIs(ascii_lowercase(filename), ".sgml");
69 bool isValidLaTeXFilename(string const & filename)
71 string const invalid_chars("#$%{}()[]\"^");
72 return filename.find_first_of(invalid_chars) == string::npos;
76 string const latex_path(string const & original_path,
77 latex_path_extension extension,
80 // On cygwin, we may need windows or posix style paths.
81 string path = os::latex_path(original_path);
82 path = subst(path, "~", "\\string~");
83 if (path.find(' ') != string::npos) {
84 // We can't use '"' because " is sometimes active (e.g. if
85 // babel is loaded with the "german" option)
86 if (extension == EXCLUDE_EXTENSION) {
87 // ChangeExtension calls os::internal_path internally
88 // so don't use it to remove the extension.
89 string const ext = getExtension(path);
90 string const base = ext.empty() ?
92 path.substr(0, path.length() - ext.length() - 1);
93 // ChangeExtension calls os::internal_path internally
94 // so don't use it to re-add the extension.
95 path = "\\string\"" + base + "\\string\"." + ext;
97 path = "\\string\"" + path + "\\string\"";
101 return dots == ESCAPE_DOTS ? subst(path, ".", "\\lyxdot ") : path;
105 // Substitutes spaces with underscores in filename (and path)
106 FileName const makeLatexName(FileName const & file)
108 string name = file.onlyFileName();
109 string const path = file.onlyPath().absFilename() + "/";
111 // ok so we scan through the string twice, but who cares.
112 // FIXME: in Unicode time this will break for sure! There is
113 // a non-latin world out there...
114 string const keep = "abcdefghijklmnopqrstuvwxyz"
115 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
116 "@!'()*+,-./0123456789:;<=>?[]`|";
118 string::size_type pos = 0;
119 while ((pos = name.find_first_not_of(keep, pos)) != string::npos)
122 FileName latex_name(path + name);
123 latex_name.changeExtension(".tex");
128 string const quoteName(string const & name, quote_style style)
132 // This does not work for filenames containing " (windows)
133 // or ' (all other OSes). This can't be changed easily, since
134 // we would need to adapt the command line parser in
135 // Forkedcall::generateChild. Therefore we don't pass user
136 // filenames to child processes if possible. We store them in
137 // a python script instead, where we don't have these
139 return (os::shell() == os::UNIX) ?
143 return "\"" + subst(subst(name, "\\", "\\\\"), "\"", "\\\"")
146 // shut up stupid compiler
152 // Uses a string of paths separated by ";"s to find a file to open.
153 // Can't cope with pathnames with a ';' in them. Returns full path to file.
154 // If path entry begins with $$LyX/, use system_lyxdir
155 // If path entry begins with $$User/, use user_lyxdir
156 // Example: "$$User/doc;$$LyX/doc"
157 FileName const fileOpenSearch(string const & path, string const & name,
162 bool notfound = true;
163 string tmppath = split(path, path_element, ';');
165 while (notfound && !path_element.empty()) {
166 path_element = os::internal_path(path_element);
167 if (!suffixIs(path_element, '/'))
169 path_element = subst(path_element, "$$LyX",
170 package().system_support().absFilename());
171 path_element = subst(path_element, "$$User",
172 package().user_support().absFilename());
174 real_file = fileSearch(path_element, name, ext);
176 if (real_file.empty()) {
178 tmppath = split(tmppath, path_element, ';');
179 } while (!tmppath.empty() && path_element.empty());
189 // Returns the real name of file name in directory path, with optional
191 FileName const fileSearch(string const & path, string const & name,
192 string const & ext, search_mode mode)
194 // if `name' is an absolute path, we ignore the setting of `path'
195 // Expand Environmentvariables in 'name'
196 string const tmpname = replaceEnvironmentPath(name);
197 FileName fullname(makeAbsPath(tmpname, path));
198 // search first without extension, then with it.
199 if (fullname.isReadableFile())
203 return mode == allow_unreadable ? fullname : FileName();
204 // Only add the extension if it is not already the extension of
206 if (getExtension(fullname.absFilename()) != ext)
207 fullname = FileName(addExtension(fullname.absFilename(), ext));
208 if (fullname.isReadableFile() || mode == allow_unreadable)
214 // Search the file name.ext in the subdirectory dir of
216 // 2) build_lyxdir (if not empty)
218 FileName const libFileSearch(string const & dir, string const & name,
221 FileName fullname = fileSearch(addPath(package().user_support().absFilename(), dir),
223 if (!fullname.empty())
226 if (!package().build_support().empty())
227 fullname = fileSearch(addPath(package().build_support().absFilename(), dir),
229 if (!fullname.empty())
232 return fileSearch(addPath(package().system_support().absFilename(), dir), name, ext);
236 FileName const i18nLibFileSearch(string const & dir, string const & name,
239 /* The highest priority value is the `LANGUAGE' environment
240 variable. But we don't use the value if the currently
241 selected locale is the C locale. This is a GNU extension.
243 Otherwise, w use a trick to guess what support/gettext.has done:
244 each po file is able to tell us its name. (JMarc)
247 string lang = to_ascii(_("[[Replace with the code of your language]]"));
248 string const language = getEnv("LANGUAGE");
249 if (!lang.empty() && !language.empty())
253 lang = split(lang, l, ':');
256 // First try with the full name
257 tmp = libFileSearch(addPath(dir, l), name, ext);
261 // Then the name without country code
262 string const shortl = token(l, '_', 0);
264 tmp = libFileSearch(addPath(dir, shortl), name, ext);
270 // For compatibility, to be removed later (JMarc)
271 tmp = libFileSearch(dir, token(l, '_', 0) + '_' + name,
274 lyxerr << "i18nLibFileSearch: File `" << tmp
275 << "' has been found by the old method" <<endl;
279 lang = split(lang, l, ':');
282 return libFileSearch(dir, name, ext);
286 string const libScriptSearch(string const & command_in, quote_style style)
288 static string const token_scriptpath = "$$s/";
290 string command = command_in;
291 // Find the starting position of "$$s/"
292 string::size_type const pos1 = command.find(token_scriptpath);
293 if (pos1 == string::npos)
295 // Find the end of the "$$s/some_subdir/some_script" word within
296 // command. Assumes that the script name does not contain spaces.
297 string::size_type const start_script = pos1 + 4;
298 string::size_type const pos2 = command.find(' ', start_script);
299 string::size_type const size_script = pos2 == string::npos?
300 (command.size() - start_script) : pos2 - start_script;
302 // Does this script file exist?
303 string const script =
304 libFileSearch(".", command.substr(start_script, size_script)).absFilename();
306 if (script.empty()) {
307 // Replace "$$s/" with ""
308 command.erase(pos1, 4);
310 // Replace "$$s/foo/some_script" with "<path to>/some_script".
311 string::size_type const size_replace = size_script + 4;
312 command.replace(pos1, size_replace, quoteName(script, style));
319 static FileName createTmpDir(FileName const & tempdir, string const & mask)
321 LYXERR(Debug::FILES, "createTmpDir: tempdir=`" << tempdir << "'\n"
322 << "createTmpDir: mask=`" << mask << '\'');
324 FileName const tmpfl = FileName::tempName(tempdir.absFilename()
326 // FileName::tempName actually creates a file to make sure that it
327 // stays unique. So we have to delete it before we can create
328 // a dir with the same name. Note also that we are not thread
329 // safe because of the gap between unlink and mkdir. (Lgb)
332 if (tmpfl.empty() || !tmpfl.createDirectory(0700)) {
333 lyxerr << "LyX could not create the temporary directory '"
334 << tmpfl << "'" << endl;
341 string const createBufferTmpDir()
344 // We are in our own directory. Why bother to mangle name?
345 // In fact I wrote this code to circumvent a problematic behaviour
346 // (bug?) of EMX mkstemp().
348 package().temp_dir().absFilename() + "/lyx_tmpbuf" +
349 convert<string>(count++);
351 if (!FileName(tmpfl).createDirectory(0777)) {
352 lyxerr << "LyX could not create the temporary directory '"
353 << tmpfl << "'" << endl;
360 FileName const createLyXTmpDir(FileName const & deflt)
362 if (deflt.empty() || deflt.absFilename() == "/tmp")
363 return createTmpDir(FileName("/tmp"), "lyx_tmpdir");
365 if (deflt.createDirectory(0777))
368 if (deflt.isDirWritable()) {
369 // deflt could not be created because it
370 // did exist already, so let's create our own
372 return createTmpDir(deflt, "lyx_tmpdir");
374 // some other error occured.
375 return createTmpDir(FileName("/tmp"), "lyx_tmpdir");
380 // Strip filename from path name
381 string const onlyPath(string const & filename)
383 // If empty filename, return empty
384 if (filename.empty())
387 // Find last / or start of filename
388 size_t j = filename.rfind('/');
389 return j == string::npos ? "./" : filename.substr(0, j + 1);
393 // Convert relative path into absolute path based on a basepath.
394 // If relpath is absolute, just use that.
395 // If basepath is empty, use CWD as base.
396 FileName const makeAbsPath(string const & relPath, string const & basePath)
398 FileName relative_path(relPath);
399 // checks for already absolute path
400 if (relative_path.isAbsolute())
401 return relative_path;
403 // Copies given paths
404 string tempRel = os::internal_path(relPath);
405 // Since TempRel is NOT absolute, we can safely replace "//" with "/"
406 tempRel = subst(tempRel, "//", "/");
410 FileName base_path(basePath);
411 if (base_path.isAbsolute())
414 tempBase = addPath(FileName::getcwd().absFilename(), basePath);
416 // Handle /./ at the end of the path
417 while (suffixIs(tempBase, "/./"))
418 tempBase.erase(tempBase.length() - 2);
420 // processes relative path
421 string rTemp = tempRel;
424 while (!rTemp.empty()) {
426 rTemp = split(rTemp, temp, '/');
428 if (temp == ".") continue;
430 // Remove one level of TempBase
431 string::difference_type i = tempBase.length() - 2;
434 while (i > 0 && tempBase[i] != '/')
437 tempBase.erase(i, string::npos);
440 } else if (temp.empty() && !rTemp.empty()) {
441 tempBase = os::current_root() + rTemp;
444 // Add this piece to TempBase
445 if (!suffixIs(tempBase, '/'))
451 // returns absolute path
452 return FileName(tempBase);
456 // Correctly append filename to the pathname.
457 // If pathname is '.', then don't use pathname.
458 // Chops any path of filename.
459 string const addName(string const & path, string const & fname)
461 string const basename = onlyFilename(fname);
464 if (path != "." && path != "./" && !path.empty()) {
465 buf = os::internal_path(path);
466 if (!suffixIs(path, '/'))
470 return buf + basename;
474 // Strips path from filename
475 string const onlyFilename(string const & fname)
480 string::size_type j = fname.rfind('/');
481 if (j == string::npos) // no '/' in fname
485 return fname.substr(j + 1);
489 // Create absolute path. If impossible, don't do anything
490 // Supports ./ and ~/. Later we can add support for ~logname/. (Asger)
491 string const expandPath(string const & path)
493 // checks for already absolute path
494 string rTemp = replaceEnvironmentPath(path);
495 FileName abs_path(rTemp);
496 if (abs_path.isAbsolute())
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 result = path;
536 regex_match(result, what, envvar_br_re);
537 if (!what[0].matched) {
538 regex_match(result, what, envvar_re);
539 if (!what[0].matched)
542 result = what.str(1) + getEnv(what.str(2)) + what.str(3);
548 // Make relative path out of two absolute paths
549 docstring const makeRelPath(docstring const & abspath, docstring const & basepath)
550 // Makes relative path out of absolute path. If it is deeper than basepath,
551 // it's easy. If basepath and abspath share something (they are all deeper
552 // than some directory), it'll be rendered using ..'s. If they are completely
553 // different, then the absolute path will be used as relative path.
555 docstring::size_type const abslen = abspath.length();
556 docstring::size_type const baselen = basepath.length();
558 docstring::size_type i = os::common_path(abspath, basepath);
561 // actually no match - cannot make it relative
565 // Count how many dirs there are in basepath above match
566 // and append as many '..''s into relpath
568 docstring::size_type j = i;
569 while (j < baselen) {
570 if (basepath[j] == '/') {
571 if (j + 1 == baselen)
578 // Append relative stuff from common directory to abspath
579 if (abspath[i] == '/')
581 for (; i < abslen; ++i)
584 if (suffixIs(buf, '/'))
585 buf.erase(buf.length() - 1);
586 // Substitute empty with .
593 // Append sub-directory(ies) to a path in an intelligent way
594 string const addPath(string const & path, string const & path_2)
597 string const path2 = os::internal_path(path_2);
599 if (!path.empty() && path != "." && path != "./") {
600 buf = os::internal_path(path);
601 if (path[path.length() - 1] != '/')
605 if (!path2.empty()) {
606 string::size_type const p2start = path2.find_first_not_of('/');
607 string::size_type const p2end = path2.find_last_not_of('/');
608 string const tmp = path2.substr(p2start, p2end - p2start + 1);
615 string const changeExtension(string const & oldname, string const & extension)
617 string::size_type const last_slash = oldname.rfind('/');
618 string::size_type last_dot = oldname.rfind('.');
619 if (last_dot < last_slash && last_slash != string::npos)
620 last_dot = string::npos;
623 // Make sure the extension starts with a dot
624 if (!extension.empty() && extension[0] != '.')
625 ext= '.' + extension;
629 return os::internal_path(oldname.substr(0, last_dot) + ext);
633 string const removeExtension(string const & name)
635 return changeExtension(name, string());
639 string const addExtension(string const & name, string const & extension)
641 if (!extension.empty() && extension[0] != '.')
642 return name + '.' + extension;
643 return name + extension;
647 /// Return the extension of the file (not including the .)
648 string const getExtension(string const & name)
650 string::size_type const last_slash = name.rfind('/');
651 string::size_type const last_dot = name.rfind('.');
652 if (last_dot != string::npos &&
653 (last_slash == string::npos || last_dot > last_slash))
654 return name.substr(last_dot + 1,
655 name.length() - (last_dot + 1));
661 string const unzippedFileName(string const & zipped_file)
663 string const ext = getExtension(zipped_file);
664 if (ext == "gz" || ext == "z" || ext == "Z")
665 return changeExtension(zipped_file, string());
666 return "unzipped_" + zipped_file;
670 FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
672 FileName const tempfile = FileName(unzipped_file.empty() ?
673 unzippedFileName(zipped_file.toFilesystemEncoding()) :
676 string const command = "gunzip -c " +
677 zipped_file.toFilesystemEncoding() + " > " +
678 tempfile.toFilesystemEncoding();
680 one.startscript(Systemcall::Wait, command);
681 // test that command was executed successfully (anon)
682 // yes, please do. (Lgb)
687 docstring const makeDisplayPath(string const & path, unsigned int threshold)
691 // If file is from LyXDir, display it as if it were relative.
692 string const system = package().system_support().absFilename();
693 if (prefixIs(str, system) && str != system)
694 return from_utf8("[" + str.erase(0, system.length()) + "]");
696 // replace /home/blah with ~/
697 string const home = package().home_dir().absFilename();
698 if (!home.empty() && prefixIs(str, home))
699 str = subst(str, home, "~");
701 if (str.length() <= threshold)
702 return from_utf8(os::external_path(str));
704 string const prefix = ".../";
707 while (str.length() > threshold)
708 str = split(str, temp, '/');
710 // Did we shorten everything away?
712 // Yes, filename itself is too long.
713 // Pick the start and the end of the filename.
714 str = onlyFilename(path);
715 string const head = str.substr(0, threshold / 2 - 3);
717 string::size_type len = str.length();
719 str.substr(len - threshold / 2 - 2, len - 1);
720 str = head + "..." + tail;
723 return from_utf8(os::external_path(prefix + str));
727 bool readLink(FileName const & file, FileName & link)
730 char linkbuffer[512];
731 // Should be PATH_MAX but that needs autconf support
732 string const encoded = file.toFilesystemEncoding();
733 int const nRead = ::readlink(encoded.c_str(),
734 linkbuffer, sizeof(linkbuffer) - 1);
737 linkbuffer[nRead] = '\0'; // terminator
738 link = makeAbsPath(linkbuffer, onlyPath(file.absFilename()));
746 cmd_ret const runCommand(string const & cmd)
748 // FIXME: replace all calls to RunCommand with ForkedCall
749 // (if the output is not needed) or the code in ISpell.cpp
750 // (if the output is needed).
752 // One question is if we should use popen or
753 // create our own popen based on fork, exec, pipe
754 // of course the best would be to have a
755 // pstream (process stream), with the
756 // variants ipstream, opstream
758 #if defined (HAVE_POPEN)
759 FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
760 #elif defined (HAVE__POPEN)
761 FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
763 #error No popen() function.
766 // (Claus Hentschel) Check if popen was succesful ;-)
768 lyxerr << "RunCommand:: could not start child process" << endl;
769 return make_pair(-1, string());
775 ret += static_cast<char>(c);
779 #if defined (HAVE_PCLOSE)
780 int const pret = pclose(inf);
781 #elif defined (HAVE__PCLOSE)
782 int const pret = _pclose(inf);
784 #error No pclose() function.
788 perror("RunCommand:: could not terminate child process");
790 return make_pair(pret, ret);
794 FileName const findtexfile(string const & fil, string const & /*format*/)
796 /* There is no problem to extend this function too use other
797 methods to look for files. It could be setup to look
798 in environment paths and also if wanted as a last resort
799 to a recursive find. One of the easier extensions would
800 perhaps be to use the LyX file lookup methods. But! I am
801 going to implement this until I see some demand for it.
805 // If the file can be found directly, we just return a
806 // absolute path version of it.
807 FileName const absfile(makeAbsPath(fil));
808 if (absfile.exists())
811 // No we try to find it using kpsewhich.
812 // It seems from the kpsewhich manual page that it is safe to use
813 // kpsewhich without --format: "When the --format option is not
814 // given, the search path used when looking for a file is inferred
815 // from the name given, by looking for a known extension. If no
816 // known extension is found, the search path for TeX source files
818 // However, we want to take advantage of the format sine almost all
819 // the different formats has environment variables that can be used
820 // to controll which paths to search. f.ex. bib looks in
821 // BIBINPUTS and TEXBIB. Small list follows:
822 // bib - BIBINPUTS, TEXBIB
824 // graphic/figure - TEXPICTS, TEXINPUTS
825 // ist - TEXINDEXSTYLE, INDEXSTYLE
826 // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
828 // tfm - TFMFONTS, TEXFONTS
829 // This means that to use kpsewhich in the best possible way we
830 // should help it by setting additional path in the approp. envir.var.
831 string const kpsecmd = "kpsewhich " + fil;
833 cmd_ret const c = runCommand(kpsecmd);
835 LYXERR(Debug::LATEX, "kpse status = " << c.first << '\n'
836 << "kpse result = `" << rtrim(c.second, "\n\r") << '\'');
838 return FileName(rtrim(to_utf8(from_filesystem8bit(c.second)), "\n\r"));
844 void removeAutosaveFile(string const & filename)
846 string a = onlyPath(filename);
848 a += onlyFilename(filename);
850 FileName const autosave(a);
851 if (autosave.exists())
852 autosave.removeFile();
856 void readBB_lyxerrMessage(FileName const & file, bool & zipped,
857 string const & message)
859 LYXERR(Debug::GRAPHICS, "[readBB_from_PSFile] " << message);
860 // FIXME: Why is this func deleting a file? (Lgb)
866 string const readBB_from_PSFile(FileName const & file)
868 // in a (e)ps-file it's an entry like %%BoundingBox:23 45 321 345
869 // It seems that every command in the header has an own line,
870 // getline() should work for all files.
871 // On the other hand some plot programs write the bb at the
872 // end of the file. Than we have in the header:
873 // %%BoundingBox: (atend)
874 // In this case we must check the end.
875 bool zipped = file.isZippedFile();
876 FileName const file_ = zipped ? unzipFile(file) : file;
877 string const format = file_.guessFormatFromContents();
879 if (format != "eps" && format != "ps") {
880 readBB_lyxerrMessage(file_, zipped,"no(e)ps-format");
884 static boost::regex bbox_re(
885 "^%%BoundingBox:\\s*([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)");
886 ifstream is(file_.toFilesystemEncoding().c_str());
891 if (regex_match(s, what, bbox_re)) {
892 // Our callers expect the tokens in the string
893 // separated by single spaces.
894 // FIXME: change return type from string to something
897 os << what.str(1) << ' ' << what.str(2) << ' '
898 << what.str(3) << ' ' << what.str(4);
899 string const bb = os.str();
900 readBB_lyxerrMessage(file_, zipped, bb);
904 readBB_lyxerrMessage(file_, zipped, "no bb found");
909 int compare_timestamps(FileName const & file1, FileName const & file2)
911 // If the original is newer than the copy, then copy the original
912 // to the new directory.
915 if (file1.exists() && file2.exists()) {
916 double const tmp = difftime(file1.lastModified(), file2.lastModified());
918 cmp = tmp > 0 ? 1 : -1;
920 } else if (file1.exists()) {
922 } else if (file2.exists()) {
930 } //namespace support