]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/OpenX/OpenXPlugin.php
Just a label change. Since the user already went ahead with
[quix0rs-gnu-social.git] / 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     /**
84      * Show a medium rectangle 'ad'
85      *
86      * @param Action $action Action being shown
87      *
88      * @return void
89      */
90
91     protected function showMediumRectangle($action)
92     {
93         $this->showAd($action, $this->mediumRectangle);
94     }
95
96     /**
97      * Show a rectangle 'ad'
98      *
99      * @param Action $action Action being shown
100      *
101      * @return void
102      */
103
104     protected function showRectangle($action)
105     {
106         $this->showAd($action, $this->rectangle);
107     }
108
109     /**
110      * Show a wide skyscraper ad
111      *
112      * @param Action $action Action being shown
113      *
114      * @return void
115      */
116
117     protected function showWideSkyscraper($action)
118     {
119         $this->showAd($action, $this->wideSkyscraper);
120     }
121
122     /**
123      * Show a leaderboard ad
124      *
125      * @param Action $action Action being shown
126      *
127      * @return void
128      */
129
130     protected function showLeaderboard($action)
131     {
132         $this->showAd($action, $this->leaderboard);
133     }
134
135     /**
136      * Show an ad using OpenX
137      *
138      * @param Action  $action Action being shown
139      * @param integer $zone   Zone to show
140      *
141      * @return void
142      */
143
144     protected function showAd($action, $zone)
145     {
146 $scr = <<<ENDOFSCRIPT
147 var m3_u = '%s';
148 var m3_r = Math.floor(Math.random()*99999999999);
149 if (!document.MAX_used) document.MAX_used = ',';
150 document.write ("<scr"+"ipt type='text/javascript' src='"+m3_u);
151 document.write ("?zoneid=%d");
152 document.write ('&amp;cb=' + m3_r);
153 if (document.MAX_used != ',') document.write ("&amp;exclude=" + document.MAX_used);
154 document.write (document.charset ? '&amp;charset='+document.charset : (document.characterSet ? '&amp;charset='+document.characterSet : ''));
155 document.write ("&amp;loc=" + escape(window.location));
156 if (document.referrer) document.write ("&amp;referer=" + escape(document.referrer));
157 if (document.context) document.write ("&context=" + escape(document.context));
158 if (document.mmm_fo) document.write ("&amp;mmm_fo=1");
159 document.write ("'><\/scr"+"ipt>");
160 ENDOFSCRIPT;
161
162         $action->inlineScript(sprintf($scr, $this->adScript, $zone));
163         return true;
164     }
165 }