RELEASE-NOTES-1.24

   1 Security reminder: MediaWiki does not require PHP's register_globals. If you
   2 have it on, turn it '''off''' if you can.
   3
   4 == MediaWiki 1.24 ==
   5
   6 THIS IS NOT A RELEASE YET
   7
   8 MediaWiki 1.24 is an alpha-quality branch and is not recommended for use in
   9 production.
  10
  11 === Configuration changes in 1.24 ===
  12 * The server's canonical hostname is available as $wgServerName, which is
  13   exposed in both mw.config and ApiQuerySiteInfo.
  14 * Introduced $wgPagePropsHaveSortkey as a backwards-compatibility switch,
  15   for using the old schema of the page_props table, in case the respective
  16   schema update was not applied.
  17 * $wgSearchEverythingOnlyLoggedIn was removed as the 'searcheverything'
  18   user option was removed. Use $wgNamespacesToBeSearchedDefault instead or
  19   if you used to have $wgDefaultUserOptions['searcheverything'] = 1.
  20 * $wgMasterWaitTimeout has been deprecated.
  21 * $wgDBClusterTimeout has been removed.
  22 * $wgProxyKey has been removed. It is no longer used by MediaWiki core.
  23   Ensure $wgSecretKey is set in LocalSettings.php.
  24 * $wgExtraInterlanguageLinkPrefixes is a new configuration variable that
  25   contains an array of interwiki prefixes that should be treated as language
  26   prefixes (i.e. turned into interlanguage links when $wgInterwikiMagic is set
  27   to true).
  28 * $wgParserTestRemote has been removed.
  29
  30 === New features in 1.24 ===
  31 * Added a new hook, "WhatLinksHereProps", to allow extensions to annotate
  32   WhatLinksHere entries.
  33 * Added a new hook, "ContentGetParserOutput", to customize parser output for
  34   a given content object.
  35 * Deprecated the hook "ShowRawCssJs", use "ContentGetParserOutput" instead.
  36 * HTMLForm's HTMLTextField now supports the 'url' type.
  37 * HTMLForm fields may now be dynamically hidden based on the values of other
  38   fields in the form.
  39 * HTMLForm now supports multiple copies of an input field or set of input
  40   fields, e.g. the form may request "one or more usernames" without having to
  41   have the user enter delimited list of names into a text field.
  42 * Added a new hook, "SidebarBeforeOutput", to allow to edit the structure of
  43   the sidebar just before its display.
  44 * (bug 49156) Added the mediawiki.cookie ResourceLoader module, which wraps
  45   jquery.cookie so that getting/setting a cookie is syntactically and
  46   functionally similar to using the WebRequest::getCookie() and
  47   WebResponse::setcookie() methods.
  48 * (bug 44740) jQuery upgraded from 1.8.3 to 1.11.1. A new configuration option,
  49   $wgIncludejQueryMigrate, also loads the jQuery Migrate hack to let extensions
  50   and gadgets use the long-deprecated functions that were removed in jQuery 1.9.
  51   This option is turned off by default, and will be removed in MediaWiki 1.25.
  52 * (bug 47076) jQuery UI upgraded from 1.8.24 to 1.9.2.
  53 * Changes to content typography (fonts, etc.). See
  54   https://www.mediawiki.org/wiki/Typography_refresh for further information.
  55 * WikitextContent will now render redirects with the expected "redirect"
  56   header, rather than as an ordered list. Code calling Article::viewRedirect
  57   can probably be changed to no longer special-case redirects.
  58 * Header font set to a serif font stack. See
  59   https://www.mediawiki.org/wiki/Typography_refresh for further information.
  60 * (bug 65567) Added a new hook, "BeforeHttpsRedirect", to allow cancellation of
  61   the HTTP to HTTPS redirect due to forceHTTPS cookie, userRequires, etc. This
  62   is only for page views, since this hook doesn't affect UserLogin, OAuth,
  63   CentralAuth, etc. ATTENTION: This hook is likely to be removed soon due to
  64   overall design of the system.
  65 * (bug 17367) It is now possible to add pages to your watchlist from
  66   Special:UnwatchedPages without reloading the special page.
  67 * New methods setVolatile and isVolatile are added to PPFrame, so that
  68   extensions such as Cite.php can mark that their output is volatile and
  69   shouldn't be cached.
  70 * (bug 52817) Advanced search options are now saved on the search page itself,
  71   rather than in a dedicated pane in the preferences panel.
  72 * (bug 44591) The dropdown actions menu (little triangle next to page tabs) in
  73   the Vector skin has gained a label that should make it more discoverable.
  74 * MWCryptHKDF added for fast, cryptographically secure random number generation
  75   that won't deplete openssl's entropy pool.
  76 * ResourceLoader: File modules can now provide a skip function that uses an
  77   inline feature test to bypass loading of the module.
  78 * (bug 20210) Special pages may now provide autocompletion of their subpage
  79   names in search suggestions. Right now the only useful implementation is in
  80   Special:Log, but more are to come.
  81 * Special:MostLinkedTemplates is no longer limited to transclusions from the
  82   Template namespace.
  83 * Skins can now use 'remoteSkinPath' when defining ResourceLoader modules.
  84   This works the same as 'remoteExtPath' but is relative to the skins/ folder
  85   instead of the extensions/ folder.
  86 * Added the json2.js polyfill for the ES5 JSON.stringify and JSON.parse methods.
  87   Exposed as module "json" with a skip function to optimise loading.
  88 * Extensions and skins may now use 'namemsg' in $wgExtensionCredits in addition
  89   to 'name', to allow for the name to be localizable. 'name' should still be
  90   specified for backwards-compatibility and to define the path Special:Version
  91   uses to find extension license information.
  92 * Browser tests are now included to verify basic wiki functionality in developer
  93   environments. For details on running tests, see tests/browser/README.mediawiki.
  94 * Upgrade jStorage to v0.4.10.
  95 * {{!}} is now a magic word that produces the | character. This removes the need
  96   for Template:! for purposes such as passing pipes inside of parameters.
  97 * (bug 20790) The block log snippet on Special:Contributions and while
  98   editing user and user talk pages now works for IP range blocks.
  99 * (bug 9360) Added ability to change the page language for MediaWiki pages using
 100   Special:PageLanguage. All pages are set to wiki language by default.
 101   The feature needs to be enabled with $wgPageLanguageUseDB=true and
 102   permission needs to be set for 'pagelang'.
 103 * Upgrade Moment.js to v2.7.0.
 104
 105 === Bug fixes in 1.24 ===
 106 * (bug 49116) Footer copyright notice is now always displayed in user language
 107   rather than content language (same as copyright notice for editing interface).
 108 * (bug 62258) A bug was fixed in File::getUnscaledThumb when a height
 109   restriction was present in the parameters. Images with both the "frame"
 110   option and a size specification set will now always ignore the provided
 111   size and display an unscaled image, as the documentation has always
 112   claimed it would.
 113 * (bug 39035) Improved Vector skin performance by removing collapsibleNav,
 114   which used to collapse some sidebar elements by default.
 115   This removes -list id suffixes like p-lang-list: instead of using things like
 116   #p-lang-list, you can do #p-lang .body ul.
 117 * (bug 890) Links in Special:RecentChanges and Special:Watchlist no longer
 118   follow redirects to their target pages.
 119 * Parser now dies early if called recursively, instead of producing subtle bugs.
 120 * (bug 14323) Redirect pages, when viewed with redirect=no, no longer hide the
 121   remaining page content.
 122 * (bug 52587) Maintenance script deleteBatch.php no longer follows redirects
 123   in the file namespace and delete the file on the target page. It will still
 124   however delete the redirect page.
 125 * (bug 22683) {{msgnw:}} and other uses of PPFrame::RECOVER_ORIG will correctly
 126   recover the original code of extension tags.
 127 * (bug 65757) MSSQL: Update script drops unnamed constraints to be prepared
 128   for future updates. Because it's doing so heuristically, it may fail or drop
 129   wrong constraints.
 130
 131 === Web API changes in 1.24 ===
 132 * action=parse API now supports prop=modules, which provides the list of
 133   ResourceLoader modules that should be used to enhance the parsed content.
 134 * action=query&meta=siteinfo&siprop=interwikimap returns a new "protorel"
 135   field which is true iff protocol-relative urls can be used to access
 136   a particular interwiki map entry.
 137 * ApiQueryLogEvents now provides logpage, which is the page ID from the
 138   logging table, if ids are requested and the user has the permissions.
 139 * action=edit now requires that appendtext, prependtext, or section=new be used
 140   when using the 'redirect' parameter, to prevent clients accidentally
 141   overwriting the target page with the content of the redirect.
 142 * action=logevents will now return an error if both letitle and leprefix are
 143   specified.
 144 * action=logevents has a new parameter, lenamespace, to allow filtering by
 145   namespace.
 146 * action=expandtemplates has a new parameter, prop, and a new output format.
 147   The old format is still used if prop isn't provided, but this is deprecated.
 148 * meta=userinfo can now return the count of unread pages on the watchlist.
 149 * list=watchlist can now filter by unread status.
 150
 151 === Languages updated in 1.24 ===
 152
 153 MediaWiki supports over 350 languages. Many localisations are updated
 154 regularly. Below only new and removed languages are listed, as well as
 155 changes to languages because of Bugzilla reports.
 156
 157 === Other changes in 1.24 ===
 158 * The deprecated jquery.delayedBind ResourceLoader module was removed.
 159 * The deprecated function mw.util.toggleToc was removed.
 160 * The Special:Search hooks SpecialSearchGo and SpecialSearchResultsAppend
 161   were removed as they were unused.
 162 * (bug 65477) User::pingLimiter() now has an additional profile point varying
 163   by action being used.
 164 * mediawiki.util.$content no longer supports old versions of the Vector,
 165   Monobook, Modern and CologneBlue skins that don't yet implement the "mw-body"
 166   and/or "mw-body-primary" class name in their html.
 167 * Added pp_sortkey column to page_props table, so pages can be efficiently
 168   queried and sorted by property value (bug 58032).
 169   See $wgPagePropsHaveSortkey if you want to postpone the schema change.
 170 * BREAKING CHANGE: The Modern and Cologne Blue skins were moved out of MediaWiki
 171   core to their own respective repositories. See also
 172   https://www.mediawiki.org/wiki/Skin:Modern and
 173   https://www.mediawiki.org/wiki/Skin:CologneBlue.
 174 * BREAKING CHANGE: Skins built for MediaWiki 1.15 and earlier that do not use
 175   the "headelement" template key are no longer supported. Setting
 176   $useHeadElement = false; is no longer supported and will not cause old keys
 177   like "headlinks", "skinnameclass", etc. to be defined.
 178 * The deprecated 'SpecialVersionExtensionTypes' hook was removed.
 179 * (bug 63891) Add 'X-Robots-Tag: noindex' header in action=render pages.
 180 * SpecialPage no longer supports the syntax for invoking wfSpecial*() functions.
 181   Special pages should subclass SpecialPage and implement the execute() method.
 182 * (bug 63755) The deprecated constants RC_MOVE and RC_MOVE_OVER_REDIRECT were
 183   removed.
 184 * Special:MostLinkedTemplates has been renamed to Special:MostTranscludedPages.
 185 * The skin autodiscovery mechanism has been deprecated and will be removed in
 186   MediaWiki 1.25. See https://www.mediawiki.org/wiki/Manual:Skin_autodiscovery
 187   for migration guide for creators and users of custom skins that relied on it.
 188 * ResourceLoaderFileModule#getAllStyleFiles now returns all style files and all
 189   skin style files used by the module.
 190 * Removed getLang() from IContextSource and subclasses. (deprecated since 1.19)
 191 * Removed setLang() from subclasses of IContextSource. (deprecated since 1.19)
 192 * Removed WebRequest::escapeAppendQuery(). (deprecated since 1.20)
 193 * Removed info(), purge(), revert() and rollback() from the Article class; they
 194   have since become subclasses of the Action class. (deprecated since 1.19)
 195 * SearchEngineReplacePrefixesComplete hook was removed.
 196 * The "jquery.json" module has been deprecated. Use the "json" module instead.
 197 * Removed HTMLForm::addJS(). (deprecated since 1.18)
 198 * Removed LogEventsList::showHeader(). (deprecated since 1.19)
 199 * Removed ImageGalleryBase::useSkin(). (deprecated since 1.18)
 200 * Removed DatabaseMysqlBase::getLagFromProcesslist(). (deprecated since 1.19)
 201 * Removed LoadBalancer::closeConnecton(). (deprecated since 1.18)
 202 * Removed ApiBase::createContext(). (deprecated since 1.19)
 203 * BREAKING CHANGE: The undocumented Special{$this->getName()}BeforeFormDisplay
 204   set of hooks has been removed and replaced by a single new hook
 205   SpecialPageBeforeFormDisplay.
 206 * (bug 65781) Removed block warning on included {{Special:Contributions}}
 207
 208 ==== Renamed classes ====
 209 * CLDRPluralRuleConverter_Expression to CLDRPluralRuleConverterExpression
 210 * CLDRPluralRuleConverter_Fragment to CLDRPluralRuleConverterFragment
 211 * CLDRPluralRuleConverter_Operator to CLDRPluralRuleConverterOperator
 212 * CLDRPluralRuleEvaluator_Range to CLDRPluralRuleEvaluatorRange
 213 * CSSJanus_Tokenizer to CSSJanusTokenizer
 214 * MediaWiki_I18N to MediaWikiI18N
 215 * Parser_DiffTest to ParserDiffTest
 216 * RevDel_ArchiveItem to RevDelArchiveItem
 217 * RevDel_ArchiveList to RevDelArchiveList
 218 * RevDel_ArchivedFileItem to RevDelArchivedFileItem
 219 * RevDel_ArchivedFileList to RevDelArchivedFileList
 220 * RevDel_ArchivedRevisionItem to RevDelArchivedRevisionItem
 221 * RevDel_FileItem to RevDelFileItem
 222 * RevDel_FileList to RevDelFileList
 223 * RevDel_Item to RevDelItem
 224 * RevDel_List to RevDelList
 225 * RevDel_LogItem to RevDelLogItem
 226 * RevDel_LogList to RevDelLogList
 227 * RevDel_RevisionItem to RevDelRevisionItem
 228 * RevDel_RevisionList to RevDelRevisionList
 229 * WebInstaller_Complete to WebInstallerComplete
 230 * WebInstaller_Copying to WebInstallerCopying
 231 * WebInstaller_DBConnect to WebInstallerDBConnect
 232 * WebInstaller_DBSettings to WebInstallerDBSettings
 233 * WebInstaller_Document to WebInstallerDocument
 234 * WebInstaller_ExistingWiki to WebInstallerExistingWiki
 235 * WebInstaller_Install to WebInstallerInstall
 236 * WebInstaller_Language to WebInstallerLanguage
 237 * WebInstaller_Name to WebInstallerName
 238 * WebInstaller_Options to WebInstallerOptions
 239 * WebInstaller_Readme to WebInstallerReadme
 240 * WebInstaller_ReleaseNotes to WebInstallerReleaseNotes
 241 * WebInstaller_Restart to WebInstallerRestart
 242 * WebInstaller_Upgrade to WebInstallerUpgrade
 243 * WebInstaller_UpgradeDoc to WebInstallerUpgradeDoc
 244 * WebInstaller_Welcome to WebInstallerWelcome
 245
 246 ==== Removed classes ====
 247 * IPBlockForm - Use SpecialBlock directly
 248 * WatchlistEditor - Use SpecialEditWatchlist directly
 249
 250 == Compatibility ==
 251
 252 MediaWiki 1.24 requires PHP 5.3.2 or later.
 253
 254 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
 255 support for them is somewhat less mature. There is experimental support for
 256 Oracle and Microsoft SQL Server.
 257
 258 The supported versions are:
 259
 260 * MySQL 5.0.2 or later
 261 * PostgreSQL 8.3 or later
 262 * SQLite 3.3.7 or later
 263 * Oracle 9.0.1 or later
 264 * Microsoft SQL Server 2005 (9.00.1399)
 265
 266 == Upgrading ==
 267
 268 1.24 has several database changes since 1.23, and will not work without schema
 269 updates. Note that due to changes to some very large tables like the revision
 270 table, the schema update may take quite long (minutes on a medium sized site,
 271 many hours on a large site).
 272
 273 If upgrading from before 1.11, and you are using a wiki as a commons
 274 repository, make sure that it is updated as well. Otherwise, errors may arise
 275 due to database schema changes.
 276
 277 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
 278 new database fields are filled with data.
 279
 280 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
 281 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
 282 with MediaWiki 1.21.
 283
 284 Don't forget to always back up your database before upgrading!
 285
 286 See the file UPGRADE for more detailed upgrade instructions.
 287
 288 For notes on 1.23.x and older releases, see HISTORY.
 289
 290 == Online documentation ==
 291
 292 Documentation for both end-users and site administrators is available on
 293 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 294 for pages that explicitly state that their contents are in the public domain):
 295
 296         https://www.mediawiki.org/wiki/Documentation
 297
 298 == Mailing list ==
 299
 300 A mailing list is available for MediaWiki user support and discussion:
 301
 302         https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 303
 304 A low-traffic announcements-only list is also available:
 305
 306         https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 307
 308 It's highly recommended that you sign up for one of these lists if you're
 309 going to run a public MediaWiki, so you can be notified of security fixes.
 310
 311 == IRC help ==
 312
 313 There's usually someone online in #mediawiki on irc.freenode.net.