jenkins-bot has submitted this change and it was merged.
Change subject: Display allocations in a compact form
......................................................................
Display allocations in a compact form
Find all groups of criteria sharing the same allocations, and partition into
Cartesian products for display.
The allocations page can now display all global allocations on one screen.
TODO:
* date filter and history reconstruction
Change-Id: Id10b191bd46ce8c6776506644e4e20d983a6380e
---
M CentralNotice.alias.php
M CentralNotice.i18n.php
M CentralNotice.php
M includes/Campaign.php
M special/SpecialCentralNotice.php
A special/SpecialGlobalAllocation.php
6 files changed, 638 insertions(+), 8 deletions(-)
Approvals:
Mwalker: Looks good to me, approved
jenkins-bot: Verified
diff --git a/CentralNotice.alias.php b/CentralNotice.alias.php
index d47996c..4b5d51a 100644
--- a/CentralNotice.alias.php
+++ b/CentralNotice.alias.php
@@ -10,6 +10,7 @@
'CentralNotice' => array( 'CentralNotice' ),
'CentralNoticeLogs' => array( 'CentralNoticeLogs' ),
'NoticeTemplate' => array( 'NoticeTemplate' ),
+ 'GlobalAllocation' => array( 'GlobalAllocation' ),
'BannerAllocation' => array( 'BannerAllocation' ),
'BannerController' => array( 'BannerController' ),
'BannerListLoader' => array( 'BannerListLoader' ),
@@ -349,4 +350,4 @@
'BannerListLoader' => array( '布條裝載' ),
'BannerLoader' => array( '橫幅裝載' ),
'HideBanners' => array( '隱藏橫幅' ),
-);
\ No newline at end of file
+);
diff --git a/CentralNotice.i18n.php b/CentralNotice.i18n.php
index c8cba1b..c8f3196 100644
--- a/CentralNotice.i18n.php
+++ b/CentralNotice.i18n.php
@@ -14,6 +14,7 @@
'centralnotice' => 'Central notice admin',
'noticetemplate' => 'Central notice admin',
'bannerallocation' => 'Central notice admin',
+ 'globalallocation' => 'Central notice admin',
'centralnoticelogs' => 'Central notice admin',
'right-centralnotice-admin' => 'Manage central notices',
'action-centralnotice-admin' => 'manage central notices',
@@ -131,6 +132,7 @@
'centralnotice-banner-landing-pages' => 'Landing pages
(comma-separated):',
'centralnotice-geo' => 'Geotargeted',
'centralnotice-countries' => 'Countries',
+ 'centralnotice-global-allocation' => 'Global allocation',
'centralnotice-allocation' => 'Allocation',
'centralnotice-view-allocation' => 'View banner allocation',
'centralnotice-allocation-instructions' => 'Choose the environment you
would like to view banner allocation for:',
@@ -139,7 +141,7 @@
'centralnotice-projects' => 'Projects',
'centralnotice-country' => 'Country',
'centralnotice-no-allocation' => 'No banners allocated.',
- 'centralnotice-allocation-description' => 'Banner allocation for $1.$2
in $3:',
+ 'centralnotice-allocation-description' => 'Banner allocation for
language: $1, project: $2, in country: $3:',
'centralnotice-percentage' => 'Percentage',
'centralnotice-documentwrite-error' => "document.write() cannot be used
within a banner.\nSee http://meta.wikimedia.org/wiki/Help:CentralNotice for
more information.",
'centralnotice-preferred' => 'Priority',
@@ -195,6 +197,10 @@
'centralnotice-bucket-letter' => 'Bucket "$1"',
'centralnotice-all' => 'All',
'centralnotice-all-except' => 'All except $1',
+ 'centralnotice-excluding-list' => '$1 (excluding $2)',
+ 'centralnotice-user-role' => 'User role',
+ 'centralnotice-user-role-anonymous' => 'Anonymous',
+ 'centralnotice-user-role-logged-in' => 'Logged-in',
);
/** Message documentation (Message documentation)
@@ -223,6 +229,8 @@
'noticetemplate' => 'Title of Special:NoticeTemplate page, should be
identical to centralnotice message. (Since the extension uses a secondary tab
interface, the effective page title is actually centralnotice-manage-templates.)
{{Identical|Central notice admin}}',
'bannerallocation' => 'Title of Special:BannerAllocation page, should
be identical to centralnotice message. (Since the extension uses a secondary
tab interface, the effective page title is actually
centralnotice-view-allocation.)
+{{Identical|Central notice admin}}',
+ 'globalallocation' => 'Title of Special:GlobalAllocation page, should
be identical to centralnotice message. (Since the extension uses a secondary
tab interface, the effective page title is actually
centralnotice-view-allocation.)
{{Identical|Central notice admin}}',
'centralnoticelogs' => 'Title of Special:CentralNoticeLogs page, should
be identical to centralnotice message. (Since the extension uses a secondary
tab interface, the effective page title is actually centralnotice-view-logs.)
{{Identical|Central notice admin}}',
@@ -331,6 +339,7 @@
* $2 - a title for a page',
'centralnotice-geo' => 'Used to label a checkbox which activates
geotargeting',
'centralnotice-countries' => '{{Identical|Country}}',
+ 'centralnotice-global-allocation' => 'Tab for
[[m:Special:GlobalAllocation|global allocation]] overview.',
'centralnotice-allocation' => 'Tab for sub-page
[[m:BannerAllocation|banner allocation]] to central notice special page.',
'centralnotice-view-allocation' => 'Heading of dialog box on
[[m:Special:BannerAllocation|banner allocation]] special page.',
'centralnotice-allocation-instructions' => 'Dialog box instructions on
[[m:Special:BannerAllocation|banner allocation]] special page.',
@@ -437,8 +446,14 @@
'centralnotice-bucket-letter' => 'Label for specifying what bucket is
being used.',
'centralnotice-all' => 'Used when a list contains all possible elements.
{{Identical|All}}',
- 'centralnotice-all-except' => 'Describe a list which nearly contains
every possible element, by only listing what is excluded. Parameters:
-* $1 - a comma-separated list of excluded elements (projects, countries or
languages)',
+ 'centralnotice-all-except' => 'A list which nearly contains every
possible element, by only listing what is excluded. Parameters:
+* $1 - a comma-separated list of excluded elements',
+ 'centralnotice-excluding-list' => 'A list followed by what has been
excluded. Parameters:
+* $1 - a comma-separated list of included elements
+* $2 - a comma-separated list of excluded elements',
+ 'centralnotice-user-role' => 'Label for a logged-in / anonymous user
column',
+ 'centralnotice-user-role-anonymous' => 'Label for the anonymous user
role',
+ 'centralnotice-user-role-logged-in' => 'Label for the logged-in user
role',
);
/** Afrikaans (Afrikaans)
diff --git a/CentralNotice.php b/CentralNotice.php
index 3061512..c8b4f41 100644
--- a/CentralNotice.php
+++ b/CentralNotice.php
@@ -295,6 +295,7 @@
$wgAutoloadClasses[ 'CentralNoticeBannerLogPager' ] = $dir .
'CentralNoticeBannerLogPager.php';
$wgAutoloadClasses[ 'CentralNoticePageLogPager' ] = $dir .
'CentralNoticePageLogPager.php';
$wgAutoloadClasses[ 'SpecialNoticeTemplate' ] = $specialDir .
'SpecialNoticeTemplate.php';
+ $wgAutoloadClasses[ 'SpecialGlobalAllocation' ] = $specialDir .
'SpecialGlobalAllocation.php';
$wgAutoloadClasses[ 'SpecialBannerAllocation' ] = $specialDir .
'SpecialBannerAllocation.php';
$wgAutoloadClasses[ 'SpecialCentralNoticeLogs' ] = $specialDir
. 'SpecialCentralNoticeLogs.php';
@@ -309,6 +310,7 @@
$wgSpecialPages[ 'CentralNotice' ] = 'CentralNotice';
$wgSpecialPageGroups[ 'CentralNotice' ] = 'wiki'; // Wiki data
and tools
$wgSpecialPages[ 'NoticeTemplate' ] = 'SpecialNoticeTemplate';
+ $wgSpecialPages[ 'GlobalAllocation' ] =
'SpecialGlobalAllocation';
$wgSpecialPages[ 'BannerAllocation' ] =
'SpecialBannerAllocation';
$wgSpecialPages[ 'CentralNoticeLogs' ] =
'SpecialCentralNoticeLogs';
}
diff --git a/includes/Campaign.php b/includes/Campaign.php
index b0755bd..22486f6 100644
--- a/includes/Campaign.php
+++ b/includes/Campaign.php
@@ -24,8 +24,7 @@
* @param null|string $project The name of the project, ie:
'wikipedia'; if null select all
* projects.
* @param null|string $language ISO language code, if null select all
languages
- * @param null|string $location ISO country code, if null select only
non geo-targeted
- * campaigns.
+ * @param null|string $location ISO country code, if null select all
campaigns
* @param null|date $date Campaigns must start before and end
after this date
* If the parameter is null, it takes the
current date/time
* @param bool $enabled If true, select only active campaigns.
If false select all.
@@ -79,11 +78,15 @@
$conds[ 'nl_language' ] = $language;
}
+ if ( $location ) {
+ $conds['not_geo'] = 0;
+ }
+
// Pull the notice IDs of the non geotargeted campaigns
$res = $dbr->select(
$tables,
'not_id',
- array_merge( $conds, array( 'not_geo' => 0 ) ),
+ $conds,
__METHOD__
);
foreach ( $res as $row ) {
diff --git a/special/SpecialCentralNotice.php b/special/SpecialCentralNotice.php
index a2a8450..40a4ebc 100644
--- a/special/SpecialCentralNotice.php
+++ b/special/SpecialCentralNotice.php
@@ -197,6 +197,7 @@
'CentralNotice' => wfMessage(
'centralnotice-notices' )->text(),
'NoticeTemplate' => wfMessage(
'centralnotice-templates' )->text(),
'BannerAllocation' => wfMessage(
'centralnotice-allocation' )->text(),
+ 'GlobalAllocation' => wfMessage(
'centralnotice-global-allocation' )->text(),
'CentralNoticeLogs' => wfMessage( 'centralnotice-logs'
)->text()
);
$htmlOut = Xml::openElement( 'ul', array( 'id' => 'preftoc' ) );
@@ -1441,6 +1442,6 @@
$txt = $this->getContext()->getLanguage()->listToText(
$inverse );
return $this->getContext()->msg(
'centralnotice-all-except', $txt )->text();
}
- return $this->getContext()->getLanguage()->listToText( $list );
+ return $this->getContext()->getLanguage()->listToText(
array_values( $list ) );
}
}
diff --git a/special/SpecialGlobalAllocation.php
b/special/SpecialGlobalAllocation.php
new file mode 100644
index 0000000..55272c3
--- /dev/null
+++ b/special/SpecialGlobalAllocation.php
@@ -0,0 +1,608 @@
+<?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.
+ *
+ */
+
+/**
+ * SpecialGlobalAllocation
+ *
+ * Display worldwide allocation
+ */
+class SpecialGlobalAllocation extends CentralNotice {
+ /**
+ * The project being used for banner allocation.
+ *
+ * @see $wgNoticeProjects
+ *
+ * @var string $project
+ */
+ public $project = null;
+
+ /**
+ * The language being used for banner allocation
+ *
+ * This should always be a lowercase language code.
+ *
+ * @var string $project
+ */
+ public $language = null;
+
+ /**
+ * The location being used for banner allocation.
+ *
+ * This should always be an uppercase country code.
+ *
+ * @var string $location
+ */
+ public $location = null;
+
+ /**
+ * Constructor
+ */
+ public function __construct() {
+ // Register special page
+ SpecialPage::__construct( 'GlobalAllocation' );
+ }
+
+ public function isListed() {
+ return false;
+ }
+
+ /**
+ * Handle different types of page requests
+ */
+ public function execute( $sub ) {
+ global $wgNoticeProjects, $wgLanguageCode, $wgNoticeProject;
+ $out = $this->getOutput();
+ $request = $this->getRequest();
+
+ $this->project = $request->getText( 'project', $this->project );
+ $this->language = $request->getText( 'language',
$this->language );
+ $this->location = $request->getVal( 'country', $this->location
);
+
+ // Begin output
+ $this->setHeaders();
+
+ // Output ResourceLoader module for styling and javascript
functions
+ $out->addModules( array(
+ 'ext.centralNotice.interface',
+ 'ext.centralNotice.bannerStats'
+ ) );
+
+ // Initialize error variable
+ $this->centralNoticeError = false;
+
+ // Show summary
+ $out->addWikiMsg( 'centralnotice-summary' );
+
+ // Show header
+ $this->printHeader();
+
+ // Begin Banners tab content
+ $out->addHTML( Html::openElement( 'div', array( 'id' =>
'preferences' ) ) );
+
+ $htmlOut = '';
+
+ // Begin Allocation selection fieldset
+ $htmlOut .= Html::openElement( 'fieldset', array( 'class' =>
'prefsection' ) );
+
+ $htmlOut .= Html::openElement( 'form', array( 'method' => 'get'
) );
+ $htmlOut .= Html::element( 'h2', array(), $this->msg(
'centralnotice-view-allocation' )->text() );
+ $htmlOut .= Xml::tags( 'p', null, $this->msg(
'centralnotice-allocation-instructions' )->text() );
+
+ $htmlOut .= Html::openElement( 'table', array ( 'id' =>
'envpicker', 'cellpadding' => 7 ) );
+ $htmlOut .= Html::openElement( 'tr' );
+ $htmlOut .= Xml::tags( 'td',
+ array( 'style' => 'width: 20%;' ),
+ $this->msg( 'centralnotice-project-name' )->text() );
+ $htmlOut .= Html::openElement( 'td' );
+ $htmlOut .= Html::openElement( 'select', array( 'name' =>
'project' ) );
+
+ $htmlOut .= Xml::option( $this->msg( 'centralnotice-all'
)->text(), '', '' === $this->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 .= Xml::tags( 'td',
+ array( 'valign' => 'top' ),
+ $this->msg( 'centralnotice-project-lang' )->text() );
+ $htmlOut .= Html::openElement( 'td' );
+
+ // Retrieve the list of languages in user's language
+ $languages = Language::fetchLanguageNames(
$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', array( 'name' =>
'language' ) );
+
+ $htmlOut .= Xml::option( $this->msg( 'centralnotice-all'
)->text(), '', '' === $this->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' );
+ $htmlOut .= Html::openElement( 'tr' );
+ $htmlOut .= Xml::tags( 'td', array(), $this->msg(
'centralnotice-country' )->text() );
+ $htmlOut .= Html::openElement( 'td' );
+
+ $userLanguageCode = $this->getLanguage()->getCode();
+ $countries = GeoTarget::getCountriesList( $userLanguageCode );
+
+ $htmlOut .= Html::openElement( 'select', array( 'name' =>
'country' ) );
+
+ $htmlOut .= Xml::option( $this->msg( 'centralnotice-all'
)->text(), '', '' === $this->location );
+ foreach( $countries as $code => $name ) {
+ $htmlOut .= Xml::option( $name, $code, $code ===
$this->location );
+ }
+
+ $htmlOut .= Html::closeElement( 'select' );
+ $htmlOut .= Html::closeElement( 'td' );
+ $htmlOut .= Html::closeElement( 'tr' );
+ $htmlOut .= Html::closeElement( 'table' );
+
+ $htmlOut .= Xml::tags( 'div',
+ array( 'class' => 'cn-buttons' ),
+ Xml::submitButton( $this->msg(
'centralnotice-apply-filters' )->text() )
+ );
+ $htmlOut .= Html::closeElement( 'form' );
+
+ // End Allocation selection fieldset
+ $htmlOut .= Html::closeElement( 'fieldset' );
+
+ $out->addHTML( $htmlOut );
+
+ $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;
+
+ // Begin building HTML
+ $htmlOut = '';
+
+ // Begin Allocation list fieldset
+ $htmlOut .= Html::openElement( 'fieldset', array( 'class' =>
'prefsection' ) );
+
+ $languageLabel = $this->language ?
+ htmlspecialchars( $this->language ) : $this->msg(
'centralnotice-all' )->text();
+ $projectLabel = $this->language ?
+ htmlspecialchars( $this->project ) : $this->msg(
'centralnotice-all' )->text();
+ $countryLabel = $this->location ?
+ htmlspecialchars( $this->location ) : $this->msg(
'centralnotice-all' )->text();
+
+ $htmlOut .= Xml::tags( 'p', null,
+ $this->msg(
+ 'centralnotice-allocation-description',
+ $languageLabel,
+ $projectLabel,
+ $countryLabel
+ )->text()
+ );
+
+ $activeCampaigns = Campaign::getCampaigns( $this->project,
$this->language, $this->location );
+ $campaigns = array();
+ foreach ( $activeCampaigns as $campaignId ) {
+ $campaignName = Campaign::getNoticeName( $campaignId );
+
+ //FIXME: get campaign settings as of $date
+ $settings = Campaign::getCampaignSettings(
$campaignName, true );
+
+ // omg. implode explode fail
+ if ( $settings['geo'] ) {
+ $settings['countries'] = explode( ", ",
$settings['countries'] );
+ } else {
+ $settings['countries'] = array_keys(
GeoTarget::getCountriesList( 'en' ) );
+ }
+ $settings['projects'] = explode( ", ",
$settings['projects'] );
+ $settings['languages'] = explode( ", ",
$settings['languages'] );
+
+ $campaigns[$campaignName] = $settings;
+ }
+
+ $groupings = $this->analyzeGroupings( $campaigns );
+
+ /*
+ * TODO: need to compare a sample of actual allocations within
each grouping,
+ * because opaque-ish factors like priority might cause some
groupings to be
+ * functionally identical. Merge these together.
+ */
+
+ foreach ( $groupings as $grouping ) {
+ $htmlOut .= Html::element( 'h2', array(), $this->msg(
'centralnotice-notice-heading', $grouping['label'] )->text() );
+
+ $htmlOut .= Html::openElement( 'table',
+ array ( 'cellpadding' => 9, 'class' =>
'wikitable', 'style' => 'margin: 1em 0;' )
+ );
+ $htmlOut .= Html::openElement( 'tr' );
+ $htmlOut .= Html::element( 'th', array( 'width' =>
'30%' ),
+ $this->msg( 'centralnotice-projects' )->text()
);
+ $htmlOut .= Html::element( 'th', array( 'width' =>
'30%' ),
+ $this->msg( 'centralnotice-languages' )->text()
);
+ $htmlOut .= Html::element( 'th', array( 'width' =>
'30%' ),
+ $this->msg( 'centralnotice-countries' )->text()
);
+ $htmlOut .= Html::closeElement( 'tr' );
+
+ foreach ( $grouping['rows'] as $row ) {
+ $htmlOut .= Html::openElement( 'tr', array(
'class'=>'mw-sp-centralnotice-allocationrow' ) );
+
+ $htmlOut .= Html::openElement( 'td' );
+ $htmlOut .= $this->listProjects(
$row['projects'] );
+ $htmlOut .= Html::closeElement( 'td' );
+
+ $htmlOut .= Html::openElement( 'td' );
+ $htmlOut .= $this->listLanguages(
$row['languages'] );
+ $htmlOut .= Html::closeElement( 'td' );
+
+ $htmlOut .= Html::openElement( 'td' );
+ $htmlOut .= $this->listCountries(
$row['countries'] );
+ $htmlOut .= Html::closeElement( 'td' );
+
+ $htmlOut .= Html::closeElement( 'tr' );
+ }
+ $htmlOut .= Html::closeElement( 'table' );
+
+ $htmlOut .= $this->getBannerAllocationsTable(
+ end( $grouping['rows'][0]['projects'] ),
+ end( $grouping['rows'][0]['countries'] ),
+ end( $grouping['rows'][0]['languages'] ),
+ $grouping['rows'][0]['buckets']
+ );
+ }
+
+ if ( !$groupings ) {
+ $htmlOut .= Html::element( 'p', null,
+ $this->msg( 'centralnotice-no-allocation'
)->text() );
+ }
+
+ // End Allocation list fieldset
+ $htmlOut .= Html::closeElement( 'fieldset' );
+
+ $this->getOutput()->addHTML( $htmlOut );
+ }
+
+ /**
+ * Find the groupings in which allocation is uniform, by finding the
+ * disjoint union of campaign criteria. Partition each grouping and
+ * express it as a sum of cartesian products for display in a table.
+ *
+ * Take campaigns C and D, with criteria from x and y: Cx,y = ({a, b},
{1, 2}),
+ * and Dx,y = ({a}, {1, 3}). The intersection will be CDx,y = ({a},
{1}),
+ * and to represent the remaining grouping C-CD will take two
cross-product
+ * rows: Cx,y = ({a}, {2}) + ({b}, {1, 2}).
+ */
+ protected function analyzeGroupings( $campaigns ) {
+ $groupings = array();
+
+ // starting with the intersection of all campaigns, working
towards the
+ // portion of each campaign which does not intersect any
others, record
+ // all distinct groupings.
+ for ( $numIntersecting = count( $campaigns ); $numIntersecting
> 0; $numIntersecting-- ) {
+ $campaignKeys = array_keys( $campaigns );
+ $combinations = self::makeCombinations( $campaignKeys,
$numIntersecting );
+ foreach ( $combinations as $intersectingKeys ) {
+ $excludeKeys = array_diff( $campaignKeys,
$intersectingKeys );
+
+ $result = $campaigns[$intersectingKeys[0]];
+ $contributing = array();
+ $excluding = array();
+
+ foreach ( $intersectingKeys as $key ) {
+ $result = CampaignCriteria::intersect(
$result, $campaigns[$key] );
+
+ // happens to be the campaign name
+ $contributing[] = $key;
+ }
+
+ if ( $result ) {
+ $result = array( $result );
+ } else {
+ $result = array();
+ }
+ foreach ( $excludeKeys as $key ) {
+ foreach( $result as $row ) {
+ if (
CampaignCriteria::intersect( $row, $campaigns[$key] ) ) {
+ $excluding[] = $key;
+ break;
+ }
+ }
+ $result = CampaignCriteria::difference(
$result, $campaigns[$key] );
+ }
+
+ if ( $result ) {
+ sort( $contributing );
+ if ( $excluding ) {
+ sort( $excluding );
+ $label = $this->msg(
'centralnotice-excluding-list',
+
$this->getLanguage()->commaList( $contributing ),
+
$this->getLanguage()->listToText( $excluding )
+ );
+ } else {
+ $label =
$this->getLanguage()->commaList( $contributing );
+ }
+
+ $groupings[] = array(
+ 'label' => $label,
+ 'rows' => $result,
+ );
+ }
+ }
+ }
+
+ return $groupings;
+ }
+
+ /**
+ * Return every (unordered) combination of $num elements from $list
+ * TODO: don't use recursion.
+ */
+ protected static function makeCombinations( array $list, $num ) {
+ if ( $num <= 0 or $num > count( $list ) ) {
+ throw new Exception( "bad arguments to
makeCombinations" );
+ }
+ if ( $num == count( $list ) ) {
+ return array( $list );
+ }
+
+ $initialElement = array_shift( $list );
+
+ // combinations without the first element
+ $combinations = self::makeCombinations( $list, $num );
+
+ // those including the first element
+ if ( $num == 1 ) {
+ $combinations[] = array( $initialElement );
+ } else {
+ foreach ( self::makeCombinations( $list, $num - 1 ) as
$innerCombination ) {
+ array_unshift( $innerCombination,
$initialElement );
+ $combinations[] = $innerCombination;
+ }
+ }
+ return $combinations;
+ }
+
+ /**
+ * Generate the HTML for an allocation table.
+ *
+ * Given a specific campaign-level criteria, display all unique
allocations
+ * variations caused by banner displayAnon, etc. criteria.
+ *
+ * @param $project string Use these campaign-level criteria...
+ * @param $country string
+ * @param $language string
+ * @param $numBuckets array Check allocations in this many buckets
+ * @return string HTML for the table
+ */
+ protected function getBannerAllocationsTable( $project, $country,
$language, $numBuckets ) {
+ // This is annoying. Within the campaign, banners usually vary
by user
+ // logged-in status, and bucket. Determine the allocations and
+ // collapse any dimensions which do not vary.
+ foreach ( array( true, false ) as $isAnon ) {
+ for ( $bucket = 0; $bucket < $numBuckets; $bucket++ ) {
+ $variations[$isAnon][$bucket] =
ApiCentralNoticeAllocations::getAllocationInformation(
+ $project, $country, $language,
+ $isAnon ? 'true' : 'false',
+ $bucket
+ );
+ $allocSignatures = array();
+ foreach ( $variations[$isAnon][$bucket] as
$banner ) {
+ $allocSignatures[] =
"{$banner['name']}:{$banner['allocation']}";
+ }
+ $hashes[$isAnon][$bucket] = sha1( implode( ";",
$allocSignatures ) );
+ }
+ }
+
+ $variesAnon = false;
+ foreach ( range( 0, $numBuckets - 1 ) as $bucket ) {
+ if ( $hashes[0][$bucket] != $hashes[1][$bucket] ) {
+ $variesAnon = true;
+ break;
+ }
+ }
+ if ( !$variesAnon ) {
+ unset( $variations[1] );
+ }
+
+ $variesBucket = ( $numBuckets > 1 );
+
+ $htmlOut = Html::openElement( 'table',
+ array ( 'cellpadding' => 9, 'class' => 'wikitable
sortable', 'style' => 'margin: 1em 0;' )
+ );
+ //$htmlOut .= Html::element( 'caption', array( 'style' =>
'font-size: 1.2em;' ), $caption );
+
+ $htmlOut .= Html::openElement( 'tr' );
+ $htmlOut .= Html::element( 'th', array( 'width' => '5%' ),
+ $this->msg( 'centralnotice-user-role' )->text() );
+ if ( $variesBucket ) {
+ $htmlOut .= Html::element( 'th', array( 'width' => '5%'
),
+ $this->msg( 'centralnotice-bucket' )->text() );
+ }
+ $htmlOut .= Html::element( 'th', array( 'width' => '5%' ),
+ $this->msg( 'centralnotice-percentage' )->text() );
+ $htmlOut .= Html::element( 'th', array( 'width' => '30%' ),
+ $this->msg( 'centralnotice-banner' )->text() );
+ $htmlOut .= Html::element( 'th', array( 'width' => '30%' ),
+ $this->msg( 'centralnotice-notice' )->text() );
+ $htmlOut .= Html::closeElement( 'tr' );
+
+ foreach ( $variations as $isAnon => $bucketVariations ) {
+ foreach ( $bucketVariations as $bucket => $banners ) {
+ foreach ( $banners as $banner ) {
+ $htmlOut .=
$this->getBannerAllocationsVariantRow( $banner, $variesAnon, $variesBucket,
$isAnon, $bucket );
+ }
+ if ( !count( $banners ) ) {
+ $htmlOut .=
$this->getBannerAllocationsVariantRow( null, $variesAnon, $variesBucket,
$isAnon, $bucket );
+ }
+ }
+ }
+
+ $htmlOut .= Html::closeElement( 'table' );
+
+ return $htmlOut;
+ }
+
+ /**
+ * Print one line of banner allocations.
+ */
+ function getBannerAllocationsVariantRow( $banner, $variesAnon,
$variesBucket, $isAnon, $bucket ) {
+ $htmlOut = '';
+
+ $viewBanner = $this->getTitleFor( 'NoticeTemplate', 'view' );
+ $viewCampaign = $this->getTitleFor( 'CentralNotice' );
+
+ // Row begin
+ $htmlOut .= Html::openElement( 'tr', array(
'class'=>'mw-sp-centralnotice-allocationrow' ) );
+
+ if ( !$variesAnon ) {
+ $anonLabel = $this->msg( 'centralnotice-all' )->text();
+ } elseif ( $isAnon ) {
+ $anonLabel = $this->msg(
'centralnotice-user-role-anonymous' )->text();
+ } else {
+ $anonLabel = $this->msg(
'centralnotice-user-role-logged-in' )->text();
+ }
+
+ $htmlOut .= Html::openElement( 'td' );
+ $htmlOut .= $anonLabel;
+ $htmlOut .= Html::closeElement( 'td' );
+
+ if ( $variesBucket ) {
+ $bucketLabel = chr( $bucket + 65 );
+
+ $htmlOut .= Html::openElement( 'td' );
+ $htmlOut .= $bucketLabel;
+ $htmlOut .= Html::closeElement( 'td' );
+ }
+
+ if ( $banner ) {
+ // Percentage
+ $percentage = round( $banner['allocation'] * 100, 2 );
+
+ $htmlOut .= Html::openElement( 'td' );
+ $htmlOut .= $this->msg( 'percent' )->numParams(
$percentage )->escaped();
+ $htmlOut .= Html::closeElement( 'td' );
+
+ // Banner name
+ $htmlOut .= Xml::openElement( 'td', array( 'valign' =>
'top' ) );
+ // The span class is used by bannerstats.js to find
where to insert the stats
+ $htmlOut .= Html::openElement( 'span',
+ array( 'class' =>
'cn-'.$banner['campaign'].'-'.$banner['name'] ) );
+ $htmlOut .= Linker::link(
+ $viewBanner,
+ htmlspecialchars( $banner['name'] ),
+ array(),
+ array( 'template' => $banner['name'] )
+ );
+ $htmlOut .= Html::closeElement( 'span' );
+ $htmlOut .= Html::closeElement( 'td' );
+
+ // Campaign name
+ $htmlOut .= Xml::tags( 'td', array( 'valign' => 'top' ),
+ Linker::link(
+ $viewCampaign,
+ htmlspecialchars( $banner['campaign'] ),
+ array(),
+ array(
+ 'method' => 'listNoticeDetail',
+ 'notice' => $banner['campaign']
+ )
+ )
+ );
+ } else {
+ $htmlOut .= Html::openElement('td');
+ $htmlOut .= Xml::tags( 'p', null, $this->msg(
'centralnotice-no-allocation' )->text() );
+ }
+
+ // Row end
+ $htmlOut .= Html::closeElement( 'tr' );
+
+ return $htmlOut;
+ }
+}
+
+class CampaignCriteria {
+ static protected $criteria = array(
+ 'projects', 'languages', 'countries'
+ );
+
+ public static function intersect( $a, $b ) {
+ if ( !$a or !$b ) {
+ return false;
+ }
+ foreach ( self::$criteria as $property ) {
+ $intersection[$property] = array_intersect(
$a[$property], $b[$property] );
+ // When any criteria are perpendicular, there cannot be
an intersection
+ if ( !$intersection[$property] ) {
+ return false;
+ }
+ }
+ $intersection['buckets'] = max( $a['buckets'], $b['buckets'] );
+ return $intersection;
+ }
+
+ /**
+ * Returns a list of criteria, where each is a simple Cartesian product.
+ *
+ * Taking multiple criteria as an argument helps us do an array_reduce--
+ * The result of a subtraction is usually multiple disjoint sets.
+ *
+ * @param $rows array of CampaignCriteria
+ * @param $b single CampaignCriteria
+ */
+ public static function difference( $rows, $b ) {
+ $newRows = array();
+
+ foreach ( $rows as $row ) {
+ $difference = $row;
+ $difference['buckets'] = max( $row['buckets'],
$b['buckets'] );
+
+ foreach ( self::$criteria as $property ) {
+ $difference[$property] = array_diff(
$row[$property], $b[$property] );
+
+ // This entry contains some points, record it
+ if ( $difference[$property] ) {
+ $newRows[] = $difference;
+ }
+
+ // the next entry only needs to contain the
remainder, so intersect
+ $difference[$property] = array_intersect(
$row[$property], $b[$property] );
+
+ if ( !$difference[$property] ) {
+ break;
+ }
+ }
+ }
+
+ return $newRows;
+ }
+}
--
To view, visit https://gerrit.wikimedia.org/r/55012
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Id10b191bd46ce8c6776506644e4e20d983a6380e
Gerrit-PatchSet: 11
Gerrit-Project: mediawiki/extensions/CentralNotice
Gerrit-Branch: master
Gerrit-Owner: Adamw <[email protected]>
Gerrit-Reviewer: Adamw <[email protected]>
Gerrit-Reviewer: Kaldari <[email protected]>
Gerrit-Reviewer: Mwalker <[email protected]>
Gerrit-Reviewer: Siebrand <[email protected]>
Gerrit-Reviewer: jenkins-bot
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
