RELEASE-NOTES-1.29

   1 == MediaWiki 1.29 ==
   2
   3 THIS IS NOT A RELEASE YET
   4
   5 MediaWiki 1.29 is an alpha-quality branch and is not recommended for use in
   6 production.
   7
   8 === Configuration changes in 1.29 ===
   9 * Default cookie expiration time has been reduced to 30 days. Login cookie
  10   expiration time is kept at 180 days.
  11 * A new configuration variable has been added: $wgCookieSetOnAutoblock. This
  12   determines whether to set a cookie when a user is autoblocked. Doing so means
  13   that a blocked user, even after logging out and moving to a new IP address,
  14   will still be blocked.
  15 * The resetpassword right and associated password reset capture feature has
  16   been removed.
  17 * The $error parameter to the EmailUser hook should be set to a Status object
  18   or boolean false. This should be compatible with at least MediaWiki 1.23 if
  19   not earlier. Returning a raw HTML string is now deprecated.
  20 * The $message parameter to the ApiCheckCanExecute hook should be set to an
  21   ApiMessage. This is compatible with MediaWiki 1.27 and later. Returning a
  22   code for ApiBase::parseMsg() will no longer work.
  23 * ApiBase::$messageMap is no longer public. Code attempting to access it will
  24   result in a PHP fatal error.
  25 * $wgUserEmailUseReplyTo is now true by default to work around restrictive DMARC
  26   policies.
  27 * Subpages are now enabled by default in the Template namespace. Set
  28   $wgNamespacesWithSubpages[NS_TEMPLATE] to false to keep the old behavior.
  29 * $wgRunJobsAsync is now false by default (T142751). This change only affects
  30   wikis with $wgJobRunRate > 0.
  31 * A temporary feature flag, $wgDisableUserGroupExpiry, is provided to disable
  32   new features that rely on the schema changes to the user_groups table. This
  33   feature flag will likely be removed before 1.29 is released.
  34 * (T158474) "Unknown user" has been added to $wgReservedUsernames.
  35 * (T156983) $wgRateLimitsExcludedIPs now accepts CIDR ranges as well as single IPs.
  36
  37 === New features in 1.29 ===
  38 * (T5233) A cookie can now be set when a user is autoblocked, to track that user
  39   if they move to a new IP address. This is disabled by default.
  40 * Added ILocalizedException interface to standardize the use of localized
  41   exceptions, largely so the API can handle them more sensibly.
  42 * Blocks created automatically by MediaWiki, such as for configured proxies or
  43   dnsbls, are now indicated as such and use a new i18n message when displayed.
  44 * Added new $wgHTTPImportTimeout setting. Sets timeout for
  45   downloading the XML dump during a transwiki import in seconds.
  46 * Parser limit report is now available in machine-readable format to JavaScript
  47   via mw.config.get('wgPageParseReport').
  48 * Added $wgSoftBlockRanges, to allow for automatically blocking anonymous edits
  49   from certain IP ranges (e.g. private IPs).
  50 * (T59603) Added new magic word {{PAGELANGUAGE}} which returns the language code
  51   of the page being parsed.
  52 * HTML5 form validation attributes will no longer be suppressed. Originally
  53   browsers had poor support for them, but modern browsers handle them fine.
  54   This might affect some forms that used them and only worked because the
  55   attributes were not actually being set.
  56 * Expiry times can now be specified when users are added to user groups.
  57
  58 === External library changes in 1.29 ===
  59
  60 ==== Upgraded external libraries ====
  61 * Updated QUnit from v1.22.0 to v1.23.1.
  62 * Updated cssjanus from v1.1.2 to 1.1.3.
  63 * Updated psr/log from v1.0.0 to v1.0.2.
  64
  65 ==== New external libraries ====
  66
  67 ==== Removed and replaced external libraries ====
  68
  69 === Bug fixes in 1.29 ===
  70 * (T62604) Core parser functions returning a number now format the number according
  71   to the page content language, not wiki content language.
  72 * (T27187) Search suggestions based on jquery.suggestions will now correctly only
  73   highlight prefix matches in the results.
  74 * (T157035) "new mw.Uri()" was ignoring options when using default URI.
  75
  76 === Action API changes in 1.29 ===
  77 * Submitting sensitive authentication request parameters to action=login,
  78   action=clientlogin, action=createaccount, action=linkaccount, and
  79   action=changeauthenticationdata in the query string is now an error. They
  80   should be submitted in the POST body instead.
  81 * The capture option for action=resetpassword has been removed
  82 * action=clearhasmsg now requires a POST.
  83 * (T47843) API errors and warnings may be requested in non-English languages
  84   using the new 'errorformat', 'errorlang', and 'errorsuselocal' parameters.
  85 * API error codes may have changed. Most notably, errors from modules using
  86   parameter prefixes (e.g. all query submodules) will no longer be prefixed.
  87 * ApiPageSet-using modules will report the 'invalidreason' using the specified
  88   'errorformat'.
  89 * action=emailuser may return a "Warnings" status, and now returns 'warnings' and
  90   'errors' subelements (as applicable) instead of 'message'.
  91 * action=imagerotate returns an 'errors' subelement rather than 'errormessage'.
  92 * action=move now reports errors when moving the talk page as an array under
  93   key 'talkmove-errors', rather than using 'talkmove-error-code' and
  94   'talkmove-error-info'. The format for subpage move errors has also changed.
  95 * action=revisiondelete no longer includes a "rendered" property on warnings
  96   and errors for each item. Use errorformat=wikitext if you're wanting parsed
  97   output.
  98 * action=rollback no longer returns a "messageHtml" property. Use
  99   errorformat=html if you're wanting HTML formatting of error messages.
 100 * action=upload now reports optional stash failures as an array under key
 101   'stasherrors' rather than a 'stashfailed' text string.
 102 * action=watch reports 'errors' and 'warnings' instead of a single 'error', and
 103   no longer returns a 'message' on success.
 104 * Added action=validatepassword to validate passwords for the account creation
 105   and password change forms.
 106 * action=purge now requires a POST.
 107
 108 === Action API internal changes in 1.29 ===
 109 * New methods were added to ApiBase to handle errors and warnings using i18n
 110   keys. Methods for using hard-coded English messages were deprecated:
 111   * ApiBase::dieUsage() was deprecated
 112   * ApiBase::dieUsageMsg() was deprecated
 113   * ApiBase::dieUsageMsgOrDebug() was deprecated
 114   * ApiBase::getErrorFromStatus() was deprecated
 115   * ApiBase::parseMsg() was deprecated
 116   * ApiBase::setWarning() was deprecated
 117 * ApiBase::$messageMap is no longer public. Code attempting to access it will
 118   result in a PHP fatal error.
 119 * The $message parameter to the ApiCheckCanExecute hook should be set to an
 120   ApiMessage. This is compatible with MediaWiki 1.27 and later. Returning a
 121   code for ApiBase::parseMsg() will no longer work.
 122 * UsageException is deprecated in favor of ApiUsageException. For the time
 123   being ApiUsageException is a subclass of UsageException to allow things that
 124   catch only UsageException to still function properly.
 125 * If, for some strange reason, code was using an ApiErrorFormatter instead of
 126   ApiErrorFormatter_BackCompat, note that the result format has changed and
 127   various methods now take a module path rather than a module name.
 128 * ApiMessageTrait::getApiCode() now strips 'apierror-' and 'apiwarn-' prefixes
 129   from the message key, and maps some message keys for backwards compatibility.
 130
 131 === Languages updated in 1.29 ===
 132
 133 MediaWiki supports over 350 languages. Many localisations are updated
 134 regularly. Below only new and removed languages are listed, as well as
 135 changes to languages because of Phabricator reports.
 136
 137 * Based as always on linguistic studies on intelligibility and language
 138   knowledge by geography, language fallbacks have been expanded. When a
 139   translation is missing in the user's preferred interface language, the
 140   corresponding translation for the fallback language will be used instead.
 141   English will only be used as last resort when there are no translations.
 142   Some configurations (such as date formats and gender namespaces) have also
 143   been updated when using the fallback language's configuration was inadequate.
 144   The new or reinstated language fallbacks are (after cs ↔ sk in 1.28):
 145   ca ↔ oc; hsb ↔ dsb; io → eo; mdf → ru; pnt → el; roa-tara → it; rup → ro;
 146   sh → bs, sr-el, hr.
 147 * (T155957) Talk Namespaces for Javanese language (jv) have been updated.
 148
 149 ==== No fallback for Ukrainian ====
 150 * (T39314) The fallback from Ukrainian to Russian was removed. The Ukrainian
 151   language will now use the default fallback language: English. When a translation
 152   to Ukrainian is not available, an English string will be shown.
 153
 154 === Other changes in 1.29 ===
 155 * Database::getSearchEngine() (deprecated in 1.28) was removed. Use
 156   SearchEngineFactory::getSearchEngineClass() instead.
 157 * $wgSessionsInMemcached (deprecated in 1.20) was removed. No replacement is
 158   required as all sessions are stored in Object Cache now.
 159 * MWHttpRequest::execute() should be considered to return a StatusValue; the
 160   Status return type is deprecated.
 161 * User::edits() (deprecated in 1.21) was removed.
 162 * Xml::escapeJsString() (deprecated in 1.21) was removed.
 163 * Article::getText() and Article::prepareTextForEdit() (deprecated in 1.21)
 164   were removed.
 165 * Article::getAutosummary() and WikiPage::getAutosummary() (deprecated in 1.21)
 166   were removed.
 167 * Hook ArticleViewCustom (deprecated in 1.21) was removed. Use ArticleContentViewCustom
 168   instead.
 169 * Hooks EditPageGetDiffText and ShowRawCssJs (deprecated in 1.21) were removed.
 170 * Class RevisiondeleteAction (deprecated in 1.25) was removed.
 171 * WikiPage::prepareTextForEdit() (deprecated in 1.21) was removed.
 172 * WikiPage::getText() (deprecated in 1.21) was removed.
 173 * Article::fetchContent() (deprecated in 1.21) was removed.
 174 * User::getPassword() (deprecated in 1.27) was removed.
 175 * User::getTemporaryPassword() (deprecated in 1.27) was removed.
 176 * User::isPasswordReminderThrottled() (deprecated in 1.27) was removed.
 177 * Class FSRepo (deprecated in 1.19) was removed.
 178 * WebRequest::checkSessionCookie() (deprecated in 1.27) was removed. Use
 179   \MediaWiki\Session\SessionManager::singleton()->getPersistedSessionId() instead.
 180 * Class ImageGallery (deprecated in 1.22) was removed.
 181   Use ImageGalleryBase::factory instead.
 182 * Title::moveNoAuth() (deprecated in 1.25) was removed. Use MovePage class instead.
 183 * Hook UnknownAction (deprecated in 1.19) was actually deprecated (it will now
 184   emit warnings). Create a subclass of Action and add it to $wgActions instead.
 185 * WikiRevision::getText() (deprecated since 1.21) is no longer marked deprecated.
 186 * Linker::getInterwikiLinkAttributes() (deprecated since 1.25) was removed.
 187 * Linker::getInternalLinkAttributes() (deprecated since 1.25) was removed.
 188 * Linker::getInternalLinkAttributesObj() (deprecated since 1.25) was removed.
 189 * Linker::getLinkAttributesInternal() (deprecated since 1.25) was removed.
 190 * RedisConnectionPool::handleException (deprecated since 1.23) was removed.
 191 * The static properties mw.Api.errors and mw.Api.warnings, containing incomplete
 192   and outdated lists of errors/warnings returned by the API, are now deprecated.
 193 * wiki.phtml entry point was removed.  Refer to index.php instead. If you want "wiki.phtml"
 194   URLs to continue to work, set up redirects. In Apache, this can be done by enabling
 195   mod_rewrite and adding the following rules to your configuration:
 196
 197     RewriteEngine On
 198     RewriteBase /
 199     RewriteRule ^/w/wiki\.phtml$ /w/index.php [R=301,L]
 200 * Hook ArticleAfterFetchContent (deprecated in 1.21) was removed.
 201   Use ArticleAfterFetchContentObject instead.
 202 * Hook ArticleInsertComplete (deprecated in 1.21) was removed.
 203   Use PageContentInsertComplete instead.
 204 * Hook ArticleSave (deprecated in 1.21) was removed.
 205   Use PageContentSave instead.
 206 * Hook ArticleSaveComplete (deprecated in 1.21) was removed.
 207   Use PageContentSaveComplete instead.
 208 * Hook EditFilterMerged (deprecated in 1.21) was removed.
 209   Use EditFilterMergedContent instead.
 210 * Hook EditPageGetPreviewText (deprecated in 1.21) was removed.
 211   Use EditPageGetPreviewContent instead.
 212 * Hook TitleIsCssOrJsPage (deprecated in 1.21) was removed.
 213   Use ContentHandlerDefaultModelFor instead.
 214 * Hook TitleIsWikitextPage (deprecated in 1.21) was removed.
 215   Use ContentHandlerDefaultModelFor instead.
 216 * Article::getContent() (deprecated in 1.21) was removed.
 217 * Revision::getText() (deprecated in 1.21) was removed.
 218 * Article::doEdit() and WikiPage::doEdit() (deprecated in 1.21) were removed.
 219 * Parser::replaceUnusualEscapes() (deprecated in 1.24) was removed.
 220 * Article::doEditContent() was marked as deprecated, to be removed in 1.30
 221   or later.
 222 * ContentHandler::runLegacyHooks() was removed.
 223 * refreshLinks.php now can be limited to a particular category with --category=...
 224   or a tracking category with --tracking-category=...
 225 * User-like objects that are passed to SpecialUserRights and its subclasses are
 226   now required to have a getGroupMemberships() method. See UserRightsProxy for
 227   an example.
 228 * User::$mGroups (instance variable) was marked private. Use User::getGroups()
 229   instead.
 230 * User::getGroupName(), User::getGroupMember(), User:getGroupPage(),
 231   User::makeGroupLinkHTML(), and User::makeGroupLinkWiki() were deprecated.
 232   Use equivalent methods on the UserGroupMembership class.
 233 * Maintenance scripts and tests that call User::addGroup() must now ensure that
 234   User objects have been added to the database prior to calling addGroup().
 235 * Protected function UsersPager::getGroups() was removed, and protected function
 236   UsersPager::buildGroupLink() was changed from a static to an instance method.
 237 * The third parameter ($cache) to the UsersPagerDoBatchLookups hook was changed;
 238   see docs/hooks.txt.
 239 * User::crypt() (deprecated in 1.24) was removed.
 240 * User::comparePasswords() (deprecated in 1.24) was removed.
 241 * ArchivedFile::getUserText() (deprecated in 1.23) was removed.
 242 * HTMLFileCache::newFromTitle() (deprecated in 1.24) was removed.
 243
 244 == Compatibility ==
 245
 246 MediaWiki 1.29 requires PHP 5.5.9 or later. There is experimental support for
 247 HHVM 3.6.5 or later.
 248
 249 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
 250 support for them is somewhat less mature. There is experimental support for
 251 Oracle and Microsoft SQL Server.
 252
 253 The supported versions are:
 254
 255 * MySQL 5.0.3 or later
 256 * PostgreSQL 8.3 or later
 257 * SQLite 3.3.7 or later
 258 * Oracle 9.0.1 or later
 259 * Microsoft SQL Server 2005 (9.00.1399)
 260
 261 == Upgrading ==
 262
 263 1.29 has several database changes since 1.28, and will not work without schema
 264 updates. Note that due to changes to some very large tables like the revision
 265 table, the schema update may take quite long (minutes on a medium sized site,
 266 many hours on a large site).
 267
 268 If upgrading from before 1.11, and you are using a wiki as a commons
 269 repository, make sure that it is updated as well. Otherwise, errors may arise
 270 due to database schema changes.
 271
 272 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
 273 new database fields are filled with data.
 274
 275 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
 276 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
 277 with MediaWiki 1.21.
 278
 279 Don't forget to always back up your database before upgrading!
 280
 281 See the file UPGRADE for more detailed upgrade instructions.
 282
 283 For notes on 1.28.x and older releases, see HISTORY.
 284
 285 == Online documentation ==
 286
 287 Documentation for both end-users and site administrators is available on
 288 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 289 for pages that explicitly state that their contents are in the public domain):
 290
 291        https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
 292
 293 == Mailing list ==
 294
 295 A mailing list is available for MediaWiki user support and discussion:
 296
 297        https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 298
 299 A low-traffic announcements-only list is also available:
 300
 301        https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 302
 303 It's highly recommended that you sign up for one of these lists if you're
 304 going to run a public MediaWiki, so you can be notified of security fixes.
 305
 306 == IRC help ==
 307
 308 There's usually someone online in #mediawiki on irc.freenode.net.