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