Added new Installer class

system/src/Grav/Common/GPM/Installer.php

@@ -0,0 +1,216 @@
+<?php
+namespace Grav\Common\GPM;
+
+use Grav\Common\Filesystem\Folder;
+
+class Installer
+{
+    /** @const No error */
+    const OK                = 0;
+    /** @const Target already exists */
+    const EXISTS            = 1;
+    /** @const Target is a symbolic link */
+    const IS_LINK           = 2;
+    /** @const Target doesn't exist */
+    const NOT_FOUND         = 4;
+    /** @const Target is not a directory */
+    const NOT_DIRECTORY     = 8;
+    /** @const Target is not a Grav instance */
+    const NOT_GRAV_ROOT     = 16;
+    /** @const Error while trying to open the ZIP package */
+    const ZIP_OPEN_ERROR    = 32;
+    /** @const Error while trying to extract the ZIP package */
+    const ZIP_EXTRACT_ERROR = 64;
+
+    /**
+     * Destination folder on which validation checks are applied
+     * @var string
+     */
+    protected static $target;
+
+    /**
+     * Error Code
+     * @var integer
+     */
+    protected static $error   = 0;
+
+    /**
+     * Default options for the install
+     * @var array
+     */
+    protected static $options = [
+                                'overwrite'       => true,
+                                'ignore_symlinks' => true,
+                                'install_path'    => '',
+                                'exclude_checks'  => [self::EXISTS, self::NOT_FOUND, self::IS_LINK]
+                             ];
+
+    /**
+     * Installs a given package to a given destination.
+     * @param  string  $package     The local path to the ZIP package
+     * @param  string  $destination The local path to the Grav Instance
+     * @param  array   $options     Options to use for installing. ie, ['install_path' => 'user/themes/antimatter']
+     * @return boolean True if everything went fine, False otherwise.
+     */
+    public static function install($package, $destination, $options = [])
+    {
+        $destination  = rtrim($destination, DS);
+        $install_path = $destination . DS . ltrim($options['install_path'], DS);
+        $options = array_merge(self::$options, $options);
+
+        if (!self::isGravInstance($destination) || !self::isValidDestination($install_path, $options['exclude_checks'])) {
+            return false;
+        }
+
+        if (
+            self::lastErrorCode() == self::IS_LINK && $options['ignore_symlinks'] ||
+            self::lastErrorCode() == self::EXISTS && !$options['overwrite']
+            ) {
+            return false;
+        }
+
+        $zip     = new \ZipArchive();
+        $archive = $zip->open($package);
+        $tmp     = sys_get_temp_dir() . DS . 'Grav-' . uniqid();
+
+        if ($archive !== true) {
+            self::$error = self::ZIP_OPEN_ERROR;
+
+            return false;
+        }
+
+        Folder::mkdir($tmp);
+        $container = $zip->getNameIndex(0); // TODO: better way of determining if zip has container folder
+        $unzip     = $zip->extractTo($tmp);
+
+        if (!$unzip) {
+            self::$error = self::ZIP_EXTRACT_ERROR;
+
+            $zip->close();
+            Folder::delete($tmp);
+
+            return false;
+        }
+
+        if (file_exists($install_path)) {
+            Folder::delete($install_path);
+        }
+
+        Folder::move($tmp . DS . $container, $install_path);
+        Folder::delete($tmp);
+
+        $zip->close();
+
+        self::$error = self::OK;
+
+        return true;
+    }
+
+    /**
+     * Runs a set of checks on the destination and sets the Error if any
+     * @param  string  $destination The directory to run validations at
+     * @param  array   $exclude     An array of constants to exclude from the validation
+     * @return boolean True if validation passed. False otherwise
+     */
+    public static function isValidDestination($destination, $exclude = [])
+    {
+        self::$error  = 0;
+        self::$target = $destination;
+
+        if (is_link($destination)) {
+            self::$error = self::IS_LINK;
+        } elseif (file_exists($destination)) {
+            self::$error = self::EXISTS;
+        } elseif (!file_exists($destination)) {
+            self::$error = self::NOT_FOUND;
+        } elseif (!is_dir($destination)) {
+            self::$error = self::NOT_DIRECTORY;
+        }
+
+        if (count($exclude) && in_array(self::$error, $exclude)) {
+            return true;
+        }
+
+        return !(self::$error);
+    }
+
+    /**
+     * Validates if the given path is a Grav Instance
+     * @param  string  $target The local path to the Grav Instance
+     * @return boolean True if is a Grav Instance. False otherwise
+     */
+    public static function isGravInstance($target)
+    {
+        self::$error  = 0;
+        self::$target = $target;
+
+        if (
+            !file_exists($target . DS . 'index.php') ||
+            !file_exists($target . DS . 'bin') ||
+            !file_exists($target . DS . 'user') ||
+            !file_exists($target . DS . 'system' . DS . 'config' . DS . 'system.yaml')
+        ) {
+            self::$error = self::NOT_GRAV_ROOT;
+        }
+
+        return !self::$error;
+    }
+
+    /**
+     * Returns the last error occurred in a string message format
+     * @return string The message of the last error
+     */
+    public static function lastErrorMsg()
+    {
+        $msg = 'Unknown Error';
+
+        switch (self::$error) {
+            case 0:
+                $msg = 'No Error';
+                break;
+
+            case self::EXISTS:
+                $msg = 'The target path "' . self::$target . '" already exists';
+                break;
+
+            case self::IS_LINK:
+                $msg = 'The target path "' . self::$target . '" is a symbolic link';
+                break;
+
+            case self::NOT_FOUND:
+                $msg = 'The target path "' . self::$target . '" does not appear to exist';
+                break;
+
+            case self::NOT_DIRECTORY:
+                $msg = 'The target path "' . self::$target . '" does not appear to be a folder';
+                break;
+
+            case self::NOT_GRAV_ROOT:
+                $msg = 'The target path "' . self::$target . '" does not appear to be a Grav instance';
+                break;
+
+            case self::ZIP_OPEN_ERROR:
+                $msg = 'Unable to open the package file';
+                break;
+
+            case self::ZIP_EXTRACT_ERROR:
+                $msg = 'An error occurred while extracting the package';
+                break;
+
+            default:
+                return 'Unknown error';
+                break;
+        }
+
+        return $msg;
+    }
+
+    /**
+     * Returns the last error code of the occurred error
+     * @return integer The code of the last error
+     */
+    public static function lastErrorCode()
+    {
+        return self::$error;
+    }
+}