ProcessJSONInstaller.module

<?php

require_once 'classes/Dependency.php';
require_once 'classes/Module.php';
require_once 'classes/JSONLoader.php';

/**
 * JSON Installer Module
 *
 * A tool for common used setup processes
 *
 * Copyright 2013 by Pieter Beulque
 *
 * ProcessWire 2.x
 * Copyright (C) 2012 by Ryan Cramer
 * Licensed under GNU/GPL v2, see LICENSE.TXT
 *
 * http://processwire.com
 *
 */

class ProcessJSONInstaller extends Process {

    public static $moduleInfo = array(
        'title' => 'JSON Installer',
        'summary' => 'Run JSON files to create fields, templates and pages and install Plugin Modules',
        'version' => 03,
        'author' => 'Pieter Beulque',
        'permission' => 'page-edit',
    );

    public static function getModuleInfo() {
        return self::$moduleInfo;
    }

    const pageName = 'json-installer';
    const confirmParam = 'confirm';
    const emptyModuleName = '"EMPTY MODULE NAME"';

    /**
     * Array containing all installable modules
     */
    protected $installableModules;
    protected $jsonLoader;

    /**
     * The base URL for the module
     */
    protected $url;

    public function init() {
        parent::init(); // required
        $this->jsonLoader = JSONInstaller\JSONLoader::create();
        $this->url = wire('pages')->get('template=admin, name=' . self::pageName)->url;
    }

    public function ___execute() {
        $table = $this->modules->get('MarkupAdminDataTable');
        $config = $this->config;

        $headerColumns = array(
            'name',
            'description'
        );

        if ($config->advanced) {
            $headerColumns[] = 'also un-/installs';
            $headerColumns[] = 'install';
            $headerColumns[] = 'uninstall';
        } else {
            $headerColumns[] = 'also installs';
            $headerColumns[] = 'action';
        }

        $table->headerRow($headerColumns);

        $installableModules = $this->jsonLoader->getModules();

        foreach ($installableModules as $key => $module) {

            $jsonDependencies = array();
            foreach ($module->jsonDependencies as $jsonDependency) {
                if(isset($jsonDependency->name)) {
                    $jsonDependencies[] = $jsonDependency->name;
                }
            }

            if(count($jsonDependencies) > 0) {
                $alsoInstalls = implode(', ', $jsonDependencies);
            } else {
                $alsoInstalls = '';
            }

            $contentColumns = array(
                $module->name,
                $module->description,
                $alsoInstalls,
                'Install' => $this->url . 'install/' . $key
            );

            if ($config->advanced) {
                if ($module->hasDeletableItems($forceDryRun = true)) {
                    $contentColumns['Uninstall'] = $this->url . 'uninstall/' . $key . '/' . self::confirmParam;
                } else {
                    $contentColumns[] = 'n/a';
                }

            }

            $table->row($contentColumns);
        }

        $table->action(array('Export site' => $this->url . 'export/'));

        $out = $table->render();
        return $out;
    }

    protected function addFolderToZip ($dir, $zip) {
        $actualDir = $dir;
        $dirName = substr($dir, strpos($dir, '/site/') + 1);

        if ($dh = opendir($actualDir)) {
            $zip->addEmptyDir($dirName);

            while (($file = readdir($dh)) !== false) {
                if ($file === '.' || $file === '..' || $file === '.DS_Store') continue;

                if (!is_file($actualDir . '/' . $file)) {
                    if ($file !== '.git') {
                        $this->addFolderToZip($actualDir . '/' . $file, $zip);
                    }
                    continue;
                }

                $zip->addFile($dir . '/' . $file, $dirName . '/' . $file);
            }
        }
    }

    protected function buildZipArchive() {
        $directories = array('site/install', 'site/modules', 'site/templates');
        $zip = new ZipArchive();

        $filePath = $this->config->paths->root . 'site/assets/site-export-' . date('Y-m-d') . '.zip';

        if ($zip->open($filePath, ZipArchive::CREATE) === TRUE) {
            foreach ($directories as $dir) {
                $this->addFolderToZip($this->config->paths->root . $dir, $zip);
            }

            $zip->close();
        }

        return $filePath;
    }

    public function ___executeExport() {

        $this->breadcrumbs->add(new Breadcrumb($this->url, self::$moduleInfo['title']));
        $this->fuel->set('processHeadline', 'Export');

        $export = $this->modules->get('ProcessExportProfile');

        if (!$export) {
            $this->error('You need the ProcessExportProfile module for this.');
            return $this->___execute();
        }

        if (!$export->___executeRemove()) {
            $this->error('Something went wrong cleaning a leftover install');
        }

        if (!$export->___executeDump()) {
            $this->error('Something went wrong executing the database dump');
        }

        if (!$export->___executeCopy()) {
            $this->error('Something went wrong copying your files');
        }

        $filename = $_SERVER['HTTP_REFERER'];
        $filename = substr($filename, strpos($filename, '//') + 2);
        $filename = substr($filename, 0, strpos($filename, '/admin/'));
        $filename = str_replace(array('.', '/'), '-', $filename);

        $file = $this->buildZipArchive();

        header('Content-Type: application/zip');
        header('Content-Transfer-Encoding: Binary');
        header('Content-disposition: attachment; filename="export-' . $filename . '-' . date('Ymd') . '.zip' . '"');
        readfile($file);
    }

    public function installModule($name) {
        if (!$this->jsonLoader) {
            $this->jsonLoader = JSONInstaller\JSONLoader::create();
        }

        $module = $this->jsonLoader->getModule($name);

        $altName = $name ? $name : self::emptyModuleName;

        if ($module) {
            $module->install();
        } else {
            throw new WireException('Module ' . $altName . ' does not exist.');
        }

        $module = $this->jsonLoader->getModule($name);

        $altName = $name ? $name : self::emptyModuleName;

        if ($module) {
            $module->install();
        } else {
            throw new WireException('Module ' . $altName . ' does not exist.');
        }

        return $module;
    }

    public function uninstallModule($name, $dryRun = false) {
        $module = $this->jsonLoader->getModule($name);

        $altName = $name ? $name : self::emptyModuleName;

        if ($module) {
            $module->uninstall($dryRun);
        } else {
            throw new WireException('Module ' . $altName . ' does not exist.');
        }

        return $module;
    }

    /**
     * Called when the URL is this module's page URL + "/install/?:name/"
     */
    public function ___executeInstall() {
        try {
            $module = $this->installModule($this->input->urlSegment(2));
        } catch (WireException $e) {
            $this->error($e->getMessage());
            return $this->failOutput();
        }

        $this->message('Succesfully installed or updated ' . $module->name);

        $skippedItems = JSONInstaller\Module::getAllSkippedItems();
        if ($skippedItems) {
            $this->error('Some items were skipped');
        }

        $headline = 'Installed ' . $module->name;

        $this->fuel->set('processHeadline', $headline);

        $this->breadcrumbs->add(new Breadcrumb($this->url, self::$moduleInfo['title']));

        $outputTemplate= self::getTemplate('install');
        $outputTemplate->setArray(array(
            'headline' => $headline,
            'skippedItems' => $skippedItems,
            'modules' => JSONInstaller\Module::$installedModules
        ));

        return $outputTemplate->render();
    }

    /**
     * Called when the URL is this module's page URL + "/uninstall/?:name/"
     */
    public function ___executeUninstall() {
        $name = $this->input->urlSegment(2);
        $confirm = $this->input->urlSegment(3);

        if($confirm === self::confirmParam) {
            return $this->confirmUninstall();
        }

        try {
            $this->breadcrumbs->add(new Breadcrumb($this->url, self::$moduleInfo['title']));

            $module = $this->uninstallModule($this->input->urlSegment(2));
            $headline = 'Uninstalled ' . $module->name;
            $this->fuel->set('processHeadline', $headline);

            $outputTemplate= self::getTemplate('uninstall');
            $outputTemplate->setArray(array(
                'headline' => $headline,
                'modules' => JSONInstaller\Module::$uninstalledModules
            ));

        } catch (WireException $e) {
            $this->error($e->getMessage());
            return $this->failOutput();
        }

        return $outputTemplate->render();
    }

    /**
     * Called when the URL is this module's page URL + "/confirmuninstall/?:name/"
     */
    protected function ___confirmUninstall() {
        $this->breadcrumbs->add(new Breadcrumb($this->url, self::$moduleInfo['title']));

        $name = $this->input->urlSegment(2);

        $module = $this->uninstallModule($name, $dryRun = true);

        $headline = 'Confirm uninstallation of ' . $module->name;
        $isNotInstalledYet = !$module->hasDeletableItems($forceDryRun = false);

        $this->fuel->set('processHeadline', $headline);

        if (!$isNotInstalledYet) {
            $this->message('This feature is experimental.');
            $this->message('The uninstall process will try to delete all pages, templates and fields defined in this module json, so if you included directives to merely modify existing pages, templates or fields, you should add a "prefab" property to each of those and set it to "true".');
            $this->message('Nothing will be deleted until you click the "Uninstall!" button below.');
        }

        $outputTemplate= self::getTemplate('confirm-uninstall');
        $outputTemplate->setArray(array(
            'headline' => $headline,
            'modules' => JSONInstaller\Module::$dryRunUninstalledModules,
            'isNotInstalledYet' => $isNotInstalledYet
        ));

        $out = $outputTemplate->render();

        if (!$isNotInstalledYet) {
            $button = $this->modules->get('InputfieldButton');
            $button->href = $this->url . 'uninstall/' . $name;
            $button->value = 'Uninstall!';

            $out .= $button->render();
        }

        return $out;
    }

    public function ___failOutput() {
        $outputTemplate = self::getTemplate('fail');
        $this->fuel->set('processHeadline', 'Fail');
        $outputTemplate->setArray(array(
            'headline' => 'Whoops! Something went wrong'
        ));
        return $outputTemplate->render();
    }

    public function ___install() {
        $page = new Page();
        $page->template = 'admin';
        $page->name = self::pageName;
        $page->parent = $this->pages->get($this->config->adminRootPageID)->child('name=setup');
        $page->process = $this;
        $page->title = 'JSON Installer';
        $page->save();

        $this->message('Created page: ' . $page->path);

        $this->installModule('config');
        $this->message('Ran config installation script');
    }

    public function ___uninstall() {
        $moduleID = $this->modules->getModuleID($this);
        $page = $this->pages->get('template=admin,process=' . $moduleID . ',name=' . self::pageName);

        if ($page->id) {
            $this->message('Deleting Page: ' . $page->path);
            $page->delete();
        }
    }

    protected static function getTemplate($templateName) {
        $file = dirname(__FILE__) . '/templates/' . $templateName . '.php';
        return new TemplateFile($file);
    }
}