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/regex.hpp>
56 using std::ostringstream;
63 bool isLyXFilename(string const & filename)
65 return suffixIs(ascii_lowercase(filename), ".lyx");
69 bool isSGMLFilename(string const & filename)
71 return suffixIs(ascii_lowercase(filename), ".sgml");
75 bool isValidLaTeXFilename(string const & filename)
77 string const invalid_chars("#$%{}()[]\"^");
78 return filename.find_first_of(invalid_chars) == string::npos;
82 string const latex_path(string const & original_path,
83 latex_path_extension extension,
86 // On cygwin, we may need windows or posix style paths.
87 string path = os::latex_path(original_path);
88 path = subst(path, "~", "\\string~");
89 if (path.find(' ') != string::npos) {
90 // We can't use '"' because " is sometimes active (e.g. if
91 // babel is loaded with the "german" option)
92 if (extension == EXCLUDE_EXTENSION) {
93 // ChangeExtension calls os::internal_path internally
94 // so don't use it to remove the extension.
95 string const ext = getExtension(path);
96 string const base = ext.empty() ?
98 path.substr(0, path.length() - ext.length() - 1);
99 // ChangeExtension calls os::internal_path internally
100 // so don't use it to re-add the extension.
101 path = "\\string\"" + base + "\\string\"." + ext;
103 path = "\\string\"" + path + "\\string\"";
107 return dots == ESCAPE_DOTS ? subst(path, ".", "\\lyxdot ") : path;
111 // Substitutes spaces with underscores in filename (and path)
112 string const makeLatexName(string const & file)
114 string name = onlyFilename(file);
115 string const path = onlyPath(file);
117 // ok so we scan through the string twice, but who cares.
118 string const keep = "abcdefghijklmnopqrstuvwxyz"
119 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
120 "@!'()*+,-./0123456789:;<=>?[]`|";
122 string::size_type pos = 0;
123 while ((pos = name.find_first_not_of(keep, pos)) != string::npos)
126 return addName(path, name);
130 string const quoteName(string const & name, quote_style style)
134 // This does not work for filenames containing " (windows)
135 // or ' (all other OSes). This can't be changed easily, since
136 // we would need to adapt the command line parser in
137 // Forkedcall::generateChild. Therefore we don't pass user
138 // filenames to child processes if possible. We store them in
139 // a python script instead, where we don't have these
141 return (os::shell() == os::UNIX) ?
145 return "\"" + subst(subst(name, "\\", "\\\\"), "\"", "\\\"")
148 // shut up stupid compiler
154 // Uses a string of paths separated by ";"s to find a file to open.
155 // Can't cope with pathnames with a ';' in them. Returns full path to file.
156 // If path entry begins with $$LyX/, use system_lyxdir
157 // If path entry begins with $$User/, use user_lyxdir
158 // Example: "$$User/doc;$$LyX/doc"
159 FileName const fileOpenSearch(string const & path, string const & name,
164 bool notfound = true;
165 string tmppath = split(path, path_element, ';');
167 while (notfound && !path_element.empty()) {
168 path_element = os::internal_path(path_element);
169 if (!suffixIs(path_element, '/'))
171 path_element = subst(path_element, "$$LyX",
172 package().system_support().absFilename());
173 path_element = subst(path_element, "$$User",
174 package().user_support().absFilename());
176 real_file = fileSearch(path_element, name, ext);
178 if (real_file.empty()) {
180 tmppath = split(tmppath, path_element, ';');
181 } while (!tmppath.empty() && path_element.empty());
191 // Returns the real name of file name in directory path, with optional
193 FileName const fileSearch(string const & path, string const & name,
194 string const & ext, search_mode mode)
196 // if `name' is an absolute path, we ignore the setting of `path'
197 // Expand Environmentvariables in 'name'
198 string const tmpname = replaceEnvironmentPath(name);
199 FileName fullname(makeAbsPath(tmpname, path));
200 // search first without extension, then with it.
201 if (fullname.isReadableFile())
205 return mode == allow_unreadable ? fullname : FileName();
206 // Only add the extension if it is not already the extension of
208 if (getExtension(fullname.absFilename()) != ext)
209 fullname = FileName(addExtension(fullname.absFilename(), ext));
210 if (fullname.isReadableFile() || mode == allow_unreadable)
216 // Search the file name.ext in the subdirectory dir of
218 // 2) build_lyxdir (if not empty)
220 FileName const libFileSearch(string const & dir, string const & name,
223 FileName fullname = fileSearch(addPath(package().user_support().absFilename(), dir),
225 if (!fullname.empty())
228 if (!package().build_support().empty())
229 fullname = fileSearch(addPath(package().build_support().absFilename(), dir),
231 if (!fullname.empty())
234 return fileSearch(addPath(package().system_support().absFilename(), dir), name, ext);
238 FileName const i18nLibFileSearch(string const & dir, string const & name,
241 /* The highest priority value is the `LANGUAGE' environment
242 variable. But we don't use the value if the currently
243 selected locale is the C locale. This is a GNU extension.
245 Otherwise, w use a trick to guess what gettext has done:
246 each po file is able to tell us its name. (JMarc)
249 string lang = to_ascii(_("[[Replace with the code of your language]]"));
250 string const language = getEnv("LANGUAGE");
251 if (!lang.empty() && !language.empty())
255 lang = split(lang, l, ':');
258 // First try with the full name
259 tmp = libFileSearch(addPath(dir, l), name, ext);
263 // Then the name without country code
264 string const shortl = token(l, '_', 0);
266 tmp = libFileSearch(addPath(dir, shortl), name, ext);
272 // For compatibility, to be removed later (JMarc)
273 tmp = libFileSearch(dir, token(l, '_', 0) + '_' + name,
276 lyxerr << "i18nLibFileSearch: File `" << tmp
277 << "' has been found by the old method" <<endl;
281 lang = split(lang, l, ':');
284 return libFileSearch(dir, name, ext);
288 string const libScriptSearch(string const & command_in, quote_style style)
290 static string const token_scriptpath = "$$s/";
292 string command = command_in;
293 // Find the starting position of "$$s/"
294 string::size_type const pos1 = command.find(token_scriptpath);
295 if (pos1 == string::npos)
297 // Find the end of the "$$s/some_subdir/some_script" word within
298 // command. Assumes that the script name does not contain spaces.
299 string::size_type const start_script = pos1 + 4;
300 string::size_type const pos2 = command.find(' ', start_script);
301 string::size_type const size_script = pos2 == string::npos?
302 (command.size() - start_script) : pos2 - start_script;
304 // Does this script file exist?
305 string const script =
306 libFileSearch(".", command.substr(start_script, size_script)).absFilename();
308 if (script.empty()) {
309 // Replace "$$s/" with ""
310 command.erase(pos1, 4);
312 // Replace "$$s/foo/some_script" with "<path to>/some_script".
313 string::size_type const size_replace = size_script + 4;
314 command.replace(pos1, size_replace, quoteName(script, style));
321 static FileName createTmpDir(FileName const & tempdir, string const & mask)
323 LYXERR(Debug::FILES, "createTmpDir: tempdir=`" << tempdir << "'\n"
324 << "createTmpDir: mask=`" << mask << '\'');
326 FileName const tmpfl(tempName(tempdir, mask));
327 // lyx::tempName actually creates a file to make sure that it
328 // stays unique. So we have to delete it before we can create
329 // a dir with the same name. Note also that we are not thread
330 // safe because of the gap between unlink and mkdir. (Lgb)
333 if (tmpfl.empty() || mkdir(tmpfl, 0700)) {
334 lyxerr << "LyX could not create the temporary directory '"
335 << tmpfl << "'" << endl;
342 string const createBufferTmpDir()
345 // We are in our own directory. Why bother to mangle name?
346 // In fact I wrote this code to circumvent a problematic behaviour
347 // (bug?) of EMX mkstemp().
349 package().temp_dir().absFilename() + "/lyx_tmpbuf" +
350 convert<string>(count++);
352 if (mkdir(FileName(tmpfl), 0777)) {
353 lyxerr << "LyX could not create the temporary directory '"
354 << tmpfl << "'" << endl;
361 FileName const createLyXTmpDir(FileName const & deflt)
363 if (deflt.empty() || deflt.absFilename() == "/tmp")
364 return createTmpDir(FileName("/tmp"), "lyx_tmpdir");
366 if (!mkdir(deflt, 0777))
369 if (deflt.isDirWritable()) {
370 // deflt could not be created because it
371 // did exist already, so let's create our own
373 return createTmpDir(deflt, "lyx_tmpdir");
375 // some other error occured.
376 return createTmpDir(FileName("/tmp"), "lyx_tmpdir");
381 // Strip filename from path name
382 string const onlyPath(string const & filename)
384 // If empty filename, return empty
385 if (filename.empty())
388 // Find last / or start of filename
389 size_t j = filename.rfind('/');
390 return j == string::npos ? "./" : filename.substr(0, j + 1);
394 // Convert relative path into absolute path based on a basepath.
395 // If relpath is absolute, just use that.
396 // If basepath is empty, use CWD as base.
397 FileName const makeAbsPath(string const & relPath, string const & basePath)
399 // checks for already absolute path
400 if (os::is_absolute_path(relPath))
401 return FileName(relPath);
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 if (os::is_absolute_path(basePath))
413 tempBase = addPath(getcwd().absFilename(), basePath);
415 // Handle /./ at the end of the path
416 while (suffixIs(tempBase, "/./"))
417 tempBase.erase(tempBase.length() - 2);
419 // processes relative path
420 string rTemp = tempRel;
423 while (!rTemp.empty()) {
425 rTemp = split(rTemp, temp, '/');
427 if (temp == ".") continue;
429 // Remove one level of TempBase
430 string::difference_type i = tempBase.length() - 2;
433 while (i > 0 && tempBase[i] != '/')
436 tempBase.erase(i, string::npos);
439 } else if (temp.empty() && !rTemp.empty()) {
440 tempBase = os::current_root() + rTemp;
443 // Add this piece to TempBase
444 if (!suffixIs(tempBase, '/'))
450 // returns absolute path
451 return FileName(os::internal_path(tempBase));
455 // Correctly append filename to the pathname.
456 // If pathname is '.', then don't use pathname.
457 // Chops any path of filename.
458 string const addName(string const & path, string const & fname)
460 string const basename = onlyFilename(fname);
463 if (path != "." && path != "./" && !path.empty()) {
464 buf = os::internal_path(path);
465 if (!suffixIs(path, '/'))
469 return buf + basename;
473 // Strips path from filename
474 string const onlyFilename(string const & fname)
479 string::size_type j = fname.rfind('/');
480 if (j == string::npos) // no '/' in fname
484 return fname.substr(j + 1);
488 /// Returns true is path is absolute
489 bool absolutePath(string const & path)
491 return os::is_absolute_path(path);
495 // Create absolute path. If impossible, don't do anything
496 // Supports ./ and ~/. Later we can add support for ~logname/. (Asger)
497 string const expandPath(string const & path)
499 // checks for already absolute path
500 string rTemp = replaceEnvironmentPath(path);
501 if (os::is_absolute_path(rTemp))
505 string const copy = rTemp;
508 rTemp = split(rTemp, temp, '/');
511 return getcwd().absFilename() + '/' + rTemp;
514 return package().home_dir().absFilename() + '/' + rTemp;
517 return makeAbsPath(copy).absFilename();
519 // Don't know how to handle this
524 // Search the string for ${VAR} and $VAR and replace VAR using getenv.
525 string const replaceEnvironmentPath(string const & path)
527 // ${VAR} is defined as
528 // $\{[A-Za-z_][A-Za-z_0-9]*\}
529 static string const envvar_br = "[$]\\{([A-Za-z_][A-Za-z_0-9]*)\\}";
531 // $VAR is defined as:
532 // $\{[A-Za-z_][A-Za-z_0-9]*\}
533 static string const envvar = "[$]([A-Za-z_][A-Za-z_0-9]*)";
535 static boost::regex envvar_br_re("(.*)" + envvar_br + "(.*)");
536 static boost::regex envvar_re("(.*)" + envvar + "(.*)");
539 string result = path;
541 regex_match(result, what, envvar_br_re);
542 if (!what[0].matched) {
543 regex_match(result, what, envvar_re);
544 if (!what[0].matched)
547 result = what.str(1) + getEnv(what.str(2)) + what.str(3);
553 // Make relative path out of two absolute paths
554 docstring const makeRelPath(docstring const & abspath, docstring const & basepath)
555 // Makes relative path out of absolute path. If it is deeper than basepath,
556 // it's easy. If basepath and abspath share something (they are all deeper
557 // than some directory), it'll be rendered using ..'s. If they are completely
558 // different, then the absolute path will be used as relative path.
560 docstring::size_type const abslen = abspath.length();
561 docstring::size_type const baselen = basepath.length();
563 docstring::size_type i = os::common_path(abspath, basepath);
566 // actually no match - cannot make it relative
570 // Count how many dirs there are in basepath above match
571 // and append as many '..''s into relpath
573 docstring::size_type j = i;
574 while (j < baselen) {
575 if (basepath[j] == '/') {
576 if (j + 1 == baselen)
583 // Append relative stuff from common directory to abspath
584 if (abspath[i] == '/')
586 for (; i < abslen; ++i)
589 if (suffixIs(buf, '/'))
590 buf.erase(buf.length() - 1);
591 // Substitute empty with .
598 // Append sub-directory(ies) to a path in an intelligent way
599 string const addPath(string const & path, string const & path_2)
602 string const path2 = os::internal_path(path_2);
604 if (!path.empty() && path != "." && path != "./") {
605 buf = os::internal_path(path);
606 if (path[path.length() - 1] != '/')
610 if (!path2.empty()) {
611 string::size_type const p2start = path2.find_first_not_of('/');
612 string::size_type const p2end = path2.find_last_not_of('/');
613 string const tmp = path2.substr(p2start, p2end - p2start + 1);
620 string const changeExtension(string const & oldname, string const & extension)
622 string::size_type const last_slash = oldname.rfind('/');
623 string::size_type last_dot = oldname.rfind('.');
624 if (last_dot < last_slash && last_slash != string::npos)
625 last_dot = string::npos;
628 // Make sure the extension starts with a dot
629 if (!extension.empty() && extension[0] != '.')
630 ext= '.' + extension;
634 return os::internal_path(oldname.substr(0, last_dot) + ext);
638 string const removeExtension(string const & name)
640 return changeExtension(name, string());
644 string const addExtension(string const & name, string const & extension)
646 if (!extension.empty() && extension[0] != '.')
647 return name + '.' + extension;
648 return name + extension;
652 /// Return the extension of the file (not including the .)
653 string const getExtension(string const & name)
655 string::size_type const last_slash = name.rfind('/');
656 string::size_type const last_dot = name.rfind('.');
657 if (last_dot != string::npos &&
658 (last_slash == string::npos || last_dot > last_slash))
659 return name.substr(last_dot + 1,
660 name.length() - (last_dot + 1));
666 string const unzippedFileName(string const & zipped_file)
668 string const ext = getExtension(zipped_file);
669 if (ext == "gz" || ext == "z" || ext == "Z")
670 return changeExtension(zipped_file, string());
671 return "unzipped_" + zipped_file;
675 FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
677 FileName const tempfile = FileName(unzipped_file.empty() ?
678 unzippedFileName(zipped_file.toFilesystemEncoding()) :
681 string const command = "gunzip -c " +
682 zipped_file.toFilesystemEncoding() + " > " +
683 tempfile.toFilesystemEncoding();
685 one.startscript(Systemcall::Wait, command);
686 // test that command was executed successfully (anon)
687 // yes, please do. (Lgb)
692 docstring const makeDisplayPath(string const & path, unsigned int threshold)
696 // If file is from LyXDir, display it as if it were relative.
697 string const system = package().system_support().absFilename();
698 if (prefixIs(str, system) && str != system)
699 return from_utf8("[" + str.erase(0, system.length()) + "]");
701 // replace /home/blah with ~/
702 string const home = package().home_dir().absFilename();
703 if (!home.empty() && prefixIs(str, home))
704 str = subst(str, home, "~");
706 if (str.length() <= threshold)
707 return from_utf8(os::external_path(str));
709 string const prefix = ".../";
712 while (str.length() > threshold)
713 str = split(str, temp, '/');
715 // Did we shorten everything away?
717 // Yes, filename itself is too long.
718 // Pick the start and the end of the filename.
719 str = onlyFilename(path);
720 string const head = str.substr(0, threshold / 2 - 3);
722 string::size_type len = str.length();
724 str.substr(len - threshold / 2 - 2, len - 1);
725 str = head + "..." + tail;
728 return from_utf8(os::external_path(prefix + str));
732 bool readLink(FileName const & file, FileName & link)
735 char linkbuffer[512];
736 // Should be PATH_MAX but that needs autconf support
737 string const encoded = file.toFilesystemEncoding();
738 int const nRead = ::readlink(encoded.c_str(),
739 linkbuffer, sizeof(linkbuffer) - 1);
742 linkbuffer[nRead] = '\0'; // terminator
743 link = makeAbsPath(linkbuffer, onlyPath(file.absFilename()));
751 cmd_ret const runCommand(string const & cmd)
753 // FIXME: replace all calls to RunCommand with ForkedCall
754 // (if the output is not needed) or the code in ISpell.cpp
755 // (if the output is needed).
757 // One question is if we should use popen or
758 // create our own popen based on fork, exec, pipe
759 // of course the best would be to have a
760 // pstream (process stream), with the
761 // variants ipstream, opstream
763 #if defined (HAVE_POPEN)
764 FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
765 #elif defined (HAVE__POPEN)
766 FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
768 #error No popen() function.
771 // (Claus Hentschel) Check if popen was succesful ;-)
773 lyxerr << "RunCommand:: could not start child process" << endl;
774 return make_pair(-1, string());
780 ret += static_cast<char>(c);
784 #if defined (HAVE_PCLOSE)
785 int const pret = pclose(inf);
786 #elif defined (HAVE__PCLOSE)
787 int const pret = _pclose(inf);
789 #error No pclose() function.
793 perror("RunCommand:: could not terminate child process");
795 return make_pair(pret, ret);
799 FileName const findtexfile(string const & fil, string const & /*format*/)
801 /* There is no problem to extend this function too use other
802 methods to look for files. It could be setup to look
803 in environment paths and also if wanted as a last resort
804 to a recursive find. One of the easier extensions would
805 perhaps be to use the LyX file lookup methods. But! I am
806 going to implement this until I see some demand for it.
810 // If the file can be found directly, we just return a
811 // absolute path version of it.
812 FileName const absfile(makeAbsPath(fil));
813 if (absfile.exists())
816 // No we try to find it using kpsewhich.
817 // It seems from the kpsewhich manual page that it is safe to use
818 // kpsewhich without --format: "When the --format option is not
819 // given, the search path used when looking for a file is inferred
820 // from the name given, by looking for a known extension. If no
821 // known extension is found, the search path for TeX source files
823 // However, we want to take advantage of the format sine almost all
824 // the different formats has environment variables that can be used
825 // to controll which paths to search. f.ex. bib looks in
826 // BIBINPUTS and TEXBIB. Small list follows:
827 // bib - BIBINPUTS, TEXBIB
829 // graphic/figure - TEXPICTS, TEXINPUTS
830 // ist - TEXINDEXSTYLE, INDEXSTYLE
831 // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
833 // tfm - TFMFONTS, TEXFONTS
834 // This means that to use kpsewhich in the best possible way we
835 // should help it by setting additional path in the approp. envir.var.
836 string const kpsecmd = "kpsewhich " + fil;
838 cmd_ret const c = runCommand(kpsecmd);
840 LYXERR(Debug::LATEX, "kpse status = " << c.first << '\n'
841 << "kpse result = `" << rtrim(c.second, "\n\r") << '\'');
843 return FileName(os::internal_path(rtrim(to_utf8(from_filesystem8bit(c.second)),
850 void removeAutosaveFile(string const & filename)
852 string a = onlyPath(filename);
854 a += onlyFilename(filename);
856 FileName const autosave(a);
857 if (autosave.exists())
862 void readBB_lyxerrMessage(FileName const & file, bool & zipped,
863 string const & message)
865 LYXERR(Debug::GRAPHICS, "[readBB_from_PSFile] " << message);
866 // FIXME: Why is this func deleting a file? (Lgb)
872 string const readBB_from_PSFile(FileName const & file)
874 // in a (e)ps-file it's an entry like %%BoundingBox:23 45 321 345
875 // It seems that every command in the header has an own line,
876 // getline() should work for all files.
877 // On the other hand some plot programs write the bb at the
878 // end of the file. Than we have in the header:
879 // %%BoundingBox: (atend)
880 // In this case we must check the end.
881 bool zipped = file.isZippedFile();
882 FileName const file_ = zipped ? unzipFile(file) : file;
883 string const format = file_.guessFormatFromContents();
885 if (format != "eps" && format != "ps") {
886 readBB_lyxerrMessage(file_, zipped,"no(e)ps-format");
890 static boost::regex bbox_re(
891 "^%%BoundingBox:\\s*([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)");
892 std::ifstream is(file_.toFilesystemEncoding().c_str());
897 if (regex_match(s, what, bbox_re)) {
898 // Our callers expect the tokens in the string
899 // separated by single spaces.
900 // FIXME: change return type from string to something
903 os << what.str(1) << ' ' << what.str(2) << ' '
904 << what.str(3) << ' ' << what.str(4);
905 string const bb = os.str();
906 readBB_lyxerrMessage(file_, zipped, bb);
910 readBB_lyxerrMessage(file_, zipped, "no bb found");
915 int compare_timestamps(FileName const & file1, FileName const & file2)
917 // If the original is newer than the copy, then copy the original
918 // to the new directory.
921 if (file1.exists() && file2.exists()) {
922 double const tmp = difftime(file1.lastModified(), file2.lastModified());
924 cmp = tmp > 0 ? 1 : -1;
926 } else if (file1.exists()) {
928 } else if (file2.exists()) {
935 } //namespace support