Installer::downloadPluginArchive() - Code Metrics - Jitamin/jitamin - Measure and Improve Code Quality continuously with Scrutinizer

Installer::downloadPluginArchive() B
last analyzed 2017-12-27 06:16 UTC

↳ Parent: Installer

Complexity

Conditions	5
Paths	5

Size

Total Lines	32
Code Lines	17

Duplication

Lines	8
Ratio	25 %

Importance

Changes

Metric	Value
cc	5
eloc	17
nc	5
nop	1
dl	8
loc	32
rs	8.439
c	0
b	0
f	0

<?php

/*
 * This file is part of Jitamin.
 *
 * Copyright (C) Jitamin Team
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Jitamin\Foundation\Plugin;

use Jitamin\Foundation\Tool;
use ZipArchive;

/**
 * Class Installer.
 */
class Installer extends \Jitamin\Foundation\Base
{
    /**
     * Return true if Jitamin is configured to install plugins.
     *
     * @static
     *
     * @return bool
     */
    public static function isConfigured()
    {
        return PLUGIN_INSTALLER && is_writable(PLUGINS_DIR) && extension_loaded('zip');
    }

    /**
     * Install a plugin.
     *
     * @param string $archiveUrl
     *
     * @throws PluginInstallerException
     */
    public function install($archiveUrl)
    {
        $zip = $this->downloadPluginArchive($archiveUrl);

        if (!$zip->extractTo(PLUGINS_DIR)) {
            $this->cleanupArchive($zip);

            throw new PluginInstallerException(t('Unable to extract plugin archive.'));
        }

        $this->cleanupArchive($zip);
    }

    /**
     * Uninstall a plugin.
     *
     * @param string $pluginId
     *
     * @throws PluginInstallerException
     */
    public function uninstall($pluginId)
    {
        $pluginFolder = PLUGINS_DIR.DIRECTORY_SEPARATOR.basename($pluginId);

        if (!file_exists($pluginFolder)) {
            throw new PluginInstallerException(t('Plugin not found.'));
        }

        if (!is_writable($pluginFolder)) {
            throw new PluginInstallerException(e('You don\'t have the permission to remove this plugin.'));
        }

        Tool::removeAllFiles($pluginFolder);
    }

    /**
     * Update a plugin.
     *
     * @param string $archiveUrl
     *
     * @throws PluginInstallerException
     */
    public function update($archiveUrl)
    {
        $zip = $this->downloadPluginArchive($archiveUrl);

        $firstEntry = $zip->statIndex(0);
        $this->uninstall($firstEntry['name']);

        if (!$zip->extractTo(PLUGINS_DIR)) {
            $this->cleanupArchive($zip);

            throw new PluginInstallerException(t('Unable to extract plugin archive.'));
        }

        $this->cleanupArchive($zip);
    }

    /**
     * Download archive from URL.
     *
     * @param string $archiveUrl
     *
     * @throws PluginInstallerException
     *
     * @return ZipArchive
     */
    protected function downloadPluginArchive($archiveUrl)
    {
        $zip = new ZipArchive();
        $archiveData = $this->httpClient->get($archiveUrl);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $archiveFile = tempnam(sys_get_temp_dir(), 'kb_plugin');

        if (empty($archiveData)) {
            unlink($archiveFile);

            throw new PluginInstallerException(t('Unable to download plugin archive.'));
        }

        if (file_put_contents($archiveFile, $archiveData) === false) {

            unlink($archiveFile);

            throw new PluginInstallerException(t('Unable to write temporary file for plugin.'));
        }

        if ($zip->open($archiveFile) !== true) {

            unlink($archiveFile);

            throw new PluginInstallerException(t('Unable to open plugin archive.'));
        }

        if ($zip->numFiles === 0) {
            unlink($archiveFile);

            throw new PluginInstallerException(t('There is no file in the plugin archive.'));
        }

        return $zip;
    }

    /**
     * Remove archive file.
     *
     * @param ZipArchive $zip
     */
    protected function cleanupArchive(ZipArchive $zip)
    {
        unlink($zip->filename);
        $zip->close();
    }
}


1		<?php
2
3		/*
4		* This file is part of Jitamin.
5		*
6		* Copyright (C) Jitamin Team
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Jitamin\Foundation\Plugin;
13
14		use Jitamin\Foundation\Tool;
15		use ZipArchive;
16
17		/**
18		* Class Installer.
19		*/
20		class Installer extends \Jitamin\Foundation\Base
21		{
22		/**
23		* Return true if Jitamin is configured to install plugins.
24		*
25		* @static
26		*
27		* @return bool
28		*/
29		public static function isConfigured()
30		{
31		return PLUGIN_INSTALLER && is_writable(PLUGINS_DIR) && extension_loaded('zip');
32		}
33
34		/**
35		* Install a plugin.
36		*
37		* @param string $archiveUrl
38		*
39		* @throws PluginInstallerException
40		*/
41		public function install($archiveUrl)
42		{
43		$zip = $this->downloadPluginArchive($archiveUrl);
44
45		if (!$zip->extractTo(PLUGINS_DIR)) {
46		$this->cleanupArchive($zip);
47
48		throw new PluginInstallerException(t('Unable to extract plugin archive.'));
49		}
50
51		$this->cleanupArchive($zip);
52		}
53
54		/**
55		* Uninstall a plugin.
56		*
57		* @param string $pluginId
58		*
59		* @throws PluginInstallerException
60		*/
61		public function uninstall($pluginId)
62		{
63		$pluginFolder = PLUGINS_DIR.DIRECTORY_SEPARATOR.basename($pluginId);
64
65		if (!file_exists($pluginFolder)) {
66		throw new PluginInstallerException(t('Plugin not found.'));
67		}
68
69		if (!is_writable($pluginFolder)) {
70		throw new PluginInstallerException(e('You don\'t have the permission to remove this plugin.'));
71		}
72
73		Tool::removeAllFiles($pluginFolder);
74		}
75
76		/**
77		* Update a plugin.
78		*
79		* @param string $archiveUrl
80		*
81		* @throws PluginInstallerException
82		*/
83		public function update($archiveUrl)
84		{
85		$zip = $this->downloadPluginArchive($archiveUrl);
86
87		$firstEntry = $zip->statIndex(0);
88		$this->uninstall($firstEntry['name']);
89
90		if (!$zip->extractTo(PLUGINS_DIR)) {
91		$this->cleanupArchive($zip);
92
93		throw new PluginInstallerException(t('Unable to extract plugin archive.'));
94		}
95
96		$this->cleanupArchive($zip);
97		}
98
99		/**
100		* Download archive from URL.
101		*
102		* @param string $archiveUrl
103		*
104		* @throws PluginInstallerException
105		*
106		* @return ZipArchive
107		*/
108		protected function downloadPluginArchive($archiveUrl)
109		{
110		$zip = new ZipArchive();
111		$archiveData = $this->httpClient->get($archiveUrl);
		0 ignored issues – show Documentation introduced 2017-01-10 05:03 UTC by Report Bug Copy Issue Report The property `httpClient` does not exist on `object<Jitamin\Foundation\Plugin\Installer>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
112		$archiveFile = tempnam(sys_get_temp_dir(), 'kb_plugin');
113
114		if (empty($archiveData)) {
115		unlink($archiveFile);
116
117		throw new PluginInstallerException(t('Unable to download plugin archive.'));
118		}
119
120	View Code Duplication	if (file_put_contents($archiveFile, $archiveData) === false) {
		0 ignored issues – show Duplication introduced 2016-12-21 12:32 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
121		unlink($archiveFile);
122
123		throw new PluginInstallerException(t('Unable to write temporary file for plugin.'));
124		}
125
126	View Code Duplication	if ($zip->open($archiveFile) !== true) {
		0 ignored issues – show Duplication introduced 2016-12-21 12:32 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
127		unlink($archiveFile);
128
129		throw new PluginInstallerException(t('Unable to open plugin archive.'));
130		}
131
132		if ($zip->numFiles === 0) {
133		unlink($archiveFile);
134
135		throw new PluginInstallerException(t('There is no file in the plugin archive.'));
136		}
137
138		return $zip;
139		}
140
141		/**
142		* Remove archive file.
143		*
144		* @param ZipArchive $zip
145		*/
146		protected function cleanupArchive(ZipArchive $zip)
147		{
148		unlink($zip->filename);
149		$zip->close();
150		}
151		}
152

Jitamin / jitamin

Installer::downloadPluginArchive() B last analyzed 2017-12-27 06:16 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Installer::downloadPluginArchive() B
last analyzed 2017-12-27 06:16 UTC