Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7424685
AbuseFilterPermissionManager.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
6 KB
Referenced Files
None
Subscribers
None
AbuseFilterPermissionManager.php
View Options
<?php
namespace
MediaWiki\Extension\AbuseFilter
;
use
MediaWiki\Config\ServiceOptions
;
use
MediaWiki\Extension\AbuseFilter\Filter\AbstractFilter
;
use
MediaWiki\Extension\AbuseFilter\Filter\Flags
;
use
MediaWiki\Permissions\Authority
;
use
MediaWiki\User\Options\UserOptionsLookup
;
/**
* This class simplifies the interactions between the AbuseFilter code and Authority, knowing
* what rights are required to perform AF-related actions.
*/
class
AbuseFilterPermissionManager
{
public
const
SERVICE_NAME
=
'AbuseFilterPermissionManager'
;
public
const
CONSTRUCTOR_OPTIONS
=
[
'AbuseFilterProtectedVariables'
,
];
/**
* @var string[] Protected variables defined in config via AbuseFilterProtectedVariables
*/
private
$protectedVariables
;
private
UserOptionsLookup
$userOptionsLookup
;
/**
* @param ServiceOptions $options
* @param UserOptionsLookup $userOptionsLookup
*/
public
function
__construct
(
ServiceOptions
$options
,
UserOptionsLookup
$userOptionsLookup
)
{
$this
->
protectedVariables
=
$options
->
get
(
'AbuseFilterProtectedVariables'
);
$this
->
userOptionsLookup
=
$userOptionsLookup
;
}
/**
* @param Authority $performer
* @return bool
*/
public
function
canEdit
(
Authority
$performer
):
bool
{
$block
=
$performer
->
getBlock
();
return
(
!(
$block
&&
$block
->
isSitewide
()
)
&&
$performer
->
isAllowed
(
'abusefilter-modify'
)
);
}
/**
* @param Authority $performer
* @return bool
*/
public
function
canEditGlobal
(
Authority
$performer
):
bool
{
return
$performer
->
isAllowed
(
'abusefilter-modify-global'
);
}
/**
* Whether the user can edit the given filter.
*
* @param Authority $performer
* @param AbstractFilter $filter
* @return bool
*/
public
function
canEditFilter
(
Authority
$performer
,
AbstractFilter
$filter
):
bool
{
return
(
$this
->
canEdit
(
$performer
)
&&
!(
$filter
->
isGlobal
()
&&
!
$this
->
canEditGlobal
(
$performer
)
)
);
}
/**
* Whether the user can edit a filter with restricted actions enabled.
*
* @param Authority $performer
* @return bool
*/
public
function
canEditFilterWithRestrictedActions
(
Authority
$performer
):
bool
{
return
$performer
->
isAllowed
(
'abusefilter-modify-restricted'
);
}
/**
* @param Authority $performer
* @return bool
*/
public
function
canViewPrivateFilters
(
Authority
$performer
):
bool
{
$block
=
$performer
->
getBlock
();
return
(
!(
$block
&&
$block
->
isSitewide
()
)
&&
$performer
->
isAllowedAny
(
'abusefilter-modify'
,
'abusefilter-view-private'
)
);
}
/**
* @param Authority $performer
* @return bool
*/
public
function
canViewProtectedVariables
(
Authority
$performer
)
{
$block
=
$performer
->
getBlock
();
return
(
!(
$block
&&
$block
->
isSitewide
()
)
&&
$performer
->
isAllowed
(
'abusefilter-access-protected-vars'
)
);
}
/**
* @param Authority $performer
* @return bool
*/
public
function
canViewProtectedVariableValues
(
Authority
$performer
)
{
return
(
$this
->
canViewProtectedVariables
(
$performer
)
&&
$this
->
userOptionsLookup
->
getOption
(
$performer
->
getUser
(),
'abusefilter-protected-vars-view-agreement'
)
);
}
/**
* Return all used protected variables from an array of variables. Ignore user permissions.
*
* @param string[] $usedVariables
* @return string[]
*/
public
function
getUsedProtectedVariables
(
array
$usedVariables
):
array
{
return
array_intersect
(
$usedVariables
,
$this
->
protectedVariables
);
}
/**
* Check if the filter uses variables that the user is not allowed to use (i.e., variables that are protected, if
* the user can't view protected variables), and return them.
*
* @param Authority $performer
* @param string[] $usedVariables
* @return string[]
*/
public
function
getForbiddenVariables
(
Authority
$performer
,
array
$usedVariables
):
array
{
$usedProtectedVariables
=
array_intersect
(
$usedVariables
,
$this
->
protectedVariables
);
// All good if protected variables aren't used, or the user can view them.
if
(
count
(
$usedProtectedVariables
)
===
0
||
$this
->
canViewProtectedVariables
(
$performer
)
)
{
return
[];
}
return
$usedProtectedVariables
;
}
/**
* Return an array of protected variables (originally defined in configuration)
*
* @return string[]
*/
public
function
getProtectedVariables
()
{
return
$this
->
protectedVariables
;
}
/**
* @param Authority $performer
* @return bool
*/
public
function
canViewPrivateFiltersLogs
(
Authority
$performer
):
bool
{
return
$this
->
canViewPrivateFilters
(
$performer
)
||
$performer
->
isAllowed
(
'abusefilter-log-private'
);
}
/**
* @param Authority $performer
* @return bool
*/
public
function
canViewAbuseLog
(
Authority
$performer
):
bool
{
return
$performer
->
isAllowed
(
'abusefilter-log'
);
}
/**
* @param Authority $performer
* @return bool
*/
public
function
canHideAbuseLog
(
Authority
$performer
):
bool
{
return
$performer
->
isAllowed
(
'abusefilter-hide-log'
);
}
/**
* @param Authority $performer
* @return bool
*/
public
function
canRevertFilterActions
(
Authority
$performer
):
bool
{
return
$performer
->
isAllowed
(
'abusefilter-revert'
);
}
/**
* @param Authority $performer
* @param int $privacyLevel Bitmask of privacy flags
* @todo Take a Filter parameter
* @return bool
*/
public
function
canSeeLogDetailsForFilter
(
Authority
$performer
,
int
$privacyLevel
):
bool
{
if
(
!
$this
->
canSeeLogDetails
(
$performer
)
)
{
return
false
;
}
if
(
$privacyLevel
===
Flags
::
FILTER_PUBLIC
)
{
return
true
;
}
if
(
FilterUtils
::
isHidden
(
$privacyLevel
)
&&
!
$this
->
canViewPrivateFiltersLogs
(
$performer
)
)
{
return
false
;
}
if
(
FilterUtils
::
isProtected
(
$privacyLevel
)
&&
!
$this
->
canViewProtectedVariables
(
$performer
)
)
{
return
false
;
}
return
true
;
}
/**
* @param Authority $performer
* @return bool
*/
public
function
canSeeLogDetails
(
Authority
$performer
):
bool
{
return
$performer
->
isAllowed
(
'abusefilter-log-detail'
);
}
/**
* @param Authority $performer
* @return bool
*/
public
function
canSeePrivateDetails
(
Authority
$performer
):
bool
{
return
$performer
->
isAllowed
(
'abusefilter-privatedetails'
);
}
/**
* @param Authority $performer
* @return bool
*/
public
function
canSeeHiddenLogEntries
(
Authority
$performer
):
bool
{
return
$performer
->
isAllowed
(
'abusefilter-hidden-log'
);
}
/**
* @param Authority $performer
* @return bool
*/
public
function
canUseTestTools
(
Authority
$performer
):
bool
{
// TODO: make independent
return
$this
->
canViewPrivateFilters
(
$performer
);
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sun, Nov 22, 07:31 (21 h, 9 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
02/ed/f2ac19ba98dfa0e6b174da816e09
Default Alt Text
AbuseFilterPermissionManager.php (6 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment