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 // checks for already absolute path
379 if (FileName::isAbsolute(relPath))
380 return FileName(relPath);
382 // Copies given paths
383 string tempRel = os::internal_path(relPath);
384 // Since TempRel is NOT absolute, we can safely replace "//" with "/"
385 tempRel = subst(tempRel, "//", "/");
389 if (FileName::isAbsolute(basePath))
392 tempBase = addPath(FileName::getcwd().absFilename(), basePath);
394 // Handle /./ at the end of the path
395 while (suffixIs(tempBase, "/./"))
396 tempBase.erase(tempBase.length() - 2);
398 // processes relative path
399 string rTemp = tempRel;
402 // Check for a leading "~"
404 rTemp = split(rTemp, temp, '/');
406 tempBase = package().home_dir().absFilename();
411 while (!rTemp.empty()) {
413 rTemp = split(rTemp, temp, '/');
415 if (temp == ".") continue;
417 // Remove one level of TempBase
418 if (tempBase.length() <= 1) {
419 //this is supposed to be an absolute path, so...
423 //erase a trailing slash if there is one
424 if (suffixIs(tempBase, "/"))
425 tempBase.erase(tempBase.length() - 1, string::npos);
427 string::size_type i = tempBase.length() - 1;
428 while (i > 0 && tempBase[i] != '/')
431 tempBase.erase(i, string::npos);
434 } else if (temp.empty() && !rTemp.empty()) {
435 tempBase = os::current_root() + rTemp;
438 // Add this piece to TempBase
439 if (!suffixIs(tempBase, '/'))
445 // returns absolute path
446 return FileName(tempBase);
450 // Correctly append filename to the pathname.
451 // If pathname is '.', then don't use pathname.
452 // Chops any path of filename.
453 string const addName(string const & path, string const & fname)
455 string const basename = onlyFilename(fname);
458 if (path != "." && path != "./" && !path.empty()) {
459 buf = os::internal_path(path);
460 if (!suffixIs(path, '/'))
464 return buf + basename;
468 // Strips path from filename
469 string const onlyFilename(string const & fname)
474 string::size_type j = fname.rfind('/');
475 if (j == string::npos) // no '/' in fname
479 return fname.substr(j + 1);
483 // Create absolute path. If impossible, don't do anything
484 // Supports ./ and ~/. Later we can add support for ~logname/. (Asger)
485 string const expandPath(string const & path)
487 // checks for already absolute path
488 string rTemp = replaceEnvironmentPath(path);
489 if (FileName::isAbsolute(rTemp))
493 string const copy = rTemp;
496 rTemp = split(rTemp, temp, '/');
499 return FileName::getcwd().absFilename() + '/' + rTemp;
502 return package().home_dir().absFilename() + '/' + rTemp;
505 return makeAbsPath(copy).absFilename();
507 // Don't know how to handle this
512 // Search the string for ${VAR} and $VAR and replace VAR using getenv.
513 string const replaceEnvironmentPath(string const & path)
515 // ${VAR} is defined as
516 // $\{[A-Za-z_][A-Za-z_0-9]*\}
517 static string const envvar_br = "[$]\\{([A-Za-z_][A-Za-z_0-9]*)\\}";
519 // $VAR is defined as:
520 // $\{[A-Za-z_][A-Za-z_0-9]*\}
521 static string const envvar = "[$]([A-Za-z_][A-Za-z_0-9]*)";
523 static boost::regex envvar_br_re("(.*)" + envvar_br + "(.*)");
524 static boost::regex envvar_re("(.*)" + envvar + "(.*)");
527 string result = path;
529 regex_match(result, what, envvar_br_re);
530 if (!what[0].matched) {
531 regex_match(result, what, envvar_re);
532 if (!what[0].matched)
535 result = what.str(1) + getEnv(what.str(2)) + what.str(3);
541 // Make relative path out of two absolute paths
542 docstring const makeRelPath(docstring const & abspath, docstring const & basepath)
543 // Makes relative path out of absolute path. If it is deeper than basepath,
544 // it's easy. If basepath and abspath share something (they are all deeper
545 // than some directory), it'll be rendered using ..'s. If they are completely
546 // different, then the absolute path will be used as relative path.
548 docstring::size_type const abslen = abspath.length();
549 docstring::size_type const baselen = basepath.length();
551 docstring::size_type i = os::common_path(abspath, basepath);
554 // actually no match - cannot make it relative
558 // Count how many dirs there are in basepath above match
559 // and append as many '..''s into relpath
561 docstring::size_type j = i;
562 while (j < baselen) {
563 if (basepath[j] == '/') {
564 if (j + 1 == baselen)
571 // Append relative stuff from common directory to abspath
572 if (abspath[i] == '/')
574 for (; i < abslen; ++i)
577 if (suffixIs(buf, '/'))
578 buf.erase(buf.length() - 1);
579 // Substitute empty with .
586 // Append sub-directory(ies) to a path in an intelligent way
587 string const addPath(string const & path, string const & path_2)
590 string const path2 = os::internal_path(path_2);
592 if (!path.empty() && path != "." && path != "./") {
593 buf = os::internal_path(path);
594 if (path[path.length() - 1] != '/')
598 if (!path2.empty()) {
599 string::size_type const p2start = path2.find_first_not_of('/');
600 string::size_type const p2end = path2.find_last_not_of('/');
601 string const tmp = path2.substr(p2start, p2end - p2start + 1);
608 string const changeExtension(string const & oldname, string const & extension)
610 string::size_type const last_slash = oldname.rfind('/');
611 string::size_type last_dot = oldname.rfind('.');
612 if (last_dot < last_slash && last_slash != string::npos)
613 last_dot = string::npos;
616 // Make sure the extension starts with a dot
617 if (!extension.empty() && extension[0] != '.')
618 ext= '.' + extension;
622 return os::internal_path(oldname.substr(0, last_dot) + ext);
626 string const removeExtension(string const & name)
628 return changeExtension(name, string());
632 string const addExtension(string const & name, string const & extension)
634 if (!extension.empty() && extension[0] != '.')
635 return name + '.' + extension;
636 return name + extension;
640 /// Return the extension of the file (not including the .)
641 string const getExtension(string const & name)
643 string::size_type const last_slash = name.rfind('/');
644 string::size_type const last_dot = name.rfind('.');
645 if (last_dot != string::npos &&
646 (last_slash == string::npos || last_dot > last_slash))
647 return name.substr(last_dot + 1,
648 name.length() - (last_dot + 1));
654 string const unzippedFileName(string const & zipped_file)
656 string const ext = getExtension(zipped_file);
657 if (ext == "gz" || ext == "z" || ext == "Z")
658 return changeExtension(zipped_file, string());
659 return onlyPath(zipped_file) + "unzipped_" + onlyFilename(zipped_file);
663 FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
665 FileName const tempfile = FileName(unzipped_file.empty() ?
666 unzippedFileName(zipped_file.toFilesystemEncoding()) :
669 string const command = "gunzip -c " +
670 zipped_file.toFilesystemEncoding() + " > " +
671 tempfile.toFilesystemEncoding();
673 one.startscript(Systemcall::Wait, command);
674 // test that command was executed successfully (anon)
675 // yes, please do. (Lgb)
680 docstring const makeDisplayPath(string const & path, unsigned int threshold)
684 // If file is from LyXDir, display it as if it were relative.
685 string const system = package().system_support().absFilename();
686 if (prefixIs(str, system) && str != system)
687 return from_utf8("[" + str.erase(0, system.length()) + "]");
689 // replace /home/blah with ~/
690 string const home = package().home_dir().absFilename();
691 if (!home.empty() && prefixIs(str, home))
692 str = subst(str, home, "~");
694 if (str.length() <= threshold)
695 return from_utf8(os::external_path(str));
697 string const prefix = ".../";
700 while (str.length() > threshold)
701 str = split(str, temp, '/');
703 // Did we shorten everything away?
705 // Yes, filename itself is too long.
706 // Pick the start and the end of the filename.
707 str = onlyFilename(path);
708 string const head = str.substr(0, threshold / 2 - 3);
710 string::size_type len = str.length();
712 str.substr(len - threshold / 2 - 2, len - 1);
713 str = head + "..." + tail;
716 return from_utf8(os::external_path(prefix + str));
720 bool readLink(FileName const & file, FileName & link)
723 char linkbuffer[512];
724 // Should be PATH_MAX but that needs autconf support
725 string const encoded = file.toFilesystemEncoding();
726 int const nRead = ::readlink(encoded.c_str(),
727 linkbuffer, sizeof(linkbuffer) - 1);
730 linkbuffer[nRead] = '\0'; // terminator
731 link = makeAbsPath(linkbuffer, onlyPath(file.absFilename()));
739 cmd_ret const runCommand(string const & cmd)
741 // FIXME: replace all calls to RunCommand with ForkedCall
742 // (if the output is not needed) or the code in ISpell.cpp
743 // (if the output is needed).
745 // One question is if we should use popen or
746 // create our own popen based on fork, exec, pipe
747 // of course the best would be to have a
748 // pstream (process stream), with the
749 // variants ipstream, opstream
751 #if defined (HAVE_POPEN)
752 FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
753 #elif defined (HAVE__POPEN)
754 FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
756 #error No popen() function.
759 // (Claus Hentschel) Check if popen was succesful ;-)
761 lyxerr << "RunCommand:: could not start child process" << endl;
762 return make_pair(-1, string());
768 ret += static_cast<char>(c);
772 #if defined (HAVE_PCLOSE)
773 int const pret = pclose(inf);
774 #elif defined (HAVE__PCLOSE)
775 int const pret = _pclose(inf);
777 #error No pclose() function.
781 perror("RunCommand:: could not terminate child process");
783 return make_pair(pret, ret);
787 FileName const findtexfile(string const & fil, string const & /*format*/)
789 /* There is no problem to extend this function too use other
790 methods to look for files. It could be setup to look
791 in environment paths and also if wanted as a last resort
792 to a recursive find. One of the easier extensions would
793 perhaps be to use the LyX file lookup methods. But! I am
794 going to implement this until I see some demand for it.
798 // If the file can be found directly, we just return a
799 // absolute path version of it.
800 FileName const absfile(makeAbsPath(fil));
801 if (absfile.exists())
804 // Now we try to find it using kpsewhich.
805 // It seems from the kpsewhich manual page that it is safe to use
806 // kpsewhich without --format: "When the --format option is not
807 // given, the search path used when looking for a file is inferred
808 // from the name given, by looking for a known extension. If no
809 // known extension is found, the search path for TeX source files
811 // However, we want to take advantage of the format sine almost all
812 // the different formats has environment variables that can be used
813 // to controll which paths to search. f.ex. bib looks in
814 // BIBINPUTS and TEXBIB. Small list follows:
815 // bib - BIBINPUTS, TEXBIB
817 // graphic/figure - TEXPICTS, TEXINPUTS
818 // ist - TEXINDEXSTYLE, INDEXSTYLE
819 // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
821 // tfm - TFMFONTS, TEXFONTS
822 // This means that to use kpsewhich in the best possible way we
823 // should help it by setting additional path in the approp. envir.var.
824 string const kpsecmd = "kpsewhich " + fil;
826 cmd_ret const c = runCommand(kpsecmd);
828 LYXERR(Debug::LATEX, "kpse status = " << c.first << '\n'
829 << "kpse result = `" << rtrim(c.second, "\n\r") << '\'');
831 return FileName(rtrim(to_utf8(from_filesystem8bit(c.second)), "\n\r"));
837 void readBB_lyxerrMessage(FileName const & file, bool & zipped,
838 string const & message)
840 LYXERR(Debug::GRAPHICS, "[readBB_from_PSFile] " << message);
841 // FIXME: Why is this func deleting a file? (Lgb)
847 string const readBB_from_PSFile(FileName const & file)
849 // in a (e)ps-file it's an entry like %%BoundingBox:23 45 321 345
850 // It seems that every command in the header has an own line,
851 // getline() should work for all files.
852 // On the other hand some plot programs write the bb at the
853 // end of the file. Than we have in the header:
854 // %%BoundingBox: (atend)
855 // In this case we must check the end.
856 bool zipped = file.isZippedFile();
857 FileName const file_ = zipped ? unzipFile(file) : file;
858 string const format = file_.guessFormatFromContents();
860 if (format != "eps" && format != "ps") {
861 readBB_lyxerrMessage(file_, zipped,"no(e)ps-format");
865 static boost::regex bbox_re(
866 "^%%BoundingBox:\\s*([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)");
867 ifstream is(file_.toFilesystemEncoding().c_str());
872 if (regex_match(s, what, bbox_re)) {
873 // Our callers expect the tokens in the string
874 // separated by single spaces.
875 // FIXME: change return type from string to something
878 os << what.str(1) << ' ' << what.str(2) << ' '
879 << what.str(3) << ' ' << what.str(4);
880 string const bb = os.str();
881 readBB_lyxerrMessage(file_, zipped, bb);
885 readBB_lyxerrMessage(file_, zipped, "no bb found");
890 int compare_timestamps(FileName const & file1, FileName const & file2)
892 // If the original is newer than the copy, then copy the original
893 // to the new directory.
896 if (file1.exists() && file2.exists()) {
897 double const tmp = difftime(file1.lastModified(), file2.lastModified());
899 cmp = tmp > 0 ? 1 : -1;
901 } else if (file1.exists()) {
903 } else if (file2.exists()) {
911 } //namespace support