AdsensePlugin.php 6.15 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Plugin for Google Adsense
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Ads
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2010 StatusNet Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    exit(1);
}

/**
 * Plugin to add Google Adsense to StatusNet sites
 *
 * This plugin lets you add Adsense ad units to your StatusNet site.
 *
 * We support the 4 ad sizes for the Universal Ad Platform (UAP):
 *
 *     Medium Rectangle
 *     (Small) Rectangle
 *     Leaderboard
 *     Wide Skyscraper
 *
 * They fit in different places on the default theme. Some themes
 * might interact quite poorly with this plugin.
 *
 * To enable advertising, you must sign up with Google Adsense and
 * get a client ID.
 *
 *     https://www.google.com/adsense/
 *
 * You'll also need to create an Adsense for Content unit in one
 * of the four sizes described above. At the end of the process,
 * note the "google_ad_client" and "google_ad_slot" values in the
 * resultant Javascript.
 *
 * Add the plugin to config.php like so:
 *
 *     addPlugin('Adsense', array('client' => 'Your client ID',
 *                                'rectangle' => 'slot'));
 *
 * Here, your client ID is the value of google_ad_client and the
 * slot is the value of google_ad_slot. Note that if you create
 * a different size, you'll need to provide different arguments:
 * 'mediumRectangle', 'leaderboard', or 'wideSkyscraper'.
 *
 * If for some reason your ad server is different from the default,
 * use the 'adScript' parameter to set the full path to the ad script.
 *
 * @category Plugin
 * @package  StatusNet
 * @author   Evan Prodromou <evan@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 *
 * @seeAlso  UAPPlugin
 */
class AdsensePlugin extends UAPPlugin
{
    public $adScript = 'http://pagead2.googlesyndication.com/pagead/show_ads.js';
    public $client   = null;

Evan Prodromou's avatar
Evan Prodromou committed
85 86 87 88 89 90 91 92 93 94 95 96 97 98
    function initialize()
    {
        parent::initialize();

        // A little bit of chicanery so we avoid overwriting values that
        // are passed in with the constructor
        foreach (array('mediumRectangle', 'rectangle', 'leaderboard', 'wideSkyscraper', 'adScript', 'client') as $setting) {
            $value = common_config('adsense', strtolower($setting));
            if (!empty($value)) { // not found
                $this->$setting = $value;
            }
        }
    }

99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
    /**
     * Show a medium rectangle 'ad'
     *
     * @param Action $action Action being shown
     *
     * @return void
     */
    protected function showMediumRectangle($action)
    {
        $this->showAdsenseCode($action, 300, 250, $this->mediumRectangle);
    }

    /**
     * Show a rectangle 'ad'
     *
     * @param Action $action Action being shown
     *
     * @return void
     */
    protected function showRectangle($action)
    {
        $this->showAdsenseCode($action, 180, 150, $this->rectangle);
    }

    /**
     * Show a wide skyscraper ad
     *
     * @param Action $action Action being shown
     *
     * @return void
     */
    protected function showWideSkyscraper($action)
    {
        $this->showAdsenseCode($action, 160, 600, $this->wideSkyscraper);
    }

    /**
     * Show a leaderboard ad
     *
     * @param Action $action Action being shown
     *
     * @return void
     */
    protected function showLeaderboard($action)
    {
        $this->showAdsenseCode($action, 728, 90, $this->leaderboard);
    }

    /**
     * Output the bits of JavaScript code to show Adsense
     *
     * @param Action  $action Action being shown
     * @param integer $width  Width of the block
     * @param integer $height Height of the block
     * @param string  $slot   Slot identifier
     *
     * @return void
     */
    protected function showAdsenseCode($action, $width, $height, $slot)
    {
        $code  = 'google_ad_client = "'.$this->client.'"; ';
        $code .= 'google_ad_slot = "'.$slot.'"; ';
161 162
        $code .= 'google_ad_width = '.$width.'; ';
        $code .= 'google_ad_height = '.$height.'; ';
163 164 165 166 167

        $action->inlineScript($code);

        $action->script($this->adScript);
    }
Evan Prodromou's avatar
Evan Prodromou committed
168 169 170

    function onRouterInitialized($m)
    {
Evan Prodromou's avatar
Evan Prodromou committed
171
        $m->connect('panel/adsense',
Evan Prodromou's avatar
Evan Prodromou committed
172 173 174 175 176 177 178 179
                    array('action' => 'adsenseadminpanel'));

        return true;
    }

    function onEndAdminPanelNav($menu) {
        if (AdminPanelAction::canAdmin('adsense')) {
            // TRANS: Menu item title/tooltip
Siebrand Mazeland's avatar
Siebrand Mazeland committed
180
            $menu_title = _m('AdSense configuration');
Evan Prodromou's avatar
Evan Prodromou committed
181
            // TRANS: Menu item for site administration
182
            $menu->out->menuItem(common_local_url('adsenseadminpanel'), _m('MENU','AdSense'),
Evan Prodromou's avatar
Evan Prodromou committed
183 184 185 186
                                 $menu_title, $action_name == 'adsenseadminpanel', 'nav_adsense_admin_panel');
        }
        return true;
    }
Siebrand Mazeland's avatar
Siebrand Mazeland committed
187 188 189 190 191 192 193 194

    function onPluginVersion(&$versions)
    {
        $versions[] = array('name' => 'BlankAdPlugin',
                            'version' => STATUSNET_VERSION,
                            'author' => 'Evan Prodromou',
                            'homepage' => 'http://status.net/wiki/Plugin:Adsense',
                            'rawdescription' =>
195
                            // TRANS: Plugin description.
196
                            _m('Plugin to add Google AdSense to StatusNet sites.'));
Siebrand Mazeland's avatar
Siebrand Mazeland committed
197 198
        return true;
    }
Siebrand Mazeland's avatar
Siebrand Mazeland committed
199
}