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: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 
<?php
namespace Omeka\Module;

use Doctrine\ORM\EntityManager;
use Omeka\Entity\Module as ModuleEntity;
use Omeka\Permissions\Exception as AclException;
use Zend\I18n\Translator\TranslatorInterface;
use Zend\Permissions\Acl\Resource\ResourceInterface;
use Zend\ServiceManager\ServiceLocatorInterface;

class Manager implements ResourceInterface
{
    const STATE_ACTIVE = 'active';
    const STATE_NOT_ACTIVE = 'not_active';
    const STATE_NOT_INSTALLED = 'not_installed';
    const STATE_NOT_FOUND = 'not_found';
    const STATE_INVALID_MODULE = 'invalid_module';
    const STATE_INVALID_INI = 'invalid_ini';
    const STATE_INVALID_OMEKA_VERSION = 'invalid_omeka_version';
    const STATE_NEEDS_UPGRADE = 'needs_upgrade';

    /**
     * @var array Valid module states
     */
    protected $validStates = [
        // A module that is valid, installed, and active
        self::STATE_ACTIVE,
        // A module that is valid, installed, and not active
        self::STATE_NOT_ACTIVE,
        // A module that is in the filesystem but not in the database
        self::STATE_NOT_INSTALLED,
        // A module that is in the database but not in the filesystem
        self::STATE_NOT_FOUND,
        // A module with an invalid Module.php file
        self::STATE_INVALID_MODULE,
        // A module with an invalid config/module.ini file
        self::STATE_INVALID_INI,
        // A module with an Omeka version constraint that doesn't match the current version
        self::STATE_INVALID_OMEKA_VERSION,
        // A module where the filesystem version is newer than the installed version
        self::STATE_NEEDS_UPGRADE,
    ];

    /**
     * @var array Registered modules
     */
    protected $modules = [];

    /**
     * @var EntityManager
     */
    protected $entityManager;

    /**
     * @var TranslatorInterface
     */
    protected $translator;

    /**
     * @var ServiceLocatorInterface
     */
    protected $serviceLocator;

    public function __construct(ServiceLocatorInterface $serviceLocator)
    {
        $this->serviceLocator = $serviceLocator;
    }

    /**
     * Register a new module
     *
     * @param string $id
     * @return Module
     */
    public function registerModule($id)
    {
        $module = new Module($id);
        $this->modules[$id] = $module;
        return $module;
    }

    /**
     * Check whether the module INI is valid
     *
     * @param Module $module
     * @return bool
     */
    public function iniIsValid(Module $module)
    {
        $ini = $module->getIni();
        if (!isset($ini['name'])) {
            return false;
        }
        if (!isset($ini['version'])) {
            return false;
        }
        return true;
    }

    /**
     * Check whether a module is registered
     *
     * @param string $id
     * @return bool
     */
    public function isRegistered($id)
    {
        return array_key_exists($id, $this->modules);
    }

    /**
     * Get a registered module
     *
     * @param string $id
     * @return Module|false Returns false when id is invalid
     */
    public function getModule($id)
    {
        return $this->isRegistered($id) ? $this->modules[$id] : false;
    }

    /**
     * Get all registered modules
     *
     * @return array
     */
    public function getModules()
    {
        return $this->modules;
    }

    /**
     * Get all registered modules by state
     *
     * @param string $state
     * @return array
     */
    public function getModulesByState($state)
    {
        $modules = [];
        foreach ($this->modules as $id => $module) {
            if ($state == $module->getState()) {
                $modules[$id] = $module;
            }
        }
        return $modules;
    }

    /**
     * Activate a module
     *
     * @param Module $module
     */
    public function activate(Module $module)
    {
        $this->authorize($module, 'activate');
        $t = $this->getTranslator();

        // Only a deactivated module can be activated
        if (self::STATE_NOT_ACTIVE !== $module->getState()) {
            throw new Exception\ModuleStateInvalidException(sprintf(
                $t->translate('Module "%s" is marked as "%s" and cannot be activated'),
                $module->getId(), $module->getState()
            ));
        }

        $entity = $this->getModuleEntity($module);
        if ($entity instanceof ModuleEntity) {
            $entity->setIsActive(true);
            $this->getEntityManager()->flush();
        } else {
            throw new Exception\ModuleNotInDatabaseException(sprintf(
                $t->translate('Module "%s" not in database during activation'),
                $module->getId()
            ));
        }

        $module->setState(self::STATE_ACTIVE);
    }

    /**
     * Deactivate a module
     *
     * @param Module $module
     */
    public function deactivate(Module $module)
    {
        $this->authorize($module, 'deactivate');
        $t = $this->getTranslator();

        // Only an active module can be deactivated
        if (self::STATE_ACTIVE !== $module->getState()) {
            throw new Exception\ModuleStateInvalidException(sprintf(
                $t->translate('Module "%s" is marked as "%s" and cannot be deactivated'),
                $module->getId(), $module->getState()
            ));
        }

        $entity = $this->getModuleEntity($module);
        if ($entity instanceof ModuleEntity) {
            $entity->setIsActive(false);
            $this->getEntityManager()->flush();
        } else {
            throw new Exception\ModuleNotInDatabaseException(sprintf(
                $t->translate('Module "%s" not in database during deactivation'),
                $module->getId()
            ));
        }

        $module->setState(self::STATE_NOT_ACTIVE);
    }

    /**
     * Install and activate a module
     *
     * @param Module $module
     */
    public function install(Module $module)
    {
        $this->authorize($module, 'install');

        // Only a not installed module can be installed
        if (self::STATE_NOT_INSTALLED !== $module->getState()) {
            throw new Exception\ModuleStateInvalidException(sprintf(
                $this->getTranslator()->translate('Module "%s" is marked as "%s" and cannot be installed'),
                $module->getId(), $module->getState()
            ));
        }

        // Invoke the module's install method
        $this->getModuleObject($module)->install(
            $this->serviceLocator
        );

        // Persist the module entity
        $entity = new ModuleEntity;
        $entity->setId($module->getId());
        $entity->setIsActive(true);
        $entity->setVersion($module->getIni('version'));

        $this->getEntityManager()->persist($entity);
        $this->getEntityManager()->flush();

        $module->setState(self::STATE_ACTIVE);
    }

    /**
     * Uninstall a module
     *
     * @param Module $module
     */
    public function uninstall(Module $module)
    {
        $this->authorize($module, 'uninstall');
        $t = $this->getTranslator();

        // Only an installed and upgraded module can be uninstalled
        if (!in_array($module->getState(), [
            self::STATE_ACTIVE,
            self::STATE_NOT_ACTIVE,
        ])) {
            throw new Exception\ModuleStateInvalidException(sprintf(
                $t->translate('Module "%s" is marked as "%s" and cannot be uninstalled'),
                $module->getId(), $module->getState()
            ));
        }

        // Invoke the module's uninstall method
        $this->getModuleObject($module)->uninstall(
            $this->serviceLocator
        );

        // Remove the module entity
        $entity = $this->getModuleEntity($module);
        if ($entity instanceof ModuleEntity) {
            $this->getEntityManager()->remove($entity);
            $this->getEntityManager()->flush();
        } else {
            throw new Exception\ModuleNotInDatabaseException(sprintf(
                $t->translate('Module "%s" not found in database during uninstallation'),
                $module->getId()
            ));
        }

        $module->setState(self::STATE_NOT_INSTALLED);
    }

    /**
     * Upgrade a module
     *
     * @param Module $module
     */
    public function upgrade(Module $module)
    {
        $this->authorize($module, 'upgrade');
        $t = $this->getTranslator();

        // Only a module marked for upgrade can be upgraded
        if (self::STATE_NEEDS_UPGRADE !== $module->getState()) {
            throw new Exception\ModuleStateInvalidException(sprintf(
                $t->translate('Module "%s" is marked as "%s" and cannot be upgraded'),
                $module->getId(), $module->getState()
            ));
        }

        $oldVersion = $module->getDb('version');
        $newVersion = $module->getIni('version');

        // Invoke the module's upgrade method
        $this->getModuleObject($module)->upgrade(
            $oldVersion,
            $newVersion,
            $this->serviceLocator
        );

        // Update the module entity
        $entity = $this->getModuleEntity($module);
        if ($entity instanceof ModuleEntity) {
            $entity->setVersion($newVersion);
            $this->getEntityManager()->flush();
        } else {
            throw new Exception\ModuleNotInDatabaseException(sprintf(
                $t->translate('Module "%s" not found in database during upgrade'),
                $module->getId()
            ));
        }

        $module->setState($module->getDb('is_active')
            ? self::STATE_ACTIVE : self::STATE_NOT_ACTIVE);
    }

    /**
     * Get a module entity
     *
     * @param Module $module
     * @return ModuleEntity|null
     */
    protected function getModuleEntity(Module $module)
    {
        return $this->getEntityManager()
            ->getRepository('Omeka\Entity\Module')
            ->findOneById($module->getId());
    }

    /**
     * Get a module object
     *
     * Get from Zend's module manager if loaded (i.e. active), otherwise
     * instantiate a new module object.
     *
     * @param Module $module
     */
    protected function getModuleObject(Module $module)
    {
        $moduleObject = $this->serviceLocator->get('ModuleManager')->getModule($module->getId());
        if (null !== $moduleObject) {
            return $moduleObject;
        }
        $moduleClass = $module->getId() . "\Module";
        return new $moduleClass;
    }

    /**
     * Get the entity manager
     *
     * @return EntityManager
     */
    protected function getEntityManager()
    {
        if (null === $this->entityManager) {
            $this->entityManager = $this->serviceLocator->get('Omeka\EntityManager');
        }
        return $this->entityManager;
    }

    /**
     * Get the translator service
     *
     * return TranslatorInterface
     */
    public function getTranslator()
    {
        if (!$this->translator instanceof TranslatorInterface) {
            $this->translator = $this->serviceLocator->get('MvcTranslator');
        }
        return $this->translator;
    }

    /**
     * Verify that the current user has permission.
     *
     * @throws AclException\PermissionDeniedException
     * @param Module $module
     * @param string $privilege
     */
    protected function authorize(Module $module, $privilege)
    {
        $acl = $this->serviceLocator->get('Omeka\Acl');
        if (!$acl->userIsAllowed($this, $privilege)) {
            throw new AclException\PermissionDeniedException(sprintf(
                $this->getTranslator()->translate(
                    'Permission denied for the current user to %s the %s module.'
                ),
                $privilege, $module->getId()
            ));
        }
    }

    /**
     * {@inheritDoc}
     */
    public function getResourceId()
    {
        return get_called_class();
    }
}