ApiCacheableTemplateParse::execute() - Code Metrics - Inspection of "Merge pull request #6 from SemanticMediaWiki/rel" - SemanticMediaWiki/SummaryCards - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e11051...f173c0 )

by mw

created 2016-06-22 04:09 UTC

ApiCacheableTemplateParse::execute() A

↳ Parent: ApiCacheableTemplateParse

Complexity

Conditions	1
Paths	1

Size

Total Lines	13
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	1

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
c	2
b	0
f	1
dl	0
loc	13
ccs	10
cts	10
cp	1
rs	9.4285
cc	1
eloc	8
nc	1
nop	0
crap	1

<?php

namespace SUC;

use ParserOptions;
use ParserOutput;
use ApiBase;
use Title;

/**
 * Content parsing can be expensive especially if it contains a large set of
 * #ask queries/#if parser functions to form a summary card.
 *
 * This API module is to parse a text/template and if possible tries to retrieve
 * data from a persistent cache layer to avoid unnecessary content parsing.
 *
 * On the event of NewRevisionFromEditComplete a cached item will be evicted if
 * it matches the BackendCache::getHashFrom.
 *
 * On the event that a template that was used for generating content  was modified
 * then a re-parse of the content is requested the next time instead of a cache
 * retrieval.
 *
 * @license GNU GPL v2+
 * @since 1.0
 *
 * @author mwjames
 */
class ApiCacheableTemplateParse extends ApiBase {

	/**
	 * @var BackendCache
	 */
	private $backendCache;

	/**
	 * @since 1.0
	 *
	 * @param BackendCache $backendCache
	 */
	public function setBackendCache( BackendCache $backendCache ) {
		$this->backendCache = $backendCache;
	}

	/**
	 * ApiBase::execute
	 *
	 * @since 1.0
	 */
	public function execute() {

		$data = $this->getDataFrom(
			BackendCache::getInstance( $this->backendCache ),
			$this->extractRequestParams()
		);

 		$this->getResult()->addValue(
 			null,
 			$this->getModuleName(),
 			$data
 		);
	}

	/**
	 * ApiBase::getAllowedParams
	 *
	 * @since 1.0
	 */
	public function getAllowedParams() {
		return array(
			'text'         => array( ApiBase::PARAM_TYPE => 'string' ),
			'template'     => array( ApiBase::PARAM_TYPE => 'string' ),
			'title'        => array( ApiBase::PARAM_TYPE => 'string' ),
			'userlanguage' => array( ApiBase::PARAM_TYPE => 'string' )
		);
	}

	/**
	 * @codeCoverageIgnore
	 * @see ApiBase::getParamDescription
	 *
	 * @return array
	 */
	public function getParamDescription() {
		return array(
			'text'     => 'Contains the text/template to be parsed.',
			'template' => 'Contains the template to track possible changes.',
			'title'    => 'Subject to filter repeated requests.',
			'userlanguage' => 'The user language.'
		);
	}

	/**
	 * @codeCoverageIgnore
	 * @see ApiBase::getDescription
	 *
	 * @return array
	 */
	public function getDescription() {
		return array(
			'Module to parse raw text/templates and store returning results in a backend-cache.'
		);
	}

	private function getDataFrom( BackendCache $backendCache, array $params ) {

		$start = microtime( true );
		$untouchedTemplate = false;

		$data = array(
			'text' => '',
			'time' => false
		);

		if ( !isset( $params['text'] ) || !isset( $params['title'] ) ) {
			return $data;
		}

		$blobStore = $backendCache->getBlobStore();

		list( $templateKey, $templateTouched ) = $this->getTemplateFrom( $params );

		$title = $backendCache->getTargetFrom( $params['title'] );
		$hash = $backendCache->getHashFrom( $title );

		$container = $blobStore->read( $hash );

		// If the template was touched then re-parse the content to
		// avoid stalled data
		if ( $container->has( $templateKey ) ) {
			$untouchedTemplate = $container->get( $templateKey ) == $templateTouched;
		}

		// Split by lang and fragment into separate containers, while the cache
		// is stored on a per subject basis allowing all related containers to
		// be purged at once
		$key = 'L#' . $params['userlanguage'] . '#' . ( $title !== null ? $title->getFragment() : '' );

		if ( $untouchedTemplate && $hash !== '' && $container->has( $key ) ) {
			wfDebugLog( 'smw', 'SummaryCards API cache hit on ' . $hash );
			$data = $container->get( $key );
			$data['time']['cached'] = microtime( true ) - $start;
			return $data;
		}

		$data = array(
			'text' => $this->doParse( $title, $params['userlanguage'], $params['text'] ),
			'time' => array(
				'parse'  => microtime( true ) - $start
			)
		);

		// Only cache when a template is known
		if ( $hash !== '' && $templateKey !== '' ) {
			$container->set( $key, $data );
			$container->set( $templateKey, $templateTouched );
			$blobStore->save( $container );
		}

		return $data;
	}

	private function getTemplateFrom( $params ) {

		$templateKey = '';
		$templateTouched = 0;

		if ( isset( $params['template'] ) ) {
			$template = Title::makeTitleSafe( NS_TEMPLATE, $params['template'] );
			$templateTouched = $template->getTouched();
			$templateKey = 'T#' . $params['template'] . '#' . $params['userlanguage'];
		}

		return array( $templateKey, $templateTouched );
	}

	private function doParse( $title, $userLanguage, $text ) {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

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

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}

		$parserOutput = $GLOBALS['wgParser']->parse(
			$text,
			$title,
			$this->makeParserOptions( $title, $userLanguage )
		);

		return $parserOutput instanceof ParserOutput ? $parserOutput->getText() : '' ;

	}

	private function makeParserOptions( $title, $userLanguage ) {

		$user = null;

		$parserOptions = new ParserOptions( $user );
		$parserOptions->setInterfaceMessage( true );
		$parserOptions->setUserLang( $userLanguage );

		return $parserOptions;
	}

}


1		<?php
2
3		namespace SUC;
4
5		use ParserOptions;
6		use ParserOutput;
7		use ApiBase;
8		use Title;
9
10		/**
11		* Content parsing can be expensive especially if it contains a large set of
12		* #ask queries/#if parser functions to form a summary card.
13		*
14		* This API module is to parse a text/template and if possible tries to retrieve
15		* data from a persistent cache layer to avoid unnecessary content parsing.
16		*
17		* On the event of NewRevisionFromEditComplete a cached item will be evicted if
18		* it matches the BackendCache::getHashFrom.
19		*
20		* On the event that a template that was used for generating content was modified
21		* then a re-parse of the content is requested the next time instead of a cache
22		* retrieval.
23		*
24		* @license GNU GPL v2+
25		* @since 1.0
26		*
27		* @author mwjames
28		*/
29		class ApiCacheableTemplateParse extends ApiBase {
30
31		/**
32		* @var BackendCache
33		*/
34		private $backendCache;
35
36		/**
37		* @since 1.0
38		*
39		* @param BackendCache $backendCache
40		*/
41	3	public function setBackendCache( BackendCache $backendCache ) {
42	3	$this->backendCache = $backendCache;
43	3	}
44
45		/**
46		* ApiBase::execute
47		*
48		* @since 1.0
49		*/
50	2	public function execute() {
51
52	2	$data = $this->getDataFrom(
53	2	BackendCache::getInstance( $this->backendCache ),
54	2	$this->extractRequestParams()
55	2	);
56
57	2	$this->getResult()->addValue(
58	2	null,
59	2	$this->getModuleName(),
60		$data
61	2	);
62	2	}
63
64		/**
65		* ApiBase::getAllowedParams
66		*
67		* @since 1.0
68		*/
69	2	public function getAllowedParams() {
70		return array(
71	2	'text' => array( ApiBase::PARAM_TYPE => 'string' ),
72	2	'template' => array( ApiBase::PARAM_TYPE => 'string' ),
73	2	'title' => array( ApiBase::PARAM_TYPE => 'string' ),
74	2	'userlanguage' => array( ApiBase::PARAM_TYPE => 'string' )
75	2	);
76		}
77
78		/**
79		* @codeCoverageIgnore
80		* @see ApiBase::getParamDescription
81		*
82		* @return array
83		*/
84		public function getParamDescription() {
85		return array(
86		'text' => 'Contains the text/template to be parsed.',
87		'template' => 'Contains the template to track possible changes.',
88		'title' => 'Subject to filter repeated requests.',
89		'userlanguage' => 'The user language.'
90		);
91		}
92
93		/**
94		* @codeCoverageIgnore
95		* @see ApiBase::getDescription
96		*
97		* @return array
98		*/
99		public function getDescription() {
100		return array(
101		'Module to parse raw text/templates and store returning results in a backend-cache.'
102		);
103		}
104
105	2	private function getDataFrom( BackendCache $backendCache, array $params ) {
106
107	2	$start = microtime( true );
108	2	$untouchedTemplate = false;
109
110		$data = array(
111	2	'text' => '',
112		'time' => false
113	2	);
114
115	2	if ( !isset( $params['text'] ) \|\| !isset( $params['title'] ) ) {
116	1	return $data;
117		}
118
119	1	$blobStore = $backendCache->getBlobStore();
120
121	1	list( $templateKey, $templateTouched ) = $this->getTemplateFrom( $params );
122
123	1	$title = $backendCache->getTargetFrom( $params['title'] );
124	1	$hash = $backendCache->getHashFrom( $title );
125
126	1	$container = $blobStore->read( $hash );
127
128		// If the template was touched then re-parse the content to
129		// avoid stalled data
130	1	if ( $container->has( $templateKey ) ) {
131		$untouchedTemplate = $container->get( $templateKey ) == $templateTouched;
132		}
133
134		// Split by lang and fragment into separate containers, while the cache
135		// is stored on a per subject basis allowing all related containers to
136		// be purged at once
137	1	$key = 'L#' . $params['userlanguage'] . '#' . ( $title !== null ? $title->getFragment() : '' );
138
139	1	if ( $untouchedTemplate && $hash !== '' && $container->has( $key ) ) {
140		wfDebugLog( 'smw', 'SummaryCards API cache hit on ' . $hash );
141		$data = $container->get( $key );
142		$data['time']['cached'] = microtime( true ) - $start;
143		return $data;
144		}
145
146		$data = array(
147	1	'text' => $this->doParse( $title, $params['userlanguage'], $params['text'] ),
148		'time' => array(
149	1	'parse' => microtime( true ) - $start
150	1	)
151	1	);
152
153		// Only cache when a template is known
154	1	if ( $hash !== '' && $templateKey !== '' ) {
155		$container->set( $key, $data );
156		$container->set( $templateKey, $templateTouched );
157		$blobStore->save( $container );
158		}
159
160	1	return $data;
161		}
162
163	1	private function getTemplateFrom( $params ) {
164
165	1	$templateKey = '';
166	1	$templateTouched = 0;
167
168	1	if ( isset( $params['template'] ) ) {
169		$template = Title::makeTitleSafe( NS_TEMPLATE, $params['template'] );
170		$templateTouched = $template->getTouched();
171		$templateKey = 'T#' . $params['template'] . '#' . $params['userlanguage'];
172		}
173
174	1	return array( $templateKey, $templateTouched );
175		}
176
177	1	private function doParse( $title, $userLanguage, $text ) {
		0 ignored issues – show Coding Style introduced 2016-06-07 13:25 UTC by Report Bug Copy Issue Report `doParse` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
178
179	1	$parserOutput = $GLOBALS['wgParser']->parse(
180	1	$text,
181	1	$title,
182	1	$this->makeParserOptions( $title, $userLanguage )
183	1	);
184
185	1	return $parserOutput instanceof ParserOutput ? $parserOutput->getText() : '' ;
		0 ignored issues – show Bug introduced 2016-06-07 13:25 UTC by Report Bug Copy Issue Report The class `ParserOutput` does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json? Loading history...
186		}
187
188	1	private function makeParserOptions( $title, $userLanguage ) {
189
190	1	$user = null;
191
192	1	$parserOptions = new ParserOptions( $user );
193	1	$parserOptions->setInterfaceMessage( true );
194	1	$parserOptions->setUserLang( $userLanguage );
195
196	1	return $parserOptions;
197		}
198
199		}
200

SemanticMediaWiki / SummaryCards

Push — master ( e11051...f173c0 )

ApiCacheableTemplateParse::execute() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like