Page MenuHomeWickedGov Phorge
Files F6033527

CNCampaignPager.php
No OneTemporary
Actions

Size
12 KB
Referenced Files
None
Subscribers
None

CNCampaignPager.php
View Options

<?php
use MediaWiki\Html\Html;
use MediaWiki\Pager\TablePager;
use MediaWiki\Xml\Xml;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\IResultWrapper;
/**
* A pager for viewing lists of CentralNotice campaigns. Optionally allows
* modification of some campaign properties. It is expected that this will only
* be included on special pages that are subclasses of CentralNotice.
*
* This class is a reorganization of code formerly in
* CentralNotice::listNotices().
*/
class CNCampaignPager extends TablePager {
// For now, we want to make this display without paging on
// meta.wikimedia.org, in line with the functionality that users currently
// encounter.
// This should be enough--Meta has less than 500 campaigns.
private const DEFAULT_LIMIT = 5000;
/** @var CentralNotice */
private $onSpecialCN;
/** @var string|false */
private $editable;
/** @var int|null */
private $assignedBannerId;
/** @var bool|null */
private $showArchived;
/** @var string[]|null */
private $fieldNames = null;
/**
* @param CentralNotice $onSpecialCN The CentralNotice special page we're on
* @param string|false $editable Whether or not to make the list editable
* @param int|null $assignedBannerId Set this to show only the campaigns
* associated with this banner id.
* @param bool|null $showArchived Set true to only show archived campaigns,
* false to only show unarchived campaigns
*/
public function __construct( CentralNotice $onSpecialCN,
$editable = false, $assignedBannerId = null, $showArchived = null
) {
$this->onSpecialCN = $onSpecialCN;
$this->assignedBannerId = $assignedBannerId;
$this->editable = $editable;
$this->showArchived = $showArchived;
parent::__construct( $onSpecialCN->getContext() );
$req = $onSpecialCN->getRequest();
// The 'limit' request param is used by the pager superclass.
// If it's absent, we'll set the limit to our own default.
$this->setLimit(
$req->getVal( 'limit', null ) ?:
self::DEFAULT_LIMIT );
// If the request doesn't an order by value, set descending order.
// This makes our order-by-id compatible with the previous default
// ordering in the UI.
if ( !$req->getVal( 'sort', null ) ) {
$this->mDefaultDirection = true;
}
}
/**
* @inheritDoc
*/
public function getQueryInfo() {
$db = $this->getDatabase();
$pagerQuery = [
'tables' => [
'notices' => 'cn_notices',
],
'fields' => [
'notices.not_id',
'not_name',
'not_type',
'not_start',
'not_end',
'not_enabled',
'not_preferred',
'not_throttle',
'not_geo',
'not_locked',
'not_archived',
'countries' => $db->newSelectQueryBuilder()
->table( 'cn_notice_countries' )
->field( 'nc_country' )
->where( 'nc_notice_id = notices.not_id' )
->buildGroupConcatField( ',' ),
'regions' => $db->newSelectQueryBuilder()
->table( 'cn_notice_regions' )
->field( 'nr_region' )
->where( 'nr_notice_id = notices.not_id' )
->buildGroupConcatField( ',' ),
'languages' => $db->newSelectQueryBuilder()
->table( 'cn_notice_languages' )
->field( 'nl_language' )
->where( 'nl_notice_id = notices.not_id' )
->buildGroupConcatField( ',' ),
'projects' => $db->newSelectQueryBuilder()
->table( 'cn_notice_projects' )
->field( 'np_project' )
->where( 'np_notice_id = notices.not_id' )
->buildGroupConcatField( ',' ),
],
'conds' => [],
];
if ( $this->assignedBannerId ) {
// Query for only campaigns associated with a specific banner id.
$pagerQuery['tables']['assignments'] = 'cn_assignments';
$pagerQuery['conds'] = [
'notices.not_id = assignments.not_id',
'assignments.tmp_id' => (int)$this->assignedBannerId,
];
}
if ( $this->showArchived !== null ) {
$pagerQuery['conds']['not_archived'] = (int)$this->showArchived;
}
return $pagerQuery;
}
public function doQuery() {
// group_concat output is limited to 1024 characters by default, increase
// the limit temporarily so the list of all languages can be rendered.
$db = $this->getDatabase();
if ( $db instanceof IDatabase ) {
$db->setSessionOptions( [ 'groupConcatMaxLen' => 10000 ] );
}
parent::doQuery();
}
/**
* @inheritDoc
*/
public function getFieldNames() {
if ( !$this->fieldNames ) {
$this->fieldNames = [
'not_name' => $this->msg( 'centralnotice-notice-name' )->text(),
'not_type' => $this->msg( 'centralnotice-campaign-type' )->text(),
'projects' => $this->msg( 'centralnotice-projects' )->text(),
'languages' => $this->msg( 'centralnotice-languages' )->text(),
'location' => $this->msg( 'centralnotice-location' )->text(),
'not_start' => $this->msg( 'centralnotice-start-timestamp' )->text(),
'not_end' => $this->msg( 'centralnotice-end-timestamp' )->text(),
'not_enabled' => $this->msg( 'centralnotice-enabled' )->text(),
'not_preferred' => $this->msg( 'centralnotice-preferred' )->text(),
'not_throttle' => $this->msg( 'centralnotice-throttle' )->text(),
'not_locked' => $this->msg( 'centralnotice-locked' )->text(),
'not_archived' => $this->msg( 'centralnotice-archive-campaign' )->text()
];
}
return $this->fieldNames;
}
/**
* @inheritDoc
*/
public function getStartBody() {
$htmlOut = '';
$htmlOut .= Html::openElement(
'fieldset',
[
'class' => 'prefsection',
'id' => 'cn-campaign-pager',
'data-editable' => ( $this->editable ? 1 : 0 )
]
);
return $htmlOut . parent::getStartBody();
}
/**
* Format the data in the pager
*
* This calls a method which calls Language::listToText. Language
* uses ->escaped() messages for commas, so this triggers a double
* escape warning in phan. However in terms of double escaping, a
* comma message doesn't matter that much, and it would be difficult
* to avoid without rewriting how all these classes work, so we
* suppress this for now, and leave fixing it as a future FIXME.
* @suppress SecurityCheck-DoubleEscaped
* @param string $fieldName While field are we formatting
* @param string $value The value for the field
* @return string HTML
*/
public function formatValue( $fieldName, $value ) {
// These are used in a few cases below.
$rowIsEnabled = (bool)$this->mCurrentRow->not_enabled;
$rowIsLocked = (bool)$this->mCurrentRow->not_locked;
$rowIsArchived = (bool)$this->mCurrentRow->not_archived;
$name = $this->mCurrentRow->not_name;
$readonly = [ 'disabled' => 'disabled' ];
switch ( $fieldName ) {
case 'not_name':
$linkRenderer = $this->getLinkRenderer();
return $linkRenderer->makeLink(
Campaign::getTitleForURL(),
$value,
[],
Campaign::getQueryForURL( $value )
);
case 'not_type':
return $this->onSpecialCN->campaignTypeSelector(
$this->editable && !$rowIsLocked && !$rowIsArchived,
$value,
$name
);
case 'projects':
$p = explode( ',', $this->mCurrentRow->projects );
return htmlspecialchars( $this->onSpecialCN->listProjects( $p ) );
case 'languages':
$l = explode( ',', $this->mCurrentRow->languages );
return htmlspecialchars( $this->onSpecialCN->listLanguages( $l ) );
case 'location':
$countries = $this->mCurrentRow->countries
? explode( ',', $this->mCurrentRow->countries )
: [];
$regions = $this->mCurrentRow->regions
? explode( ',', $this->mCurrentRow->regions )
: [];
// if not geotargeted or no countries and regions chosen, show "all"
$emptyGeo = !$countries && !$regions;
if ( !$this->mCurrentRow->not_geo || $emptyGeo ) {
return $this->msg( 'centralnotice-all' )->text();
}
$list = $this->onSpecialCN->listCountriesRegions( $countries, $regions );
return htmlspecialchars( $list );
case 'not_start':
case 'not_end':
return date( '<\b>Y-m-d</\b> H:i', (int)wfTimestamp( TS_UNIX, $value ) );
// Note: Names of controls and data attributes must coordinate with
// ext.centralNotice.adminUi.campaignPager.js
case 'not_enabled':
return Html::check(
'enabled',
$rowIsEnabled,
array_replace(
( !$this->editable || $rowIsLocked || $rowIsArchived )
? $readonly : [],
[
'data-campaign-name' => $name,
'data-initial-value' => $rowIsEnabled,
'class' => 'noshiftselect mw-cn-input-check-sort'
]
)
);
case 'not_preferred':
return $this->onSpecialCN->prioritySelector(
$name,
$this->editable && !$rowIsLocked && !$rowIsArchived,
(int)$value
);
case 'not_throttle':
if ( $value < 100 ) {
return htmlspecialchars( $value . "%" );
} else {
return '';
}
case 'not_locked':
return Html::check(
'locked',
$rowIsLocked,
array_replace(
// Note: Lockability should always be modifiable
// regardless of whether the camapgin is archived.
// Otherwise we create a dead-end state of locked and
// archived.
( !$this->editable )
? $readonly : [],
[
'data-campaign-name' => $name,
'data-initial-value' => $rowIsLocked,
'class' => 'noshiftselect mw-cn-input-check-sort'
]
)
);
case 'not_archived':
return Html::check(
'archived',
$rowIsArchived,
array_replace(
( !$this->editable || $rowIsLocked || $rowIsEnabled )
? $readonly : [],
[
'data-campaign-name' => $name,
'data-initial-value' => $rowIsArchived,
'class' => 'noshiftselect mw-cn-input-check-sort'
]
)
);
}
}
/**
* Set special CSS classes for active and archived campaigns.
*
* @inheritDoc
*/
public function getRowClass( $row ) {
$enabled = (bool)$row->not_enabled;
$now = wfTimestamp();
$started = $now >= wfTimestamp( TS_UNIX, $row->not_start );
$notEnded = $now <= wfTimestamp( TS_UNIX, $row->not_end );
$cssClass = parent::getRowClass( $row );
if ( $enabled && $started && $notEnded ) {
$cssClass .= ' cn-active-campaign';
}
return $cssClass;
}
/**
* @inheritDoc
*/
public function getCellAttrs( $field, $value ) {
$attrs = parent::getCellAttrs( $field, $value );
switch ( $field ) {
case 'not_start':
case 'not_end':
// Set css class, or add to the class(es) set by parent
$attrs['class'] = ltrim( ( $attrs['class'] ?? '' ) . ' cn-date-column' );
break;
case 'not_enabled':
case 'not_preferred':
case 'not_throttle':
case 'not_locked':
case 'not_archived':
// These fields use the extra sort-value attribute for JS
// sorting.
$attrs['data-sort-value'] = $value;
}
return $attrs;
}
/**
* @inheritDoc
*/
public function getEndBody() {
$htmlOut = '';
if ( $this->editable ) {
$htmlOut .=
Html::openElement( 'div',
[ 'class' => 'cn-buttons cn-formsection-emphasis' ] );
$htmlOut .= $this->onSpecialCN->makeSummaryField();
$htmlOut .= Xml::input(
'centralnoticesubmit',
false,
$this->msg( 'centralnotice-modify' )->text(),
[
'type' => 'button',
'id' => 'cn-campaign-pager-submit'
]
);
$htmlOut .= Html::closeElement( 'div' );
}
$htmlOut .= Html::closeElement( 'fieldset' );
return parent::getEndBody() . $htmlOut;
}
/**
* @inheritDoc
*/
public function isFieldSortable( $field ) {
// If this is the only page shown, we'll sort via JS, which works on all
// columns.
if ( $this->isWithinLimit() ) {
return false;
}
// Because of how paging works, it seems that only unique columns can be
// ordered if there's more than one page of results.
// TODO If paging is ever needed in the UI, it should be possible to
// partially address this by using the id as a secondary field for
// ordering and for the paging offset. Some fields still won't be
// sortable via the DB because of how values are munged in the UI (for
// example, "All" and "All except..." for languages and countries).
// If needed, filters could be added for such fields, though.
if ( $field === 'not_name' ) {
return true;
}
return false;
}
/**
* @inheritDoc
*/
public function getDefaultSort() {
return $this->assignedBannerId === null ?
'not_id' : 'notices.not_id';
}
/**
* Returns true if this is the only page of results there is to show.
* @return bool
*/
private function isWithinLimit() {
return $this->mIsFirst && $this->mIsLast;
}
/**
* @inheritDoc
*/
public function extractResultInfo( $isFirst, $limit, IResultWrapper $res ) {
parent::extractResultInfo( $isFirst, $limit, $res );
// Disable editing if there's more than one page. (This is a legacy
// requirement; it might work even with paging now.)
if ( !$this->isWithinLimit() ) {
$this->editable = false;
}
}
/**
* @inheritDoc
*/
public function getTableClass() {
$jsSortable = $this->isWithinLimit() ? ' sortable' : '';
return parent::getTableClass() . ' wikitable' . $jsSortable;
}
}

File Metadata

Mime Type
text/x-php
Expires
Oct 4 2026, 18:37 (5 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
81/85/2ff3acd881c066812d26c655f800
Default Alt Text
CNCampaignPager.php (12 KB)

Event Timeline