Set site logo in mediawiki.skinning.interface module instead of inline styles
authortholam <t.lam@lamsinfosystem.com>
Sun, 1 Dec 2013 00:49:21 +0000 (18:49 -0600)
committerJdlrobson <jrobson@wikimedia.org>
Fri, 26 Sep 2014 21:09:22 +0000 (21:09 +0000)
Requires skins use the 'mw-wiki-logo' class on the logo element for the styles
to apply and to load the 'mediawiki.skinning.interface' module (or implement
their own skin module that uses the ResourceLoaderSkinModule class).

This is backwards compatible with skins using inline styles as the class only
applies when used.

Bug: 56257
Change-Id: I4e6db89a688843ac24539f8fd1b408c0d04881b3

RELEASE-NOTES-1.25
includes/AutoLoader.php
includes/resourceloader/ResourceLoaderSkinModule.php [new file with mode: 0644]
resources/Resources.php

index 71ac5e3..aa46518 100644 (file)
@@ -33,6 +33,8 @@ changes to languages because of Bugzilla reports.
   removed. See https://www.mediawiki.org/wiki/Manual:Skin_autodiscovery for
   migration guide for creators and users of custom skins that relied on it.
 * Javascript variable 'wgFileCanRotate' now only available on Special:Upload.
+* (bug 56257) Set site logo from mediawiki.skinning.interface module instead of
+  inline styles in the HTML.
 
 == Compatibility ==
 
index c5032b5..50fcd61 100644 (file)
@@ -890,6 +890,7 @@ $wgAutoloadLocalClasses = array(
        'ResourceLoaderModule' => 'includes/resourceloader/ResourceLoaderModule.php',
        'ResourceLoaderNoscriptModule' => 'includes/resourceloader/ResourceLoaderNoscriptModule.php',
        'ResourceLoaderSiteModule' => 'includes/resourceloader/ResourceLoaderSiteModule.php',
+       'ResourceLoaderSkinModule' => 'includes/resourceloader/ResourceLoaderSkinModule.php',
        'ResourceLoaderStartUpModule' => 'includes/resourceloader/ResourceLoaderStartUpModule.php',
        'ResourceLoaderUserCSSPrefsModule' =>
                'includes/resourceloader/ResourceLoaderUserCSSPrefsModule.php',
diff --git a/includes/resourceloader/ResourceLoaderSkinModule.php b/includes/resourceloader/ResourceLoaderSkinModule.php
new file mode 100644 (file)
index 0000000..6de1be0
--- /dev/null
@@ -0,0 +1,69 @@
+<?php
+/**
+ * Resource loader module for skin stylesheets.
+ *
+ * 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 Timo Tijhof
+ */
+
+class ResourceLoaderSkinModule extends ResourceLoaderFileModule {
+
+       /* Methods */
+
+       /**
+        * @param $context ResourceLoaderContext
+        * @return array
+        */
+       public function getStyles( ResourceLoaderContext $context ) {
+               $logo = $this->getConfig()->get( 'Logo' );
+               $styles = parent::getStyles( $context );
+               $styles['all'][] = '.mw-wiki-logo { background-image: ' .
+                       CSSMin::buildUrlValue( $logo ) .
+                       '; }';
+
+               return $styles;
+       }
+
+       /**
+        * @param $context ResourceLoaderContext
+        * @return boolean
+        */
+       public function isKnownEmpty( ResourceLoaderContext $context ) {
+               // Regardless of whether the files are specified, we always
+               // provide mw-wiki-logo styles.
+               return false;
+       }
+
+       /**
+        * @param $context ResourceLoaderContext
+        * @return int|mixed
+        */
+       public function getModifiedTime( ResourceLoaderContext $context ) {
+               $parentMTime = parent::getModifiedTime( $context );
+               return max( $parentMTime, $this->getHashMtime( $context ) );
+       }
+
+       /**
+        * @param $context ResourceLoaderContext
+        * @return string: Hash
+        */
+       public function getModifiedHash( ResourceLoaderContext $context ) {
+               $logo = $this->getConfig()->get( 'Logo' );
+               return md5( parent::getModifiedHash( $context ) . $logo );
+       }
+}
index 3bb5b4e..7bc3b75 100644 (file)
@@ -93,6 +93,7 @@ return array(
                ),
        ),
        'mediawiki.skinning.interface' => array(
+               'class' => 'ResourceLoaderSkinModule',
                // Used in the web installer. Test it after modifying this definition!
                'styles' => array(
                        'resources/src/mediawiki.skinning/elements.css' => array( 'media' => 'screen' ),