Page MenuHomeWickedGov Phorge
Files F4105525

ToolLinksHandler.php
No OneTemporary
Actions

Size
8 KB
Referenced Files
None
Subscribers
None

ToolLinksHandler.php
View Options

<?php
namespace MediaWiki\CheckUser\HookHandler;
use MediaWiki\Context\RequestContext;
use MediaWiki\Hook\ContributionsToolLinksHook;
use MediaWiki\Hook\SpecialContributionsBeforeMainOutputHook;
use MediaWiki\Hook\UserToolLinksEditHook;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\MediaWikiServices;
use MediaWiki\Permissions\PermissionManager;
use MediaWiki\Registration\ExtensionRegistry;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\SpecialPage\SpecialPageFactory;
use MediaWiki\Title\Title;
use MediaWiki\User\Options\UserOptionsLookup;
use MediaWiki\User\TempUser\TempUserConfig;
use MediaWiki\User\UserIdentity;
use MediaWiki\User\UserIdentityLookup;
use MediaWiki\User\UserIdentityUtils;
use MobileContext;
use OOUI\ButtonGroupWidget;
use OOUI\ButtonWidget;
use Wikimedia\IPUtils;
class ToolLinksHandler implements
SpecialContributionsBeforeMainOutputHook,
ContributionsToolLinksHook,
UserToolLinksEditHook
{
private PermissionManager $permissionManager;
private SpecialPageFactory $specialPageFactory;
private LinkRenderer $linkRenderer;
private UserIdentityLookup $userIdentityLookup;
private UserIdentityUtils $userIdentityUtils;
private UserOptionsLookup $userOptionsLookup;
private TempUserConfig $tempUserConfig;
/**
* @param PermissionManager $permissionManager
* @param SpecialPageFactory $specialPageFactory
* @param LinkRenderer $linkRenderer
* @param UserIdentityLookup $userIdentityLookup
* @param UserIdentityUtils $userIdentityUtils
* @param UserOptionsLookup $userOptionsLookup
* @param TempUserConfig $tempUserConfig
*/
public function __construct(
PermissionManager $permissionManager,
SpecialPageFactory $specialPageFactory,
LinkRenderer $linkRenderer,
UserIdentityLookup $userIdentityLookup,
UserIdentityUtils $userIdentityUtils,
UserOptionsLookup $userOptionsLookup,
TempUserConfig $tempUserConfig
) {
$this->permissionManager = $permissionManager;
$this->specialPageFactory = $specialPageFactory;
$this->linkRenderer = $linkRenderer;
$this->userIdentityLookup = $userIdentityLookup;
$this->userIdentityUtils = $userIdentityUtils;
$this->userOptionsLookup = $userOptionsLookup;
$this->tempUserConfig = $tempUserConfig;
}
/**
* Determine whether a user is able to reveal IP, based on their rights
* and preferences.
*
* @param UserIdentity $user
* @return bool
*/
private function userCanRevealIP( UserIdentity $user ) {
return $this->permissionManager->userHasRight(
$user,
'checkuser-temporary-account-no-preference'
) ||
(
$this->permissionManager->userHasRight(
$user,
'checkuser-temporary-account'
) &&
$this->userOptionsLookup->getOption(
$user,
'checkuser-temporary-account-enable'
)
);
}
/**
* @return bool Whether the user is in mobile view. This will always be false if MobileFrontend is not loaded.
*/
private function isMobile(): bool {
$isMobile = false;
if ( ExtensionRegistry::getInstance()->isLoaded( 'MobileFrontend' ) ) {
/** @var MobileContext $mobFrontContext */
$mobFrontContext = MediaWikiServices::getInstance()->getService( 'MobileFrontend.Context' );
$isMobile = $mobFrontContext->shouldDisplayMobileView();
}
return $isMobile;
}
/**
* Determine whether a user is able to see archived contributions.
*
* @param UserIdentity $user
* @return bool
*/
private function userCanSeeDeleted( UserIdentity $user ) {
return $this->permissionManager->userHasRight( $user, 'deletedhistory' );
}
/** @inheritDoc */
public function onSpecialContributionsBeforeMainOutput( $id, $user, $sp ) {
if ( !in_array( $sp->getName(), [ 'Contributions', 'IPContributions', 'DeletedContributions' ] ) ) {
return;
}
if (
!$this->tempUserConfig->isKnown() ||
!IPUtils::isIPAddress( $user->getName() ) ||
!$this->userCanRevealIP( $sp->getUser() )
) {
return;
}
$isArchive = $sp->getRequest()->getBool( 'isArchive' ) ||
$sp->getName() === 'DeletedContributions';
if ( $isArchive && !$this->userCanSeeDeleted( $sp->getUser() ) ) {
return;
}
// Pages showing archived contributions should link to each other.
$ipContributionsUrl = SpecialPage::getTitleFor(
'IPContributions',
$user->getName()
)->getLinkURL(
[ 'isArchive' => $isArchive ]
);
$contributionsUrl = SpecialPage::getTitleFor(
$isArchive ? 'DeletedContributions' : 'Contributions',
$user->getName()
)->getLinkURL();
// Generate the button text for the IPContributions link. If the user should be in mobile mode (as
// defined by MobileFrontend), then append '-mobile' to the message key to get a shortened version.
$ipContributionsButtonMessageKey = 'checkuser-ip-contributions-special-ip-contributions-button';
if ( $this->isMobile() ) {
$ipContributionsButtonMessageKey .= '-mobile';
}
$buttons = new ButtonGroupWidget( [
'items' => [
new ButtonWidget( [
'label' => $sp->msg( $ipContributionsButtonMessageKey )->text(),
'href' => $ipContributionsUrl,
'active' => $sp->getName() === 'IPContributions',
] ),
new ButtonWidget( [
'label' => $sp->msg( 'checkuser-ip-contributions-special-contributions-button' )->text(),
'href' => $contributionsUrl,
'active' => in_array( $sp->getName(), [ 'Contributions', 'DeletedContributions' ] ),
] )
],
] );
$sp->getOutput()->addSubtitle( $buttons );
}
/**
* Add a link to Special:CheckUser and Special:CheckUserLog
* on Special:Contributions/<username> for
* privileged users.
*
* @param int $id User ID
* @param Title $nt User page title
* @param string[] &$links Tool links
* @param SpecialPage $sp Special page
*/
public function onContributionsToolLinks(
$id, Title $nt, array &$links, SpecialPage $sp
) {
$user = $sp->getUser();
$linkRenderer = $sp->getLinkRenderer();
if ( $sp->getName() === 'IPContributions' && $this->userCanRevealIP( $user ) ) {
if ( $sp->getRequest()->getBool( 'isArchive' ) ) {
// Use the same key to ensure the link is added in the same position
$links['deletedcontribs'] = $linkRenderer->makeKnownLink(
SpecialPage::getTitleFor( 'IPContributions', $nt->getText() ),
$sp->msg( 'checkuser-ip-contributions-contributions-link' )->text(),
[ 'class' => 'mw-contributions-link-check-user-ip-contributions' ],
);
} elseif ( $this->userCanSeeDeleted( $user ) ) {
$links['deletedcontribs'] = $linkRenderer->makeKnownLink(
SpecialPage::getTitleFor( 'IPContributions', $nt->getText() ),
$sp->msg( 'checkuser-ip-contributions-deleted-contributions-link' )->text(),
[ 'class' => 'mw-contributions-link-check-user-ip-contributions' ],
[ 'isArchive' => true ]
);
}
}
if ( $this->permissionManager->userHasRight( $user, 'checkuser' ) ) {
$links['checkuser'] = $linkRenderer->makeKnownLink(
SpecialPage::getTitleFor( 'CheckUser' ),
$sp->msg( 'checkuser-contribs' )->text(),
[ 'class' => 'mw-contributions-link-check-user' ],
[ 'user' => $nt->getText() ]
);
}
if ( $this->permissionManager->userHasRight( $user, 'checkuser-log' ) ) {
$links['checkuser-log'] = $linkRenderer->makeKnownLink(
SpecialPage::getTitleFor( 'CheckUserLog' ),
$sp->msg( 'checkuser-contribs-log' )->text(),
[ 'class' => 'mw-contributions-link-check-user-log' ],
[ 'cuSearch' => $nt->getText() ]
);
$userIdentity = $this->userIdentityLookup->getUserIdentityByUserId( $id );
if ( $id && $userIdentity && $this->userIdentityUtils->isNamed( $userIdentity ) ) {
$links['checkuser-log-initiator'] = $linkRenderer->makeKnownLink(
SpecialPage::getTitleFor( 'CheckUserLog' ),
$sp->msg( 'checkuser-contribs-log-initiator' )->text(),
[ 'class' => 'mw-contributions-link-check-user-initiator' ],
[ 'cuInitiator' => $nt->getText() ]
);
}
}
}
/** @inheritDoc */
public function onUserToolLinksEdit( $userId, $userText, &$items ) {
$requestTitle = RequestContext::getMain()->getTitle();
if (
$requestTitle !== null &&
$requestTitle->isSpecialPage()
) {
$specialPageName = $this->specialPageFactory->resolveAlias( $requestTitle->getText() )[0];
if ( $specialPageName === 'CheckUserLog' ) {
$items[] = $this->linkRenderer->makeLink(
SpecialPage::getTitleFor( 'CheckUserLog', $userText ),
wfMessage( 'checkuser-log-checks-on' )->text()
);
} elseif ( $specialPageName === 'CheckUser' ) {
$items[] = $this->linkRenderer->makeLink(
SpecialPage::getTitleFor( 'CheckUser', $userText ),
wfMessage( 'checkuser-toollink-check' )->text(),
[],
[ 'reason' => RequestContext::getMain()->getRequest()->getVal( 'reason', '' ) ]
);
}
}
}
}

File Metadata

Mime Type
text/x-php
Expires
Tue, Aug 18, 19:02 (2 w, 6 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
31/cf/46e1fba3dc3f69787b962228e1c5
Default Alt Text
ToolLinksHandler.php (8 KB)

Event Timeline