Improve API query RevDel handling
[mediawiki.git] / RELEASE-NOTES-1.23
bloba5e223b56a2b8a9e040188bce155252dfe82ed64
1 Security reminder: MediaWiki does not require PHP's register_globals. If you
2 have it on, turn it '''off''' if you can.
4 == MediaWiki 1.23 ==
6 THIS IS NOT A RELEASE YET
8 MediaWiki 1.23 is an alpha-quality branch and is not recommended for use in
9 production.
11 === Configuration changes in 1.23 ===
12 * $wgDebugLogGroups values may be set to an associative array with a
13   'destination' key specifying the log destination. The array may also contain
14   a 'sample' key with a positive integer value N indicating that the log group
15   should be sampled by dispatching one in every N messages on average. The
16   sampling is random.
17 * In addition to the current exception log format, MediaWiki now serializes
18   exception metadata to JSON and logs it to the 'exception-json' log group.
19   This makes MediaWiki easier to integrate with log aggregation and analysis
20   tools.
21 * $wgSquidServersNoPurge now supports the use of Classless Inter-Domain
22   Routing (CIDR) notation to specify contiguous blocks of IPv4 and/or IPv6
23   addresses that should be trusted to provide X-Forwarded-For headers.
24 * Preferences 'watchcreations' and 'watchdefault' ("Add pages I create and files
25   I upload to my watchlist", "Add pages and files I edit to my watchlist") are
26   now enabled by default.
27 * $wgLBFactoryConf: Class names have had underscores removed. The configuration
28   should be updated if LBFactory_Simple or LBFactory_Multi is configured.
29 * $wgPasswordSenderName has been deprecated. To set a custom mailer name,
30   the system message 'emailsender' should be modified (default: "{{SITENAME}}").
31 * $wgDBAhandler was removed as the only class using it was also removed
33 === New features in 1.23 ===
34 * ResourceLoader can utilize the Web Storage API to cache modules client-side.
35   Compared to the browser cache, caching in Web Storage allows ResourceLoader
36   to be more granular about evicting stale modules from the cache while
37   retaining the ability to retrieve multiple modules in a single HTTP request.
38   This capability can be enabled by setting $wgResourceLoaderStorageEnabled to
39   true. This feature is currently considered experimental and should only be
40   enabled with care.
41 * (bug 6092) Add expensive parser functions {{REVISIONID:}}, {{REVISIONUSER:}}
42   and {{REVISIONTIMESTAMP:}} (with friends).
43 * Add "wgRelevantUserName" to mw.config containing the current
44   Skin::getRelevantUser value.
45 * (bug 56033) Add content model to the page information.
46 * Added Article::MissingArticleConditions hook to give extensions a chance to
47   hide their (unrelated) log entries.
48 * Added LonelyPagesQuery hook to let extensions modify the query used to
49   generate Special:LonelyPages.
50 * Added $wgOpenSearchDefaultLimit defining the default number of entries to show
51   on action=opensearch API call.
52 * For namespaces with $wgNamespaceProtection (including the MediaWiki
53   namespace), the "protect" tab will be shown only if there are restriction
54   levels available that would restrict editing beyond what
55   $wgNamespaceProtection already applies. The protection form will offer only
56   those protection levels.
57 * Added $wgAPIFormatModules, allowing extensions to add additional output
58   formatting modules for the API.
59 * (bug 47812) The MediaWiki:Group-user.{css,js} pages can now be used to add
60   custom CSS or JavaScript enabled only for registered users.
61 * (bug 52005) Special pages RecentChanges, RecentChangesLinked and Watchlist
62   now include a legend describing the symbols used in lists of changes.
63 * Improved the accessibility of the tabs in Special:Preferences.
64 * Added ApiBeforeMain hook, roughly equivalent to the BeforeInitialize hook:
65   it's called after everything is set up but before any major processing
66   happens.
67 * The jquery.client module now performs a component-wise version comparison in
68   its #test method when strings are used in the browser map: version '1.10' is
69   now correctly considered larger than '1.2'. Using numbers in the version map
70   is not affected.
71 * All API modules now support an assert parameter, which can either be
72   'user' or 'bot'. The API will throw an error if the user is not logged
73   in (user) or does not have the 'bot' userright (bot). Based off of the
74   AssertEdit extension by Steve Sanbeg.
75 * WikitextContent will now render redirects with the expected "redirect"
76   header, rather than as an ordered list. Code calling Article::viewRedirect
77   can probably be changed to no longer special-case redirects.
79 === Bug fixes in 1.23 ===
80 * (bug 41759) The "updated since last visit" markers (on history pages, recent
81   changes and watchlist) and the talk page message indicator are now correctly
82   updated when the user is viewing old revisions of pages, instead of always
83   acting as if the latest revision was being viewed.
84 * (bug 56443) Special:ConfirmEmail no longer shows a "Mail a confirmation code"
85   when the email address is already confirmed. Also, consistently use
86   "confirmed", rather than "authenticated", when messaging whether or not the
87   user has confirmed an email address.
88 * (bug 56912) Show correct link color on cached result of Special:DeadendPages.
89 * Classes TitleListDependency and TitleDependency have been removed, as they
90   have been found unused in core and extensions for a long time.
91 * (bug 57098) SpecialPasswordReset now obeys returnto parameter
92 * (bug 37812) ResourceLoader will notice when a module's definition changes and
93   recompile it accordingly.
94 * (bug 57201) SpecialRecentChangesFilters hook is now executed for feeds.
95 * (bug 58640) Fixed a compatibility issue with PCRE 8.34 that caused pages
96   to appear blank or with missing text.
97 * (bug 56931) Updated the plural rules to CLDR 24. They are in new format
98   which is detailed in UTS 35 Rev 33. The PHP parser and evaluator as well as
99   the JavaScript evaluator were updated to support the new format. Plural rules
100   for some languages have changed, most notably Russian. Affected software
101   messages have been updated and marked for review at translatewiki.net.
102 * (bug 14323) Redirect pages, when viewed with redirect=no, no longer hide the
103   remaining page content.
104 * (bug 23542) imagelinks now stores both the redirect and target (as
105   templatelinks does).
106 * (bug 58167) The web installer no longer throws an exception when PHP is
107   compiled without support for MySQL yet with support for another DBMS.
108 * (bug 56199) Raw option of parser functions must now match complete word,
109   to take effect.
111 === Web API changes in 1.23 ===
112 * (bug 54884) action=parse&prop=categories now indicates hidden and missing
113   categories.
114 * action=query&meta=filerepoinfo now returns additional information for each
115   repo.
116 * action=parse&prop=languageshtml was deprecated in 1.18 and will be removed in
117   MediaWiki 1.24.
118 * action=parse now has disabletoc flag to disable table of contents in output.
119 * (bug 25702) list=allcategories, list=allimages, list=alllinks, list=allpages,
120   list=deletedrevs and list=filearchive did not handle case-sensitivity
121   properly for all parameters.
122 * ApiQueryBase::titlePartToKey allows an extra parameter that indicates the
123   namespace in order to properly capitalize the title part.
124 * (bug 57874) action=feedcontributions no longer has one item more than limit.
125 * All API modules now support an assert parameter. See the new features section
126   for more details.
127 * Added prop=contributors to fetch the list of contributors to the page.
128 * The following API modules will now return entries where fields have been
129   revision-deleted: list=deletedrevs, list=filearchive, list=recentchanges,
130   list=watchlist. "hidden" indicators will be included, in the same style as is
131   already done for prop=revisions.
132 * The following API modules will now return the content of revision-deleted
133   fields, in addition to the "hidden" indicators, if the querying user has the
134   necessary rights: list=logevents, list=usercontribs, prop=imageinfo,
135   prop=revisions.
136 * The above modules, where applicable, will now return entries filtered by
137   revision-deleted fields if the querying user has the necessary rights. For
138   example, prop=revisions with rvuser or rvexcludeuser will no longer skip
139   revisions where the user was revision-deleted if the current user has the
140   deletedhistory right.
141 * The 'hideuser' right, used when blocking, is no longer necessary or
142   sufficient for seeing contributions with revision-deleted in
143   list=usercontribs.
144 * list=watchlist now uses the querying user's rights rather than the wlowner's
145   rights when checking whether wlprop=patrol is allowed.
147 === Languages updated in 1.23 ===
149 MediaWiki supports over 350 languages. Many localisations are updated
150 regularly. Below only new and removed languages are listed, as well as
151 changes to languages because of Bugzilla reports.
153 * Support was added for Northern Luri (lrc).
155 === Other changes in 1.23 ===
156 * The rc_type field in the recentchanges table has been superseded by a new
157   rc_source field.  The rc_source field is a string representation of the
158   change type where rc_type was a numeric constant.  This field is not yet
159   queried but will be in a future point release of 1.22.
160 ** Utilize update.php to create and populate this new field.  On larger wiki's
161    which do not wish to update recentchanges table in one large update please
162    review the sql and comments in maintenance/archives/patch-rc_source.sql.
163 ** The rc_type field of recentchanges will be deprecated in a future point
164    release.
165 * The global variable $wgArticle has been removed after a lengthy deprecation.
166 * The global functions addButton and insertTags (for mw.toolbar.addButton and
167   mw.toolbar.insertTags) now emits mw.log.warn when accessed.
168 * The ExpandTemplates extension has been moved into MediaWiki core.
169 * (bug 52812) Removed "Disable search suggestions" from Preference.
170 * (bug 52809) Removed "Disable browser page caching" from Preference.
171 * Three new modules intended for use by custom skins were added:
172   'skins.common.elements', 'skins.common.content', and 'skins.common.interface',
173   representing three levels of standard MediaWiki styling. Previously skin
174   creators wishing to use them had to refer to the file names of appropriate
175   files directly, which is now discouraged.
176 * The modules 'skins.vector' and 'skins.monobook' have been renamed to
177   'skins.vector.styles' and 'skins.monobook.styles', respectively,
178   and their definition was changed not to include the common*.css files;
179   the two skins now load the 'skins.common.interface' module instead.
180 * A page_links_updated field has been added to the page table.
181 * SpecialPage::getTitle has been deprecated in favor of
182   SpecialPage::getPageTitle.
183 * BREAKING CHANGE: Two potentially backwards-incompatible changes have been made
184   to the 'SpecialWatchlistQuery' hook's last parameter (array $values) to make
185   the hook more consistent with the 'SpecialRecentChangesQuery' one:
186 ** Several array keys have been renamed: hideMinor → hideminor,
187    hideBots → hidebots, hideAnons → hideanons, hideLiu → hideliu,
188    hidePatrolled → hidepatrolled, hideOwn → hidemyself.
189 ** The parameter value is now a FormOptions object, not a plain array (array
190    access operators should continue to work, as it implements the ArrayAccess
191    interface).
192 * Option to mark hooks as deprecated has been added.
194 ==== Removed classes ====
195 * TitleDependency (unused)
196 * TitleListDependency (unused)
197 * WikiError (deprecated in 1.17)
198 * WikiXmlError (deprecated in 1.17)
199 * WikiErrorMsg (deprecated in 1.17)
201 ==== Renamed classes ====
202 * CdbReader_DBA to CdbReaderDBA
203 * CdbReader_PHP to CdbReaderPHP
204 * CdbWriter_DBA to CdbWriterDBA
205 * CdbWriter_PHP to CdbWriterPHP
206 * DiffOp_Add to DiffOpAdd
207 * DiffOp_Change to DiffOpChange
208 * DiffOp_Copy to DiffOpCopy
209 * DiffOp_Delete to DiffOpDelete
210 * HWLDF_WordAccumulator to HWLDFWordAccumulator
211 * LBFactory_Fake to LBFactoryFake
212 * LBFactory_Multi to LBFactoryMulti
213 * LBFactory_Simple to LBFactorySimple
214 * LBFactory_Single to LBFactorySingle
215 * LCStore_Accel to LCStoreAccel
216 * LCStore_CDB to LCStoreCDB
217 * LCStore_DB to LCStoreDB
218 * LCStore_Null to LCStoreNull
219 * LoadBalancer_Single to LoadBalancerSingle
220 * LoadMonitor_MySQL to LoadMonitorMySQL
221 * LoadMonitor_Null to LoadMonitorNull
222 * LocalisationCache_BulkLoad to LocalisationCacheBulkLoad
223 * csvStatsOutput to CsvStatsOutput
224 * extensionLanguages to ExtensionLanguages
225 * languages to Languages
226 * statsOutput to StatsOutput
227 * textStatsOutput to TextStatsOutput
228 * wikiStatsOutput to WikiStatsOutput
230 ==== Removed methods ====
231 * ApiBase::getValidNamespaces() (deprecated in 1.17)
232 * ApiMain::setCachePrivate() (deprecated in 1.17)
233 * ApiMain::setVaryCookie (deprecated in 1.17)
234 * Article::forUpdate() (deprecated in 1.18)
235 * CategoryViewer::addSubcategory() (deprecated in 1.17)
236 * EditPage::spamPage() (deprecated since 1.17)
237 * Exif::getFormattedData() (deprecated in 1.18)
238 * Exif::makeFormattedData() (deprecated in 1.18)
239 * Language::convertLinkToAllVariants() (deprecated in 1.17)
240 * LanguageConverter::convertLinkToAllVariants() (deprecated in 1.17)
241 * Linker::makeBrokenLink() (deprecated in 1.16)
242 * Linker::makeBrokenLinkObj() (deprecated in 1.16)
243 * Linker::makeColouredLinkObj() (deprecated in 1.16)
244 * Linker::makeSizeLinkObj() (deprecated in 1.17)
245 * ProfilerSimple::getCpuTime (deprecated in 1.20)
246 * Revision::revText() (deprecated in 1.17)
247 * SkinTemplate::jstext() (deprecated in 1.21)
248 * SpecialPage::__call() (deprecated in 1.17)
249 * SpecialPage::executePath() (deprecated in 1.18)
250 * SpecialPage::exists() (deprecated in 1.18)
251 * SpecialPage::file() (deprecated in 1.18)
252 * SpecialPage::func() (deprecated in 1.18)
253 * SpecialPage::getGroup() (deprecated in 1.18)
254 * SpecialPage::getPage() (deprecated in 1.18)
255 * SpecialPage::getPageByAlias() (deprecated in 1.18)
256 * SpecialPage::getLocalNameFor() (deprecated in 1.18)
257 * SpecialPage::getRegularPages() (deprecated in 1.18)
258 * SpecialPage::getRestrictedPages() (deprecated in 1.18)
259 * SpecialPage::getTitleForAlias() (deprecated in 1.18)
260 * SpecialPage::getUsablePages() (deprecated in 1.18)
261 * SpecialPage::includable() (deprecated in 1.18)
262 * SpecialPage::init()
263 * SpecialPage::initAliasList() (deprecated in 1.18)
264 * SpecialPage::initList() (deprecated in 1.18)
265 * SpecialPage::name() (deprecated in 1.18)
266 * SpecialPage::removePage() (deprecated in 1.18)
267 * SpecialPage::resolveAlias() (deprecated in 1.18)
268 * SpecialPage::resolveAliasWithSubpage() (deprecated in 1.18)
269 * SpecialPage::restriction() (deprecated in 1.18)
270 * SpecialPage::setGroup() (deprecated in 1.18)
271 * SpecialRecentChanges::feedSetup()
272 * SpecialRevisionDelete::extractBitField() (deprecated in 1.22)
273 * User::getPageRenderingHash() (deprecated in 1.17)
274 * WebRequest::getFileSize() (deprecated in 1.17)
275 * WebRequest::isPathInfoBad() (deprecated in 1.17)
276 * WikiPage::quickEdit() (deprecated in 1.18)
277 * WikiPage::useParserCache() (deprecated in 1.18)
278 * WikiPage::viewUpdates() (deprecated in 1.18)
280 == Compatibility ==
282 MediaWiki 1.23 requires PHP 5.3.2 or later.
284 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
285 support for them is somewhat less mature. There is experimental support for
286 Oracle.
288 The supported versions are:
290 * MySQL 5.0.2 or later
291 * PostgreSQL 8.3 or later
292 * SQLite 3.3.7 or later
293 * Oracle 9.0.1 or later
295 == Upgrading ==
297 1.23 has several database changes since 1.22, and will not work without schema
298 updates. Note that due to changes to some very large tables like the revision
299 table, the schema update may take quite long (minutes on a medium sized site,
300 many hours on a large site).
302 If upgrading from before 1.11, and you are using a wiki as a commons
303 repository, make sure that it is updated as well. Otherwise, errors may arise
304 due to database schema changes.
306 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
307 new database fields are filled with data.
309 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
310 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
311 with MediaWiki 1.21.
313 Don't forget to always back up your database before upgrading!
315 See the file UPGRADE for more detailed upgrade instructions.
317 For notes on 1.21.x and older releases, see HISTORY.
319 == Online documentation ==
321 Documentation for both end-users and site administrators is available on
322 MediaWiki.org, and is covered under the GNU Free Documentation License (except
323 for pages that explicitly state that their contents are in the public domain):
325         https://www.mediawiki.org/wiki/Documentation
327 == Mailing list ==
329 A mailing list is available for MediaWiki user support and discussion:
331         https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
333 A low-traffic announcements-only list is also available:
335         https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
337 It's highly recommended that you sign up for one of these lists if you're
338 going to run a public MediaWiki, so you can be notified of security fixes.
340 == IRC help ==
342 There's usually someone online in #mediawiki on irc.freenode.net.