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   min_width = {},
  33   max_width = {},
  34   width,
  35   rendered = {},
  36   queue = [],
  37   output = [];
  38
  39
  40   /*
  41    * Configuration-Options for jQuery.openx
  42    *
  43    * Since the domain-name of the ad-server is the only required parameter,
  44    * jQuery.openx for convenience can be configured with only that one
  45    * parameter. For example: "jQuery.openx('openx.example.org');". If more
  46    * configuration-options are needed, they must be specified as an object.
  47    * For example: "jQuery.openx({'server': 'openx.example.org', ... });".
  48    *
  49    *
  50    * Server-Settings:
  51    *
  52    * server:        string  Name of the server, without protocol or port. For
  53    *                        example "openx.example.org". This option is
  54    *                        REQUIRED.
  55    * protocol:              Optional parameter.
  56    *                http:   All connections to the ad-server are made via HTTP.
  57    *                https:  All connections to the ad-server are made via HTTPS.
  58    *                        If empty, document.location.protocol will be used.
  59    * http_port:     number  Port-Number for HTTP-connections to the ad-server
  60    *                        (only needed, when it is not the default-value 80).
  61    * https_port:            Port-Number for HTTPS-connections to the ad-server
  62    *                        (only needed, when it is not the default-value 443).
  63    *
  64    *
  65    * Seldom needed special Server-Settings (these parameters are only needed,
  66    * if the default delivery-configration of the OpenX-Server was changed):
  67    *
  68    * path:          string  Path to delivery-scripts. DEFAULT: "/www/delivery".
  69    * fl:            string  Flash-Include-Script. DEFAULT: "fl.js".
  70    *
  71    *
  72    * Delivery-Options (for details and explanations see the see:
  73    * http://www.openx.com/docs/2.8/userguide/single%20page%20call):
  74    *
  75    * block:         1       Don't show the banner again on the same page.
  76    *                0       A Banner might be shown multiple times on the same
  77    *                        page (DEFAULT).
  78    * blockcampaign: 1       Don't show a banner from the same campaign again on
  79    *                        the same page.
  80    *                0       A Banner from the same campaign might be shown
  81    *                        muliple times on the same page (DEFAULT).
  82    * target:        string  The value is addes as the HTML TARGET attribute in
  83    *                        the ad code. Examples for sensible values: "_blank",
  84    *                        "_top".
  85    * withtext:      1       Show text below banner. Enter this text in the
  86    *                        Banner properties page.
  87    *                0       Ignore the text-field from the banner-properties
  88                             (DEFAULT).
  89    * charset:       string  Charset used, when delivering the banner-codes.
  90    *                        If empty, the charset is guessed by OpenX. Examples
  91    *                        for sensible values: "UTF-8", "ISO-8859-1".
  92    *
  93    *
  94    * Other settings:
  95    *
  96    * selector:      string  A selector for selecting the DOM-elements, that
  97    *                        should display ad-banners. DEFAULT: ".oa".
  98    *                        See: http://api.jquery.com/category/selectors/
  99    * min_prefix:    string  Prefix for the encoding of the minmal width as
 100    *                        CSS-classname. DEFAULT: "min_".
 101    * max_prefix:    string  Prefix for the encoding of the maximal width as
 102    *                        CSS-classname. DEFAULT: "max_".
 103    */
 104   $.openx = function( options ) {
 105
 106     if (domain) {
 107       if (console.error) {
 108         console.error('jQuery.openx was already initialized!');
 109         console.log('Configured options: ', _options);
 110       }
 111       return;
 112     }
 113
 114     /** Enable convenient-configuration */
 115     if (typeof(options) == 'string')
 116       options = { 'server': options };
 117
 118     _options = options;
 119
 120     if (!options.server) {
 121       if (console.error) {
 122         console.error('Required option "server" is missing!');
 123         console.log('options: ', options);
 124       }
 125       return;
 126     }
 127
 128     settings = $.extend(
 129       {
 130         'protocol': document.location.protocol,
 131         'delivery': '/www/delivery',
 132         'fl': 'fl.js',
 133         'selector': '.oa',
 134         'min_prefix': 'min_',
 135         'max_prefix': 'max_',
 136       },
 137       options
 138       );
 139
 140     domain = settings.protocol + '//';
 141     domain += settings.server;
 142     if (settings.protocol === 'http:' && settings.http_port)
 143       domain += ':' + settings.http_port;
 144     if (settings.protocol === 'https:' && settings.https_port)
 145       domain += ':' + settings.https_port;
 146
 147     /**
 148      * Without this option, jQuery appends an timestamp to every URL, that
 149      * is fetched via $.getScript(). This can mess up badly written
 150      * third-party-ad-scripts, that assume that the called URL's are not
 151      * altered.
 152      */
 153     $.ajaxSetup({ 'cache': true });
 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     for(name in OA_zones) {
 168       $(settings.selector).each(function() {
 169         var
 170         id,
 171         classes,
 172         i,
 173         min = new RegExp('^' + settings.min_prefix + '([0-9]+)$'),
 174         max = new RegExp('^' + settings.max_prefix + '([0-9]+)$'),
 175         match;
 176         if (this.id === name) {
 177           id = 'oa_' + ++count;
 178           slots[id] = this;
 179           min_width[id] = 0;
 180           max_width[id] = Number.MAX_VALUE;
 181           classes = this.className.split(/\s+/);
 182           for (i=0; i<classes.length; i++) {
 183             match = min.exec(classes[i]);
 184             if (match)
 185               min_width[id] = match[1];
 186             match = max.exec(classes[i]);
 187             if (match)
 188               max_width[id] = match[1];
 189           }
 190           rendered[id] = false;
 191         }
 192       });
 193     }
 194
 195     /** Set initial window-width */
 196     width = $(document).width();
 197
 198     /** Fetch the JavaScript for Flash and schedule the initial fetch */
 199     $.getScript(domain + settings.delivery + '/' + settings.fl, fetch_ads);
 200
 201   }
 202
 203   function fetch_ads() {
 204
 205     var name, src = domain + settings.delivery + '/spc.php';
 206
 207     /** Order banners for all zones that were found on the page */
 208     src += '?zones=';
 209     for(id in slots) {
 210       if (width >= min_width[id] && width <= max_width[id]) {
 211         queue.push(id);
 212         src += escape(id + '=' + OA_zones[slots[id].id] + "|");
 213         rendered[id] = true;
 214       }
 215     }
 216     src += '&nz=1'; // << We want to fetch named zones!
 217
 218     /**
 219      * These are some additions to the URL of spc.php, that are originally
 220      * made in spcjs.php
 221      */
 222     src += '&r=' + Math.floor(Math.random()*99999999);
 223     if (window.location)   src += "&loc=" + escape(window.location);
 224     if (document.referrer) src += "&referer=" + escape(document.referrer);
 225
 226     /** Add the configured options */
 227     if (settings.block === 1)
 228       src += '&block=1';
 229     if (settings.blockcampaign === 1)
 230       src += '&blockcampaign=1';
 231     if (settings.target)
 232       src += '&target=' + settings.target;
 233     if (settings.withtext === 1)
 234       src += '&withtext=1';
 235     if (settings.charset)
 236       src += '&charset=' + settings.charset;
 237
 238     /** Add the source-code - if present */
 239     if (typeof OA_source !== 'undefined')
 240       src += "&source=" + escape(OA_source);
 241
 242     /** Fetch data from OpenX and schedule the render-preparation */
 243     $.getScript(src, init_ads);
 244
 245   }
 246
 247   function init_ads() {
 248
 249     var i, id, ads = [];
 250     for (i=0; i<queue.length; i++) {
 251       id = queue[i];
 252       if (typeof(OA_output[id]) != 'undefined' && OA_output[id] != '')
 253         ads.push(id);
 254     }
 255     queue = ads;
 256
 257     document.write = document_write;
 258     document.writeln = document_write;
 259
 260     render_ads();
 261
 262   }
 263
 264   function render_ads() {
 265
 266     while (queue.length > 0) {
 267
 268       var result, src, inline;
 269
 270       id = queue.shift();
 271       node = $(slots[id]);
 272
 273       node.slideDown();
 274
 275       // node.append(id + ": " + node.attr('class'));
 276
 277       /**
 278        * If output was added via document.write(), this output must be
 279        * rendered before other banner-code from the OpenX-server is rendered!
 280        */
 281       insert_output();
 282
 283       while ((result = /<script/i.exec(OA_output[id])) != null) {
 284         node.append(OA_output[id].slice(0,result.index));
 285         /** Strip all text before "<script" from OA_output[id] */
 286         OA_output[id] = OA_output[id].slice(result.index,OA_output[id].length);
 287         result = /^([^>]*)>([\s\S]*?)<\\?\/script>/i.exec(OA_output[id]);
 288         if (result == null) {
 289           /** Invalid syntax in delivered banner-code: ignoring the rest of this banner-code! */
 290           // alert(OA_output[id]);
 291           OA_output[id] = "";
 292         }
 293         else {
 294           /** Remember iinline-code, if present */
 295           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!
 296           inline = result[2];
 297           /** Strip all text up to and including "</script>" from OA_output[id] */
 298           OA_output[id] = OA_output[id].slice(result[0].length,OA_output[id].length);
 299           result = /src\s*=\s*['"]?([^'"]*)['"]?\s/i.exec(src);
 300           if (result == null) {
 301             /** script-tag with inline-code: execute inline-code! */
 302             result = /^\s*<.*$/m.exec(inline);
 303             if (result != null) {
 304               /** Remove leading HTML-comments, because IE will stumble otherwise */
 305               inline = inline.slice(result[0].length,inline.length);
 306             }
 307             $.globalEval(inline);
 308             insert_output(); // << The executed inline-code might have called document.write()!
 309           }
 310           else {
 311             /** script-tag with src-URL! */
 312             if (OA_output[id].length > 0)
 313               /** The banner-code was not rendered completely yet! */
 314               queue.unshift(id);
 315             /** Load the script and halt all work until the script is loaded and executed... */
 316             $.getScript(result[1], render_ads); // << jQuery.getScript() generates onload-Handler for _all_ browsers ;)
 317             return;
 318           }
 319         }
 320       }
 321
 322       node.append(OA_output[id]);
 323       OA_output[id] = "";
 324     }
 325
 326     /** All entries from OA_output were rendered */
 327
 328     id = undefined;
 329     node = undefined;
 330   }
 331
 332   /** This function is used to overwrite document.write and document.writeln */
 333   function document_write() {
 334
 335     if (id == undefined)
 336       return;
 337
 338     for (var i=0; i<arguments.length; i++)
 339       output.push(arguments[i]);
 340
 341     if (id != queue[0])
 342       /**
 343        * Re-Add the last banner-code to the working-queue, because included
 344        * scripts had added markup via document.write(), which is not
 345        * proccessed yet.
 346        * Otherwise the added markup would be falsely rendered together with
 347        * the markup from the following banner-code.
 348        */
 349       queue.unshift(id);
 350
 351   }
 352
 353   /**
 354    * This function prepends the collected output from calls to
 355    * document_write() to the current banner-code.
 356    */
 357   function insert_output() {
 358
 359     if (output.length > 0) {
 360       output.push(OA_output[id]);
 361       OA_output[id] = "";
 362       for (i=0; i<output.length; i++)
 363         OA_output[id] += output[i];
 364       output = [];
 365     }
 366
 367   }
 368
 369 })( jQuery, window, document );
 370
 371 var OA_output = {}; // << Needed, because IE will complain loudly otherwise!