includes/resourceloader/ResourceLoaderSkinModule.php

   1 <?php
   2 /**
   3  * ResourceLoader module for skin stylesheets.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @author Timo Tijhof
  22  */
  23
  24 class ResourceLoaderSkinModule extends ResourceLoaderFileModule {
  25         /**
  26          * All skins are assumed to be compatible with mobile
  27          */
  28         public $targets = [ 'desktop', 'mobile' ];
  29
  30         /**
  31          * @param ResourceLoaderContext $context
  32          * @return array
  33          */
  34         public function getStyles( ResourceLoaderContext $context ) {
  35                 $logo = $this->getLogoData( $this->getConfig() );
  36                 $styles = parent::getStyles( $context );
  37                 $this->normalizeStyles( $styles );
  38
  39                 $default = !is_array( $logo ) ? $logo : $logo['1x'];
  40                 $styles['all'][] = '.mw-wiki-logo { background-image: ' .
  41                                 CSSMin::buildUrlValue( $default ) .
  42                                 '; }';
  43
  44                 if ( is_array( $logo ) ) {
  45                         if ( isset( $logo['svg'] ) ) {
  46                                 $styles['all'][] = '.mw-wiki-logo { ' .
  47                                         'background-image: -webkit-linear-gradient(transparent, transparent), ' .
  48                                                 CSSMin::buildUrlValue( $logo['svg'] ) . '; ' .
  49                                         'background-image: linear-gradient(transparent, transparent), ' .
  50                                                 CSSMin::buildUrlValue( $logo['svg'] ) . ';' .
  51                                         'background-size: 135px auto; }';
  52                         } else {
  53                                 if ( isset( $logo['1.5x'] ) ) {
  54                                         $styles[
  55                                                 '(-webkit-min-device-pixel-ratio: 1.5), ' .
  56                                                 '(min--moz-device-pixel-ratio: 1.5), ' .
  57                                         '(min-resolution: 1.5dppx), ' .
  58                                                 '(min-resolution: 144dpi)'
  59                                         ][] = '.mw-wiki-logo { background-image: ' .
  60                                         CSSMin::buildUrlValue( $logo['1.5x'] ) . ';' .
  61                                         'background-size: 135px auto; }';
  62                                 }
  63                                 if ( isset( $logo['2x'] ) ) {
  64                                         $styles[
  65                                                 '(-webkit-min-device-pixel-ratio: 2), ' .
  66                                                 '(min--moz-device-pixel-ratio: 2), ' .
  67                                                 '(min-resolution: 2dppx), ' .
  68                                                 '(min-resolution: 192dpi)'
  69                                         ][] = '.mw-wiki-logo { background-image: ' .
  70                                         CSSMin::buildUrlValue( $logo['2x'] ) . ';' .
  71                                         'background-size: 135px auto; }';
  72                                 }
  73                         }
  74                 }
  75
  76                 return $styles;
  77         }
  78
  79         /**
  80          * @param ResourceLoaderContext $context
  81          * @return array
  82          */
  83         public function getPreloadLinks( ResourceLoaderContext $context ) {
  84                 return $this->getLogoPreloadlinks();
  85         }
  86
  87         /**
  88          * Helper method for getPreloadLinks()
  89          * @return array
  90          */
  91         private function getLogoPreloadlinks() {
  92                 $logo = $this->getLogoData( $this->getConfig() );
  93
  94                 $logosPerDppx = [];
  95                 $logos = [];
  96
  97                 $preloadLinks = [];
  98
  99                 if ( !is_array( $logo ) ) {
 100                         // No media queries required if we only have one variant
 101                         $preloadLinks[$logo] = [ 'as' => 'image' ];
 102                         return $preloadLinks;
 103                 }
 104
 105                 if ( isset( $logo['svg'] ) ) {
 106                         // No media queries required if we only have a 1x and svg variant
 107                         // because all preload-capable browsers support SVGs
 108                         $preloadLinks[$logo['svg']] = [ 'as' => 'image' ];
 109                         return $preloadLinks;
 110                 }
 111
 112                 foreach ( $logo as $dppx => $src ) {
 113                         // Keys are in this format: "1.5x"
 114                         $dppx = substr( $dppx, 0, -1 );
 115                         $logosPerDppx[$dppx] = $src;
 116                 }
 117
 118                 // Because PHP can't have floats as array keys
 119                 uksort( $logosPerDppx, function ( $a, $b ) {
 120                         $a = floatval( $a );
 121                         $b = floatval( $b );
 122                         // Sort from smallest to largest (e.g. 1x, 1.5x, 2x)
 123                         return $a <=> $b;
 124                 } );
 125
 126                 foreach ( $logosPerDppx as $dppx => $src ) {
 127                         $logos[] = [
 128                                 'dppx' => $dppx,
 129                                 'src' => $src
 130                         ];
 131                 }
 132
 133                 $logosCount = count( $logos );
 134                 // Logic must match ResourceLoaderSkinModule:
 135                 // - 1x applies to resolution < 1.5dppx
 136                 // - 1.5x applies to resolution >= 1.5dppx && < 2dppx
 137                 // - 2x applies to resolution >= 2dppx
 138                 // Note that min-resolution and max-resolution are both inclusive.
 139                 for ( $i = 0; $i < $logosCount; $i++ ) {
 140                         if ( $i === 0 ) {
 141                                 // Smallest dppx
 142                                 // min-resolution is ">=" (larger than or equal to)
 143                                 // "not min-resolution" is essentially "<"
 144                                 $media_query = 'not all and (min-resolution: ' . $logos[1]['dppx'] . 'dppx)';
 145                         } elseif ( $i !== $logosCount - 1 ) {
 146                                 // In between
 147                                 // Media query expressions can only apply "not" to the entire expression
 148                                 // (e.g. can't express ">= 1.5 and not >= 2).
 149                                 // Workaround: Use <= 1.9999 in place of < 2.
 150                                 $upper_bound = floatval( $logos[$i + 1]['dppx'] ) - 0.000001;
 151                                 $media_query = '(min-resolution: ' . $logos[$i]['dppx'] .
 152                                         'dppx) and (max-resolution: ' . $upper_bound . 'dppx)';
 153                         } else {
 154                                 // Largest dppx
 155                                 $media_query = '(min-resolution: ' . $logos[$i]['dppx'] . 'dppx)';
 156                         }
 157
 158                         $preloadLinks[$logos[$i]['src']] = [
 159                                 'as' => 'image',
 160                                 'media' => $media_query
 161                         ];
 162                 }
 163
 164                 return $preloadLinks;
 165         }
 166
 167         /**
 168          * Ensure all media keys use array values.
 169          *
 170          * Normalises arrays returned by the ResourceLoaderFileModule::getStyles() method.
 171          *
 172          * @param array &$styles Associative array, keys are strings (media queries),
 173          *   values are strings or arrays
 174          */
 175         private function normalizeStyles( &$styles ) {
 176                 foreach ( $styles as $key => $val ) {
 177                         if ( !is_array( $val ) ) {
 178                                 $styles[$key] = [ $val ];
 179                         }
 180                 }
 181         }
 182
 183         /**
 184          * @since 1.31
 185          * @param Config $conf
 186          * @return string|array Single url if no variants are defined,
 187          *  or an array of logo urls keyed by dppx in form "<float>x".
 188          *  Key "1x" is always defined. Key "svg" may also be defined,
 189          *  in which case variants other than "1x" are omitted.
 190          */
 191         protected function getLogoData( Config $conf ) {
 192                 $logo = $conf->get( 'Logo' );
 193                 $logoHD = $conf->get( 'LogoHD' );
 194
 195                 $logo1Url = OutputPage::transformResourcePath( $conf, $logo );
 196
 197                 if ( !$logoHD ) {
 198                         return $logo1Url;
 199                 }
 200
 201                 $logoUrls = [
 202                         '1x' => $logo1Url,
 203                 ];
 204
 205                 if ( isset( $logoHD['svg'] ) ) {
 206                         $logoUrls['svg'] = OutputPage::transformResourcePath(
 207                                 $conf,
 208                                 $logoHD['svg']
 209                         );
 210                 } else {
 211                         // Only 1.5x and 2x are supported
 212                         if ( isset( $logoHD['1.5x'] ) ) {
 213                                 $logoUrls['1.5x'] = OutputPage::transformResourcePath(
 214                                         $conf,
 215                                         $logoHD['1.5x']
 216                                 );
 217                         }
 218                         if ( isset( $logoHD['2x'] ) ) {
 219                                 $logoUrls['2x'] = OutputPage::transformResourcePath(
 220                                         $conf,
 221                                         $logoHD['2x']
 222                                 );
 223                         }
 224                 }
 225
 226                 return $logoUrls;
 227         }
 228
 229         /**
 230          * @param ResourceLoaderContext $context
 231          * @return bool
 232          */
 233         public function isKnownEmpty( ResourceLoaderContext $context ) {
 234                 // Regardless of whether the files are specified, we always
 235                 // provide mw-wiki-logo styles.
 236                 return false;
 237         }
 238
 239         public function getDefinitionSummary( ResourceLoaderContext $context ) {
 240                 $summary = parent::getDefinitionSummary( $context );
 241                 $summary[] = [
 242                         'logo' => $this->getConfig()->get( 'Logo' ),
 243                         'logoHD' => $this->getConfig()->get( 'LogoHD' ),
 244                 ];
 245                 return $summary;
 246         }
 247 }