aboutsummaryrefslogtreecommitdiffstats
path: root/includes/libs/rdbms/database/utils/GeneralizedSql.php
blob: 16ee7441c5361235adaf7c90c40e9002a33793dd (plain) (blame)
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
<?php
/**
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 */
namespace Wikimedia\Rdbms;

/**
 * Lazy-loaded wrapper for simplification and scrubbing of SQL queries for profiling
 *
 * @since 1.34
 * @ingroup Profiler
 * @ingroup Database
 */
class GeneralizedSql {
	/** @var string */
	private $rawSql;
	/** @var string */
	private $prefix;

	/** @var string|null */
	private $genericSql;

	/**
	 * @param string $rawSql
	 * @param string $prefix
	 */
	public function __construct( $rawSql, $prefix ) {
		$this->rawSql = $rawSql;
		$this->prefix = $prefix;
	}

	/**
	 * @return string
	 */
	public function stringify() {
		if ( $this->genericSql !== null ) {
			return $this->genericSql;
		}

		$this->genericSql = $this->prefix .
			substr( QueryBuilderFromRawSql::generalizeSQL( $this->rawSql ), 0, 255 );

		return $this->genericSql;
	}

	public function getRawSql() {
		return $this->rawSql;
	}

	/**
	 * @param Query $query
	 * @param string $prefix
	 * @return self
	 */
	public static function newFromQuery( Query $query, $prefix ) {
		$generalizedSql = new self( $query->getSQL(), $prefix );

		$cleanedSql = $query->getCleanedSql();
		if ( $cleanedSql != '' ) {
			// Generalized SQL already provided; no need to use regexes
			$generalizedSql->genericSql = $prefix . $cleanedSql;
		}

		return $generalizedSql;
	}
}