Page MenuHomeWickedGov Phorge
Files F1431884

GlobalUserPageManager.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

GlobalUserPageManager.php
View Options

<?php
namespace MediaWiki\GlobalUserPage;
use MapCacheLRU;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\Linker\LinkTarget;
use MediaWiki\Title\TitleValue;
use MediaWiki\User\CentralId\CentralIdLookup;
use MediaWiki\User\UserFactory;
use MediaWiki\User\UserIdentity;
use MediaWiki\User\UserNameUtils;
use MediaWiki\WikiMap\WikiMap;
use Wikimedia\Rdbms\IConnectionProvider;
class GlobalUserPageManager {
public const CONSTRUCTOR_OPTIONS = [ 'GlobalUserPageDBname' ];
private MapCacheLRU $displayCache;
private MapCacheLRU $touchedCache;
public function __construct(
private readonly IConnectionProvider $connectionProvider,
private readonly UserFactory $userFactory,
private readonly UserNameUtils $userNameUtils,
private readonly CentralIdLookup $centralIdLookup,
private readonly ServiceOptions $options,
) {
$options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
// Do some instance caching since this can be
// called frequently due do the Linker hook
$this->displayCache = new MapCacheLRU( 100 );
$this->touchedCache = new MapCacheLRU( 100 );
}
/**
* Given a Title, assuming it doesn't exist, should
* we display a global user page on it
*
* @param LinkTarget $title
* @return bool
*/
public function shouldDisplayGlobalPage( LinkTarget $title ): bool {
if ( !$this->canBeGlobal( $title ) ) {
return false;
}
$cacheKey = "{$title->getNamespace()}:{$title->getDBkey()}";
if ( $this->displayCache->has( $cacheKey ) ) {
return $this->displayCache->get( $cacheKey );
}
// Normalize the username
$user = $this->userFactory->newFromName( $title->getText() );
if ( !$user ) {
$this->displayCache->set( $cacheKey, false );
return false;
}
// Make sure that the username represents the same
// user on both wikis.
if (
!$this->centralIdLookup->isAttached( $user ) ||
!$this->centralIdLookup->isAttached( $user, $this->options->get( 'GlobalUserPageDBname' ) )
) {
$this->displayCache->set( $cacheKey, false );
return false;
}
$touched = (bool)$this->getCentralTouched( $user );
$this->displayCache->set( $cacheKey, $touched );
return $touched;
}
/**
* Get the page_touched timestamp of the central user page.
*
* @param UserIdentity $user
* @return string|false MediaWiki timestamp, or `false` if the page does not exist or is excluded via
* the __NOGLOBAL__ magic word.
*/
public function getCentralTouched( UserIdentity $user ) {
if ( $this->touchedCache->has( $user->getName() ) ) {
return $this->touchedCache->get( $user->getName() );
}
$dbr = $this->connectionProvider->getReplicaDatabase( $this->options->get( 'GlobalUserPageDBname' ) );
$userPage = new TitleValue( NS_USER, $user->getName() );
$row = $dbr->newSelectQueryBuilder()
->select( [ 'page_touched', 'pp_propname' ] )
->from( 'page' )
->leftJoin( 'page_props', null, [ 'page_id=pp_page', 'pp_propname' => 'noglobal' ] )
->where( [
'page_namespace' => NS_USER,
'page_title' => $userPage->getDBkey(),
] )
->caller( __METHOD__ )
->fetchRow();
if ( $row ) {
if ( $row->pp_propname == 'noglobal' ) {
$touched = false;
} else {
$touched = $row->page_touched;
}
} else {
$touched = false;
}
$this->touchedCache->set( $user->getName(), $touched );
return $touched;
}
/**
* Checks whether the given page can be global
* doesn't check the actual database
* @param LinkTarget $title
* @return bool
*/
private function canBeGlobal( LinkTarget $title ): bool {
// Don't run this code for Hub.
if ( WikiMap::getCurrentWikiId() === $this->options->get( 'GlobalUserPageDBname' ) ) {
return false;
}
return (
// Must be a user page
$title->inNamespace( NS_USER ) &&
// Check valid username (also handles IP usernames and user subpages)
$this->userNameUtils->isValid( $title->getText() ) &&
// Temporary accounts cannot have global userpages (T326920).
!$this->userNameUtils->isTemp( $title->getText() )
);
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 21:10 (1 d, 13 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
a7/65/4696e91b9ca3ac42c311b99eaaa6
Default Alt Text
GlobalUserPageManager.php (3 KB)

Event Timeline