Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7433171
MarkpatrolledAction.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
5 KB
Referenced Files
None
Subscribers
None
MarkpatrolledAction.php
View Options
<?php
/**
* Copyright © 2011 Alexandre Emsenhuber
*
* @license GPL-2.0-or-later
* @file
* @ingroup Actions
*/
namespace
MediaWiki\Actions
;
use
MediaWiki\Context\IContextSource
;
use
MediaWiki\Exception\ErrorPageError
;
use
MediaWiki\Exception\PermissionsError
;
use
MediaWiki\HTMLForm\HTMLForm
;
use
MediaWiki\Linker\LinkRenderer
;
use
MediaWiki\Message\Message
;
use
MediaWiki\Page\Article
;
use
MediaWiki\RecentChanges\PatrolManager
;
use
MediaWiki\RecentChanges\RecentChange
;
use
MediaWiki\RecentChanges\RecentChangeLookup
;
use
MediaWiki\SpecialPage\SpecialPage
;
use
StatusValue
;
/**
* Mark a revision as patrolled on a page
*
* @ingroup Actions
*/
class
MarkpatrolledAction
extends
FormAction
{
private
LinkRenderer
$linkRenderer
;
private
PatrolManager
$patrolManager
;
private
RecentChangeLookup
$recentChangeLookup
;
/**
* @param Article $article
* @param IContextSource $context
* @param LinkRenderer $linkRenderer
* @param PatrolManager $patrolManager
* @param RecentChangeLookup $recentChangeLookup
*/
public
function
__construct
(
Article
$article
,
IContextSource
$context
,
LinkRenderer
$linkRenderer
,
PatrolManager
$patrolManager
,
RecentChangeLookup
$recentChangeLookup
)
{
parent
::
__construct
(
$article
,
$context
);
$this
->
linkRenderer
=
$linkRenderer
;
$this
->
patrolManager
=
$patrolManager
;
$this
->
recentChangeLookup
=
$recentChangeLookup
;
}
/** @inheritDoc */
public
function
getName
()
{
return
'markpatrolled'
;
}
/** @inheritDoc */
protected
function
getDescription
()
{
// Disable default header "subtitle"
return
''
;
}
/** @inheritDoc */
public
function
getRestriction
()
{
return
'patrol'
;
}
/** @inheritDoc */
protected
function
usesOOUI
()
{
return
true
;
}
/**
* @param array|null $data
* @return RecentChange
*/
protected
function
getRecentChange
(
$data
=
null
)
{
$rc
=
null
;
// Note: This works both on initial GET url and after submitting the form
$rcId
=
$data
?
intval
(
$data
[
'rcid'
]
)
:
$this
->
getRequest
()->
getInt
(
'rcid'
);
if
(
$rcId
)
{
$rc
=
$this
->
recentChangeLookup
->
getRecentChangeById
(
$rcId
);
}
if
(
!
$rc
)
{
throw
new
ErrorPageError
(
'markedaspatrollederror'
,
'markedaspatrollederrortext'
);
}
return
$rc
;
}
/** @inheritDoc */
protected
function
preText
()
{
$rc
=
$this
->
getRecentChange
();
$title
=
$rc
->
getTitle
();
// Based on logentry-patrol-patrol (see PatrolLogFormatter)
$revId
=
$rc
->
getAttribute
(
'rc_this_oldid'
);
$query
=
[
'curid'
=>
$rc
->
getAttribute
(
'rc_cur_id'
),
'diff'
=>
$revId
,
'oldid'
=>
$rc
->
getAttribute
(
'rc_last_oldid'
)
];
$revlink
=
$this
->
linkRenderer
->
makeLink
(
$title
,
$revId
,
[],
$query
);
$pagelink
=
$this
->
linkRenderer
->
makeLink
(
$title
,
$title
->
getPrefixedText
()
);
return
$this
->
msg
(
'confirm-markpatrolled-top'
)->
params
(
$title
->
getPrefixedText
(),
// Provide pre-rendered link as parser would render [[:$1]] as bold non-link
Message
::
rawParam
(
$pagelink
),
Message
::
rawParam
(
$revlink
)
)->
parse
();
}
protected
function
alterForm
(
HTMLForm
$form
)
{
$form
->
addHiddenField
(
'rcid'
,
$this
->
getRequest
()->
getInt
(
'rcid'
)
);
$form
->
setTokenSalt
(
'patrol'
);
$form
->
setSubmitTextMsg
(
'confirm-markpatrolled-button'
);
}
/**
* @param array $data
* @return bool|StatusValue True for success, false for didn't-try, StatusValue on failure
*/
public
function
onSubmit
(
$data
)
{
$rc
=
$this
->
getRecentChange
(
$data
);
$status
=
$this
->
patrolManager
->
markPatrolled
(
$rc
,
$this
->
getAuthority
()
);
if
(
$status
->
hasMessage
(
'rcpatroldisabled'
)
)
{
throw
new
ErrorPageError
(
'rcpatroldisabled'
,
'rcpatroldisabledtext'
);
}
// Guess where the user came from
// TODO: Would be nice to see where the user actually came from
if
(
$rc
->
getAttribute
(
'rc_source'
)
===
RecentChange
::
SRC_NEW
)
{
$returnTo
=
'Newpages'
;
}
elseif
(
$rc
->
getAttribute
(
'rc_log_type'
)
==
'upload'
)
{
$returnTo
=
'Newfiles'
;
}
else
{
$returnTo
=
'Recentchanges'
;
}
$return
=
SpecialPage
::
getTitleFor
(
$returnTo
);
if
(
$status
->
hasMessage
(
'markedaspatrollederror-noautopatrol'
)
)
{
$this
->
getOutput
()->
setPageTitleMsg
(
$this
->
msg
(
'markedaspatrollederror'
)
);
$this
->
getOutput
()->
addWikiMsg
(
'markedaspatrollederror-noautopatrol'
);
$this
->
getOutput
()->
returnToMain
(
null
,
$return
);
return
true
;
}
if
(
!
$status
->
isGood
()
)
{
if
(
!
$status
->
hasMessage
(
'hookaborted'
)
)
{
throw
new
PermissionsError
(
'patrol'
,
$status
);
}
// The MarkPatrolled hook itself has handled any output
return
$status
;
}
$this
->
getOutput
()->
setPageTitleMsg
(
$this
->
msg
(
'markedaspatrolled'
)
);
$this
->
getOutput
()->
addWikiMsg
(
'markedaspatrolledtext'
,
$rc
->
getTitle
()->
getPrefixedText
()
);
$this
->
getOutput
()->
returnToMain
(
null
,
$return
);
return
true
;
}
/** @inheritDoc */
public
function
onSuccess
()
{
// Required by parent class. Redundant as our onSubmit handles output already.
}
/** @inheritDoc */
public
function
doesWrites
()
{
return
true
;
}
}
/** @deprecated class alias since 1.44 */
class_alias
(
MarkpatrolledAction
::
class
,
'MarkpatrolledAction'
);
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sun, Nov 22, 11:46 (3 h, 19 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
16/c7/1b7cdaa278c516761ca6898e8158
Default Alt Text
MarkpatrolledAction.php (5 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment