MediaWiki  1.31.0
ActiveUsersPager.php
Go to the documentation of this file.
1 <?php
30 
34  protected $opts;
35 
39  protected $groups;
40 
45 
51  parent::__construct( $context );
52 
53  $this->RCMaxAge = $this->getConfig()->get( 'ActiveUserDays' );
54  $this->requestedUser = '';
55 
56  $un = $opts->getValue( 'username' );
57  if ( $un != '' ) {
59  if ( !is_null( $username ) ) {
60  $this->requestedUser = $username->getText();
61  }
62  }
63 
64  $this->groups = $opts->getValue( 'groups' );
65  $this->excludegroups = $opts->getValue( 'excludegroups' );
66  // Backwards-compatibility with old URLs
67  if ( $opts->getValue( 'hidebots' ) ) {
68  $this->excludegroups[] = 'bot';
69  }
70  if ( $opts->getValue( 'hidesysops' ) ) {
71  $this->excludegroups[] = 'sysop';
72  }
73  }
74 
75  function getIndexField() {
76  return 'qcc_title';
77  }
78 
79  function getQueryInfo() {
80  $dbr = $this->getDatabase();
81 
82  $rcQuery = ActorMigration::newMigration()->getJoin( 'rc_user' );
83 
84  $activeUserSeconds = $this->getConfig()->get( 'ActiveUserDays' ) * 86400;
85  $timestamp = $dbr->timestamp( wfTimestamp( TS_UNIX ) - $activeUserSeconds );
86  $tables = [ 'querycachetwo', 'user', 'recentchanges' ] + $rcQuery['tables'];
87  $jconds = $rcQuery['joins'];
88  $conds = [
89  'qcc_type' => 'activeusers',
90  'qcc_namespace' => NS_USER,
91  'user_name = qcc_title',
92  $rcQuery['fields']['rc_user_text'] . ' = qcc_title',
93  'rc_type != ' . $dbr->addQuotes( RC_EXTERNAL ), // Don't count wikidata.
94  'rc_type != ' . $dbr->addQuotes( RC_CATEGORIZE ), // Don't count categorization changes.
95  'rc_log_type IS NULL OR rc_log_type != ' . $dbr->addQuotes( 'newusers' ),
96  'rc_timestamp >= ' . $dbr->addQuotes( $timestamp ),
97  ];
98  if ( $this->requestedUser != '' ) {
99  $conds[] = 'qcc_title >= ' . $dbr->addQuotes( $this->requestedUser );
100  }
101  if ( $this->groups !== [] ) {
102  $tables[] = 'user_groups';
103  $conds[] = 'ug_user = user_id';
104  $conds['ug_group'] = $this->groups;
105  $conds[] = 'ug_expiry IS NULL OR ug_expiry >= ' . $dbr->addQuotes( $dbr->timestamp() );
106  }
107  if ( $this->excludegroups !== [] ) {
108  foreach ( $this->excludegroups as $group ) {
109  $conds[] = 'NOT EXISTS (' . $dbr->selectSQLText(
110  'user_groups', '1', [
111  'ug_user = user_id',
112  'ug_group' => $group,
113  'ug_expiry IS NULL OR ug_expiry >= ' . $dbr->addQuotes( $dbr->timestamp() )
114  ]
115  ) . ')';
116  }
117  }
118  if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
119  $conds[] = 'NOT EXISTS (' . $dbr->selectSQLText(
120  'ipblocks', '1', [ 'ipb_user=user_id', 'ipb_deleted' => 1 ]
121  ) . ')';
122  }
123 
124  return [
125  'tables' => $tables,
126  'fields' => [
127  'qcc_title',
128  'user_name' => 'qcc_title',
129  'user_id' => 'MAX(user_id)',
130  'recentedits' => 'COUNT(*)'
131  ],
132  'options' => [ 'GROUP BY' => [ 'qcc_title' ] ],
133  'conds' => $conds,
134  'join_conds' => $jconds,
135  ];
136  }
137 
138  function doBatchLookups() {
139  parent::doBatchLookups();
140 
141  $uids = [];
142  foreach ( $this->mResult as $row ) {
143  $uids[] = $row->user_id;
144  }
145  // Fetch the block status of the user for showing "(blocked)" text and for
146  // striking out names of suppressed users when privileged user views the list.
147  // Although the first query already hits the block table for un-privileged, this
148  // is done in two queries to avoid huge quicksorts and to make COUNT(*) correct.
149  $dbr = $this->getDatabase();
150  $res = $dbr->select( 'ipblocks',
151  [ 'ipb_user', 'MAX(ipb_deleted) AS block_status' ],
152  [ 'ipb_user' => $uids ],
153  __METHOD__,
154  [ 'GROUP BY' => [ 'ipb_user' ] ]
155  );
156  $this->blockStatusByUid = [];
157  foreach ( $res as $row ) {
158  $this->blockStatusByUid[$row->ipb_user] = $row->block_status; // 0 or 1
159  }
160  $this->mResult->seek( 0 );
161  }
162 
163  function formatRow( $row ) {
164  $userName = $row->user_name;
165 
166  $ulinks = Linker::userLink( $row->user_id, $userName );
167  $ulinks .= Linker::userToolLinks( $row->user_id, $userName );
168 
169  $lang = $this->getLanguage();
170 
171  $list = [];
172  $user = User::newFromId( $row->user_id );
173 
174  $ugms = self::getGroupMemberships( intval( $row->user_id ), $this->userGroupCache );
175  foreach ( $ugms as $ugm ) {
176  $list[] = $this->buildGroupLink( $ugm, $userName );
177  }
178 
179  $groups = $lang->commaList( $list );
180 
181  $item = $lang->specialList( $ulinks, $groups );
182 
183  $isBlocked = isset( $this->blockStatusByUid[$row->user_id] );
184  if ( $isBlocked && $this->blockStatusByUid[$row->user_id] == 1 ) {
185  $item = "<span class=\"deleted\">$item</span>";
186  }
187  $count = $this->msg( 'activeusers-count' )->numParams( $row->recentedits )
188  ->params( $userName )->numParams( $this->RCMaxAge )->escaped();
189  $blocked = $isBlocked ? ' ' . $this->msg( 'listusers-blocked', $userName )->escaped() : '';
190 
191  return Html::rawElement( 'li', [], "{$item} [{$count}]{$blocked}" );
192  }
193 
194 }
ContextSource\$context
IContextSource $context
Definition: ContextSource.php:33
ContextSource\getConfig
getConfig()
Definition: ContextSource.php:63
ActiveUsersPager\__construct
__construct(IContextSource $context=null, FormOptions $opts)
Definition: ActiveUsersPager.php:50
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:244
User\newFromId
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:614
RC_EXTERNAL
const RC_EXTERNAL
Definition: Defines.php:146
$tables
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist & $tables
Definition: hooks.txt:990
Linker\userLink
static userLink( $userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
Definition: Linker.php:893
ActiveUsersPager\getQueryInfo
getQueryInfo()
Definition: ActiveUsersPager.php:79
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
FormOptions\getValue
getValue( $name)
Get the value for the given option name.
Definition: FormOptions.php:180
ContextSource\msg
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
Definition: ContextSource.php:168
UsersPager\buildGroupLink
buildGroupLink( $group, $username)
Format a link to a group description page.
Definition: UsersPager.php:413
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1968
ActiveUsersPager\$blockStatusByUid
array $blockStatusByUid
Definition: ActiveUsersPager.php:44
IndexPager\getDatabase
getDatabase()
Get the Database object in use.
Definition: IndexPager.php:190
$res
$res
Definition: database.txt:21
ContextSource\getUser
getUser()
Definition: ContextSource.php:120
ActorMigration\newMigration
static newMigration()
Static constructor.
Definition: ActorMigration.php:89
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
$dbr
$dbr
Definition: testCompression.php:50
ContextSource\getLanguage
getLanguage()
Definition: ContextSource.php:128
ActiveUsersPager
This class is used to get a list of active users.
Definition: ActiveUsersPager.php:29
UsersPager
This class is used to get a list of user.
Definition: UsersPager.php:33
ActiveUsersPager\formatRow
formatRow( $row)
Definition: ActiveUsersPager.php:163
Title\makeTitleSafe
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:562
ActiveUsersPager\getIndexField
getIndexField()
Definition: ActiveUsersPager.php:75
Linker\userToolLinks
static userToolLinks( $userId, $userText, $redContribsWhenNoEdits=false, $flags=0, $edits=null)
Generate standard user tool links (talk, contributions, block link, etc.)
Definition: Linker.php:931
ActiveUsersPager\$opts
FormOptions $opts
Definition: ActiveUsersPager.php:34
groups
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing groups(accessed through $special->getFilterGroup)
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:53
UsersPager\getGroupMemberships
static getGroupMemberships( $uid, $cache=null)
Get an associative array containing groups the specified user belongs to, and the relevant UserGroupM...
Definition: UsersPager.php:397
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
Html\rawElement
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
NS_USER
const NS_USER
Definition: Defines.php:67
ActiveUsersPager\$groups
string[] $groups
Definition: ActiveUsersPager.php:39
RC_CATEGORIZE
const RC_CATEGORIZE
Definition: Defines.php:147
FormOptions
Helper class to keep track of options when mixing links and form elements.
Definition: FormOptions.php:35
ActiveUsersPager\doBatchLookups
doBatchLookups()
Called from getBody(), before getStartBody() is called and after doQuery() was called.
Definition: ActiveUsersPager.php:138
$username
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:783
array
the array() calling protocol came about after MediaWiki 1.4rc1.