RELEASE-NOTES-1.26

   1 Security reminder: If you have PHP's register_globals option set, you must
   2 turn it off. MediaWiki will not work with it enabled.
   3
   4 == MediaWiki 1.26 ==
   5
   6 THIS IS NOT A RELEASE YET
   7
   8 MediaWiki 1.26 is an alpha-quality branch and is not recommended for use in
   9 production.
  10
  11 === Configuration changes in 1.26 ===
  12 * $wgPasswordResetRoutes['email'] = true by default.
  13 * $wgEnableParserCache was deprecated, set $wgParserCacheType to CACHE_NONE
  14   instead if you want to disable the parser cache.
  15 * New-style continuation is now the default for API action=continue. Clients may
  16   use the 'rawcontinue' parameter to receive raw query-continue data, but the
  17   new style is encouraged as it's harder to implement incorrectly.
  18 * Deprecated API formats dump and wddx have been completely removed.
  19 * (T7645) The "Signature" button on the edit toolbar is now hidden by default
  20   in non-talk namespaces. A new configuration variable,
  21   $wgExtraSignatureNamespaces, controls in which subject (non-talk) namespaces
  22   the "Signature" button on the edit toolbar will be displayed.
  23 * $wgResourceLoaderUseESI was deprecated and removed. This was an experimental
  24   feature that was never enabled by default.
  25 * $wgResourceLoaderExperimentalAsyncLoading was deprecated and removed.
  26   This experimental feature was never enabled by default and is obsolete as of
  27   MediaWiki 1.26, in where ResourceLoader became fully asynchronous.
  28 * $wgMasterWaitTimeout was removed (deprecated in 1.24).
  29 * Fields in ParserOptions are now private. Use the accessors instead.
  30 * Custom LESS functions (defined via $wgResourceLoaderLESSFunctions or
  31   in extension.json) have been removed, after being deprecated in 1.24.
  32 * $wgAlwaysUseTidy has been removed.
  33 * ResetSessionID hook has been removed. Nothing seems to use it.
  34 * Certain AuthPlugin methods are deprecated in favor of new hooks:
  35 ** AuthPlugin::initUser() is replaced by LocalUserCreated.
  36 ** AuthPlugin::updateUser() is replaced by UserLoggedIn.
  37 ** AuthPlugin::updateExternalDB() is replaced by the existing UserSaveSettings.
  38 ** AuthPlugin::updateExternalDBGroups() is replaced by UserGroupsChanged.
  39 ** AuthPluginUser::isHidden() is replaced by UserIsHidden.
  40 ** AuthPluginUser::isLocked() is replaced by UserIsLocked.
  41 * The UserRights hook is deprecated in favor of the new UserGroupsChanged hook.
  42 * AuthPlugin::initUser() and AuthPlugin::updateUser() should no longer replace
  43   the passed User object.
  44 * $wgBlockAllowsUTEdit is now set to true by default. This allows
  45   blocked users to edit their talk pages unless explicitly disabled
  46   when they are being blocked.
  47
  48 === New features in 1.26 ===
  49 * (T51506) Now action=info gives estimates of actual watchers for a page.
  50   See $wgRCMaxAge, $wgWatchersMaxAge and $wgUnwatchedPageSecret
  51   to learn how to configure if needed.
  52 * Change tags can now be hidden in the interface by disabling the associated
  53   "tag-<id>" interface message.
  54 * ':' (colon) is now invalid in usernames for new accounts. Existing accounts
  55   are not affected.
  56 * Added a new hook, 'LogException', to log exceptions in nonstandard ways.
  57 * Revive the 'SpecialSearchResultsAppend' hook which occurs after the list of
  58   search results are rendered. The initial use case is to append a "give us
  59   feedback" link beneath the search results.
  60 * Added a new hook, 'RejectParserCacheValue', which allows extensions to
  61   reject an otherwise-successful parser cache lookup. The intent is to allow
  62   extensions to manage the eviction of archaic HTML output from the cache.
  63 * (T68699) The expiration of the UserID and Token login cookies
  64   ($wgExtendedLoginCookieExpiration) can be configured independently of the
  65   expiration of all other cookies ($wgCookieExpiration).
  66 * (T50519) Support for generating JPEG/PNG thumbnails from WebP images added
  67   if ImageMagick is used as image scaler ($wgUseImageMagick = true). Uploading
  68   of WebP images still disabled by default. Add $wgFileExtensions[] =
  69   'webp'; to LocalSettings.php to enable uploading of WebP images.
  70 * Added new hooks 'EnhancedChangesListModifyLineData' &
  71   'EnhancedChangesListModifyBlockLineData', to modify the data used to build
  72   lines in enhanced recentchanges and watchlist.
  73 * Caches that need purging ability now use the WANObjectCache interface.
  74   This corresponds to a new $wgMainWANCache setting, which defaults to using
  75   the $wgMainCacheType settings.
  76 * Added MWTimestamp::getTimezoneString() which returns the localized timezone
  77   string, if available. To localize this string, see the comments of
  78   $wgLocaltimezone in includes/DefaultSettings.php.
  79 * Callers needing fast light-weight data stores use $wgMainStash to select
  80   the store type from $wgObjectCaches. The default is the local database.
  81 * Interface message overrides in the MediaWiki namespace will now be cached in
  82   memcached and APC (if available), rather than memcached and local files.
  83 * Added a new hook, 'RandomPageQuery', to allow modification of the query used
  84   by Special:Random to select random pages.
  85 * $wgTransactionalTimeLimit was added, which controls the request time limit
  86   for potentially slow POST requests that need to be as atomic as possible.
  87 * ResourceLoader now loads all scripts asynchronously. The top-queue and
  88   startup modules are no longer synchronously loaded.
  89 * 'mediawiki.ui.button' styles are no longer unconditionally loaded on every
  90   page. During the deprecation period, the styles will only be loaded on pages
  91   which contain 'mw-ui-button' in their HTML. Starting in 1.28, the styles will
  92   only be loaded if explicitly required.
  93 * If search returns zero results and current search engine has a "did you mean"
  94   suggestion, results for suggestion will be shown. Can be disabled by setting
  95   $wgSearchRunSuggestedQuery to false.
  96 * Added several JavaScript libraries for uploading files to MediaWiki
  97   from the client-side. See documentation for mw.Upload and its
  98   subclasses for more information.
  99 * Added OOUI dialogs and layout for file upload interfaces. See
 100   documentation for mw.Upload.Dialog, mw.Upload.BookletLayout and its
 101   subclasses for more information.
 102
 103 == extension.json changes in 1.26 ==
 104 * (T99344) The extension.json schema is now versioned. All extensions
 105   and skins should set a "manifest_version" property corresponding to
 106   the schema version they were written for. The only supported version
 107   currently is "1".
 108 * (T102523) The error message if a non-array attribute is set was improved.
 109 * (T107646) Configuration settings can now specify how they should be merged,
 110   which is necessary for arrays using integer keys.
 111 * (T110389) Adding namespaces through extension.json now actually works
 112 * $wgNamespaceProtection can now be set in extension.json.
 113 * $wgCapitalLinkOverrides can now be set in extension.json.
 114 * (T97186) Extensions using a custom prefix for their configuration settings
 115   can now set a "_prefix" key to override the default of "wg".
 116 * (T99084) Extensions can now specify what MediaWiki core versions they
 117   depend upon.
 118 * (T105236) The extension.json schema now validates custom classes in
 119   the "ResourceModules" property properly.
 120
 121 == External libraries ==
 122 === Upgraded external libraries ===
 123 * Updated es5-shim from v4.0.0 to v4.1.5.
 124 * Updated json2 from revision 2014-02-04 to 2015-05-03.
 125 * Updated Sinon.JS from 1.10.3 to 1.15.4.
 126 * Updated jQuery Client from v1.0.0 to v2.0.0.
 127 * Updated QUnit from v1.17.1 to v1.18.0.
 128 * Updated liuggio/statsd-php-client from v1.0.12 to v1.0.16
 129 * Updated oojs/oojs-ui from v0.9.8 to v0.12.9.
 130 * Updated wikimedia/utfnormal from v1.0.2 to v1.0.3
 131 * Updated wikimedia/composer-merge-plugin from v1.0.0 to v1.2.1.
 132 * Updated zordius/lightncandy from v0.18 to v0.21.
 133
 134 === New external libraries ===
 135 * Added composer/semver v0.1.0.
 136 * Added mediawiki/at-ease v1.1.0.
 137 * Added wikimedia/assert v0.2.2.
 138 * Added wikimedia/ip-set v1.0.1.
 139 * Added wikimedia/wrappedstring v2.0.0.
 140
 141 === Removed and replaced external libraries ===
 142 * Replaced leafo/lessphp v0.5.0 with oyejorge/less.php: v1.7.0.8
 143
 144 === Bug fixes in 1.26 ===
 145 * (T53283) load.php sometimes sends 304 response without full headers
 146 * (T65198) Talk page tabs now have a "rel=discussion" attribute
 147 * (T98841) {{msgnw:}} now preserves comments even when subst: is not used.
 148 * (T104142) $wgEmergencyContact and $wgPasswordSender now use their default
 149   value if set to an empty string.
 150
 151 === Action API changes in 1.26 ===
 152 * New-style continuation is now the default for action=continue. Clients may
 153   use the 'rawcontinue' parameter to receive raw query-continue data, but the
 154   new style is encouraged as it's harder to implement incorrectly.
 155 * Deprecated API formats dump and wddx have been completely removed.
 156 * API action=query&list=tags: The displayname can now be boolean false if the
 157   tag is meant to be hidden from user interfaces.
 158 * action=import no longer allows both the namespace= and rootpage= parameters
 159   to be set. If they are both set, the value of rootpage= will be ignored.
 160 * prop=revision output in enum mode is now sorted by timestamp rather than
 161   revision ID. This usually won't make any difference.
 162 * (T102645) Namespace list from meta=siteinfo&siprop=namespaces is now an array
 163   with formatversion=2.
 164 * Various other output from meta=siteinfo will now always be arrays instead of
 165   sometimes being numerically-indexed objects with formatversion=2.
 166 * When errors about users being blocked are returned, they now include
 167   information about the relevant block.
 168 * (T99926) list=random has higher limits, in line with other API modules.
 169 * list=random's rnredirect parameter is deprecated in favor of a new
 170   rnfilterredir parameter that also allows for listing both redirects and
 171   non-redirects.
 172 * list=random now supports continuation.
 173 * API responses to GET requests may now include ETag and Last-Modified headers,
 174   and will honor corresponding If-None-Match and If-Modified-Since on such
 175   requests.
 176 * (T47988) The protect log event details now use new-style formatting.
 177
 178 === Action API internal changes in 1.26 ===
 179 * New metadata item ApiResult::META_KVP_MERGE to allow for merging the KVP key
 180   into the value when the value is an assoc.
 181 * API action modules may now provide values for the RFC 7232 ETag and
 182   Last-Modified headers. The API will check these against If-None-Match and
 183   If-Modified-Since request headers on GET requests and avoid executing the
 184   module when appropriate.
 185
 186 === Languages updated in 1.26 ===
 187
 188 MediaWiki supports over 350 languages. Many localisations are updated
 189 regularly. Below only new and removed languages are listed, as well as
 190 changes to languages because of Phabricator reports.
 191
 192 * Languages added:
 193 ** ase (American sign language), thanks to translator Icemandeaf
 194 ** dty (डोटेली/Doteli), thanks to translators जनक राज भट्ट, बिप्लब आनन्द,
 195    मेश सिंह बोहरा, and राम प्रसाद जोशी
 196 ** luz (لئری دوٙمینی / Southern Luri)
 197 ** olo (Livvinкarjala / Livvi-Karelian), thanks to translators Denö, Hiloin Natoi,
 198    Ilja.mos, and Mashoi7
 199
 200 === Other changes in 1.26 ===
 201 * ChangeTags::tagDescription() will return false if the interface message
 202   for the tag is disabled.
 203 * Added PageHistoryPager::doBatchLookups hook.
 204 * Added $wikiId parameter to FormatAutocomments hook.
 205 * Added ParserCacheSaveComplete to ParserCache
 206 * supportsDirectEditing and supportsDirectApiEditing methods added to
 207   ContentHandler, to provide a way for ApiEditPage and EditPage to check
 208   if direct editing of content is allowed. These methods return false,
 209   by default for the ContentHandler base class and true for TextContentHandler
 210   and it's derivative classes (everything in core). For Content types that
 211   do not support direct editing, an alternative mechanism should be provided
 212   for editing, such as action overrides or specific api modules.
 213 * mediaWiki.confirmCloseWindow now returns an object of functions, instead of
 214   one function. The callback can't be called directly any more. The callback
 215   function is replaced with confirmCloseWindow.release().
 216 * BREAKING CHANGE: Added an optional ResouceLoaderContext parameter to
 217   ResourceLoaderModule::getDependencies(). Extension classes that override that
 218   method should be updated. If they aren't updated, PHP Strict standards
 219   warnings will appear when E_STRICT error reporting is enabled. Note: in the
 220   near future, this parameter will probably become non-optional.
 221 * Removed maintenance script deleteImageMemcached.php.
 222 * MWFunction::newObj() was removed (deprecated in 1.25).
 223   ObjectFactory::getObjectFromSpec() should be used instead.
 224 * The parser will no longer randomize the string it uses to mark the place of
 225   items that were stripped during parsing. It will use a fixed string instead.
 226   This causes the parser to re-use the regular expressions it uses to search
 227   and replace markers rather than generate novel expressions on each parse.
 228   Re-using regular expressions will improve performance on HHVM and the
 229   forthcoming PHP 7. The interfaces changes accompanying this change are:
 230   - Parser::getRandomString() and Parser::uniqPrefix() have been deprecated.
 231   - The $uniq_prefix argument for Parser::extractTagsAndParams() and the
 232     $prefix argument for StripState::_construct() are deprecated and their
 233     value is ignored.
 234 * wfSuppressWarnings() and wfRestoreWarnings() were split into a separate library,
 235   mediawiki/at-ease, and are now deprecated. Callers should use
 236   MediaWiki\suppressWarnings() and MediaWiki\restoreWarnings() directly.
 237 * The Block class constructor now takes an associative array of parameters
 238   instead of many optional positional arguments. Calling the constructor the old
 239   way will issue a deprecation warning.
 240 * The jquery.mwExtension module was deprecated.
 241 * $wgSpecialPageGroups was removed (deprecated in 1.21).
 242 * SpecialPageFactory::setGroup was removed (deprecated in 1.21).
 243 * SpecialPageFactory::getGroup was removed (deprecated in 1.21).
 244 * DatabaseBase::ignoreErrors() is now protected.
 245 * BREAKING CHANGE: mediawiki.legacy.ajax has been removed, following
 246   a lengthy deprecation period.
 247 * The ScopedPHPTimeout class was removed.
 248 * Removed maintenance script fixSlaveDesync.php.
 249 * Watchlist tokens, SpecialResetTokens, and User::getTokenFromOption()
 250   are deprecated. Applications using those can work via the OAuth
 251   extension instead. New tokens types should not be added.
 252 * (T36948) The default file revert message's timestamp is now in $wgLocaltimezone,
 253   instead of UTC.
 254 * DatabaseBase::errorCount() was removed (unused).
 255 * $wgDeferredUpdateList was removed.
 256 * DeferredUpdates::addHTMLCacheUpdate() was removed.
 257 * The default name of the 'suppress' group page has been changed from
 258   'Project:Oversight' to 'Project:Suppress'.
 259 * DatabaseBase::resultObject() is now protected (use outside Database classes
 260   not necessary since 1.11).
 261 * Calling ResourceLoaderFileModule::readStyleFiles() without a
 262   ResourceLoaderContext instance is deprecated.
 263 * ResourceLoader::getLessCompiler() now takes an optional parameter of
 264   additional LESS variables to set for the compiler.
 265
 266 == Compatibility ==
 267
 268 MediaWiki 1.26 requires PHP 5.3.3 or later. There is experimental support for
 269 HHVM 3.3.0.
 270
 271 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
 272 support for them is somewhat less mature. There is experimental support for
 273 Oracle and Microsoft SQL Server.
 274
 275 The supported versions are:
 276
 277 * MySQL 5.0.3 or later
 278 * PostgreSQL 8.3 or later
 279 * SQLite 3.3.7 or later
 280 * Oracle 9.0.1 or later
 281 * Microsoft SQL Server 2005 (9.00.1399)
 282
 283 == Upgrading ==
 284
 285 1.26 has several database changes since 1.25, and will not work without schema
 286 updates. Note that due to changes to some very large tables like the revision
 287 table, the schema update may take quite long (minutes on a medium sized site,
 288 many hours on a large site).
 289
 290 If upgrading from before 1.11, and you are using a wiki as a commons
 291 repository, make sure that it is updated as well. Otherwise, errors may arise
 292 due to database schema changes.
 293
 294 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
 295 new database fields are filled with data.
 296
 297 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
 298 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
 299 with MediaWiki 1.21.
 300
 301 Don't forget to always back up your database before upgrading!
 302
 303 See the file UPGRADE for more detailed upgrade instructions.
 304
 305 For notes on 1.25.x and older releases, see HISTORY.
 306
 307 == Online documentation ==
 308
 309 Documentation for both end-users and site administrators is available on
 310 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 311 for pages that explicitly state that their contents are in the public domain):
 312
 313         https://www.mediawiki.org/wiki/Documentation
 314
 315 == Mailing list ==
 316
 317 A mailing list is available for MediaWiki user support and discussion:
 318
 319         https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 320
 321 A low-traffic announcements-only list is also available:
 322
 323         https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 324
 325 It's highly recommended that you sign up for one of these lists if you're
 326 going to run a public MediaWiki, so you can be notified of security fixes.
 327
 328 == IRC help ==
 329
 330 There's usually someone online in #mediawiki on irc.freenode.net.