Commit graph

1212 commits

Author SHA1 Message Date
jenkins-bot
e2d7f9b490 Merge "Hard deprecate $wgParser" 2020-05-01 21:31:26 +00:00
Timo Tijhof
2f35c3ae67 HtmlCacheUpdater: Add getUrls() method and support selective purging
* Move the Title::getCdnUrls() logic to the new HtmlCacheUpdater service.

* Introduce a runtime option to decide whether this is for a direct
  revision or a cascading LinksUpdate.

Bug: T250261
Change-Id: I514b9052761e0d949234996e97fdef255582df86
2020-04-30 18:16:07 +00:00
TheSandDoctor
705e7e7c21 Hard deprecate $wgParser
$wgParser, originally soft deprecated in 1.32, has been hard deprecated.

Code search in WMF deployed code:
https://codesearch.wmflabs.org/deployed/?q=%5B%24%5DwgParser%5B%5EA-Z%5D&i=nope&files=&repos=

Everything search:
https://codesearch.wmflabs.org/search/?q=%5B%24%5DwgParser%5B%5EA-Z%5D&i=nope&files=&repos=

Bug: T160811
Change-Id: I6830126d4dedab25b6ae6a2fcbfacdf429f71021
2020-04-30 03:41:04 -04:00
Tim Starling
df65f09669 Revert "Correct capitalization of BeforeParserFetchTemplateAndTitle hook"
In the new hook system, it is invalid to have two hooks that differ only
in case.

This reverts commit afb5b38e15.

Change-Id: I160ece0a7bc68c748037b383137364b787be86a0
2020-04-30 07:50:24 +10:00
jenkins-bot
4ca946e155 Merge "Replace ArticleRollbackComplete hook with RollbackComplete" 2020-04-20 22:58:57 +00:00
DannyS712
1519cefbc4 Replace ArticleRollbackComplete hook with RollbackComplete
Bug: T250543
Change-Id: I5fcb4b2adad8f16811bf9c76b95378f0f0f1e6a6
2020-04-18 04:54:48 +00:00
C. Scott Ananian
b328aa3311 Add ParserBeforePreprocess hook
This will allow us to deprecate the ParserBeforeStrip and ParserAfterStrip
hooks by covering the one case where ParserBeforeStrip is called but
ParserBeforeInternalParse is not.

Bug: T250450
Change-Id: Ia298fecba77e97fc30dc30a09ac69a4239767d8c
2020-04-17 17:20:22 -04:00
C. Scott Ananian
95350d3dcf Deprecate ParserBeforeTidy hook
Untidy parser output should not be exposed outside mediawiki core.
Callers should use ParserAfterTidy instead.

Code search:
https://codesearch.wmflabs.org/deployed/?q=ParserBeforeTidy&i=nope&files=&repos=
https://codesearch.wmflabs.org/search/?q=ParserBeforeTidy&i=nope&files=&repos=

Depends-On: Ia6bd94fc937a9bff77843e6734e88ba8991d04ec
Change-Id: I4a0aae7b17fb522a5e4f90edad3a0b7137b270a6
2020-04-17 17:20:20 -04:00
C. Scott Ananian
afb5b38e15 Correct capitalization of BeforeParserFetchTemplateAndTitle hook
We deprecate the incorrect capitalization and add a new hook with the
correct capitalization.  There are very few users of this hook, and none
in WMF-deployed code.

WMF-deployed code search:
https://codesearch.wmflabs.org/deployed/?q=BeforeParserFetchTemplateAndtitle&i=nope&files=&repos=

Everything code search:
https://codesearch.wmflabs.org/search/?q=BeforeParserFetchTemplateAndtitle&i=nope&files=&repos=

It would be tempting to remove this hook entirely, but it seems to
serve a valuable purpose in allowing page and template fetches at a
specific "old" timestamp.  (Extension:Memento and Extension:TimeTravel
don't seem to have implemented this feature, however.)

Change-Id: I501b0ee35b81fee424d45084088a6ed63c3dfd54
2020-04-17 17:19:44 -04:00
C. Scott Ananian
d8bb54a965 Deprecate infrequently-used parser-related hooks
The following parser-related hooks have no users in deployed code:
- InternalParseBeforeSanitize
- ParserFetchTemplate
- ParserSectionCreate
- ParserPreSaveTransformComplete
- BeforeParserrenderImageGallery

Code search in WMF-deployed code:
https://codesearch.wmflabs.org/deployed/?q=%5Cb%28InternalParseBeforeSanitize%7CParserFetchTemplate%7CParserSectionCreate%7CParserPreSaveTransformComplete%7CBeforeParserrenderImageGallery%29%5Cb&i=nope&files=&repos=

Code search in all code:
https://codesearch.wmflabs.org/search/?q=%5Cb%28InternalParseBeforeSanitize%7CParserFetchTemplate%7CParserSectionCreate%7CParserPreSaveTransformComplete%7CBeforeParserrenderImageGallery%29%5Cb&i=nope&files=&repos=

Removing as many infrequently-used hooks as possible will aid our
transition from the legacy parser to alternative parsers.

Bug: T236809
Change-Id: I3a09fbe6436232ae0b417ad61b19f8df6d0485e0
2020-04-17 17:18:01 -04:00
DannyS712
5127acb8ec RevisionUndeleted hook: Add $oldPageId
Not always the same as the restored revision's pageId

Bug: T248727
Change-Id: I4e3ea4519d34de7c67ad8999575affe77d756f08
2020-04-14 23:08:54 +00:00
C. Scott Ananian
83a22b7fcd Remove codepaths which ran parser in 'untidy' mode
Disabling tidy has been deprecated since 1.33.  This cleans up the code
paths which still used untidy output.

Bug: T198214
Change-Id: I821ef3b8f59b272d983583d407b2f0794fe1e791
2020-04-13 21:34:04 +00:00
DannyS712
d4c08de41b Deprecate the UndeleteShowRevision hook
No known uses; if needed, can be reintroduced with RevisionRecord

Bug: T249434
Change-Id: I5c50a13c98145f3cddde2e817ac29ebb27c9cc73
2020-04-13 04:43:55 +00:00
DannyS712
c2ff5c0355 Add RevisionUndeleted hook to replace ArticleRevisionUndeleted
Bug: T248727
Change-Id: Ic4f771fcb3f1468a78b7eef3ff11686083144154
2020-04-08 12:26:36 +00:00
jenkins-bot
65906da2c2 Merge "MCR: provide MultiContentSave hook to replace PageContentSave" 2020-03-30 17:09:45 +00:00
Edward Chernenko
9cf8427865 MCR: provide MultiContentSave hook to replace PageContentSave
Old hook PageContentSave only received the main slot of the article.
In order for extensions to intercept changes in all slots, they should
receive a RevisionSlots object with new content.

PageContentSave hook is still preserved for backward compatibility.

Note: parameters $iswatch and $section (from PageContentSave) are
not added into the new hook, because they are obsolete in the old hook.

Note: new hook also doesn't unnecessarily pass-by-reference (T193950),
which was an issue with the old hook.

Bug: T205982
Change-Id: I55455639c5ff6ccbf3917d85c1ab0dac847ec853
2020-03-27 23:06:33 +03:00
C. Scott Ananian
a3c9621ad0 Deprecate unusual uses of the ParserGetVariableValueSwitch hook
Ensure that the value returned is always also added to the cache, since
we (eventually) want to remove the hook's access to
$parser->mVarCache.  Also don't allow monkeying with the value passed
as $magicWordId, even though it's a reference.

Code search:
https://codesearch.wmflabs.org/deployed/?q=ParserGetVariableValueSwitch&i=nope&files=&repos=

Bug: T236813
Depends-On: Ia12faefada7e4cf04f1a6b12b3ed1703bf28e437
Depends-On: Ia9e2e00c6b7d0e62cbe80c3b124165b691b1ff3d
Depends-On: I1e48fa47b8723958d543a69aaf9b62b872200dc5
Depends-On: If9a0885a8664c22473ade712364c2dd0a5c04e0b
Change-Id: I3d6b281f8e4e0bf68eefbf9767047527b4573b79
2020-03-27 08:59:21 -04:00
C. Scott Ananian
99f6b82995 Deprecate the ParserGetVariableValueVarCache hook
We don't want to expose the internal caching mechanism of the parser.
There are no uses in deployed WMF code:

https://codesearch.wmflabs.org/deployed/?q=ParserGetVariableValueVarCache&i=nope&files=&repos=

Bug: T236813
Change-Id: I1b0a5cf7d32be86a45d7231940360e2bfce7275f
2020-03-26 18:47:30 -04:00
Daimona Eaytoy
c1d6e8b0b9 page: Remove the ArticleAfterFetchContentObject hook
Deprecated since 1.32, and no longer used anywhere.
It is referenced in ApprovedRevs, but conditional on a MW < 1.35
context only.


Change-Id: I415927f198473ae3e795fac8c4811690424f167a
2020-03-20 01:40:01 +00:00
jenkins-bot
7c0c182b5b Merge "Reconcile differences between arguments in hooks.txt and at the call site" 2020-03-09 15:35:08 +00:00
Tim Starling
eb6c5f70d9 Add ParserPreSaveTransformComplete hook
This is needed to migrate an extension (AutoWIGO2) that uses ArticleSave
to a version of MW after that hook was removed. The extension was using
ArticleSave to do its own PST processing, which probably doesn't work
with PageContentSave, and wasn't really the right way to do it in the
first place. Surprisingly, there were no useful hooks in PST or its
callers.

Change-Id: If1b3d7ea130a2b77609afe206eedc8445e1ab9f9
2020-03-08 09:52:09 +11:00
Tim Starling
30d5810572 Reconcile differences between arguments in hooks.txt and at the call site
The interface generator script now flags any differences between the
argument list at the call site and the documented arguments. Resolve all
such differences.

* In AlternateEditPreview, $parserOutput is a reference, and a
  WMF-deployed extension replaces it.
* In DeleteUnknownPreferences, fix missing "$" in &$where
* In LocalisationCacheRecache, document the unused parameter, as is the
  convention elsewhere in the file.
* In NewRevisionFromEditComplete, make all callers pass a $tags
  variable, and document the fact that there are multiple callers.
* In PageContentInsertComplete, document legacy references
* In PageContentSave, document the fact that $flags and $status are
  references. I made them legacy references, since although replacement
  will have an effect, no extension relies on this and it is not
  documented on the Manual:Hooks page.
* In PageContentSaveComplete, document $wikiPage, $user, $flags and
  $status as legacy references. Replacement of $status was broken
  by If610c68f4912e89 (MW 1.32), but I confirmed that no extensions
  in CodeSearch are currently affected.
* In ParserGetVariableValueSwitch, document $frame as a legacy reference
* In WatchArticleComplete and UnwatchArticleComplete, SpecialEditWatchlist
  was passing $user by value where as the other callers were passing it
  by reference. Passed by reference. It was already marked legacy.

Bug: T240307

Change-Id: I33f69ebdb5242982fd7986d9877959d2d33149b9
2020-03-06 15:49:15 +11:00
DannyS712
2962e56f01 Remove UserIsHidden hook, deprecated and unused
Bug: T247019
Change-Id: Icb2703d20aed1d684cd897537cba71d5e1633541
2020-03-05 19:31:46 +00:00
jenkins-bot
6512ef160c Merge "Introduce an expiry to WatchedItem" 2020-03-04 18:33:07 +00:00
MusikAnimal
bb56abfba0 Introduce an expiry to WatchedItem
Includes the new $wgWatchlistExpiry feature flag.

Consumers of WatchedItem and WatchedItemStore have not been changed to
make use of expiries, this along with associated UI changes will be done
in a separate patch.

Bug: T245213
Change-Id: Ifff5e56e0222bb325cf796e0aa3d88825820d1fd
2020-03-04 11:32:19 -05:00
Tim Starling
a37adeff89 Annotate hook parameters that are references for legacy reasons.
In hooks.txt, annotate all parameters that are references for legacy
reasons with [&] instead of &.

This will be the canonical source of this information. After T240307
is complete, assignment through the reference (replacement) will have no
effect. So if any parameters are incorrectly annotated with [&],
extensions will break.

These changes are final, since T240307 will make it impossible to change
the reference type of an existing hook. The only recourse will be add a
new hook without the reference.

Full review notes:
* FileDeleteComplete: A case of inappropriate non-object references
  introduced by analogy: the local variables are not consulted after the
  hook is called. CodeSearch reveals that handlers already use non-ref
  params, presumably due to T193950
* BeforeInitialize: Replacing the title here would have some effect, but
  it is fetched from the context and not written back, so the result would
  be inconsistent. Inadvisable.
* InitializeArticleMaybeRedirect: $target and $article are certainly
  replaceable, but not the request-sourced variables $title and $request.
  The correct way to redirect is to use $target.
* IsTrustedProxy: $ip inappropriate scalar reference
* ResourceLoaderRegisterModules: The contract is pretty clear here,
  replacement would be difficult
* ActionBeforeFormDisplay: replacement seems inadvisable; no handlers in
  codesearch
* PageHistoryBeforeList: inadvisable, no callers replace
* UnwatchArticleComplete: $user was called with & but undocumented
* APIAfterExecute: seems safe from codesearch
* APIQueryGeneratorAfterExecute: no handlers
* User::mailPasswordInternal: handlers do not use ref params
* FetchChangesList: replacement would have no effect
* ParserFirstCallInit, ParserClearState, ParserBeforeStrip,
  ParserAfterStrip, ParserAfterParse, ParserBeforeInternalParse,
  InternalParseBeforeSanitize, InternalParseBeforeLinks, ParserBeforeTidy,
  ParserAfterTidy, ParserGetVariableValueVarCache,
  ParserGetVariableValueTs, ParserGetVariableValueSwitch,
  BeforeParserrenderImageGallery: undocumented reference
* BeforeParserrenderImageGallery: replacement seems inadvisable after
  mutation. No handlers.
* RevisionInsertComplete: undocumented reference
* SkinTemplateOutputPageBeforeExec: $tpl replacement would be
  inadvisable after mutation. CodeSearch shows many callers, I haven't
  reviewed them all, but a sampling shows $tpl->set() being the usual
  pattern
* SpecialPageBeforeFormDisplay: CodeSearch confirms this is harmless
* BlockIp: did CodeSearch to confirm that neither variable is replaced
* SpecialMovepageAfterMove: did CodeSearch
* UnblockUser: no handlers
* UndeleteForm::showRevision: extensions/Video actually tries to replace
  it, but forgot to declare the parameter as a reference. Filed T246408.
* ArticleEditUpdates: $editInfo is unused after the hook call
* PageContentSave: undocumented ref params. $mainContent is unused after
  hook call.
* ImageBeforeProduceHTML: $dummy is unused after hook execution. The rest
  could be altered

Bug: T193950
Change-Id: I6ddf54cb6812d2e292eca6d8e588364498c2fe73
2020-02-28 17:23:23 +11:00
DannyS712
28671f69b4 OutputPageBeforeHTML: Fix class of first parameter in docs
Its an OutputPage, not a ParserOutput

Change-Id: Icfff5e9f8f2254eec00368ec63b24a16e4746aed
2020-02-27 05:01:35 +00:00
Tim Starling
ff4606fd7c docs: Add missing BeforeResetNotificationTimestamp hook and MediaWikiPHPUnitTest::*
Change-Id: I1dd9cb61e7732a56fcb1fc94a347311d5572b761
2020-02-25 18:25:02 -08:00
Tim Starling
53247b5c5b Add missing colons to parameter declarations
There's no other way to detect parameters, since variable names are
often mentioned in the description prose, even at the start of a line.

Change-Id: Ie375ecffaae4efa268c5305ea9b1cc55a91cd813
2020-02-26 13:05:04 +11:00
Timo Tijhof
f575721a06 Update all use of $wgVersion to MW_VERSION
Follows-up I04628de4152dd5.

Bug: T212738
Change-Id: I718474ec0d9fd29ac2c05477f0f2493615d8aff5
2020-02-25 02:16:12 +00:00
DannyS712
b640be36b1 Docs: Remove reference to UploadVerification hook, removed in 1.34
Was deprecated in 1.28 and removed, so it need not be mentioned as
an alternative to `UploadVerifyFile`

Bug: T220656
Change-Id: Ic1c78a0216ca6f03099c1e8433297418f3d50172
2020-02-23 01:48:56 +00:00
DannyS712
0c303967b1 Remove double newline in hooks.txt
Change-Id: Ib2bb7ead4e4f514c9561ca050014a4582eb34d11
2020-02-13 07:54:58 +00:00
jenkins-bot
4dbc276487 Merge "Remove ArticleContentViewCustom hook, deprecated and unused" 2020-02-13 05:13:11 +00:00
James D. Forrester
cafe286e2b Deprecate the ArticleEditUpdates hook
Change-Id: Ie85a46846315999ebaab1e1b38265937f4b2c79e
2020-02-08 20:29:35 +00:00
James D. Forrester
6a7ab1ed04 Deprecate the ArticleEditUpdatesDeleteFromRecentchanges hook
Bug: T244613
Change-Id: I2bb1645a8b5d99a5a3c4425f2bc0e8c3f524d4e8
2020-02-07 15:35:08 -08:00
DannyS712
f14fad3538 Remove ArticleContentViewCustom hook, deprecated and unused
Bug: T241351
Change-Id: Ie37ed9265511e3051ea60c6898febb567d5283df
2020-02-06 19:55:16 +00:00
Thiemo Kreuz
ea01e7cfbb parser: Remove unused ParserAfterUnstrip hook
Introduced in 2015 via If83b062. Unfortunately the patch fails to mention
why the hook was introduced. A review comment asking for the missing
information was ignored.

The hook was introduced exclusively for the Cite extension, see I0e136f9.
The Cite change got reverted a few days later via I1a71854. As far as I
can tell the hook (oddly specific and underspecified anyway) was never
used again, neither for Cite nor for anything else.

Now unused: https://codesearch.wmflabs.org/search/?q=ParserAfterUnstrip

I suggest to just remove it with no deprecation phase.

My team is currently working on Cite, essentially turning it upside down.
I'm not aware of a need for this hook.

Change-Id: If68a88d7afff60385ff1e33fd13716b20d01a313
2020-01-25 09:20:52 +01:00
DannyS712
0bbe0b8fe6 Docs: Update hooks.txt to remove usage of global $wgUser
Also remove 2 refernces to $wgOut and $wgRequest

Bug: T159299
Bug: T160810
Bug: T160812
Change-Id: I267dece08d6a2224091cbcb5d29e29bd9e9d3f07
2020-01-07 19:06:04 +00:00
jdlrobson
5b044bb928 resourceloader: Introduce hooks in ResourceLoaderSiteModule
This will allow extensions/skins to alter the wiki pages that editors
can use to control styles

Bug: T237050
Change-Id: I329415b787136fcf9422a9deebfcd34f83b40f12
2020-01-06 22:52:27 +00:00
Kunal Mehta
99007e96c7 Use namespaced IPUtils class
Change-Id: I047e099a93203a59093946d336a143d899d0271f
2020-01-01 02:36:49 -08:00
jenkins-bot
2ea3adebc2 Merge "skins: Remove deprecated SkinCopyrightFooter $forContent param" 2019-11-19 21:17:56 +00:00
jenkins-bot
8d240f87a9 Merge "docs: Update hook documentation for PageContentSaveComplete" 2019-11-19 01:45:24 +00:00
jenkins-bot
cad9111aec Merge "hooks: Do not document the Parser object to be passed by ref" 2019-11-18 22:04:41 +00:00
Piotr Miazga
076993c938 skins: Remove deprecated SkinCopyrightFooter $forContent param
The $forContent parameter was deprecated six years ago and looks
like nothing else is using it (verified via codeseach.wmflabs.org)

Change-Id: I7c6093a083845a40b82e39c91006a5a0b223eab6
2019-11-18 16:16:27 -05:00
Thiemo Kreuz
17363ad381 hooks: Do not document the Parser object to be passed by ref
It does not make sense for hook handler functions to *expect* the
Parser to be passed by reference. Hook handlers not only can't do
anything with it being a reference, they should *not* use it to
replace the Parser with another one.

This is an obsolete relict from PHP 3 (?), where objects got passed as a
cloned copy, which was very expensive.

Note we can not update the Hooks::run() calls as long as a single
hook handler still *expects* a reference.

Bug: T193950
Change-Id: I5f9a3f56faec0e90a2839c064844928c3b5c9751
2019-11-18 16:47:08 +00:00
Thiemo Kreuz
210483fc16 hooks: Stop suggesting to pass objects by reference
It looks like the examples section on top of the hooks.txt file still
suggests to pass objects by reference. This is an obsolete relict from
PHP 4 and not needed any more.

Bug: T193950
Change-Id: I61bdc4a313401955943903918ff8167c2bea5aac
2019-11-18 16:45:28 +00:00
jenkins-bot
8aafbfc02f Merge "docs: Update ParserGetVariableValueSwitch documentation" 2019-11-15 04:29:59 +00:00
Umherirrender
1feb04b741 docs: Update hook documentation for PageContentSaveComplete
The hook no longer takes null, as of 4860e1d5ac (I492514413ec9c37c2f9343bb207798fc8e24a5a9).

Change-Id: I31b7768ae5bd2389b59f2aca1c55ca962a75b509
2019-11-12 18:45:21 +00:00
Thiemo Kreuz
abf62c6c78 Fix ApiQuerySiteinfo class name capitalization
Change-Id: I7e522fb34119b62c4fb59590f7ee8a45f5a4954d
2019-11-08 16:58:11 +01:00
jenkins-bot
baf3d4b803 Merge "Remove the deprecated GetBlockedStatus hook" 2019-10-21 17:11:27 +00:00