Chris@13: <?php
Chris@13: 
Chris@13: /*
Chris@13:  * This file is part of Psy Shell.
Chris@13:  *
Chris@13:  * (c) 2012-2018 Justin Hileman
Chris@13:  *
Chris@13:  * For the full copyright and license information, please view the LICENSE
Chris@13:  * file that was distributed with this source code.
Chris@13:  */
Chris@13: 
Chris@13: namespace Psy;
Chris@13: 
Chris@13: use XdgBaseDir\Xdg;
Chris@13: 
Chris@13: /**
Chris@13:  * A Psy Shell configuration path helper.
Chris@13:  */
Chris@13: class ConfigPaths
Chris@13: {
Chris@13:     /**
Chris@13:      * Get potential config directory paths.
Chris@13:      *
Chris@13:      * Returns `~/.psysh`, `%APPDATA%/PsySH` (when on Windows), and all
Chris@13:      * XDG Base Directory config directories:
Chris@13:      *
Chris@13:      *     http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
Chris@13:      *
Chris@13:      * @return string[]
Chris@13:      */
Chris@13:     public static function getConfigDirs()
Chris@13:     {
Chris@13:         $xdg = new Xdg();
Chris@13: 
Chris@13:         return self::getDirNames($xdg->getConfigDirs());
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Get potential home config directory paths.
Chris@13:      *
Chris@13:      * Returns `~/.psysh`, `%APPDATA%/PsySH` (when on Windows), and the
Chris@13:      * XDG Base Directory home config directory:
Chris@13:      *
Chris@13:      *     http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
Chris@13:      *
Chris@13:      * @return string[]
Chris@13:      */
Chris@13:     public static function getHomeConfigDirs()
Chris@13:     {
Chris@13:         $xdg = new Xdg();
Chris@13: 
Chris@13:         return self::getDirNames([$xdg->getHomeConfigDir()]);
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Get the current home config directory.
Chris@13:      *
Chris@13:      * Returns the highest precedence home config directory which actually
Chris@13:      * exists. If none of them exists, returns the highest precedence home
Chris@13:      * config directory (`%APPDATA%/PsySH` on Windows, `~/.config/psysh`
Chris@13:      * everywhere else).
Chris@13:      *
Chris@13:      * @see self::getHomeConfigDirs
Chris@13:      *
Chris@13:      * @return string
Chris@13:      */
Chris@13:     public static function getCurrentConfigDir()
Chris@13:     {
Chris@13:         $configDirs = self::getHomeConfigDirs();
Chris@13:         foreach ($configDirs as $configDir) {
Chris@17:             if (@\is_dir($configDir)) {
Chris@13:                 return $configDir;
Chris@13:             }
Chris@13:         }
Chris@13: 
Chris@13:         return $configDirs[0];
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Find real config files in config directories.
Chris@13:      *
Chris@13:      * @param string[] $names     Config file names
Chris@13:      * @param string   $configDir Optionally use a specific config directory
Chris@13:      *
Chris@13:      * @return string[]
Chris@13:      */
Chris@13:     public static function getConfigFiles(array $names, $configDir = null)
Chris@13:     {
Chris@13:         $dirs = ($configDir === null) ? self::getConfigDirs() : [$configDir];
Chris@13: 
Chris@13:         return self::getRealFiles($dirs, $names);
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Get potential data directory paths.
Chris@13:      *
Chris@13:      * If a `dataDir` option was explicitly set, returns an array containing
Chris@13:      * just that directory.
Chris@13:      *
Chris@13:      * Otherwise, it returns `~/.psysh` and all XDG Base Directory data directories:
Chris@13:      *
Chris@13:      *     http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
Chris@13:      *
Chris@13:      * @return string[]
Chris@13:      */
Chris@13:     public static function getDataDirs()
Chris@13:     {
Chris@13:         $xdg = new Xdg();
Chris@13: 
Chris@13:         return self::getDirNames($xdg->getDataDirs());
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Find real data files in config directories.
Chris@13:      *
Chris@13:      * @param string[] $names   Config file names
Chris@13:      * @param string   $dataDir Optionally use a specific config directory
Chris@13:      *
Chris@13:      * @return string[]
Chris@13:      */
Chris@13:     public static function getDataFiles(array $names, $dataDir = null)
Chris@13:     {
Chris@13:         $dirs = ($dataDir === null) ? self::getDataDirs() : [$dataDir];
Chris@13: 
Chris@13:         return self::getRealFiles($dirs, $names);
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Get a runtime directory.
Chris@13:      *
Chris@13:      * Defaults to  `/psysh` inside the system's temp dir.
Chris@13:      *
Chris@13:      * @return string
Chris@13:      */
Chris@13:     public static function getRuntimeDir()
Chris@13:     {
Chris@13:         $xdg = new Xdg();
Chris@13: 
Chris@17:         \set_error_handler(['Psy\Exception\ErrorException', 'throwException']);
Chris@13: 
Chris@13:         try {
Chris@13:             // XDG doesn't really work on Windows, sometimes complains about
Chris@13:             // permissions, sometimes tries to remove non-empty directories.
Chris@13:             // It's a bit flaky. So we'll give this a shot first...
Chris@13:             $runtimeDir = $xdg->getRuntimeDir(false);
Chris@13:         } catch (\Exception $e) {
Chris@13:             // Well. That didn't work. Fall back to a boring old folder in the
Chris@13:             // system temp dir.
Chris@17:             $runtimeDir = \sys_get_temp_dir();
Chris@13:         }
Chris@13: 
Chris@17:         \restore_error_handler();
Chris@13: 
Chris@17:         return \strtr($runtimeDir, '\\', '/') . '/psysh';
Chris@13:     }
Chris@13: 
Chris@13:     private static function getDirNames(array $baseDirs)
Chris@13:     {
Chris@17:         $dirs = \array_map(function ($dir) {
Chris@17:             return \strtr($dir, '\\', '/') . '/psysh';
Chris@13:         }, $baseDirs);
Chris@13: 
Chris@13:         // Add ~/.psysh
Chris@17:         if ($home = \getenv('HOME')) {
Chris@17:             $dirs[] = \strtr($home, '\\', '/') . '/.psysh';
Chris@13:         }
Chris@13: 
Chris@13:         // Add some Windows specific ones :)
Chris@17:         if (\defined('PHP_WINDOWS_VERSION_MAJOR')) {
Chris@17:             if ($appData = \getenv('APPDATA')) {
Chris@13:                 // AppData gets preference
Chris@17:                 \array_unshift($dirs, \strtr($appData, '\\', '/') . '/PsySH');
Chris@13:             }
Chris@13: 
Chris@17:             $dir = \strtr(\getenv('HOMEDRIVE') . '/' . \getenv('HOMEPATH'), '\\', '/') . '/.psysh';
Chris@17:             if (!\in_array($dir, $dirs)) {
Chris@13:                 $dirs[] = $dir;
Chris@13:             }
Chris@13:         }
Chris@13: 
Chris@13:         return $dirs;
Chris@13:     }
Chris@13: 
Chris@13:     private static function getRealFiles(array $dirNames, array $fileNames)
Chris@13:     {
Chris@13:         $files = [];
Chris@13:         foreach ($dirNames as $dir) {
Chris@13:             foreach ($fileNames as $name) {
Chris@13:                 $file = $dir . '/' . $name;
Chris@17:                 if (@\is_file($file)) {
Chris@13:                     $files[] = $file;
Chris@13:                 }
Chris@13:             }
Chris@13:         }
Chris@13: 
Chris@13:         return $files;
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Ensure that $file exists and is writable, make the parent directory if necessary.
Chris@13:      *
Chris@13:      * Generates E_USER_NOTICE error if either $file or its directory is not writable.
Chris@13:      *
Chris@13:      * @param string $file
Chris@13:      *
Chris@13:      * @return string|false Full path to $file, or false if file is not writable
Chris@13:      */
Chris@13:     public static function touchFileWithMkdir($file)
Chris@13:     {
Chris@17:         if (\file_exists($file)) {
Chris@17:             if (\is_writable($file)) {
Chris@13:                 return $file;
Chris@13:             }
Chris@13: 
Chris@17:             \trigger_error(\sprintf('Writing to %s is not allowed.', $file), E_USER_NOTICE);
Chris@13: 
Chris@13:             return false;
Chris@13:         }
Chris@13: 
Chris@17:         $dir = \dirname($file);
Chris@13: 
Chris@17:         if (!\is_dir($dir)) {
Chris@13:             // Just try making it and see if it works
Chris@17:             @\mkdir($dir, 0700, true);
Chris@13:         }
Chris@13: 
Chris@17:         if (!\is_dir($dir) || !\is_writable($dir)) {
Chris@17:             \trigger_error(\sprintf('Writing to %s is not allowed.', $dir), E_USER_NOTICE);
Chris@13: 
Chris@13:             return false;
Chris@13:         }
Chris@13: 
Chris@17:         \touch($file);
Chris@13: 
Chris@13:         return $file;
Chris@13:     }
Chris@13: }