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 "support/lassert.h"
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 == may_not_exist ? 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 == may_not_exist)
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, mask);
326 if (tmpfl.empty() || !tmpfl.createDirectory(0700)) {
327 LYXERR0("LyX could not create temporary directory in " << tempdir
336 FileName const createLyXTmpDir(FileName const & deflt)
338 if (deflt.empty() || deflt == package().system_temp_dir())
339 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
341 if (deflt.createDirectory(0777))
344 if (deflt.isDirWritable()) {
345 // deflt could not be created because it
346 // did exist already, so let's create our own
348 return createTmpDir(deflt, "lyx_tmpdir");
350 // some other error occured.
351 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
356 // Strip filename from path name
357 string const onlyPath(string const & filename)
359 // If empty filename, return empty
360 if (filename.empty())
363 // Find last / or start of filename
364 size_t j = filename.rfind('/');
365 return j == string::npos ? "./" : filename.substr(0, j + 1);
369 // Convert relative path into absolute path based on a basepath.
370 // If relpath is absolute, just use that.
371 // If basepath is empty, use CWD as base.
372 // Note that basePath can be a relative path, in the sense that it may
373 // not begin with "/" (e.g.), but it should NOT contain such constructs
375 // FIXME It might be nice if the code didn't simply assume that.
376 FileName const makeAbsPath(string const & relPath, string const & basePath)
378 FileName relative_path(relPath);
379 // checks for already absolute path
380 if (relative_path.isAbsolute())
381 return relative_path;
383 // Copies given paths
384 string tempRel = os::internal_path(relPath);
385 // Since TempRel is NOT absolute, we can safely replace "//" with "/"
386 tempRel = subst(tempRel, "//", "/");
390 FileName base_path(basePath);
391 if (base_path.isAbsolute())
394 tempBase = addPath(FileName::getcwd().absFilename(), basePath);
396 // Handle /./ at the end of the path
397 while (suffixIs(tempBase, "/./"))
398 tempBase.erase(tempBase.length() - 2);
400 // processes relative path
401 string rTemp = tempRel;
404 // Check for a leading "~"
406 rTemp = split(rTemp, temp, '/');
408 tempBase = package().home_dir().absFilename();
413 while (!rTemp.empty()) {
415 rTemp = split(rTemp, temp, '/');
417 if (temp == ".") continue;
419 // Remove one level of TempBase
420 if (tempBase.length() <= 1) {
421 //this is supposed to be an absolute path, so...
425 //erase a trailing slash if there is one
426 if (suffixIs(tempBase, "/"))
427 tempBase.erase(tempBase.length() - 1, string::npos);
429 string::size_type i = tempBase.length() - 1;
430 while (i > 0 && tempBase[i] != '/')
433 tempBase.erase(i, string::npos);
436 } else if (temp.empty() && !rTemp.empty()) {
437 tempBase = os::current_root() + rTemp;
440 // Add this piece to TempBase
441 if (!suffixIs(tempBase, '/'))
447 // returns absolute path
448 return FileName(tempBase);
452 // Correctly append filename to the pathname.
453 // If pathname is '.', then don't use pathname.
454 // Chops any path of filename.
455 string const addName(string const & path, string const & fname)
457 string const basename = onlyFilename(fname);
460 if (path != "." && path != "./" && !path.empty()) {
461 buf = os::internal_path(path);
462 if (!suffixIs(path, '/'))
466 return buf + basename;
470 // Strips path from filename
471 string const onlyFilename(string const & fname)
476 string::size_type j = fname.rfind('/');
477 if (j == string::npos) // no '/' in fname
481 return fname.substr(j + 1);
485 // Create absolute path. If impossible, don't do anything
486 // Supports ./ and ~/. Later we can add support for ~logname/. (Asger)
487 string const expandPath(string const & path)
489 // checks for already absolute path
490 string rTemp = replaceEnvironmentPath(path);
491 FileName abs_path(rTemp);
492 if (abs_path.isAbsolute())
496 string const copy = rTemp;
499 rTemp = split(rTemp, temp, '/');
502 return FileName::getcwd().absFilename() + '/' + rTemp;
505 return package().home_dir().absFilename() + '/' + rTemp;
508 return makeAbsPath(copy).absFilename();
510 // Don't know how to handle this
515 // Search the string for ${VAR} and $VAR and replace VAR using getenv.
516 string const replaceEnvironmentPath(string const & path)
518 // ${VAR} is defined as
519 // $\{[A-Za-z_][A-Za-z_0-9]*\}
520 static string const envvar_br = "[$]\\{([A-Za-z_][A-Za-z_0-9]*)\\}";
522 // $VAR is defined as:
523 // $\{[A-Za-z_][A-Za-z_0-9]*\}
524 static string const envvar = "[$]([A-Za-z_][A-Za-z_0-9]*)";
526 static boost::regex envvar_br_re("(.*)" + envvar_br + "(.*)");
527 static boost::regex envvar_re("(.*)" + envvar + "(.*)");
530 string result = path;
532 regex_match(result, what, envvar_br_re);
533 if (!what[0].matched) {
534 regex_match(result, what, envvar_re);
535 if (!what[0].matched)
538 result = what.str(1) + getEnv(what.str(2)) + what.str(3);
544 // Make relative path out of two absolute paths
545 docstring const makeRelPath(docstring const & abspath, docstring const & basepath)
546 // Makes relative path out of absolute path. If it is deeper than basepath,
547 // it's easy. If basepath and abspath share something (they are all deeper
548 // than some directory), it'll be rendered using ..'s. If they are completely
549 // different, then the absolute path will be used as relative path.
551 docstring::size_type const abslen = abspath.length();
552 docstring::size_type const baselen = basepath.length();
554 docstring::size_type i = os::common_path(abspath, basepath);
557 // actually no match - cannot make it relative
561 // Count how many dirs there are in basepath above match
562 // and append as many '..''s into relpath
564 docstring::size_type j = i;
565 while (j < baselen) {
566 if (basepath[j] == '/') {
567 if (j + 1 == baselen)
574 // Append relative stuff from common directory to abspath
575 if (abspath[i] == '/')
577 for (; i < abslen; ++i)
580 if (suffixIs(buf, '/'))
581 buf.erase(buf.length() - 1);
582 // Substitute empty with .
589 // Append sub-directory(ies) to a path in an intelligent way
590 string const addPath(string const & path, string const & path_2)
593 string const path2 = os::internal_path(path_2);
595 if (!path.empty() && path != "." && path != "./") {
596 buf = os::internal_path(path);
597 if (path[path.length() - 1] != '/')
601 if (!path2.empty()) {
602 string::size_type const p2start = path2.find_first_not_of('/');
603 string::size_type const p2end = path2.find_last_not_of('/');
604 string const tmp = path2.substr(p2start, p2end - p2start + 1);
611 string const changeExtension(string const & oldname, string const & extension)
613 string::size_type const last_slash = oldname.rfind('/');
614 string::size_type last_dot = oldname.rfind('.');
615 if (last_dot < last_slash && last_slash != string::npos)
616 last_dot = string::npos;
619 // Make sure the extension starts with a dot
620 if (!extension.empty() && extension[0] != '.')
621 ext= '.' + extension;
625 return os::internal_path(oldname.substr(0, last_dot) + ext);
629 string const removeExtension(string const & name)
631 return changeExtension(name, string());
635 string const addExtension(string const & name, string const & extension)
637 if (!extension.empty() && extension[0] != '.')
638 return name + '.' + extension;
639 return name + extension;
643 /// Return the extension of the file (not including the .)
644 string const getExtension(string const & name)
646 string::size_type const last_slash = name.rfind('/');
647 string::size_type const last_dot = name.rfind('.');
648 if (last_dot != string::npos &&
649 (last_slash == string::npos || last_dot > last_slash))
650 return name.substr(last_dot + 1,
651 name.length() - (last_dot + 1));
657 string const unzippedFileName(string const & zipped_file)
659 string const ext = getExtension(zipped_file);
660 if (ext == "gz" || ext == "z" || ext == "Z")
661 return changeExtension(zipped_file, string());
662 return onlyPath(zipped_file) + "unzipped_" + onlyFilename(zipped_file);
666 FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
668 FileName const tempfile = FileName(unzipped_file.empty() ?
669 unzippedFileName(zipped_file.toFilesystemEncoding()) :
672 string const command = "gunzip -c " +
673 zipped_file.toFilesystemEncoding() + " > " +
674 tempfile.toFilesystemEncoding();
676 one.startscript(Systemcall::Wait, command);
677 // test that command was executed successfully (anon)
678 // yes, please do. (Lgb)
683 docstring const makeDisplayPath(string const & path, unsigned int threshold)
687 // If file is from LyXDir, display it as if it were relative.
688 string const system = package().system_support().absFilename();
689 if (prefixIs(str, system) && str != system)
690 return from_utf8("[" + str.erase(0, system.length()) + "]");
692 // replace /home/blah with ~/
693 string const home = package().home_dir().absFilename();
694 if (!home.empty() && prefixIs(str, home))
695 str = subst(str, home, "~");
697 if (str.length() <= threshold)
698 return from_utf8(os::external_path(str));
700 string const prefix = ".../";
703 while (str.length() > threshold)
704 str = split(str, temp, '/');
706 // Did we shorten everything away?
708 // Yes, filename itself is too long.
709 // Pick the start and the end of the filename.
710 str = onlyFilename(path);
711 string const head = str.substr(0, threshold / 2 - 3);
713 string::size_type len = str.length();
715 str.substr(len - threshold / 2 - 2, len - 1);
716 str = head + "..." + tail;
719 return from_utf8(os::external_path(prefix + str));
723 bool readLink(FileName const & file, FileName & link)
726 char linkbuffer[512];
727 // Should be PATH_MAX but that needs autconf support
728 string const encoded = file.toFilesystemEncoding();
729 int const nRead = ::readlink(encoded.c_str(),
730 linkbuffer, sizeof(linkbuffer) - 1);
733 linkbuffer[nRead] = '\0'; // terminator
734 link = makeAbsPath(linkbuffer, onlyPath(file.absFilename()));
742 cmd_ret const runCommand(string const & cmd)
744 // FIXME: replace all calls to RunCommand with ForkedCall
745 // (if the output is not needed) or the code in ISpell.cpp
746 // (if the output is needed).
748 // One question is if we should use popen or
749 // create our own popen based on fork, exec, pipe
750 // of course the best would be to have a
751 // pstream (process stream), with the
752 // variants ipstream, opstream
754 #if defined (HAVE_POPEN)
755 FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
756 #elif defined (HAVE__POPEN)
757 FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
759 #error No popen() function.
762 // (Claus Hentschel) Check if popen was succesful ;-)
764 lyxerr << "RunCommand:: could not start child process" << endl;
765 return make_pair(-1, string());
771 ret += static_cast<char>(c);
775 #if defined (HAVE_PCLOSE)
776 int const pret = pclose(inf);
777 #elif defined (HAVE__PCLOSE)
778 int const pret = _pclose(inf);
780 #error No pclose() function.
784 perror("RunCommand:: could not terminate child process");
786 return make_pair(pret, ret);
790 FileName const findtexfile(string const & fil, string const & /*format*/)
792 /* There is no problem to extend this function too use other
793 methods to look for files. It could be setup to look
794 in environment paths and also if wanted as a last resort
795 to a recursive find. One of the easier extensions would
796 perhaps be to use the LyX file lookup methods. But! I am
797 going to implement this until I see some demand for it.
801 // If the file can be found directly, we just return a
802 // absolute path version of it.
803 FileName const absfile(makeAbsPath(fil));
804 if (absfile.exists())
807 // Now we try to find it using kpsewhich.
808 // It seems from the kpsewhich manual page that it is safe to use
809 // kpsewhich without --format: "When the --format option is not
810 // given, the search path used when looking for a file is inferred
811 // from the name given, by looking for a known extension. If no
812 // known extension is found, the search path for TeX source files
814 // However, we want to take advantage of the format sine almost all
815 // the different formats has environment variables that can be used
816 // to controll which paths to search. f.ex. bib looks in
817 // BIBINPUTS and TEXBIB. Small list follows:
818 // bib - BIBINPUTS, TEXBIB
820 // graphic/figure - TEXPICTS, TEXINPUTS
821 // ist - TEXINDEXSTYLE, INDEXSTYLE
822 // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
824 // tfm - TFMFONTS, TEXFONTS
825 // This means that to use kpsewhich in the best possible way we
826 // should help it by setting additional path in the approp. envir.var.
827 string const kpsecmd = "kpsewhich " + fil;
829 cmd_ret const c = runCommand(kpsecmd);
831 LYXERR(Debug::LATEX, "kpse status = " << c.first << '\n'
832 << "kpse result = `" << rtrim(c.second, "\n\r") << '\'');
834 return FileName(rtrim(to_utf8(from_filesystem8bit(c.second)), "\n\r"));
840 void removeAutosaveFile(string const & filename)
842 string a = onlyPath(filename);
844 a += onlyFilename(filename);
846 FileName const autosave(a);
847 if (autosave.exists())
848 autosave.removeFile();
852 void readBB_lyxerrMessage(FileName const & file, bool & zipped,
853 string const & message)
855 LYXERR(Debug::GRAPHICS, "[readBB_from_PSFile] " << message);
856 // FIXME: Why is this func deleting a file? (Lgb)
862 string const readBB_from_PSFile(FileName const & file)
864 // in a (e)ps-file it's an entry like %%BoundingBox:23 45 321 345
865 // It seems that every command in the header has an own line,
866 // getline() should work for all files.
867 // On the other hand some plot programs write the bb at the
868 // end of the file. Than we have in the header:
869 // %%BoundingBox: (atend)
870 // In this case we must check the end.
871 bool zipped = file.isZippedFile();
872 FileName const file_ = zipped ? unzipFile(file) : file;
873 string const format = file_.guessFormatFromContents();
875 if (format != "eps" && format != "ps") {
876 readBB_lyxerrMessage(file_, zipped,"no(e)ps-format");
880 static boost::regex bbox_re(
881 "^%%BoundingBox:\\s*([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)");
882 ifstream is(file_.toFilesystemEncoding().c_str());
887 if (regex_match(s, what, bbox_re)) {
888 // Our callers expect the tokens in the string
889 // separated by single spaces.
890 // FIXME: change return type from string to something
893 os << what.str(1) << ' ' << what.str(2) << ' '
894 << what.str(3) << ' ' << what.str(4);
895 string const bb = os.str();
896 readBB_lyxerrMessage(file_, zipped, bb);
900 readBB_lyxerrMessage(file_, zipped, "no bb found");
905 int compare_timestamps(FileName const & file1, FileName const & file2)
907 // If the original is newer than the copy, then copy the original
908 // to the new directory.
911 if (file1.exists() && file2.exists()) {
912 double const tmp = difftime(file1.lastModified(), file2.lastModified());
914 cmp = tmp > 0 ? 1 : -1;
916 } else if (file1.exists()) {
918 } else if (file2.exists()) {
926 } //namespace support