RELEASE-NOTES-1.30

   1 == MediaWiki 1.30 ==
   2
   3 THIS IS NOT A RELEASE YET
   4
   5 MediaWiki 1.30 is an alpha-quality branch and is not recommended for use in
   6 production.
   7
   8 === MySQL version requirement in 1.30 ===
   9 As of 1.30, MediaWiki now requires MySQL 5.5.8 or higher (see Compatibility
  10 section).
  11
  12 === Configuration changes in 1.30 ===
  13 * The "C.UTF-8" locale should be used for $wgShellLocale, if available, to avoid
  14   unexpected behavior when code uses locale-sensitive string comparisons. For
  15   example, the Scribunto extension considers "bar" < "Foo" in most locales
  16   since it ignores case.
  17 * $wgShellLocale now affects LC_ALL rather than only LC_CTYPE. See
  18   documentation of $wgShellLocale for details.
  19 * $wgShellLocale is now applied for all requests. wfInitShellLocale() is
  20   deprecated and a no-op, as it is no longer needed.
  21 * $wgJobClasses may now specify callback functions as an alternative to plain
  22   class names. This is intended for extensions that want control over the
  23   instantiation of their jobs, to allow for proper dependency injection.
  24 * $wgResourceModules may now specify callback functions as an alternative
  25   to plain class names, using the 'factory' key in the module description
  26   array. This allows dependency injection to be used for ResourceLoader modules.
  27 * $wgExceptionHooks has been removed.
  28 * (T163562) $wgRangeContributionsCIDRLimit was introduced to control the size
  29   of IP ranges that can be queried at Special:Contributions.
  30 * (T45547) $wgUsePigLatinVariant added (off by default).
  31 * (T152540) MediaWiki now supports a section ID escaping style that allows to display
  32   non-Latin characters verbatim on many modern browsers. This is controlled by the
  33   new configuration setting, $wgFragmentMode.
  34 * $wgExperimentalHtmlIds is now deprecated and will be removed in a future version,
  35   use $wgFragmentMode to migrate off it to a modern alternative.
  36 * $wgExternalInterwikiFragmentMode was introduced to control how fragments in
  37   sinterwikis going outside of current wiki farm are encoded.
  38 * (T120333) Soft-deprecated the use of PHP extension 'mysql' in favor of 'mysqli'.
  39   This PHP extension was deprecated in PHP 5.5 and removed in PHP 7.0. MediaWiki
  40   auto-selects the 'mysqli' driver since MediaWiki 1.22, except if explicitly
  41   requested through the configuration parameter $wgDBservers.
  42 * $wgOOUIEditPage was removed, as it is now the default. This was documented as a
  43   temporary variable during the migration period.
  44
  45 === New features in 1.30 ===
  46 * (T37247) Output from Parser::parse() will now be wrapped in a div with
  47   class="mw-parser-output" by default. This may be changed or disabled using
  48   ParserOptions::setWrapOutputClass().
  49 * (T163562) Added ability to search for contributions within an IP ranges
  50   at Special:Contributions.
  51 * Added 'ChangeTagsAllowedAdd' hook, enabling extensions to allow software-
  52   specific tags to be added by users.
  53 * Added a 'ParserOptionsRegister' hook to allow extensions to register
  54   additional parser options.
  55 * (T45547) Included Pig Latin, a language game in English, as a
  56   LanguageConverter variant.  This allows English-speaking developers
  57   to develop and test LanguageConverter more easily.  Pig Latin can be
  58   enabled by setting $wgUsePigLatinVariant to true.
  59 * Added RecentChangesPurgeRows hook to allow extensions to purge data that
  60   depends on the recentchanges table.
  61 * Added JS config values wgDiffOldId/wgDiffNewId to the output of diff pages.
  62 * (T2424) Added direct unwatch links to entries in Special:Watchlist (if the
  63   'watchlistunwatchlinks' preference option is enabled). With JavaScript
  64   enabled, these links toggle so the user can also re-watch pages that have
  65   just been unwatched.
  66 * Added $wgParserTestMediaHandlers, where mock media handlers can be passed to
  67   MediaHandlerFactory for parser tests.
  68 * Edit summaries, block reasons, and other "comments" are now stored in a
  69   separate database table. Use the CommentFormatter class to access them.
  70 ** This is currently gated by $wgCommentTableSchemaMigrationStage. Most wikis
  71    can set this to MIGRATION_NEW and run maintenance/migrateComments.php as
  72    soon as any necessary extensions are updated.
  73 * (T138166) Added ability for users to prohibit other users from sending them
  74   emails with Special:Emailuser. Can be enabled by setting
  75   $wgEnableUserEmailBlacklist to true.
  76 * (T67297) $wgBrowserBlacklist is deprecated, and changing it will have no effect.
  77   Instead, users using browsers that do not support Unicode will be unable to edit
  78   and should upgrade to a modern browser instead.
  79
  80 === External library changes in 1.30 ===
  81
  82 ==== Upgraded external libraries ====
  83 * mediawiki/mediawiki-codesniffer updated to 0.8.1.
  84 * wikimedia/composer-merge-plugin updated to 1.4.1.
  85
  86 ==== New external libraries ====
  87 * The class \TestingAccessWrapper has been moved to the external library
  88   wikimedia/testing-access-wrapper and renamed \Wikimedia\TestingAccessWrapper.
  89
  90 ==== Removed and replaced external libraries ====
  91 * …
  92
  93 === Bug fixes in 1.30 ===
  94 * (T151633) Ordered list items use now Devanagari digits in Nepalese
  95   (thanks to Sfic)
  96
  97 === Action API changes in 1.30 ===
  98 * (T37247) action=parse output will be wrapped in a div with
  99   class="mw-parser-output" by default. This may be changed or disabled using
 100   the new 'wrapoutputclass' parameter.
 101 * When errorformat is not 'bc', abort reasons from action=login will be
 102   formatted as specified by the error formatter parameters.
 103 * action=compare can now handle arbitrary text, deleted revisions, and
 104   returning users and edit comments.
 105 * (T164106) The 'rvdifftotext', 'rvdifftotextpst', 'rvdiffto',
 106   'rvexpandtemplates', 'rvgeneratexml', 'rvparse', and 'rvprop=parsetree'
 107   parameters to prop=revisions are deprecated, as are the similarly named
 108   parameters to prop=deletedrevisions, list=allrevisions, and
 109   list=alldeletedrevisions. Use action=compare, action=parse, or
 110   action=expandtemplates instead.
 111
 112 === Action API internal changes in 1.30 ===
 113 * ApiBase::getDescriptionMessage() and the "apihelp-*-description" messages are
 114   deprecated. The existing message should be split between "apihelp-*-summary"
 115   and "apihelp-*-extended-description".
 116 * (T123931) Individual values of multi-valued parameters can now be marked as
 117   deprecated.
 118
 119 === Languages updated in 1.30 ===
 120 MediaWiki supports over 350 languages. Many localisations are updated
 121 regularly. Below only new and removed languages are listed, as well as
 122 changes to languages because of Phabricator reports.
 123
 124 * Added: kbp (Kabɩyɛ / Kabiyè)
 125 * Added: skr (Saraiki, سرائیکی)
 126 * Added: tay (Tayal / Atayal)
 127 * Removed: tokipona (Toki Pona)
 128
 129 ==== Pig Latin added ====
 130 * (T45547) Added Pig Latin, a made-up English variant (en-x-piglatin),
 131   for easier variant development and testing. Disabled by default. It can be
 132   enabled by setting $wgUsePigLatinVariant to true.
 133
 134 === Other changes in 1.30 ===
 135 * The use of an associative array for $wgProxyList, where the IP address is in
 136   the key instead of the value, is deprecated (e.g. [ '127.0.0.1' => 'value' ]).
 137   Please convert these arrays to indexed/sequential ones (e.g. [ '127.0.0.1' ]).
 138 * mw.user.bucket (deprecated in 1.23) was removed.
 139 * LoadBalancer::getServerInfo() and LoadBalancer::setServerInfo() are
 140   deprecated. There are no known callers.
 141 * File::getStreamHeaders() was deprecated.
 142 * MediaHandler::getStreamHeaders() was deprecated.
 143 * Title::canTalk() was deprecated. The new Title::canHaveTalkPage() should be
 144   used instead.
 145 * MWNamespace::canTalk() was deprecated. The new MWNamespace::hasTalkNamespace()
 146   should be used instead.
 147 * The ExtractThumbParameters hook (deprecated in 1.21) was removed.
 148 * The OutputPage::addParserOutputNoText and ::getHeadLinks methods (both
 149   deprecated in 1.24) were removed.
 150 * wfMemcKey() and wfGlobalCacheKey() were deprecated. BagOStuff::makeKey() and
 151   BagOStuff::makeGlobalKey() should be used instead.
 152 * (T146304) Preprocessor handling of LanguageConverter markup has been improved.
 153   As a result of the new uniform handling, '-{' may need to be escaped
 154   (for example, as '-<nowiki/>{') where it occurs inside template arguments
 155   or wikilinks.
 156 * (T163966) Page moves are now counted as edits for the purposes of
 157   autopromotion, i.e., they increment the user_editcount field in the database.
 158 * Two new hooks, LogEventsListLineEnding and NewPagesLineEnding, were added for
 159   manipulating Special:Log and Special:NewPages lines.
 160 * The OldChangesListRecentChangesLine, EnhancedChangesListModifyLineData,
 161   PageHistoryLineEnding, ContributionsLineEnding and DeletedContributionsLineEnding
 162   hooks have an additional parameter, for manipulating HTML data attributes of
 163   RC/history lines. EnhancedChangesListModifyBlockLineData can do that via the
 164   $data['attribs'] subarray.
 165 * (T130632) The OutputPage::enableTOC() method was removed.
 166 * WikiPage::getParserOutput() will now throw an exception if passed
 167   ParserOptions that would pollute the parser cache. Callers should use
 168   WikiPage::makeParserOptions() to create the ParserOptions object and only
 169   change options that affect the parser cache key.
 170 * Article::viewRedirect() is deprecated.
 171 * IP::isValidBlock() was deprecated. Use the equivalent IP::isValidRange().
 172 * DeprecatedGlobal no longer supports passing in a direct value, it requires a
 173   callable factory function or a class name.
 174 * The $parserMemc global, wfGetParserCacheStorage(), and ParserCache::singleton()
 175   are all deprecated. The main ParserCache instance should be obtained from
 176   MediaWikiServices instead. Access to the underlying BagOStuff is possible
 177   through the new ParserCache::getCacheStorage() method.
 178 * .mw-ui-constructive CSS class (deprecated in 1.27) was removed.
 179 * Sanitizer::escapeId() was deprecated, use escapeIdForAttribute(),
 180   escapeIdForLink() or escapeIdForExternalInterwiki() instead.
 181 * Title::escapeFragmentForURL() was deprecated, use one of the aforementioned
 182   Sanitizer functions or, if possible, Title::getFragmentForURL().
 183 * Second parameter to Sanitizer::escapeIdReferenceList() ($options) now does
 184   nothing and is deprecated.
 185 * mw.util.escapeId() was deprecated, use escapeIdForAttribute() or
 186   escapeIdForLink().
 187 * MagicWord::replaceMultiple() (deprecated in 1.25) was removed.
 188 * WikiImporter now requires the second parameter to be an instance of the Config,
 189   class. Prior to that, the Config parameter was optional (a behavior deprecated in
 190   1.25).
 191 * Removed 'jquery.mwExtension' module. (deprecated since 1.26)
 192 * mediawiki.ui: Deprecate greys, which are not part of WikimediaUI color palette
 193   any more.
 194 * CdbReader, CdbWriter, CdbException classes (deprecated in 1.25) were removed.
 195   The namespaced classes in the Cdb namespace should be used instead.
 196 * IPSet class (deprecated in 1.26) was removed. The namespaced IPSet\IPSet
 197   should be used instead.
 198 * RunningStat class (deprecated in 1.27) was removed. The namespaced
 199   RunningStat\RunningStat should be used instead.
 200 * MWMemcached and MemCachedClientforWiki classes (deprecated in 1.27) were removed.
 201   The MemcachedClient class should be used instead.
 202 * EditPage underwent some refactoring and deprecations:
 203   * EditPage::isOouiEnabled() is deprecated and will always return true.
 204   * EditPage::getSummaryInput() and ::getSummaryInputOOUI() are deprecated. Please
 205     use ::getSummaryInputWidget() instead.
 206   * EditPage::getCheckboxes() and ::getCheckboxesOOUI() are deprecated. Please
 207     use ::getCheckboxesWidget() instead.
 208   * Creating an EditPage instance without calling EditPage::setContextTitle() should
 209     be avoided and will be deprecated in a future release.
 210   * EditPage::safeUnicodeInput() and ::safeUnicodeOutput() are deprecated and no-ops.
 211   * EditPage::$isCssJsSubpage, ::$isCssSubpage, and ::$isJsSubpage are deprecated. The
 212     corresponding methods from Title should be used instead.
 213   * EditPage::$isWrongCaseCssJsPage is deprecated. There is no replacement.
 214   * EditPage::$mArticle and ::$mTitle are deprecated for public usage. The getters
 215     ::getArticle() and ::getTitle() should be used instead.
 216   * Trying to control or fake EditPage context by overriding $wgUser, $wgRequest, $wgOut,
 217     and $wgLang is no longer supported and won't work. The IContextSource returned from
 218     EditPage::getContext() must be modified instead.
 219 * Parser::getRandomString() (deprecated in 1.26) was removed.
 220 * Parser::uniqPrefix() (deprecated in 1.26) was removed.
 221 * Parser::extractTagsAndParams() now only accepts three arguments. The fourth,
 222   $uniq_prefix was deprecated in 1.26 and has now been removed.
 223 * (T172514) The following tables have had their UNIQUE indexes turned into proper
 224   PRIMARY KEYs for increased maintainability: categorylinks, imagelinks, iwlinks,
 225   langlinks, log_search, module_deps, objectcache, pagelinks, query_cache, site_stats,
 226   templatelinks, text, transcache, user_former_groups, user_properties.
 227 * IDatabase::nextSequenceValue() is no longer needed by any database backends
 228   (formerly it was needed by PostgreSQL and Oracle), and is now deprecated.
 229 * (T146591) The lc_lang_key index on the l10n_cache table has been changed into a
 230   PRIMARY KEY.
 231 * (T157227) bot_password.bp_user, change_tag.ct_log_id, change_tag.ct_rev_id,
 232   page_restrictions.pr_user, tag_summary.ts_log_id, tag_summary.ts_rev_id and
 233   user_properties.up_user have all been made unsigned on MySQL.
 234 * DB_SLAVE is deprecated. DB_REPLICA should be used instead.
 235 * wfUsePHP() is deprecated.
 236 * wfFixSessionID() was removed.
 237 * wfShellExec() and related functions are deprecated, use Shell::command(). This also
 238   slightly changes the behavior of how execution time limits are calculated when only
 239   some of defaults are overridden per-call. When in doubt, always override both wall
 240   clock and CPU time.
 241 * (T138166) SpecialEmailUser::getTarget() now requires a second argument, the sending
 242   user object. Using the method without the second argument is deprecated.
 243 * (T67297) Browsers that don't support Unicode will have their edits rejected.
 244 * (T178450) The module 'jquery.badge' is deprecated and will be removed in a future
 245   release. For notifying the user of an event, the Notifications ("Echo") system
 246   should be used instead.
 247
 248 == Compatibility ==
 249 MediaWiki 1.30 requires PHP 5.5.9 or later. There is experimental support for
 250 HHVM 3.6.5 or later.
 251
 252 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
 253 but support for them is somewhat less mature. There is experimental support for
 254 Oracle and Microsoft SQL Server.
 255
 256 The supported versions are:
 257
 258 * MySQL 5.5.8 or later
 259 * PostgreSQL 8.3 or later
 260 * SQLite 3.3.7 or later
 261 * Oracle 9.0.1 or later
 262 * Microsoft SQL Server 2005 (9.00.1399)
 263
 264 == Upgrading ==
 265 1.30 has several database changes since 1.29, and will not work without schema
 266 updates. Note that due to changes to some very large tables like the revision
 267 table, the schema update may take a long time (minutes on a medium sized site,
 268 many hours on a large site).
 269
 270 Don't forget to always back up your database before upgrading!
 271
 272 See the file UPGRADE for more detailed upgrade instructions, including
 273 important information when upgrading from versions prior to 1.11.
 274
 275 For notes on 1.29.x and older releases, see HISTORY.
 276
 277 == Online documentation ==
 278 Documentation for both end-users and site administrators is available on
 279 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 280 for pages that explicitly state that their contents are in the public domain):
 281
 282        https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
 283
 284 == Mailing list ==
 285 A mailing list is available for MediaWiki user support and discussion:
 286
 287        https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 288
 289 A low-traffic announcements-only list is also available:
 290
 291        https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 292
 293 It's highly recommended that you sign up for one of these lists if you're
 294 going to run a public MediaWiki, so you can be notified of security fixes.
 295
 296 == IRC help ==
 297 There's usually someone online in #mediawiki on irc.freenode.net.