ThreemaGateway_Installer

Complexity

Total Complexity

14

Size/Duplication

Total Lines	207
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	install()	0	78	6
B	uninstall()	0	61	4
A	getProviderInstaller()	0	21	1
A	meetsRequirements()	0	19	3

<?php
/**
 * Add-on installer/uninstaller.
 *
 * @package ThreemaGateway
 * @author rugk
 * @copyright Copyright (c) 2015-2016 rugk
 * @license MIT
*/

/**
 * Installation and uninstallation routines for Threema Gateway.
 */
class ThreemaGateway_Installer
{
    /**
     * At the installation this will check the XenForo version and
     * add the 2FA provider to the table.
     *
     * @param array $installedAddon
     */
    public static function install($installedAddon)
    {
        /** @var array $providerInstaller An array with the models of all providers */
        $providerInstaller = self::getProviderInstaller();
        // check requirements of Gateway
        if (!self::meetsRequirements($error)) {
            throw new XenForo_Exception($error);
        }

        // Get installed add-on version
        /** @var int $oldAddonVersion internal version number of installed addon version */
        $oldAddonVersion = is_array($installedAddon) ? $installedAddon['version_id'] : 0;

        // Not installed
        if ($oldAddonVersion == 0) {
            // add tfa providers to database
            foreach ($providerInstaller as $provider) {
                $provider->add();
            }

            // add permissions
            /** @var ThreemaGateway_Installer_Permissions $permissionsInstaller */
            $permissionsInstaller = new ThreemaGateway_Installer_Permissions;
            // allow everything for registered users by default
            $permissionsInstaller->addForUserGroup(2, 'use', 'allow');
            $permissionsInstaller->addForUserGroup(2, 'send', 'allow');
            $permissionsInstaller->addForUserGroup(2, 'receive', 'allow');
            $permissionsInstaller->addForUserGroup(2, 'fetch', 'allow');
            $permissionsInstaller->addForUserGroup(2, 'lookup', 'allow');
            $permissionsInstaller->addForUserGroup(2, 'tfa', 'allow');

            // allow registered users some basic (uncritical) block actions
            $permissionsInstaller->addForUserGroup(2, 'blockedNotification', 'allow');
            $permissionsInstaller->addForUserGroup(2, 'blockTfaMode', 'allow');

            // allow all block actions for mods (& thus also admins)
            $permissionsInstaller->addForUserGroup(4, 'blockedNotification', 'allow');
            $permissionsInstaller->addForUserGroup(4, 'blockTfaMode', 'allow');
            $permissionsInstaller->addForUserGroup(4, 'blockUser', 'allow'); // not possible as mods/admins cannot be blocked, but we allow it :)
            $permissionsInstaller->addForUserGroup(4, 'blockIp', 'allow');

            // create public key store
            /** @var ThreemaGateway_Installer_Keystore $keystoreInstaller */
            $keystoreInstaller = new ThreemaGateway_Installer_Keystore;
            $keystoreInstaller->create();

            // create custom user field
            /** @var XenForo_DataWriter $userFieldWriter */
            $userFieldWriter = XenForo_DataWriter::create('XenForo_DataWriter_UserField');
            $userFieldWriter->set('field_id', 'threemaid');
            $userFieldWriter->set('display_group', 'contact');
            $userFieldWriter->set('display_order', 120);
            $userFieldWriter->set('field_type', 'textbox');
            $userFieldWriter->set('match_type', 'callback');
            $userFieldWriter->set('match_callback_class', 'ThreemaGateway_Helper_UserField');
            $userFieldWriter->set('match_callback_method', 'verifyThreemaId');
            $userFieldWriter->set('max_length', 8);
            $userFieldWriter->save();

            // create tables for messages
            /** @var ThreemaGateway_Installer_MessagesDb $messageDbInstaller */
            $messageDbInstaller = new ThreemaGateway_Installer_MessagesDb;
            $messageDbInstaller->create();

            // create tfa tables
            /** @var ThreemaGateway_Installer_TfaPendingConfirmMsgs $pendReqInstaller */
            $pendReqInstaller = new ThreemaGateway_Installer_TfaPendingConfirmMsgs;
            $pendReqInstaller->create();
        }

        // introduced in v1.00.00 70 (stable)

36% of this comment could be valid code. Did you maybe forget this after debugging?

        if ($oldAddonVersion < 1000070) {
            // add throttle table
            /** @var ThreemaGateway_Installer_ActionThrottle $throttleInstaller */
            $throttleInstaller = new ThreemaGateway_Installer_ActionThrottle;
            $throttleInstaller->create();
        }
    }

    /**
     * When uninstalling this deletes the unnecessary database entries/tables.
     */
    public static function uninstall()
    {
        // delete throttle table
        /** @var ThreemaGateway_Installer_ActionThrottle $throttleInstaller */
        $throttleInstaller = new ThreemaGateway_Installer_ActionThrottle;
        $throttleInstaller->destroy();

        // delete tfa tables
        /** @var ThreemaGateway_Installer_TfaPendingConfirmMsgs $pendReqInstaller */
        $pendReqInstaller = new ThreemaGateway_Installer_TfaPendingConfirmMsgs;
        $pendReqInstaller->destroy();

        // remove message tables
        /** @var ThreemaGateway_Installer_MessagesDb $messageDbInstaller */
        $messageDbInstaller = new ThreemaGateway_Installer_MessagesDb;
        $messageDbInstaller->destroy();

        /** @var array $providerInstaller An array with the models of all providers */
        $providerInstaller = self::getProviderInstaller();

        // delete tfa provider from database
        foreach ($providerInstaller as $provider) {
            $provider->delete();
        }

        // delete keystore
        /** @var ThreemaGateway_Installer_Keystore $keystoreInstaller */
        $keystoreInstaller = new ThreemaGateway_Installer_Keystore;
        $keystoreInstaller->destroy();

        // delete permissions
        /** @var ThreemaGateway_Installer_Permissions $permissionsInstaller */
        $permissionsInstaller = new ThreemaGateway_Installer_Permissions;
        $permissionsInstaller->deleteAll();

        // delete custom user field (if it exists)
        /** @var XenForo_Model_UserField $userFieldModel */
        $userFieldModel = XenForo_Model::create('XenForo_Model_UserField');
        /** @var array $userFieldData fetched data from database */
        if ($userFieldData = $userFieldModel->getUserFieldById('threemaid')) {
            /** @var XenForo_DataWriter $userFieldWriter */
            $userFieldWriter = XenForo_DataWriter::create('XenForo_DataWriter_UserField');
            $userFieldWriter->setExistingData($userFieldData);
            $userFieldWriter->delete();
        }

        /** @var XenForo_Options $xenOptions */
        $xenOptions = XenForo_Application::getOptions();

        try {
            //delete debug log file
            ThreemaGateway_Option_DebugModeLog::removeLog($xenOptions->threema_gateway_logreceivedmsgs);

            //delete private key file if possible
            ThreemaGateway_Option_PrivateKeyPath::removePrivateKey($xenOptions->threema_gateway_privatekeyfile);
        } catch (Exception $e) {
            // ignore errors as deletion operations are additional security
            // features, which may fail in an expected way, e.g. when XenForo
            // does not have write access to these files.
        }
    }

    /**
     * Returns the provider installer needed for modifying the database.
     *
     * @return array
     */
    protected static function getProviderInstaller()
    {
        /** @var array $providerInstaller An array with the models of all providers */
        $providerInstaller = [];

        // add provider
        $providerInstaller['conventional'] = new ThreemaGateway_Installer_TfaProvider(
            ThreemaGateway_Constants::TFA_ID_PREFIX . '_conventional',
            'ThreemaGateway_Tfa_Conventional',
            ThreemaGateway_Constants::TFA_BASE_PRIORITY - 15);
        $providerInstaller['reversed'] = new ThreemaGateway_Installer_TfaProvider(
            ThreemaGateway_Constants::TFA_ID_PREFIX . '_reversed',
            'ThreemaGateway_Tfa_Reversed',
            ThreemaGateway_Constants::TFA_BASE_PRIORITY - 10);
        $providerInstaller['fast'] = new ThreemaGateway_Installer_TfaProvider(
            ThreemaGateway_Constants::TFA_ID_PREFIX . '_fast',
            'ThreemaGateway_Tfa_Fast',
            ThreemaGateway_Constants::TFA_BASE_PRIORITY - 5);

        return $providerInstaller;
    }

    /**
     * At the installation this will check the XenForo version and
     * remove the 2FA provider to the table.
     *
     * @param  string $error Will be filled by a human-readable error description
     *                       when an error occurs
     * @return bool
     */
    protected static function meetsRequirements(&$error)
    {
        /** @var bool $isError whether an error is triggered */
        $isError = false;

        // check XenForo version
        if (XenForo_Application::$versionId < 1050770) {
            $error .= 'This add-on requires XenForo 1.5.7 or higher.' . PHP_EOL;
            $isError = true;
        }

        // check PHP version
        if (version_compare(PHP_VERSION, '5.4', '<')) {
            $error .= 'Threema Gateway requires PHP version 5.4 or higher. Current version: ' . PHP_VERSION . PHP_EOL;
            $isError = true;
        }

        return !$isError;
    }
}