katie/src/core/io/qstandardpaths.cpp

/***********************************************************************
*
* Copyright (c) 2012-2015 Barbara Geller
* Copyright (c) 2012-2015 Ansel Sermersheim
* Copyright (c) 2012-2014 Digia Plc and/or its subsidiary(-ies).
* Copyright (c) 2008-2012 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
*
* This file is part of CopperSpice.
*
* CopperSpice is free software: you can redistribute it and/or 
* modify it under the terms of the GNU Lesser General Public License
* version 2.1 as published by the Free Software Foundation.
*
* CopperSpice is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with CopperSpice.  If not, see 
* <http://www.gnu.org/licenses/>.
*
***********************************************************************/

#include <qstandardpaths.h>

#include <qdir.h>
#include <qfileinfo.h>
#include <qhash.h>
#include <qobject.h>
#include <qcoreapplication.h>

#ifndef QT_NO_STANDARDPATHS

QT_BEGIN_NAMESPACE

/*!
    \class QStandardPaths
    \inmodule QtCore
    \brief The QStandardPaths class provides methods for accessing standard paths.
    \since 5.0

    This class contains functions to query standard locations on the local
    filesystem, for common tasks such as user-specific directories or system-wide
    configuration directories.
*/

/*!
    \enum QStandardPaths::StandardLocation

    This enum describes the different locations that can be queried using
    methods such as QStandardPaths::writableLocation, QStandardPaths::standardLocations,
    and QStandardPaths::displayName.

    \value DesktopLocation Returns the user's desktop directory.
    \value DocumentsLocation Returns the user's document.
    \value FontsLocation Returns the user's fonts.
    \value ApplicationsLocation Returns the user's applications.
    \value MusicLocation Returns the user's music.
    \value MoviesLocation Returns the user's movies.
    \value PicturesLocation Returns the user's pictures.
    \value TempLocation Returns the system's temporary directory.
    \value HomeLocation Returns the user's home directory.
    \value DataLocation Returns a directory location where persistent
           application data can be stored. QCoreApplication::organizationName
           and QCoreApplication::applicationName are appended to the directory location
           returned for GenericDataLocation.
    \value CacheLocation Returns a directory location where user-specific
           non-essential (cached) data should be written.
    \value GenericCacheLocation Returns a directory location where user-specific
           non-essential (cached) data, shared across applications, should be written.
    \value GenericDataLocation Returns a directory location where persistent
           data shared across applications can be stored.
    \value RuntimeLocation Returns a directory location where runtime communication
           files should be written. For instance unix local sockets.
    \value ConfigLocation Returns a directory location where user-specific
           configuration files should be written. This may be either a generic value
           or application-specific, and the returned path is never empty.
    \value DownloadLocation Returns a directory for user's downloaded files. This is a generic value.
           If no directory specific for downloads exists, a sensible fallback for storing user
           documents is returned.
    \value GenericConfigLocation Returns a directory location where user-specific
           configuration files shared between multiple applications should be written.
           This is a generic value and the returned path is never empty.

    The following table gives examples of paths on different operating systems.
    The first path is the writable path (unless noted). Other, additional
    paths, if any, represent non-writable locations.

    \table
    \header \li Path type \li OS X  \li Windows
    \row \li DesktopLocation
         \li "~/Desktop"
         \li "C:/Users/<USER>/Desktop"
    \row \li DocumentsLocation
         \li "~/Documents"
         \li "C:/Users/<USER>/Documents"
    \row \li FontsLocation
         \li "/System/Library/Fonts" (not writable)
         \li "C:/Windows/Fonts" (not writable)
    \row \li ApplicationsLocation
         \li "/Applications" (not writable)
         \li "C:/Users/<USER>/AppData/Roaming/Microsoft/Windows/Start Menu/Programs"
    \row \li MusicLocation
         \li "~/Music"
         \li "C:/Users/<USER>/Music"
    \row \li MoviesLocation
         \li "~/Movies"
         \li "C:/Users/<USER>/Videos"
    \row \li PicturesLocation
         \li "~/Pictures"
         \li "C:/Users/<USER>/Pictures"
    \row \li TempLocation
         \li randomly generated by the OS
         \li "C:/Users/<USER>/AppData/Local/Temp"
    \row \li HomeLocation
         \li "~"
         \li "C:/Users/<USER>"
    \row \li DataLocation
         \li "~/Library/Application Support/<APPNAME>", "/Library/Application Support/<APPNAME>". "<APPDIR>/../Resources"
         \li "C:/Users/<USER>/AppData/Local/<APPNAME>", "C:/ProgramData/<APPNAME>", "<APPDIR>", "<APPDIR>/data"
    \row \li CacheLocation
         \li "~/Library/Caches/<APPNAME>", "/Library/Caches/<APPNAME>"
         \li "C:/Users/<USER>/AppData/Local/<APPNAME>/cache"
    \row \li GenericDataLocation
         \li "~/Library/Application Support", "/Library/Application Support"
         \li "C:/Users/<USER>/AppData/Local", "C:/ProgramData"
    \row \li RuntimeLocation
         \li "~/Library/Application Support"
         \li "C:/Users/<USER>"
    \row \li ConfigLocation
         \li "~/Library/Preferences"
         \li "C:/Users/<USER>/AppData/Local/<APPNAME>", "C:/ProgramData/<APPNAME>"
    \row \li GenericConfigLocation
         \li "~/Library/Preferences"
         \li "C:/Users/<USER>/AppData/Local", "C:/ProgramData"
    \row \li DownloadLocation
         \li "~/Documents"
         \li "C:/Users/<USER>/Documents"
    \row \li GenericCacheLocation
         \li "~/Library/Caches", "/Library/Caches"
         \li "C:/Users/<USER>/AppData/Local/cache"
    \endtable

    \table
    \header \li Path type \li Linux (including Android)
    \row \li DesktopLocation
         \li "<APPROOT>/data"
         \li "~/Desktop"
    \row \li DocumentsLocation
         \li "<APPROOT>/shared/documents"
         \li "~/Documents"
    \row \li FontsLocation
         \li "/base/usr/fonts" (not writable)
         \li "~/.fonts"
    \row \li ApplicationsLocation
         \li not supported (directory not readable)
         \li "~/.local/share/applications", "/usr/local/share/applications", "/usr/share/applications"
    \row \li MusicLocation
         \li "<APPROOT>/shared/music"
         \li "~/Music"
    \row \li MoviesLocation
         \li "<APPROOT>/shared/videos"
         \li "~/Videos"
    \row \li PicturesLocation
         \li "<APPROOT>/shared/photos"
         \li "~/Pictures"
    \row \li TempLocation
         \li "/var/tmp"
         \li "/tmp"
    \row \li HomeLocation
         \li "<APPROOT>/data"
         \li "~"
    \row \li DataLocation
         \li "<APPROOT>/data", "<APPROOT>/app/native/assets"
         \li "~/.local/share/<APPNAME>", "/usr/local/share/<APPNAME>", "/usr/share/<APPNAME>"
    \row \li CacheLocation
         \li "<APPROOT>/data/Cache"
         \li "~/.cache/<APPNAME>"
    \row \li GenericDataLocation
         \li "<APPROOT>/shared/misc"
         \li "~/.local/share", "/usr/local/share", "/usr/share"
    \row \li RuntimeLocation
         \li "/var/tmp"
         \li "/run/user/<USER>"
    \row \li ConfigLocation
         \li "<APPROOT>/data/Settings"
         \li "~/.config", "/etc/xdg"
    \row \li GenericConfigLocation
         \li "<APPROOT>/data/Settings"
         \li "~/.config", "/etc/xdg"
    \row \li DownloadLocation
         \li "<APPROOT>/shared/downloads"
         \li "~/Downloads"
    \row \li GenericCacheLocation
         \li "<APPROOT>/data/Cache" (there is no shared cache)
         \li "~/.cache"
    \endtable

    In the table above, \c <APPNAME> is usually the organization name, the
    application name, or both, or a unique name generated at packaging.
    Similarly, <APPROOT> is the location where this application is installed
    (often a sandbox). <APPDIR> is the directory containing the application
    executable.

    The paths above should not be relied upon, as they may change according to
    OS configuration, locale, or they may change in future Qt versions.

    \sa writableLocation(), standardLocations(), displayName(), locate(), locateAll()
*/

/*!
    \fn QString QStandardPaths::writableLocation(StandardLocation type)

    Returns the directory where files of \a type should be written to, or an empty string
    if the location cannot be determined.

    \note The storage location returned can be a directory that does not exist; i.e., it
    may need to be created by the system or the user.
*/


/*!
   \fn QStringList QStandardPaths::standardLocations(StandardLocation type)

   Returns all the directories where files of \a type belong.

   The list of directories is sorted from high to low priority, starting with
   writableLocation() if it can be determined. This list is empty if no locations
   for \a type are defined.

   \sa writableLocation()
 */

/*!
    \enum QStandardPaths::LocateOption

    This enum describes the different flags that can be used for
    controlling the behavior of QStandardPaths::locate and
    QStandardPaths::locateAll.

    \value LocateFile return only files
    \value LocateDirectory return only directories
*/

static bool existsAsSpecified(const QString &path, QStandardPaths::LocateOptions options)
{
   if (options & QStandardPaths::LocateDirectory) {
      return QDir(path).exists();
   }
   return QFileInfo(path).isFile();
}

/*!
   Tries to find a file or directory called \a fileName in the standard locations
   for \a type.

   The full path to the first file or directory (depending on \a options) found is returned.
   If no such file or directory can be found, an empty string is returned.
 */
QString QStandardPaths::locate(StandardLocation type, const QString &fileName, LocateOptions options)
{
   const QStringList &dirs = standardLocations(type);
   for (QStringList::const_iterator dir = dirs.constBegin(); dir != dirs.constEnd(); ++dir) {
      const QString path = *dir + QLatin1Char('/') + fileName;
      if (existsAsSpecified(path, options)) {
         return path;
      }
   }
   return QString();
}

/*!
   Tries to find all files or directories called \a fileName in the standard locations
   for \a type.

   The \a options flag allows to specify whether to look for files or directories.

   Returns the list of all the files that were found.
 */
QStringList QStandardPaths::locateAll(StandardLocation type, const QString &fileName, LocateOptions options)
{
   const QStringList &dirs = standardLocations(type);
   QStringList result;
   for (QStringList::const_iterator dir = dirs.constBegin(); dir != dirs.constEnd(); ++dir) {
      const QString path = *dir + QLatin1Char('/') + fileName;
      if (existsAsSpecified(path, options)) {
         result.append(path);
      }
   }
   return result;
}

#ifdef Q_OS_WIN
static QStringList executableExtensions()
{
   // If %PATHEXT% does not contain .exe, it is either empty, malformed, or distorted in ways that we cannot support, anyway.
   const QStringList pathExt = QString::fromLocal8Bit(qgetenv("PATHEXT")).toLower().split(QLatin1Char(';'));
   return pathExt.contains(QLatin1String(".exe"), Qt::CaseInsensitive) ?
          pathExt :
          QStringList() << QLatin1String(".exe") << QLatin1String(".com")
          << QLatin1String(".bat") << QLatin1String(".cmd");
}
#endif

static QString checkExecutable(const QString &path)
{
   const QFileInfo info(path);
   if (info.isFile() && info.isExecutable()) {
      return QDir::cleanPath(path);
   }
   return QString();
}

static inline QString searchExecutable(const QStringList &searchPaths,
                                       const QString &executableName)
{
   const QDir currentDir = QDir::current();
   foreach (const QString & searchPath, searchPaths) {
      const QString candidate = currentDir.absoluteFilePath(searchPath + QLatin1Char('/') + executableName);
      const QString absPath = checkExecutable(candidate);
      if (!absPath.isEmpty()) {
         return absPath;
      }
   }
   return QString();
}

#ifdef Q_OS_WIN

// Find executable appending candidate suffixes, used for suffix-less executables
// on Windows.
static inline QString
searchExecutableAppendSuffix(const QStringList &searchPaths,
                             const QString &executableName,
                             const QStringList &suffixes)
{
   const QDir currentDir = QDir::current();
   foreach (const QString & searchPath, searchPaths) {
      const QString candidateRoot = currentDir.absoluteFilePath(searchPath + QLatin1Char('/') + executableName);
      foreach (const QString & suffix, suffixes) {
         const QString absPath = checkExecutable(candidateRoot + suffix);
         if (!absPath.isEmpty()) {
            return absPath;
         }
      }
   }
   return QString();
}

#endif // Q_OS_WIN

/*!
  Finds the executable named \a executableName in the paths specified by \a paths,
  or the system paths if \a paths is empty.

  On most operating systems the system path is determined by the PATH environment variable.

  The directories where to search for the executable can be set in the \a paths argument.
  To search in both your own paths and the system paths, call findExecutable twice, once with
  \a paths set and once with \a paths empty.

  Symlinks are not resolved, in order to preserve behavior for the case of executables
  whose behavior depends on the name they are invoked with.

  \note On Windows, the usual executable extensions (from the PATHEXT environment variable)
  are automatically appended, so that for instance findExecutable("foo") will find foo.exe
  or foo.bat if present.

  Returns the absolute file path to the executable, or an empty string if not found.
 */
QString QStandardPaths::findExecutable(const QString &executableName, const QStringList &paths)
{
   if (QFileInfo(executableName).isAbsolute()) {
      return checkExecutable(executableName);
   }

   QStringList searchPaths = paths;
   if (paths.isEmpty()) {
      QByteArray pEnv = qgetenv("PATH");
#if defined(Q_OS_WIN)
      const QLatin1Char pathSep(';');
#else
      const QLatin1Char pathSep(':');
#endif
      // Remove trailing slashes, which occur on Windows.
      const QStringList rawPaths = QString::fromLocal8Bit(pEnv.constData()).split(pathSep, QString::SkipEmptyParts);
      searchPaths.reserve(rawPaths.size());
      foreach (const QString & rawPath, rawPaths) {
         QString cleanPath = QDir::cleanPath(rawPath);
         if (cleanPath.size() > 1 && cleanPath.endsWith(QLatin1Char('/'))) {
            cleanPath.truncate(cleanPath.size() - 1);
         }
         searchPaths.push_back(cleanPath);
      }
   }

#ifdef Q_OS_WIN
   // On Windows, if the name does not have a suffix or a suffix not
   // in PATHEXT ("xx.foo"), append suffixes from PATHEXT.
   static const QStringList executable_extensions = executableExtensions();
   if (executableName.contains(QLatin1Char('.'))) {
      const QString suffix = QFileInfo(executableName).suffix();
      if (suffix.isEmpty() || !executable_extensions.contains(QLatin1Char('.') + suffix, Qt::CaseInsensitive)) {
         return searchExecutableAppendSuffix(searchPaths, executableName, executable_extensions);
      }
   } else {
      return searchExecutableAppendSuffix(searchPaths, executableName, executable_extensions);
   }
#endif
   return searchExecutable(searchPaths, executableName);
}

/*!
    \fn QString QStandardPaths::displayName(StandardLocation type)

    Returns a localized display name for the given location \a type or
    an empty QString if no relevant location can be found.
*/

#if !defined(Q_OS_MAC)
QString QStandardPaths::displayName(StandardLocation type)
{
   switch (type) {
      case DesktopLocation:
         return QCoreApplication::translate("QStandardPaths", "Desktop");
      case DocumentsLocation:
         return QCoreApplication::translate("QStandardPaths", "Documents");
      case FontsLocation:
         return QCoreApplication::translate("QStandardPaths", "Fonts");
      case ApplicationsLocation:
         return QCoreApplication::translate("QStandardPaths", "Applications");
      case MusicLocation:
         return QCoreApplication::translate("QStandardPaths", "Music");
      case MoviesLocation:
         return QCoreApplication::translate("QStandardPaths", "Movies");
      case PicturesLocation:
         return QCoreApplication::translate("QStandardPaths", "Pictures");
      case TempLocation:
         return QCoreApplication::translate("QStandardPaths", "Temporary Directory");
      case HomeLocation:
         return QCoreApplication::translate("QStandardPaths", "Home");
      case DataLocation:
         return QCoreApplication::translate("QStandardPaths", "Application Data");
      case CacheLocation:
         return QCoreApplication::translate("QStandardPaths", "Cache");
      case GenericDataLocation:
         return QCoreApplication::translate("QStandardPaths", "Shared Data");
      case RuntimeLocation:
         return QCoreApplication::translate("QStandardPaths", "Runtime");
      case ConfigLocation:
         return QCoreApplication::translate("QStandardPaths", "Configuration");
      case GenericConfigLocation:
         return QCoreApplication::translate("QStandardPaths", "Shared Configuration");
      case GenericCacheLocation:
         return QCoreApplication::translate("QStandardPaths", "Shared Cache");
      case DownloadLocation:
         return QCoreApplication::translate("QStandardPaths", "Download");
   }
   // not reached
   return QString();
}
#endif

QT_END_NAMESPACE

#endif // QT_NO_STANDARDPATHS