]> git.lyx.org Git - lyx.git/blobdiff - src/support/filetools.cpp
TR1: check in cmake for GCC version, fallback in checktr1.h for other build systems...
[lyx.git] / src / support / filetools.cpp
index 73067ea751f547e9f6099978b75a92c20c1c4e10..b0b9d169a08153fa020c16dc9345b31d7df8cca1 100644 (file)
@@ -8,11 +8,11 @@
  * \author Ivan Schreter
  * \author Dirk Niggemann
  * \author Asger Alstrup
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  * \author Jean-Marc Lasgouttes
  * \author Angus Leeming
  * \author John Levon
- * \author Herbert Voß
+ * \author Herbert Voß
  *
  * Full author contact details are available in file CREDITS.
  *
@@ -23,7 +23,6 @@
 
 #include "support/filetools.h"
 
-#include "support/convert.h"
 #include "support/debug.h"
 #include "support/environment.h"
 #include "support/gettext.h"
@@ -36,8 +35,8 @@
 
 #include <QDir>
 
-#include <boost/assert.hpp>
-#include <boost/regex.hpp>
+#include "support/lassert.h"
+#include "support/regex.h"
 
 #include <fcntl.h>
 
 #include <fstream>
 #include <sstream>
 
+#if defined (_WIN32)
+#include <io.h>
+#include <windows.h>
+#endif
+
 using namespace std;
 
+#define USE_QPROCESS
+
 namespace lyx {
 namespace support {
 
-bool isLyXFilename(string const & filename)
+bool isLyXFileName(string const & filename)
 {
        return suffixIs(ascii_lowercase(filename), ".lyx");
 }
 
 
-bool isSGMLFilename(string const & filename)
+bool isSGMLFileName(string const & filename)
 {
        return suffixIs(ascii_lowercase(filename), ".sgml");
 }
 
 
-bool isValidLaTeXFilename(string const & filename)
+bool isValidLaTeXFileName(string const & filename)
 {
        string const invalid_chars("#$%{}()[]\"^");
        return filename.find_first_of(invalid_chars) == string::npos;
@@ -106,7 +112,7 @@ string const latex_path(string const & original_path,
 FileName const makeLatexName(FileName const & file)
 {
        string name = file.onlyFileName();
-       string const path = file.onlyPath().absFilename() + "/";
+       string const path = file.onlyPath().absFileName() + "/";
 
        // ok so we scan through the string twice, but who cares.
        // FIXME: in Unicode time this will break for sure! There is
@@ -129,16 +135,27 @@ string const quoteName(string const & name, quote_style style)
 {
        switch(style) {
        case quote_shell:
-               // This does not work for filenames containing " (windows)
-               // or ' (all other OSes). This can't be changed easily, since
-               // we would need to adapt the command line parser in
-               // Forkedcall::generateChild. Therefore we don't pass user
-               // filenames to child processes if possible. We store them in
-               // a python script instead, where we don't have these
-               // limitations.
+               // This does not work on native Windows for filenames
+               // containing the following characters < > : " / \ | ? *
+               // Moreover, it can't be made to work, as, according to
+               // http://msdn.microsoft.com/en-us/library/aa365247(VS.85).aspx
+               // those are reserved characters, and thus are forbidden.
+               // Please, also note that the command-line parser in
+               // ForkedCall::generateChild cannot deal with filenames
+               // containing " or ', therefore we don't pass user filenames
+               // to child processes if possible. We store them in a python
+               // script instead, where we don't have these limitations.
+#ifndef USE_QPROCESS
                return (os::shell() == os::UNIX) ?
-                       '\'' + name + '\'':
+                       '\'' + subst(name, "'", "\'\\\'\'") + '\'' :
                        '"' + name + '"';
+#else
+               // According to the QProcess parser, a single double
+               // quote is represented by three consecutive ones.
+               // Here we simply escape the double quote and let our
+               // simple parser in Systemcall.cpp do the substitution.
+               return '"' + subst(name, "\"", "\\\"") + '"';
+#endif
        case quote_python:
                return "\"" + subst(subst(name, "\\", "\\\\"), "\"", "\\\"")
                     + "\"";
@@ -167,9 +184,9 @@ FileName const fileOpenSearch(string const & path, string const & name,
                if (!suffixIs(path_element, '/'))
                        path_element += '/';
                path_element = subst(path_element, "$$LyX",
-                                    package().system_support().absFilename());
+                                    package().system_support().absFileName());
                path_element = subst(path_element, "$$User",
-                                    package().user_support().absFilename());
+                                    package().user_support().absFileName());
 
                real_file = fileSearch(path_element, name, ext);
 
@@ -200,12 +217,12 @@ FileName const fileSearch(string const & path, string const & name,
                return fullname;
        if (ext.empty())
                // We are done.
-               return mode == allow_unreadable ? fullname : FileName();
+               return mode == may_not_exist ? fullname : FileName();
        // Only add the extension if it is not already the extension of
        // fullname.
-       if (getExtension(fullname.absFilename()) != ext)
-               fullname = FileName(addExtension(fullname.absFilename(), ext));
-       if (fullname.isReadableFile() || mode == allow_unreadable)
+       if (getExtension(fullname.absFileName()) != ext)
+               fullname = FileName(addExtension(fullname.absFileName(), ext));
+       if (fullname.isReadableFile() || mode == may_not_exist)
                return fullname;
        return FileName();
 }
@@ -218,18 +235,18 @@ FileName const fileSearch(string const & path, string const & name,
 FileName const libFileSearch(string const & dir, string const & name,
                           string const & ext)
 {
-       FileName fullname = fileSearch(addPath(package().user_support().absFilename(), dir),
+       FileName fullname = fileSearch(addPath(package().user_support().absFileName(), dir),
                                     name, ext);
        if (!fullname.empty())
                return fullname;
 
        if (!package().build_support().empty())
-               fullname = fileSearch(addPath(package().build_support().absFilename(), dir),
+               fullname = fileSearch(addPath(package().build_support().absFileName(), dir),
                                      name, ext);
        if (!fullname.empty())
                return fullname;
 
-       return fileSearch(addPath(package().system_support().absFilename(), dir), name, ext);
+       return fileSearch(addPath(package().system_support().absFileName(), dir), name, ext);
 }
 
 
@@ -301,7 +318,7 @@ string const libScriptSearch(string const & command_in, quote_style style)
 
        // Does this script file exist?
        string const script =
-               libFileSearch(".", command.substr(start_script, size_script)).absFilename();
+               libFileSearch(".", command.substr(start_script, size_script)).absFileName();
 
        if (script.empty()) {
                // Replace "$$s/" with ""
@@ -321,46 +338,22 @@ static FileName createTmpDir(FileName const & tempdir, string const & mask)
        LYXERR(Debug::FILES, "createTmpDir: tempdir=`" << tempdir << "'\n"
                << "createTmpDir:    mask=`" << mask << '\'');
 
-       FileName const tmpfl = FileName::tempName(tempdir.absFilename()
-               + "/" + mask);
-       // FileName::tempName actually creates a file to make sure that it
-       // stays unique. So we have to delete it before we can create
-       // a dir with the same name. Note also that we are not thread
-       // safe because of the gap between unlink and mkdir. (Lgb)
-       tmpfl.removeFile();
+       FileName const tmpfl = FileName::tempName(tempdir, mask);
 
        if (tmpfl.empty() || !tmpfl.createDirectory(0700)) {
-               lyxerr << "LyX could not create the temporary directory '"
-                      << tmpfl << "'" << endl;
+               LYXERR0("LyX could not create temporary directory in " << tempdir
+                       << "'");
                return FileName();
        }
 
        return tmpfl;
 }
 
-string const createBufferTmpDir()
-{
-       static int count;
-       // We are in our own directory.  Why bother to mangle name?
-       // In fact I wrote this code to circumvent a problematic behaviour
-       // (bug?) of EMX mkstemp().
-       string const tmpfl =
-               package().temp_dir().absFilename() + "/lyx_tmpbuf" +
-               convert<string>(count++);
-
-       if (!FileName(tmpfl).createDirectory(0777)) {
-               lyxerr << "LyX could not create the temporary directory '"
-                      << tmpfl << "'" << endl;
-               return string();
-       }
-       return tmpfl;
-}
-
 
 FileName const createLyXTmpDir(FileName const & deflt)
 {
-       if (deflt.empty() || deflt.absFilename() == "/tmp")
-               return createTmpDir(FileName("/tmp"), "lyx_tmpdir");
+       if (deflt.empty() || deflt == package().system_temp_dir())
+               return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
 
        if (deflt.createDirectory(0777)) 
                return deflt;
@@ -372,7 +365,7 @@ FileName const createLyXTmpDir(FileName const & deflt)
                return createTmpDir(deflt, "lyx_tmpdir");
        } else {
                // some other error occured.
-               return createTmpDir(FileName("/tmp"), "lyx_tmpdir");
+               return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
        }
 }
 
@@ -393,10 +386,14 @@ string const onlyPath(string const & filename)
 // Convert relative path into absolute path based on a basepath.
 // If relpath is absolute, just use that.
 // If basepath is empty, use CWD as base.
+// Note that basePath can be a relative path, in the sense that it may
+// not begin with "/" (e.g.), but it should NOT contain such constructs
+// as "/../".
+// FIXME It might be nice if the code didn't simply assume that.
 FileName const makeAbsPath(string const & relPath, string const & basePath)
 {
        // checks for already absolute path
-       if (os::is_absolute_path(relPath))
+       if (FileName::isAbsolute(relPath))
                return FileName(relPath);
 
        // Copies given paths
@@ -406,10 +403,10 @@ FileName const makeAbsPath(string const & relPath, string const & basePath)
 
        string tempBase;
 
-       if (os::is_absolute_path(basePath))
+       if (FileName::isAbsolute(basePath))
                tempBase = basePath;
        else
-               tempBase = addPath(FileName::getcwd().absFilename(), basePath);
+               tempBase = addPath(FileName::getcwd().absFileName(), basePath);
 
        // Handle /./ at the end of the path
        while (suffixIs(tempBase, "/./"))
@@ -419,6 +416,15 @@ FileName const makeAbsPath(string const & relPath, string const & basePath)
        string rTemp = tempRel;
        string temp;
 
+       // Check for a leading "~"
+       // Split by first /
+       rTemp = split(rTemp, temp, '/');
+       if (temp == "~") {
+               tempBase = package().home_dir().absFileName();
+               tempRel = rTemp;
+       }
+
+       rTemp = tempRel;
        while (!rTemp.empty()) {
                // Split by next /
                rTemp = split(rTemp, temp, '/');
@@ -426,15 +432,22 @@ FileName const makeAbsPath(string const & relPath, string const & basePath)
                if (temp == ".") continue;
                if (temp == "..") {
                        // Remove one level of TempBase
-                       string::difference_type i = tempBase.length() - 2;
-                       if (i < 0)
-                               i = 0;
+                       if (tempBase.length() <= 1) {
+                               //this is supposed to be an absolute path, so...
+                               tempBase = "/";
+                               continue;
+                       }
+                       //erase a trailing slash if there is one
+                       if (suffixIs(tempBase, "/"))
+                               tempBase.erase(tempBase.length() - 1, string::npos);
+
+                       string::size_type i = tempBase.length() - 1;
                        while (i > 0 && tempBase[i] != '/')
                                --i;
                        if (i > 0)
                                tempBase.erase(i, string::npos);
                        else
-                               tempBase += '/';
+                               tempBase = '/';
                } else if (temp.empty() && !rTemp.empty()) {
                                tempBase = os::current_root() + rTemp;
                                rTemp.erase();
@@ -456,7 +469,7 @@ FileName const makeAbsPath(string const & relPath, string const & basePath)
 // Chops any path of filename.
 string const addName(string const & path, string const & fname)
 {
-       string const basename = onlyFilename(fname);
+       string const basename = onlyFileName(fname);
        string buf;
 
        if (path != "." && path != "./" && !path.empty()) {
@@ -470,7 +483,7 @@ string const addName(string const & path, string const & fname)
 
 
 // Strips path from filename
-string const onlyFilename(string const & fname)
+string const onlyFileName(string const & fname)
 {
        if (fname.empty())
                return fname;
@@ -484,20 +497,13 @@ string const onlyFilename(string const & fname)
 }
 
 
-/// Returns true is path is absolute
-bool absolutePath(string const & path)
-{
-       return os::is_absolute_path(path);
-}
-
-
 // Create absolute path. If impossible, don't do anything
 // Supports ./ and ~/. Later we can add support for ~logname/. (Asger)
 string const expandPath(string const & path)
 {
        // checks for already absolute path
        string rTemp = replaceEnvironmentPath(path);
-       if (os::is_absolute_path(rTemp))
+       if (FileName::isAbsolute(rTemp))
                return rTemp;
 
        string temp;
@@ -507,13 +513,13 @@ string const expandPath(string const & path)
        rTemp = split(rTemp, temp, '/');
 
        if (temp == ".")
-               return FileName::getcwd().absFilename() + '/' + rTemp;
+               return FileName::getcwd().absFileName() + '/' + rTemp;
 
        if (temp == "~")
-               return package().home_dir().absFilename() + '/' + rTemp;
+               return package().home_dir().absFileName() + '/' + rTemp;
 
        if (temp == "..")
-               return makeAbsPath(copy).absFilename();
+               return makeAbsPath(copy).absFileName();
 
        // Don't know how to handle this
        return copy;
@@ -531,19 +537,26 @@ string const replaceEnvironmentPath(string const & path)
        // $\{[A-Za-z_][A-Za-z_0-9]*\}
        static string const envvar = "[$]([A-Za-z_][A-Za-z_0-9]*)";
 
-       static boost::regex envvar_br_re("(.*)" + envvar_br + "(.*)");
-       static boost::regex envvar_re("(.*)" + envvar + "(.*)");
-       boost::smatch what;
-
-       string result = path;
+        static regex envvar_br_re("(.*)" + envvar_br + "(.*)");
+        static regex envvar_re("(.*)" + envvar + "(.*)");
+        smatch what;
+       string result;
+       string remaining = path;
        while (1) {
-               regex_match(result, what, envvar_br_re);
+               regex_match(remaining, what, envvar_br_re);
                if (!what[0].matched) {
-                       regex_match(result, what, envvar_re);
-                       if (!what[0].matched)
+                       regex_match(remaining, what, envvar_re);
+                       if (!what[0].matched) {
+                               result += remaining;
                                break;
+                       }
                }
-               result = what.str(1) + getEnv(what.str(2)) + what.str(3);
+               string env_var = getEnv(what.str(2));
+               if (!env_var.empty())
+                       result += what.str(1) + env_var;
+               else
+                       result += what.str(1) + "$" + what.str(2);
+               remaining = what.str(3);
        }
        return result;
 }
@@ -667,7 +680,7 @@ string const unzippedFileName(string const & zipped_file)
        string const ext = getExtension(zipped_file);
        if (ext == "gz" || ext == "z" || ext == "Z")
                return changeExtension(zipped_file, string());
-       return "unzipped_" + zipped_file;
+       return onlyPath(zipped_file) + "unzipped_" + onlyFileName(zipped_file);
 }
 
 
@@ -693,12 +706,12 @@ docstring const makeDisplayPath(string const & path, unsigned int threshold)
        string str = path;
 
        // If file is from LyXDir, display it as if it were relative.
-       string const system = package().system_support().absFilename();
+       string const system = package().system_support().absFileName();
        if (prefixIs(str, system) && str != system)
                return from_utf8("[" + str.erase(0, system.length()) + "]");
 
        // replace /home/blah with ~/
-       string const home = package().home_dir().absFilename();
+       string const home = package().home_dir().absFileName();
        if (!home.empty() && prefixIs(str, home))
                str = subst(str, home, "~");
 
@@ -715,7 +728,7 @@ docstring const makeDisplayPath(string const & path, unsigned int threshold)
        if (str.empty()) {
                // Yes, filename itself is too long.
                // Pick the start and the end of the filename.
-               str = onlyFilename(path);
+               str = onlyFileName(path);
                string const head = str.substr(0, threshold / 2 - 3);
 
                string::size_type len = str.length();
@@ -731,15 +744,14 @@ docstring const makeDisplayPath(string const & path, unsigned int threshold)
 bool readLink(FileName const & file, FileName & link)
 {
 #ifdef HAVE_READLINK
-       char linkbuffer[512];
-       // Should be PATH_MAX but that needs autconf support
+       char linkbuffer[PATH_MAX + 1];
        string const encoded = file.toFilesystemEncoding();
        int const nRead = ::readlink(encoded.c_str(),
                                     linkbuffer, sizeof(linkbuffer) - 1);
        if (nRead <= 0)
                return false;
        linkbuffer[nRead] = '\0'; // terminator
-       link = makeAbsPath(linkbuffer, onlyPath(file.absFilename()));
+       link = makeAbsPath(linkbuffer, onlyPath(file.absFileName()));
        return true;
 #else
        return false;
@@ -759,7 +771,39 @@ cmd_ret const runCommand(string const & cmd)
        // pstream (process stream), with the
        // variants ipstream, opstream
 
-#if defined (HAVE_POPEN)
+#if defined (_WIN32)
+       int fno; 
+       STARTUPINFO startup; 
+       PROCESS_INFORMATION process; 
+       SECURITY_ATTRIBUTES security; 
+       HANDLE in, out;
+       FILE * inf = 0;
+    
+       security.nLength = sizeof(SECURITY_ATTRIBUTES); 
+       security.bInheritHandle = TRUE; 
+       security.lpSecurityDescriptor = NULL; 
+
+       if (CreatePipe(&in, &out, &security, 0)) { 
+               memset(&startup, 0, sizeof(STARTUPINFO));
+               memset(&process, 0, sizeof(PROCESS_INFORMATION));
+    
+               startup.cb = sizeof(STARTUPINFO);
+               startup.dwFlags = STARTF_USESTDHANDLES;
+  
+               startup.hStdError = GetStdHandle(STD_ERROR_HANDLE);
+               startup.hStdInput = GetStdHandle(STD_INPUT_HANDLE);
+               startup.hStdOutput = out;
+
+               if (CreateProcess(0, (LPTSTR)cmd.c_str(), &security, &security,
+                       TRUE, CREATE_NO_WINDOW, 0, 0, &startup, &process)) {
+
+                       CloseHandle(process.hThread);
+                       fno = _open_osfhandle((long)in, _O_RDONLY);
+                       CloseHandle(out);
+                       inf = _fdopen(fno, "r");
+               }
+       }
+#elif defined (HAVE_POPEN)
        FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
 #elif defined (HAVE__POPEN)
        FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
@@ -780,7 +824,11 @@ cmd_ret const runCommand(string const & cmd)
                c = fgetc(inf);
        }
 
-#if defined (HAVE_PCLOSE)
+#if defined (_WIN32)
+       WaitForSingleObject(process.hProcess, INFINITE);
+       CloseHandle(process.hProcess);
+       int const pret = fclose(inf);
+#elif defined (HAVE_PCLOSE)
        int const pret = pclose(inf);
 #elif defined (HAVE__PCLOSE)
        int const pret = _pclose(inf);
@@ -812,7 +860,7 @@ FileName const findtexfile(string const & fil, string const & /*format*/)
        if (absfile.exists())
                return absfile;
 
-       // No we try to find it using kpsewhich.
+       // Now we try to find it using kpsewhich.
        // It seems from the kpsewhich manual page that it is safe to use
        // kpsewhich without --format: "When the --format option is not
        // given, the search path used when looking for a file is inferred
@@ -845,18 +893,6 @@ FileName const findtexfile(string const & fil, string const & /*format*/)
 }
 
 
-void removeAutosaveFile(string const & filename)
-{
-       string a = onlyPath(filename);
-       a += '#';
-       a += onlyFilename(filename);
-       a += '#';
-       FileName const autosave(a);
-       if (autosave.exists())
-               autosave.removeFile();
-}
-
-
 void readBB_lyxerrMessage(FileName const & file, bool & zipped,
        string const & message)
 {
@@ -885,13 +921,13 @@ string const readBB_from_PSFile(FileName const & file)
                return string();
        }
 
-       static boost::regex bbox_re(
+       static lyx::regex bbox_re(
                "^%%BoundingBox:\\s*([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)");
        ifstream is(file_.toFilesystemEncoding().c_str());
        while (is) {
                string s;
                getline(is,s);
-               boost::smatch what;
+               lyx::smatch what;
                if (regex_match(s, what, bbox_re)) {
                        // Our callers expect the tokens in the string
                        // separated by single spaces.