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 tmp_names_.erase(abs);
505 static FileName createTmpDir(FileName const & tempdir, string const & mask)
507 LYXERR(Debug::FILES, "createTmpDir: tempdir=`" << tempdir << "'\n"
508 << "createTmpDir: mask=`" << mask << '\'');
510 QFileInfo tmp_fi(QDir(toqstr(tempdir.absFileName())), toqstr(mask));
511 FileName const tmpfl =
512 tempFileName(FileName(fromqstr(tmp_fi.absolutePath())),
513 fromqstr(tmp_fi.fileName()) + ".XXXXXXXXXXXX", true);
515 if (tmpfl.empty() || !tmpfl.createDirectory(0700)) {
516 LYXERR0("LyX could not create temporary directory in " << tempdir
525 FileName const createLyXTmpDir(FileName const & deflt)
527 if (deflt.empty() || deflt == package().system_temp_dir())
528 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
530 if (deflt.createDirectory(0777))
533 if (deflt.isDirWritable()) {
534 // deflt could not be created because it
535 // did exist already, so let's create our own
537 return createTmpDir(deflt, "lyx_tmpdir");
539 // some other error occurred.
540 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
545 // Strip filename from path name
546 string const onlyPath(string const & filename)
548 // If empty filename, return empty
549 if (filename.empty())
552 // Find last / or start of filename
553 size_t j = filename.rfind('/');
554 return j == string::npos ? "./" : filename.substr(0, j + 1);
558 // Convert relative path into absolute path based on a basepath.
559 // If relpath is absolute, just use that.
560 // If basepath is empty, use CWD as base.
561 // Note that basePath can be a relative path, in the sense that it may
562 // not begin with "/" (e.g.), but it should NOT contain such constructs
564 // FIXME It might be nice if the code didn't simply assume that.
565 FileName const makeAbsPath(string const & relPath, string const & basePath)
567 // checks for already absolute path
568 if (FileName::isAbsolute(relPath))
569 return FileName(relPath);
571 // Copies given paths
572 string tempRel = os::internal_path(relPath);
573 // Since TempRel is NOT absolute, we can safely replace "//" with "/"
574 tempRel = subst(tempRel, "//", "/");
578 if (FileName::isAbsolute(basePath))
581 tempBase = addPath(FileName::getcwd().absFileName(), basePath);
583 // Handle /./ at the end of the path
584 while (suffixIs(tempBase, "/./"))
585 tempBase.erase(tempBase.length() - 2);
587 // processes relative path
588 string rTemp = tempRel;
591 // Check for a leading "~"
593 rTemp = split(rTemp, temp, '/');
595 tempBase = Package::get_home_dir().absFileName();
600 while (!rTemp.empty()) {
602 rTemp = split(rTemp, temp, '/');
604 if (temp == ".") continue;
606 // Remove one level of TempBase
607 if (tempBase.length() <= 1) {
608 //this is supposed to be an absolute path, so...
612 //erase a trailing slash if there is one
613 if (suffixIs(tempBase, "/"))
614 tempBase.erase(tempBase.length() - 1, string::npos);
616 string::size_type i = tempBase.length() - 1;
617 while (i > 0 && tempBase[i] != '/')
620 tempBase.erase(i, string::npos);
623 } else if (temp.empty() && !rTemp.empty()) {
624 tempBase = os::current_root() + rTemp;
627 // Add this piece to TempBase
628 if (!suffixIs(tempBase, '/'))
634 // returns absolute path
635 return FileName(tempBase);
639 // Correctly append filename to the pathname.
640 // If pathname is '.', then don't use pathname.
641 // Chops any path of filename.
642 string const addName(string const & path, string const & fname)
644 string const basename = onlyFileName(fname);
647 if (path != "." && path != "./" && !path.empty()) {
648 buf = os::internal_path(path);
649 if (!suffixIs(buf, '/'))
653 return buf + basename;
657 // Strips path from filename
658 string const onlyFileName(string const & fname)
663 string::size_type j = fname.rfind('/');
664 if (j == string::npos) // no '/' in fname
668 return fname.substr(j + 1);
672 // Search the string for ${VAR} and $VAR and replace VAR using getenv.
673 string const replaceEnvironmentPath(string const & path)
675 // ${VAR} is defined as
676 // $\{[A-Za-z_][A-Za-z_0-9]*\}
677 static string const envvar_br = "[$]\\{([A-Za-z_][A-Za-z_0-9]*)\\}";
679 // $VAR is defined as:
680 // $[A-Za-z_][A-Za-z_0-9]*
681 static string const envvar = "[$]([A-Za-z_][A-Za-z_0-9]*)";
683 // Coverity thinks that the regex constructor can return an
684 // exception. We know that it is not true since our regex are
685 // hardcoded, but we have to protect against that nevertheless.
687 static regex const envvar_br_re("(.*)" + envvar_br + "(.*)");
688 static regex const envvar_re("(.*)" + envvar + "(.*)");
689 string result = path;
692 if (!regex_match(result, what, envvar_br_re)) {
693 if (!regex_match(result, what, envvar_re))
696 string env_var = getEnv(what.str(2));
697 result = what.str(1) + env_var + what.str(3);
700 } catch (exception const & e) {
701 LYXERR0("Something is very wrong: " << e.what());
707 // Return a command prefix for setting the environment of the TeX engine.
708 string latexEnvCmdPrefix(string const & path, string const & lpath)
710 bool use_lpath = !(lpath.empty() || lpath == "." || lpath == "./");
712 if (path.empty() || (lyxrc.texinputs_prefix.empty() && !use_lpath))
715 string texinputs_prefix = lyxrc.texinputs_prefix.empty() ? string()
716 : os::latex_path_list(
717 replaceCurdirPath(path, lyxrc.texinputs_prefix));
718 string const allother_prefix = os::latex_path_list(path);
719 string const sep = string(1, os::path_separator(os::TEXENGINE));
720 string const texinputs = getEnv("TEXINPUTS");
721 string const bibinputs = getEnv("BIBINPUTS");
722 string const bstinputs = getEnv("BSTINPUTS");
723 string const texfonts = getEnv("TEXFONTS");
726 string const abslpath = FileName::isAbsolute(lpath)
727 ? os::latex_path(lpath)
728 : os::latex_path(FileName(path + "/" + lpath).realPath());
729 if (texinputs_prefix.empty())
730 texinputs_prefix = abslpath;
731 else if (suffixIs(texinputs_prefix, sep))
732 texinputs_prefix.append(abslpath + sep);
734 texinputs_prefix.append(sep + abslpath);
737 if (os::shell() == os::UNIX)
738 return "env TEXINPUTS=\"." + sep + texinputs_prefix
739 + sep + texinputs + "\" "
740 + "BIBINPUTS=\"." + sep + allother_prefix
741 + sep + bibinputs + "\" "
742 + "BSTINPUTS=\"." + sep + allother_prefix
743 + sep + bstinputs + "\" "
744 + "TEXFONTS=\"." + sep + allother_prefix
745 + sep + texfonts + "\" ";
747 // NOTE: the dummy blank dirs are necessary to force the
748 // QProcess parser to quote the argument (see bug 9453)
749 return "cmd /d /c set \"TEXINPUTS=." + sep + " "
750 + sep + texinputs_prefix
751 + sep + texinputs + "\" & "
752 + "set \"BIBINPUTS=." + sep + " "
753 + sep + allother_prefix
754 + sep + bibinputs + "\" & "
755 + "set \"BSTINPUTS=." + sep + " "
756 + sep + allother_prefix
757 + sep + bstinputs + "\" & "
758 + "set \"TEXFONTS=." + sep + " "
759 + sep + allother_prefix
760 + sep + texfonts + "\" & ";
764 // Replace current directory in all elements of a path list with a given path.
765 string const replaceCurdirPath(string const & path, string const & pathlist)
767 string const oldpathlist = replaceEnvironmentPath(pathlist);
768 char const sep = os::path_separator();
771 for (size_t i = 0, k = 0; i != string::npos; k = i) {
772 i = oldpathlist.find(sep, i);
773 string p = oldpathlist.substr(k, i - k);
774 if (FileName::isAbsolute(p)) {
780 } else if (prefixIs(p, "./")) {
782 while (p[offset] == '/')
785 newpathlist += addPath(path, p.substr(offset));
786 if (suffixIs(p, "//"))
789 if (i != string::npos) {
791 // Stop here if the last element is empty
792 if (++i == oldpathlist.length())
800 // Make relative path out of two absolute paths
801 docstring const makeRelPath(docstring const & abspath, docstring const & basepath)
802 // Makes relative path out of absolute path. If it is deeper than basepath,
803 // it's easy. If basepath and abspath share something (they are all deeper
804 // than some directory), it'll be rendered using ..'s. If they are completely
805 // different, then the absolute path will be used as relative path.
807 docstring::size_type const abslen = abspath.length();
808 docstring::size_type const baselen = basepath.length();
810 docstring::size_type i = os::common_path(abspath, basepath);
813 // actually no match - cannot make it relative
817 // Count how many dirs there are in basepath above match
818 // and append as many '..''s into relpath
820 docstring::size_type j = i;
821 while (j < baselen) {
822 if (basepath[j] == '/') {
823 if (j + 1 == baselen)
830 // Append relative stuff from common directory to abspath
831 if (abspath[i] == '/')
833 for (; i < abslen; ++i)
836 if (suffixIs(buf, '/'))
837 buf.erase(buf.length() - 1);
838 // Substitute empty with .
845 // Append sub-directory(ies) to a path in an intelligent way
846 string const addPath(string const & path, string const & path_2)
849 string const path2 = os::internal_path(path_2);
851 if (!path.empty() && path != "." && path != "./") {
852 buf = os::internal_path(path);
853 if (path[path.length() - 1] != '/')
857 if (!path2.empty()) {
858 string::size_type const p2start = path2.find_first_not_of('/');
859 string::size_type const p2end = path2.find_last_not_of('/');
860 string const tmp = path2.substr(p2start, p2end - p2start + 1);
867 string const changeExtension(string const & oldname, string const & extension)
869 string::size_type const last_slash = oldname.rfind('/');
870 string::size_type last_dot = oldname.rfind('.');
871 if (last_dot < last_slash && last_slash != string::npos)
872 last_dot = string::npos;
875 // Make sure the extension starts with a dot
876 if (!extension.empty() && extension[0] != '.')
877 ext= '.' + extension;
881 return os::internal_path(oldname.substr(0, last_dot) + ext);
885 string const removeExtension(string const & name)
887 return changeExtension(name, string());
891 string const addExtension(string const & name, string const & extension)
893 if (!extension.empty() && extension[0] != '.')
894 return name + '.' + extension;
895 return name + extension;
899 /// Return the extension of the file (not including the .)
900 string const getExtension(string const & name)
902 string::size_type const last_slash = name.rfind('/');
903 string::size_type const last_dot = name.rfind('.');
904 if (last_dot != string::npos &&
905 (last_slash == string::npos || last_dot > last_slash))
906 return name.substr(last_dot + 1,
907 name.length() - (last_dot + 1));
913 string const unzippedFileName(string const & zipped_file)
915 string const ext = getExtension(zipped_file);
916 if (ext == "gz" || ext == "z" || ext == "Z")
917 return changeExtension(zipped_file, string());
918 else if (ext == "svgz")
919 return changeExtension(zipped_file, "svg");
920 return onlyPath(zipped_file) + "unzipped_" + onlyFileName(zipped_file);
924 FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
926 FileName const tempfile = FileName(unzipped_file.empty() ?
927 unzippedFileName(zipped_file.toFilesystemEncoding()) :
930 string const command = "gunzip -c \"" +
931 zipped_file.toFilesystemEncoding() + "\" > \"" +
932 tempfile.toFilesystemEncoding() + "\"";
934 one.startscript(Systemcall::Wait, command);
935 // test that command was executed successfully (anon)
936 // yes, please do. (Lgb)
941 docstring const makeDisplayPath(string const & path, unsigned int threshold)
945 // Recode URL encoded chars.
946 str = from_percent_encoding(str);
948 // If file is from LyXDir, display it as if it were relative.
949 string const system = package().system_support().absFileName();
950 if (prefixIs(str, system) && str != system)
951 return from_utf8("[" + str.erase(0, system.length()) + "]");
953 // replace /home/blah with ~/
954 string const home = Package::get_home_dir().absFileName();
955 if (!home.empty() && prefixIs(str, home))
956 str = subst(str, home, "~");
958 if (str.length() <= threshold)
959 return from_utf8(os::external_path(str));
961 string const prefix = ".../";
962 docstring dstr = from_utf8(str);
965 while (dstr.length() > threshold)
966 dstr = split(dstr, temp, '/');
968 // Did we shorten everything away?
970 // Yes, filename itself is too long.
971 // Pick the start and the end of the filename.
972 docstring fstr = from_utf8(onlyFileName(path));
974 if (support::truncateWithEllipsis(dstr, threshold / 2))
975 dstr += fstr.substr(fstr.length() - threshold / 2 - 2,
979 return from_utf8(os::external_path(prefix + to_utf8(dstr)));
984 bool readLink(FileName const & file, FileName & link)
986 string const encoded = file.toFilesystemEncoding();
987 #ifdef HAVE_DEF_PATH_MAX
988 char linkbuffer[PATH_MAX + 1];
989 ssize_t const nRead = ::readlink(encoded.c_str(),
990 linkbuffer, sizeof(linkbuffer) - 1);
993 linkbuffer[nRead] = '\0'; // terminator
995 vector<char> buf(1024);
999 nRead = ::readlink(encoded.c_str(), &buf[0], buf.size() - 1);
1003 if (static_cast<size_t>(nRead) < buf.size() - 1) {
1006 buf.resize(buf.size() * 2);
1008 buf[nRead] = '\0'; // terminator
1009 const char * linkbuffer = &buf[0];
1011 link = makeAbsPath(linkbuffer, onlyPath(file.absFileName()));
1015 bool readLink(FileName const &, FileName &)
1022 cmd_ret const runCommand(string const & cmd)
1024 // FIXME: replace all calls to RunCommand with ForkedCall
1025 // (if the output is not needed) or the code in ISpell.cpp
1026 // (if the output is needed).
1028 // One question is if we should use popen or
1029 // create our own popen based on fork, exec, pipe
1030 // of course the best would be to have a
1031 // pstream (process stream), with the
1032 // variants ipstream, opstream
1035 lyxerr << "\nRunning: " << cmd << endl;
1037 LYXERR(Debug::INFO,"Running: " << cmd);
1039 #if defined (_WIN32)
1040 STARTUPINFO startup;
1041 PROCESS_INFORMATION process;
1042 SECURITY_ATTRIBUTES security;
1045 bool err2out = false;
1047 string const infile = trim(split(cmd, command, '<'), " \"");
1048 command = rtrim(command);
1049 if (suffixIs(command, "2>&1")) {
1050 command = rtrim(command, "2>&1");
1053 string const cmdarg = "/d /c \"" + command + "\"";
1054 string const comspec = getEnv("COMSPEC");
1056 security.nLength = sizeof(SECURITY_ATTRIBUTES);
1057 security.bInheritHandle = TRUE;
1058 security.lpSecurityDescriptor = NULL;
1060 if (CreatePipe(&in, &out, &security, 0)) {
1061 memset(&startup, 0, sizeof(STARTUPINFO));
1062 memset(&process, 0, sizeof(PROCESS_INFORMATION));
1064 startup.cb = sizeof(STARTUPINFO);
1065 startup.dwFlags = STARTF_USESTDHANDLES;
1067 startup.hStdError = err2out ? out : GetStdHandle(STD_ERROR_HANDLE);
1068 startup.hStdInput = infile.empty()
1069 ? GetStdHandle(STD_INPUT_HANDLE)
1070 : CreateFile(infile.c_str(), GENERIC_READ,
1071 FILE_SHARE_READ, &security, OPEN_EXISTING,
1072 FILE_ATTRIBUTE_NORMAL, NULL);
1073 startup.hStdOutput = out;
1075 if (startup.hStdInput != INVALID_HANDLE_VALUE &&
1076 CreateProcess(comspec.c_str(), (LPTSTR)cmdarg.c_str(),
1077 &security, &security, TRUE, CREATE_NO_WINDOW,
1078 0, 0, &startup, &process)) {
1080 CloseHandle(process.hThread);
1081 int fno = _open_osfhandle((intptr_t)in, _O_RDONLY);
1083 inf = _fdopen(fno, "r");
1086 #elif defined (HAVE_POPEN)
1087 FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
1088 #elif defined (HAVE__POPEN)
1089 FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
1091 #error No popen() function.
1094 // (Claus Hentschel) Check if popen was successful ;-)
1096 lyxerr << "RunCommand:: could not start child process" << endl;
1097 return { false, string() };
1103 result += static_cast<char>(c);
1107 #if defined (_WIN32)
1108 WaitForSingleObject(process.hProcess, INFINITE);
1110 BOOL success = GetExitCodeProcess(process.hProcess, &pret);
1111 bool valid = (pret == 0) && success;
1112 if (!infile.empty())
1113 CloseHandle(startup.hStdInput);
1114 CloseHandle(process.hProcess);
1115 if (fclose(inf) != 0)
1117 #elif defined (HAVE_PCLOSE)
1118 int const pret = pclose(inf);
1119 bool const valid = (pret != -1);
1120 #elif defined (HAVE__PCLOSE)
1121 int const pret = _pclose(inf);
1122 bool const valid = (pret != -1);
1124 #error No pclose() function.
1128 perror("RunCommand:: could not terminate child process");
1130 return { valid, result };
1134 FileName const findtexfile(string const & fil, string const & /*format*/,
1135 bool const onlykpse)
1137 /* There is no problem to extend this function too use other
1138 methods to look for files. It could be setup to look
1139 in environment paths and also if wanted as a last resort
1140 to a recursive find. One of the easier extensions would
1141 perhaps be to use the LyX file lookup methods. But! I am
1142 going to implement this until I see some demand for it.
1146 // If the file can be found directly, we just return a
1147 // absolute path version of it.
1149 FileName const absfile(makeAbsPath(fil));
1150 if (absfile.exists())
1154 // Now we try to find it using kpsewhich.
1155 // It seems from the kpsewhich manual page that it is safe to use
1156 // kpsewhich without --format: "When the --format option is not
1157 // given, the search path used when looking for a file is inferred
1158 // from the name given, by looking for a known extension. If no
1159 // known extension is found, the search path for TeX source files
1161 // However, we want to take advantage of the format sine almost all
1162 // the different formats has environment variables that can be used
1163 // to control which paths to search. f.ex. bib looks in
1164 // BIBINPUTS and TEXBIB. Small list follows:
1165 // bib - BIBINPUTS, TEXBIB
1167 // graphic/figure - TEXPICTS, TEXINPUTS
1168 // ist - TEXINDEXSTYLE, INDEXSTYLE
1169 // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
1171 // tfm - TFMFONTS, TEXFONTS
1172 // This means that to use kpsewhich in the best possible way we
1173 // should help it by setting additional path in the approp. envir.var.
1174 string const kpsecmd = "kpsewhich " + fil;
1176 cmd_ret const c = runCommand(kpsecmd);
1178 LYXERR(Debug::LATEX, "kpse status = " << c.valid << '\n'
1179 << "kpse result = `" << rtrim(c.result, "\n\r") << '\'');
1181 return FileName(rtrim(to_utf8(from_filesystem8bit(c.result)), "\n\r"));
1187 int compare_timestamps(FileName const & file1, FileName const & file2)
1189 // If the original is newer than the copy, then copy the original
1190 // to the new directory.
1193 if (file1.exists() && file2.exists()) {
1194 double const tmp = difftime(file1.lastModified(), file2.lastModified());
1196 cmp = tmp > 0 ? 1 : -1;
1198 } else if (file1.exists()) {
1200 } else if (file2.exists()) {
1208 bool prefs2prefs(FileName const & filename, FileName const & tempfile, bool lfuns)
1210 FileName const script = libFileSearch("scripts", "prefs2prefs.py");
1211 if (script.empty()) {
1212 LYXERR0("Could not find bind file conversion "
1213 "script prefs2prefs.py.");
1217 ostringstream command;
1218 command << os::python() << ' ' << quoteName(script.toFilesystemEncoding())
1219 << ' ' << (lfuns ? "-l" : "-p") << ' '
1220 << quoteName(filename.toFilesystemEncoding())
1221 << ' ' << quoteName(tempfile.toFilesystemEncoding());
1222 string const command_str = command.str();
1224 LYXERR(Debug::FILES, "Running `" << command_str << '\'');
1226 cmd_ret const ret = runCommand(command_str);
1228 LYXERR0("Could not run file conversion script prefs2prefs.py.");
1235 bool configFileNeedsUpdate(string const & file)
1237 // We cannot initialize configure_script directly because the package
1238 // is not initialized yet when static objects are constructed.
1239 static FileName configure_script;
1240 static bool firstrun = true;
1243 FileName(addName(package().system_support().absFileName(),
1249 FileName(addName(package().user_support().absFileName(), file));
1250 return !absfile.exists()
1251 || configure_script.lastModified() > absfile.lastModified();
1255 int fileLock(const char * lock_file)
1258 #if defined(HAVE_LOCKF)
1259 fd = open(lock_file, O_CREAT|O_APPEND|O_SYNC|O_RDWR, 0666);
1262 if (lockf(fd, F_LOCK, 0) != 0) {
1271 void fileUnlock(int fd, const char * /* lock_file*/)
1273 #if defined(HAVE_LOCKF)
1275 if (lockf(fd, F_ULOCK, 0))
1276 LYXERR0("Can't unlock the file.");
1282 } //namespace support