helper_plugin_extension_repository::hasAccess() - Code Metrics - Inspection of "adjusted phpcs config for plugins" - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — psr2 ( 957f36...e79ce3 )

by Andreas

created 2018-05-08 18:28 UTC

helper_plugin_extension_repository::hasAccess() B

↳ Parent: helper_plugin_extension_repository

Complexity

Conditions	4
Paths	4

Size

Total Lines	22
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	16
nc	4
nop	0
dl	0
loc	22
rs	8.9197
c	0
b	0
f	0

<?php
/**
 * DokuWiki Plugin extension (Helper Component)
 *
 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
 * @author  Michael Hamann <[email protected]>
 */

/**
 * Class helper_plugin_extension_repository provides access to the extension repository on dokuwiki.org
 */
class helper_plugin_extension_repository extends DokuWiki_Plugin
{

    const EXTENSION_REPOSITORY_API = 'http://www.dokuwiki.org/lib/plugins/pluginrepo/api.php';

    private $loaded_extensions = array();
    private $has_access = null;

    /**
     * Initialize the repository (cache), fetches data for all installed plugins
     */
    public function init()
    {
        /* @var Doku_Plugin_Controller $plugin_controller */
        global $plugin_controller;
        if ($this->hasAccess()) {
            $list = $plugin_controller->getList('', true);
            $request_data = array('fmt' => 'php');
            $request_needed = false;
            foreach ($list as $name) {
                $cache = new cache('##extension_manager##'.$name, '.repo');

                if (!isset($this->loaded_extensions[$name]) &&
                    $this->hasAccess() &&
                    !$cache->useCache(array('age' => 3600 * 24))
                ) {
                    $this->loaded_extensions[$name] = true;
                    $request_data['ext'][] = $name;
                    $request_needed = true;
                }
            }

            if ($request_needed) {
                $httpclient = new DokuHTTPClient();
                $data = $httpclient->post(self::EXTENSION_REPOSITORY_API, $request_data);
                if ($data !== false) {
                    $extensions = unserialize($data);
                    foreach ($extensions as $extension) {
                        $cache = new cache('##extension_manager##'.$extension['plugin'], '.repo');
                        $cache->storeCache(serialize($extension));
                    }
                } else {
                    $this->has_access = false;
                }
            }
        }
    }

    /**
     * If repository access is available
     *
     * @return bool If repository access is available
     */
    public function hasAccess()
    {
        if ($this->has_access === null) {
            $cache = new cache('##extension_manager###hasAccess', '.repo');

            if (!$cache->useCache(array('age' => 3600 * 24, 'purge'=>1))) {
                $httpclient = new DokuHTTPClient();
                $httpclient->timeout = 5;
                $data = $httpclient->get(self::EXTENSION_REPOSITORY_API.'?cmd=ping');
                if ($data !== false) {
                    $this->has_access = true;
                    $cache->storeCache(1);
                } else {
                    $this->has_access = false;
                    $cache->storeCache(0);
                }
            } else {
                $this->has_access = ($cache->retrieveCache(false) == 1);
            }
        }
        return $this->has_access;
    }

    /**
     * Get the remote data of an individual plugin or template
     *
     * @param string $name  The plugin name to get the data for, template names need to be prefix by 'template:'
     * @return array The data or null if nothing was found (possibly no repository access)
     */
    public function getData($name)
    {
        $cache = new cache('##extension_manager##'.$name, '.repo');

        if (!isset($this->loaded_extensions[$name]) &&
            $this->hasAccess() &&
            !$cache->useCache(array('age' => 3600 * 24))
        ) {
            $this->loaded_extensions[$name] = true;
            $httpclient = new DokuHTTPClient();
            $data = $httpclient->get(self::EXTENSION_REPOSITORY_API.'?fmt=php&ext[]='.urlencode($name));
            if ($data !== false) {
                $result = unserialize($data);
                $cache->storeCache(serialize($result[0]));
                return $result[0];
            } else {
                $this->has_access = false;
            }
        }
        if (file_exists($cache->cache)) {
            return unserialize($cache->retrieveCache(false));
        }
        return array();
    }

    /**
     * Search for plugins or templates using the given query string
     *
     * @param string $q the query string
     * @return array a list of matching extensions
     */
    public function search($q)
    {
        $query = $this->parseQuery($q);
        $query['fmt'] = 'php';

        $httpclient = new DokuHTTPClient();
        $data = $httpclient->post(self::EXTENSION_REPOSITORY_API, $query);
        if ($data === false) return array();
        $result = unserialize($data);

        $ids = array();

        // store cache info for each extension
        foreach ($result as $ext) {
            $name = $ext['plugin'];
            $cache = new cache('##extension_manager##'.$name, '.repo');
            $cache->storeCache(serialize($ext));
            $ids[] = $name;
        }

        return $ids;
    }

    /**
     * Parses special queries from the query string
     *
     * @param string $q
     * @return array
     */
    protected function parseQuery($q)
    {
        $parameters = array(
            'tag'  => array(),
            'mail' => array(),
            'type' => array(),
            'ext'  => array()
        );

        // extract tags
        if (preg_match_all('/(^|\s)(tag:([\S]+))/', $q, $matches, PREG_SET_ORDER)) {
            foreach ($matches as $m) {
                $q = str_replace($m[2], '', $q);
                $parameters['tag'][] = $m[3];
            }
        }
        // extract author ids
        if (preg_match_all('/(^|\s)(authorid:([\S]+))/', $q, $matches, PREG_SET_ORDER)) {
            foreach ($matches as $m) {
                $q = str_replace($m[2], '', $q);
                $parameters['mail'][] = $m[3];
            }
        }
        // extract extensions
        if (preg_match_all('/(^|\s)(ext:([\S]+))/', $q, $matches, PREG_SET_ORDER)) {
            foreach ($matches as $m) {
                $q = str_replace($m[2], '', $q);
                $parameters['ext'][] = $m[3];
            }
        }
        // extract types
        if (preg_match_all('/(^|\s)(type:([\S]+))/', $q, $matches, PREG_SET_ORDER)) {
            foreach ($matches as $m) {
                $q = str_replace($m[2], '', $q);
                $parameters['type'][] = $m[3];
            }
        }

        // FIXME make integer from type value

        $parameters['q'] = trim($q);
        return $parameters;
    }
}

// vim:ts=4:sw=4:et:


1			<?php
2			/**
3			* DokuWiki Plugin extension (Helper Component)
4			*
5			* @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
6			* @author Michael Hamann <[email protected]>
7			*/
8
9			/**
10			* Class helper_plugin_extension_repository provides access to the extension repository on dokuwiki.org
11			*/
12			class helper_plugin_extension_repository extends DokuWiki_Plugin
13			{
14
15			const EXTENSION_REPOSITORY_API = 'http://www.dokuwiki.org/lib/plugins/pluginrepo/api.php';
16
17			private $loaded_extensions = array();
18			private $has_access = null;
19
20			/**
21			* Initialize the repository (cache), fetches data for all installed plugins
22			*/
23			public function init()
24			{
25			/* @var Doku_Plugin_Controller $plugin_controller */
26			global $plugin_controller;
27			if ($this->hasAccess()) {
28			$list = $plugin_controller->getList('', true);
29			$request_data = array('fmt' => 'php');
30			$request_needed = false;
31			foreach ($list as $name) {
32			$cache = new cache('##extension_manager##'.$name, '.repo');
33
34			if (!isset($this->loaded_extensions[$name]) &&
35			$this->hasAccess() &&
36			!$cache->useCache(array('age' => 3600 * 24))
37			) {
38			$this->loaded_extensions[$name] = true;
39			$request_data['ext'][] = $name;
40			$request_needed = true;
41			}
42			}
43
44			if ($request_needed) {
45			$httpclient = new DokuHTTPClient();
46			$data = $httpclient->post(self::EXTENSION_REPOSITORY_API, $request_data);
47			if ($data !== false) {
48			$extensions = unserialize($data);
49			foreach ($extensions as $extension) {
50			$cache = new cache('##extension_manager##'.$extension['plugin'], '.repo');
51			$cache->storeCache(serialize($extension));
52			}
53			} else {
54			$this->has_access = false;
55			}
56			}
57			}
58			}
59
60			/**
61			* If repository access is available
62			*
63			* @return bool If repository access is available
64			*/
65			public function hasAccess()
66			{
67			if ($this->has_access === null) {
68			$cache = new cache('##extension_manager###hasAccess', '.repo');
69
70			if (!$cache->useCache(array('age' => 3600 * 24, 'purge'=>1))) {
71			$httpclient = new DokuHTTPClient();
72			$httpclient->timeout = 5;
73			$data = $httpclient->get(self::EXTENSION_REPOSITORY_API.'?cmd=ping');
74			if ($data !== false) {
75			$this->has_access = true;
76			$cache->storeCache(1);
77			} else {
78			$this->has_access = false;
79			$cache->storeCache(0);
80			}
81			} else {
82			$this->has_access = ($cache->retrieveCache(false) == 1);
83			}
84			}
85			return $this->has_access;
86			}
87
88			/**
89			* Get the remote data of an individual plugin or template
90			*
91			* @param string $name The plugin name to get the data for, template names need to be prefix by 'template:'
92			* @return array The data or null if nothing was found (possibly no repository access)
93			*/
94			public function getData($name)
95			{
96			$cache = new cache('##extension_manager##'.$name, '.repo');
97
98			if (!isset($this->loaded_extensions[$name]) &&
99			$this->hasAccess() &&
100			!$cache->useCache(array('age' => 3600 * 24))
101			) {
102			$this->loaded_extensions[$name] = true;
103			$httpclient = new DokuHTTPClient();
104			$data = $httpclient->get(self::EXTENSION_REPOSITORY_API.'?fmt=php&ext[]='.urlencode($name));
105			if ($data !== false) {
106			$result = unserialize($data);
107			$cache->storeCache(serialize($result[0]));
108			return $result[0];
109			} else {
110			$this->has_access = false;
111			}
112			}
113			if (file_exists($cache->cache)) {
114			return unserialize($cache->retrieveCache(false));
115			}
116			return array();
117			}
118
119			/**
120			* Search for plugins or templates using the given query string
121			*
122			* @param string $q the query string
123			* @return array a list of matching extensions
124			*/
125			public function search($q)
126			{
127			$query = $this->parseQuery($q);
128			$query['fmt'] = 'php';
129
130			$httpclient = new DokuHTTPClient();
131			$data = $httpclient->post(self::EXTENSION_REPOSITORY_API, $query);
132			if ($data === false) return array();
133			$result = unserialize($data);
134
135			$ids = array();
136
137			// store cache info for each extension
138			foreach ($result as $ext) {
139			$name = $ext['plugin'];
140			$cache = new cache('##extension_manager##'.$name, '.repo');
141			$cache->storeCache(serialize($ext));
142			$ids[] = $name;
143			}
144
145			return $ids;
146			}
147
148			/**
149			* Parses special queries from the query string
150			*
151			* @param string $q
152			* @return array
153			*/
154			protected function parseQuery($q)
155			{
156			$parameters = array(
157			'tag' => array(),
158			'mail' => array(),
159			'type' => array(),
160			'ext' => array()
161			);
162
163			// extract tags
164			if (preg_match_all('/(^\|\s)(tag:([\S]+))/', $q, $matches, PREG_SET_ORDER)) {
165			foreach ($matches as $m) {
166			$q = str_replace($m[2], '', $q);
167			$parameters['tag'][] = $m[3];
168			}
169			}
170			// extract author ids
171			if (preg_match_all('/(^\|\s)(authorid:([\S]+))/', $q, $matches, PREG_SET_ORDER)) {
172			foreach ($matches as $m) {
173			$q = str_replace($m[2], '', $q);
174			$parameters['mail'][] = $m[3];
175			}
176			}
177			// extract extensions
178			if (preg_match_all('/(^\|\s)(ext:([\S]+))/', $q, $matches, PREG_SET_ORDER)) {
179			foreach ($matches as $m) {
180			$q = str_replace($m[2], '', $q);
181			$parameters['ext'][] = $m[3];
182			}
183			}
184			// extract types
185			if (preg_match_all('/(^\|\s)(type:([\S]+))/', $q, $matches, PREG_SET_ORDER)) {
186			foreach ($matches as $m) {
187			$q = str_replace($m[2], '', $q);
188			$parameters['type'][] = $m[3];
189			}
190			}
191
192			// FIXME make integer from type value
193
194			$parameters['q'] = trim($q);
195			return $parameters;
196			}
197			}
198
199			// vim:ts=4:sw=4:et:
200

splitbrain / dokuwiki

Push — psr2 ( 957f36...e79ce3 )

helper_plugin_extension_repository::hasAccess() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like