includes/api/ApiQueryAllMessages.php

   1 <?php
   2 /**
   3  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   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  */
  22
  23 /**
  24  * A query action to return messages from site message cache
  25  *
  26  * @ingroup API
  27  */
  28 class ApiQueryAllMessages extends ApiQueryBase {
  29
  30         public function __construct( ApiQuery $query, $moduleName ) {
  31                 parent::__construct( $query, $moduleName, 'am' );
  32         }
  33
  34         public function execute() {
  35                 $params = $this->extractRequestParams();
  36
  37                 if ( is_null( $params['lang'] ) ) {
  38                         $langObj = $this->getLanguage();
  39                 } elseif ( !Language::isValidCode( $params['lang'] ) ) {
  40                         $this->dieWithError(
  41                                 [ 'apierror-invalidlang', $this->encodeParamName( 'lang' ) ], 'invalidlang'
  42                         );
  43                 } else {
  44                         $langObj = Language::factory( $params['lang'] );
  45                 }
  46
  47                 if ( $params['enableparser'] ) {
  48                         if ( !is_null( $params['title'] ) ) {
  49                                 $title = Title::newFromText( $params['title'] );
  50                                 if ( !$title || $title->isExternal() ) {
  51                                         $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $params['title'] ) ] );
  52                                 }
  53                         } else {
  54                                 $title = Title::newFromText( 'API' );
  55                         }
  56                 }
  57
  58                 $prop = array_flip( (array)$params['prop'] );
  59
  60                 // Determine which messages should we print
  61                 if ( in_array( '*', $params['messages'] ) ) {
  62                         $message_names = Language::getMessageKeysFor( $langObj->getCode() );
  63                         if ( $params['includelocal'] ) {
  64                                 $message_names = array_unique( array_merge(
  65                                         $message_names,
  66                                         // Pass in the content language code so we get local messages that have a
  67                                         // MediaWiki:msgkey page. We might theoretically miss messages that have no
  68                                         // MediaWiki:msgkey page but do have a MediaWiki:msgkey/lang page, but that's
  69                                         // just a stupid case.
  70                                         MessageCache::singleton()->getAllMessageKeys( $this->getConfig()->get( 'LanguageCode' ) )
  71                                 ) );
  72                         }
  73                         sort( $message_names );
  74                         $messages_target = $message_names;
  75                 } else {
  76                         $messages_target = $params['messages'];
  77                 }
  78
  79                 // Filter messages that have the specified prefix
  80                 // Because we sorted the message array earlier, they will appear in a clump:
  81                 if ( isset( $params['prefix'] ) ) {
  82                         $skip = false;
  83                         $messages_filtered = [];
  84                         foreach ( $messages_target as $message ) {
  85                                 // === 0: must be at beginning of string (position 0)
  86                                 if ( strpos( $message, $params['prefix'] ) === 0 ) {
  87                                         if ( !$skip ) {
  88                                                 $skip = true;
  89                                         }
  90                                         $messages_filtered[] = $message;
  91                                 } elseif ( $skip ) {
  92                                         break;
  93                                 }
  94                         }
  95                         $messages_target = $messages_filtered;
  96                 }
  97
  98                 // Filter messages that contain specified string
  99                 if ( isset( $params['filter'] ) ) {
 100                         $messages_filtered = [];
 101                         foreach ( $messages_target as $message ) {
 102                                 // !== is used because filter can be at the beginning of the string
 103                                 if ( strpos( $message, $params['filter'] ) !== false ) {
 104                                         $messages_filtered[] = $message;
 105                                 }
 106                         }
 107                         $messages_target = $messages_filtered;
 108                 }
 109
 110                 // Whether we have any sort of message customisation filtering
 111                 $customiseFilterEnabled = $params['customised'] !== 'all';
 112                 if ( $customiseFilterEnabled ) {
 113                         global $wgContLang;
 114
 115                         $customisedMessages = AllMessagesTablePager::getCustomisedStatuses(
 116                                 array_map(
 117                                         [ $langObj, 'ucfirst' ],
 118                                         $messages_target
 119                                 ),
 120                                 $langObj->getCode(),
 121                                 !$langObj->equals( $wgContLang )
 122                         );
 123
 124                         $customised = $params['customised'] === 'modified';
 125                 }
 126
 127                 // Get all requested messages and print the result
 128                 $skip = !is_null( $params['from'] );
 129                 $useto = !is_null( $params['to'] );
 130                 $result = $this->getResult();
 131                 foreach ( $messages_target as $message ) {
 132                         // Skip all messages up to $params['from']
 133                         if ( $skip && $message === $params['from'] ) {
 134                                 $skip = false;
 135                         }
 136
 137                         if ( $useto && $message > $params['to'] ) {
 138                                 break;
 139                         }
 140
 141                         if ( !$skip ) {
 142                                 $a = [
 143                                         'name' => $message,
 144                                         'normalizedname' => MessageCache::normalizeKey( $message ),
 145                                 ];
 146
 147                                 $args = [];
 148                                 if ( isset( $params['args'] ) && count( $params['args'] ) != 0 ) {
 149                                         $args = $params['args'];
 150                                 }
 151
 152                                 if ( $customiseFilterEnabled ) {
 153                                         $messageIsCustomised = isset( $customisedMessages['pages'][$langObj->ucfirst( $message )] );
 154                                         if ( $customised === $messageIsCustomised ) {
 155                                                 if ( $customised ) {
 156                                                         $a['customised'] = true;
 157                                                 }
 158                                         } else {
 159                                                 continue;
 160                                         }
 161                                 }
 162
 163                                 $msg = wfMessage( $message, $args )->inLanguage( $langObj );
 164
 165                                 if ( !$msg->exists() ) {
 166                                         $a['missing'] = true;
 167                                 } else {
 168                                         // Check if the parser is enabled:
 169                                         if ( $params['enableparser'] ) {
 170                                                 $msgString = $msg->title( $title )->text();
 171                                         } else {
 172                                                 $msgString = $msg->plain();
 173                                         }
 174                                         if ( !$params['nocontent'] ) {
 175                                                 ApiResult::setContentValue( $a, 'content', $msgString );
 176                                         }
 177                                         if ( isset( $prop['default'] ) ) {
 178                                                 $default = wfMessage( $message )->inLanguage( $langObj )->useDatabase( false );
 179                                                 if ( !$default->exists() ) {
 180                                                         $a['defaultmissing'] = true;
 181                                                 } elseif ( $default->plain() != $msgString ) {
 182                                                         $a['default'] = $default->plain();
 183                                                 }
 184                                         }
 185                                 }
 186                                 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $a );
 187                                 if ( !$fit ) {
 188                                         $this->setContinueEnumParameter( 'from', $message );
 189                                         break;
 190                                 }
 191                         }
 192                 }
 193                 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'message' );
 194         }
 195
 196         public function getCacheMode( $params ) {
 197                 if ( is_null( $params['lang'] ) ) {
 198                         // Language not specified, will be fetched from preferences
 199                         return 'anon-public-user-private';
 200                 } elseif ( $params['enableparser'] ) {
 201                         // User-specific parser options will be used
 202                         return 'anon-public-user-private';
 203                 } else {
 204                         // OK to cache
 205                         return 'public';
 206                 }
 207         }
 208
 209         public function getAllowedParams() {
 210                 return [
 211                         'messages' => [
 212                                 ApiBase::PARAM_DFLT => '*',
 213                                 ApiBase::PARAM_ISMULTI => true,
 214                         ],
 215                         'prop' => [
 216                                 ApiBase::PARAM_ISMULTI => true,
 217                                 ApiBase::PARAM_TYPE => [
 218                                         'default'
 219                                 ]
 220                         ],
 221                         'enableparser' => false,
 222                         'nocontent' => false,
 223                         'includelocal' => false,
 224                         'args' => [
 225                                 ApiBase::PARAM_ISMULTI => true,
 226                                 ApiBase::PARAM_ALLOW_DUPLICATES => true,
 227                         ],
 228                         'filter' => [],
 229                         'customised' => [
 230                                 ApiBase::PARAM_DFLT => 'all',
 231                                 ApiBase::PARAM_TYPE => [
 232                                         'all',
 233                                         'modified',
 234                                         'unmodified'
 235                                 ]
 236                         ],
 237                         'lang' => null,
 238                         'from' => null,
 239                         'to' => null,
 240                         'title' => null,
 241                         'prefix' => null,
 242                 ];
 243         }
 244
 245         protected function getExamplesMessages() {
 246                 return [
 247                         'action=query&meta=allmessages&amprefix=ipb-'
 248                                 => 'apihelp-query+allmessages-example-ipb',
 249                         'action=query&meta=allmessages&ammessages=august|mainpage&amlang=de'
 250                                 => 'apihelp-query+allmessages-example-de',
 251                 ];
 252         }
 253
 254         public function getHelpUrls() {
 255                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allmessages';
 256         }
 257 }