plugins/OpenX/OpenXPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Plugin for OpenX ad server
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Ads
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2010 StatusNet Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Plugin for OpenX Ad Server
  36  *
  37  * This plugin supports the OpenX ad server, http://www.openx.org/
  38  *
  39  * We support the 4 ad sizes for the Universal Ad Platform (UAP):
  40  *
  41  *     Medium Rectangle
  42  *     (Small) Rectangle
  43  *     Leaderboard
  44  *     Wide Skyscraper
  45  *
  46  * They fit in different places on the default theme. Some themes
  47  * might interact quite poorly with this plugin.
  48  *
  49  * To enable advertising, you will need an OpenX server. You'll need
  50  * to set up a "zone" for your StatusNet site that identifies a
  51  * kind of ad you want to place (of the above 4 sizes).
  52  *
  53  * Add the plugin to config.php like so:
  54  *
  55  *     addPlugin('OpenX', array('adScript' => 'full path to script',
  56  *                              'rectangle' => 1));
  57  *
  58  * Here, the 'adScript' parameter is the full path to the OpenX
  59  * ad script, like 'http://example.com/www/delivery/ajs.php'. Note
  60  * that we don't do any magic to swap between HTTP and HTTPS, so
  61  * if you want HTTPS, say so.
  62  *
  63  * The 'rectangle' parameter is the zone ID for that ad space on
  64  * your site. If you've configured another size, try 'mediumRectangle',
  65  * 'leaderboard', or 'wideSkyscraper'.
  66  *
  67  * If for some reason your ad server is different from the default,
  68  * use the 'adScript' parameter to set the full path to the ad script.
  69  *
  70  * @category Ads
  71  * @package  StatusNet
  72  * @author   Evan Prodromou <evan@status.net>
  73  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  74  * @link     http://status.net/
  75  *
  76  * @seeAlso  UAPPlugin
  77  */
  78 class OpenXPlugin extends UAPPlugin
  79 {
  80     public $adScript = null;
  81
  82     function initialize()
  83     {
  84         parent::initialize();
  85
  86         // A little bit of chicanery so we avoid overwriting values that
  87         // are passed in with the constructor
  88         foreach (array('mediumRectangle', 'rectangle', 'leaderboard', 'wideSkyscraper', 'adScript') as $setting) {
  89             $value = common_config('openx', $setting);
  90             if (!empty($value)) { // not found
  91                 $this->$setting = $value;
  92             }
  93         }
  94
  95         return true;
  96     }
  97
  98     /**
  99      * Show a medium rectangle 'ad'
 100      *
 101      * @param Action $action Action being shown
 102      *
 103      * @return void
 104      */
 105     protected function showMediumRectangle($action)
 106     {
 107         $this->showAd($action, $this->mediumRectangle);
 108     }
 109
 110     /**
 111      * Show a rectangle 'ad'
 112      *
 113      * @param Action $action Action being shown
 114      *
 115      * @return void
 116      */
 117     protected function showRectangle($action)
 118     {
 119         $this->showAd($action, $this->rectangle);
 120     }
 121
 122     /**
 123      * Show a wide skyscraper ad
 124      *
 125      * @param Action $action Action being shown
 126      *
 127      * @return void
 128      */
 129     protected function showWideSkyscraper($action)
 130     {
 131         $this->showAd($action, $this->wideSkyscraper);
 132     }
 133
 134     /**
 135      * Show a leaderboard ad
 136      *
 137      * @param Action $action Action being shown
 138      *
 139      * @return void
 140      */
 141     protected function showLeaderboard($action)
 142     {
 143         $this->showAd($action, $this->leaderboard);
 144     }
 145
 146     /**
 147      * Show an ad using OpenX
 148      *
 149      * @param Action  $action Action being shown
 150      * @param integer $zone   Zone to show
 151      *
 152      * @return void
 153      */
 154     protected function showAd($action, $zone)
 155     {
 156 $scr = <<<ENDOFSCRIPT
 157 var m3_u = '%s';
 158 var m3_r = Math.floor(Math.random()*99999999999);
 159 if (!document.MAX_used) document.MAX_used = ',';
 160 document.write ("<scr"+"ipt type='text/javascript' src='"+m3_u);
 161 document.write ("?zoneid=%d");
 162 document.write ('&amp;cb=' + m3_r);
 163 if (document.MAX_used != ',') document.write ("&amp;exclude=" + document.MAX_used);
 164 document.write (document.charset ? '&amp;charset='+document.charset : (document.characterSet ? '&amp;charset='+document.characterSet : ''));
 165 document.write ("&amp;loc=" + escape(window.location));
 166 if (document.referrer) document.write ("&amp;referer=" + escape(document.referrer));
 167 if (document.context) document.write ("&context=" + escape(document.context));
 168 if (document.mmm_fo) document.write ("&amp;mmm_fo=1");
 169 document.write ("'><\/scr"+"ipt>");
 170 ENDOFSCRIPT;
 171
 172         $action->inlineScript(sprintf($scr, $this->adScript, $zone));
 173         return true;
 174     }
 175
 176     function onRouterInitialized(URLMapper $m)
 177     {
 178         $m->connect('panel/openx',
 179                     array('action' => 'openxadminpanel'));
 180
 181         return true;
 182     }
 183
 184     function onEndAdminPanelNav(Menu $menu) {
 185         if (AdminPanelAction::canAdmin('openx')) {
 186             // TRANS: Menu item title.
 187             $menu_title = _m('OpenX configuration.');
 188             // TRANS: Menu item for site administration
 189             $menu->out->menuItem(common_local_url('openxadminpanel'), _m('OpenX'),
 190                                  $menu_title, $action_name == 'openxadminpanel', 'nav_openx_admin_panel');
 191         }
 192         return true;
 193     }
 194
 195     /**
 196      * Add our version information to output
 197      *
 198      * @param array &$versions Array of version-data arrays
 199      *
 200      * @return boolean hook value
 201      */
 202     function onPluginVersion(array &$versions)
 203     {
 204         $versions[] = array('name' => 'OpenX',
 205                             'version' => GNUSOCIAL_VERSION,
 206                             'author' => 'Evan Prodromou',
 207                             'homepage' => 'http://status.net/wiki/Plugin:OpenX',
 208                             'rawdescription' =>
 209                             // TRANS: Plugin description.
 210                             _m('Plugin for <a href="http://www.openx.org/">OpenX Ad Server</a>.'));
 211         return true;
 212     }
 213 }