juplo.de Git - openx/blob - jquery.openx.js

   1 /*
   2  * (C) Copyright 2012 juplo (http://juplo.de/).
   3  *
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the GNU Lesser General Public License
   6  * (LGPL) version 3.0 which accompanies this distribution, and is available at
   7  * http://www.gnu.org/licenses/lgpl-3.0.html
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * Contributors:
  15  * - Kai Moritz
  16  */
  17
  18 /*
  19  * See http://coding.smashingmagazine.com/2011/10/11/essential-jquery-plugin-patterns/
  20  * for detailed explanations for the applied best practices.
  21  *
  22  * The semicolon guides our code for poorly written concatenated scripts.
  23  */
  24 ;(function( $, window, document, undefined ) {
  25
  26   var
  27
  28   settings, _options, domain, id, node,
  29
  30   count = 0,
  31   slots = {},
  32   queue = [],
  33   ads = [],
  34   output = [];
  35
  36
  37   /*
  38    * Configuration-Options for jQuery.openx
  39    *
  40    * Since the domain-name of the ad-server is the only required parameter,
  41    * jQuery.openx for convenience can be configured with only that one
  42    * parameter. For example: "jQuery.openx('openx.example.org');". If more
  43    * configuration-options are needed, they must be specified as an object.
  44    * For example: "jQuery.openx({'server': 'openx.example.org', ... });".
  45    *
  46    *
  47    * Server-Settings:
  48    *
  49    * server:        string  Name of the server, without protocol or port. For
  50    *                        example "openx.example.org". This option is
  51    *                        REQUIRED.
  52    * protocol:              Optional parameter.
  53    *                http:   All connections to the ad-server are made via HTTP.
  54    *                https:  All connections to the ad-server are made via HTTPS.
  55    *                        If empty, document.location.protocol will be used.
  56    * http_port:     number  Port-Number for HTTP-connections to the ad-server
  57    *                        (only needed, when it is not the default-value 80).
  58    * https_port:            Port-Number for HTTPS-connections to the ad-server
  59    *                        (only needed, when it is not the default-value 443).
  60    *
  61    *
  62    * Seldom needed special Server-Settings (these parameters are only needed,
  63    * if the default delivery-configration of the OpenX-Server was changed):
  64    *
  65    * path:          string  Path to delivery-scripts. DEFAULT: "/www/delivery".
  66    * fl:            string  Flash-Include-Script. DEFAULT: "fl.js".
  67    *
  68    *
  69    * Delivery-Options (for details and explanations see the see:
  70    * http://www.openx.com/docs/2.8/userguide/single%20page%20call):
  71    *
  72    * block:         1       Don't show the banner again on the same page.
  73    *                0       A Banner might be shown multiple times on the same
  74    *                        page (DEFAULT).
  75    * blockcampaign: 1       Don't show a banner from the same campaign again on
  76    *                        the same page.
  77    *                0       A Banner from the same campaign might be shown
  78    *                        muliple times on the same page (DEFAULT).
  79    * target:        string  The value is addes as the HTML TARGET attribute in
  80    *                        the ad code. Examples for sensible values: "_blank",
  81    *                        "_top".
  82    * withtext:      1       Show text below banner. Enter this text in the
  83    *                        Banner properties page.
  84    *                0       Ignore the text-field from the banner-properties
  85                             (DEFAULT).
  86    * charset:       string  Charset used, when delivering the banner-codes.
  87    *                        If empty, the charset is guessed by OpenX. Examples
  88    *                        for sensible values: "UTF-8", "ISO-8859-1".
  89    *
  90    *
  91    * Other settings:
  92    *
  93    * selector:      string  A selector for selecting the DOM-elements, that
  94    *                        should display ad-banners. DEFAULT: ".oa".
  95    *                        See: http://api.jquery.com/category/selectors/
  96    */
  97   $.openx = function( options ) {
  98
  99     var name, src, errors = [], i;
 100
 101     if (domain) {
 102       if (console.error) {
 103         console.error('jQuery.openx was already initialized!');
 104         console.log('Configured options: ', _options);
 105       }
 106       return;
 107     }
 108
 109     /** Enable convenient-configuration */
 110     if (typeof(options) == 'string')
 111       options = { 'server': options };
 112
 113     _options = options;
 114
 115     if (!options.server)
 116       errors.push('Required option "server" is missing!');
 117     if (errors.length > 0) {
 118       if (console.error) {
 119         for (i=0; i<errors.length; i++)
 120           console.error('Required option "server" is missing!');
 121         console.log('options: ', options);
 122       }
 123       return;
 124     }
 125
 126     settings = $.extend(
 127       {
 128         'protocol': document.location.protocol,
 129         'delivery': '/www/delivery',
 130         'fl': 'fl.js',
 131         'selector': '.oa',
 132         'cache': true
 133       },
 134       options
 135       );
 136
 137     domain = settings.protocol + '//';
 138     domain += settings.server;
 139     if (settings.protocol === 'http:' && settings.http_port)
 140       domain += ':' + settings.http_port;
 141     if (settings.protocol === 'https:' && settings.https_port)
 142       domain += ':' + settings.https_port;
 143
 144     /**
 145      * Without this option, jQuery appends an timestamp to every URL, that
 146      * is fetched via $.getScript(). This can mess up badly written
 147      * third-party-ad-scripts, that assume that the called URL's are not
 148      * altered.
 149      */
 150     $.ajaxSetup({ 'cache': true });
 151
 152
 153     src = domain + settings.delivery + '/spc.php';
 154
 155     /**
 156      * jQuery.openx only works with "named zones", because it does not know,
 157      * which zones belong to which website. For mor informations about
 158      * "named zones" see:
 159      * http://www.openx.com/docs/2.8/userguide/single%20page%20call
 160      *
 161      * For convenience, jQuery.openx only fetches banners, that are really
 162      * included in the actual page. This way, you can configure jQuery.openx
 163      * with all zones available for your website - for example in a central
 164      * template - and does not have to worry about performance penalties due
 165      * to unnecessarily fetched banners.
 166      */
 167     src += '?zones=';
 168     for(name in OA_zones) {
 169       $(settings.selector).each(function() {
 170         var
 171         node = $(this),
 172         id;
 173         if (node.hasClass(name)) {
 174           id = 'oa_' + ++count;
 175           slots[id] = node;
 176           queue.push(id);
 177           src += escape(id + '=' + OA_zones[name] + "|");
 178         }
 179       });
 180     }
 181     src += '&nz=1'; // << We want to fetch named zones!
 182
 183     /**
 184      * These are some additions to the URL of spc.php, that are originally
 185      * made in spcjs.php
 186      */
 187     src += '&r=' + Math.floor(Math.random()*99999999);
 188     if (window.location)   src += "&loc=" + escape(window.location);
 189     if (document.referrer) src += "&referer=" + escape(document.referrer);
 190
 191     /** Add the configured options */
 192     if (settings.block === 1)
 193       src += '&block=1';
 194     if (settings.blockcampaign === 1)
 195       src += '&blockcampaign=1';
 196     if (settings.target)
 197       src += '&target=' + settings.target;
 198     if (settings.withtext === 1)
 199       src += '&withtext=1';
 200     if (settings.charset)
 201       src += '&charset=' + settings.charset;
 202
 203     /** Add the source-code - if present */
 204     if (typeof OA_source !== 'undefined')
 205       src += "&source=" + escape(OA_source);
 206
 207     /** Chain-load the scripts (next script to load is fl.js */
 208     $.getScript(src, load_flash);
 209
 210   }
 211
 212   function load_flash() {
 213
 214     $.getScript(domain + settings.delivery + '/' + settings.fl, init_ads);
 215
 216   }
 217
 218   function init_ads() {
 219
 220     var i, id;
 221     for (i=0; i<queue.length; i++) {
 222       id = queue[i];
 223       if (typeof(OA_output[id]) != 'undefined' && OA_output[id] != '')
 224         ads.push(id);
 225     }
 226
 227     document.write = document_write;
 228     document.writeln = document_write;
 229
 230     render_ads();
 231
 232   }
 233
 234   function render_ads() {
 235
 236     while (ads.length > 0) {
 237
 238       var result, src, inline;
 239
 240       id = ads.shift();
 241       node = slots[id];
 242
 243       node.slideDown();
 244
 245       // node.append(id + ": " + node.attr('class'));
 246
 247       /**
 248        * If output was added via document.write(), this output must be
 249        * rendered before other banner-code from the OpenX-server is rendered!
 250        */
 251       insert_output();
 252
 253       while ((result = /<script/i.exec(OA_output[id])) != null) {
 254         node.append(OA_output[id].slice(0,result.index));
 255         /** Strip all text before "<script" from OA_output[id] */
 256         OA_output[id] = OA_output[id].slice(result.index,OA_output[id].length);
 257         result = /^([^>]*)>([\s\S]*?)<\\?\/script>/i.exec(OA_output[id]);
 258         if (result == null) {
 259           /** Invalid syntax in delivered banner-code: ignoring the rest of this banner-code! */
 260           // alert(OA_output[id]);
 261           OA_output[id] = "";
 262         }
 263         else {
 264           /** Remember iinline-code, if present */
 265           src = result[1] + ' ' // << simplifies the following regular expression: the string ends with a space in any case, so that the src-URL cannot be followed by the end of the string emediately!
 266           inline = result[2];
 267           /** Strip all text up to and including "</script>" from OA_output[id] */
 268           OA_output[id] = OA_output[id].slice(result[0].length,OA_output[id].length);
 269           result = /src\s*=\s*['"]?([^'"]*)['"]?\s/i.exec(src);
 270           if (result == null) {
 271             /** script-tag with inline-code: execute inline-code! */
 272             result = /^\s*<.*$/m.exec(inline);
 273             if (result != null) {
 274               /** Remove leading HTML-comments, because IE will stumble otherwise */
 275               inline = inline.slice(result[0].length,inline.length);
 276             }
 277             $.globalEval(inline);
 278             insert_output(); // << The executed inline-code might have called document.write()!
 279           }
 280           else {
 281             /** script-tag with src-URL! */
 282             if (OA_output[id].length > 0)
 283               /** The banner-code was not rendered completely yet! */
 284               ads.unshift(id);
 285             /** Load the script and halt all work until the script is loaded and executed... */
 286             $.getScript(result[1], render_ads); // << jQuery.getScript() generates onload-Handler for _all_ browsers ;)
 287             return;
 288           }
 289         }
 290       }
 291
 292       node.append(OA_output[id]);
 293       OA_output[id] = "";
 294     }
 295
 296     /** All entries from OA_output were rendered */
 297
 298     id = undefined;
 299     node = undefined;
 300   }
 301
 302   /** This function is used to overwrite document.write and document.writeln */
 303   function document_write() {
 304
 305     if (id == undefined)
 306       return;
 307
 308     for (var i=0; i<arguments.length; i++)
 309       output.push(arguments[i]);
 310
 311     if (id != ads[0])
 312       /**
 313        * Re-Add the last banner-code to the working-queue, because included
 314        * scripts had added markup via document.write(), which is not
 315        * proccessed yet.
 316        * Otherwise the added markup would be falsely rendered together with
 317        * the markup from the following banner-code.
 318        */
 319       ads.unshift(id);
 320
 321   }
 322
 323   /**
 324    * This function prepends the collected output from calls to
 325    * document_write() to the current banner-code.
 326    */
 327   function insert_output() {
 328
 329     if (output.length > 0) {
 330       output.push(OA_output[id]);
 331       OA_output[id] = "";
 332       for (i=0; i<output.length; i++)
 333         OA_output[id] += output[i];
 334       output = [];
 335     }
 336
 337   }
 338
 339 })( jQuery, window, document );
 340
 341 var OA_output = {}; // << Needed, because IE will complain loudly otherwise!