Page MenuHomeWickedGov Phorge
Files F4102006

SpecialBannerAllocation.php
No OneTemporary
Actions

Size
12 KB
Referenced Files
None
Subscribers
None

SpecialBannerAllocation.php
View Options

<?php
/**
* Wikimedia Foundation
*
* LICENSE
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
*/
use MediaWiki\Html\Html;
use MediaWiki\MediaWikiServices;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Xml\Xml;
/**
* SpecialBannerAllocation
*
* Special page for handling banner allocation.
*/
class SpecialBannerAllocation extends CentralNotice {
/**
* The project being used for banner allocation.
*
* @see $wgNoticeProjects
*
* @var string
*/
public $project = 'wikipedia';
/**
* The language being used for banner allocation
*
* This should always be a lowercase language code.
*
* @var string
*/
public $language = 'en';
/**
* The country being used for banner allocation.
*
* This should always be an uppercase country code or the empty string.
*
* @var string
*/
public $locationCountry = 'US';
/**
* The region being used for banner allocation.
*
* This should always be an uppercase region code or the empty string.
*
* @var string
*/
public $locationRegion = '';
public function __construct() {
// Register special page
SpecialPage::__construct( 'BannerAllocation' );
}
/**
* Handle different types of page requests
* @param string|null $sub
*/
public function execute( $sub ) {
global $wgNoticeProjects, $wgLanguageCode, $wgNoticeProject;
$out = $this->getOutput();
$request = $this->getRequest();
$this->project = $request->getText( 'project', $wgNoticeProject );
$this->language = $request->getText( 'language', $wgLanguageCode );
// If the form has been submitted, the country code or region code should be passed along.
$locationCountrySubmitted = $request->getVal( 'country' );
$locationRegionSubmitted = $request->getVal( 'region' );
$this->locationCountry = $locationCountrySubmitted ?: $this->locationCountry;
$this->locationRegion = $locationRegionSubmitted ?: $this->locationRegion;
// Convert submitted location to boolean value. If it true, showList() will be called.
$locationSubmitted = ( $locationCountrySubmitted || $locationRegionSubmitted );
// Begin output
$this->setHeaders();
// Output ResourceLoader module for styling and javascript functions
$out->addModules( [
'ext.centralNotice.adminUi',
] );
// Initialize error variable
$this->centralNoticeError = false;
// Allow users to add a custom nav bar (T138284)
$navBar = $this->msg( 'centralnotice-navbar' )->inContentLanguage();
if ( !$navBar->isDisabled() ) {
$out->addHTML( $navBar->parseAsBlock() );
}
// Show summary
$out->addWikiMsg( 'centralnotice-summary' );
// Begin Banners tab content
$out->addHTML( Html::openElement( 'div', [ 'id' => 'preferences' ] ) );
$htmlOut = '';
// Begin Allocation selection fieldset
$htmlOut .= Html::openElement( 'fieldset', [ 'class' => 'prefsection' ] );
$htmlOut .= Html::openElement( 'form', [ 'method' => 'get' ] );
$htmlOut .= Html::element( 'h2', [], $this->msg( 'centralnotice-view-allocation' )->text() );
$htmlOut .= $this->msg( 'centralnotice-allocation-instructions' )->parseAsBlock();
$htmlOut .= Html::openElement( 'table', [ 'id' => 'envpicker', 'cellpadding' => 7 ] );
$htmlOut .= Html::openElement( 'tr' );
$htmlOut .= Html::rawElement( 'td',
[ 'style' => 'width: 20%;' ],
$this->msg( 'centralnotice-project-name' )->parse() );
$htmlOut .= Html::openElement( 'td' );
$htmlOut .= Html::openElement( 'select', [ 'name' => 'project' ] );
foreach ( $wgNoticeProjects as $value ) {
$htmlOut .= Xml::option( $value, $value, $value === $this->project );
}
$htmlOut .= Html::closeElement( 'select' );
$htmlOut .= Html::closeElement( 'td' );
$htmlOut .= Html::closeElement( 'tr' );
$htmlOut .= Html::openElement( 'tr' );
$htmlOut .= Html::element( 'td',
[ 'valign' => 'top' ],
$this->msg( 'centralnotice-project-lang' )->text() );
$htmlOut .= Html::openElement( 'td' );
// Retrieve the list of languages in user's language
$languages = MediaWikiServices::getInstance()->getLanguageNameUtils()
->getLanguageNames( $this->getLanguage()->getCode() );
// Make sure the site language is in the list; a custom language code
// might not have a defined name...
if ( !array_key_exists( $wgLanguageCode, $languages ) ) {
$languages[$wgLanguageCode] = $wgLanguageCode;
}
ksort( $languages );
$htmlOut .= Html::openElement( 'select', [ 'name' => 'language' ] );
foreach ( $languages as $code => $name ) {
$htmlOut .= Xml::option(
$this->msg( 'centralnotice-language-listing', $code, $name )->text(),
$code, $code === $this->language );
}
$htmlOut .= Html::closeElement( 'select' );
$htmlOut .= Html::closeElement( 'td' );
$htmlOut .= Html::closeElement( 'tr' );
// Country dropdown
$htmlOut .= Html::openElement( 'tr' );
$htmlOut .= Html::element( 'td', [], $this->msg( 'centralnotice-country' )->text() );
$htmlOut .= Html::openElement( 'td' );
$userLanguageCode = $this->getLanguage()->getCode();
$countries = GeoTarget::getCountriesList( $userLanguageCode );
$htmlOut .= Html::openElement(
'select', [ 'name' => 'country', 'id' => 'centralnotice-country' ]
);
foreach ( $countries as $code => $country ) {
$htmlOut .= Xml::option(
$country->getName(), $code, $code === $this->locationCountry
);
}
$htmlOut .= Html::closeElement( 'select' );
$htmlOut .= Html::closeElement( 'td' );
$htmlOut .= Html::closeElement( 'tr' );
// End Country dropdown
// Region dropdown
$htmlOut .= Html::openElement( 'tr' );
$htmlOut .= Html::element( 'td', [], $this->msg( 'centralnotice-region' )->text() );
$htmlOut .= Html::openElement( 'td' );
$htmlOut .= Html::openElement(
'select', [ 'name' => 'region', 'id' => 'centralnotice-region' ]
);
// set a client-side config variable with an associative array so we can
// dynamically populate this dropdown based on selected country.
$regionOptions = [];
foreach ( $countries as $countryCode => $country ) {
$regionOptions[$countryCode] = [];
foreach ( $country->getRegions() as $regionCode => $regionName ) {
$regionOptions[$countryCode][$regionCode] = $regionName;
}
}
$out->addJsConfigVars( [ 'CentralNoticeRegionOptions' => $regionOptions ] );
$htmlOut .= Html::closeElement( 'select' );
$htmlOut .= Html::closeElement( 'td' );
$htmlOut .= Html::closeElement( 'tr' );
// End Region dropdown
$htmlOut .= Html::closeElement( 'table' );
$htmlOut .= Html::rawElement( 'div',
[ 'class' => 'cn-buttons' ],
Html::submitButton( $this->msg( 'centralnotice-view' )->text() )
);
$htmlOut .= Html::closeElement( 'form' );
// End Allocation selection fieldset
$htmlOut .= Html::closeElement( 'fieldset' );
$out->addHTML( $htmlOut );
// Handle form submissions
if ( $locationSubmitted ) {
$this->showList();
}
// End Banners tab content
$out->addHTML( Html::closeElement( 'div' ) );
}
/**
* Show a list of banners with allocation. Newer banners are shown first.
*/
public function showList() {
global $wgNoticeNumberOfBuckets;
// Obtain all banners & campaigns
$request = $this->getRequest();
$project = $request->getText( 'project' );
$country = $request->getText( 'country' );
$region = $request->getText( 'region' );
$language = $request->getText( 'language' );
// Begin building HTML
$htmlOut = '';
// Begin Allocation list fieldset
$htmlOut .= Html::openElement( 'fieldset', [ 'class' => 'prefsection' ] );
// Given our project and language combination, get banner choice data,
// then filter on country
$choiceData = ChoiceDataProvider::getChoices( $project, $language );
// Iterate through each possible device type and get allocation information
$devices = CNDeviceTarget::getAvailableDevices();
foreach ( $devices as $deviceId => $deviceData ) {
$htmlOut .= Html::openElement(
'div',
[
'id' => "cn-allocation-{$project}-{$language}-{$country}-{$deviceId}",
'class' => 'cn-allocation-group'
]
);
$htmlOut .= Html::rawElement(
'h3', [],
$this->msg(
'centralnotice-allocation-description',
wfEscapeWikiText( $language ),
wfEscapeWikiText( $project ),
wfEscapeWikiText( $country ),
$deviceData['label']
)->parse()
);
// FIXME matrix is chosen dynamically based on more UI inputs
$matrix = [];
for ( $i = 0; $i < $wgNoticeNumberOfBuckets; $i++ ) {
$matrix[] = [ 'anonymous' => 'true', 'bucket' => $i ];
}
for ( $i = 0; $i < $wgNoticeNumberOfBuckets; $i++ ) {
$matrix[] = [ 'anonymous' => 'false', 'bucket' => $i ];
}
foreach ( $matrix as $target ) {
if ( $target['anonymous'] === 'true' ) {
$label = $this->msg( 'centralnotice-banner-anonymous' )->text();
$status = AllocationCalculator::ANONYMOUS;
} else {
$label = $this->msg( 'centralnotice-banner-logged-in' )->text();
$status = AllocationCalculator::LOGGED_IN;
}
$label .= ' -- ' . $this->msg( 'centralnotice-bucket-letter' )->
rawParams( chr( $target['bucket'] + 65 ) )->text();
$possibleBannersAllCampaigns =
AllocationCalculator::filterAndAllocate( $country,
$region, $status, $deviceData['header'], $target['bucket'],
$choiceData );
$htmlOut .= $this->getTable( $label, $possibleBannersAllCampaigns );
}
$htmlOut .= Html::closeElement( 'div' );
}
// End Allocation list fieldset
$htmlOut .= Html::closeElement( 'fieldset' );
$this->getOutput()->addHTML( $htmlOut );
$this->getOutput()->addModuleStyles( 'jquery.tablesorter.styles' );
$this->getOutput()->addModules( 'jquery.tablesorter' );
}
/**
* Generate the HTML for an allocation table
* @param string $type The title for the table
* @param array $banners The banners as allocated by AllocationCalculator
* @return string HTML for the table
*/
public function getTable( $type, $banners ) {
$htmlOut = Html::openElement( 'table',
[ 'cellpadding' => 9, 'class' => 'wikitable sortable', 'style' => 'margin: 1em 0;' ]
);
$htmlOut .= Html::element( 'h4', [], $type );
if ( count( $banners ) > 0 ) {
$htmlOut .= Html::rawElement( 'tr', [],
Html::element( 'th', [ 'width' => '5%' ],
$this->msg( 'centralnotice-percentage' )->text() ) .
Html::element( 'th', [ 'width' => '30%' ],
$this->msg( 'centralnotice-banner' )->text() ) .
Html::element( 'th', [ 'width' => '30%' ],
$this->msg( 'centralnotice-notice' )->text() )
);
}
$htmlOut .= $this->createRows( $banners );
$htmlOut .= Html::closeElement( 'table' );
return $htmlOut;
}
/**
* @param array[] $banners
* @return string HTML
*/
public function createRows( $banners ) {
$viewCampaign = $this->getTitleFor( 'CentralNotice' );
$htmlOut = '';
if ( count( $banners ) > 0 ) {
$linkRenderer = $this->getLinkRenderer();
foreach ( $banners as $banner ) {
$percentage = sprintf( "%0.2f", round( $banner['allocation'] * 100, 2 ) );
// Row begin
$htmlOut .= Html::openElement( 'tr', [ 'class' => 'mw-sp-centralnotice-allocationrow' ] );
// Percentage
$htmlOut .= Html::element( 'td', [ 'align' => 'right' ],
$this->msg( 'percent', $percentage )->text()
);
// Banner name
$viewBanner = $this->getTitleFor( 'CentralNoticeBanners', "edit/{$banner['name']}" );
$htmlOut .= Html::rawElement( 'td', [ 'valign' => 'top' ],
Html::rawElement( 'span',
[ 'class' => 'cn-' . $banner['campaign'] . '-' . $banner['name'] ],
$linkRenderer->makeLink(
$viewBanner,
$banner['name'],
[],
[ 'template' => $banner['name'] ]
)
)
);
// Campaign name
$htmlOut .= Html::rawElement( 'td', [ 'valign' => 'top' ],
$linkRenderer->makeLink(
$viewCampaign,
$banner['campaign'],
[],
[
'subaction' => 'noticeDetail',
'notice' => $banner['campaign']
]
)
);
// Row end
$htmlOut .= Html::closeElement( 'tr' );
}
} else {
$htmlOut .= Html::rawElement( 'tr', [],
Html::rawElement( 'td', [],
$this->msg( 'centralnotice-no-allocation' )->parseAsBlock()
)
);
}
return $htmlOut;
}
}

File Metadata

Mime Type
text/x-php
Expires
Tue, Aug 18, 17:13 (3 w, 4 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
20/30/52fd2d068d8e422a91152d7fc418
Default Alt Text
SpecialBannerAllocation.php (12 KB)

Event Timeline