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