summaryrefslogtreecommitdiff
path: root/includes/resourceloader/ResourceLoaderEditToolbarModule.php
blob: d79174cd74d6a1e54bf1b8de20d1c15e45313ef1 (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
<?php
/**
 * Resource loader module for the edit toolbar.
 *
 * 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
 */

/**
 * ResourceLoader module for the edit toolbar.
 *
 * @since 1.24
 */
class ResourceLoaderEditToolbarModule extends ResourceLoaderFileModule {
	/**
	 * Serialize a string (escape and quote) for use as a CSS string value.
	 * http://www.w3.org/TR/2013/WD-cssom-20131205/#serialize-a-string
	 *
	 * @param string $value
	 * @return string
	 * @throws Exception
	 */
	private static function cssSerializeString( $value ) {
		if ( strstr( $value, "\0" ) ) {
			throw new Exception( "Invalid character in CSS string" );
		}
		$value = strtr( $value, array( '\\' => '\\\\', '"' => '\\"' ) );
		$value = preg_replace_callback( '/[\x01-\x1f\x7f-\x9f]/', function ( $match ) {
			return '\\' . base_convert( ord( $match[0] ), 10, 16 ) . ' ';
		}, $value );
		return '"' . $value . '"';
	}

	/**
	 * Get language-specific LESS variables for this module.
	 *
	 * @return array
	 */
	private function getLessVars( ResourceLoaderContext $context ) {
		$language = Language::factory( $context->getLanguage() );

		// This is very conveniently formatted and we can pass it right through
		$vars = $language->getImageFiles();

		// lessc tries to be helpful and parse our variables as LESS source code
		foreach ( $vars as $key => &$value ) {
			$value = self::cssSerializeString( $value );
		}

		return $vars;
	}

	/**
	 * @param ResourceLoaderContext $context
	 * @return int UNIX timestamp
	 */
	public function getModifiedTime( ResourceLoaderContext $context ) {
		return max(
			parent::getModifiedTime( $context ),
			$this->getHashMtime( $context )
		);
	}

	/**
	 * @param ResourceLoaderContext $context
	 * @return string Hash
	 */
	public function getModifiedHash( ResourceLoaderContext $context ) {
		return md5(
			parent::getModifiedHash( $context ) .
			serialize( $this->getLessVars( $context ) )
		);
	}

	/**
	 * Get a LESS compiler instance for this module.
	 *
	 * Set our variables in it.
	 *
	 * @throws MWException
	 * @param ResourceLoaderContext $context
	 * @return lessc
	 */
	protected function getLessCompiler( ResourceLoaderContext $context = null ) {
		$compiler = parent::getLessCompiler();
		$compiler->setVariables( $this->getLessVars( $context ) );
		return $compiler;
	}
}