src/gromacs/utility/path.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2011,2012,2013,2014, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \internal \file
  36  * \brief
  37  * Implements functions in path.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #include "path.h"
  43
  44 #include <cctype>
  45 #include <cerrno>
  46 #include <cstdlib>
  47 #include <cstring>
  48
  49 #include <algorithm>
  50
  51 #include "config.h"
  52
  53 #include <sys/stat.h>
  54 #ifdef GMX_NATIVE_WINDOWS
  55 #include <direct.h>
  56 #else
  57 #ifdef HAVE_UNISTD_H
  58 #include <unistd.h>
  59 #endif
  60 #endif
  61
  62 #include "gromacs/utility/futil.h"
  63 #include "gromacs/utility/stringutil.h"
  64
  65 namespace
  66 {
  67
  68 //! Directory separator to use when joining paths.
  69 const char cDirSeparator = '/';
  70 //! Directory separators to use when parsing paths.
  71 const char cDirSeparators[] = "/\\";
  72 /*! \var cPathSeparator
  73  * \brief
  74  * Separator to use to split the PATH environment variable.
  75  *
  76  * When reading the PATH environment variable, Unix separates entries
  77  * with colon, while windows uses semicolon.
  78  */
  79 #ifdef GMX_NATIVE_WINDOWS
  80 const char cPathSeparator = ';';
  81 #else
  82 const char cPathSeparator = ':';
  83 #endif
  84
  85 //! Check whether a given character is a directory separator.
  86 bool isDirSeparator(char chr)
  87 {
  88     return std::strchr(cDirSeparators, chr);
  89 }
  90
  91 } // namespace
  92
  93 namespace gmx
  94 {
  95
  96 /********************************************************************
  97  * Path
  98  */
  99
 100 bool Path::containsDirectory(const std::string &path)
 101 {
 102     return path.find_first_of(cDirSeparators) != std::string::npos;
 103 }
 104
 105 /* Check if the program name begins with "/" on unix/cygwin, or
 106  * with "\" or "X:\" on windows. If not, the program name
 107  * is relative to the current directory.
 108  */
 109 bool Path::isAbsolute(const char *path)
 110 {
 111     if (isDirSeparator(path[0]))
 112     {
 113         return true;
 114     }
 115 #ifdef GMX_NATIVE_WINDOWS
 116     return path[0] != '\0' && path[1] == ':' && isDirSeparator(path[2]);
 117 #else
 118     return false;
 119 #endif
 120 }
 121
 122 bool Path::isAbsolute(const std::string &path)
 123 {
 124     return isAbsolute(path.c_str());
 125 }
 126
 127 bool Path::startsWith(const std::string &path, const std::string &prefix)
 128 {
 129     return gmx::startsWith(normalize(path), normalize(prefix));
 130 }
 131
 132 std::string Path::join(const std::string &path1,
 133                        const std::string &path2)
 134 {
 135     // TODO: Remove extra separators if they are present in the input paths.
 136     return path1 + cDirSeparator + path2;
 137 }
 138
 139
 140 std::string Path::join(const std::string &path1,
 141                        const std::string &path2,
 142                        const std::string &path3)
 143 {
 144     // TODO: Remove extra separators if they are present in the input paths.
 145     return path1 + cDirSeparator + path2 + cDirSeparator + path3;
 146 }
 147
 148 std::string Path::getParentPath(const std::string &path)
 149 {
 150     size_t pos = path.find_last_of(cDirSeparators);
 151     if (pos == std::string::npos)
 152     {
 153         return std::string();
 154     }
 155     return path.substr(0, pos);
 156 }
 157
 158 std::string Path::getFilename(const std::string &path)
 159 {
 160     size_t pos = path.find_last_of(cDirSeparators);
 161     if (pos == std::string::npos)
 162     {
 163         return path;
 164     }
 165     return path.substr(pos+1);
 166 }
 167
 168 std::string Path::normalize(const std::string &path)
 169 {
 170     std::string result(path);
 171     // TODO: Remove . and .. entries.
 172     if (DIR_SEPARATOR != '/')
 173     {
 174         std::replace(result.begin(), result.end(), '/', DIR_SEPARATOR);
 175     }
 176 #ifdef GMX_NATIVE_WINDOWS
 177     if (std::isalpha(result[0]) && result[1] == ':')
 178     {
 179         result[0] = std::toupper(result[0]);
 180     }
 181 #endif
 182     return result;
 183 }
 184
 185 bool Path::exists(const char *path)
 186 {
 187     return gmx_fexist(path);
 188 }
 189
 190 bool Path::exists(const std::string &path)
 191 {
 192     return exists(path.c_str());
 193 }
 194
 195 std::string Path::getWorkingDirectory()
 196 {
 197     // TODO: Use exceptions instead of gmx_fatal().
 198     char cwd[GMX_PATH_MAX];
 199     gmx_getcwd(cwd, sizeof(cwd));
 200     return cwd;
 201 }
 202
 203 void Path::splitPathEnvironment(const std::string        &pathEnv,
 204                                 std::vector<std::string> *result)
 205 {
 206     size_t prevPos = 0;
 207     size_t separator;
 208     do
 209     {
 210         separator = pathEnv.find(cPathSeparator, prevPos);
 211         result->push_back(pathEnv.substr(prevPos, separator - prevPos));
 212         prevPos = separator + 1;
 213     }
 214     while (separator != std::string::npos);
 215 }
 216
 217 std::vector<std::string> Path::getExecutablePaths()
 218 {
 219     std::vector<std::string> result;
 220 #ifdef GMX_NATIVE_WINDOWS
 221     // Add the local dir since it is not in the path on Windows.
 222     result.push_back("");
 223 #endif
 224     const char *path = std::getenv("PATH");
 225     if (path != NULL)
 226     {
 227         splitPathEnvironment(path, &result);
 228     }
 229     return result;
 230 }
 231
 232 std::string Path::resolveSymlinks(const std::string &path)
 233 {
 234     std::string result(path);
 235 #ifndef GMX_NATIVE_WINDOWS
 236     char        buf[GMX_PATH_MAX];
 237     int         length;
 238     while ((length = readlink(result.c_str(), buf, sizeof(buf)-1)) > 0)
 239     {
 240         buf[length] = '\0';
 241         if (isAbsolute(buf))
 242         {
 243             result = buf;
 244         }
 245         else
 246         {
 247             result = join(getParentPath(result), buf);
 248         }
 249     }
 250 #endif
 251     return result;
 252 }
 253
 254
 255 /********************************************************************
 256  * Directory
 257  */
 258
 259 int Directory::create(const char *path)
 260 {
 261     if (Directory::exists(path))
 262     {
 263         return 0;
 264     }
 265 #ifdef GMX_NATIVE_WINDOWS
 266     if (_mkdir(path))
 267 #else
 268     if (mkdir(path, S_IRWXU | S_IRWXG | S_IROTH | S_IWOTH) != 0)
 269 #endif
 270     {
 271         // TODO: Proper error handling.
 272         return -1;
 273     }
 274     return 0;
 275 }
 276
 277
 278 int Directory::create(const std::string &path)
 279 {
 280     return create(path.c_str());
 281 }
 282
 283
 284 bool Directory::exists(const char *path)
 285 {
 286     struct stat info;
 287     if (stat(path, &info) != 0)
 288     {
 289         if (errno != ENOENT && errno != ENOTDIR)
 290         {
 291             // TODO: Proper error handling.
 292         }
 293         return false;
 294     }
 295 #ifdef GMX_NATIVE_WINDOWS
 296     return ((_S_IFDIR & info.st_mode) != 0);
 297 #else
 298     return S_ISDIR(info.st_mode);
 299 #endif
 300 }
 301
 302
 303 bool Directory::exists(const std::string &path)
 304 {
 305     return exists(path.c_str());
 306 }
 307
 308 } // namespace gmx