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/convert.h"
25 #include "support/environment.h"
26 #include "support/filetools.h"
27 #include "support/lstrings.h"
28 #include "support/lyxlib.h"
29 #include "support/os.h"
30 #include "support/Package.h"
31 #include "support/Path.h"
32 #include "support/Systemcall.h"
34 // FIXME Interface violation
38 #include <boost/assert.hpp>
39 #include <boost/filesystem/operations.hpp>
40 #include <boost/regex.hpp>
57 using std::ostringstream;
61 namespace fs = boost::filesystem;
66 bool isLyXFilename(string const & filename)
68 return suffixIs(ascii_lowercase(filename), ".lyx");
72 bool isSGMLFilename(string const & filename)
74 return suffixIs(ascii_lowercase(filename), ".sgml");
78 bool isValidLaTeXFilename(string const & filename)
80 string const invalid_chars("#$%{}()[]\"^");
81 return filename.find_first_of(invalid_chars) == string::npos;
85 string const latex_path(string const & original_path,
86 latex_path_extension extension,
89 // On cygwin, we may need windows or posix style paths.
90 string path = os::latex_path(original_path);
91 path = subst(path, "~", "\\string~");
92 if (path.find(' ') != string::npos) {
93 // We can't use '"' because " is sometimes active (e.g. if
94 // babel is loaded with the "german" option)
95 if (extension == EXCLUDE_EXTENSION) {
96 // ChangeExtension calls os::internal_path internally
97 // so don't use it to remove the extension.
98 string const ext = getExtension(path);
99 string const base = ext.empty() ?
101 path.substr(0, path.length() - ext.length() - 1);
102 // ChangeExtension calls os::internal_path internally
103 // so don't use it to re-add the extension.
104 path = "\\string\"" + base + "\\string\"." + ext;
106 path = "\\string\"" + path + "\\string\"";
110 return dots == ESCAPE_DOTS ? subst(path, ".", "\\lyxdot ") : path;
114 // Substitutes spaces with underscores in filename (and path)
115 string const makeLatexName(string const & file)
117 string name = onlyFilename(file);
118 string const path = onlyPath(file);
120 // ok so we scan through the string twice, but who cares.
121 string const keep = "abcdefghijklmnopqrstuvwxyz"
122 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
123 "@!'()*+,-./0123456789:;<=>?[]`|";
125 string::size_type pos = 0;
126 while ((pos = name.find_first_not_of(keep, pos)) != string::npos)
129 return addName(path, name);
133 string const quoteName(string const & name, quote_style style)
137 // This does not work for filenames containing " (windows)
138 // or ' (all other OSes). This can't be changed easily, since
139 // we would need to adapt the command line parser in
140 // Forkedcall::generateChild. Therefore we don't pass user
141 // filenames to child processes if possible. We store them in
142 // a python script instead, where we don't have these
144 return (os::shell() == os::UNIX) ?
148 return "\"" + subst(subst(name, "\\", "\\\\"), "\"", "\\\"")
151 // shut up stupid compiler
157 // Uses a string of paths separated by ";"s to find a file to open.
158 // Can't cope with pathnames with a ';' in them. Returns full path to file.
159 // If path entry begins with $$LyX/, use system_lyxdir
160 // If path entry begins with $$User/, use user_lyxdir
161 // Example: "$$User/doc;$$LyX/doc"
162 FileName const fileOpenSearch(string const & path, string const & name,
167 bool notfound = true;
168 string tmppath = split(path, path_element, ';');
170 while (notfound && !path_element.empty()) {
171 path_element = os::internal_path(path_element);
172 if (!suffixIs(path_element, '/'))
174 path_element = subst(path_element, "$$LyX",
175 package().system_support().absFilename());
176 path_element = subst(path_element, "$$User",
177 package().user_support().absFilename());
179 real_file = fileSearch(path_element, name, ext);
181 if (real_file.empty()) {
183 tmppath = split(tmppath, path_element, ';');
184 } while (!tmppath.empty() && path_element.empty());
194 // Returns the real name of file name in directory path, with optional
196 FileName const fileSearch(string const & path, string const & name,
197 string const & ext, search_mode mode)
199 // if `name' is an absolute path, we ignore the setting of `path'
200 // Expand Environmentvariables in 'name'
201 string const tmpname = replaceEnvironmentPath(name);
202 FileName fullname(makeAbsPath(tmpname, path));
203 // search first without extension, then with it.
204 if (fullname.isReadableFile())
208 return mode == allow_unreadable ? fullname : FileName();
209 // Only add the extension if it is not already the extension of
211 if (getExtension(fullname.absFilename()) != ext)
212 fullname = FileName(addExtension(fullname.absFilename(), ext));
213 if (fullname.isReadableFile() || mode == allow_unreadable)
219 // Search the file name.ext in the subdirectory dir of
221 // 2) build_lyxdir (if not empty)
223 FileName const libFileSearch(string const & dir, string const & name,
226 FileName fullname = fileSearch(addPath(package().user_support().absFilename(), dir),
228 if (!fullname.empty())
231 if (!package().build_support().empty())
232 fullname = fileSearch(addPath(package().build_support().absFilename(), dir),
234 if (!fullname.empty())
237 return fileSearch(addPath(package().system_support().absFilename(), dir), name, ext);
241 FileName const i18nLibFileSearch(string const & dir, string const & name,
244 /* The highest priority value is the `LANGUAGE' environment
245 variable. But we don't use the value if the currently
246 selected locale is the C locale. This is a GNU extension.
248 Otherwise, w use a trick to guess what gettext has done:
249 each po file is able to tell us its name. (JMarc)
252 string lang = to_ascii(_("[[Replace with the code of your language]]"));
253 string const language = getEnv("LANGUAGE");
254 if (!lang.empty() && !language.empty())
258 lang = split(lang, l, ':');
261 // First try with the full name
262 tmp = libFileSearch(addPath(dir, l), name, ext);
266 // Then the name without country code
267 string const shortl = token(l, '_', 0);
269 tmp = libFileSearch(addPath(dir, shortl), name, ext);
275 // For compatibility, to be removed later (JMarc)
276 tmp = libFileSearch(dir, token(l, '_', 0) + '_' + name,
279 lyxerr << "i18nLibFileSearch: File `" << tmp
280 << "' has been found by the old method" <<endl;
284 lang = split(lang, l, ':');
287 return libFileSearch(dir, name, ext);
291 string const libScriptSearch(string const & command_in, quote_style style)
293 static string const token_scriptpath = "$$s/";
295 string command = command_in;
296 // Find the starting position of "$$s/"
297 string::size_type const pos1 = command.find(token_scriptpath);
298 if (pos1 == string::npos)
300 // Find the end of the "$$s/some_subdir/some_script" word within
301 // command. Assumes that the script name does not contain spaces.
302 string::size_type const start_script = pos1 + 4;
303 string::size_type const pos2 = command.find(' ', start_script);
304 string::size_type const size_script = pos2 == string::npos?
305 (command.size() - start_script) : pos2 - start_script;
307 // Does this script file exist?
308 string const script =
309 libFileSearch(".", command.substr(start_script, size_script)).absFilename();
311 if (script.empty()) {
312 // Replace "$$s/" with ""
313 command.erase(pos1, 4);
315 // Replace "$$s/foo/some_script" with "<path to>/some_script".
316 string::size_type const size_replace = size_script + 4;
317 command.replace(pos1, size_replace, quoteName(script, style));
324 static FileName createTmpDir(FileName const & tempdir, string const & mask)
326 LYXERR(Debug::FILES, "createTmpDir: tempdir=`" << tempdir << "'\n"
327 << "createTmpDir: mask=`" << mask << '\'');
329 FileName const tmpfl(tempName(tempdir, mask));
330 // lyx::tempName actually creates a file to make sure that it
331 // stays unique. So we have to delete it before we can create
332 // a dir with the same name. Note also that we are not thread
333 // safe because of the gap between unlink and mkdir. (Lgb)
336 if (tmpfl.empty() || mkdir(tmpfl, 0700)) {
337 lyxerr << "LyX could not create the temporary directory '"
338 << tmpfl << "'" << endl;
345 string const createBufferTmpDir()
348 // We are in our own directory. Why bother to mangle name?
349 // In fact I wrote this code to circumvent a problematic behaviour
350 // (bug?) of EMX mkstemp().
352 package().temp_dir().absFilename() + "/lyx_tmpbuf" +
353 convert<string>(count++);
355 if (mkdir(FileName(tmpfl), 0777)) {
356 lyxerr << "LyX could not create the temporary directory '"
357 << tmpfl << "'" << endl;
364 FileName const createLyXTmpDir(FileName const & deflt)
366 if (deflt.empty() || deflt.absFilename() == "/tmp")
367 return createTmpDir(FileName("/tmp"), "lyx_tmpdir");
369 if (!mkdir(deflt, 0777))
372 if (deflt.isDirWritable()) {
373 // deflt could not be created because it
374 // did exist already, so let's create our own
376 return createTmpDir(deflt, "lyx_tmpdir");
378 // some other error occured.
379 return createTmpDir(FileName("/tmp"), "lyx_tmpdir");
384 // Strip filename from path name
385 string const onlyPath(string const & filename)
387 // If empty filename, return empty
388 if (filename.empty())
391 // Find last / or start of filename
392 size_t j = filename.rfind('/');
393 return j == string::npos ? "./" : filename.substr(0, j + 1);
397 // Convert relative path into absolute path based on a basepath.
398 // If relpath is absolute, just use that.
399 // If basepath is empty, use CWD as base.
400 FileName const makeAbsPath(string const & relPath, string const & basePath)
402 // checks for already absolute path
403 if (os::is_absolute_path(relPath))
404 return FileName(relPath);
406 // Copies given paths
407 string tempRel = os::internal_path(relPath);
408 // Since TempRel is NOT absolute, we can safely replace "//" with "/"
409 tempRel = subst(tempRel, "//", "/");
413 if (os::is_absolute_path(basePath))
416 tempBase = addPath(getcwd().absFilename(), basePath);
418 // Handle /./ at the end of the path
419 while (suffixIs(tempBase, "/./"))
420 tempBase.erase(tempBase.length() - 2);
422 // processes relative path
423 string rTemp = tempRel;
426 while (!rTemp.empty()) {
428 rTemp = split(rTemp, temp, '/');
430 if (temp == ".") continue;
432 // Remove one level of TempBase
433 string::difference_type i = tempBase.length() - 2;
436 while (i > 0 && tempBase[i] != '/')
439 tempBase.erase(i, string::npos);
442 } else if (temp.empty() && !rTemp.empty()) {
443 tempBase = os::current_root() + rTemp;
446 // Add this piece to TempBase
447 if (!suffixIs(tempBase, '/'))
453 // returns absolute path
454 return FileName(os::internal_path(tempBase));
458 // Correctly append filename to the pathname.
459 // If pathname is '.', then don't use pathname.
460 // Chops any path of filename.
461 string const addName(string const & path, string const & fname)
463 string const basename = onlyFilename(fname);
466 if (path != "." && path != "./" && !path.empty()) {
467 buf = os::internal_path(path);
468 if (!suffixIs(path, '/'))
472 return buf + basename;
476 // Strips path from filename
477 string const onlyFilename(string const & fname)
482 string::size_type j = fname.rfind('/');
483 if (j == string::npos) // no '/' in fname
487 return fname.substr(j + 1);
491 /// Returns true is path is absolute
492 bool absolutePath(string const & path)
494 return os::is_absolute_path(path);
498 // Create absolute path. If impossible, don't do anything
499 // Supports ./ and ~/. Later we can add support for ~logname/. (Asger)
500 string const expandPath(string const & path)
502 // checks for already absolute path
503 string rTemp = replaceEnvironmentPath(path);
504 if (os::is_absolute_path(rTemp))
508 string const copy = rTemp;
511 rTemp = split(rTemp, temp, '/');
514 return getcwd().absFilename() + '/' + rTemp;
517 return package().home_dir().absFilename() + '/' + rTemp;
520 return makeAbsPath(copy).absFilename();
522 // Don't know how to handle this
527 // Normalize a path. Constracts path/../path
528 // Can't handle "../../" or "/../" (Asger)
529 // Also converts paths like /foo//bar ==> /foo/bar
530 string const normalizePath(string const & path)
532 // Normalize paths like /foo//bar ==> /foo/bar
533 static boost::regex regex("/{2,}");
534 string const tmppath = boost::regex_merge(path, regex, "/");
536 fs::path const npath = fs::path(tmppath, fs::no_check).normalize();
538 if (!npath.is_complete())
539 return "./" + npath.string() + '/';
541 return npath.string() + '/';
545 // Search the string for ${VAR} and $VAR and replace VAR using getenv.
546 string const replaceEnvironmentPath(string const & path)
548 // ${VAR} is defined as
549 // $\{[A-Za-z_][A-Za-z_0-9]*\}
550 static string const envvar_br = "[$]\\{([A-Za-z_][A-Za-z_0-9]*)\\}";
552 // $VAR is defined as:
553 // $\{[A-Za-z_][A-Za-z_0-9]*\}
554 static string const envvar = "[$]([A-Za-z_][A-Za-z_0-9]*)";
556 static boost::regex envvar_br_re("(.*)" + envvar_br + "(.*)");
557 static boost::regex envvar_re("(.*)" + envvar + "(.*)");
560 string result = path;
562 regex_match(result, what, envvar_br_re);
563 if (!what[0].matched) {
564 regex_match(result, what, envvar_re);
565 if (!what[0].matched)
568 result = what.str(1) + getEnv(what.str(2)) + what.str(3);
574 // Make relative path out of two absolute paths
575 docstring const makeRelPath(docstring const & abspath, docstring const & basepath)
576 // Makes relative path out of absolute path. If it is deeper than basepath,
577 // it's easy. If basepath and abspath share something (they are all deeper
578 // than some directory), it'll be rendered using ..'s. If they are completely
579 // different, then the absolute path will be used as relative path.
581 docstring::size_type const abslen = abspath.length();
582 docstring::size_type const baselen = basepath.length();
584 docstring::size_type i = os::common_path(abspath, basepath);
587 // actually no match - cannot make it relative
591 // Count how many dirs there are in basepath above match
592 // and append as many '..''s into relpath
594 docstring::size_type j = i;
595 while (j < baselen) {
596 if (basepath[j] == '/') {
597 if (j + 1 == baselen)
604 // Append relative stuff from common directory to abspath
605 if (abspath[i] == '/')
607 for (; i < abslen; ++i)
610 if (suffixIs(buf, '/'))
611 buf.erase(buf.length() - 1);
612 // Substitute empty with .
619 // Append sub-directory(ies) to a path in an intelligent way
620 string const addPath(string const & path, string const & path_2)
623 string const path2 = os::internal_path(path_2);
625 if (!path.empty() && path != "." && path != "./") {
626 buf = os::internal_path(path);
627 if (path[path.length() - 1] != '/')
631 if (!path2.empty()) {
632 string::size_type const p2start = path2.find_first_not_of('/');
633 string::size_type const p2end = path2.find_last_not_of('/');
634 string const tmp = path2.substr(p2start, p2end - p2start + 1);
641 string const changeExtension(string const & oldname, string const & extension)
643 string::size_type const last_slash = oldname.rfind('/');
644 string::size_type last_dot = oldname.rfind('.');
645 if (last_dot < last_slash && last_slash != string::npos)
646 last_dot = string::npos;
649 // Make sure the extension starts with a dot
650 if (!extension.empty() && extension[0] != '.')
651 ext= '.' + extension;
655 return os::internal_path(oldname.substr(0, last_dot) + ext);
659 string const removeExtension(string const & name)
661 return changeExtension(name, string());
665 string const addExtension(string const & name, string const & extension)
667 if (!extension.empty() && extension[0] != '.')
668 return name + '.' + extension;
669 return name + extension;
673 /// Return the extension of the file (not including the .)
674 string const getExtension(string const & name)
676 string::size_type const last_slash = name.rfind('/');
677 string::size_type const last_dot = name.rfind('.');
678 if (last_dot != string::npos &&
679 (last_slash == string::npos || last_dot > last_slash))
680 return name.substr(last_dot + 1,
681 name.length() - (last_dot + 1));
687 string const unzippedFileName(string const & zipped_file)
689 string const ext = getExtension(zipped_file);
690 if (ext == "gz" || ext == "z" || ext == "Z")
691 return changeExtension(zipped_file, string());
692 return "unzipped_" + zipped_file;
696 FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
698 FileName const tempfile = FileName(unzipped_file.empty() ?
699 unzippedFileName(zipped_file.toFilesystemEncoding()) :
702 string const command = "gunzip -c " +
703 zipped_file.toFilesystemEncoding() + " > " +
704 tempfile.toFilesystemEncoding();
706 one.startscript(Systemcall::Wait, command);
707 // test that command was executed successfully (anon)
708 // yes, please do. (Lgb)
713 docstring const makeDisplayPath(string const & path, unsigned int threshold)
717 // If file is from LyXDir, display it as if it were relative.
718 string const system = package().system_support().absFilename();
719 if (prefixIs(str, system) && str != system)
720 return from_utf8("[" + str.erase(0, system.length()) + "]");
722 // replace /home/blah with ~/
723 string const home = package().home_dir().absFilename();
724 if (!home.empty() && prefixIs(str, home))
725 str = subst(str, home, "~");
727 if (str.length() <= threshold)
728 return from_utf8(os::external_path(str));
730 string const prefix = ".../";
733 while (str.length() > threshold)
734 str = split(str, temp, '/');
736 // Did we shorten everything away?
738 // Yes, filename itself is too long.
739 // Pick the start and the end of the filename.
740 str = onlyFilename(path);
741 string const head = str.substr(0, threshold / 2 - 3);
743 string::size_type len = str.length();
745 str.substr(len - threshold / 2 - 2, len - 1);
746 str = head + "..." + tail;
749 return from_utf8(os::external_path(prefix + str));
753 bool readLink(FileName const & file, FileName & link)
756 char linkbuffer[512];
757 // Should be PATH_MAX but that needs autconf support
758 string const encoded = file.toFilesystemEncoding();
759 int const nRead = ::readlink(encoded.c_str(),
760 linkbuffer, sizeof(linkbuffer) - 1);
763 linkbuffer[nRead] = '\0'; // terminator
764 link = makeAbsPath(linkbuffer, onlyPath(file.absFilename()));
772 cmd_ret const runCommand(string const & cmd)
774 // FIXME: replace all calls to RunCommand with ForkedCall
775 // (if the output is not needed) or the code in ISpell.cpp
776 // (if the output is needed).
778 // One question is if we should use popen or
779 // create our own popen based on fork, exec, pipe
780 // of course the best would be to have a
781 // pstream (process stream), with the
782 // variants ipstream, opstream
784 #if defined (HAVE_POPEN)
785 FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
786 #elif defined (HAVE__POPEN)
787 FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
789 #error No popen() function.
792 // (Claus Hentschel) Check if popen was succesful ;-)
794 lyxerr << "RunCommand:: could not start child process" << endl;
795 return make_pair(-1, string());
801 ret += static_cast<char>(c);
805 #if defined (HAVE_PCLOSE)
806 int const pret = pclose(inf);
807 #elif defined (HAVE__PCLOSE)
808 int const pret = _pclose(inf);
810 #error No pclose() function.
814 perror("RunCommand:: could not terminate child process");
816 return make_pair(pret, ret);
820 FileName const findtexfile(string const & fil, string const & /*format*/)
822 /* There is no problem to extend this function too use other
823 methods to look for files. It could be setup to look
824 in environment paths and also if wanted as a last resort
825 to a recursive find. One of the easier extensions would
826 perhaps be to use the LyX file lookup methods. But! I am
827 going to implement this until I see some demand for it.
831 // If the file can be found directly, we just return a
832 // absolute path version of it.
833 FileName const absfile(makeAbsPath(fil));
834 if (absfile.exists())
837 // No we try to find it using kpsewhich.
838 // It seems from the kpsewhich manual page that it is safe to use
839 // kpsewhich without --format: "When the --format option is not
840 // given, the search path used when looking for a file is inferred
841 // from the name given, by looking for a known extension. If no
842 // known extension is found, the search path for TeX source files
844 // However, we want to take advantage of the format sine almost all
845 // the different formats has environment variables that can be used
846 // to controll which paths to search. f.ex. bib looks in
847 // BIBINPUTS and TEXBIB. Small list follows:
848 // bib - BIBINPUTS, TEXBIB
850 // graphic/figure - TEXPICTS, TEXINPUTS
851 // ist - TEXINDEXSTYLE, INDEXSTYLE
852 // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
854 // tfm - TFMFONTS, TEXFONTS
855 // This means that to use kpsewhich in the best possible way we
856 // should help it by setting additional path in the approp. envir.var.
857 string const kpsecmd = "kpsewhich " + fil;
859 cmd_ret const c = runCommand(kpsecmd);
861 LYXERR(Debug::LATEX, "kpse status = " << c.first << '\n'
862 << "kpse result = `" << rtrim(c.second, "\n\r") << '\'');
864 return FileName(os::internal_path(rtrim(to_utf8(from_filesystem8bit(c.second)),
871 void removeAutosaveFile(string const & filename)
873 string a = onlyPath(filename);
875 a += onlyFilename(filename);
877 FileName const autosave(a);
878 if (autosave.exists())
883 void readBB_lyxerrMessage(FileName const & file, bool & zipped,
884 string const & message)
886 LYXERR(Debug::GRAPHICS, "[readBB_from_PSFile] " << message);
887 // FIXME: Why is this func deleting a file? (Lgb)
893 string const readBB_from_PSFile(FileName const & file)
895 // in a (e)ps-file it's an entry like %%BoundingBox:23 45 321 345
896 // It seems that every command in the header has an own line,
897 // getline() should work for all files.
898 // On the other hand some plot programs write the bb at the
899 // end of the file. Than we have in the header:
900 // %%BoundingBox: (atend)
901 // In this case we must check the end.
902 bool zipped = file.isZippedFile();
903 FileName const file_ = zipped ? unzipFile(file) : file;
904 string const format = file_.guessFormatFromContents();
906 if (format != "eps" && format != "ps") {
907 readBB_lyxerrMessage(file_, zipped,"no(e)ps-format");
911 static boost::regex bbox_re(
912 "^%%BoundingBox:\\s*([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)");
913 std::ifstream is(file_.toFilesystemEncoding().c_str());
918 if (regex_match(s, what, bbox_re)) {
919 // Our callers expect the tokens in the string
920 // separated by single spaces.
921 // FIXME: change return type from string to something
924 os << what.str(1) << ' ' << what.str(2) << ' '
925 << what.str(3) << ' ' << what.str(4);
926 string const bb = os.str();
927 readBB_lyxerrMessage(file_, zipped, bb);
931 readBB_lyxerrMessage(file_, zipped, "no bb found");
936 int compare_timestamps(FileName const & file1, FileName const & file2)
938 // If the original is newer than the copy, then copy the original
939 // to the new directory.
942 if (file1.exists() && file2.exists()) {
943 double const tmp = difftime(file1.lastModified(), file2.lastModified());
945 cmp = tmp > 0 ? 1 : -1;
947 } else if (file1.exists()) {
949 } else if (file2.exists()) {
956 } //namespace support