includes/resourceloader/ResourceLoaderUserOptionsModule.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @author Trevor Parscal
  20  * @author Roan Kattouw
  21  */
  22
  23 /**
  24  * Module for user preference customizations
  25  */
  26 class ResourceLoaderUserOptionsModule extends ResourceLoaderModule {
  27
  28         /* Protected Members */
  29
  30         protected $modifiedTime = array();
  31
  32         protected $origin = self::ORIGIN_CORE_INDIVIDUAL;
  33
  34         /* Methods */
  35
  36         /**
  37          * @param $context ResourceLoaderContext
  38          * @return array|int|Mixed
  39          */
  40         public function getModifiedTime( ResourceLoaderContext $context ) {
  41                 $hash = $context->getHash();
  42                 if ( isset( $this->modifiedTime[$hash] ) ) {
  43                         return $this->modifiedTime[$hash];
  44                 }
  45
  46                 global $wgUser;
  47
  48                 if ( $context->getUser() === $wgUser->getName() ) {
  49                         return $this->modifiedTime[$hash] = wfTimestamp( TS_UNIX, $wgUser->getTouched() );
  50                 } else {
  51                         return 1;
  52                 }
  53         }
  54
  55         /**
  56          * Fetch the context's user options, or if it doesn't match current user,
  57          * the default options.
  58          *
  59          * @param $context ResourceLoaderContext: Context object
  60          * @return Array: List of user options keyed by option name
  61          */
  62         protected function contextUserOptions( ResourceLoaderContext $context ) {
  63                 global $wgUser;
  64
  65                 // Verify identity -- this is a private module
  66                 if ( $context->getUser() === $wgUser->getName() ) {
  67                         return $wgUser->getOptions();
  68                 } else {
  69                         return User::getDefaultOptions();
  70                 }
  71         }
  72
  73         /**
  74          * @param $context ResourceLoaderContext
  75          * @return string
  76          */
  77         public function getScript( ResourceLoaderContext $context ) {
  78                 return Xml::encodeJsCall( 'mw.user.options.set',
  79                         array( $this->contextUserOptions( $context ) ) );
  80         }
  81
  82         /**
  83          * @param $context ResourceLoaderContext
  84          * @return array
  85          */
  86         public function getStyles( ResourceLoaderContext $context ) {
  87                 // FIXME: This stuff should really be in its own module, because it gets double-loaded otherwise
  88                 // (once through a <link>, once when embedded as JS)
  89                 global $wgAllowUserCssPrefs;
  90
  91                 if ( $wgAllowUserCssPrefs ) {
  92                         $options = $this->contextUserOptions( $context );
  93
  94                         // Build CSS rules
  95                         $rules = array();
  96
  97                         // Underline: 2 = browser default, 1 = always, 0 = never
  98                         if ( $options['underline'] < 2 ) {
  99                                 $rules[] = "a { text-decoration: " .
 100                                         ( $options['underline'] ? 'underline' : 'none' ) . "; }";
 101                         } else {
 102                                 # The scripts of these languages are very hard to read with underlines
 103                                 $rules[] = 'a:lang(ar), a:lang(ckb), a:lang(fa),a:lang(kk-arab), ' .
 104                                 'a:lang(mzn), a:lang(ps), a:lang(ur) { text-decoration: none; }';
 105                         }
 106                         if ( $options['highlightbroken'] ) {
 107                                 $rules[] = "a.new, #quickbar a.new { color: #ba0000; }\n";
 108                         } else {
 109                                 $rules[] = "a.new, #quickbar a.new, a.stub, #quickbar a.stub { color: inherit; }";
 110                                 $rules[] = "a.new:after, #quickbar a.new:after { content: '?'; color: #ba0000; }";
 111                                 $rules[] = "a.stub:after, #quickbar a.stub:after { content: '!'; color: #772233; }";
 112                         }
 113                         if ( $options['justify'] ) {
 114                                 $rules[] = "#article, #bodyContent, #mw_content { text-align: justify; }\n";
 115                         }
 116                         if ( !$options['showtoc'] ) {
 117                                 $rules[] = "#toc { display: none; }\n";
 118                         }
 119                         if ( !$options['editsection'] ) {
 120                                 $rules[] = ".editsection { display: none; }\n";
 121                         }
 122                         if ( $options['editfont'] !== 'default' ) {
 123                                 $rules[] = "textarea { font-family: {$options['editfont']}; }\n";
 124                         }
 125                         $style = implode( "\n", $rules );
 126                         if ( $this->getFlip( $context ) ) {
 127                                 $style = CSSJanus::transform( $style, true, false );
 128                         }
 129                         return array( 'all' => $style );
 130                 }
 131                 return array();
 132         }
 133
 134         /**
 135          * @return string
 136          */
 137         public function getGroup() {
 138                 return 'private';
 139         }
 140
 141         /**
 142          * @return array
 143          */
 144         public function getDependencies() {
 145                 return array( 'mediawiki.user' );
 146         }
 147 }