http://www.mediawiki.org/wiki/Special:Code/MediaWiki/72932
Revision: 72932
Author: kaldari
Date: 2010-09-13 21:05:14 +0000 (Mon, 13 Sep 2010)
Log Message:
-----------
adding schema changes for geotargetting, adding BannerController class
Modified Paths:
--------------
trunk/extensions/CentralNotice/CentralNotice.php
trunk/extensions/CentralNotice/SpecialBannerListLoader.php
trunk/extensions/CentralNotice/SpecialBannerLoader.php
Added Paths:
-----------
trunk/extensions/CentralNotice/SpecialBannerController.php
trunk/extensions/CentralNotice/patches/patch-notice_geo.sql
Modified: trunk/extensions/CentralNotice/CentralNotice.php
===================================================================
--- trunk/extensions/CentralNotice/CentralNotice.php 2010-09-13 20:39:51 UTC
(rev 72931)
+++ trunk/extensions/CentralNotice/CentralNotice.php 2010-09-13 21:05:14 UTC
(rev 72932)
@@ -83,25 +83,28 @@
$wgHooks['MakeGlobalVariablesScript'][] =
'efCentralNoticeDefaults';
$wgHooks['SiteNoticeAfter'][] = 'efCentralNoticeDisplay';
}
+
+ $wgSpecialPages['BannerLoader'] = 'SpecialBannerLoader';
+ $wgAutoloadClasses['SpecialBannerLoader'] = $dir .
'SpecialBannerLoader.php';
+
+ $wgSpecialPages['BannerListLoader'] = 'SpecialBannerListLoader';
+ $wgAutoloadClasses['SpecialBannerListLoader'] = $dir .
'SpecialBannerListLoader.php';
+
+ $wgSpecialPages['BannerController'] = 'SpecialBannerController';
+ $wgAutoloadClasses['SpecialBannerController'] = $dir .
'SpecialBannerController.php';
- $wgAutoloadClasses['NoticePage'] = $dir . 'NoticePage.php';
-
if ( $wgNoticeInfrastructure ) {
$wgSpecialPages['CentralNotice'] = 'CentralNotice';
$wgSpecialPageGroups['CentralNotice'] = 'wiki'; // Wiki data
and tools"
$wgAutoloadClasses['CentralNotice'] = $dir .
'SpecialCentralNotice.php';
- $wgSpecialPages['BannerLoader'] = 'SpecialBannerLoader';
- $wgAutoloadClasses['SpecialBannerLoader'] = $dir .
'SpecialBannerLoader.php';
+ $wgSpecialPages['NoticeTemplate'] = 'SpecialNoticeTemplate';
+ $wgAutoloadClasses['SpecialNoticeTemplate'] = $dir .
'SpecialNoticeTemplate.php';
- $wgSpecialPages['BannerListLoader'] = 'SpecialBannerListLoader';
- $wgAutoloadClasses['SpecialBannerListLoader'] = $dir .
'SpecialBannerListLoader.php';
-
+ // remove these as soon as banner loader is complete
$wgSpecialPages['NoticeText'] = 'SpecialNoticeText';
$wgAutoloadClasses['SpecialNoticeText'] = $dir .
'SpecialNoticeText.php';
-
- $wgSpecialPages['NoticeTemplate'] = 'SpecialNoticeTemplate';
- $wgAutoloadClasses['SpecialNoticeTemplate'] = $dir .
'SpecialNoticeTemplate.php';
+ $wgAutoloadClasses['NoticePage'] = $dir . 'NoticePage.php';
$wgAutoloadClasses['CentralNoticeDB'] = $dir .
'CentralNotice.db.php';
$wgAutoloadClasses['TemplatePager'] = $dir .
'TemplatePager.php';
@@ -117,6 +120,7 @@
$wgExtNewFields[] = array( 'cn_notices', 'not_preferred', $base
. '/patches/patch-notice_preferred.sql' );
$wgExtNewTables[] = array( 'cn_notice_languages', $base .
'/patches/patch-notice_languages.sql' );
$wgExtNewFields[] = array( 'cn_templates', 'tmp_display_anon',
$base . '/patches/patch-template_settings.sql' );
+ $wgExtNewTables[] = array( 'cn_notice_geo', $base .
'/patches/patch-notice_geo.sql' );
}
return true;
}
@@ -124,7 +128,7 @@
function efCentralNoticeLoader( $out, $skin ) {
global $wgUser, $wgOut;
- $centralLoader = SpecialPage::getTitleFor( 'NoticeText'
)->getLocalUrl();
+ $centralLoader = SpecialPage::getTitleFor( 'BannerController'
)->getLocalUrl();
// Insert the banner controller Javascript into the <head>
$wgOut->addScriptFile( $centralLoader );
Added: trunk/extensions/CentralNotice/SpecialBannerController.php
===================================================================
--- trunk/extensions/CentralNotice/SpecialBannerController.php
(rev 0)
+++ trunk/extensions/CentralNotice/SpecialBannerController.php 2010-09-13
21:05:14 UTC (rev 72932)
@@ -0,0 +1,199 @@
+<?php
+
+/**
+ * Generates Javascript file which controls banner selection on the client side
+ */
+class SpecialBannerController extends UnlistedSpecialPage {
+ public $centralNoticeDB;
+ protected $sharedMaxAge = 150; // Cache for ? minutes on the server side
+ protected $maxAge = 150; // Cache for ? minutes on the client side
+ protected $contentType = 'text/javascript';
+
+ function __construct() {
+ // Register special page
+ parent::__construct( "BannerController" );
+ $this->centralNoticeDB = new CentralNoticeDB();
+ }
+
+ function execute( $par ) {
+ global $wgOut, $wgRequest;
+ global $wgNoticeLang, $wgNoticeProject;
+
+ $wgOut->disable();
+ $this->sendHeaders();
+
+ $content = $this->getOutput();
+ if ( strlen( $content ) == 0 ) {
+ // Hack for IE/Mac 0-length keepalive problem, see
RawPage.php
+ echo "/* Empty */";
+ } else {
+ echo $content;
+ }
+
+ }
+
+ /**
+ * Generate the HTTP response headers for the banner controller
+ */
+ function sendHeaders() {
+ header( "Content-type: $this->contentType; charset=utf-8" );
+ header( "Cache-Control: public, s-maxage=$this->sharedMaxAge,
max-age=$this->maxAge" );
+ }
+
+ /**
+ * Generate the body for a static Javascript file
+ */
+ function getOutput() {
+ $js = $this->getScriptFunctions() . $this->getToggleScripts();
+ $js .= <<<EOT
+( function( $ ) {
+ $.centralNotice = {
+ 'data': {
+ 'getVars': {}
+ },
+ 'fn': {
+ 'loadBanner': function( bannerName ) {
+ // get the requested banner from
/centralnotice/banners/<bannername>/<wgUserLanguage>.js
+ var bannerPage =
'Special:BannerLoader?banner='+bannerName+'&userlang='+wgContentLanguage+'&sitename='+wgNoticeProject;
+ //centralized version:
+ //var bannerURL =
'http://meta.wikimedia.org/wiki/'+bannerPage;
+ //var bannerURL = wgArticlePath.replace( '$1',
bannerPage );
+ var bannerURL =
'http://localhost/~rkaldari/banner.html';
+ var request = $.ajax( {
+ url: bannerURL,
+ dataType: 'html',
+ success: function( data ) {
+
$.centralNotice.fn.displayBanner( data );
+ }
+ });
+ },
+ 'loadBannerList': function( timestamp ) {
+ var listURL;
+ if ( timestamp ) {
+ listURL = "TBD"
+ } else {
+ // http://geoiplookup.wikimedia.org/
+ var geoLocation = 'US'; // Hard-coding
for now
+ var bannerListPage =
'Special:BannerListLoader?language='+wgContentLanguage+'&project='+wgNoticeProject+'&location='+geoLocation;
+ //centralized version:
+ //var bannerListURL =
'http://meta.wikimedia.org/wiki/'+bannerListPage;
+ var bannerListURL =
wgArticlePath.replace( '$1', bannerListPage );
+ }
+ var request = $.ajax( {
+ url: bannerListURL,
+ dataType: 'json',
+ success: $.centralNotice.fn.chooseBanner
+ } );
+ },
+ 'chooseBanner': function( bannerList ) {
+ // convert the json object to a true array
+ bannerList = Array.prototype.slice.call(
bannerList );
+
+ // Make sure there are some banners to choose
from
+ if ( bannerList.length == 0 ) return false;
+
+ var groomedBannerList = [];
+
+ for( var i = 0; i < bannerList.length; i++ ) {
+ // only include this banner if it's
inteded for the current user
+ if( ( wgUserName ?
bannerList[i].display_account == 1 : bannerList.display_anon == 1 ) ) {
+ // add the banner to our list
once per weight
+ for( var j=0; j <
bannerList[i].weight; j++ ) {
+ groomedBannerList.push(
bannerList[i] );
+ }
+ }
+ }
+
+ // return if there's nothing left after the
grooming
+ if( groomedBannerList.length == 0 ) return
false;
+ // load a random banner from our groomed list
+
+ $.centralNotice.fn.loadBanner(
+ groomedBannerList[ Math.floor(
Math.random() * groomedBannerList.length ) ].name
+ );
+ },
+ 'displayBanner': function( bannerHTML ) {
+ // inject the banner html into the page
+ $( '#siteNotice' )
+ .prepend( '<div id="centralnotice"
class="' + ( wgNoticeToggleState ? 'expanded' : 'collapsed' ) + '">' +
bannerHTML + '</div>' );
+ },
+ 'getQueryStringVariables': function() {
+ document.location.search.replace(
/\??(?:([^=]+)=([^&]*)&?)/g, function () {
+ function decode( s ) {
+ return decodeURIComponent(
s.split( "+" ).join( " " ) );
+ }
+ $.centralNotice.data.getVars[decode(
arguments[1] )] = decode( arguments[2] );
+ } );
+ }
+ }
+ }
+ $( document ).ready( function () {
+ // initialize the query string vars
+ $.centralNotice.fn.getQueryStringVariables();
+ if( $.centralNotice.data.getVars['forceBanner'] ) {
+ // if we're forcing one banner
+ $.centralNotice.fn.loadBanner(
$.centralNotice.data.getVars['forceBanner'] );
+ } else if ( $.centralNotice.data.getVars['forceTimestamp'] ) {
+ // if we're forcing a future campaign time
+ $.centralNotice.fn.loadBannerList(
$.centralNotice.data.getVars['forceTimestamp'] );
+ } else {
+ // look for banners ready to go NOW
+ $.centralNotice.fn.loadBannerList( );
+ }
+ } ); //document ready
+} )( jQuery );
+EOT;
+ return $js;
+
+ }
+
+ function getToggleScripts() {
+ $showStyle = <<<END
+<style type="text/css">
+#centralNotice .siteNoticeSmall {display:none;}
+#centralNotice .siteNoticeSmallAnon {display:none;}
+#centralNotice .siteNoticeSmallUser {display:none;}
+#centralNotice.collapsed .siteNoticeBig {display:none;}
+#centralNotice.collapsed .siteNoticeSmall {display:block;}
+#centralNotice.collapsed .siteNoticeSmallUser {display:block;}
+#centralNotice.collapsed .siteNoticeSmallAnon {display:block;}
+#centralNotice.anonnotice .siteNoticeSmallUser {display:none !important;}
+#centralNotice.usernotice .siteNoticeSmallAnon {display:none !important;}
+</style>
+END;
+ $encShowStyle = Xml::encodeJsVar( $showStyle );
+
+ $script = "
+var wgNoticeToggleState = (document.cookie.indexOf('hidesnmessage=1')==-1);
+document.writeln($encShowStyle);\n\n";
+ return $script;
+ }
+
+ function getScriptFunctions() {
+ $script = "
+function toggleNotice() {
+ var notice = document.getElementById('centralNotice');
+ if (!wgNoticeToggleState) {
+ notice.className = notice.className.replace('collapsed',
'expanded');
+ toggleNoticeCookie('0');
+ } else {
+ notice.className = notice.className.replace('expanded',
'collapsed');
+ toggleNoticeCookie('1');
+ }
+ wgNoticeToggleState = !wgNoticeToggleState;
+}
+function toggleNoticeStyle(elems, display) {
+ if(elems)
+ for(var i=0;i<elems.length;i++)
+ elems[i].style.display = display;
+}
+function toggleNoticeCookie(state) {
+ var e = new Date();
+ e.setTime( e.getTime() + (7*24*60*60*1000) ); // one week
+ var work='hidesnmessage='+state+'; expires=' + e.toGMTString() + ';
path=/';
+ document.cookie = work;
+}\n\n";
+ return $script;
+ }
+
+}
Modified: trunk/extensions/CentralNotice/SpecialBannerListLoader.php
===================================================================
--- trunk/extensions/CentralNotice/SpecialBannerListLoader.php 2010-09-13
20:39:51 UTC (rev 72931)
+++ trunk/extensions/CentralNotice/SpecialBannerListLoader.php 2010-09-13
21:05:14 UTC (rev 72932)
@@ -7,8 +7,8 @@
public $project; // Project name
public $language; // Project language
public $centralNoticeDB;
- protected $sharedMaxAge = 22; // Cache for ? minutes on the server side
- protected $maxAge = 10; // Cache for ? minutes on the client side
+ protected $sharedMaxAge = 150; // Cache for ? minutes on the server side
+ protected $maxAge = 150; // Cache for ? minutes on the client side
protected $contentType = 'text/javascript';
function __construct() {
Modified: trunk/extensions/CentralNotice/SpecialBannerLoader.php
===================================================================
--- trunk/extensions/CentralNotice/SpecialBannerLoader.php 2010-09-13
20:39:51 UTC (rev 72931)
+++ trunk/extensions/CentralNotice/SpecialBannerLoader.php 2010-09-13
21:05:14 UTC (rev 72932)
@@ -6,7 +6,7 @@
class SpecialBannerLoader extends UnlistedSpecialPage {
public $siteName = 'Wikipedia'; // Site name
public $language = 'en'; // User language
- protected $sharedMaxAge = 22; // Cache for 2 hours on the server side
+ protected $sharedMaxAge = 150; // Cache for 2 hours on the server side
protected $maxAge = 0; // No client-side banner caching so we get all
impressions
protected $contentType = 'text/html';
Added: trunk/extensions/CentralNotice/patches/patch-notice_geo.sql
===================================================================
--- trunk/extensions/CentralNotice/patches/patch-notice_geo.sql
(rev 0)
+++ trunk/extensions/CentralNotice/patches/patch-notice_geo.sql 2010-09-13
21:05:14 UTC (rev 72932)
@@ -0,0 +1,8 @@
+-- Update to allow for any number of languages per notice.
+
+CREATE TABLE IF NOT EXISTS /*$wgDBprefix*/cn_notice_geo (
+ ng_notice_id int unsigned NOT NULL,
+ ng_country varchar(2) NOT NULL
+) /*$wgDBTableOptions*/;
+CREATE UNIQUE INDEX /*i*/ng_notice_id_geo ON /*$wgDBprefix*/cn_notice_geo
(ng_notice_id, ng_country);
+ALTER TABLE /*$wgDBprefix*/cn_notices ADD not_geo BOOLEAN NOT NULL DEFAULT '0'
AFTER not_locked;
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
