Added debugging-output (debugging can be turned on/off via options)

[openx] / jquery.openx.js

diff --git a/jquery.openx.js b/jquery.openx.js
index a37dcff..3ccdb39 100644 (file)
--- a/jquery.openx.js
+++ b/jquery.openx.js
@@ -33,6 +33,9 @@
   max_width = {},
   width,
   rendered = {},
+  visible = {},
+  rendering = false,
+  resize_timer,
   queue = [],
   output = [];
 
@@ -100,6 +103,12 @@
    *                        CSS-classname. DEFAULT: "min_".
    * max_prefix:    string  Prefix for the encoding of the maximal width as
    *                        CSS-classname. DEFAULT: "max_".
+   * resize_delay:  number  Number of milliseconds to wait, before a
+   *                        recalculation of the visible ads is scheduled.
+   *                        If the value is choosen to small, a recalculation
+   *                        might be scheduled, while resizing is still in
+   *                        progress. DEFAULT: 200.
+   * debug:         boolean Turn on/off console-debugging. DEFAULT: false.
    */
   $.openx = function( options ) {
 
@@ -133,6 +142,8 @@
         'selector': '.oa',
         'min_prefix': 'min_',
         'max_prefix': 'max_',
+        'resize_delay': 200,
+        'debug': false
       },
       options
       );
@@ -144,6 +155,9 @@
     if (settings.protocol === 'https:' && settings.https_port)
       domain += ':' + settings.https_port;
 
+    if (settings.debug && console.debug)
+      console.debug('Ad-Server: ' + domain);
+
     /**
      * Without this option, jQuery appends an timestamp to every URL, that
      * is fetched via $.getScript(). This can mess up badly written
@@ -188,29 +202,72 @@
               max_width[id] = match[1];
           }
           rendered[id] = false;
+          visible[id] = false;
+          if (settings.debug && console.debug)
+            console.debug(
+                'Slot ' + count + ': ' + this.id + ' (' + min_width[id]
+                + (max_width[id] != Number.MAX_VALUE ? '-' + max_width[id] : '')
+                + ')'
+                );
         }
       });
     }
 
-    /** Set initial window-width */
-    width = $(document).width();
+    /** Add resize-event */
+    $(window).resize(function() {
+      clearTimeout(resize_timer);
+      resize_timer = setTimeout(recalculate_visible , settings.resize_timeout);
+    });
 
     /** Fetch the JavaScript for Flash and schedule the initial fetch */
-    $.getScript(domain + settings.delivery + '/' + settings.fl, fetch_ads);
+    $.getScript(domain + settings.delivery + '/' + settings.fl, recalculate_visible);
 
   }
 
+  function recalculate_visible() {
+
+    width = $(document).width();
+    if (settings.debug && console.debug)
+      console.debug('Scheduling recalculation of visible banners for width ' + width);
+    if (!rendering)
+      fetch_ads();
+    
+  }
+
   function fetch_ads() {
 
+    /** Guide rendering-process for early restarts */
+    rendering = true;
+
+    if (settings.debug && console.debug)
+      console.debug('Starting recalculation of visible banners for width ' + width);
+
     var name, src = domain + settings.delivery + '/spc.php';
 
     /** Order banners for all zones that were found on the page */
     src += '?zones=';
     for(id in slots) {
-      if (width >= min_width[id] && width <= max_width[id]) {
-        queue.push(id);
-        src += escape(id + '=' + OA_zones[slots[id].id] + "|");
-        rendered[id] = true;
+      visible[id] = width >= min_width[id] && width <= max_width[id];
+      if (visible[id]) {
+        if (!rendered[id]) {
+          queue.push(id);
+          src += escape(id + '=' + OA_zones[slots[id].id] + "|");
+          rendered[id] = true;
+          if (settings.debug && console.debug)
+            console.debug('Fetching banner ' + slots[id].id);
+        }
+        else {
+          /** Unhide already fetched visible banners */
+          if (settings.debug && console.debug)
+            console.debug('Unhiding already fetched banner ' + slots[id].id);
+          $(slots[id]).slideDown();
+        }
+      }
+      else {
+        /** Hide unvisible banners */
+        if (settings.debug && console.debug)
+          console.debug('Hiding banner ' + slots[id].id);
+        $(slots[id]).hide();
       }
     }
     src += '&nz=1'; // << We want to fetch named zones!
@@ -239,6 +296,9 @@
     if (typeof OA_source !== 'undefined')
       src += "&source=" + escape(OA_source);
 
+    /** Signal, that this task is done / in progress */
+    width = undefined;
+
     /** Fetch data from OpenX and schedule the render-preparation */
     $.getScript(src, init_ads);
 
@@ -270,6 +330,9 @@
       id = queue.shift();
       node = $(slots[id]);
 
+      if (settings.debug && console.debug)
+        console.debug('Rendering banner ' + slots[id].id);
+
       node.slideDown();
 
       // node.append(id + ": " + node.attr('class'));
@@ -327,6 +390,15 @@
 
     id = undefined;
     node = undefined;
+    rendering = false;
+
+    if (settings.debug && console.debug)
+      console.debug('Recalculation of visible banners done!');
+
+    /** Restart rendering, if new task was queued */
+    if (width)
+      fetch_ads();
+
   }
 
   /** This function is used to overwrite document.write and document.writeln */