OutputPage: documentation for (semi-)deprecated methods
[mediawiki.git] / RELEASE-NOTES-1.27
blob3a45fae6a6388f5a41f1d8e8b88ff0a1110ccfc0
1 Security reminder: If you have PHP's register_globals option set, you must
2 turn it off. MediaWiki will not work with it enabled.
4 == MediaWiki 1.27 ==
6 THIS IS NOT A RELEASE YET
8 MediaWiki 1.27 is an alpha-quality branch and is not recommended for use in
9 production.
11 === Configuration changes in 1.27 ===
12 * $wgUseLinkNamespaceDBFields was removed.
13 * Deprecated $wgResourceLoaderMinifierStatementsOnOwnLine and
14   $wgResourceLoaderMinifierMaxLineLength, because there was little value in
15   making the behavior configurable. The default values (`false` for the former,
16   1000 for the latter) are now hard-coded.
17 * $wgDebugDumpSqlLength was removed (deprecated in 1.24).
18 * $wgDebugDBTransactions was removed (deprecated in 1.20).
19 * $wgUseXVO has been removed, as it provides functionality only used by
20   custom Wikimedia patches against Squid 2.x that probably noone uses in
21   production anymore. There is now $wgUseKeyHeader that provides similar
22   functionality but instead of the MediaWiki-specific X-Vary-Options header,
23   uses the draft Key header standard.
24 * $wgScriptExtension (and support for '.php5' entry points) was removed. See the
25   deprecation notice in the release notes for version 1.25 for advice on how to
26   preserve support for '.php5' entry points via URL rewriting.
27 * Password handling via the User object has been deprecated and partially
28   removed, pending the future introduction of AuthManager. In particular:
29 ** expirePassword(), getPasswordExpireDate(), resetPasswordExpiration(), and
30    getPasswordExpired() have been removed. They were unused outside of core.
31 ** The mPassword, mNewpassword, mNewpassTime, and mPasswordExpires fields are
32    now private and will be removed in the future.
33 ** The getPassword() and getTemporaryPassword() methods now throw
34    BadMethodCallException and will be removed in the future.
35 ** The ability to pass 'password' and 'newpassword' to createNew() has been
36    removed. The only users of it seem to have been using it to set invalid
37    passwords, and so shouldn't be greatly affected.
38 ** setPassword(), setInternalPassword(), and setNewpassword() have been
39    deprecated, pending the introduction of AuthManager.
40 ** User::randomPassword() is deprecated in favor of a new method
41    PasswordFactory::generateRandomPasswordString()
42 ** User::getPasswordFactory() is deprecated, callers should just create a
43    PasswordFactory themselves.
44 ** A new constructor, User::newSystemUser(), has been added to simplify the
45    creation of passwordless "system" users for logged actions.
46 * $wgMaxSquidPurgeTitles was removed.
47 * $wgAjaxWatch was removed. This is now enabled by default.
49 === New features in 1.27 ===
50 * $wgDataCenterId and $wgDataCenterRoles where added, which will serve as
51   basic configuration settings needed for multi-datacenter setups.
52   $wgDataCenterUpdateStickTTL was also added.
53 * Added a new hook, 'UserMailerTransformContent', to transform the contents
54   of an email. This is similar to the EmailUser hook but applies to all mail
55   sent via UserMailer.
56 * Added a new hook, 'UserMailerTransformMessage', to transform the contents
57   of an emai after MIME encoding.
58 * Added a new hook, 'UserMailerSplitTo', to control which users have to be
59   emailed separately (ie. there is a single address in the To: field) so
60   user-specific changes to the email can be applied safely.
61 * $wgCdnMaxageLagged was added, which limits the CDN cache TTL
62   when any load balancer uses a DB that is lagged beyond the 'max lag'
63   setting in the relevant section of $wgLBFactoryConf.
64 * User::newSystemUser() may be used to simplify the creation of passwordless
65   "system" users for logged actions from scripts and extensions.
67 ==== External libraries ====
69 === Bug fixes in 1.27 ===
71 === Action API changes in 1.27 ===
72 * Added list=allrevisions.
73 * generator=recentchanges now has the option to generate revids.
74 * ApiPageSet::setRedirectMergePolicy() was added. This allows generator
75   modules to define how generator data for a redirect source gets merged
76   into the redirect destination.
77 * prop=imageinfo&iiprop=uploadwarning will no longer include the possibility of
78   "was-deleted" warning.
79 * Added difftotextpst to query=revisions which preforms a pre-save transform on
80   the text before diffing it.
82 === Action API internal changes in 1.27 ===
83 * ApiQueryORM removed.
85 === Languages updated in 1.27 ===
87 MediaWiki supports over 350 languages. Many localisations are updated
88 regularly. Below only new and removed languages are listed, as well as
89 changes to languages because of Bugzilla reports.
91 === Other changes in 1.27 ===
92 * ProfilerOutputUdp was removed. Note that there is a ProfilerOutputStats class.
93 * WikiPage::doDeleteArticleReal() and WikiPage::doDeleteArticle() now
94   ignore the 2nd and 3rd arguments (formerly $id and $commit).
95 * Removed "loaderScripts" option from ResourceLoaderFileModule class.
97 == Compatibility ==
99 MediaWiki 1.27 requires PHP 5.3.3 or later. There is experimental support for
100 HHVM 3.3.0.
102 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
103 support for them is somewhat less mature. There is experimental support for
104 Oracle and Microsoft SQL Server.
106 The supported versions are:
108 * MySQL 5.0.3 or later
109 * PostgreSQL 8.3 or later
110 * SQLite 3.3.7 or later
111 * Oracle 9.0.1 or later
112 * Microsoft SQL Server 2005 (9.00.1399)
114 == Upgrading ==
116 1.27 has several database changes since 1.26, and will not work without schema
117 updates. Note that due to changes to some very large tables like the revision
118 table, the schema update may take quite long (minutes on a medium sized site,
119 many hours on a large site).
121 If upgrading from before 1.11, and you are using a wiki as a commons
122 repository, make sure that it is updated as well. Otherwise, errors may arise
123 due to database schema changes.
125 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
126 new database fields are filled with data.
128 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
129 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
130 with MediaWiki 1.21.
132 Don't forget to always back up your database before upgrading!
134 See the file UPGRADE for more detailed upgrade instructions.
136 For notes on 1.26.x and older releases, see HISTORY.
138 == Online documentation ==
140 Documentation for both end-users and site administrators is available on
141 MediaWiki.org, and is covered under the GNU Free Documentation License (except
142 for pages that explicitly state that their contents are in the public domain):
144        https://www.mediawiki.org/wiki/Documentation
146 == Mailing list ==
148 A mailing list is available for MediaWiki user support and discussion:
150        https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
152 A low-traffic announcements-only list is also available:
154        https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
156 It's highly recommended that you sign up for one of these lists if you're
157 going to run a public MediaWiki, so you can be notified of security fixes.
159 == IRC help ==
161 There's usually someone online in #mediawiki on irc.freenode.net.