1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 
<?php
namespace Omeka\Controller\Admin;

use Omeka\Form\ModuleStateChangeForm;
use Omeka\Form\ConfirmForm;
use Omeka\Module\Exception\ModuleCannotInstallException;
use Omeka\Module\Manager as OmekaModuleManager;
use Zend\ModuleManager\ModuleManager;
use Omeka\Mvc\Exception;
use Zend\Mvc\Controller\AbstractActionController;
use Zend\View\Model\ViewModel;
use Zend\View\Renderer\PhpRenderer;

class ModuleController extends AbstractActionController
{
    /**
     * @var PhpRenderer
     */
    protected $viewRenderer;

    /**
     * @var ModuleManager
     */
    protected $modules;

    /**
     * @var OmekaModuleManager
     */
    protected $omekaModules;

    /**
     * @param PhpRenderer $viewRenderer
     * @param ModuleManager $modules
     * @param OmekaModuleManager $omekaModules
     */
    public function __construct(PhpRenderer $viewRenderer, ModuleManager $modules,
        OmekaModuleManager $omekaModules
    ) {
        $this->viewRenderer = $viewRenderer;
        $this->modules = $modules;
        $this->omekaModules = $omekaModules;
    }

    public function browseAction()
    {
        // Get modules, filtering modules by state.
        $state = $this->params()->fromQuery('state');
        if ('error' == $state) {
            $modules = array_merge(
                $this->omekaModules->getModulesByState('not_found'),
                $this->omekaModules->getModulesByState('invalid_module'),
                $this->omekaModules->getModulesByState('invalid_ini')
            );
        } elseif ($state) {
            $modules = $this->omekaModules->getModulesByState($state);
        } else {
            $modules = $this->omekaModules->getModules();
        }

        // Order modules by name.
        uasort($modules, function ($a, $b) {
            return strcmp($a->getName(), $b->getName());
        });

        $view = new ViewModel;
        $view->setVariable('modules', $modules);
        $view->setVariable('filterState', $state);
        $view->setVariable('filterStates', [
            'active' => $this->translate('Active'),
            'not_active' => $this->translate('Not active'),
            'not_installed' => $this->translate('Not installed'),
            'needs_upgrade' => $this->translate('Needs upgrade'),
            'error' => $this->translate('Error'),
        ]);
        $view->setVariable('states', [
            'active' => $this->translate('Active'),
            'not_active' => $this->translate('Not active'),
            'not_installed' => $this->translate('Not installed'),
            'needs_upgrade' => $this->translate('Needs upgrade'),
            'not_found' => $this->translate('Not found'),
            'invalid_module' => $this->translate('Invalid module'),
            'invalid_ini' => $this->translate('Invalid INI'),
            'invalid_omeka_version' => $this->translate('Invalid Omeka S version'),
        ]);
        $view->setVariable('stateChangeForm', function ($action, $id) {
            return $this->getForm(ModuleStateChangeForm::class, [
                'module_action' => $action,
                'module_id' => $id,
            ]);
        });
        return $view;
    }

    /**
     * Install a module.
     */
    public function installAction()
    {
        if (!$this->getRequest()->isPost()) {
            return $this->redirect()->toRoute(null, ['action' => 'browse'], true);
        }
        $id = $this->params()->fromQuery('id');
        $form = $this->getForm(ModuleStateChangeForm::class, [
            'module_action' => 'install',
            'module_id' => $id,
        ]);
        $form->setData($this->getRequest()->getPost());
        if (!$form->isValid()) {
            throw new Exception\PermissionDeniedException;
        }
        $module = $this->omekaModules->getModule($id);
        if (!$module) {
            throw new Exception\NotFoundException;
        }
        try {
            $this->omekaModules->install($module);
        } catch (ModuleCannotInstallException $e) {
            $this->messenger()->addError($e->getMessage());
            return $this->redirect()->toRoute(null, ['action' => 'browse'], true);
        }
        $this->messenger()->addSuccess('The module was successfully installed'); // @translate
        if ($module->isConfigurable()) {
            return $this->redirect()->toRoute(
                null, ['action' => 'configure'],
                ['query' => ['id' => $module->getId()]], true
            );
        }
        return $this->redirect()->toRoute(null, ['action' => 'browse'], true);
    }

    public function uninstallConfirmAction()
    {
        $id = $this->params()->fromQuery('id');
        $module = $this->omekaModules->getModule($id);
        if (!$module) {
            throw new Exception\NotFoundException;
        }

        $form = $this->getForm(ConfirmForm::class);
        $form->setAttribute('action', $this->url()->fromRoute(
            null, ['action' => 'uninstall'], ['query' => ['id' => $module->getId()],
        ], true));
        $form->setButtonLabel('Confirm uninstall'); // @translate

        $view = new ViewModel;
        $view->setTerminal(true);
        $view->setTemplate('omeka/admin/module/uninstall-confirm');
        $view->setVariable('form', $form);
        $view->setVariable('module', $module);
        return $view;
    }

    /**
     * Uninstall a module.
     */
    public function uninstallAction()
    {
        if (!$this->getRequest()->isPost()) {
            return $this->redirect()->toRoute(null, ['action' => 'browse'], true);
        }
        $id = $this->params()->fromQuery('id');
        $form = $this->getForm(ConfirmForm::class);
        $form->setData($this->getRequest()->getPost());
        if (!$form->isValid()) {
            throw new Exception\PermissionDeniedException;
        }
        $module = $this->omekaModules->getModule($id);
        if (!$module) {
            throw new Exception\NotFoundException;
        }
        $this->omekaModules->uninstall($module);
        $this->messenger()->addSuccess('The module was successfully uninstalled'); // @translate
        return $this->redirect()->toRoute(null, ['action' => 'browse'], true);
    }

    /**
     * Activate a module or modules.
     */
    public function activateAction()
    {
        if (!$this->getRequest()->isPost()) {
            return $this->redirect()->toRoute(null, ['action' => 'browse'], true);
        }
        $id = $this->params()->fromQuery('id');
        $form = $this->getForm(ModuleStateChangeForm::class, [
            'module_action' => 'activate',
            'module_id' => $id,
        ]);
        $form->setData($this->getRequest()->getPost());
        if (!$form->isValid()) {
            throw new Exception\PermissionDeniedException;
        }
        $module = $this->omekaModules->getModule($id);
        if (!$module) {
            throw new Exception\NotFoundException;
        }
        $this->omekaModules->activate($module);
        $this->messenger()->addSuccess('The module was successfully activated'); // @translate
        return $this->redirect()->toRoute(null, ['action' => 'browse'], true);
    }

    /**
     * Deactivate a module or modules.
     */
    public function deactivateAction()
    {
        if (!$this->getRequest()->isPost()) {
            return $this->redirect()->toRoute(null, ['action' => 'browse'], true);
        }
        $id = $this->params()->fromQuery('id');
        $form = $this->getForm(ModuleStateChangeForm::class, [
            'module_action' => 'deactivate',
            'module_id' => $id,
        ]);
        $form->setData($this->getRequest()->getPost());
        if (!$form->isValid()) {
            throw new Exception\PermissionDeniedException;
        }
        $module = $this->omekaModules->getModule($id);
        if (!$module) {
            throw new Exception\NotFoundException;
        }
        $this->omekaModules->deactivate($module);
        $this->messenger()->addSuccess('The module was successfully deactivated'); // @translate
        return $this->redirect()->toRoute(null, ['action' => 'browse'], true);
    }

    /**
     * Upgrade a module.
     */
    public function upgradeAction()
    {
        if (!$this->getRequest()->isPost()) {
            return $this->redirect()->toRoute(null, ['action' => 'browse'], true);
        }
        $id = $this->params()->fromQuery('id');
        $form = $this->getForm(ModuleStateChangeForm::class, [
            'module_action' => 'upgrade',
            'module_id' => $id,
        ]);
        $form->setData($this->getRequest()->getPost());
        if (!$form->isValid()) {
            throw new Exception\PermissionDeniedException;
        }
        $module = $this->omekaModules->getModule($id);
        if (!$module) {
            throw new Exception\NotFoundException;
        }
        $this->omekaModules->upgrade($module);
        $this->messenger()->addSuccess('The module was successfully upgraded'); // @translate
        return $this->redirect()->toRoute(null, ['action' => 'browse'], true);
    }

    /**
     * Configure a module.
     */
    public function configureAction()
    {
        $id = $this->params()->fromQuery('id');
        $module = $this->omekaModules->getModule($id);
        if (!$module) {
            throw new Exception\NotFoundException;
        }

        $moduleObject = $this->modules->getModule($id);
        if (null === $moduleObject) {
            // Do not attempt to configure an unloaded module.
            throw new Exception\NotFoundException;
        }

        if ($this->getRequest()->isPost()) {
            if (false !== $moduleObject->handleConfigForm($this)) {
                $this->messenger()->addSuccess('The module was successfully configured'); // @translate
                return $this->redirect()->toRoute(null, ['action' => 'browse'], true);
            }
            $this->messenger()->addError('There was a problem during configuration'); // @translate
        }

        $view = new ViewModel;
        $view->setVariable('configForm', $moduleObject->getConfigForm($this->viewRenderer));
        $view->setVariable('module', $module);
        return $view;
    }

    public function showDetailsAction()
    {
        $id = $this->params()->fromQuery('id');
        $module = $this->omekaModules->getModule($id);
        if (!$module) {
            throw new Exception\NotFoundException;
        }

        $view = new ViewModel;
        $view->setTerminal(true);
        $view->setVariable('module', $module);
        return $view;
    }
}