summaryrefslogtreecommitdiff
path: root/plugins/UAP/UAPPlugin.php
blob: 13c1017230feca80331bdca362ef5f2988425d11 (plain)
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * UAP (Universal Ad Package) plugin
 *
 * 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  Action
 * @package   StatusNet
 * @author    Sarven Capadisli <csarven@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') && !defined('LACONICA')) {
    exit(1);
}

/**
 * Outputs the following ad types (based on UAP):
 * Medium Rectangle 300x250
 * Rectangle        180x150
 * Leaderboard      728x90
 * Wide Skyscraper  160x600
 *
 * Any number of ad types can be used. Enable all using example:
 * addPlugin('UAP', array(
 *  'MediumRectangle' => '<script type="text/javascript">var foo = 1;</script>',
 *  'Rectangle' => '<script type="text/javascript">var bar = 2;</script>',
 *  'Leaderboard' => '<script type="text/javascript">var baz = 2;</script>',
 *  'WideSkyscraper' => '<script type="text/javascript">var bbq = 4;</script>'
 *  )
 * );
 *
 * @category Plugin
 * @package  StatusNet
 * @author   Sarven Capadisli <csarven@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/
 */

class UAPPlugin extends Plugin
{
    public $MediumRectangle = null;
    public $Rectangle = null;
    public $Leaderboard = null;
    public $WideSkyscraper = null;

    function __construct($uap = array())
    {
        $this->uap = $uap;

        parent::__construct();
    }

    function onInitializePlugin()
    {
        foreach($this->uap as $key => $value) {
            switch(strtolower($key)) {
                case 'MediumRectangle': default:
                    $this->MediumRectangle = $value;
                    break;
                case 'Rectangle':
                    $this->Rectangle = $value;
                    break;
                case 'Leaderboard':
                    $this->Leaderboard = $value;
                    break;
                case 'WideSkyscraper':
                    $this->WideSkyscraper = $value;
                    break;
            }
        }
    }

    function onEndShowStatusNetStyles($action)
    {
        $action->cssLink(common_path('plugins/UAP/uap.css'),
                         null, 'screen, projection, tv');
        return true;
    }

    //MediumRectangle ad
    function onStartShowAside($action)
    {
        if (!$this->MediumRectangle) {
            return true;
        }

        $this->showAd($action, array('id' => 'ad_medium-rectangle'), 
                               $this->MediumRectangle);

        return true;
    }

/*
    //Rectangle ad
    function onEndShowSiteNotice($action)
    {
        if (!$this->Rectangle) {
            return true;
        }

        $this->showAd($action, array('id' => 'ad_rectangle'), 
                               $this->Rectangle);

        return true;
    }
*/

    //Leaderboard and Rectangle ad
    function onStartShowHeader($action)
    {
        if ($this->Leaderboard) {
            $this->showAd($action, array('id' => 'ad_leaderboard'), 
                                   $this->Leaderboard);
        }

        if ($this->Rectangle) {
            $this->showAd($action, array('id' => 'ad_rectangle'), 
                                   $this->Rectangle);
        }

        return true;
    }

    //WideSkyscraper ad
    function onEndShowAside($action)
    {
        if (!$this->WideSkyscraper) {
            return true;
        }

        $this->showAd($action, array('id' => 'ad_wide-skyscraper'), 
                               $this->WideSkyscraper);

        return true;
    }

    //Output ad container
    function showAd($action, $attr=array(), $value)
    {
        $classes = ($attr['class']) ? $attr['class'].' ' : '';

        $action->elementStart('div', array('id' => $attr['id'],
                                           'class' => $classes.'ad'));
        $action->raw($value);
        $action->elementEnd('div');
    }

    function onPluginVersion(&$versions)
    {
        $versions[] = array('name' => 'UAP',
                            'version' => STATUSNET_VERSION,
                            'author' => 'Sarven Capadisli',
                            'homepage' => 'http://status.net/wiki/Plugin:UAP',
                            'rawdescription' =>
                            _m('Outputs ad placements based on Universal Ad Package'));
        return true;
    }
}