ThreemaGateway_Installer::install() - Code Metrics - rugk/xenforo-threema-gateway - Measure and Improve Code Quality continuously with Scrutinizer

ThreemaGateway_Installer::install() B
last analyzed 2018-04-24 14:39 UTC

↳ Parent: ThreemaGateway_Installer

Complexity

Conditions	6
Paths	9

Size

Total Lines	78
Code Lines	40

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	78
rs	8.4316
c	0
b	0
f	0
cc	6
eloc	40
nc	9
nop	1

How to fix Long Method

<?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)

        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;
    }
}


1			<?php
2			/**
3			* Add-on installer/uninstaller.
4			*
5			* @package ThreemaGateway
6			* @author rugk
7			* @copyright Copyright (c) 2015-2016 rugk
8			* @license MIT
9			*/
10
11			/**
12			* Installation and uninstallation routines for Threema Gateway.
13			*/
14			class ThreemaGateway_Installer
15			{
16			/**
17			* At the installation this will check the XenForo version and
18			* add the 2FA provider to the table.
19			*
20			* @param array $installedAddon
21			*/
22			public static function install($installedAddon)
23			{
24			/** @var array $providerInstaller An array with the models of all providers */
25			$providerInstaller = self::getProviderInstaller();
26			// check requirements of Gateway
27			if (!self::meetsRequirements($error)) {
28			throw new XenForo_Exception($error);
29			}
30
31			// Get installed add-on version
32			/** @var int $oldAddonVersion internal version number of installed addon version */
33			$oldAddonVersion = is_array($installedAddon) ? $installedAddon['version_id'] : 0;
34
35			// Not installed
36			if ($oldAddonVersion == 0) {
37			// add tfa providers to database
38			foreach ($providerInstaller as $provider) {
39			$provider->add();
40			}
41
42			// add permissions
43			/** @var ThreemaGateway_Installer_Permissions $permissionsInstaller */
44			$permissionsInstaller = new ThreemaGateway_Installer_Permissions;
45			// allow everything for registered users by default
46			$permissionsInstaller->addForUserGroup(2, 'use', 'allow');
47			$permissionsInstaller->addForUserGroup(2, 'send', 'allow');
48			$permissionsInstaller->addForUserGroup(2, 'receive', 'allow');
49			$permissionsInstaller->addForUserGroup(2, 'fetch', 'allow');
50			$permissionsInstaller->addForUserGroup(2, 'lookup', 'allow');
51			$permissionsInstaller->addForUserGroup(2, 'tfa', 'allow');
52
53			// allow registered users some basic (uncritical) block actions
54			$permissionsInstaller->addForUserGroup(2, 'blockedNotification', 'allow');
55			$permissionsInstaller->addForUserGroup(2, 'blockTfaMode', 'allow');
56
57			// allow all block actions for mods (& thus also admins)
58			$permissionsInstaller->addForUserGroup(4, 'blockedNotification', 'allow');
59			$permissionsInstaller->addForUserGroup(4, 'blockTfaMode', 'allow');
60			$permissionsInstaller->addForUserGroup(4, 'blockUser', 'allow'); // not possible as mods/admins cannot be blocked, but we allow it :)
61			$permissionsInstaller->addForUserGroup(4, 'blockIp', 'allow');
62
63			// create public key store
64			/** @var ThreemaGateway_Installer_Keystore $keystoreInstaller */
65			$keystoreInstaller = new ThreemaGateway_Installer_Keystore;
66			$keystoreInstaller->create();
67
68			// create custom user field
69			/** @var XenForo_DataWriter $userFieldWriter */
70			$userFieldWriter = XenForo_DataWriter::create('XenForo_DataWriter_UserField');
71			$userFieldWriter->set('field_id', 'threemaid');
72			$userFieldWriter->set('display_group', 'contact');
73			$userFieldWriter->set('display_order', 120);
74			$userFieldWriter->set('field_type', 'textbox');
75			$userFieldWriter->set('match_type', 'callback');
76			$userFieldWriter->set('match_callback_class', 'ThreemaGateway_Helper_UserField');
77			$userFieldWriter->set('match_callback_method', 'verifyThreemaId');
78			$userFieldWriter->set('max_length', 8);
79			$userFieldWriter->save();
80
81			// create tables for messages
82			/** @var ThreemaGateway_Installer_MessagesDb $messageDbInstaller */
83			$messageDbInstaller = new ThreemaGateway_Installer_MessagesDb;
84			$messageDbInstaller->create();
85
86			// create tfa tables
87			/** @var ThreemaGateway_Installer_TfaPendingConfirmMsgs $pendReqInstaller */
88			$pendReqInstaller = new ThreemaGateway_Installer_TfaPendingConfirmMsgs;
89			$pendReqInstaller->create();
90			}
91
92			// introduced in v1.00.00 70 (stable)
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-03-25 23:59 UTC by Report Bug Copy Issue Report `36%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
93			if ($oldAddonVersion < 1000070) {
94			// add throttle table
95			/** @var ThreemaGateway_Installer_ActionThrottle $throttleInstaller */
96			$throttleInstaller = new ThreemaGateway_Installer_ActionThrottle;
97			$throttleInstaller->create();
98			}
99			}
100
101			/**
102			* When uninstalling this deletes the unnecessary database entries/tables.
103			*/
104			public static function uninstall()
105			{
106			// delete throttle table
107			/** @var ThreemaGateway_Installer_ActionThrottle $throttleInstaller */
108			$throttleInstaller = new ThreemaGateway_Installer_ActionThrottle;
109			$throttleInstaller->destroy();
110
111			// delete tfa tables
112			/** @var ThreemaGateway_Installer_TfaPendingConfirmMsgs $pendReqInstaller */
113			$pendReqInstaller = new ThreemaGateway_Installer_TfaPendingConfirmMsgs;
114			$pendReqInstaller->destroy();
115
116			// remove message tables
117			/** @var ThreemaGateway_Installer_MessagesDb $messageDbInstaller */
118			$messageDbInstaller = new ThreemaGateway_Installer_MessagesDb;
119			$messageDbInstaller->destroy();
120
121			/** @var array $providerInstaller An array with the models of all providers */
122			$providerInstaller = self::getProviderInstaller();
123
124			// delete tfa provider from database
125			foreach ($providerInstaller as $provider) {
126			$provider->delete();
127			}
128
129			// delete keystore
130			/** @var ThreemaGateway_Installer_Keystore $keystoreInstaller */
131			$keystoreInstaller = new ThreemaGateway_Installer_Keystore;
132			$keystoreInstaller->destroy();
133
134			// delete permissions
135			/** @var ThreemaGateway_Installer_Permissions $permissionsInstaller */
136			$permissionsInstaller = new ThreemaGateway_Installer_Permissions;
137			$permissionsInstaller->deleteAll();
138
139			// delete custom user field (if it exists)
140			/** @var XenForo_Model_UserField $userFieldModel */
141			$userFieldModel = XenForo_Model::create('XenForo_Model_UserField');
142			/** @var array $userFieldData fetched data from database */
143			if ($userFieldData = $userFieldModel->getUserFieldById('threemaid')) {
144			/** @var XenForo_DataWriter $userFieldWriter */
145			$userFieldWriter = XenForo_DataWriter::create('XenForo_DataWriter_UserField');
146			$userFieldWriter->setExistingData($userFieldData);
147			$userFieldWriter->delete();
148			}
149
150			/** @var XenForo_Options $xenOptions */
151			$xenOptions = XenForo_Application::getOptions();
152
153			try {
154			//delete debug log file
155			ThreemaGateway_Option_DebugModeLog::removeLog($xenOptions->threema_gateway_logreceivedmsgs);
156
157			//delete private key file if possible
158			ThreemaGateway_Option_PrivateKeyPath::removePrivateKey($xenOptions->threema_gateway_privatekeyfile);
159			} catch (Exception $e) {
160			// ignore errors as deletion operations are additional security
161			// features, which may fail in an expected way, e.g. when XenForo
162			// does not have write access to these files.
163			}
164			}
165
166			/**
167			* Returns the provider installer needed for modifying the database.
168			*
169			* @return array
170			*/
171			protected static function getProviderInstaller()
172			{
173			/** @var array $providerInstaller An array with the models of all providers */
174			$providerInstaller = [];
175
176			// add provider
177			$providerInstaller['conventional'] = new ThreemaGateway_Installer_TfaProvider(
178			ThreemaGateway_Constants::TFA_ID_PREFIX . '_conventional',
179			'ThreemaGateway_Tfa_Conventional',
180			ThreemaGateway_Constants::TFA_BASE_PRIORITY - 15);
181			$providerInstaller['reversed'] = new ThreemaGateway_Installer_TfaProvider(
182			ThreemaGateway_Constants::TFA_ID_PREFIX . '_reversed',
183			'ThreemaGateway_Tfa_Reversed',
184			ThreemaGateway_Constants::TFA_BASE_PRIORITY - 10);
185			$providerInstaller['fast'] = new ThreemaGateway_Installer_TfaProvider(
186			ThreemaGateway_Constants::TFA_ID_PREFIX . '_fast',
187			'ThreemaGateway_Tfa_Fast',
188			ThreemaGateway_Constants::TFA_BASE_PRIORITY - 5);
189
190			return $providerInstaller;
191			}
192
193			/**
194			* At the installation this will check the XenForo version and
195			* remove the 2FA provider to the table.
196			*
197			* @param string $error Will be filled by a human-readable error description
198			* when an error occurs
199			* @return bool
200			*/
201			protected static function meetsRequirements(&$error)
202			{
203			/** @var bool $isError whether an error is triggered */
204			$isError = false;
205
206			// check XenForo version
207			if (XenForo_Application::$versionId < 1050770) {
208			$error .= 'This add-on requires XenForo 1.5.7 or higher.' . PHP_EOL;
209			$isError = true;
210			}
211
212			// check PHP version
213			if (version_compare(PHP_VERSION, '5.4', '<')) {
214			$error .= 'Threema Gateway requires PHP version 5.4 or higher. Current version: ' . PHP_VERSION . PHP_EOL;
215			$isError = true;
216			}
217
218			return !$isError;
219			}
220			}
221

rugk / xenforo-threema-gateway

ThreemaGateway_Installer::install() B last analyzed 2018-04-24 14:39 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

ThreemaGateway_Installer::install() B
last analyzed 2018-04-24 14:39 UTC