summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/src/ParserFunctions/ExpensiveFuncExecutionWatcher.php
blob: 4fe50cec3e9e0285c748db7420392108cad1ded7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<?php

namespace SMW\ParserFunctions;

use SMW\ParserData;
use SMWQuery as Query;

/**
 * @private
 *
 * @license GNU GPL v2+
 * @since 3.0
 *
 * @author mwjames
 */
class ExpensiveFuncExecutionWatcher {

	/**
	 * Idenitifer
	 */
	const EXPENSIVE_COUNTER = 'smw-expensiveparsercount';

	/**
	 * @var ParserData
	 */
	private $parserData;

	/**
	 * @var integer
	 */
	private $expensiveThreshold = 10;

	/**
	 * @var integer|boolean
	 */
	private $expensiveExecutionLimit = false;

	/**
	 * @since 3.0
	 *
	 * @param ParserData $parserData
	 */
	public function __construct( ParserData $parserData ) {
		$this->parserData = $parserData;
	}

	/**
	 * @since 3.0
	 *
	 * @param integer $expensiveThreshold
	 */
	public function setExpensiveThreshold( $expensiveThreshold ) {
		$this->expensiveThreshold = $expensiveThreshold;
	}

	/**
	 * @since 3.0
	 *
	 * @param integer|boolean $expensiveExecutionLimit
	 */
	public function setExpensiveExecutionLimit( $expensiveExecutionLimit ) {
		$this->expensiveExecutionLimit = $expensiveExecutionLimit;
	}

	/**
	 * @since 3.0
	 *
	 * @param Query $query
	 *
	 * @return boolean
	 */
	public function hasReachedExpensiveLimit( Query $query ) {

		if ( $this->expensiveExecutionLimit === false ) {
			return false;
		}

		if ( $query->getLimit() == 0 ) {
			return false;
		}

		if ( $this->parserData->getOutput()->getExtensionData( self::EXPENSIVE_COUNTER ) < $this->expensiveExecutionLimit ) {
			return false;
		}

		return true;
	}

	/**
	 * @since 3.0
	 *
	 * @param Query $query
	 *
	 * @return boolean
	 */
	public function incrementExpensiveCount( Query $query ) {

		if ( $this->expensiveExecutionLimit === false || $query->getLimit() == 0 || $query->getOption( Query::PROC_QUERY_TIME ) < $this->expensiveThreshold  ) {
			return;
		}

		$output = $this->parserData->getOutput();
		$expensiveCount = $output->getExtensionData( self::EXPENSIVE_COUNTER );

		if ( !is_int( $expensiveCount ) ) {
			$expensiveCount = 0;
		}

		$expensiveCount++;
		$output->setExtensionData( self::EXPENSIVE_COUNTER, $expensiveCount );
	}

}