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 * Callers needing fast light-weight data stores use $wgMainStash to select
  77   the store type from $wgObjectCaches. The default is the local database.
  78 * Interface message overrides in the MediaWiki namespace will now be cached in
  79   memcached and APC (if available), rather than memcached and local files.
  80 * Added a new hook, 'RandomPageQuery', to allow modification of the query used
  81   by Special:Random to select random pages.
  82 * $wgTransactionalTimeLimit was added, which controls the request time limit
  83   for potentially slow POST requests that need to be as atomic as possible.
  84 * ResourceLoader now loads all scripts asynchronously. The top-queue and
  85   startup modules are no longer synchronously loaded.
  86 * 'mediawiki.ui.button' styles are no longer unconditionally loaded on every
  87   page. During the deprecation period, the styles will only be loaded on pages
  88   which contain 'mw-ui-button' in their HTML. Starting in 1.28, the styles will
  89   only be loaded if explicitly required.
  90 * If search returns zero results and current search engine has a "did you mean"
  91   suggestion, results for suggestion will be shown. Can be disabled by setting
  92   $wgSearchRunSuggestedQuery to false.
  93 * Added several JavaScript libraries for uploading files to MediaWiki
  94   from the client-side. See documentation for mw.Upload and its
  95   subclasses for more information.
  96 * Added OOUI dialogs and layout for file upload interfaces. See
  97   documentation for mw.Upload.Dialog, mw.Upload.BookletLayout and its
  98   subclasses for more information.
  99
 100 == extension.json changes in 1.26 ==
 101 * (T99344) The extension.json schema is now versioned. All extensions
 102   and skins should set a "manifest_version" property corresponding to
 103   the schema version they were written for. The only supported version
 104   currently is "1".
 105 * (T102523) The error message if a non-array attribute is set was improved.
 106 * (T107646) Configuration settings can now specify how they should be merged,
 107   which is necessary for arrays using integer keys.
 108 * (T110389) Adding namespaces through extension.json now actually works
 109 * $wgNamespaceProtection can now be set in extension.json.
 110 * $wgCapitalLinkOverrides can now be set in extension.json.
 111 * (T97186) Extensions using a custom prefix for their configuration settings
 112   can now set a "_prefix" key to override the default of "wg".
 113 * (T99084) Extensions can now specify what MediaWiki core versions they
 114   depend upon.
 115 * (T105236) The extension.json schema now validates custom classes in
 116   the "ResourceModules" property properly.
 117
 118 === External library changes in 1.26 ===
 119 ==== Upgraded external libraries ====
 120 * Updated es5-shim from v4.0.0 to v4.1.5.
 121 * Updated json2 from revision 2014-02-04 to 2015-05-03.
 122 * Updated Sinon.JS from 1.10.3 to 1.15.4.
 123 * Updated jQuery Client from v1.0.0 to v2.0.0.
 124 * Updated QUnit from v1.17.1 to v1.18.0.
 125 * Updated liuggio/statsd-php-client from v1.0.12 to v1.0.16.
 126 * Updated oojs/oojs-ui from v0.11.3 to v0.12.12.
 127 * Updated wikimedia/cdb from v1.0.1 to v1.3.0.
 128 * Updated wikimedia/utfnormal from v1.0.2 to v1.0.3.
 129 * Updated wikimedia/composer-merge-plugin from v1.0.0 to v1.3.0.
 130 * Updated zordius/lightncandy from v0.18 to v0.21.
 131
 132 ==== New external libraries ====
 133 * Added composer/semver v1.0.0.
 134 * Added mediawiki/at-ease v1.1.0.
 135 * Added wikimedia/assert v0.2.2.
 136 * Added wikimedia/ip-set v1.0.1.
 137 * Added wikimedia/wrappedstring v2.0.0.
 138
 139 ==== Removed and replaced external libraries ====
 140 * Replaced leafo/lessphp v0.5.0 with oyejorge/less.php v1.7.0.9.
 141
 142 === Bug fixes in 1.26 ===
 143 * (T53283) load.php sometimes sends 304 response without full headers
 144 * (T65198) Talk page tabs now have a "rel=discussion" attribute
 145 * (T98841) {{msgnw:}} now preserves comments even when subst: is not used.
 146 * (T104142) $wgEmergencyContact and $wgPasswordSender now use their default
 147   value if set to an empty string.
 148
 149 === Action API changes in 1.26 ===
 150 * New-style continuation is now the default for action=continue. Clients may
 151   use the 'rawcontinue' parameter to receive raw query-continue data, but the
 152   new style is encouraged as it's harder to implement incorrectly.
 153 * Deprecated API formats dump and wddx have been completely removed.
 154 * API action=query&list=tags: The displayname can now be boolean false if the
 155   tag is meant to be hidden from user interfaces.
 156 * action=import no longer allows both the namespace= and rootpage= parameters
 157   to be set. If they are both set, the value of rootpage= will be ignored.
 158 * prop=revision output in enum mode is now sorted by timestamp rather than
 159   revision ID. This usually won't make any difference.
 160 * (T102645) Namespace list from meta=siteinfo&siprop=namespaces is now an array
 161   with formatversion=2.
 162 * Various other output from meta=siteinfo will now always be arrays instead of
 163   sometimes being numerically-indexed objects with formatversion=2.
 164 * When errors about users being blocked are returned, they now include
 165   information about the relevant block.
 166 * (T99926) list=random has higher limits, in line with other API modules.
 167 * list=random's rnredirect parameter is deprecated in favor of a new
 168   rnfilterredir parameter that also allows for listing both redirects and
 169   non-redirects.
 170 * list=random now supports continuation.
 171 * API responses to GET requests may now include ETag and Last-Modified headers,
 172   and will honor corresponding If-None-Match and If-Modified-Since on such
 173   requests.
 174
 175 === Action API internal changes in 1.26 ===
 176 * New metadata item ApiResult::META_KVP_MERGE to allow for merging the KVP key
 177   into the value when the value is an assoc.
 178 * API action modules may now provide values for the RFC 7232 ETag and
 179   Last-Modified headers. The API will check these against If-None-Match and
 180   If-Modified-Since request headers on GET requests and avoid executing the
 181   module when appropriate.
 182
 183 === Languages updated in 1.26 ===
 184
 185 MediaWiki supports over 350 languages. Many localisations are updated
 186 regularly. Below only new and removed languages are listed, as well as
 187 changes to languages because of Phabricator reports.
 188
 189 * Languages added:
 190 ** ase (American sign language), thanks to translator Icemandeaf
 191 ** dty (डोटेली/Doteli), thanks to translators जनक राज भट्ट, बिप्लब आनन्द,
 192    मेश सिंह बोहरा, and राम प्रसाद जोशी
 193 ** luz (لئری دوٙمینی / Southern Luri)
 194 ** olo (Livvinкarjala / Livvi-Karelian), thanks to translators Denö, Hiloin Natoi,
 195    Ilja.mos, and Mashoi7
 196
 197 === Other changes in 1.26 ===
 198 * ChangeTags::tagDescription() will return false if the interface message
 199   for the tag is disabled.
 200 * Added PageHistoryPager::doBatchLookups hook.
 201 * Added $wikiId parameter to FormatAutocomments hook.
 202 * Added ParserCacheSaveComplete to ParserCache
 203 * supportsDirectEditing and supportsDirectApiEditing methods added to
 204   ContentHandler, to provide a way for ApiEditPage and EditPage to check
 205   if direct editing of content is allowed. These methods return false,
 206   by default for the ContentHandler base class and true for TextContentHandler
 207   and it's derivative classes (everything in core). For Content types that
 208   do not support direct editing, an alternative mechanism should be provided
 209   for editing, such as action overrides or specific api modules.
 210 * mediaWiki.confirmCloseWindow now returns an object of functions, instead of
 211   one function. The callback can't be called directly any more. The callback
 212   function is replaced with confirmCloseWindow.release().
 213 * BREAKING CHANGE: Added an optional ResouceLoaderContext parameter to
 214   ResourceLoaderModule::getDependencies(). Extension classes that override that
 215   method should be updated. If they aren't updated, PHP Strict standards
 216   warnings will appear when E_STRICT error reporting is enabled. Note: in the
 217   near future, this parameter will probably become non-optional.
 218 * Removed maintenance script deleteImageMemcached.php.
 219 * MWFunction::newObj() was removed (deprecated in 1.25).
 220   ObjectFactory::getObjectFromSpec() should be used instead.
 221 * The parser will no longer randomize the string it uses to mark the place of
 222   items that were stripped during parsing. It will use a fixed string instead.
 223   This causes the parser to re-use the regular expressions it uses to search
 224   and replace markers rather than generate novel expressions on each parse.
 225   Re-using regular expressions will improve performance on HHVM and the
 226   forthcoming PHP 7. The interfaces changes accompanying this change are:
 227   - Parser::getRandomString() and Parser::uniqPrefix() have been deprecated.
 228   - The $uniq_prefix argument for Parser::extractTagsAndParams() and the
 229     $prefix argument for StripState::_construct() are deprecated and their
 230     value is ignored.
 231 * wfSuppressWarnings() and wfRestoreWarnings() were split into a separate library,
 232   mediawiki/at-ease, and are now deprecated. Callers should use
 233   MediaWiki\suppressWarnings() and MediaWiki\restoreWarnings() directly.
 234 * The Block class constructor now takes an associative array of parameters
 235   instead of many optional positional arguments. Calling the constructor the old
 236   way will issue a deprecation warning.
 237 * The jquery.mwExtension module was deprecated.
 238 * $wgSpecialPageGroups was removed (deprecated in 1.21).
 239 * SpecialPageFactory::setGroup was removed (deprecated in 1.21).
 240 * SpecialPageFactory::getGroup was removed (deprecated in 1.21).
 241 * DatabaseBase::ignoreErrors() is now protected.
 242 * BREAKING CHANGE: mediawiki.legacy.ajax has been removed, following
 243   a lengthy deprecation period.
 244 * The ScopedPHPTimeout class was removed.
 245 * Removed maintenance script fixSlaveDesync.php.
 246 * Watchlist tokens, SpecialResetTokens, and User::getTokenFromOption()
 247   are deprecated. Applications using those can work via the OAuth
 248   extension instead. New tokens types should not be added.
 249 * DatabaseBase::errorCount() was removed (unused).
 250 * $wgDeferredUpdateList was removed.
 251 * DeferredUpdates::addHTMLCacheUpdate() was removed.
 252
 253 == Compatibility ==
 254
 255 MediaWiki 1.26 requires PHP 5.3.3 or later. There is experimental support for
 256 HHVM 3.3.0.
 257
 258 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
 259 support for them is somewhat less mature. There is experimental support for
 260 Oracle and Microsoft SQL Server.
 261
 262 The supported versions are:
 263
 264 * MySQL 5.0.3 or later
 265 * PostgreSQL 8.3 or later
 266 * SQLite 3.3.7 or later
 267 * Oracle 9.0.1 or later
 268 * Microsoft SQL Server 2005 (9.00.1399)
 269
 270 == Upgrading ==
 271
 272 1.26 has several database changes since 1.25, and will not work without schema
 273 updates. Note that due to changes to some very large tables like the revision
 274 table, the schema update may take quite long (minutes on a medium sized site,
 275 many hours on a large site).
 276
 277 If upgrading from before 1.11, and you are using a wiki as a commons
 278 repository, make sure that it is updated as well. Otherwise, errors may arise
 279 due to database schema changes.
 280
 281 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
 282 new database fields are filled with data.
 283
 284 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
 285 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
 286 with MediaWiki 1.21.
 287
 288 Don't forget to always back up your database before upgrading!
 289
 290 See the file UPGRADE for more detailed upgrade instructions.
 291
 292 For notes on 1.25.x and older releases, see HISTORY.
 293
 294 == Online documentation ==
 295
 296 Documentation for both end-users and site administrators is available on
 297 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 298 for pages that explicitly state that their contents are in the public domain):
 299
 300         https://www.mediawiki.org/wiki/Documentation
 301
 302 == Mailing list ==
 303
 304 A mailing list is available for MediaWiki user support and discussion:
 305
 306         https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 307
 308 A low-traffic announcements-only list is also available:
 309
 310         https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 311
 312 It's highly recommended that you sign up for one of these lists if you're
 313 going to run a public MediaWiki, so you can be notified of security fixes.
 314
 315 == IRC help ==
 316
 317 There's usually someone online in #mediawiki on irc.freenode.net.