MediaWiki 1.17.0

[autoinstallsdev/mediawiki.git] / includes / resourceloader / ResourceLoaderContext.php

diff --git a/includes/resourceloader/ResourceLoaderContext.php b/includes/resourceloader/ResourceLoaderContext.php
new file mode 100644 (file)
index 0000000..bf059b4
--- /dev/null
+++ b/includes/resourceloader/ResourceLoaderContext.php
@@ -0,0 +1,176 @@
+<?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
+ * @author Trevor Parscal
+ * @author Roan Kattouw
+ */
+
+/**
+ * Object passed around to modules which contains information about the state 
+ * of a specific loader request
+ */
+class ResourceLoaderContext {
+
+       /* Protected Members */
+
+       protected $resourceLoader;
+       protected $request;
+       protected $modules;
+       protected $language;
+       protected $direction;
+       protected $skin;
+       protected $user;
+       protected $debug;
+       protected $only;
+       protected $version;
+       protected $hash;
+
+       /* Methods */
+
+       public function __construct( ResourceLoader $resourceLoader, WebRequest $request ) {
+               global $wgDefaultSkin, $wgResourceLoaderDebug;
+
+               $this->resourceLoader = $resourceLoader;
+               $this->request = $request;
+
+               // Interpret request
+               // List of modules
+               $modules = $request->getVal( 'modules' );
+               $this->modules   = $modules ? self::expandModuleNames( $modules ) : array();
+               // Various parameters
+               $this->skin      = $request->getVal( 'skin' );
+               $this->user      = $request->getVal( 'user' );
+               $this->debug     = $request->getFuzzyBool( 'debug', $wgResourceLoaderDebug );
+               $this->only      = $request->getVal( 'only' );
+               $this->version   = $request->getVal( 'version' );
+
+               if ( !$this->skin ) {
+                       $this->skin = $wgDefaultSkin;
+               }
+       }
+       
+       /**
+        * Expand a string of the form jquery.foo,bar|jquery.ui.baz,quux to
+        * an array of module names like array( 'jquery.foo', 'jquery.bar',
+        * 'jquery.ui.baz', 'jquery.ui.quux' )
+        * @param $modules String Packed module name list
+        * @return array of module names
+        */
+       public static function expandModuleNames( $modules ) {
+               $retval = array();
+               $exploded = explode( '|', $modules );
+               foreach ( $exploded as $group ) {
+                       if ( strpos( $group, ',' ) === false ) {
+                               // This is not a set of modules in foo.bar,baz notation
+                               // but a single module
+                               $retval[] = $group;
+                       } else {
+                               // This is a set of modules in foo.bar,baz notation
+                               $pos = strrpos( $group, '.' );
+                               if ( $pos === false ) {
+                                       // Prefixless modules, i.e. without dots
+                                       $retval = explode( ',', $group );
+                               } else {
+                                       // We have a prefix and a bunch of suffixes
+                                       $prefix = substr( $group, 0, $pos ); // 'foo'
+                                       $suffixes = explode( ',', substr( $group, $pos + 1 ) ); // array( 'bar', 'baz' )
+                                       foreach ( $suffixes as $suffix ) {
+                                               $retval[] = "$prefix.$suffix";
+                                       }
+                               }
+                       }
+               }
+               return $retval;
+       }
+
+       public function getResourceLoader() {
+               return $this->resourceLoader;
+       }
+       
+       public function getRequest() {
+               return $this->request;
+       }
+
+       public function getModules() {
+               return $this->modules;
+       }
+
+       public function getLanguage() {
+               if ( $this->language === null ) {
+                       global $wgLang;
+                       $this->language  = $this->request->getVal( 'lang' );
+                       if ( !$this->language ) {
+                               $this->language = $wgLang->getCode();
+                       }
+               }
+               return $this->language;
+       }
+
+       public function getDirection() {
+               if ( $this->direction === null ) {
+                       $this->direction = $this->request->getVal( 'dir' );
+                       if ( !$this->direction ) {
+                               global $wgContLang;
+                               $this->direction = $wgContLang->getDir();
+                       }
+               }
+               return $this->direction;
+       }
+
+       public function getSkin() {
+               return $this->skin;
+       }
+
+       public function getUser() {
+               return $this->user;
+       }
+
+       public function getDebug() {
+               return $this->debug;
+       }
+
+       public function getOnly() {
+               return $this->only;
+       }
+
+       public function getVersion() {
+               return $this->version;
+       }
+
+       public function shouldIncludeScripts() {
+               return is_null( $this->only ) || $this->only === 'scripts';
+       }
+
+       public function shouldIncludeStyles() {
+               return is_null( $this->only ) || $this->only === 'styles';
+       }
+
+       public function shouldIncludeMessages() {
+               return is_null( $this->only ) || $this->only === 'messages';
+       }
+
+       public function getHash() {
+               if ( !isset( $this->hash ) ) {
+                       $this->hash = implode( '|', array(
+                               $this->getLanguage(), $this->getDirection(), $this->skin, $this->user, 
+                               $this->debug, $this->only, $this->version
+                       ) );
+               }
+               return $this->hash;
+       }
+}