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
  79 class OpenXPlugin extends UAPPlugin
  80 {
  81     public $adScript = null;
  82
  83     function initialize()
  84     {
  85         parent::initialize();
  86
  87         // A little bit of chicanery so we avoid overwriting values that
  88         // are passed in with the constructor
  89         foreach (array('mediumRectangle', 'rectangle', 'leaderboard', 'wideSkyscraper', 'adScript') as $setting) {
  90             $value = common_config('openx', $setting);
  91             if (!empty($value)) { // not found
  92                 $this->$setting = $value;
  93             }
  94         }
  95
  96         return true;
  97     }
  98
  99     /**
 100      * Show a medium rectangle 'ad'
 101      *
 102      * @param Action $action Action being shown
 103      *
 104      * @return void
 105      */
 106
 107     protected function showMediumRectangle($action)
 108     {
 109         $this->showAd($action, $this->mediumRectangle);
 110     }
 111
 112     /**
 113      * Show a rectangle 'ad'
 114      *
 115      * @param Action $action Action being shown
 116      *
 117      * @return void
 118      */
 119
 120     protected function showRectangle($action)
 121     {
 122         $this->showAd($action, $this->rectangle);
 123     }
 124
 125     /**
 126      * Show a wide skyscraper ad
 127      *
 128      * @param Action $action Action being shown
 129      *
 130      * @return void
 131      */
 132
 133     protected function showWideSkyscraper($action)
 134     {
 135         $this->showAd($action, $this->wideSkyscraper);
 136     }
 137
 138     /**
 139      * Show a leaderboard ad
 140      *
 141      * @param Action $action Action being shown
 142      *
 143      * @return void
 144      */
 145
 146     protected function showLeaderboard($action)
 147     {
 148         $this->showAd($action, $this->leaderboard);
 149     }
 150
 151     /**
 152      * Show an ad using OpenX
 153      *
 154      * @param Action  $action Action being shown
 155      * @param integer $zone   Zone to show
 156      *
 157      * @return void
 158      */
 159
 160     protected function showAd($action, $zone)
 161     {
 162 $scr = <<<ENDOFSCRIPT
 163 var m3_u = '%s';
 164 var m3_r = Math.floor(Math.random()*99999999999);
 165 if (!document.MAX_used) document.MAX_used = ',';
 166 document.write ("<scr"+"ipt type='text/javascript' src='"+m3_u);
 167 document.write ("?zoneid=%d");
 168 document.write ('&amp;cb=' + m3_r);
 169 if (document.MAX_used != ',') document.write ("&amp;exclude=" + document.MAX_used);
 170 document.write (document.charset ? '&amp;charset='+document.charset : (document.characterSet ? '&amp;charset='+document.characterSet : ''));
 171 document.write ("&amp;loc=" + escape(window.location));
 172 if (document.referrer) document.write ("&amp;referer=" + escape(document.referrer));
 173 if (document.context) document.write ("&context=" + escape(document.context));
 174 if (document.mmm_fo) document.write ("&amp;mmm_fo=1");
 175 document.write ("'><\/scr"+"ipt>");
 176 ENDOFSCRIPT;
 177
 178         $action->inlineScript(sprintf($scr, $this->adScript, $zone));
 179         return true;
 180     }
 181
 182     function onRouterInitialized($m)
 183     {
 184         $m->connect('admin/openx',
 185                     array('action' => 'openxadminpanel'));
 186
 187         return true;
 188     }
 189
 190     function onAutoload($cls)
 191     {
 192         $dir = dirname(__FILE__);
 193
 194         switch ($cls)
 195         {
 196         case 'OpenxadminpanelAction':
 197             require_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
 198             return false;
 199         default:
 200             return true;
 201         }
 202     }
 203
 204     function onEndAdminPanelNav($menu) {
 205         if (AdminPanelAction::canAdmin('openx')) {
 206             // TRANS: Menu item title/tooltip
 207             $menu_title = _m('OpenX configuration');
 208             // TRANS: Menu item for site administration
 209             $menu->out->menuItem(common_local_url('openxadminpanel'), _m('OpenX'),
 210                                  $menu_title, $action_name == 'openxadminpanel', 'nav_openx_admin_panel');
 211         }
 212         return true;
 213     }
 214 }