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
27 #include "support/filetools.h"
29 #include "support/convert.h"
30 #include "support/debug.h"
31 #include "support/environment.h"
32 #include "support/gettext.h"
33 #include "support/lstrings.h"
34 #include "support/os.h"
35 #include "support/Messages.h"
36 #include "support/Package.h"
37 #include "support/PathChanger.h"
38 #include "support/Systemcall.h"
39 #include "support/qstring_helpers.h"
40 #include "support/TempFile.h"
44 #include "support/lassert.h"
45 #include "support/regex.h"
77 bool isLyXFileName(string const & filename)
79 return suffixIs(ascii_lowercase(filename), ".lyx");
83 bool isSGMLFileName(string const & filename)
85 return suffixIs(ascii_lowercase(filename), ".sgml");
89 bool isValidLaTeXFileName(string const & filename)
91 string const invalid_chars("#%\"");
92 return filename.find_first_of(invalid_chars) == string::npos;
96 bool isValidDVIFileName(string const & filename)
98 string const invalid_chars("${}()[]^");
99 return filename.find_first_of(invalid_chars) == string::npos;
103 bool isBinaryFile(FileName const & filename)
105 bool isbinary = false;
106 if (filename.empty() || !filename.exists())
110 magic_t magic_cookie = magic_open(MAGIC_MIME_ENCODING);
112 bool detected = true;
113 if (magic_load(magic_cookie, nullptr) != 0) {
114 LYXERR(Debug::FILES, "isBinaryFile: "
115 "Could not load magic database - "
116 << magic_error(magic_cookie));
119 char const *charset = magic_file(magic_cookie,
120 filename.toFilesystemEncoding().c_str());
121 isbinary = contains(charset, "binary");
123 magic_close(magic_cookie);
128 // Try by looking for binary chars at the beginning of the file.
129 // Note that this is formally not correct, since count_bin_chars
130 // expects utf8, and the passed string can be anything: plain text
131 // in any encoding, or really binary data. In practice it works,
132 // since QString::fromUtf8() drops invalid utf8 sequences, and
133 // while the exact number may not be correct, we still get a high
134 // number for truly binary files.
136 ifstream ifs(filename.toFilesystemEncoding().c_str());
140 // Maximum strings to read
141 int const max_count = 50;
143 // Maximum number of binary chars allowed
144 int const max_bin = 5;
149 while (count++ < max_count && !ifs.eof()) {
151 binchars += count_bin_chars(str);
153 return binchars > max_bin;
157 string const latex_path(string const & original_path,
158 latex_path_extension extension,
159 latex_path_dots dots)
161 // On cygwin, we may need windows or posix style paths.
162 string path = os::latex_path(original_path);
163 path = subst(path, "~", "\\string~");
164 if (path.find(' ') != string::npos) {
165 // We can't use '"' because " is sometimes active (e.g. if
166 // babel is loaded with the "german" option)
167 if (extension == EXCLUDE_EXTENSION) {
168 // changeExtension calls os::internal_path internally
169 // so don't use it to remove the extension.
170 string const ext = getExtension(path);
171 string const base = ext.empty() ?
173 path.substr(0, path.length() - ext.length() - 1);
174 // changeExtension calls os::internal_path internally
175 // so don't use it to re-add the extension.
176 path = "\\string\"" + base + "\\string\"." + ext;
178 path = "\\string\"" + path + "\\string\"";
182 if (dots != ESCAPE_DOTS)
185 // Replace dots with the lyxdot macro, but only in the file name,
186 // not the directory part.
187 // addName etc call os::internal_path internally
188 // so don't use them for path manipulation
189 // The directory separator is always '/' for LaTeX.
190 string::size_type pos = path.rfind('/');
191 if (pos == string::npos)
192 return subst(path, ".", "\\lyxdot ");
193 return path.substr(0, pos) + subst(path.substr(pos), ".", "\\lyxdot ");
197 // Substitutes spaces with underscores in filename (and path)
198 FileName const makeLatexName(FileName const & file)
200 string name = file.onlyFileName();
201 string const path = file.onlyPath().absFileName() + "/";
203 // ok so we scan through the string twice, but who cares.
204 // FIXME: in Unicode time this will break for sure! There is
205 // a non-latin world out there...
206 string const keep = "abcdefghijklmnopqrstuvwxyz"
207 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
208 "@!'()*+,-./0123456789:;<=>?[]`|";
210 string::size_type pos = 0;
211 while ((pos = name.find_first_not_of(keep, pos)) != string::npos)
214 FileName latex_name(path + name);
215 latex_name.changeExtension(".tex");
220 string const quoteName(string const & name, quote_style style)
224 // This does not work on native Windows for filenames
225 // containing the following characters < > : " / \ | ? *
226 // Moreover, it can't be made to work, as, according to
227 // http://msdn.microsoft.com/en-us/library/aa365247(VS.85).aspx
228 // those are reserved characters, and thus are forbidden.
229 // Please, also note that the command-line parser in
230 // ForkedCall::generateChild cannot deal with filenames
231 // containing " or ', therefore we don't pass user filenames
232 // to child processes if possible. We store them in a python
233 // script instead, where we don't have these limitations.
235 return (os::shell() == os::UNIX) ?
236 '\'' + subst(name, "'", "\'\\\'\'") + '\'' :
239 // According to the QProcess parser, a single double
240 // quote is represented by three consecutive ones.
241 // Here we simply escape the double quote and let our
242 // simple parser in Systemcall.cpp do the substitution.
243 return '"' + subst(name, "\"", "\\\"") + '"';
245 case quote_shell_filename:
246 return quoteName(os::external_path(name), quote_shell);
248 return "\"" + subst(subst(name, "\\", "\\\\"), "\"", "\\\"")
251 // shut up stupid compiler
257 // Uses a string of paths separated by ";"s to find a file to open.
258 // Can't cope with pathnames with a ';' in them. Returns full path to file.
259 // If path entry begins with $$LyX/, use system_lyxdir
260 // If path entry begins with $$User/, use user_lyxdir
261 // Example: "$$User/doc;$$LyX/doc"
262 FileName const fileOpenSearch(string const & path, string const & name,
267 bool notfound = true;
268 string tmppath = split(path, path_element, ';');
270 while (notfound && !path_element.empty()) {
271 path_element = os::internal_path(path_element);
272 if (!suffixIs(path_element, '/'))
274 path_element = subst(path_element, "$$LyX",
275 package().system_support().absFileName());
276 path_element = subst(path_element, "$$User",
277 package().user_support().absFileName());
279 real_file = fileSearch(path_element, name, ext);
281 if (real_file.empty()) {
283 tmppath = split(tmppath, path_element, ';');
284 } while (!tmppath.empty() && path_element.empty());
294 // Returns the real name of file name in directory path, with optional
296 FileName const fileSearch(string const & path, string const & name,
297 string const & exts, search_mode mode)
299 // if `name' is an absolute path, we ignore the setting of `path'
300 // Expand Environmentvariables in 'name'
301 string const tmpname = replaceEnvironmentPath(name);
302 FileName fullname(makeAbsPath(tmpname, path));
303 // search first without extension, then with it.
304 if (fullname.isReadableFile())
308 return mode == may_not_exist ? fullname : FileName();
310 string ext = token(exts, ',', n);
311 while (!ext.empty()) {
312 // Only add the extension if it is not already the extension of
314 bool addext = getExtension(fullname.absFileName()) != ext;
316 if (mode == check_hidpi) {
317 FileName fullname2x = FileName(addExtension(fullname.absFileName() + "@2x", ext));
318 if (fullname2x.isReadableFile())
321 fullname = FileName(addExtension(fullname.absFileName(), ext));
323 if (fullname.isReadableFile() || mode == may_not_exist)
326 fullname.changeExtension("");
327 ext = token(exts, ',', ++n);
333 // Search the file name.ext in the subdirectory dir of
335 // 2) build_lyxdir (if not empty)
337 FileName const libFileSearch(string const & dir, string const & name,
338 string const & ext, search_mode mode)
340 FileName fullname = fileSearch(addPath(package().user_support().absFileName(), dir),
342 if (!fullname.empty())
345 if (!package().build_support().empty())
346 fullname = fileSearch(addPath(package().build_support().absFileName(), dir),
348 if (!fullname.empty())
351 return fileSearch(addPath(package().system_support().absFileName(), dir),
356 FileName const i18nLibFileSearch(string const & dir, string const & name,
359 // if the LANGUAGE variable is set, use it as a fallback for searching for files.
360 string lang = getGuiMessages().language();
361 string const language = getEnv("LANGUAGE");
362 if (!language.empty())
363 lang += ":" + language;
365 for (auto const & l : getVectorFromString(lang, ":")) {
367 // First try with the full name
368 // `en' files are not in a subdirectory
370 tmp = libFileSearch(dir, name, ext);
372 tmp = libFileSearch(addPath(dir, l), name, ext);
376 // Then the name without country code
377 string const shortl = token(l, '_', 0);
379 tmp = libFileSearch(addPath(dir, shortl), name, ext);
385 return libFileSearch(dir, name, ext);
389 FileName const imageLibFileSearch(string & dir, string const & name,
390 string const & ext, search_mode mode)
392 if (!lyx::lyxrc.icon_set.empty()) {
393 string const imagedir = addPath(dir, lyx::lyxrc.icon_set);
394 FileName const fn = libFileSearch(imagedir, name, ext, mode);
400 return libFileSearch(dir, name, ext, mode);
404 string const commandPrep(string const & command_in)
406 static string const token_scriptpath = "$$s/";
407 string const python_call = "python -tt";
409 string command = command_in;
410 if (prefixIs(command_in, python_call))
411 command = os::python() + command_in.substr(python_call.length());
413 // Find the starting position of "$$s/"
414 string::size_type const pos1 = command.find(token_scriptpath);
415 if (pos1 == string::npos)
417 // Find the end of the "$$s/some_subdir/some_script" word within
418 // command. Assumes that the script name does not contain spaces.
419 string::size_type const start_script = pos1 + 4;
420 string::size_type const pos2 = command.find(' ', start_script);
421 string::size_type const size_script = pos2 == string::npos?
422 (command.size() - start_script) : pos2 - start_script;
424 // Does this script file exist?
425 string const script =
426 libFileSearch(".", command.substr(start_script, size_script)).absFileName();
428 if (script.empty()) {
429 // Replace "$$s/" with ""
430 command.erase(pos1, 4);
432 quote_style style = quote_shell;
433 if (prefixIs(command, os::python()))
434 style = quote_python;
436 // Replace "$$s/foo/some_script" with "<path to>/some_script".
437 string::size_type const size_replace = size_script + 4;
438 command.replace(pos1, size_replace, quoteName(script, style));
445 FileName const tempFileName(FileName tempdir, string const & mask, bool const dir)
447 return tempFileName(TempFile(tempdir, mask).name(), dir);
451 FileName const tempFileName(string const & mask, bool const dir)
453 return tempFileName(TempFile(mask).name(), dir);
457 FileName const tempFileName(FileName tempfile, bool const dir)
459 // Since the QTemporaryFile object is destroyed at function return
460 // (which is what is intended here), the next call to this function
461 // may return the same file name again.
462 // Thus, in order to prevent race conditions, we track returned names
463 // and create our own unique names if QTemporaryFile returns a name again.
464 if (tmp_names_.find(tempfile.absFileName()) == tmp_names_.end()) {
465 tmp_names_.insert(tempfile.absFileName());
469 // OK, we need another name. Simply append digits.
470 FileName tmp = tempfile;
473 // Store and remove extensions
474 ext = "." + tempfile.extension();
475 tmp.changeExtension("");
477 for (int i = 1; i < INT_MAX ;++i) {
478 // Append digit to filename and re-add extension
479 string const new_fn =
480 tmp.absFileName() + convert<string>(i) + ext;
481 if (tmp_names_.find(new_fn) == tmp_names_.end()) {
482 tmp_names_.insert(new_fn);
483 tempfile.set(new_fn);
488 // This should not happen!
489 LYXERR0("tempFileName(): Could not create unique temp file name!");
494 void removeTempFile(FileName const & fn)
499 string const abs = fn.absFileName();
500 if (tmp_names_.find(abs) != tmp_names_.end())
501 tmp_names_.erase(abs);
506 static FileName createTmpDir(FileName const & tempdir, string const & mask)
508 LYXERR(Debug::FILES, "createTmpDir: tempdir=`" << tempdir << "'\n"
509 << "createTmpDir: mask=`" << mask << '\'');
511 QFileInfo tmp_fi(QDir(toqstr(tempdir.absFileName())), toqstr(mask));
512 FileName const tmpfl =
513 tempFileName(FileName(fromqstr(tmp_fi.absolutePath())),
514 fromqstr(tmp_fi.fileName()) + ".XXXXXXXXXXXX", true);
516 if (tmpfl.empty() || !tmpfl.createDirectory(0700)) {
517 LYXERR0("LyX could not create temporary directory in " << tempdir
526 FileName const createLyXTmpDir(FileName const & deflt)
528 if (deflt.empty() || deflt == package().system_temp_dir())
529 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
531 if (deflt.createDirectory(0777))
534 if (deflt.isDirWritable()) {
535 // deflt could not be created because it
536 // did exist already, so let's create our own
538 return createTmpDir(deflt, "lyx_tmpdir");
540 // some other error occurred.
541 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
546 // Strip filename from path name
547 string const onlyPath(string const & filename)
549 // If empty filename, return empty
550 if (filename.empty())
553 // Find last / or start of filename
554 size_t j = filename.rfind('/');
555 return j == string::npos ? "./" : filename.substr(0, j + 1);
559 // Convert relative path into absolute path based on a basepath.
560 // If relpath is absolute, just use that.
561 // If basepath is empty, use CWD as base.
562 // Note that basePath can be a relative path, in the sense that it may
563 // not begin with "/" (e.g.), but it should NOT contain such constructs
565 // FIXME It might be nice if the code didn't simply assume that.
566 FileName const makeAbsPath(string const & relPath, string const & basePath)
568 // checks for already absolute path
569 if (FileName::isAbsolute(relPath))
570 return FileName(relPath);
572 // Copies given paths
573 string tempRel = os::internal_path(relPath);
574 // Since TempRel is NOT absolute, we can safely replace "//" with "/"
575 tempRel = subst(tempRel, "//", "/");
579 if (FileName::isAbsolute(basePath))
582 tempBase = addPath(FileName::getcwd().absFileName(), basePath);
584 // Handle /./ at the end of the path
585 while (suffixIs(tempBase, "/./"))
586 tempBase.erase(tempBase.length() - 2);
588 // processes relative path
589 string rTemp = tempRel;
592 // Check for a leading "~"
594 rTemp = split(rTemp, temp, '/');
596 tempBase = Package::get_home_dir().absFileName();
601 while (!rTemp.empty()) {
603 rTemp = split(rTemp, temp, '/');
605 if (temp == ".") continue;
607 // Remove one level of TempBase
608 if (tempBase.length() <= 1) {
609 //this is supposed to be an absolute path, so...
613 //erase a trailing slash if there is one
614 if (suffixIs(tempBase, "/"))
615 tempBase.erase(tempBase.length() - 1, string::npos);
617 string::size_type i = tempBase.length() - 1;
618 while (i > 0 && tempBase[i] != '/')
621 tempBase.erase(i, string::npos);
624 } else if (temp.empty() && !rTemp.empty()) {
625 tempBase = os::current_root() + rTemp;
628 // Add this piece to TempBase
629 if (!suffixIs(tempBase, '/'))
635 // returns absolute path
636 return FileName(tempBase);
640 // Correctly append filename to the pathname.
641 // If pathname is '.', then don't use pathname.
642 // Chops any path of filename.
643 string const addName(string const & path, string const & fname)
645 string const basename = onlyFileName(fname);
648 if (path != "." && path != "./" && !path.empty()) {
649 buf = os::internal_path(path);
650 if (!suffixIs(buf, '/'))
654 return buf + basename;
658 // Strips path from filename
659 string const onlyFileName(string const & fname)
664 string::size_type j = fname.rfind('/');
665 if (j == string::npos) // no '/' in fname
669 return fname.substr(j + 1);
673 // Search the string for ${VAR} and $VAR and replace VAR using getenv.
674 string const replaceEnvironmentPath(string const & path)
676 // ${VAR} is defined as
677 // $\{[A-Za-z_][A-Za-z_0-9]*\}
678 static string const envvar_br = "[$]\\{([A-Za-z_][A-Za-z_0-9]*)\\}";
680 // $VAR is defined as:
681 // $[A-Za-z_][A-Za-z_0-9]*
682 static string const envvar = "[$]([A-Za-z_][A-Za-z_0-9]*)";
684 // Coverity thinks that the regex constructor can return an
685 // exception. We know that it is not true since our regex are
686 // hardcoded, but we have to protect against that nevertheless.
688 static regex const envvar_br_re("(.*)" + envvar_br + "(.*)");
689 static regex const envvar_re("(.*)" + envvar + "(.*)");
690 string result = path;
693 if (!regex_match(result, what, envvar_br_re)) {
694 if (!regex_match(result, what, envvar_re))
697 string env_var = getEnv(what.str(2));
698 result = what.str(1) + env_var + what.str(3);
701 } catch (exception const & e) {
702 LYXERR0("Something is very wrong: " << e.what());
708 // Return a command prefix for setting the environment of the TeX engine.
709 string latexEnvCmdPrefix(string const & path, string const & lpath)
711 bool use_lpath = !(lpath.empty() || lpath == "." || lpath == "./");
713 if (path.empty() || (lyxrc.texinputs_prefix.empty() && !use_lpath))
716 string texinputs_prefix = lyxrc.texinputs_prefix.empty() ? string()
717 : os::latex_path_list(
718 replaceCurdirPath(path, lyxrc.texinputs_prefix));
719 string const allother_prefix = os::latex_path_list(path);
720 string const sep = string(1, os::path_separator(os::TEXENGINE));
721 string const texinputs = getEnv("TEXINPUTS");
722 string const bibinputs = getEnv("BIBINPUTS");
723 string const bstinputs = getEnv("BSTINPUTS");
724 string const texfonts = getEnv("TEXFONTS");
727 string const abslpath = FileName::isAbsolute(lpath)
728 ? os::latex_path(lpath)
729 : os::latex_path(FileName(path + "/" + lpath).realPath());
730 if (texinputs_prefix.empty())
731 texinputs_prefix = abslpath;
732 else if (suffixIs(texinputs_prefix, sep))
733 texinputs_prefix.append(abslpath + sep);
735 texinputs_prefix.append(sep + abslpath);
738 if (os::shell() == os::UNIX)
739 return "env TEXINPUTS=\"." + sep + texinputs_prefix
740 + sep + texinputs + "\" "
741 + "BIBINPUTS=\"." + sep + allother_prefix
742 + sep + bibinputs + "\" "
743 + "BSTINPUTS=\"." + sep + allother_prefix
744 + sep + bstinputs + "\" "
745 + "TEXFONTS=\"." + sep + allother_prefix
746 + sep + texfonts + "\" ";
748 // NOTE: the dummy blank dirs are necessary to force the
749 // QProcess parser to quote the argument (see bug 9453)
750 return "cmd /d /c set \"TEXINPUTS=." + sep + " "
751 + sep + texinputs_prefix
752 + sep + texinputs + "\" & "
753 + "set \"BIBINPUTS=." + sep + " "
754 + sep + allother_prefix
755 + sep + bibinputs + "\" & "
756 + "set \"BSTINPUTS=." + sep + " "
757 + sep + allother_prefix
758 + sep + bstinputs + "\" & "
759 + "set \"TEXFONTS=." + sep + " "
760 + sep + allother_prefix
761 + sep + texfonts + "\" & ";
765 // Replace current directory in all elements of a path list with a given path.
766 string const replaceCurdirPath(string const & path, string const & pathlist)
768 string const oldpathlist = replaceEnvironmentPath(pathlist);
769 char const sep = os::path_separator();
772 for (size_t i = 0, k = 0; i != string::npos; k = i) {
773 i = oldpathlist.find(sep, i);
774 string p = oldpathlist.substr(k, i - k);
775 if (FileName::isAbsolute(p)) {
781 } else if (prefixIs(p, "./")) {
783 while (p[offset] == '/')
786 newpathlist += addPath(path, p.substr(offset));
787 if (suffixIs(p, "//"))
790 if (i != string::npos) {
792 // Stop here if the last element is empty
793 if (++i == oldpathlist.length())
801 // Make relative path out of two absolute paths
802 docstring const makeRelPath(docstring const & abspath, docstring const & basepath)
803 // Makes relative path out of absolute path. If it is deeper than basepath,
804 // it's easy. If basepath and abspath share something (they are all deeper
805 // than some directory), it'll be rendered using ..'s. If they are completely
806 // different, then the absolute path will be used as relative path.
808 docstring::size_type const abslen = abspath.length();
809 docstring::size_type const baselen = basepath.length();
811 docstring::size_type i = os::common_path(abspath, basepath);
814 // actually no match - cannot make it relative
818 // Count how many dirs there are in basepath above match
819 // and append as many '..''s into relpath
821 docstring::size_type j = i;
822 while (j < baselen) {
823 if (basepath[j] == '/') {
824 if (j + 1 == baselen)
831 // Append relative stuff from common directory to abspath
832 if (abspath[i] == '/')
834 for (; i < abslen; ++i)
837 if (suffixIs(buf, '/'))
838 buf.erase(buf.length() - 1);
839 // Substitute empty with .
846 // Append sub-directory(ies) to a path in an intelligent way
847 string const addPath(string const & path, string const & path_2)
850 string const path2 = os::internal_path(path_2);
852 if (!path.empty() && path != "." && path != "./") {
853 buf = os::internal_path(path);
854 if (path[path.length() - 1] != '/')
858 if (!path2.empty()) {
859 string::size_type const p2start = path2.find_first_not_of('/');
860 string::size_type const p2end = path2.find_last_not_of('/');
861 string const tmp = path2.substr(p2start, p2end - p2start + 1);
868 string const changeExtension(string const & oldname, string const & extension)
870 string::size_type const last_slash = oldname.rfind('/');
871 string::size_type last_dot = oldname.rfind('.');
872 if (last_dot < last_slash && last_slash != string::npos)
873 last_dot = string::npos;
876 // Make sure the extension starts with a dot
877 if (!extension.empty() && extension[0] != '.')
878 ext= '.' + extension;
882 return os::internal_path(oldname.substr(0, last_dot) + ext);
886 string const removeExtension(string const & name)
888 return changeExtension(name, string());
892 string const addExtension(string const & name, string const & extension)
894 if (!extension.empty() && extension[0] != '.')
895 return name + '.' + extension;
896 return name + extension;
900 /// Return the extension of the file (not including the .)
901 string const getExtension(string const & name)
903 string::size_type const last_slash = name.rfind('/');
904 string::size_type const last_dot = name.rfind('.');
905 if (last_dot != string::npos &&
906 (last_slash == string::npos || last_dot > last_slash))
907 return name.substr(last_dot + 1,
908 name.length() - (last_dot + 1));
914 string const unzippedFileName(string const & zipped_file)
916 string const ext = getExtension(zipped_file);
917 if (ext == "gz" || ext == "z" || ext == "Z")
918 return changeExtension(zipped_file, string());
919 else if (ext == "svgz")
920 return changeExtension(zipped_file, "svg");
921 return onlyPath(zipped_file) + "unzipped_" + onlyFileName(zipped_file);
925 FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
927 FileName const tempfile = FileName(unzipped_file.empty() ?
928 unzippedFileName(zipped_file.toFilesystemEncoding()) :
931 string const command = "gunzip -c \"" +
932 zipped_file.toFilesystemEncoding() + "\" > \"" +
933 tempfile.toFilesystemEncoding() + "\"";
935 one.startscript(Systemcall::Wait, command);
936 // test that command was executed successfully (anon)
937 // yes, please do. (Lgb)
942 docstring const makeDisplayPath(string const & path, unsigned int threshold)
946 // Recode URL encoded chars.
947 str = from_percent_encoding(str);
949 // If file is from LyXDir, display it as if it were relative.
950 string const system = package().system_support().absFileName();
951 if (prefixIs(str, system) && str != system)
952 return from_utf8("[" + str.erase(0, system.length()) + "]");
954 // replace /home/blah with ~/
955 string const home = Package::get_home_dir().absFileName();
956 if (!home.empty() && prefixIs(str, home))
957 str = subst(str, home, "~");
959 if (str.length() <= threshold)
960 return from_utf8(os::external_path(str));
962 string const prefix = ".../";
963 docstring dstr = from_utf8(str);
966 while (dstr.length() > threshold)
967 dstr = split(dstr, temp, '/');
969 // Did we shorten everything away?
971 // Yes, filename itself is too long.
972 // Pick the start and the end of the filename.
973 docstring fstr = from_utf8(onlyFileName(path));
975 if (support::truncateWithEllipsis(dstr, threshold / 2))
976 dstr += fstr.substr(fstr.length() - threshold / 2 - 2,
980 return from_utf8(os::external_path(prefix + to_utf8(dstr)));
985 bool readLink(FileName const & file, FileName & link)
987 string const encoded = file.toFilesystemEncoding();
988 #ifdef HAVE_DEF_PATH_MAX
989 char linkbuffer[PATH_MAX + 1];
990 ssize_t const nRead = ::readlink(encoded.c_str(),
991 linkbuffer, sizeof(linkbuffer) - 1);
994 linkbuffer[nRead] = '\0'; // terminator
996 vector<char> buf(1024);
1000 nRead = ::readlink(encoded.c_str(), &buf[0], buf.size() - 1);
1004 if (static_cast<size_t>(nRead) < buf.size() - 1) {
1007 buf.resize(buf.size() * 2);
1009 buf[nRead] = '\0'; // terminator
1010 const char * linkbuffer = &buf[0];
1012 link = makeAbsPath(linkbuffer, onlyPath(file.absFileName()));
1016 bool readLink(FileName const &, FileName &)
1023 cmd_ret const runCommand(string const & cmd)
1025 // FIXME: replace all calls to RunCommand with ForkedCall
1026 // (if the output is not needed) or the code in ISpell.cpp
1027 // (if the output is needed).
1029 // One question is if we should use popen or
1030 // create our own popen based on fork, exec, pipe
1031 // of course the best would be to have a
1032 // pstream (process stream), with the
1033 // variants ipstream, opstream
1036 lyxerr << "\nRunning: " << cmd << endl;
1038 LYXERR(Debug::INFO,"Running: " << cmd);
1040 #if defined (_WIN32)
1041 STARTUPINFO startup;
1042 PROCESS_INFORMATION process;
1043 SECURITY_ATTRIBUTES security;
1046 bool err2out = false;
1048 string const infile = trim(split(cmd, command, '<'), " \"");
1049 command = rtrim(command);
1050 if (suffixIs(command, "2>&1")) {
1051 command = rtrim(command, "2>&1");
1054 string const cmdarg = "/d /c \"" + command + "\"";
1055 string const comspec = getEnv("COMSPEC");
1057 security.nLength = sizeof(SECURITY_ATTRIBUTES);
1058 security.bInheritHandle = TRUE;
1059 security.lpSecurityDescriptor = NULL;
1061 if (CreatePipe(&in, &out, &security, 0)) {
1062 memset(&startup, 0, sizeof(STARTUPINFO));
1063 memset(&process, 0, sizeof(PROCESS_INFORMATION));
1065 startup.cb = sizeof(STARTUPINFO);
1066 startup.dwFlags = STARTF_USESTDHANDLES;
1068 startup.hStdError = err2out ? out : GetStdHandle(STD_ERROR_HANDLE);
1069 startup.hStdInput = infile.empty()
1070 ? GetStdHandle(STD_INPUT_HANDLE)
1071 : CreateFile(infile.c_str(), GENERIC_READ,
1072 FILE_SHARE_READ, &security, OPEN_EXISTING,
1073 FILE_ATTRIBUTE_NORMAL, NULL);
1074 startup.hStdOutput = out;
1076 if (startup.hStdInput != INVALID_HANDLE_VALUE &&
1077 CreateProcess(comspec.c_str(), (LPTSTR)cmdarg.c_str(),
1078 &security, &security, TRUE, CREATE_NO_WINDOW,
1079 0, 0, &startup, &process)) {
1081 CloseHandle(process.hThread);
1082 int fno = _open_osfhandle((intptr_t)in, _O_RDONLY);
1084 inf = _fdopen(fno, "r");
1087 #elif defined (HAVE_POPEN)
1088 FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
1089 #elif defined (HAVE__POPEN)
1090 FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
1092 #error No popen() function.
1095 // (Claus Hentschel) Check if popen was successful ;-)
1097 lyxerr << "RunCommand:: could not start child process" << endl;
1098 return make_pair(-1, string());
1104 ret += static_cast<char>(c);
1108 #if defined (_WIN32)
1109 WaitForSingleObject(process.hProcess, INFINITE);
1111 if (!GetExitCodeProcess(process.hProcess, &pret))
1113 if (!infile.empty())
1114 CloseHandle(startup.hStdInput);
1115 CloseHandle(process.hProcess);
1116 if (fclose(inf) != 0)
1118 #elif defined (HAVE_PCLOSE)
1119 int const pret = pclose(inf);
1120 #elif defined (HAVE__PCLOSE)
1121 int const pret = _pclose(inf);
1123 #error No pclose() function.
1127 perror("RunCommand:: could not terminate child process");
1129 return make_pair(pret, ret);
1133 FileName const findtexfile(string const & fil, string const & /*format*/,
1134 bool const onlykpse)
1136 /* There is no problem to extend this function too use other
1137 methods to look for files. It could be setup to look
1138 in environment paths and also if wanted as a last resort
1139 to a recursive find. One of the easier extensions would
1140 perhaps be to use the LyX file lookup methods. But! I am
1141 going to implement this until I see some demand for it.
1145 // If the file can be found directly, we just return a
1146 // absolute path version of it.
1148 FileName const absfile(makeAbsPath(fil));
1149 if (absfile.exists())
1153 // Now we try to find it using kpsewhich.
1154 // It seems from the kpsewhich manual page that it is safe to use
1155 // kpsewhich without --format: "When the --format option is not
1156 // given, the search path used when looking for a file is inferred
1157 // from the name given, by looking for a known extension. If no
1158 // known extension is found, the search path for TeX source files
1160 // However, we want to take advantage of the format sine almost all
1161 // the different formats has environment variables that can be used
1162 // to controll which paths to search. f.ex. bib looks in
1163 // BIBINPUTS and TEXBIB. Small list follows:
1164 // bib - BIBINPUTS, TEXBIB
1166 // graphic/figure - TEXPICTS, TEXINPUTS
1167 // ist - TEXINDEXSTYLE, INDEXSTYLE
1168 // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
1170 // tfm - TFMFONTS, TEXFONTS
1171 // This means that to use kpsewhich in the best possible way we
1172 // should help it by setting additional path in the approp. envir.var.
1173 string const kpsecmd = "kpsewhich " + fil;
1175 cmd_ret const c = runCommand(kpsecmd);
1177 LYXERR(Debug::LATEX, "kpse status = " << c.first << '\n'
1178 << "kpse result = `" << rtrim(c.second, "\n\r") << '\'');
1180 return FileName(rtrim(to_utf8(from_filesystem8bit(c.second)), "\n\r"));
1186 int compare_timestamps(FileName const & file1, FileName const & file2)
1188 // If the original is newer than the copy, then copy the original
1189 // to the new directory.
1192 if (file1.exists() && file2.exists()) {
1193 double const tmp = difftime(file1.lastModified(), file2.lastModified());
1195 cmp = tmp > 0 ? 1 : -1;
1197 } else if (file1.exists()) {
1199 } else if (file2.exists()) {
1207 bool prefs2prefs(FileName const & filename, FileName const & tempfile, bool lfuns)
1209 FileName const script = libFileSearch("scripts", "prefs2prefs.py");
1210 if (script.empty()) {
1211 LYXERR0("Could not find bind file conversion "
1212 "script prefs2prefs.py.");
1216 ostringstream command;
1217 command << os::python() << ' ' << quoteName(script.toFilesystemEncoding())
1218 << ' ' << (lfuns ? "-l" : "-p") << ' '
1219 << quoteName(filename.toFilesystemEncoding())
1220 << ' ' << quoteName(tempfile.toFilesystemEncoding());
1221 string const command_str = command.str();
1223 LYXERR(Debug::FILES, "Running `" << command_str << '\'');
1225 cmd_ret const ret = runCommand(command_str);
1226 if (ret.first != 0) {
1227 LYXERR0("Could not run file conversion script prefs2prefs.py.");
1234 bool configFileNeedsUpdate(string const & file)
1236 // We cannot initialize configure_script directly because the package
1237 // is not initialized yet when static objects are constructed.
1238 static FileName configure_script;
1239 static bool firstrun = true;
1242 FileName(addName(package().system_support().absFileName(),
1248 FileName(addName(package().user_support().absFileName(), file));
1249 return !absfile.exists()
1250 || configure_script.lastModified() > absfile.lastModified();
1254 int fileLock(const char * lock_file)
1257 #if defined(HAVE_LOCKF)
1258 fd = open(lock_file, O_CREAT|O_APPEND|O_SYNC|O_RDWR, 0666);
1261 if (lockf(fd, F_LOCK, 0) != 0) {
1270 void fileUnlock(int fd, const char * /* lock_file*/)
1272 #if defined(HAVE_LOCKF)
1274 if (lockf(fd, F_ULOCK, 0))
1275 LYXERR0("Can't unlock the file.");
1281 } //namespace support