)<[^<]*)*<\/script>/gi,cs=/([?&])_=[^&]*/,ct=/^([\w\+\.\-]+:)(?:\/\/([^\/?#:]*)(?::(\d+)|)|)/,cu=p.fn.load,cv={},cw={},cx=["*/"]+["*"];try{ck=f.href}catch(cy){ck=e.createElement("a"),ck.href="",ck=ck.href}cj=ct.exec(ck.toLowerCase())||[],p.fn.load=function(a,c,d){if(typeof a!="string"&&cu)return cu.apply(this,arguments);if(!this.length)return this;var e,f,g,h=this,i=a.indexOf(" ");return i>=0&&(e=a.slice(i,a.length),a=a.slice(0,i)),p.isFunction(c)?(d=c,c=b):c&&typeof c=="object"&&(f="POST"),p.ajax({url:a,type:f,dataType:"html",data:c,complete:function(a,b){d&&h.each(d,g||[a.responseText,b,a])}}).done(function(a){g=arguments,h.html(e?p("").append(a.replace(cr,"")).find(e):a)}),this},p.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "),function(a,b){p.fn[b]=function(a){return this.on(b,a)}}),p.each(["get","post"],function(a,c){p[c]=function(a,d,e,f){return p.isFunction(d)&&(f=f||e,e=d,d=b),p.ajax({type:c,url:a,data:d,success:e,dataType:f})}}),p.extend({getScript:function(a,c){return p.get(a,b,c,"script")},getJSON:function(a,b,c){return p.get(a,b,c,"json")},ajaxSetup:function(a,b){return b?cB(a,p.ajaxSettings):(b=a,a=p.ajaxSettings),cB(a,b),a},ajaxSettings:{url:ck,isLocal:cn.test(cj[1]),global:!0,type:"GET",contentType:"application/x-www-form-urlencoded; charset=UTF-8",processData:!0,async:!0,accepts:{xml:"application/xml, text/xml",html:"text/html",text:"text/plain",json:"application/json, text/javascript","*":cx},contents:{xml:/xml/,html:/html/,json:/json/},responseFields:{xml:"responseXML",text:"responseText"},converters:{"* text":a.String,"text html":!0,"text json":p.parseJSON,"text xml":p.parseXML},flatOptions:{context:!0,url:!0}},ajaxPrefilter:cz(cv),ajaxTransport:cz(cw),ajax:function(a,c){function y(a,c,f,i){var k,s,t,u,w,y=c;if(v===2)return;v=2,h&&clearTimeout(h),g=b,e=i||"",x.readyState=a>0?4:0,f&&(u=cC(l,x,f));if(a>=200&&a<300||a===304)l.ifModified&&(w=x.getResponseHeader("Last-Modified"),w&&(p.lastModified[d]=w),w=x.getResponseHeader("Etag"),w&&(p.etag[d]=w)),a===304?(y="notmodified",k=!0):(k=cD(l,u),y=k.state,s=k.data,t=k.error,k=!t);else{t=y;if(!y||a)y="error",a<0&&(a=0)}x.status=a,x.statusText=(c||y)+"",k?o.resolveWith(m,[s,y,x]):o.rejectWith(m,[x,y,t]),x.statusCode(r),r=b,j&&n.trigger("ajax"+(k?"Success":"Error"),[x,l,k?s:t]),q.fireWith(m,[x,y]),j&&(n.trigger("ajaxComplete",[x,l]),--p.active||p.event.trigger("ajaxStop"))}typeof a=="object"&&(c=a,a=b),c=c||{};var d,e,f,g,h,i,j,k,l=p.ajaxSetup({},c),m=l.context||l,n=m!==l&&(m.nodeType||m instanceof p)?p(m):p.event,o=p.Deferred(),q=p.Callbacks("once memory"),r=l.statusCode||{},t={},u={},v=0,w="canceled",x={readyState:0,setRequestHeader:function(a,b){if(!v){var c=a.toLowerCase();a=u[c]=u[c]||a,t[a]=b}return this},getAllResponseHeaders:function(){return v===2?e:null},getResponseHeader:function(a){var c;if(v===2){if(!f){f={};while(c=cm.exec(e))f[c[1].toLowerCase()]=c[2]}c=f[a.toLowerCase()]}return c===b?null:c},overrideMimeType:function(a){return v||(l.mimeType=a),this},abort:function(a){return a=a||w,g&&g.abort(a),y(0,a),this}};o.promise(x),x.success=x.done,x.error=x.fail,x.complete=q.add,x.statusCode=function(a){if(a){var b;if(v<2)for(b in a)r[b]=[r[b],a[b]];else b=a[x.status],x.always(b)}return this},l.url=((a||l.url)+"").replace(cl,"").replace(cp,cj[1]+"//"),l.dataTypes=p.trim(l.dataType||"*").toLowerCase().split(s),l.crossDomain==null&&(i=ct.exec(l.url.toLowerCase())||!1,l.crossDomain=i&&i.join(":")+(i[3]?"":i[1]==="http:"?80:443)!==cj.join(":")+(cj[3]?"":cj[1]==="http:"?80:443)),l.data&&l.processData&&typeof l.data!="string"&&(l.data=p.param(l.data,l.traditional)),cA(cv,l,c,x);if(v===2)return x;j=l.global,l.type=l.type.toUpperCase(),l.hasContent=!co.test(l.type),j&&p.active++===0&&p.event.trigger("ajaxStart");if(!l.hasContent){l.data&&(l.url+=(cq.test(l.url)?"&":"?")+l.data,delete l.data),d=l.url;if(l.cache===!1){var z=p.now(),A=l.url.replace(cs,"$1_="+z);l.url=A+(A===l.url?(cq.test(l.url)?"&":"?")+"_="+z:"")}}(l.data&&l.hasContent&&l.contentType!==!1||c.contentType)&&x.setRequestHeader("Content-Type",l.contentType),l.ifModified&&(d=d||l.url,p.lastModified[d]&&x.setRequestHeader("If-Modified-Since",p.lastModified[d]),p.etag[d]&&x.setRequestHeader("If-None-Match",p.etag[d])),x.setRequestHeader("Accept",l.dataTypes[0]&&l.accepts[l.dataTypes[0]]?l.accepts[l.dataTypes[0]]+(l.dataTypes[0]!=="*"?", "+cx+"; q=0.01":""):l.accepts["*"]);for(k in l.headers)x.setRequestHeader(k,l.headers[k]);if(!l.beforeSend||l.beforeSend.call(m,x,l)!==!1&&v!==2){w="abort";for(k in{success:1,error:1,complete:1})x[k](l[k]);g=cA(cw,l,c,x);if(!g)y(-1,"No Transport");else{x.readyState=1,j&&n.trigger("ajaxSend",[x,l]),l.async&&l.timeout>0&&(h=setTimeout(function(){x.abort("timeout")},l.timeout));try{v=1,g.send(t,y)}catch(B){if(v<2)y(-1,B);else throw B}}return x}return x.abort()},active:0,lastModified:{},etag:{}});var cE=[],cF=/\?/,cG=/(=)\?(?=&|$)|\?\?/,cH=p.now();p.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var a=cE.pop()||p.expando+"_"+cH++;return this[a]=!0,a}}),p.ajaxPrefilter("json jsonp",function(c,d,e){var f,g,h,i=c.data,j=c.url,k=c.jsonp!==!1,l=k&&cG.test(j),m=k&&!l&&typeof i=="string"&&!(c.contentType||"").indexOf("application/x-www-form-urlencoded")&&cG.test(i);if(c.dataTypes[0]==="jsonp"||l||m)return f=c.jsonpCallback=p.isFunction(c.jsonpCallback)?c.jsonpCallback():c.jsonpCallback,g=a[f],l?c.url=j.replace(cG,"$1"+f):m?c.data=i.replace(cG,"$1"+f):k&&(c.url+=(cF.test(j)?"&":"?")+c.jsonp+"="+f),c.converters["script json"]=function(){return h||p.error(f+" was not called"),h[0]},c.dataTypes[0]="json",a[f]=function(){h=arguments},e.always(function(){a[f]=g,c[f]&&(c.jsonpCallback=d.jsonpCallback,cE.push(f)),h&&p.isFunction(g)&&g(h[0]),h=g=b}),"script"}),p.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/javascript|ecmascript/},converters:{"text script":function(a){return p.globalEval(a),a}}}),p.ajaxPrefilter("script",function(a){a.cache===b&&(a.cache=!1),a.crossDomain&&(a.type="GET",a.global=!1)}),p.ajaxTransport("script",function(a){if(a.crossDomain){var c,d=e.head||e.getElementsByTagName("head")[0]||e.documentElement;return{send:function(f,g){c=e.createElement("script"),c.async="async",a.scriptCharset&&(c.charset=a.scriptCharset),c.src=a.url,c.onload=c.onreadystatechange=function(a,e){if(e||!c.readyState||/loaded|complete/.test(c.readyState))c.onload=c.onreadystatechange=null,d&&c.parentNode&&d.removeChild(c),c=b,e||g(200,"success")},d.insertBefore(c,d.firstChild)},abort:function(){c&&c.onload(0,1)}}}});var cI,cJ=a.ActiveXObject?function(){for(var a in cI)cI[a](0,1)}:!1,cK=0;p.ajaxSettings.xhr=a.ActiveXObject?function(){return!this.isLocal&&cL()||cM()}:cL,function(a){p.extend(p.support,{ajax:!!a,cors:!!a&&"withCredentials"in a})}(p.ajaxSettings.xhr()),p.support.ajax&&p.ajaxTransport(function(c){if(!c.crossDomain||p.support.cors){var d;return{send:function(e,f){var g,h,i=c.xhr();c.username?i.open(c.type,c.url,c.async,c.username,c.password):i.open(c.type,c.url,c.async);if(c.xhrFields)for(h in c.xhrFields)i[h]=c.xhrFields[h];c.mimeType&&i.overrideMimeType&&i.overrideMimeType(c.mimeType),!c.crossDomain&&!e["X-Requested-With"]&&(e["X-Requested-With"]="XMLHttpRequest");try{for(h in e)i.setRequestHeader(h,e[h])}catch(j){}i.send(c.hasContent&&c.data||null),d=function(a,e){var h,j,k,l,m;try{if(d&&(e||i.readyState===4)){d=b,g&&(i.onreadystatechange=p.noop,cJ&&delete cI[g]);if(e)i.readyState!==4&&i.abort();else{h=i.status,k=i.getAllResponseHeaders(),l={},m=i.responseXML,m&&m.documentElement&&(l.xml=m);try{l.text=i.responseText}catch(a){}try{j=i.statusText}catch(n){j=""}!h&&c.isLocal&&!c.crossDomain?h=l.text?200:404:h===1223&&(h=204)}}}catch(o){e||f(-1,o)}l&&f(h,j,l,k)},c.async?i.readyState===4?setTimeout(d,0):(g=++cK,cJ&&(cI||(cI={},p(a).unload(cJ)),cI[g]=d),i.onreadystatechange=d):d()},abort:function(){d&&d(0,1)}}}});var cN,cO,cP=/^(?:toggle|show|hide)$/,cQ=new RegExp("^(?:([-+])=|)("+q+")([a-z%]*)$","i"),cR=/queueHooks$/,cS=[cY],cT={"*":[function(a,b){var c,d,e=this.createTween(a,b),f=cQ.exec(b),g=e.cur(),h=+g||0,i=1,j=20;if(f){c=+f[2],d=f[3]||(p.cssNumber[a]?"":"px");if(d!=="px"&&h){h=p.css(e.elem,a,!0)||c||1;do i=i||".5",h=h/i,p.style(e.elem,a,h+d);while(i!==(i=e.cur()/g)&&i!==1&&--j)}e.unit=d,e.start=h,e.end=f[1]?h+(f[1]+1)*c:c}return e}]};p.Animation=p.extend(cW,{tweener:function(a,b){p.isFunction(a)?(b=a,a=["*"]):a=a.split(" ");var c,d=0,e=a.length;for(;d-1,j={},k={},l,m;i?(k=e.position(),l=k.top,m=k.left):(l=parseFloat(g)||0,m=parseFloat(h)||0),p.isFunction(b)&&(b=b.call(a,c,f)),b.top!=null&&(j.top=b.top-f.top+l),b.left!=null&&(j.left=b.left-f.left+m),"using"in b?b.using.call(a,j):e.css(j)}},p.fn.extend({position:function(){if(!this[0])return;var a=this[0],b=this.offsetParent(),c=this.offset(),d=c_.test(b[0].nodeName)?{top:0,left:0}:b.offset();return c.top-=parseFloat(p.css(a,"marginTop"))||0,c.left-=parseFloat(p.css(a,"marginLeft"))||0,d.top+=parseFloat(p.css(b[0],"borderTopWidth"))||0,d.left+=parseFloat(p.css(b[0],"borderLeftWidth"))||0,{top:c.top-d.top,left:c.left-d.left}},offsetParent:function(){return this.map(function(){var a=this.offsetParent||e.body;while(a&&!c_.test(a.nodeName)&&p.css(a,"position")==="static")a=a.offsetParent;return a||e.body})}}),p.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(a,c){var d=/Y/.test(c);p.fn[a]=function(e){return p.access(this,function(a,e,f){var g=da(a);if(f===b)return g?c in g?g[c]:g.document.documentElement[e]:a[e];g?g.scrollTo(d?p(g).scrollLeft():f,d?f:p(g).scrollTop()):a[e]=f},a,e,arguments.length,null)}}),p.each({Height:"height",Width:"width"},function(a,c){p.each({padding:"inner"+a,content:c,"":"outer"+a},function(d,e){p.fn[e]=function(e,f){var g=arguments.length&&(d||typeof e!="boolean"),h=d||(e===!0||f===!0?"margin":"border");return p.access(this,function(c,d,e){var f;return p.isWindow(c)?c.document.documentElement["client"+a]:c.nodeType===9?(f=c.documentElement,Math.max(c.body["scroll"+a],f["scroll"+a],c.body["offset"+a],f["offset"+a],f["client"+a])):e===b?p.css(c,d,e,h):p.style(c,d,e,h)},c,g?e:b,g,null)}})}),a.jQuery=a.$=p,typeof define=="function"&&define.amd&&define.amd.jQuery&&define("jquery",[],function(){return p})})(window);
\ No newline at end of file
diff --git a/api/lib/jquery.layout.js b/api/lib/jquery.layout.js
new file mode 100644
index 0000000..d5e008d
--- /dev/null
+++ b/api/lib/jquery.layout.js
@@ -0,0 +1,5486 @@
+/**
+ * @preserve jquery.layout 1.3.0 - Release Candidate 30.62
+ * $Date: 2012-08-04 08:00:00 (Thu, 23 Aug 2012) $
+ * $Rev: 303006 $
+ *
+ * Copyright (c) 2012
+ * Fabrizio Balliano (http://www.fabrizioballiano.net)
+ * Kevin Dalman (http://allpro.net)
+ *
+ * Dual licensed under the GPL (http://www.gnu.org/licenses/gpl.html)
+ * and MIT (http://www.opensource.org/licenses/mit-license.php) licenses.
+ *
+ * Changelog: http://layout.jquery-dev.net/changelog.cfm#1.3.0.rc30.62
+ * NOTE: This is a short-term release to patch a couple of bugs.
+ * These bugs are listed as officially fixed in RC30.7, which will be released shortly.
+ *
+ * Docs: http://layout.jquery-dev.net/documentation.html
+ * Tips: http://layout.jquery-dev.net/tips.html
+ * Help: http://groups.google.com/group/jquery-ui-layout
+ */
+
+/* JavaDoc Info: http://code.google.com/closure/compiler/docs/js-for-compiler.html
+ * {!Object} non-nullable type (never NULL)
+ * {?string} nullable type (sometimes NULL) - default for {Object}
+ * {number=} optional parameter
+ * {*} ALL types
+ */
+
+// NOTE: For best readability, view with a fixed-width font and tabs equal to 4-chars
+
+;(function ($) {
+
+// alias Math methods - used a lot!
+var min = Math.min
+, max = Math.max
+, round = Math.floor
+
+, isStr = function (v) { return $.type(v) === "string"; }
+
+, runPluginCallbacks = function (Instance, a_fn) {
+ if ($.isArray(a_fn))
+ for (var i=0, c=a_fn.length; i
').appendTo("body");
+ var d = { width: $c.width() - $c[0].clientWidth, height: $c.height() - $c[0].clientHeight };
+ $c.remove();
+ window.scrollbarWidth = d.width;
+ window.scrollbarHeight = d.height;
+ return dim.match(/^(width|height)$/) ? d[dim] : d;
+ }
+
+
+ /**
+ * Returns hash container 'display' and 'visibility'
+ *
+ * @see $.swap() - swaps CSS, runs callback, resets CSS
+ */
+, showInvisibly: function ($E, force) {
+ if ($E && $E.length && (force || $E.css('display') === "none")) { // only if not *already hidden*
+ var s = $E[0].style
+ // save ONLY the 'style' props because that is what we must restore
+ , CSS = { display: s.display || '', visibility: s.visibility || '' };
+ // show element 'invisibly' so can be measured
+ $E.css({ display: "block", visibility: "hidden" });
+ return CSS;
+ }
+ return {};
+ }
+
+ /**
+ * Returns data for setting size of an element (container or a pane).
+ *
+ * @see _create(), onWindowResize() for container, plus others for pane
+ * @return JSON Returns a hash of all dimensions: top, bottom, left, right, outerWidth, innerHeight, etc
+ */
+, getElementDimensions: function ($E) {
+ var
+ d = {} // dimensions hash
+ , x = d.css = {} // CSS hash
+ , i = {} // TEMP insets
+ , b, p // TEMP border, padding
+ , N = $.layout.cssNum
+ , off = $E.offset()
+ ;
+ d.offsetLeft = off.left;
+ d.offsetTop = off.top;
+
+ $.each("Left,Right,Top,Bottom".split(","), function (idx, e) { // e = edge
+ b = x["border" + e] = $.layout.borderWidth($E, e);
+ p = x["padding"+ e] = $.layout.cssNum($E, "padding"+e);
+ i[e] = b + p; // total offset of content from outer side
+ d["inset"+ e] = p; // eg: insetLeft = paddingLeft
+ });
+
+ d.offsetWidth = $E.innerWidth(); // offsetWidth is used in calc when doing manual resize
+ d.offsetHeight = $E.innerHeight(); // ditto
+ d.outerWidth = $E.outerWidth();
+ d.outerHeight = $E.outerHeight();
+ d.innerWidth = max(0, d.outerWidth - i.Left - i.Right);
+ d.innerHeight = max(0, d.outerHeight - i.Top - i.Bottom);
+
+ x.width = $E.width();
+ x.height = $E.height();
+ x.top = N($E,"top",true);
+ x.bottom = N($E,"bottom",true);
+ x.left = N($E,"left",true);
+ x.right = N($E,"right",true);
+
+ //d.visible = $E.is(":visible");// && x.width > 0 && x.height > 0;
+
+ return d;
+ }
+
+, getElementCSS: function ($E, list) {
+ var
+ CSS = {}
+ , style = $E[0].style
+ , props = list.split(",")
+ , sides = "Top,Bottom,Left,Right".split(",")
+ , attrs = "Color,Style,Width".split(",")
+ , p, s, a, i, j, k
+ ;
+ for (i=0; i < props.length; i++) {
+ p = props[i];
+ if (p.match(/(border|padding|margin)$/))
+ for (j=0; j < 4; j++) {
+ s = sides[j];
+ if (p === "border")
+ for (k=0; k < 3; k++) {
+ a = attrs[k];
+ CSS[p+s+a] = style[p+s+a];
+ }
+ else
+ CSS[p+s] = style[p+s];
+ }
+ else
+ CSS[p] = style[p];
+ };
+ return CSS
+ }
+
+ /**
+ * Return the innerWidth for the current browser/doctype
+ *
+ * @see initPanes(), sizeMidPanes(), initHandles(), sizeHandles()
+ * @param {Array.} $E Must pass a jQuery object - first element is processed
+ * @param {number=} outerWidth (optional) Can pass a width, allowing calculations BEFORE element is resized
+ * @return {number} Returns the innerWidth of the elem by subtracting padding and borders
+ */
+, cssWidth: function ($E, outerWidth) {
+ // a 'calculated' outerHeight can be passed so borders and/or padding are removed if needed
+ if (outerWidth <= 0) return 0;
+
+ if (!$.layout.browser.boxModel) return outerWidth;
+
+ // strip border and padding from outerWidth to get CSS Width
+ var b = $.layout.borderWidth
+ , n = $.layout.cssNum
+ , W = outerWidth
+ - b($E, "Left")
+ - b($E, "Right")
+ - n($E, "paddingLeft")
+ - n($E, "paddingRight");
+
+ return max(0,W);
+ }
+
+ /**
+ * Return the innerHeight for the current browser/doctype
+ *
+ * @see initPanes(), sizeMidPanes(), initHandles(), sizeHandles()
+ * @param {Array.} $E Must pass a jQuery object - first element is processed
+ * @param {number=} outerHeight (optional) Can pass a width, allowing calculations BEFORE element is resized
+ * @return {number} Returns the innerHeight of the elem by subtracting padding and borders
+ */
+, cssHeight: function ($E, outerHeight) {
+ // a 'calculated' outerHeight can be passed so borders and/or padding are removed if needed
+ if (outerHeight <= 0) return 0;
+
+ if (!$.layout.browser.boxModel) return outerHeight;
+
+ // strip border and padding from outerHeight to get CSS Height
+ var b = $.layout.borderWidth
+ , n = $.layout.cssNum
+ , H = outerHeight
+ - b($E, "Top")
+ - b($E, "Bottom")
+ - n($E, "paddingTop")
+ - n($E, "paddingBottom");
+
+ return max(0,H);
+ }
+
+ /**
+ * Returns the 'current CSS numeric value' for a CSS property - 0 if property does not exist
+ *
+ * @see Called by many methods
+ * @param {Array.} $E Must pass a jQuery object - first element is processed
+ * @param {string} prop The name of the CSS property, eg: top, width, etc.
+ * @param {boolean=} [allowAuto=false] true = return 'auto' if that is value; false = return 0
+ * @return {(string|number)} Usually used to get an integer value for position (top, left) or size (height, width)
+ */
+, cssNum: function ($E, prop, allowAuto) {
+ if (!$E.jquery) $E = $($E);
+ var CSS = $.layout.showInvisibly($E)
+ , p = $.css($E[0], prop, true)
+ , v = allowAuto && p=="auto" ? p : (parseInt(p, 10) || 0);
+ $E.css( CSS ); // RESET
+ return v;
+ }
+
+, borderWidth: function (el, side) {
+ if (el.jquery) el = el[0];
+ var b = "border"+ side.substr(0,1).toUpperCase() + side.substr(1); // left => Left
+ return $.css(el, b+"Style", true) === "none" ? 0 : (parseInt($.css(el, b+"Width", true), 10) || 0);
+ }
+
+ /**
+ * Mouse-tracking utility - FUTURE REFERENCE
+ *
+ * init: if (!window.mouse) {
+ * window.mouse = { x: 0, y: 0 };
+ * $(document).mousemove( $.layout.trackMouse );
+ * }
+ *
+ * @param {Object} evt
+ *
+, trackMouse: function (evt) {
+ window.mouse = { x: evt.clientX, y: evt.clientY };
+ }
+ */
+
+ /**
+ * SUBROUTINE for preventPrematureSlideClose option
+ *
+ * @param {Object} evt
+ * @param {Object=} el
+ */
+, isMouseOverElem: function (evt, el) {
+ var
+ $E = $(el || this)
+ , d = $E.offset()
+ , T = d.top
+ , L = d.left
+ , R = L + $E.outerWidth()
+ , B = T + $E.outerHeight()
+ , x = evt.pageX // evt.clientX ?
+ , y = evt.pageY // evt.clientY ?
+ ;
+ // if X & Y are < 0, probably means is over an open SELECT
+ return ($.layout.browser.msie && x < 0 && y < 0) || ((x >= L && x <= R) && (y >= T && y <= B));
+ }
+
+ /**
+ * Message/Logging Utility
+ *
+ * @example $.layout.msg("My message"); // log text
+ * @example $.layout.msg("My message", true); // alert text
+ * @example $.layout.msg({ foo: "bar" }, "Title"); // log hash-data, with custom title
+ * @example $.layout.msg({ foo: "bar" }, true, "Title", { sort: false }); -OR-
+ * @example $.layout.msg({ foo: "bar" }, "Title", { sort: false, display: true }); // alert hash-data
+ *
+ * @param {(Object|string)} info String message OR Hash/Array
+ * @param {(Boolean|string|Object)=} [popup=false] True means alert-box - can be skipped
+ * @param {(Object|string)=} [debugTitle=""] Title for Hash data - can be skipped
+ * @param {Object=} [debugOpts] Extra options for debug output
+ */
+, msg: function (info, popup, debugTitle, debugOpts) {
+ if ($.isPlainObject(info) && window.debugData) {
+ if (typeof popup === "string") {
+ debugOpts = debugTitle;
+ debugTitle = popup;
+ }
+ else if (typeof debugTitle === "object") {
+ debugOpts = debugTitle;
+ debugTitle = null;
+ }
+ var t = debugTitle || "log( )"
+ , o = $.extend({ sort: false, returnHTML: false, display: false }, debugOpts);
+ if (popup === true || o.display)
+ debugData( info, t, o );
+ else if (window.console)
+ console.log(debugData( info, t, o ));
+ }
+ else if (popup)
+ alert(info);
+ else if (window.console)
+ console.log(info);
+ else {
+ var id = "#layoutLogger"
+ , $l = $(id);
+ if (!$l.length)
+ $l = createLog();
+ $l.children("ul").append(''+ info.replace(/\/g,">") +' ');
+ }
+
+ function createLog () {
+ var pos = $.support.fixedPosition ? 'fixed' : 'absolute'
+ , $e = $(''
+ + '
'
+ + 'X Layout console.log
'
+ + '
'
+ + '
0) {
+ if (autoHide && $E.data('autoHidden') && $E.innerHeight() > 0) {
+ $E.show().data('autoHidden', false);
+ if (!browser.mozilla) // FireFox refreshes iframes - IE does not
+ // make hidden, then visible to 'refresh' display after animation
+ $E.css(_c.hidden).css(_c.visible);
+ }
+ }
+ else if (autoHide && !$E.data('autoHidden'))
+ $E.hide().data('autoHidden', true);
+ }
+
+ /**
+ * @param {(string|!Object)} el
+ * @param {number=} outerHeight
+ * @param {boolean=} [autoHide=false]
+ */
+, setOuterHeight = function (el, outerHeight, autoHide) {
+ var $E = el, h;
+ if (isStr(el)) $E = $Ps[el]; // west
+ else if (!el.jquery) $E = $(el);
+ h = cssH($E, outerHeight);
+ $E.css({ height: h, visibility: "visible" }); // may have been 'hidden' by sizeContent
+ if (h > 0 && $E.innerWidth() > 0) {
+ if (autoHide && $E.data('autoHidden')) {
+ $E.show().data('autoHidden', false);
+ if (!browser.mozilla) // FireFox refreshes iframes - IE does not
+ $E.css(_c.hidden).css(_c.visible);
+ }
+ }
+ else if (autoHide && !$E.data('autoHidden'))
+ $E.hide().data('autoHidden', true);
+ }
+
+ /**
+ * @param {(string|!Object)} el
+ * @param {number=} outerSize
+ * @param {boolean=} [autoHide=false]
+ */
+, setOuterSize = function (el, outerSize, autoHide) {
+ if (_c[pane].dir=="horz") // pane = north or south
+ setOuterHeight(el, outerSize, autoHide);
+ else // pane = east or west
+ setOuterWidth(el, outerSize, autoHide);
+ }
+
+
+ /**
+ * Converts any 'size' params to a pixel/integer size, if not already
+ * If 'auto' or a decimal/percentage is passed as 'size', a pixel-size is calculated
+ *
+ /**
+ * @param {string} pane
+ * @param {(string|number)=} size
+ * @param {string=} [dir]
+ * @return {number}
+ */
+, _parseSize = function (pane, size, dir) {
+ if (!dir) dir = _c[pane].dir;
+
+ if (isStr(size) && size.match(/%/))
+ size = (size === '100%') ? -1 : parseInt(size, 10) / 100; // convert % to decimal
+
+ if (size === 0)
+ return 0;
+ else if (size >= 1)
+ return parseInt(size, 10);
+
+ var o = options, avail = 0;
+ if (dir=="horz") // north or south or center.minHeight
+ avail = sC.innerHeight - ($Ps.north ? o.north.spacing_open : 0) - ($Ps.south ? o.south.spacing_open : 0);
+ else if (dir=="vert") // east or west or center.minWidth
+ avail = sC.innerWidth - ($Ps.west ? o.west.spacing_open : 0) - ($Ps.east ? o.east.spacing_open : 0);
+
+ if (size === -1) // -1 == 100%
+ return avail;
+ else if (size > 0) // percentage, eg: .25
+ return round(avail * size);
+ else if (pane=="center")
+ return 0;
+ else { // size < 0 || size=='auto' || size==Missing || size==Invalid
+ // auto-size the pane
+ var dim = (dir === "horz" ? "height" : "width")
+ , $P = $Ps[pane]
+ , $C = dim === 'height' ? $Cs[pane] : false
+ , vis = $.layout.showInvisibly($P) // show pane invisibly if hidden
+ , szP = $P.css(dim) // SAVE current pane size
+ , szC = $C ? $C.css(dim) : 0 // SAVE current content size
+ ;
+ $P.css(dim, "auto");
+ if ($C) $C.css(dim, "auto");
+ size = (dim === "height") ? $P.outerHeight() : $P.outerWidth(); // MEASURE
+ $P.css(dim, szP).css(vis); // RESET size & visibility
+ if ($C) $C.css(dim, szC);
+ return size;
+ }
+ }
+
+ /**
+ * Calculates current 'size' (outer-width or outer-height) of a border-pane - optionally with 'pane-spacing' added
+ *
+ * @param {(string|!Object)} pane
+ * @param {boolean=} [inclSpace=false]
+ * @return {number} Returns EITHER Width for east/west panes OR Height for north/south panes
+ */
+, getPaneSize = function (pane, inclSpace) {
+ var
+ $P = $Ps[pane]
+ , o = options[pane]
+ , s = state[pane]
+ , oSp = (inclSpace ? o.spacing_open : 0)
+ , cSp = (inclSpace ? o.spacing_closed : 0)
+ ;
+ if (!$P || s.isHidden)
+ return 0;
+ else if (s.isClosed || (s.isSliding && inclSpace))
+ return cSp;
+ else if (_c[pane].dir === "horz")
+ return $P.outerHeight() + oSp;
+ else // dir === "vert"
+ return $P.outerWidth() + oSp;
+ }
+
+ /**
+ * Calculate min/max pane dimensions and limits for resizing
+ *
+ * @param {string} pane
+ * @param {boolean=} [slide=false]
+ */
+, setSizeLimits = function (pane, slide) {
+ if (!isInitialized()) return;
+ var
+ o = options[pane]
+ , s = state[pane]
+ , c = _c[pane]
+ , dir = c.dir
+ , side = c.side.toLowerCase()
+ , type = c.sizeType.toLowerCase()
+ , isSliding = (slide != undefined ? slide : s.isSliding) // only open() passes 'slide' param
+ , $P = $Ps[pane]
+ , paneSpacing = o.spacing_open
+ // measure the pane on the *opposite side* from this pane
+ , altPane = _c.oppositeEdge[pane]
+ , altS = state[altPane]
+ , $altP = $Ps[altPane]
+ , altPaneSize = (!$altP || altS.isVisible===false || altS.isSliding ? 0 : (dir=="horz" ? $altP.outerHeight() : $altP.outerWidth()))
+ , altPaneSpacing = ((!$altP || altS.isHidden ? 0 : options[altPane][ altS.isClosed !== false ? "spacing_closed" : "spacing_open" ]) || 0)
+ // limitSize prevents this pane from 'overlapping' opposite pane
+ , containerSize = (dir=="horz" ? sC.innerHeight : sC.innerWidth)
+ , minCenterDims = cssMinDims("center")
+ , minCenterSize = dir=="horz" ? max(options.center.minHeight, minCenterDims.minHeight) : max(options.center.minWidth, minCenterDims.minWidth)
+ // if pane is 'sliding', then ignore center and alt-pane sizes - because 'overlays' them
+ , limitSize = (containerSize - paneSpacing - (isSliding ? 0 : (_parseSize("center", minCenterSize, dir) + altPaneSize + altPaneSpacing)))
+ , minSize = s.minSize = max( _parseSize(pane, o.minSize), cssMinDims(pane).minSize )
+ , maxSize = s.maxSize = min( (o.maxSize ? _parseSize(pane, o.maxSize) : 100000), limitSize )
+ , r = s.resizerPosition = {} // used to set resizing limits
+ , top = sC.insetTop
+ , left = sC.insetLeft
+ , W = sC.innerWidth
+ , H = sC.innerHeight
+ , rW = o.spacing_open // subtract resizer-width to get top/left position for south/east
+ ;
+ switch (pane) {
+ case "north": r.min = top + minSize;
+ r.max = top + maxSize;
+ break;
+ case "west": r.min = left + minSize;
+ r.max = left + maxSize;
+ break;
+ case "south": r.min = top + H - maxSize - rW;
+ r.max = top + H - minSize - rW;
+ break;
+ case "east": r.min = left + W - maxSize - rW;
+ r.max = left + W - minSize - rW;
+ break;
+ };
+ }
+
+ /**
+ * Returns data for setting the size/position of center pane. Also used to set Height for east/west panes
+ *
+ * @return JSON Returns a hash of all dimensions: top, bottom, left, right, (outer) width and (outer) height
+ */
+, calcNewCenterPaneDims = function () {
+ var d = {
+ top: getPaneSize("north", true) // true = include 'spacing' value for pane
+ , bottom: getPaneSize("south", true)
+ , left: getPaneSize("west", true)
+ , right: getPaneSize("east", true)
+ , width: 0
+ , height: 0
+ };
+
+ // NOTE: sC = state.container
+ // calc center-pane outer dimensions
+ d.width = sC.innerWidth - d.left - d.right; // outerWidth
+ d.height = sC.innerHeight - d.bottom - d.top; // outerHeight
+ // add the 'container border/padding' to get final positions relative to the container
+ d.top += sC.insetTop;
+ d.bottom += sC.insetBottom;
+ d.left += sC.insetLeft;
+ d.right += sC.insetRight;
+
+ return d;
+ }
+
+
+ /**
+ * @param {!Object} el
+ * @param {boolean=} [allStates=false]
+ */
+, getHoverClasses = function (el, allStates) {
+ var
+ $El = $(el)
+ , type = $El.data("layoutRole")
+ , pane = $El.data("layoutEdge")
+ , o = options[pane]
+ , root = o[type +"Class"]
+ , _pane = "-"+ pane // eg: "-west"
+ , _open = "-open"
+ , _closed = "-closed"
+ , _slide = "-sliding"
+ , _hover = "-hover " // NOTE the trailing space
+ , _state = $El.hasClass(root+_closed) ? _closed : _open
+ , _alt = _state === _closed ? _open : _closed
+ , classes = (root+_hover) + (root+_pane+_hover) + (root+_state+_hover) + (root+_pane+_state+_hover)
+ ;
+ if (allStates) // when 'removing' classes, also remove alternate-state classes
+ classes += (root+_alt+_hover) + (root+_pane+_alt+_hover);
+
+ if (type=="resizer" && $El.hasClass(root+_slide))
+ classes += (root+_slide+_hover) + (root+_pane+_slide+_hover);
+
+ return $.trim(classes);
+ }
+, addHover = function (evt, el) {
+ var $E = $(el || this);
+ if (evt && $E.data("layoutRole") === "toggler")
+ evt.stopPropagation(); // prevent triggering 'slide' on Resizer-bar
+ $E.addClass( getHoverClasses($E) );
+ }
+, removeHover = function (evt, el) {
+ var $E = $(el || this);
+ $E.removeClass( getHoverClasses($E, true) );
+ }
+
+, onResizerEnter = function (evt) { // ALSO called by toggler.mouseenter
+ if ($.fn.disableSelection)
+ $("body").disableSelection();
+ }
+, onResizerLeave = function (evt, el) {
+ var
+ e = el || this // el is only passed when called by the timer
+ , pane = $(e).data("layoutEdge")
+ , name = pane +"ResizerLeave"
+ ;
+ timer.clear(pane+"_openSlider"); // cancel slideOpen timer, if set
+ timer.clear(name); // cancel enableSelection timer - may re/set below
+ // this method calls itself on a timer because it needs to allow
+ // enough time for dragging to kick-in and set the isResizing flag
+ // dragging has a 100ms delay set, so this delay must be >100
+ if (!el) // 1st call - mouseleave event
+ timer.set(name, function(){ onResizerLeave(evt, e); }, 200);
+ // if user is resizing, then dragStop will enableSelection(), so can skip it here
+ else if (!state[pane].isResizing && $.fn.enableSelection) // 2nd call - by timer
+ $("body").enableSelection();
+ }
+
+/*
+ * ###########################
+ * INITIALIZATION METHODS
+ * ###########################
+ */
+
+ /**
+ * Initialize the layout - called automatically whenever an instance of layout is created
+ *
+ * @see none - triggered onInit
+ * @return mixed true = fully initialized | false = panes not initialized (yet) | 'cancel' = abort
+ */
+, _create = function () {
+ // initialize config/options
+ initOptions();
+ var o = options;
+
+ // TEMP state so isInitialized returns true during init process
+ state.creatingLayout = true;
+
+ // init plugins for this layout, if there are any (eg: stateManagement)
+ runPluginCallbacks( Instance, $.layout.onCreate );
+
+ // options & state have been initialized, so now run beforeLoad callback
+ // onload will CANCEL layout creation if it returns false
+ if (false === _runCallbacks("onload_start"))
+ return 'cancel';
+
+ // initialize the container element
+ _initContainer();
+
+ // bind hotkey function - keyDown - if required
+ initHotkeys();
+
+ // bind window.onunload
+ $(window).bind("unload."+ sID, unload);
+
+ // init plugins for this layout, if there are any (eg: customButtons)
+ runPluginCallbacks( Instance, $.layout.onLoad );
+
+ // if layout elements are hidden, then layout WILL NOT complete initialization!
+ // initLayoutElements will set initialized=true and run the onload callback IF successful
+ if (o.initPanes) _initLayoutElements();
+
+ delete state.creatingLayout;
+
+ return state.initialized;
+ }
+
+ /**
+ * Initialize the layout IF not already
+ *
+ * @see All methods in Instance run this test
+ * @return boolean true = layoutElements have been initialized | false = panes are not initialized (yet)
+ */
+, isInitialized = function () {
+ if (state.initialized || state.creatingLayout) return true; // already initialized
+ else return _initLayoutElements(); // try to init panes NOW
+ }
+
+ /**
+ * Initialize the layout - called automatically whenever an instance of layout is created
+ *
+ * @see _create() & isInitialized
+ * @return An object pointer to the instance created
+ */
+, _initLayoutElements = function (retry) {
+ // initialize config/options
+ var o = options;
+
+ // CANNOT init panes inside a hidden container!
+ if (!$N.is(":visible")) {
+ // handle Chrome bug where popup window 'has no height'
+ // if layout is BODY element, try again in 50ms
+ // SEE: http://layout.jquery-dev.net/samples/test_popup_window.html
+ if ( !retry && browser.webkit && $N[0].tagName === "BODY" )
+ setTimeout(function(){ _initLayoutElements(true); }, 50);
+ return false;
+ }
+
+ // a center pane is required, so make sure it exists
+ if (!getPane("center").length) {
+ return _log( o.errors.centerPaneMissing );
+ }
+
+ // TEMP state so isInitialized returns true during init process
+ state.creatingLayout = true;
+
+ // update Container dims
+ $.extend(sC, elDims( $N ));
+
+ // initialize all layout elements
+ initPanes(); // size & position panes - calls initHandles() - which calls initResizable()
+
+ if (o.scrollToBookmarkOnLoad) {
+ var l = self.location;
+ if (l.hash) l.replace( l.hash ); // scrollTo Bookmark
+ }
+
+ // check to see if this layout 'nested' inside a pane
+ if (Instance.hasParentLayout)
+ o.resizeWithWindow = false;
+ // bind resizeAll() for 'this layout instance' to window.resize event
+ else if (o.resizeWithWindow)
+ $(window).bind("resize."+ sID, windowResize);
+
+ delete state.creatingLayout;
+ state.initialized = true;
+
+ // init plugins for this layout, if there are any
+ runPluginCallbacks( Instance, $.layout.onReady );
+
+ // now run the onload callback, if exists
+ _runCallbacks("onload_end");
+
+ return true; // elements initialized successfully
+ }
+
+ /**
+ * Initialize nested layouts - called when _initLayoutElements completes
+ *
+ * NOT CURRENTLY USED
+ *
+ * @see _initLayoutElements
+ * @return An object pointer to the instance created
+ */
+, _initChildLayouts = function () {
+ $.each(_c.allPanes, function (idx, pane) {
+ if (options[pane].initChildLayout)
+ createChildLayout( pane );
+ });
+ }
+
+ /**
+ * Initialize nested layouts for a specific pane - can optionally pass layout-options
+ *
+ * @see _initChildLayouts
+ * @param {string|Object} evt_or_pane The pane being opened, ie: north, south, east, or west
+ * @param {Object=} [opts] Layout-options - if passed, will OVERRRIDE options[pane].childOptions
+ * @return An object pointer to the layout instance created - or null
+ */
+, createChildLayout = function (evt_or_pane, opts) {
+ var pane = evtPane.call(this, evt_or_pane)
+ , $P = $Ps[pane]
+ , C = children
+ ;
+ if ($P) {
+ var $C = $Cs[pane]
+ , o = opts || options[pane].childOptions
+ , d = "layout"
+ // determine which element is supposed to be the 'child container'
+ // if pane has a 'containerSelector' OR a 'content-div', use those instead of the pane
+ , $Cont = o.containerSelector ? $P.find( o.containerSelector ) : ($C || $P)
+ , containerFound = $Cont.length
+ // see if a child-layout ALREADY exists on this element
+ , child = containerFound ? (C[pane] = $Cont.data(d) || null) : null
+ ;
+ // if no layout exists, but childOptions are set, try to create the layout now
+ if (!child && containerFound && o)
+ child = C[pane] = $Cont.eq(0).layout(o) || null;
+ if (child)
+ child.hasParentLayout = true; // set parent-flag in child
+ }
+ Instance[pane].child = C[pane]; // ALWAYS set pane-object pointer, even if null
+ }
+
+, windowResize = function () {
+ var delay = Number(options.resizeWithWindowDelay);
+ if (delay < 10) delay = 100; // MUST have a delay!
+ // resizing uses a delay-loop because the resize event fires repeatly - except in FF, but delay anyway
+ timer.clear("winResize"); // if already running
+ timer.set("winResize", function(){
+ timer.clear("winResize");
+ timer.clear("winResizeRepeater");
+ var dims = elDims( $N );
+ // only trigger resizeAll() if container has changed size
+ if (dims.innerWidth !== sC.innerWidth || dims.innerHeight !== sC.innerHeight)
+ resizeAll();
+ }, delay);
+ // ALSO set fixed-delay timer, if not already running
+ if (!timer.data["winResizeRepeater"]) setWindowResizeRepeater();
+ }
+
+, setWindowResizeRepeater = function () {
+ var delay = Number(options.resizeWithWindowMaxDelay);
+ if (delay > 0)
+ timer.set("winResizeRepeater", function(){ setWindowResizeRepeater(); resizeAll(); }, delay);
+ }
+
+, unload = function () {
+ var o = options;
+
+ _runCallbacks("onunload_start");
+
+ // trigger plugin callabacks for this layout (eg: stateManagement)
+ runPluginCallbacks( Instance, $.layout.onUnload );
+
+ _runCallbacks("onunload_end");
+ }
+
+ /**
+ * Validate and initialize container CSS and events
+ *
+ * @see _create()
+ */
+, _initContainer = function () {
+ var
+ N = $N[0]
+ , tag = sC.tagName = N.tagName
+ , id = sC.id = N.id
+ , cls = sC.className = N.className
+ , o = options
+ , name = o.name
+ , fullPage= (tag === "BODY")
+ , props = "overflow,position,margin,padding,border"
+ , css = "layoutCSS"
+ , CSS = {}
+ , hid = "hidden" // used A LOT!
+ // see if this container is a 'pane' inside an outer-layout
+ , parent = $N.data("parentLayout") // parent-layout Instance
+ , pane = $N.data("layoutEdge") // pane-name in parent-layout
+ , isChild = parent && pane
+ ;
+ // sC -> state.container
+ sC.selector = $N.selector.split(".slice")[0];
+ sC.ref = (o.name ? o.name +' layout / ' : '') + tag + (id ? "#"+id : cls ? '.['+cls+']' : ''); // used in messages
+
+ $N .data({
+ layout: Instance
+ , layoutContainer: sID // FLAG to indicate this is a layout-container - contains unique internal ID
+ })
+ .addClass(o.containerClass)
+ ;
+ var layoutMethods = {
+ destroy: ''
+ , initPanes: ''
+ , resizeAll: 'resizeAll'
+ , resize: 'resizeAll'
+ };
+ // loop hash and bind all methods - include layoutID namespacing
+ for (name in layoutMethods) {
+ $N.bind("layout"+ name.toLowerCase() +"."+ sID, Instance[ layoutMethods[name] || name ]);
+ }
+
+ // if this container is another layout's 'pane', then set child/parent pointers
+ if (isChild) {
+ // update parent flag
+ Instance.hasParentLayout = true;
+ // set pointers to THIS child-layout (Instance) in parent-layout
+ // NOTE: parent.PANE.child is an ALIAS to parent.children.PANE
+ parent[pane].child = parent.children[pane] = $N.data("layout");
+ }
+
+ // SAVE original container CSS for use in destroy()
+ if (!$N.data(css)) {
+ // handle props like overflow different for BODY & HTML - has 'system default' values
+ if (fullPage) {
+ CSS = $.extend( elCSS($N, props), {
+ height: $N.css("height")
+ , overflow: $N.css("overflow")
+ , overflowX: $N.css("overflowX")
+ , overflowY: $N.css("overflowY")
+ });
+ // ALSO SAVE CSS
+ var $H = $("html");
+ $H.data(css, {
+ height: "auto" // FF would return a fixed px-size!
+ , overflow: $H.css("overflow")
+ , overflowX: $H.css("overflowX")
+ , overflowY: $H.css("overflowY")
+ });
+ }
+ else // handle props normally for non-body elements
+ CSS = elCSS($N, props+",top,bottom,left,right,width,height,overflow,overflowX,overflowY");
+
+ $N.data(css, CSS);
+ }
+
+ try { // format html/body if this is a full page layout
+ if (fullPage) {
+ $("html").css({
+ height: "100%"
+ , overflow: hid
+ , overflowX: hid
+ , overflowY: hid
+ });
+ $("body").css({
+ position: "relative"
+ , height: "100%"
+ , overflow: hid
+ , overflowX: hid
+ , overflowY: hid
+ , margin: 0
+ , padding: 0 // TODO: test whether body-padding could be handled?
+ , border: "none" // a body-border creates problems because it cannot be measured!
+ });
+
+ // set current layout-container dimensions
+ $.extend(sC, elDims( $N ));
+ }
+ else { // set required CSS for overflow and position
+ // ENSURE container will not 'scroll'
+ CSS = { overflow: hid, overflowX: hid, overflowY: hid }
+ var
+ p = $N.css("position")
+ , h = $N.css("height")
+ ;
+ // if this is a NESTED layout, then container/outer-pane ALREADY has position and height
+ if (!isChild) {
+ if (!p || !p.match(/fixed|absolute|relative/))
+ CSS.position = "relative"; // container MUST have a 'position'
+ /*
+ if (!h || h=="auto")
+ CSS.height = "100%"; // container MUST have a 'height'
+ */
+ }
+ $N.css( CSS );
+
+ // set current layout-container dimensions
+ if ( $N.is(":visible") ) {
+ $.extend(sC, elDims( $N ));
+ if (sC.innerHeight < 1)
+ _log( o.errors.noContainerHeight.replace(/CONTAINER/, sC.ref) );
+ }
+ }
+ } catch (ex) {}
+ }
+
+ /**
+ * Bind layout hotkeys - if options enabled
+ *
+ * @see _create() and addPane()
+ * @param {string=} [panes=""] The edge(s) to process
+ */
+, initHotkeys = function (panes) {
+ panes = panes ? panes.split(",") : _c.borderPanes;
+ // bind keyDown to capture hotkeys, if option enabled for ANY pane
+ $.each(panes, function (i, pane) {
+ var o = options[pane];
+ if (o.enableCursorHotkey || o.customHotkey) {
+ $(document).bind("keydown."+ sID, keyDown); // only need to bind this ONCE
+ return false; // BREAK - binding was done
+ }
+ });
+ }
+
+ /**
+ * Build final OPTIONS data
+ *
+ * @see _create()
+ */
+, initOptions = function () {
+ var data, d, pane, key, val, i, c, o;
+
+ // reprocess user's layout-options to have correct options sub-key structure
+ opts = $.layout.transformData( opts ); // panes = default subkey
+
+ // auto-rename old options for backward compatibility
+ opts = $.layout.backwardCompatibility.renameAllOptions( opts );
+
+ // if user-options has 'panes' key (pane-defaults), clean it...
+ if (!$.isEmptyObject(opts.panes)) {
+ // REMOVE any pane-defaults that MUST be set per-pane
+ data = $.layout.optionsMap.noDefault;
+ for (i=0, c=data.length; i 0) {
+ z.pane_normal = zo;
+ z.content_mask = max(zo+1, z.content_mask); // MIN = +1
+ z.resizer_normal = max(zo+2, z.resizer_normal); // MIN = +2
+ }
+
+ // DELETE 'panes' key now that we are done - values were copied to EACH pane
+ delete options.panes;
+
+
+ function createFxOptions ( pane ) {
+ var o = options[pane]
+ , d = options.panes;
+ // ensure fxSettings key to avoid errors
+ if (!o.fxSettings) o.fxSettings = {};
+ if (!d.fxSettings) d.fxSettings = {};
+
+ $.each(["_open","_close","_size"], function (i,n) {
+ var
+ sName = "fxName"+ n
+ , sSpeed = "fxSpeed"+ n
+ , sSettings = "fxSettings"+ n
+ // recalculate fxName according to specificity rules
+ , fxName = o[sName] =
+ o[sName] // options.west.fxName_open
+ || d[sName] // options.panes.fxName_open
+ || o.fxName // options.west.fxName
+ || d.fxName // options.panes.fxName
+ || "none" // MEANS $.layout.defaults.panes.fxName == "" || false || null || 0
+ ;
+ // validate fxName to ensure is valid effect - MUST have effect-config data in options.effects
+ if (fxName === "none" || !$.effects || !$.effects[fxName] || !options.effects[fxName])
+ fxName = o[sName] = "none"; // effect not loaded OR unrecognized fxName
+
+ // set vars for effects subkeys to simplify logic
+ var fx = options.effects[fxName] || {} // effects.slide
+ , fx_all = fx.all || null // effects.slide.all
+ , fx_pane = fx[pane] || null // effects.slide.west
+ ;
+ // create fxSpeed[_open|_close|_size]
+ o[sSpeed] =
+ o[sSpeed] // options.west.fxSpeed_open
+ || d[sSpeed] // options.west.fxSpeed_open
+ || o.fxSpeed // options.west.fxSpeed
+ || d.fxSpeed // options.panes.fxSpeed
+ || null // DEFAULT - let fxSetting.duration control speed
+ ;
+ // create fxSettings[_open|_close|_size]
+ o[sSettings] = $.extend(
+ true
+ , {}
+ , fx_all // effects.slide.all
+ , fx_pane // effects.slide.west
+ , d.fxSettings // options.panes.fxSettings
+ , o.fxSettings // options.west.fxSettings
+ , d[sSettings] // options.panes.fxSettings_open
+ , o[sSettings] // options.west.fxSettings_open
+ );
+ });
+
+ // DONE creating action-specific-settings for this pane,
+ // so DELETE generic options - are no longer meaningful
+ delete o.fxName;
+ delete o.fxSpeed;
+ delete o.fxSettings;
+ }
+ }
+
+ /**
+ * Initialize module objects, styling, size and position for all panes
+ *
+ * @see _initElements()
+ * @param {string} pane The pane to process
+ */
+, getPane = function (pane) {
+ var sel = options[pane].paneSelector
+ if (sel.substr(0,1)==="#") // ID selector
+ // NOTE: elements selected 'by ID' DO NOT have to be 'children'
+ return $N.find(sel).eq(0);
+ else { // class or other selector
+ var $P = $N.children(sel).eq(0);
+ // look for the pane nested inside a 'form' element
+ return $P.length ? $P : $N.children("form:first").children(sel).eq(0);
+ }
+ }
+
+, initPanes = function (evt) {
+ // stopPropagation if called by trigger("layoutinitpanes") - use evtPane utility
+ evtPane(evt);
+
+ // NOTE: do north & south FIRST so we can measure their height - do center LAST
+ $.each(_c.allPanes, function (idx, pane) {
+ addPane( pane, true );
+ });
+
+ // init the pane-handles NOW in case we have to hide or close the pane below
+ initHandles();
+
+ // now that all panes have been initialized and initially-sized,
+ // make sure there is really enough space available for each pane
+ $.each(_c.borderPanes, function (i, pane) {
+ if ($Ps[pane] && state[pane].isVisible) { // pane is OPEN
+ setSizeLimits(pane);
+ makePaneFit(pane); // pane may be Closed, Hidden or Resized by makePaneFit()
+ }
+ });
+ // size center-pane AGAIN in case we 'closed' a border-pane in loop above
+ sizeMidPanes("center");
+
+ // Chrome/Webkit sometimes fires callbacks BEFORE it completes resizing!
+ // Before RC30.3, there was a 10ms delay here, but that caused layout
+ // to load asynchrously, which is BAD, so try skipping delay for now
+
+ // process pane contents and callbacks, and init/resize child-layout if exists
+ $.each(_c.allPanes, function (i, pane) {
+ var o = options[pane];
+ if ($Ps[pane]) {
+ if (state[pane].isVisible) { // pane is OPEN
+ sizeContent(pane);
+ // trigger pane.onResize if triggerEventsOnLoad = true
+ if (o.triggerEventsOnLoad)
+ _runCallbacks("onresize_end", pane);
+ else // automatic if onresize called, otherwise call it specifically
+ // resize child - IF inner-layout already exists (created before this layout)
+ resizeChildLayout(pane);
+ }
+ // init childLayout - even if pane is not visible
+ if (o.initChildLayout && o.childOptions)
+ createChildLayout(pane);
+ }
+ });
+ }
+
+ /**
+ * Add a pane to the layout - subroutine of initPanes()
+ *
+ * @see initPanes()
+ * @param {string} pane The pane to process
+ * @param {boolean=} [force=false] Size content after init
+ */
+, addPane = function (pane, force) {
+ if (!force && !isInitialized()) return;
+ var
+ o = options[pane]
+ , s = state[pane]
+ , c = _c[pane]
+ , fx = s.fx
+ , dir = c.dir
+ , spacing = o.spacing_open || 0
+ , isCenter = (pane === "center")
+ , CSS = {}
+ , $P = $Ps[pane]
+ , size, minSize, maxSize
+ ;
+ // if pane-pointer already exists, remove the old one first
+ if ($P)
+ removePane( pane, false, true, false );
+ else
+ $Cs[pane] = false; // init
+
+ $P = $Ps[pane] = getPane(pane);
+ if (!$P.length) {
+ $Ps[pane] = false; // logic
+ return;
+ }
+
+ // SAVE original Pane CSS
+ if (!$P.data("layoutCSS")) {
+ var props = "position,top,left,bottom,right,width,height,overflow,zIndex,display,backgroundColor,padding,margin,border";
+ $P.data("layoutCSS", elCSS($P, props));
+ }
+
+ // create alias for pane data in Instance - initHandles will add more
+ Instance[pane] = { name: pane, pane: $Ps[pane], content: $Cs[pane], options: options[pane], state: state[pane], child: children[pane] };
+
+ // add classes, attributes & events
+ $P .data({
+ parentLayout: Instance // pointer to Layout Instance
+ , layoutPane: Instance[pane] // NEW pointer to pane-alias-object
+ , layoutEdge: pane
+ , layoutRole: "pane"
+ })
+ .css(c.cssReq).css("zIndex", options.zIndexes.pane_normal)
+ .css(o.applyDemoStyles ? c.cssDemo : {}) // demo styles
+ .addClass( o.paneClass +" "+ o.paneClass+"-"+pane ) // default = "ui-layout-pane ui-layout-pane-west" - may be a dupe of 'paneSelector'
+ .bind("mouseenter."+ sID, addHover )
+ .bind("mouseleave."+ sID, removeHover )
+ ;
+ var paneMethods = {
+ hide: ''
+ , show: ''
+ , toggle: ''
+ , close: ''
+ , open: ''
+ , slideOpen: ''
+ , slideClose: ''
+ , slideToggle: ''
+ , size: 'sizePane'
+ , sizePane: 'sizePane'
+ , sizeContent: ''
+ , sizeHandles: ''
+ , enableClosable: ''
+ , disableClosable: ''
+ , enableSlideable: ''
+ , disableSlideable: ''
+ , enableResizable: ''
+ , disableResizable: ''
+ , swapPanes: 'swapPanes'
+ , swap: 'swapPanes'
+ , move: 'swapPanes'
+ , removePane: 'removePane'
+ , remove: 'removePane'
+ , createChildLayout: ''
+ , resizeChildLayout: ''
+ , resizeAll: 'resizeAll'
+ , resizeLayout: 'resizeAll'
+ }
+ , name;
+ // loop hash and bind all methods - include layoutID namespacing
+ for (name in paneMethods) {
+ $P.bind("layoutpane"+ name.toLowerCase() +"."+ sID, Instance[ paneMethods[name] || name ]);
+ }
+
+ // see if this pane has a 'scrolling-content element'
+ initContent(pane, false); // false = do NOT sizeContent() - called later
+
+ if (!isCenter) {
+ // call _parseSize AFTER applying pane classes & styles - but before making visible (if hidden)
+ // if o.size is auto or not valid, then MEASURE the pane and use that as its 'size'
+ size = s.size = _parseSize(pane, o.size);
+ minSize = _parseSize(pane,o.minSize) || 1;
+ maxSize = _parseSize(pane,o.maxSize) || 100000;
+ if (size > 0) size = max(min(size, maxSize), minSize);
+
+ // state for border-panes
+ s.isClosed = false; // true = pane is closed
+ s.isSliding = false; // true = pane is currently open by 'sliding' over adjacent panes
+ s.isResizing= false; // true = pane is in process of being resized
+ s.isHidden = false; // true = pane is hidden - no spacing, resizer or toggler is visible!
+
+ // array for 'pin buttons' whose classNames are auto-updated on pane-open/-close
+ if (!s.pins) s.pins = [];
+ }
+ // states common to ALL panes
+ s.tagName = $P[0].tagName;
+ s.edge = pane; // useful if pane is (or about to be) 'swapped' - easy find out where it is (or is going)
+ s.noRoom = false; // true = pane 'automatically' hidden due to insufficient room - will unhide automatically
+ s.isVisible = true; // false = pane is invisible - closed OR hidden - simplify logic
+
+ // set css-position to account for container borders & padding
+ switch (pane) {
+ case "north": CSS.top = sC.insetTop;
+ CSS.left = sC.insetLeft;
+ CSS.right = sC.insetRight;
+ break;
+ case "south": CSS.bottom = sC.insetBottom;
+ CSS.left = sC.insetLeft;
+ CSS.right = sC.insetRight;
+ break;
+ case "west": CSS.left = sC.insetLeft; // top, bottom & height set by sizeMidPanes()
+ break;
+ case "east": CSS.right = sC.insetRight; // ditto
+ break;
+ case "center": // top, left, width & height set by sizeMidPanes()
+ }
+
+ if (dir === "horz") // north or south pane
+ CSS.height = cssH($P, size);
+ else if (dir === "vert") // east or west pane
+ CSS.width = cssW($P, size);
+ //else if (isCenter) {}
+
+ $P.css(CSS); // apply size -- top, bottom & height will be set by sizeMidPanes
+ if (dir != "horz") sizeMidPanes(pane, true); // true = skipCallback
+
+ // close or hide the pane if specified in settings
+ if (o.initClosed && o.closable && !o.initHidden)
+ close(pane, true, true); // true, true = force, noAnimation
+ else if (o.initHidden || o.initClosed)
+ hide(pane); // will be completely invisible - no resizer or spacing
+ else if (!s.noRoom)
+ // make the pane visible - in case was initially hidden
+ $P.css("display","block");
+ // ELSE setAsOpen() - called later by initHandles()
+
+ // RESET visibility now - pane will appear IF display:block
+ $P.css("visibility","visible");
+
+ // check option for auto-handling of pop-ups & drop-downs
+ if (o.showOverflowOnHover)
+ $P.hover( allowOverflow, resetOverflow );
+
+ // if manually adding a pane AFTER layout initialization, then...
+ if (state.initialized) {
+ initHandles( pane );
+ initHotkeys( pane );
+ resizeAll(); // will sizeContent if pane is visible
+ if (s.isVisible) { // pane is OPEN
+ if (o.triggerEventsOnLoad)
+ _runCallbacks("onresize_end", pane);
+ else // automatic if onresize called, otherwise call it specifically
+ // resize child - IF inner-layout already exists (created before this layout)
+ resizeChildLayout(pane); // a previously existing childLayout
+ }
+ if (o.initChildLayout && o.childOptions)
+ createChildLayout(pane);
+ }
+ }
+
+ /**
+ * Initialize module objects, styling, size and position for all resize bars and toggler buttons
+ *
+ * @see _create()
+ * @param {string=} [panes=""] The edge(s) to process
+ */
+, initHandles = function (panes) {
+ panes = panes ? panes.split(",") : _c.borderPanes;
+
+ // create toggler DIVs for each pane, and set object pointers for them, eg: $R.north = north toggler DIV
+ $.each(panes, function (i, pane) {
+ var $P = $Ps[pane];
+ $Rs[pane] = false; // INIT
+ $Ts[pane] = false;
+ if (!$P) return; // pane does not exist - skip
+
+ var
+ o = options[pane]
+ , s = state[pane]
+ , c = _c[pane]
+ , paneId = o.paneSelector.substr(0,1) === "#" ? o.paneSelector.substr(1) : ""
+ , rClass = o.resizerClass
+ , tClass = o.togglerClass
+ , side = c.side.toLowerCase()
+ , spacing = (s.isVisible ? o.spacing_open : o.spacing_closed)
+ , _pane = "-"+ pane // used for classNames
+ , _state = (s.isVisible ? "-open" : "-closed") // used for classNames
+ , I = Instance[pane]
+ // INIT RESIZER BAR
+ , $R = I.resizer = $Rs[pane] = $("
")
+ // INIT TOGGLER BUTTON
+ , $T = I.toggler = (o.closable ? $Ts[pane] = $("
") : false)
+ ;
+
+ //if (s.isVisible && o.resizable) ... handled by initResizable
+ if (!s.isVisible && o.slidable)
+ $R.attr("title", o.tips.Slide).css("cursor", o.sliderCursor);
+
+ $R // if paneSelector is an ID, then create a matching ID for the resizer, eg: "#paneLeft" => "paneLeft-resizer"
+ .attr("id", paneId ? paneId +"-resizer" : "" )
+ .data({
+ parentLayout: Instance
+ , layoutPane: Instance[pane] // NEW pointer to pane-alias-object
+ , layoutEdge: pane
+ , layoutRole: "resizer"
+ })
+ .css(_c.resizers.cssReq).css("zIndex", options.zIndexes.resizer_normal)
+ .css(o.applyDemoStyles ? _c.resizers.cssDemo : {}) // add demo styles
+ .addClass(rClass +" "+ rClass+_pane)
+ .hover(addHover, removeHover) // ALWAYS add hover-classes, even if resizing is not enabled - handle with CSS instead
+ .hover(onResizerEnter, onResizerLeave) // ALWAYS NEED resizer.mouseleave to balance toggler.mouseenter
+ .appendTo($N) // append DIV to container
+ ;
+
+ if ($T) {
+ $T // if paneSelector is an ID, then create a matching ID for the resizer, eg: "#paneLeft" => "#paneLeft-toggler"
+ .attr("id", paneId ? paneId +"-toggler" : "" )
+ .data({
+ parentLayout: Instance
+ , layoutPane: Instance[pane] // NEW pointer to pane-alias-object
+ , layoutEdge: pane
+ , layoutRole: "toggler"
+ })
+ .css(_c.togglers.cssReq) // add base/required styles
+ .css(o.applyDemoStyles ? _c.togglers.cssDemo : {}) // add demo styles
+ .addClass(tClass +" "+ tClass+_pane)
+ .hover(addHover, removeHover) // ALWAYS add hover-classes, even if toggling is not enabled - handle with CSS instead
+ .bind("mouseenter", onResizerEnter) // NEED toggler.mouseenter because mouseenter MAY NOT fire on resizer
+ .appendTo($R) // append SPAN to resizer DIV
+ ;
+ // ADD INNER-SPANS TO TOGGLER
+ if (o.togglerContent_open) // ui-layout-open
+ $(""+ o.togglerContent_open +" ")
+ .data({
+ layoutEdge: pane
+ , layoutRole: "togglerContent"
+ })
+ .data("layoutRole", "togglerContent")
+ .data("layoutEdge", pane)
+ .addClass("content content-open")
+ .css("display","none")
+ .appendTo( $T )
+ //.hover( addHover, removeHover ) // use ui-layout-toggler-west-hover .content-open instead!
+ ;
+ if (o.togglerContent_closed) // ui-layout-closed
+ $(""+ o.togglerContent_closed +" ")
+ .data({
+ layoutEdge: pane
+ , layoutRole: "togglerContent"
+ })
+ .addClass("content content-closed")
+ .css("display","none")
+ .appendTo( $T )
+ //.hover( addHover, removeHover ) // use ui-layout-toggler-west-hover .content-closed instead!
+ ;
+ // ADD TOGGLER.click/.hover
+ enableClosable(pane);
+ }
+
+ // add Draggable events
+ initResizable(pane);
+
+ // ADD CLASSNAMES & SLIDE-BINDINGS - eg: class="resizer resizer-west resizer-open"
+ if (s.isVisible)
+ setAsOpen(pane); // onOpen will be called, but NOT onResize
+ else {
+ setAsClosed(pane); // onClose will be called
+ bindStartSlidingEvent(pane, true); // will enable events IF option is set
+ }
+
+ });
+
+ // SET ALL HANDLE DIMENSIONS
+ sizeHandles();
+ }
+
+
+ /**
+ * Initialize scrolling ui-layout-content div - if exists
+ *
+ * @see initPane() - or externally after an Ajax injection
+ * @param {string} [pane] The pane to process
+ * @param {boolean=} [resize=true] Size content after init
+ */
+, initContent = function (pane, resize) {
+ if (!isInitialized()) return;
+ var
+ o = options[pane]
+ , sel = o.contentSelector
+ , I = Instance[pane]
+ , $P = $Ps[pane]
+ , $C
+ ;
+ if (sel) $C = I.content = $Cs[pane] = (o.findNestedContent)
+ ? $P.find(sel).eq(0) // match 1-element only
+ : $P.children(sel).eq(0)
+ ;
+ if ($C && $C.length) {
+ $C.data("layoutRole", "content");
+ // SAVE original Pane CSS
+ if (!$C.data("layoutCSS"))
+ $C.data("layoutCSS", elCSS($C, "height"));
+ $C.css( _c.content.cssReq );
+ if (o.applyDemoStyles) {
+ $C.css( _c.content.cssDemo ); // add padding & overflow: auto to content-div
+ $P.css( _c.content.cssDemoPane ); // REMOVE padding/scrolling from pane
+ }
+ state[pane].content = {}; // init content state
+ if (resize !== false) sizeContent(pane);
+ // sizeContent() is called AFTER init of all elements
+ }
+ else
+ I.content = $Cs[pane] = false;
+ }
+
+
+ /**
+ * Add resize-bars to all panes that specify it in options
+ * -dependancy: $.fn.resizable - will skip if not found
+ *
+ * @see _create()
+ * @param {string=} [panes=""] The edge(s) to process
+ */
+, initResizable = function (panes) {
+ var draggingAvailable = $.layout.plugins.draggable
+ , side // set in start()
+ ;
+ panes = panes ? panes.split(",") : _c.borderPanes;
+
+ $.each(panes, function (idx, pane) {
+ var o = options[pane];
+ if (!draggingAvailable || !$Ps[pane] || !o.resizable) {
+ o.resizable = false;
+ return true; // skip to next
+ }
+
+ var s = state[pane]
+ , z = options.zIndexes
+ , c = _c[pane]
+ , side = c.dir=="horz" ? "top" : "left"
+ , opEdge = _c.oppositeEdge[pane]
+ , masks = pane +",center,"+ opEdge + (c.dir=="horz" ? ",west,east" : "")
+ , $P = $Ps[pane]
+ , $R = $Rs[pane]
+ , base = o.resizerClass
+ , lastPos = 0 // used when live-resizing
+ , r, live // set in start because may change
+ // 'drag' classes are applied to the ORIGINAL resizer-bar while dragging is in process
+ , resizerClass = base+"-drag" // resizer-drag
+ , resizerPaneClass = base+"-"+pane+"-drag" // resizer-north-drag
+ // 'helper' class is applied to the CLONED resizer-bar while it is being dragged
+ , helperClass = base+"-dragging" // resizer-dragging
+ , helperPaneClass = base+"-"+pane+"-dragging" // resizer-north-dragging
+ , helperLimitClass = base+"-dragging-limit" // resizer-drag
+ , helperPaneLimitClass = base+"-"+pane+"-dragging-limit" // resizer-north-drag
+ , helperClassesSet = false // logic var
+ ;
+
+ if (!s.isClosed)
+ $R.attr("title", o.tips.Resize)
+ .css("cursor", o.resizerCursor); // n-resize, s-resize, etc
+
+ $R.draggable({
+ containment: $N[0] // limit resizing to layout container
+ , axis: (c.dir=="horz" ? "y" : "x") // limit resizing to horz or vert axis
+ , delay: 0
+ , distance: 1
+ , grid: o.resizingGrid
+ // basic format for helper - style it using class: .ui-draggable-dragging
+ , helper: "clone"
+ , opacity: o.resizerDragOpacity
+ , addClasses: false // avoid ui-state-disabled class when disabled
+ //, iframeFix: o.draggableIframeFix // TODO: consider using when bug is fixed
+ , zIndex: z.resizer_drag
+
+ , start: function (e, ui) {
+ // REFRESH options & state pointers in case we used swapPanes
+ o = options[pane];
+ s = state[pane];
+ // re-read options
+ live = o.livePaneResizing;
+
+ // ondrag_start callback - will CANCEL hide if returns false
+ // TODO: dragging CANNOT be cancelled like this, so see if there is a way?
+ if (false === _runCallbacks("ondrag_start", pane)) return false;
+
+ s.isResizing = true; // prevent pane from closing while resizing
+ timer.clear(pane+"_closeSlider"); // just in case already triggered
+
+ // SET RESIZER LIMITS - used in drag()
+ setSizeLimits(pane); // update pane/resizer state
+ r = s.resizerPosition;
+ lastPos = ui.position[ side ]
+
+ $R.addClass( resizerClass +" "+ resizerPaneClass ); // add drag classes
+ helperClassesSet = false; // reset logic var - see drag()
+
+ // DISABLE TEXT SELECTION (probably already done by resizer.mouseOver)
+ $('body').disableSelection();
+
+ // MASK PANES CONTAINING IFRAMES, APPLETS OR OTHER TROUBLESOME ELEMENTS
+ showMasks( masks );
+ }
+
+ , drag: function (e, ui) {
+ if (!helperClassesSet) { // can only add classes after clone has been added to the DOM
+ //$(".ui-draggable-dragging")
+ ui.helper
+ .addClass( helperClass +" "+ helperPaneClass ) // add helper classes
+ .css({ right: "auto", bottom: "auto" }) // fix dir="rtl" issue
+ .children().css("visibility","hidden") // hide toggler inside dragged resizer-bar
+ ;
+ helperClassesSet = true;
+ // draggable bug!? RE-SET zIndex to prevent E/W resize-bar showing through N/S pane!
+ if (s.isSliding) $Ps[pane].css("zIndex", z.pane_sliding);
+ }
+ // CONTAIN RESIZER-BAR TO RESIZING LIMITS
+ var limit = 0;
+ if (ui.position[side] < r.min) {
+ ui.position[side] = r.min;
+ limit = -1;
+ }
+ else if (ui.position[side] > r.max) {
+ ui.position[side] = r.max;
+ limit = 1;
+ }
+ // ADD/REMOVE dragging-limit CLASS
+ if (limit) {
+ ui.helper.addClass( helperLimitClass +" "+ helperPaneLimitClass ); // at dragging-limit
+ window.defaultStatus = (limit>0 && pane.match(/(north|west)/)) || (limit<0 && pane.match(/(south|east)/)) ? o.tips.maxSizeWarning : o.tips.minSizeWarning;
+ }
+ else {
+ ui.helper.removeClass( helperLimitClass +" "+ helperPaneLimitClass ); // not at dragging-limit
+ window.defaultStatus = "";
+ }
+ // DYNAMICALLY RESIZE PANES IF OPTION ENABLED
+ // won't trigger unless resizer has actually moved!
+ if (live && Math.abs(ui.position[side] - lastPos) >= o.liveResizingTolerance) {
+ lastPos = ui.position[side];
+ resizePanes(e, ui, pane)
+ }
+ }
+
+ , stop: function (e, ui) {
+ $('body').enableSelection(); // RE-ENABLE TEXT SELECTION
+ window.defaultStatus = ""; // clear 'resizing limit' message from statusbar
+ $R.removeClass( resizerClass +" "+ resizerPaneClass ); // remove drag classes from Resizer
+ s.isResizing = false;
+ resizePanes(e, ui, pane, true, masks); // true = resizingDone
+ }
+
+ });
+ });
+
+ /**
+ * resizePanes
+ *
+ * Sub-routine called from stop() - and drag() if livePaneResizing
+ *
+ * @param {!Object} evt
+ * @param {!Object} ui
+ * @param {string} pane
+ * @param {boolean=} [resizingDone=false]
+ */
+ var resizePanes = function (evt, ui, pane, resizingDone, masks) {
+ var dragPos = ui.position
+ , c = _c[pane]
+ , o = options[pane]
+ , s = state[pane]
+ , resizerPos
+ ;
+ switch (pane) {
+ case "north": resizerPos = dragPos.top; break;
+ case "west": resizerPos = dragPos.left; break;
+ case "south": resizerPos = sC.offsetHeight - dragPos.top - o.spacing_open; break;
+ case "east": resizerPos = sC.offsetWidth - dragPos.left - o.spacing_open; break;
+ };
+ // remove container margin from resizer position to get the pane size
+ var newSize = resizerPos - sC["inset"+ c.side];
+
+ // Disable OR Resize Mask(s) created in drag.start
+ if (!resizingDone) {
+ // ensure we meet liveResizingTolerance criteria
+ if (Math.abs(newSize - s.size) < o.liveResizingTolerance)
+ return; // SKIP resize this time
+ // resize the pane
+ manualSizePane(pane, newSize, false, true); // true = noAnimation
+ sizeMasks(); // resize all visible masks
+ }
+ else { // resizingDone
+ // ondrag_end callback
+ if (false !== _runCallbacks("ondrag_end", pane))
+ manualSizePane(pane, newSize, false, true); // true = noAnimation
+ hideMasks(); // hide all masks, which include panes with 'content/iframe-masks'
+ if (s.isSliding && masks) // RE-SHOW only 'object-masks' so objects won't show through sliding pane
+ showMasks( masks, true ); // true = onlyForObjects
+ }
+ };
+ }
+
+ /**
+ * sizeMask
+ *
+ * Needed to overlay a DIV over an IFRAME-pane because mask CANNOT be *inside* the pane
+ * Called when mask created, and during livePaneResizing
+ */
+, sizeMask = function () {
+ var $M = $(this)
+ , pane = $M.data("layoutMask") // eg: "west"
+ , s = state[pane]
+ ;
+ // only masks over an IFRAME-pane need manual resizing
+ if (s.tagName == "IFRAME" && s.isVisible) // no need to mask closed/hidden panes
+ $M.css({
+ top: s.offsetTop
+ , left: s.offsetLeft
+ , width: s.outerWidth
+ , height: s.outerHeight
+ });
+ /* ALT Method...
+ var $P = $Ps[pane];
+ $M.css( $P.position() ).css({ width: $P[0].offsetWidth, height: $P[0].offsetHeight });
+ */
+ }
+, sizeMasks = function () {
+ $Ms.each( sizeMask ); // resize all 'visible' masks
+ }
+
+, showMasks = function (panes, onlyForObjects) {
+ var a = panes ? panes.split(",") : $.layout.config.allPanes
+ , z = options.zIndexes
+ , o, s;
+ $.each(a, function(i,p){
+ s = state[p];
+ o = options[p];
+ if (s.isVisible && ( (!onlyForObjects && o.maskContents) || o.maskObjects )) {
+ getMasks(p).each(function(){
+ sizeMask.call(this);
+ this.style.zIndex = s.isSliding ? z.pane_sliding+1 : z.pane_normal+1
+ this.style.display = "block";
+ });
+ }
+ });
+ }
+
+, hideMasks = function () {
+ // ensure no pane is resizing - could be a timing issue
+ var skip;
+ $.each( $.layout.config.borderPanes, function(i,p){
+ if (state[p].isResizing) {
+ skip = true;
+ return false; // BREAK
+ }
+ });
+ if (!skip)
+ $Ms.hide(); // hide ALL masks
+ }
+
+, getMasks = function (pane) {
+ var $Masks = $([])
+ , $M, i = 0, c = $Ms.length
+ ;
+ for (; i CSS
+ if (sC.tagName === "BODY" && ($N = $("html")).data(css)) // RESET CSS
+ $N.css( $N.data(css) ).removeData(css);
+
+ // trigger plugins for this layout, if there are any
+ runPluginCallbacks( Instance, $.layout.onDestroy );
+
+ // trigger state-management and onunload callback
+ unload();
+
+ // clear the Instance of everything except for container & options (so could recreate)
+ // RE-CREATE: myLayout = myLayout.container.layout( myLayout.options );
+ for (n in Instance)
+ if (!n.match(/^(container|options)$/)) delete Instance[ n ];
+ // add a 'destroyed' flag to make it easy to check
+ Instance.destroyed = true;
+
+ // if this is a child layout, CLEAR the child-pointer in the parent
+ /* for now the pointer REMAINS, but with only container, options and destroyed keys
+ if (parentPane) {
+ var layout = parentPane.pane.data("parentLayout");
+ parentPane.child = layout.children[ parentPane.name ] = null;
+ }
+ */
+
+ return Instance; // for coding convenience
+ }
+
+ /**
+ * Remove a pane from the layout - subroutine of destroy()
+ *
+ * @see destroy()
+ * @param {string|Object} evt_or_pane The pane to process
+ * @param {boolean=} [remove=false] Remove the DOM element?
+ * @param {boolean=} [skipResize=false] Skip calling resizeAll()?
+ * @param {boolean=} [destroyChild=true] Destroy Child-layouts? If not passed, obeys options setting
+ */
+, removePane = function (evt_or_pane, remove, skipResize, destroyChild) {
+ if (!isInitialized()) return;
+ var pane = evtPane.call(this, evt_or_pane)
+ , $P = $Ps[pane]
+ , $C = $Cs[pane]
+ , $R = $Rs[pane]
+ , $T = $Ts[pane]
+ ;
+ // NOTE: elements can still exist even after remove()
+ // so check for missing data(), which is cleared by removed()
+ if ($P && $.isEmptyObject( $P.data() )) $P = false;
+ if ($C && $.isEmptyObject( $C.data() )) $C = false;
+ if ($R && $.isEmptyObject( $R.data() )) $R = false;
+ if ($T && $.isEmptyObject( $T.data() )) $T = false;
+
+ if ($P) $P.stop(true, true);
+
+ // check for a child layout
+ var o = options[pane]
+ , s = state[pane]
+ , d = "layout"
+ , css = "layoutCSS"
+ , child = children[pane] || ($P ? $P.data(d) : 0) || ($C ? $C.data(d) : 0) || null
+ , destroy = destroyChild !== undefined ? destroyChild : o.destroyChildLayout
+ ;
+
+ // FIRST destroy the child-layout(s)
+ if (destroy && child && !child.destroyed) {
+ child.destroy(true); // tell child-layout to destroy ALL its child-layouts too
+ if (child.destroyed) // destroy was successful
+ child = null; // clear pointer for logic below
+ }
+
+ if ($P && remove && !child)
+ $P.remove();
+ else if ($P && $P[0]) {
+ // create list of ALL pane-classes that need to be removed
+ var root = o.paneClass // default="ui-layout-pane"
+ , pRoot = root +"-"+ pane // eg: "ui-layout-pane-west"
+ , _open = "-open"
+ , _sliding= "-sliding"
+ , _closed = "-closed"
+ , classes = [ root, root+_open, root+_closed, root+_sliding, // generic classes
+ pRoot, pRoot+_open, pRoot+_closed, pRoot+_sliding ] // pane-specific classes
+ ;
+ $.merge(classes, getHoverClasses($P, true)); // ADD hover-classes
+ // remove all Layout classes from pane-element
+ $P .removeClass( classes.join(" ") ) // remove ALL pane-classes
+ .removeData("parentLayout")
+ .removeData("layoutPane")
+ .removeData("layoutRole")
+ .removeData("layoutEdge")
+ .removeData("autoHidden") // in case set
+ .unbind("."+ sID) // remove ALL Layout events
+ // TODO: remove these extra unbind commands when jQuery is fixed
+ //.unbind("mouseenter"+ sID)
+ //.unbind("mouseleave"+ sID)
+ ;
+ // do NOT reset CSS if this pane/content is STILL the container of a nested layout!
+ // the nested layout will reset its 'container' CSS when/if it is destroyed
+ if ($C && $C.data(d)) {
+ // a content-div may not have a specific width, so give it one to contain the Layout
+ $C.width( $C.width() );
+ child.resizeAll(); // now resize the Layout
+ }
+ else if ($C)
+ $C.css( $C.data(css) ).removeData(css).removeData("layoutRole");
+ // remove pane AFTER content in case there was a nested layout
+ if (!$P.data(d))
+ $P.css( $P.data(css) ).removeData(css);
+ }
+
+ // REMOVE pane resizer and toggler elements
+ if ($T) $T.remove();
+ if ($R) $R.remove();
+
+ // CLEAR all pointers and state data
+ Instance[pane] = $Ps[pane] = $Cs[pane] = $Rs[pane] = $Ts[pane] = children[pane] = false;
+ s = { removed: true };
+
+ if (!skipResize)
+ resizeAll();
+ }
+
+
+/*
+ * ###########################
+ * ACTION METHODS
+ * ###########################
+ */
+
+, _hidePane = function (pane) {
+ var $P = $Ps[pane]
+ , o = options[pane]
+ , s = $P[0].style
+ ;
+ if (o.useOffscreenClose) {
+ if (!$P.data(_c.offscreenReset))
+ $P.data(_c.offscreenReset, { left: s.left, right: s.right });
+ $P.css( _c.offscreenCSS );
+ }
+ else
+ $P.hide().removeData(_c.offscreenReset);
+ }
+
+, _showPane = function (pane) {
+ var $P = $Ps[pane]
+ , o = options[pane]
+ , off = _c.offscreenCSS
+ , old = $P.data(_c.offscreenReset)
+ , s = $P[0].style
+ ;
+ $P .show() // ALWAYS show, just in case
+ .removeData(_c.offscreenReset);
+ if (o.useOffscreenClose && old) {
+ if (s.left == off.left)
+ s.left = old.left;
+ if (s.right == off.right)
+ s.right = old.right;
+ }
+ }
+
+
+ /**
+ * Completely 'hides' a pane, including its spacing - as if it does not exist
+ * The pane is not actually 'removed' from the source, so can use 'show' to un-hide it
+ *
+ * @param {string|Object} evt_or_pane The pane being hidden, ie: north, south, east, or west
+ * @param {boolean=} [noAnimation=false]
+ */
+, hide = function (evt_or_pane, noAnimation) {
+ if (!isInitialized()) return;
+ var pane = evtPane.call(this, evt_or_pane)
+ , o = options[pane]
+ , s = state[pane]
+ , $P = $Ps[pane]
+ , $R = $Rs[pane]
+ ;
+ if (!$P || s.isHidden) return; // pane does not exist OR is already hidden
+
+ // onhide_start callback - will CANCEL hide if returns false
+ if (state.initialized && false === _runCallbacks("onhide_start", pane)) return;
+
+ s.isSliding = false; // just in case
+
+ // now hide the elements
+ if ($R) $R.hide(); // hide resizer-bar
+ if (!state.initialized || s.isClosed) {
+ s.isClosed = true; // to trigger open-animation on show()
+ s.isHidden = true;
+ s.isVisible = false;
+ if (!state.initialized)
+ _hidePane(pane); // no animation when loading page
+ sizeMidPanes(_c[pane].dir === "horz" ? "" : "center");
+ if (state.initialized || o.triggerEventsOnLoad)
+ _runCallbacks("onhide_end", pane);
+ }
+ else {
+ s.isHiding = true; // used by onclose
+ close(pane, false, noAnimation); // adjust all panes to fit
+ }
+ }
+
+ /**
+ * Show a hidden pane - show as 'closed' by default unless openPane = true
+ *
+ * @param {string|Object} evt_or_pane The pane being opened, ie: north, south, east, or west
+ * @param {boolean=} [openPane=false]
+ * @param {boolean=} [noAnimation=false]
+ * @param {boolean=} [noAlert=false]
+ */
+, show = function (evt_or_pane, openPane, noAnimation, noAlert) {
+ if (!isInitialized()) return;
+ var pane = evtPane.call(this, evt_or_pane)
+ , o = options[pane]
+ , s = state[pane]
+ , $P = $Ps[pane]
+ , $R = $Rs[pane]
+ ;
+ if (!$P || !s.isHidden) return; // pane does not exist OR is not hidden
+
+ // onshow_start callback - will CANCEL show if returns false
+ if (false === _runCallbacks("onshow_start", pane)) return;
+
+ s.isSliding = false; // just in case
+ s.isShowing = true; // used by onopen/onclose
+ //s.isHidden = false; - will be set by open/close - if not cancelled
+
+ // now show the elements
+ //if ($R) $R.show(); - will be shown by open/close
+ if (openPane === false)
+ close(pane, true); // true = force
+ else
+ open(pane, false, noAnimation, noAlert); // adjust all panes to fit
+ }
+
+
+ /**
+ * Toggles a pane open/closed by calling either open or close
+ *
+ * @param {string|Object} evt_or_pane The pane being toggled, ie: north, south, east, or west
+ * @param {boolean=} [slide=false]
+ */
+, toggle = function (evt_or_pane, slide) {
+ if (!isInitialized()) return;
+ var evt = evtObj(evt_or_pane)
+ , pane = evtPane.call(this, evt_or_pane)
+ , s = state[pane]
+ ;
+ if (evt) // called from to $R.dblclick OR triggerPaneEvent
+ evt.stopImmediatePropagation();
+ if (s.isHidden)
+ show(pane); // will call 'open' after unhiding it
+ else if (s.isClosed)
+ open(pane, !!slide);
+ else
+ close(pane);
+ }
+
+
+ /**
+ * Utility method used during init or other auto-processes
+ *
+ * @param {string} pane The pane being closed
+ * @param {boolean=} [setHandles=false]
+ */
+, _closePane = function (pane, setHandles) {
+ var
+ $P = $Ps[pane]
+ , s = state[pane]
+ ;
+ _hidePane(pane);
+ s.isClosed = true;
+ s.isVisible = false;
+ // UNUSED: if (setHandles) setAsClosed(pane, true); // true = force
+ }
+
+ /**
+ * Close the specified pane (animation optional), and resize all other panes as needed
+ *
+ * @param {string|Object} evt_or_pane The pane being closed, ie: north, south, east, or west
+ * @param {boolean=} [force=false]
+ * @param {boolean=} [noAnimation=false]
+ * @param {boolean=} [skipCallback=false]
+ */
+, close = function (evt_or_pane, force, noAnimation, skipCallback) {
+ var pane = evtPane.call(this, evt_or_pane);
+ // if pane has been initialized, but NOT the complete layout, close pane instantly
+ if (!state.initialized && $Ps[pane]) {
+ _closePane(pane); // INIT pane as closed
+ return;
+ }
+ if (!isInitialized()) return;
+
+ var
+ $P = $Ps[pane]
+ , $R = $Rs[pane]
+ , $T = $Ts[pane]
+ , o = options[pane]
+ , s = state[pane]
+ , c = _c[pane]
+ , doFX, isShowing, isHiding, wasSliding;
+
+ // QUEUE in case another action/animation is in progress
+ $N.queue(function( queueNext ){
+
+ if ( !$P
+ || (!o.closable && !s.isShowing && !s.isHiding) // invalid request // (!o.resizable && !o.closable) ???
+ || (!force && s.isClosed && !s.isShowing) // already closed
+ ) return queueNext();
+
+ // onclose_start callback - will CANCEL hide if returns false
+ // SKIP if just 'showing' a hidden pane as 'closed'
+ var abort = !s.isShowing && false === _runCallbacks("onclose_start", pane);
+
+ // transfer logic vars to temp vars
+ isShowing = s.isShowing;
+ isHiding = s.isHiding;
+ wasSliding = s.isSliding;
+ // now clear the logic vars (REQUIRED before aborting)
+ delete s.isShowing;
+ delete s.isHiding;
+
+ if (abort) return queueNext();
+
+ doFX = !noAnimation && !s.isClosed && (o.fxName_close != "none");
+ s.isMoving = true;
+ s.isClosed = true;
+ s.isVisible = false;
+ // update isHidden BEFORE sizing panes
+ if (isHiding) s.isHidden = true;
+ else if (isShowing) s.isHidden = false;
+
+ if (s.isSliding) // pane is being closed, so UNBIND trigger events
+ bindStopSlidingEvents(pane, false); // will set isSliding=false
+ else // resize panes adjacent to this one
+ sizeMidPanes(_c[pane].dir === "horz" ? "" : "center", false); // false = NOT skipCallback
+
+ // if this pane has a resizer bar, move it NOW - before animation
+ setAsClosed(pane);
+
+ // CLOSE THE PANE
+ if (doFX) { // animate the close
+ // mask panes with objects
+ var masks = "center"+ (c.dir=="horz" ? ",west,east" : "");
+ showMasks( masks, true ); // true = ONLY mask panes with maskObjects=true
+ lockPaneForFX(pane, true); // need to set left/top so animation will work
+ $P.hide( o.fxName_close, o.fxSettings_close, o.fxSpeed_close, function () {
+ lockPaneForFX(pane, false); // undo
+ if (s.isClosed) close_2();
+ queueNext();
+ });
+ }
+ else { // hide the pane without animation
+ _hidePane(pane);
+ close_2();
+ queueNext();
+ };
+ });
+
+ // SUBROUTINE
+ function close_2 () {
+ s.isMoving = false;
+ bindStartSlidingEvent(pane, true); // will enable if o.slidable = true
+
+ // if opposite-pane was autoClosed, see if it can be autoOpened now
+ var altPane = _c.oppositeEdge[pane];
+ if (state[ altPane ].noRoom) {
+ setSizeLimits( altPane );
+ makePaneFit( altPane );
+ }
+
+ // hide any masks shown while closing
+ hideMasks();
+
+ if (!skipCallback && (state.initialized || o.triggerEventsOnLoad)) {
+ // onclose callback - UNLESS just 'showing' a hidden pane as 'closed'
+ if (!isShowing) _runCallbacks("onclose_end", pane);
+ // onhide OR onshow callback
+ if (isShowing) _runCallbacks("onshow_end", pane);
+ if (isHiding) _runCallbacks("onhide_end", pane);
+ }
+ }
+ }
+
+ /**
+ * @param {string} pane The pane just closed, ie: north, south, east, or west
+ */
+, setAsClosed = function (pane) {
+ var
+ $P = $Ps[pane]
+ , $R = $Rs[pane]
+ , $T = $Ts[pane]
+ , o = options[pane]
+ , s = state[pane]
+ , side = _c[pane].side.toLowerCase()
+ , inset = "inset"+ _c[pane].side
+ , rClass = o.resizerClass
+ , tClass = o.togglerClass
+ , _pane = "-"+ pane // used for classNames
+ , _open = "-open"
+ , _sliding= "-sliding"
+ , _closed = "-closed"
+ ;
+ $R
+ .css(side, sC[inset]) // move the resizer
+ .removeClass( rClass+_open +" "+ rClass+_pane+_open )
+ .removeClass( rClass+_sliding +" "+ rClass+_pane+_sliding )
+ .addClass( rClass+_closed +" "+ rClass+_pane+_closed )
+ .unbind("dblclick."+ sID)
+ ;
+ // DISABLE 'resizing' when closed - do this BEFORE bindStartSlidingEvent?
+ if (o.resizable && $.layout.plugins.draggable)
+ $R
+ .draggable("disable")
+ .removeClass("ui-state-disabled") // do NOT apply disabled styling - not suitable here
+ .css("cursor", "default")
+ .attr("title","")
+ ;
+
+ // if pane has a toggler button, adjust that too
+ if ($T) {
+ $T
+ .removeClass( tClass+_open +" "+ tClass+_pane+_open )
+ .addClass( tClass+_closed +" "+ tClass+_pane+_closed )
+ .attr("title", o.tips.Open) // may be blank
+ ;
+ // toggler-content - if exists
+ $T.children(".content-open").hide();
+ $T.children(".content-closed").css("display","block");
+ }
+
+ // sync any 'pin buttons'
+ syncPinBtns(pane, false);
+
+ if (state.initialized) {
+ // resize 'length' and position togglers for adjacent panes
+ sizeHandles();
+ }
+ }
+
+ /**
+ * Open the specified pane (animation optional), and resize all other panes as needed
+ *
+ * @param {string|Object} evt_or_pane The pane being opened, ie: north, south, east, or west
+ * @param {boolean=} [slide=false]
+ * @param {boolean=} [noAnimation=false]
+ * @param {boolean=} [noAlert=false]
+ */
+, open = function (evt_or_pane, slide, noAnimation, noAlert) {
+ if (!isInitialized()) return;
+ var pane = evtPane.call(this, evt_or_pane)
+ , $P = $Ps[pane]
+ , $R = $Rs[pane]
+ , $T = $Ts[pane]
+ , o = options[pane]
+ , s = state[pane]
+ , c = _c[pane]
+ , doFX, isShowing
+ ;
+ // QUEUE in case another action/animation is in progress
+ $N.queue(function( queueNext ){
+
+ if ( !$P
+ || (!o.resizable && !o.closable && !s.isShowing) // invalid request
+ || (s.isVisible && !s.isSliding) // already open
+ ) return queueNext();
+
+ // pane can ALSO be unhidden by just calling show(), so handle this scenario
+ if (s.isHidden && !s.isShowing) {
+ queueNext(); // call before show() because it needs the queue free
+ show(pane, true);
+ return;
+ }
+
+ if (o.autoResize && s.size != o.size) // resize pane to original size set in options
+ sizePane(pane, o.size, true, true, true); // true=skipCallback/forceResize/noAnimation
+ else
+ // make sure there is enough space available to open the pane
+ setSizeLimits(pane, slide);
+
+ // onopen_start callback - will CANCEL open if returns false
+ var cbReturn = _runCallbacks("onopen_start", pane);
+
+ if (cbReturn === "abort")
+ return queueNext();
+
+ // update pane-state again in case options were changed in onopen_start
+ if (cbReturn !== "NC") // NC = "No Callback"
+ setSizeLimits(pane, slide);
+
+ if (s.minSize > s.maxSize) { // INSUFFICIENT ROOM FOR PANE TO OPEN!
+ syncPinBtns(pane, false); // make sure pin-buttons are reset
+ if (!noAlert && o.tips.noRoomToOpen)
+ alert(o.tips.noRoomToOpen);
+ return queueNext(); // ABORT
+ }
+
+ if (slide) // START Sliding - will set isSliding=true
+ bindStopSlidingEvents(pane, true); // BIND trigger events to close sliding-pane
+ else if (s.isSliding) // PIN PANE (stop sliding) - open pane 'normally' instead
+ bindStopSlidingEvents(pane, false); // UNBIND trigger events - will set isSliding=false
+ else if (o.slidable)
+ bindStartSlidingEvent(pane, false); // UNBIND trigger events
+
+ s.noRoom = false; // will be reset by makePaneFit if 'noRoom'
+ makePaneFit(pane);
+
+ // transfer logic var to temp var
+ isShowing = s.isShowing;
+ // now clear the logic var
+ delete s.isShowing;
+
+ doFX = !noAnimation && s.isClosed && (o.fxName_open != "none");
+ s.isMoving = true;
+ s.isVisible = true;
+ s.isClosed = false;
+ // update isHidden BEFORE sizing panes - WHY??? Old?
+ if (isShowing) s.isHidden = false;
+
+ if (doFX) { // ANIMATE
+ // mask panes with objects
+ var masks = "center"+ (c.dir=="horz" ? ",west,east" : "");
+ if (s.isSliding) masks += ","+ _c.oppositeEdge[pane];
+ showMasks( masks, true ); // true = ONLY mask panes with maskObjects=true
+ lockPaneForFX(pane, true); // need to set left/top so animation will work
+ $P.show( o.fxName_open, o.fxSettings_open, o.fxSpeed_open, function() {
+ lockPaneForFX(pane, false); // undo
+ if (s.isVisible) open_2(); // continue
+ queueNext();
+ });
+ }
+ else { // no animation
+ _showPane(pane);// just show pane and...
+ open_2(); // continue
+ queueNext();
+ };
+ });
+
+ // SUBROUTINE
+ function open_2 () {
+ s.isMoving = false;
+
+ // cure iframe display issues
+ _fixIframe(pane);
+
+ // NOTE: if isSliding, then other panes are NOT 'resized'
+ if (!s.isSliding) { // resize all panes adjacent to this one
+ hideMasks(); // remove any masks shown while opening
+ sizeMidPanes(_c[pane].dir=="vert" ? "center" : "", false); // false = NOT skipCallback
+ }
+
+ // set classes, position handles and execute callbacks...
+ setAsOpen(pane);
+ };
+
+ }
+
+ /**
+ * @param {string} pane The pane just opened, ie: north, south, east, or west
+ * @param {boolean=} [skipCallback=false]
+ */
+, setAsOpen = function (pane, skipCallback) {
+ var
+ $P = $Ps[pane]
+ , $R = $Rs[pane]
+ , $T = $Ts[pane]
+ , o = options[pane]
+ , s = state[pane]
+ , side = _c[pane].side.toLowerCase()
+ , inset = "inset"+ _c[pane].side
+ , rClass = o.resizerClass
+ , tClass = o.togglerClass
+ , _pane = "-"+ pane // used for classNames
+ , _open = "-open"
+ , _closed = "-closed"
+ , _sliding= "-sliding"
+ ;
+ $R
+ .css(side, sC[inset] + getPaneSize(pane)) // move the resizer
+ .removeClass( rClass+_closed +" "+ rClass+_pane+_closed )
+ .addClass( rClass+_open +" "+ rClass+_pane+_open )
+ ;
+ if (s.isSliding)
+ $R.addClass( rClass+_sliding +" "+ rClass+_pane+_sliding )
+ else // in case 'was sliding'
+ $R.removeClass( rClass+_sliding +" "+ rClass+_pane+_sliding )
+
+ if (o.resizerDblClickToggle)
+ $R.bind("dblclick", toggle );
+ removeHover( 0, $R ); // remove hover classes
+ if (o.resizable && $.layout.plugins.draggable)
+ $R .draggable("enable")
+ .css("cursor", o.resizerCursor)
+ .attr("title", o.tips.Resize);
+ else if (!s.isSliding)
+ $R.css("cursor", "default"); // n-resize, s-resize, etc
+
+ // if pane also has a toggler button, adjust that too
+ if ($T) {
+ $T .removeClass( tClass+_closed +" "+ tClass+_pane+_closed )
+ .addClass( tClass+_open +" "+ tClass+_pane+_open )
+ .attr("title", o.tips.Close); // may be blank
+ removeHover( 0, $T ); // remove hover classes
+ // toggler-content - if exists
+ $T.children(".content-closed").hide();
+ $T.children(".content-open").css("display","block");
+ }
+
+ // sync any 'pin buttons'
+ syncPinBtns(pane, !s.isSliding);
+
+ // update pane-state dimensions - BEFORE resizing content
+ $.extend(s, elDims($P));
+
+ if (state.initialized) {
+ // resize resizer & toggler sizes for all panes
+ sizeHandles();
+ // resize content every time pane opens - to be sure
+ sizeContent(pane, true); // true = remeasure headers/footers, even if 'pane.isMoving'
+ }
+
+ if (!skipCallback && (state.initialized || o.triggerEventsOnLoad) && $P.is(":visible")) {
+ // onopen callback
+ _runCallbacks("onopen_end", pane);
+ // onshow callback - TODO: should this be here?
+ if (s.isShowing) _runCallbacks("onshow_end", pane);
+
+ // ALSO call onresize because layout-size *may* have changed while pane was closed
+ if (state.initialized)
+ _runCallbacks("onresize_end", pane);
+ }
+
+ // TODO: Somehow sizePane("north") is being called after this point???
+ }
+
+
+ /**
+ * slideOpen / slideClose / slideToggle
+ *
+ * Pass-though methods for sliding
+ */
+, slideOpen = function (evt_or_pane) {
+ if (!isInitialized()) return;
+ var evt = evtObj(evt_or_pane)
+ , pane = evtPane.call(this, evt_or_pane)
+ , s = state[pane]
+ , delay = options[pane].slideDelay_open
+ ;
+ // prevent event from triggering on NEW resizer binding created below
+ if (evt) evt.stopImmediatePropagation();
+
+ if (s.isClosed && evt && evt.type === "mouseenter" && delay > 0)
+ // trigger = mouseenter - use a delay
+ timer.set(pane+"_openSlider", open_NOW, delay);
+ else
+ open_NOW(); // will unbind events if is already open
+
+ /**
+ * SUBROUTINE for timed open
+ */
+ function open_NOW () {
+ if (!s.isClosed) // skip if no longer closed!
+ bindStopSlidingEvents(pane, true); // BIND trigger events to close sliding-pane
+ else if (!s.isMoving)
+ open(pane, true); // true = slide - open() will handle binding
+ };
+ }
+
+, slideClose = function (evt_or_pane) {
+ if (!isInitialized()) return;
+ var evt = evtObj(evt_or_pane)
+ , pane = evtPane.call(this, evt_or_pane)
+ , o = options[pane]
+ , s = state[pane]
+ , delay = s.isMoving ? 1000 : 300 // MINIMUM delay - option may override
+ ;
+ if (s.isClosed || s.isResizing)
+ return; // skip if already closed OR in process of resizing
+ else if (o.slideTrigger_close === "click")
+ close_NOW(); // close immediately onClick
+ else if (o.preventQuickSlideClose && s.isMoving)
+ return; // handle Chrome quick-close on slide-open
+ else if (o.preventPrematureSlideClose && evt && $.layout.isMouseOverElem(evt, $Ps[pane]))
+ return; // handle incorrect mouseleave trigger, like when over a SELECT-list in IE
+ else if (evt) // trigger = mouseleave - use a delay
+ // 1 sec delay if 'opening', else .3 sec
+ timer.set(pane+"_closeSlider", close_NOW, max(o.slideDelay_close, delay));
+ else // called programically
+ close_NOW();
+
+ /**
+ * SUBROUTINE for timed close
+ */
+ function close_NOW () {
+ if (s.isClosed) // skip 'close' if already closed!
+ bindStopSlidingEvents(pane, false); // UNBIND trigger events - TODO: is this needed here?
+ else if (!s.isMoving)
+ close(pane); // close will handle unbinding
+ };
+ }
+
+ /**
+ * @param {string|Object} evt_or_pane The pane being opened, ie: north, south, east, or west
+ */
+, slideToggle = function (evt_or_pane) {
+ var pane = evtPane.call(this, evt_or_pane);
+ toggle(pane, true);
+ }
+
+
+ /**
+ * Must set left/top on East/South panes so animation will work properly
+ *
+ * @param {string} pane The pane to lock, 'east' or 'south' - any other is ignored!
+ * @param {boolean} doLock true = set left/top, false = remove
+ */
+, lockPaneForFX = function (pane, doLock) {
+ var $P = $Ps[pane]
+ , s = state[pane]
+ , o = options[pane]
+ , z = options.zIndexes
+ ;
+ if (doLock) {
+ $P.css({ zIndex: z.pane_animate }); // overlay all elements during animation
+ if (pane=="south")
+ $P.css({ top: sC.insetTop + sC.innerHeight - $P.outerHeight() });
+ else if (pane=="east")
+ $P.css({ left: sC.insetLeft + sC.innerWidth - $P.outerWidth() });
+ }
+ else { // animation DONE - RESET CSS
+ // TODO: see if this can be deleted. It causes a quick-close when sliding in Chrome
+ $P.css({ zIndex: (s.isSliding ? z.pane_sliding : z.pane_normal) });
+ if (pane=="south")
+ $P.css({ top: "auto" });
+ // if pane is positioned 'off-screen', then DO NOT screw with it!
+ else if (pane=="east" && !$P.css("left").match(/\-99999/))
+ $P.css({ left: "auto" });
+ // fix anti-aliasing in IE - only needed for animations that change opacity
+ if (browser.msie && o.fxOpacityFix && o.fxName_open != "slide" && $P.css("filter") && $P.css("opacity") == 1)
+ $P[0].style.removeAttribute('filter');
+ }
+ }
+
+
+ /**
+ * Toggle sliding functionality of a specific pane on/off by adding removing 'slide open' trigger
+ *
+ * @see open(), close()
+ * @param {string} pane The pane to enable/disable, 'north', 'south', etc.
+ * @param {boolean} enable Enable or Disable sliding?
+ */
+, bindStartSlidingEvent = function (pane, enable) {
+ var o = options[pane]
+ , $P = $Ps[pane]
+ , $R = $Rs[pane]
+ , evtName = o.slideTrigger_open.toLowerCase()
+ ;
+ if (!$R || (enable && !o.slidable)) return;
+
+ // make sure we have a valid event
+ if (evtName.match(/mouseover/))
+ evtName = o.slideTrigger_open = "mouseenter";
+ else if (!evtName.match(/(click|dblclick|mouseenter)/))
+ evtName = o.slideTrigger_open = "click";
+
+ $R
+ // add or remove event
+ [enable ? "bind" : "unbind"](evtName +'.'+ sID, slideOpen)
+ // set the appropriate cursor & title/tip
+ .css("cursor", enable ? o.sliderCursor : "default")
+ .attr("title", enable ? o.tips.Slide : "")
+ ;
+ }
+
+ /**
+ * Add or remove 'mouseleave' events to 'slide close' when pane is 'sliding' open or closed
+ * Also increases zIndex when pane is sliding open
+ * See bindStartSlidingEvent for code to control 'slide open'
+ *
+ * @see slideOpen(), slideClose()
+ * @param {string} pane The pane to process, 'north', 'south', etc.
+ * @param {boolean} enable Enable or Disable events?
+ */
+, bindStopSlidingEvents = function (pane, enable) {
+ var o = options[pane]
+ , s = state[pane]
+ , c = _c[pane]
+ , z = options.zIndexes
+ , evtName = o.slideTrigger_close.toLowerCase()
+ , action = (enable ? "bind" : "unbind")
+ , $P = $Ps[pane]
+ , $R = $Rs[pane]
+ ;
+ s.isSliding = enable; // logic
+ timer.clear(pane+"_closeSlider"); // just in case
+
+ // remove 'slideOpen' event from resizer
+ // ALSO will raise the zIndex of the pane & resizer
+ if (enable) bindStartSlidingEvent(pane, false);
+
+ // RE/SET zIndex - increases when pane is sliding-open, resets to normal when not
+ $P.css("zIndex", enable ? z.pane_sliding : z.pane_normal);
+ $R.css("zIndex", enable ? z.pane_sliding+2 : z.resizer_normal); // NOTE: mask = pane_sliding+1
+
+ // make sure we have a valid event
+ if (!evtName.match(/(click|mouseleave)/))
+ evtName = o.slideTrigger_close = "mouseleave"; // also catches 'mouseout'
+
+ // add/remove slide triggers
+ $R[action](evtName, slideClose); // base event on resize
+ // need extra events for mouseleave
+ if (evtName === "mouseleave") {
+ // also close on pane.mouseleave
+ $P[action]("mouseleave."+ sID, slideClose);
+ // cancel timer when mouse moves between 'pane' and 'resizer'
+ $R[action]("mouseenter."+ sID, cancelMouseOut);
+ $P[action]("mouseenter."+ sID, cancelMouseOut);
+ }
+
+ if (!enable)
+ timer.clear(pane+"_closeSlider");
+ else if (evtName === "click" && !o.resizable) {
+ // IF pane is not resizable (which already has a cursor and tip)
+ // then set the a cursor & title/tip on resizer when sliding
+ $R.css("cursor", enable ? o.sliderCursor : "default");
+ $R.attr("title", enable ? o.tips.Close : ""); // use Toggler-tip, eg: "Close Pane"
+ }
+
+ // SUBROUTINE for mouseleave timer clearing
+ function cancelMouseOut (evt) {
+ timer.clear(pane+"_closeSlider");
+ evt.stopPropagation();
+ }
+ }
+
+
+ /**
+ * Hides/closes a pane if there is insufficient room - reverses this when there is room again
+ * MUST have already called setSizeLimits() before calling this method
+ *
+ * @param {string} pane The pane being resized
+ * @param {boolean=} [isOpening=false] Called from onOpen?
+ * @param {boolean=} [skipCallback=false] Should the onresize callback be run?
+ * @param {boolean=} [force=false]
+ */
+, makePaneFit = function (pane, isOpening, skipCallback, force) {
+ var
+ o = options[pane]
+ , s = state[pane]
+ , c = _c[pane]
+ , $P = $Ps[pane]
+ , $R = $Rs[pane]
+ , isSidePane = c.dir==="vert"
+ , hasRoom = false
+ ;
+ // special handling for center & east/west panes
+ if (pane === "center" || (isSidePane && s.noVerticalRoom)) {
+ // see if there is enough room to display the pane
+ // ERROR: hasRoom = s.minHeight <= s.maxHeight && (isSidePane || s.minWidth <= s.maxWidth);
+ hasRoom = (s.maxHeight >= 0);
+ if (hasRoom && s.noRoom) { // previously hidden due to noRoom, so show now
+ _showPane(pane);
+ if ($R) $R.show();
+ s.isVisible = true;
+ s.noRoom = false;
+ if (isSidePane) s.noVerticalRoom = false;
+ _fixIframe(pane);
+ }
+ else if (!hasRoom && !s.noRoom) { // not currently hidden, so hide now
+ _hidePane(pane);
+ if ($R) $R.hide();
+ s.isVisible = false;
+ s.noRoom = true;
+ }
+ }
+
+ // see if there is enough room to fit the border-pane
+ if (pane === "center") {
+ // ignore center in this block
+ }
+ else if (s.minSize <= s.maxSize) { // pane CAN fit
+ hasRoom = true;
+ if (s.size > s.maxSize) // pane is too big - shrink it
+ sizePane(pane, s.maxSize, skipCallback, force, true); // true = noAnimation
+ else if (s.size < s.minSize) // pane is too small - enlarge it
+ sizePane(pane, s.minSize, skipCallback, force, true);
+ // need s.isVisible because new pseudoClose method keeps pane visible, but off-screen
+ else if ($R && s.isVisible && $P.is(":visible")) {
+ // make sure resizer-bar is positioned correctly
+ // handles situation where nested layout was 'hidden' when initialized
+ var side = c.side.toLowerCase()
+ , pos = s.size + sC["inset"+ c.side]
+ ;
+ if ($.layout.cssNum($R, side) != pos) $R.css( side, pos );
+ }
+
+ // if was previously hidden due to noRoom, then RESET because NOW there is room
+ if (s.noRoom) {
+ // s.noRoom state will be set by open or show
+ if (s.wasOpen && o.closable) {
+ if (o.autoReopen)
+ open(pane, false, true, true); // true = noAnimation, true = noAlert
+ else // leave the pane closed, so just update state
+ s.noRoom = false;
+ }
+ else
+ show(pane, s.wasOpen, true, true); // true = noAnimation, true = noAlert
+ }
+ }
+ else { // !hasRoom - pane CANNOT fit
+ if (!s.noRoom) { // pane not set as noRoom yet, so hide or close it now...
+ s.noRoom = true; // update state
+ s.wasOpen = !s.isClosed && !s.isSliding;
+ if (s.isClosed){} // SKIP
+ else if (o.closable) // 'close' if possible
+ close(pane, true, true); // true = force, true = noAnimation
+ else // 'hide' pane if cannot just be closed
+ hide(pane, true); // true = noAnimation
+ }
+ }
+ }
+
+
+ /**
+ * sizePane / manualSizePane
+ * sizePane is called only by internal methods whenever a pane needs to be resized
+ * manualSizePane is an exposed flow-through method allowing extra code when pane is 'manually resized'
+ *
+ * @param {string|Object} evt_or_pane The pane being resized
+ * @param {number} size The *desired* new size for this pane - will be validated
+ * @param {boolean=} [skipCallback=false] Should the onresize callback be run?
+ * @param {boolean=} [noAnimation=false]
+ */
+, manualSizePane = function (evt_or_pane, size, skipCallback, noAnimation) {
+ if (!isInitialized()) return;
+ var pane = evtPane.call(this, evt_or_pane)
+ , o = options[pane]
+ , s = state[pane]
+ // if resizing callbacks have been delayed and resizing is now DONE, force resizing to complete...
+ , forceResize = o.livePaneResizing && !s.isResizing
+ ;
+ // ANY call to manualSizePane disables autoResize - ie, percentage sizing
+ o.autoResize = false;
+ // flow-through...
+ sizePane(pane, size, skipCallback, forceResize, noAnimation); // will animate resize if option enabled
+ }
+
+ /**
+ * @param {string|Object} evt_or_pane The pane being resized
+ * @param {number} size The *desired* new size for this pane - will be validated
+ * @param {boolean=} [skipCallback=false] Should the onresize callback be run?
+ * @param {boolean=} [force=false] Force resizing even if does not seem necessary
+ * @param {boolean=} [noAnimation=false]
+ */
+, sizePane = function (evt_or_pane, size, skipCallback, force, noAnimation) {
+ if (!isInitialized()) return;
+ var pane = evtPane.call(this, evt_or_pane) // probably NEVER called from event?
+ , o = options[pane]
+ , s = state[pane]
+ , $P = $Ps[pane]
+ , $R = $Rs[pane]
+ , side = _c[pane].side.toLowerCase()
+ , dimName = _c[pane].sizeType.toLowerCase()
+ , inset = "inset"+ _c[pane].side
+ , skipResizeWhileDragging = s.isResizing && !o.triggerEventsDuringLiveResize
+ , doFX = noAnimation !== true && o.animatePaneSizing
+ , oldSize, newSize
+ ;
+ // QUEUE in case another action/animation is in progress
+ $N.queue(function( queueNext ){
+ // calculate 'current' min/max sizes
+ setSizeLimits(pane); // update pane-state
+ oldSize = s.size;
+ size = _parseSize(pane, size); // handle percentages & auto
+ size = max(size, _parseSize(pane, o.minSize));
+ size = min(size, s.maxSize);
+ if (size < s.minSize) { // not enough room for pane!
+ queueNext(); // call before makePaneFit() because it needs the queue free
+ makePaneFit(pane, false, skipCallback); // will hide or close pane
+ return;
+ }
+
+ // IF newSize is same as oldSize, then nothing to do - abort
+ if (!force && size === oldSize)
+ return queueNext();
+
+ // onresize_start callback CANNOT cancel resizing because this would break the layout!
+ if (!skipCallback && state.initialized && s.isVisible)
+ _runCallbacks("onresize_start", pane);
+
+ // resize the pane, and make sure its visible
+ newSize = cssSize(pane, size);
+
+ if (doFX && $P.is(":visible")) { // ANIMATE
+ var fx = $.layout.effects.size[pane] || $.layout.effects.size.all
+ , easing = o.fxSettings_size.easing || fx.easing
+ , z = options.zIndexes
+ , props = {};
+ props[ dimName ] = newSize +'px';
+ s.isMoving = true;
+ // overlay all elements during animation
+ $P.css({ zIndex: z.pane_animate })
+ .show().animate( props, o.fxSpeed_size, easing, function(){
+ // reset zIndex after animation
+ $P.css({ zIndex: (s.isSliding ? z.pane_sliding : z.pane_normal) });
+ s.isMoving = false;
+ sizePane_2(); // continue
+ queueNext();
+ });
+ }
+ else { // no animation
+ $P.css( dimName, newSize ); // resize pane
+ // if pane is visible, then
+ if ($P.is(":visible"))
+ sizePane_2(); // continue
+ else {
+ // pane is NOT VISIBLE, so just update state data...
+ // when pane is *next opened*, it will have the new size
+ s.size = size; // update state.size
+ $.extend(s, elDims($P)); // update state dimensions
+ }
+ queueNext();
+ };
+
+ });
+
+ // SUBROUTINE
+ function sizePane_2 () {
+ /* Panes are sometimes not sized precisely in some browsers!?
+ * This code will resize the pane up to 3 times to nudge the pane to the correct size
+ */
+ var actual = dimName==='width' ? $P.outerWidth() : $P.outerHeight()
+ , tries = [{
+ pane: pane
+ , count: 1
+ , target: size
+ , actual: actual
+ , correct: (size === actual)
+ , attempt: size
+ , cssSize: newSize
+ }]
+ , lastTry = tries[0]
+ , thisTry = {}
+ , msg = 'Inaccurate size after resizing the '+ pane +'-pane.'
+ ;
+ while ( !lastTry.correct ) {
+ thisTry = { pane: pane, count: lastTry.count+1, target: size };
+
+ if (lastTry.actual > size)
+ thisTry.attempt = max(0, lastTry.attempt - (lastTry.actual - size));
+ else // lastTry.actual < size
+ thisTry.attempt = max(0, lastTry.attempt + (size - lastTry.actual));
+
+ thisTry.cssSize = cssSize(pane, thisTry.attempt);
+ $P.css( dimName, thisTry.cssSize );
+
+ thisTry.actual = dimName=='width' ? $P.outerWidth() : $P.outerHeight();
+ thisTry.correct = (size === thisTry.actual);
+
+ // log attempts and alert the user of this *non-fatal error* (if showDebugMessages)
+ if ( tries.length === 1) {
+ _log(msg, false, true);
+ _log(lastTry, false, true);
+ }
+ _log(thisTry, false, true);
+ // after 4 tries, is as close as its gonna get!
+ if (tries.length > 3) break;
+
+ tries.push( thisTry );
+ lastTry = tries[ tries.length - 1 ];
+ }
+ // END TESTING CODE
+
+ // update pane-state dimensions
+ s.size = size;
+ $.extend(s, elDims($P));
+
+ if (s.isVisible && $P.is(":visible")) {
+ // reposition the resizer-bar
+ if ($R) $R.css( side, size + sC[inset] );
+ // resize the content-div
+ sizeContent(pane);
+ }
+
+ if (!skipCallback && !skipResizeWhileDragging && state.initialized && s.isVisible)
+ _runCallbacks("onresize_end", pane);
+
+ // resize all the adjacent panes, and adjust their toggler buttons
+ // when skipCallback passed, it means the controlling method will handle 'other panes'
+ if (!skipCallback) {
+ // also no callback if live-resize is in progress and NOT triggerEventsDuringLiveResize
+ if (!s.isSliding) sizeMidPanes(_c[pane].dir=="horz" ? "" : "center", skipResizeWhileDragging, force);
+ sizeHandles();
+ }
+
+ // if opposite-pane was autoClosed, see if it can be autoOpened now
+ var altPane = _c.oppositeEdge[pane];
+ if (size < oldSize && state[ altPane ].noRoom) {
+ setSizeLimits( altPane );
+ makePaneFit( altPane, false, skipCallback );
+ }
+
+ // DEBUG - ALERT user/developer so they know there was a sizing problem
+ if (tries.length > 1)
+ _log(msg +'\nSee the Error Console for details.', true, true);
+ }
+ }
+
+ /**
+ * @see initPanes(), sizePane(), resizeAll(), open(), close(), hide()
+ * @param {Array.|string} panes The pane(s) being resized, comma-delmited string
+ * @param {boolean=} [skipCallback=false] Should the onresize callback be run?
+ * @param {boolean=} [force=false]
+ */
+, sizeMidPanes = function (panes, skipCallback, force) {
+ panes = (panes ? panes : "east,west,center").split(",");
+
+ $.each(panes, function (i, pane) {
+ if (!$Ps[pane]) return; // NO PANE - skip
+ var
+ o = options[pane]
+ , s = state[pane]
+ , $P = $Ps[pane]
+ , $R = $Rs[pane]
+ , isCenter= (pane=="center")
+ , hasRoom = true
+ , CSS = {}
+ , newCenter = calcNewCenterPaneDims()
+ ;
+ // update pane-state dimensions
+ $.extend(s, elDims($P));
+
+ if (pane === "center") {
+ if (!force && s.isVisible && newCenter.width === s.outerWidth && newCenter.height === s.outerHeight)
+ return true; // SKIP - pane already the correct size
+ // set state for makePaneFit() logic
+ $.extend(s, cssMinDims(pane), {
+ maxWidth: newCenter.width
+ , maxHeight: newCenter.height
+ });
+ CSS = newCenter;
+ // convert OUTER width/height to CSS width/height
+ CSS.width = cssW($P, CSS.width);
+ // NEW - allow pane to extend 'below' visible area rather than hide it
+ CSS.height = cssH($P, CSS.height);
+ hasRoom = CSS.width >= 0 && CSS.height >= 0; // height >= 0 = ALWAYS TRUE NOW
+ // during layout init, try to shrink east/west panes to make room for center
+ if (!state.initialized && o.minWidth > s.outerWidth) {
+ var
+ reqPx = o.minWidth - s.outerWidth
+ , minE = options.east.minSize || 0
+ , minW = options.west.minSize || 0
+ , sizeE = state.east.size
+ , sizeW = state.west.size
+ , newE = sizeE
+ , newW = sizeW
+ ;
+ if (reqPx > 0 && state.east.isVisible && sizeE > minE) {
+ newE = max( sizeE-minE, sizeE-reqPx );
+ reqPx -= sizeE-newE;
+ }
+ if (reqPx > 0 && state.west.isVisible && sizeW > minW) {
+ newW = max( sizeW-minW, sizeW-reqPx );
+ reqPx -= sizeW-newW;
+ }
+ // IF we found enough extra space, then resize the border panes as calculated
+ if (reqPx === 0) {
+ if (sizeE && sizeE != minE)
+ sizePane('east', newE, true, force, true); // true = skipCallback/noAnimation - initPanes will handle when done
+ if (sizeW && sizeW != minW)
+ sizePane('west', newW, true, force, true);
+ // now start over!
+ sizeMidPanes('center', skipCallback, force);
+ return; // abort this loop
+ }
+ }
+ }
+ else { // for east and west, set only the height, which is same as center height
+ // set state.min/maxWidth/Height for makePaneFit() logic
+ if (s.isVisible && !s.noVerticalRoom)
+ $.extend(s, elDims($P), cssMinDims(pane))
+ if (!force && !s.noVerticalRoom && newCenter.height === s.outerHeight)
+ return true; // SKIP - pane already the correct size
+ // east/west have same top, bottom & height as center
+ CSS.top = newCenter.top;
+ CSS.bottom = newCenter.bottom;
+ // NEW - allow pane to extend 'below' visible area rather than hide it
+ CSS.height = cssH($P, newCenter.height);
+ s.maxHeight = CSS.height;
+ hasRoom = (s.maxHeight >= 0); // ALWAYS TRUE NOW
+ if (!hasRoom) s.noVerticalRoom = true; // makePaneFit() logic
+ }
+
+ if (hasRoom) {
+ // resizeAll passes skipCallback because it triggers callbacks after ALL panes are resized
+ if (!skipCallback && state.initialized)
+ _runCallbacks("onresize_start", pane);
+
+ $P.css(CSS); // apply the CSS to pane
+ if (pane !== "center")
+ sizeHandles(pane); // also update resizer length
+ if (s.noRoom && !s.isClosed && !s.isHidden)
+ makePaneFit(pane); // will re-open/show auto-closed/hidden pane
+ if (s.isVisible) {
+ $.extend(s, elDims($P)); // update pane dimensions
+ if (state.initialized) sizeContent(pane); // also resize the contents, if exists
+ }
+ }
+ else if (!s.noRoom && s.isVisible) // no room for pane
+ makePaneFit(pane); // will hide or close pane
+
+ if (!s.isVisible)
+ return true; // DONE - next pane
+
+ /*
+ * Extra CSS for IE6 or IE7 in Quirks-mode - add 'width' to NORTH/SOUTH panes
+ * Normally these panes have only 'left' & 'right' positions so pane auto-sizes
+ * ALSO required when pane is an IFRAME because will NOT default to 'full width'
+ * TODO: Can I use width:100% for a north/south iframe?
+ * TODO: Sounds like a job for $P.outerWidth( sC.innerWidth ) SETTER METHOD
+ */
+ if (pane === "center") { // finished processing midPanes
+ var fix = browser.isIE6 || !browser.boxModel;
+ if ($Ps.north && (fix || state.north.tagName=="IFRAME"))
+ $Ps.north.css("width", cssW($Ps.north, sC.innerWidth));
+ if ($Ps.south && (fix || state.south.tagName=="IFRAME"))
+ $Ps.south.css("width", cssW($Ps.south, sC.innerWidth));
+ }
+
+ // resizeAll passes skipCallback because it triggers callbacks after ALL panes are resized
+ if (!skipCallback && state.initialized)
+ _runCallbacks("onresize_end", pane);
+ });
+ }
+
+
+ /**
+ * @see window.onresize(), callbacks or custom code
+ */
+, resizeAll = function (evt) {
+ // stopPropagation if called by trigger("layoutdestroy") - use evtPane utility
+ evtPane(evt);
+
+ if (!state.initialized) {
+ _initLayoutElements();
+ return; // no need to resize since we just initialized!
+ }
+ var oldW = sC.innerWidth
+ , oldH = sC.innerHeight
+ ;
+ // cannot size layout when 'container' is hidden or collapsed
+ if (!$N.is(":visible") ) return;
+ $.extend(state.container, elDims( $N )); // UPDATE container dimensions
+ if (!sC.outerHeight) return;
+
+ // onresizeall_start will CANCEL resizing if returns false
+ // state.container has already been set, so user can access this info for calcuations
+ if (false === _runCallbacks("onresizeall_start")) return false;
+
+ var // see if container is now 'smaller' than before
+ shrunkH = (sC.innerHeight < oldH)
+ , shrunkW = (sC.innerWidth < oldW)
+ , $P, o, s, dir
+ ;
+ // NOTE special order for sizing: S-N-E-W
+ $.each(["south","north","east","west"], function (i, pane) {
+ if (!$Ps[pane]) return; // no pane - SKIP
+ s = state[pane];
+ o = options[pane];
+ dir = _c[pane].dir;
+
+ if (o.autoResize && s.size != o.size) // resize pane to original size set in options
+ sizePane(pane, o.size, true, true, true); // true=skipCallback/forceResize/noAnimation
+ else {
+ setSizeLimits(pane);
+ makePaneFit(pane, false, true, true); // true=skipCallback/forceResize
+ }
+ });
+
+ sizeMidPanes("", true, true); // true=skipCallback, true=forceResize
+ sizeHandles(); // reposition the toggler elements
+
+ // trigger all individual pane callbacks AFTER layout has finished resizing
+ o = options; // reuse alias
+ $.each(_c.allPanes, function (i, pane) {
+ $P = $Ps[pane];
+ if (!$P) return; // SKIP
+ if (state[pane].isVisible) // undefined for non-existent panes
+ _runCallbacks("onresize_end", pane); // callback - if exists
+ });
+
+ _runCallbacks("onresizeall_end");
+ //_triggerLayoutEvent(pane, 'resizeall');
+ }
+
+ /**
+ * Whenever a pane resizes or opens that has a nested layout, trigger resizeAll
+ *
+ * @param {string|Object} evt_or_pane The pane just resized or opened
+ */
+, resizeChildLayout = function (evt_or_pane) {
+ var pane = evtPane.call(this, evt_or_pane);
+ if (!options[pane].resizeChildLayout) return;
+ var $P = $Ps[pane]
+ , $C = $Cs[pane]
+ , d = "layout"
+ , P = Instance[pane]
+ , L = children[pane]
+ ;
+ // user may have manually set EITHER instance pointer, so handle that
+ if (P.child && !L) {
+ // have to reverse the pointers!
+ var el = P.child.container;
+ L = children[pane] = (el ? el.data(d) : 0) || null; // set pointer _directly_ to layout instance
+ }
+
+ // if a layout-pointer exists, see if child has been destroyed
+ if (L && L.destroyed)
+ L = children[pane] = null; // clear child pointers
+ // no child layout pointer is set - see if there is a child layout NOW
+ if (!L) L = children[pane] = $P.data(d) || ($C ? $C.data(d) : 0) || null; // set/update child pointers
+
+ // ALWAYS refresh the pane.child alias
+ P.child = children[pane];
+
+ if (L) L.resizeAll();
+ }
+
+
+ /**
+ * IF pane has a content-div, then resize all elements inside pane to fit pane-height
+ *
+ * @param {string|Object} evt_or_panes The pane(s) being resized
+ * @param {boolean=} [remeasure=false] Should the content (header/footer) be remeasured?
+ */
+, sizeContent = function (evt_or_panes, remeasure) {
+ if (!isInitialized()) return;
+
+ var panes = evtPane.call(this, evt_or_panes);
+ panes = panes ? panes.split(",") : _c.allPanes;
+
+ $.each(panes, function (idx, pane) {
+ var
+ $P = $Ps[pane]
+ , $C = $Cs[pane]
+ , o = options[pane]
+ , s = state[pane]
+ , m = s.content // m = measurements
+ ;
+ if (!$P || !$C || !$P.is(":visible")) return true; // NOT VISIBLE - skip
+
+ // if content-element was REMOVED, update OR remove the pointer
+ if (!$C.length) {
+ initContent(pane, false); // false = do NOT sizeContent() - already there!
+ if (!$C) return; // no replacement element found - pointer have been removed
+ }
+
+ // onsizecontent_start will CANCEL resizing if returns false
+ if (false === _runCallbacks("onsizecontent_start", pane)) return;
+
+ // skip re-measuring offsets if live-resizing
+ if ((!s.isMoving && !s.isResizing) || o.liveContentResizing || remeasure || m.top == undefined) {
+ _measure();
+ // if any footers are below pane-bottom, they may not measure correctly,
+ // so allow pane overflow and re-measure
+ if (m.hiddenFooters > 0 && $P.css("overflow") === "hidden") {
+ $P.css("overflow", "visible");
+ _measure(); // remeasure while overflowing
+ $P.css("overflow", "hidden");
+ }
+ }
+ // NOTE: spaceAbove/Below *includes* the pane paddingTop/Bottom, but not pane.borders
+ var newH = s.innerHeight - (m.spaceAbove - s.css.paddingTop) - (m.spaceBelow - s.css.paddingBottom);
+
+ if (!$C.is(":visible") || m.height != newH) {
+ // size the Content element to fit new pane-size - will autoHide if not enough room
+ setOuterHeight($C, newH, true); // true=autoHide
+ m.height = newH; // save new height
+ };
+
+ if (state.initialized)
+ _runCallbacks("onsizecontent_end", pane);
+
+ function _below ($E) {
+ return max(s.css.paddingBottom, (parseInt($E.css("marginBottom"), 10) || 0));
+ };
+
+ function _measure () {
+ var
+ ignore = options[pane].contentIgnoreSelector
+ , $Fs = $C.nextAll().not(ignore || ':lt(0)') // not :lt(0) = ALL
+ , $Fs_vis = $Fs.filter(':visible')
+ , $F = $Fs_vis.filter(':last')
+ ;
+ m = {
+ top: $C[0].offsetTop
+ , height: $C.outerHeight()
+ , numFooters: $Fs.length
+ , hiddenFooters: $Fs.length - $Fs_vis.length
+ , spaceBelow: 0 // correct if no content footer ($E)
+ }
+ m.spaceAbove = m.top; // just for state - not used in calc
+ m.bottom = m.top + m.height;
+ if ($F.length)
+ //spaceBelow = (LastFooter.top + LastFooter.height) [footerBottom] - Content.bottom + max(LastFooter.marginBottom, pane.paddingBotom)
+ m.spaceBelow = ($F[0].offsetTop + $F.outerHeight()) - m.bottom + _below($F);
+ else // no footer - check marginBottom on Content element itself
+ m.spaceBelow = _below($C);
+ };
+ });
+ }
+
+
+ /**
+ * Called every time a pane is opened, closed, or resized to slide the togglers to 'center' and adjust their length if necessary
+ *
+ * @see initHandles(), open(), close(), resizeAll()
+ * @param {string|Object} evt_or_panes The pane(s) being resized
+ */
+, sizeHandles = function (evt_or_panes) {
+ var panes = evtPane.call(this, evt_or_panes)
+ panes = panes ? panes.split(",") : _c.borderPanes;
+
+ $.each(panes, function (i, pane) {
+ var
+ o = options[pane]
+ , s = state[pane]
+ , $P = $Ps[pane]
+ , $R = $Rs[pane]
+ , $T = $Ts[pane]
+ , $TC
+ ;
+ if (!$P || !$R) return;
+
+ var
+ dir = _c[pane].dir
+ , _state = (s.isClosed ? "_closed" : "_open")
+ , spacing = o["spacing"+ _state]
+ , togAlign = o["togglerAlign"+ _state]
+ , togLen = o["togglerLength"+ _state]
+ , paneLen
+ , left
+ , offset
+ , CSS = {}
+ ;
+
+ if (spacing === 0) {
+ $R.hide();
+ return;
+ }
+ else if (!s.noRoom && !s.isHidden) // skip if resizer was hidden for any reason
+ $R.show(); // in case was previously hidden
+
+ // Resizer Bar is ALWAYS same width/height of pane it is attached to
+ if (dir === "horz") { // north/south
+ //paneLen = $P.outerWidth(); // s.outerWidth ||
+ paneLen = sC.innerWidth; // handle offscreen-panes
+ s.resizerLength = paneLen;
+ left = $.layout.cssNum($P, "left")
+ $R.css({
+ width: cssW($R, paneLen) // account for borders & padding
+ , height: cssH($R, spacing) // ditto
+ , left: left > -9999 ? left : sC.insetLeft // handle offscreen-panes
+ });
+ }
+ else { // east/west
+ paneLen = $P.outerHeight(); // s.outerHeight ||
+ s.resizerLength = paneLen;
+ $R.css({
+ height: cssH($R, paneLen) // account for borders & padding
+ , width: cssW($R, spacing) // ditto
+ , top: sC.insetTop + getPaneSize("north", true) // TODO: what if no North pane?
+ //, top: $.layout.cssNum($Ps["center"], "top")
+ });
+ }
+
+ // remove hover classes
+ removeHover( o, $R );
+
+ if ($T) {
+ if (togLen === 0 || (s.isSliding && o.hideTogglerOnSlide)) {
+ $T.hide(); // always HIDE the toggler when 'sliding'
+ return;
+ }
+ else
+ $T.show(); // in case was previously hidden
+
+ if (!(togLen > 0) || togLen === "100%" || togLen > paneLen) {
+ togLen = paneLen;
+ offset = 0;
+ }
+ else { // calculate 'offset' based on options.PANE.togglerAlign_open/closed
+ if (isStr(togAlign)) {
+ switch (togAlign) {
+ case "top":
+ case "left": offset = 0;
+ break;
+ case "bottom":
+ case "right": offset = paneLen - togLen;
+ break;
+ case "middle":
+ case "center":
+ default: offset = round((paneLen - togLen) / 2); // 'default' catches typos
+ }
+ }
+ else { // togAlign = number
+ var x = parseInt(togAlign, 10); //
+ if (togAlign >= 0) offset = x;
+ else offset = paneLen - togLen + x; // NOTE: x is negative!
+ }
+ }
+
+ if (dir === "horz") { // north/south
+ var width = cssW($T, togLen);
+ $T.css({
+ width: width // account for borders & padding
+ , height: cssH($T, spacing) // ditto
+ , left: offset // TODO: VERIFY that toggler positions correctly for ALL values
+ , top: 0
+ });
+ // CENTER the toggler content SPAN
+ $T.children(".content").each(function(){
+ $TC = $(this);
+ $TC.css("marginLeft", round((width-$TC.outerWidth())/2)); // could be negative
+ });
+ }
+ else { // east/west
+ var height = cssH($T, togLen);
+ $T.css({
+ height: height // account for borders & padding
+ , width: cssW($T, spacing) // ditto
+ , top: offset // POSITION the toggler
+ , left: 0
+ });
+ // CENTER the toggler content SPAN
+ $T.children(".content").each(function(){
+ $TC = $(this);
+ $TC.css("marginTop", round((height-$TC.outerHeight())/2)); // could be negative
+ });
+ }
+
+ // remove ALL hover classes
+ removeHover( 0, $T );
+ }
+
+ // DONE measuring and sizing this resizer/toggler, so can be 'hidden' now
+ if (!state.initialized && (o.initHidden || s.noRoom)) {
+ $R.hide();
+ if ($T) $T.hide();
+ }
+ });
+ }
+
+
+ /**
+ * @param {string|Object} evt_or_pane
+ */
+, enableClosable = function (evt_or_pane) {
+ if (!isInitialized()) return;
+ var pane = evtPane.call(this, evt_or_pane)
+ , $T = $Ts[pane]
+ , o = options[pane]
+ ;
+ if (!$T) return;
+ o.closable = true;
+ $T .bind("click."+ sID, function(evt){ evt.stopPropagation(); toggle(pane); })
+ .css("visibility", "visible")
+ .css("cursor", "pointer")
+ .attr("title", state[pane].isClosed ? o.tips.Open : o.tips.Close) // may be blank
+ .show();
+ }
+ /**
+ * @param {string|Object} evt_or_pane
+ * @param {boolean=} [hide=false]
+ */
+, disableClosable = function (evt_or_pane, hide) {
+ if (!isInitialized()) return;
+ var pane = evtPane.call(this, evt_or_pane)
+ , $T = $Ts[pane]
+ ;
+ if (!$T) return;
+ options[pane].closable = false;
+ // is closable is disable, then pane MUST be open!
+ if (state[pane].isClosed) open(pane, false, true);
+ $T .unbind("."+ sID)
+ .css("visibility", hide ? "hidden" : "visible") // instead of hide(), which creates logic issues
+ .css("cursor", "default")
+ .attr("title", "");
+ }
+
+
+ /**
+ * @param {string|Object} evt_or_pane
+ */
+, enableSlidable = function (evt_or_pane) {
+ if (!isInitialized()) return;
+ var pane = evtPane.call(this, evt_or_pane)
+ , $R = $Rs[pane]
+ ;
+ if (!$R || !$R.data('draggable')) return;
+ options[pane].slidable = true;
+ if (state[pane].isClosed)
+ bindStartSlidingEvent(pane, true);
+ }
+ /**
+ * @param {string|Object} evt_or_pane
+ */
+, disableSlidable = function (evt_or_pane) {
+ if (!isInitialized()) return;
+ var pane = evtPane.call(this, evt_or_pane)
+ , $R = $Rs[pane]
+ ;
+ if (!$R) return;
+ options[pane].slidable = false;
+ if (state[pane].isSliding)
+ close(pane, false, true);
+ else {
+ bindStartSlidingEvent(pane, false);
+ $R .css("cursor", "default")
+ .attr("title", "");
+ removeHover(null, $R[0]); // in case currently hovered
+ }
+ }
+
+
+ /**
+ * @param {string|Object} evt_or_pane
+ */
+, enableResizable = function (evt_or_pane) {
+ if (!isInitialized()) return;
+ var pane = evtPane.call(this, evt_or_pane)
+ , $R = $Rs[pane]
+ , o = options[pane]
+ ;
+ if (!$R || !$R.data('draggable')) return;
+ o.resizable = true;
+ $R.draggable("enable");
+ if (!state[pane].isClosed)
+ $R .css("cursor", o.resizerCursor)
+ .attr("title", o.tips.Resize);
+ }
+ /**
+ * @param {string|Object} evt_or_pane
+ */
+, disableResizable = function (evt_or_pane) {
+ if (!isInitialized()) return;
+ var pane = evtPane.call(this, evt_or_pane)
+ , $R = $Rs[pane]
+ ;
+ if (!$R || !$R.data('draggable')) return;
+ options[pane].resizable = false;
+ $R .draggable("disable")
+ .css("cursor", "default")
+ .attr("title", "");
+ removeHover(null, $R[0]); // in case currently hovered
+ }
+
+
+ /**
+ * Move a pane from source-side (eg, west) to target-side (eg, east)
+ * If pane exists on target-side, move that to source-side, ie, 'swap' the panes
+ *
+ * @param {string|Object} evt_or_pane1 The pane/edge being swapped
+ * @param {string} pane2 ditto
+ */
+, swapPanes = function (evt_or_pane1, pane2) {
+ if (!isInitialized()) return;
+ var pane1 = evtPane.call(this, evt_or_pane1);
+ // change state.edge NOW so callbacks can know where pane is headed...
+ state[pane1].edge = pane2;
+ state[pane2].edge = pane1;
+ // run these even if NOT state.initialized
+ if (false === _runCallbacks("onswap_start", pane1)
+ || false === _runCallbacks("onswap_start", pane2)
+ ) {
+ state[pane1].edge = pane1; // reset
+ state[pane2].edge = pane2;
+ return;
+ }
+
+ var
+ oPane1 = copy( pane1 )
+ , oPane2 = copy( pane2 )
+ , sizes = {}
+ ;
+ sizes[pane1] = oPane1 ? oPane1.state.size : 0;
+ sizes[pane2] = oPane2 ? oPane2.state.size : 0;
+
+ // clear pointers & state
+ $Ps[pane1] = false;
+ $Ps[pane2] = false;
+ state[pane1] = {};
+ state[pane2] = {};
+
+ // ALWAYS remove the resizer & toggler elements
+ if ($Ts[pane1]) $Ts[pane1].remove();
+ if ($Ts[pane2]) $Ts[pane2].remove();
+ if ($Rs[pane1]) $Rs[pane1].remove();
+ if ($Rs[pane2]) $Rs[pane2].remove();
+ $Rs[pane1] = $Rs[pane2] = $Ts[pane1] = $Ts[pane2] = false;
+
+ // transfer element pointers and data to NEW Layout keys
+ move( oPane1, pane2 );
+ move( oPane2, pane1 );
+
+ // cleanup objects
+ oPane1 = oPane2 = sizes = null;
+
+ // make panes 'visible' again
+ if ($Ps[pane1]) $Ps[pane1].css(_c.visible);
+ if ($Ps[pane2]) $Ps[pane2].css(_c.visible);
+
+ // fix any size discrepancies caused by swap
+ resizeAll();
+
+ // run these even if NOT state.initialized
+ _runCallbacks("onswap_end", pane1);
+ _runCallbacks("onswap_end", pane2);
+
+ return;
+
+ function copy (n) { // n = pane
+ var
+ $P = $Ps[n]
+ , $C = $Cs[n]
+ ;
+ return !$P ? false : {
+ pane: n
+ , P: $P ? $P[0] : false
+ , C: $C ? $C[0] : false
+ , state: $.extend(true, {}, state[n])
+ , options: $.extend(true, {}, options[n])
+ }
+ };
+
+ function move (oPane, pane) {
+ if (!oPane) return;
+ var
+ P = oPane.P
+ , C = oPane.C
+ , oldPane = oPane.pane
+ , c = _c[pane]
+ , side = c.side.toLowerCase()
+ , inset = "inset"+ c.side
+ // save pane-options that should be retained
+ , s = $.extend(true, {}, state[pane])
+ , o = options[pane]
+ // RETAIN side-specific FX Settings - more below
+ , fx = { resizerCursor: o.resizerCursor }
+ , re, size, pos
+ ;
+ $.each("fxName,fxSpeed,fxSettings".split(","), function (i, k) {
+ fx[k +"_open"] = o[k +"_open"];
+ fx[k +"_close"] = o[k +"_close"];
+ fx[k +"_size"] = o[k +"_size"];
+ });
+
+ // update object pointers and attributes
+ $Ps[pane] = $(P)
+ .data({
+ layoutPane: Instance[pane] // NEW pointer to pane-alias-object
+ , layoutEdge: pane
+ })
+ .css(_c.hidden)
+ .css(c.cssReq)
+ ;
+ $Cs[pane] = C ? $(C) : false;
+
+ // set options and state
+ options[pane] = $.extend(true, {}, oPane.options, fx);
+ state[pane] = $.extend(true, {}, oPane.state);
+
+ // change classNames on the pane, eg: ui-layout-pane-east ==> ui-layout-pane-west
+ re = new RegExp(o.paneClass +"-"+ oldPane, "g");
+ P.className = P.className.replace(re, o.paneClass +"-"+ pane);
+
+ // ALWAYS regenerate the resizer & toggler elements
+ initHandles(pane); // create the required resizer & toggler
+
+ // if moving to different orientation, then keep 'target' pane size
+ if (c.dir != _c[oldPane].dir) {
+ size = sizes[pane] || 0;
+ setSizeLimits(pane); // update pane-state
+ size = max(size, state[pane].minSize);
+ // use manualSizePane to disable autoResize - not useful after panes are swapped
+ manualSizePane(pane, size, true, true); // true/true = skipCallback/noAnimation
+ }
+ else // move the resizer here
+ $Rs[pane].css(side, sC[inset] + (state[pane].isVisible ? getPaneSize(pane) : 0));
+
+
+ // ADD CLASSNAMES & SLIDE-BINDINGS
+ if (oPane.state.isVisible && !s.isVisible)
+ setAsOpen(pane, true); // true = skipCallback
+ else {
+ setAsClosed(pane);
+ bindStartSlidingEvent(pane, true); // will enable events IF option is set
+ }
+
+ // DESTROY the object
+ oPane = null;
+ };
+ }
+
+
+ /**
+ * INTERNAL method to sync pin-buttons when pane is opened or closed
+ * Unpinned means the pane is 'sliding' - ie, over-top of the adjacent panes
+ *
+ * @see open(), setAsOpen(), setAsClosed()
+ * @param {string} pane These are the params returned to callbacks by layout()
+ * @param {boolean} doPin True means set the pin 'down', False means 'up'
+ */
+, syncPinBtns = function (pane, doPin) {
+ if ($.layout.plugins.buttons)
+ $.each(state[pane].pins, function (i, selector) {
+ $.layout.buttons.setPinState(Instance, $(selector), pane, doPin);
+ });
+ }
+
+; // END var DECLARATIONS
+
+ /**
+ * Capture keys when enableCursorHotkey - toggle pane if hotkey pressed
+ *
+ * @see document.keydown()
+ */
+ function keyDown (evt) {
+ if (!evt) return true;
+ var code = evt.keyCode;
+ if (code < 33) return true; // ignore special keys: ENTER, TAB, etc
+
+ var
+ PANE = {
+ 38: "north" // Up Cursor - $.ui.keyCode.UP
+ , 40: "south" // Down Cursor - $.ui.keyCode.DOWN
+ , 37: "west" // Left Cursor - $.ui.keyCode.LEFT
+ , 39: "east" // Right Cursor - $.ui.keyCode.RIGHT
+ }
+ , ALT = evt.altKey // no worky!
+ , SHIFT = evt.shiftKey
+ , CTRL = evt.ctrlKey
+ , CURSOR = (CTRL && code >= 37 && code <= 40)
+ , o, k, m, pane
+ ;
+
+ if (CURSOR && options[PANE[code]].enableCursorHotkey) // valid cursor-hotkey
+ pane = PANE[code];
+ else if (CTRL || SHIFT) // check to see if this matches a custom-hotkey
+ $.each(_c.borderPanes, function (i, p) { // loop each pane to check its hotkey
+ o = options[p];
+ k = o.customHotkey;
+ m = o.customHotkeyModifier; // if missing or invalid, treated as "CTRL+SHIFT"
+ if ((SHIFT && m=="SHIFT") || (CTRL && m=="CTRL") || (CTRL && SHIFT)) { // Modifier matches
+ if (k && code === (isNaN(k) || k <= 9 ? k.toUpperCase().charCodeAt(0) : k)) { // Key matches
+ pane = p;
+ return false; // BREAK
+ }
+ }
+ });
+
+ // validate pane
+ if (!pane || !$Ps[pane] || !options[pane].closable || state[pane].isHidden)
+ return true;
+
+ toggle(pane);
+
+ evt.stopPropagation();
+ evt.returnValue = false; // CANCEL key
+ return false;
+ };
+
+
+/*
+ * ######################################
+ * UTILITY METHODS
+ * called externally or by initButtons
+ * ######################################
+ */
+
+ /**
+ * Change/reset a pane overflow setting & zIndex to allow popups/drop-downs to work
+ *
+ * @param {Object=} [el] (optional) Can also be 'bound' to a click, mouseOver, or other event
+ */
+ function allowOverflow (el) {
+ if (!isInitialized()) return;
+ if (this && this.tagName) el = this; // BOUND to element
+ var $P;
+ if (isStr(el))
+ $P = $Ps[el];
+ else if ($(el).data("layoutRole"))
+ $P = $(el);
+ else
+ $(el).parents().each(function(){
+ if ($(this).data("layoutRole")) {
+ $P = $(this);
+ return false; // BREAK
+ }
+ });
+ if (!$P || !$P.length) return; // INVALID
+
+ var
+ pane = $P.data("layoutEdge")
+ , s = state[pane]
+ ;
+
+ // if pane is already raised, then reset it before doing it again!
+ // this would happen if allowOverflow is attached to BOTH the pane and an element
+ if (s.cssSaved)
+ resetOverflow(pane); // reset previous CSS before continuing
+
+ // if pane is raised by sliding or resizing, or its closed, then abort
+ if (s.isSliding || s.isResizing || s.isClosed) {
+ s.cssSaved = false;
+ return;
+ }
+
+ var
+ newCSS = { zIndex: (options.zIndexes.resizer_normal + 1) }
+ , curCSS = {}
+ , of = $P.css("overflow")
+ , ofX = $P.css("overflowX")
+ , ofY = $P.css("overflowY")
+ ;
+ // determine which, if any, overflow settings need to be changed
+ if (of != "visible") {
+ curCSS.overflow = of;
+ newCSS.overflow = "visible";
+ }
+ if (ofX && !ofX.match(/(visible|auto)/)) {
+ curCSS.overflowX = ofX;
+ newCSS.overflowX = "visible";
+ }
+ if (ofY && !ofY.match(/(visible|auto)/)) {
+ curCSS.overflowY = ofX;
+ newCSS.overflowY = "visible";
+ }
+
+ // save the current overflow settings - even if blank!
+ s.cssSaved = curCSS;
+
+ // apply new CSS to raise zIndex and, if necessary, make overflow 'visible'
+ $P.css( newCSS );
+
+ // make sure the zIndex of all other panes is normal
+ $.each(_c.allPanes, function(i, p) {
+ if (p != pane) resetOverflow(p);
+ });
+
+ };
+ /**
+ * @param {Object=} [el] (optional) Can also be 'bound' to a click, mouseOver, or other event
+ */
+ function resetOverflow (el) {
+ if (!isInitialized()) return;
+ if (this && this.tagName) el = this; // BOUND to element
+ var $P;
+ if (isStr(el))
+ $P = $Ps[el];
+ else if ($(el).data("layoutRole"))
+ $P = $(el);
+ else
+ $(el).parents().each(function(){
+ if ($(this).data("layoutRole")) {
+ $P = $(this);
+ return false; // BREAK
+ }
+ });
+ if (!$P || !$P.length) return; // INVALID
+
+ var
+ pane = $P.data("layoutEdge")
+ , s = state[pane]
+ , CSS = s.cssSaved || {}
+ ;
+ // reset the zIndex
+ if (!s.isSliding && !s.isResizing)
+ $P.css("zIndex", options.zIndexes.pane_normal);
+
+ // reset Overflow - if necessary
+ $P.css( CSS );
+
+ // clear var
+ s.cssSaved = false;
+ };
+
+/*
+ * #####################
+ * CREATE/RETURN LAYOUT
+ * #####################
+ */
+
+ // validate that container exists
+ var $N = $(this).eq(0); // FIRST matching Container element
+ if (!$N.length) {
+ return _log( options.errors.containerMissing );
+ };
+
+ // Users retrieve Instance of a layout with: $N.layout() OR $N.data("layout")
+ // return the Instance-pointer if layout has already been initialized
+ if ($N.data("layoutContainer") && $N.data("layout"))
+ return $N.data("layout"); // cached pointer
+
+ // init global vars
+ var
+ $Ps = {} // Panes x5 - set in initPanes()
+ , $Cs = {} // Content x5 - set in initPanes()
+ , $Rs = {} // Resizers x4 - set in initHandles()
+ , $Ts = {} // Togglers x4 - set in initHandles()
+ , $Ms = $([]) // Masks - up to 2 masks per pane (IFRAME + DIV)
+ // aliases for code brevity
+ , sC = state.container // alias for easy access to 'container dimensions'
+ , sID = state.id // alias for unique layout ID/namespace - eg: "layout435"
+ ;
+
+ // create Instance object to expose data & option Properties, and primary action Methods
+ var Instance = {
+ // layout data
+ options: options // property - options hash
+ , state: state // property - dimensions hash
+ // object pointers
+ , container: $N // property - object pointers for layout container
+ , panes: $Ps // property - object pointers for ALL Panes: panes.north, panes.center
+ , contents: $Cs // property - object pointers for ALL Content: contents.north, contents.center
+ , resizers: $Rs // property - object pointers for ALL Resizers, eg: resizers.north
+ , togglers: $Ts // property - object pointers for ALL Togglers, eg: togglers.north
+ // border-pane open/close
+ , hide: hide // method - ditto
+ , show: show // method - ditto
+ , toggle: toggle // method - pass a 'pane' ("north", "west", etc)
+ , open: open // method - ditto
+ , close: close // method - ditto
+ , slideOpen: slideOpen // method - ditto
+ , slideClose: slideClose // method - ditto
+ , slideToggle: slideToggle // method - ditto
+ // pane actions
+ , setSizeLimits: setSizeLimits // method - pass a 'pane' - update state min/max data
+ , _sizePane: sizePane // method -intended for user by plugins only!
+ , sizePane: manualSizePane // method - pass a 'pane' AND an 'outer-size' in pixels or percent, or 'auto'
+ , sizeContent: sizeContent // method - pass a 'pane'
+ , swapPanes: swapPanes // method - pass TWO 'panes' - will swap them
+ , showMasks: showMasks // method - pass a 'pane' OR list of panes - default = all panes with mask option set
+ , hideMasks: hideMasks // method - ditto'
+ // pane element methods
+ , initContent: initContent // method - ditto
+ , addPane: addPane // method - pass a 'pane'
+ , removePane: removePane // method - pass a 'pane' to remove from layout, add 'true' to delete the pane-elem
+ , createChildLayout: createChildLayout// method - pass a 'pane' and (optional) layout-options (OVERRIDES options[pane].childOptions
+ // special pane option setting
+ , enableClosable: enableClosable // method - pass a 'pane'
+ , disableClosable: disableClosable // method - ditto
+ , enableSlidable: enableSlidable // method - ditto
+ , disableSlidable: disableSlidable // method - ditto
+ , enableResizable: enableResizable // method - ditto
+ , disableResizable: disableResizable// method - ditto
+ // utility methods for panes
+ , allowOverflow: allowOverflow // utility - pass calling element (this)
+ , resetOverflow: resetOverflow // utility - ditto
+ // layout control
+ , destroy: destroy // method - no parameters
+ , initPanes: isInitialized // method - no parameters
+ , resizeAll: resizeAll // method - no parameters
+ // callback triggering
+ , runCallbacks: _runCallbacks // method - pass evtName & pane (if a pane-event), eg: trigger("onopen", "west")
+ // alias collections of options, state and children - created in addPane and extended elsewhere
+ , hasParentLayout: false // set by initContainer()
+ , children: children // pointers to child-layouts, eg: Instance.children["west"]
+ , north: false // alias group: { name: pane, pane: $Ps[pane], options: options[pane], state: state[pane], child: children[pane] }
+ , south: false // ditto
+ , west: false // ditto
+ , east: false // ditto
+ , center: false // ditto
+ };
+
+ // create the border layout NOW
+ if (_create() === 'cancel') // onload_start callback returned false to CANCEL layout creation
+ return null;
+ else // true OR false -- if layout-elements did NOT init (hidden or do not exist), can auto-init later
+ return Instance; // return the Instance object
+
+}
+
+
+/* OLD versions of jQuery only set $.support.boxModel after page is loaded
+ * so if this is IE, use support.boxModel to test for quirks-mode (ONLY IE changes boxModel).
+ */
+$(function(){
+ var b = $.layout.browser;
+ if (b.msie) b.boxModel = $.support.boxModel;
+});
+
+
+/**
+ * jquery.layout.state 1.0
+ * $Date: 2011-07-16 08:00:00 (Sat, 16 July 2011) $
+ *
+ * Copyright (c) 2010
+ * Kevin Dalman (http://allpro.net)
+ *
+ * Dual licensed under the GPL (http://www.gnu.org/licenses/gpl.html)
+ * and MIT (http://www.opensource.org/licenses/mit-license.php) licenses.
+ *
+ * @dependancies: UI Layout 1.3.0.rc30.1 or higher
+ * @dependancies: $.ui.cookie (above)
+ *
+ * @support: http://groups.google.com/group/jquery-ui-layout
+ */
+/*
+ * State-management options stored in options.stateManagement, which includes a .cookie hash
+ * Default options saves ALL KEYS for ALL PANES, ie: pane.size, pane.isClosed, pane.isHidden
+ *
+ * // STATE/COOKIE OPTIONS
+ * @example $(el).layout({
+ stateManagement: {
+ enabled: true
+ , stateKeys: "east.size,west.size,east.isClosed,west.isClosed"
+ , cookie: { name: "appLayout", path: "/" }
+ }
+ })
+ * @example $(el).layout({ stateManagement__enabled: true }) // enable auto-state-management using cookies
+ * @example $(el).layout({ stateManagement__cookie: { name: "appLayout", path: "/" } })
+ * @example $(el).layout({ stateManagement__cookie__name: "appLayout", stateManagement__cookie__path: "/" })
+ *
+ * // STATE/COOKIE METHODS
+ * @example myLayout.saveCookie( "west.isClosed,north.size,south.isHidden", {expires: 7} );
+ * @example myLayout.loadCookie();
+ * @example myLayout.deleteCookie();
+ * @example var JSON = myLayout.readState(); // CURRENT Layout State
+ * @example var JSON = myLayout.readCookie(); // SAVED Layout State (from cookie)
+ * @example var JSON = myLayout.state.stateData; // LAST LOADED Layout State (cookie saved in layout.state hash)
+ *
+ * CUSTOM STATE-MANAGEMENT (eg, saved in a database)
+ * @example var JSON = myLayout.readState( "west.isClosed,north.size,south.isHidden" );
+ * @example myLayout.loadState( JSON );
+ */
+
+/**
+ * UI COOKIE UTILITY
+ *
+ * A $.cookie OR $.ui.cookie namespace *should be standard*, but until then...
+ * This creates $.ui.cookie so Layout does not need the cookie.jquery.js plugin
+ * NOTE: This utility is REQUIRED by the layout.state plugin
+ *
+ * Cookie methods in Layout are created as part of State Management
+ */
+if (!$.ui) $.ui = {};
+$.ui.cookie = {
+
+ // cookieEnabled is not in DOM specs, but DOES works in all browsers,including IE6
+ acceptsCookies: !!navigator.cookieEnabled
+
+, read: function (name) {
+ var
+ c = document.cookie
+ , cs = c ? c.split(';') : []
+ , pair // loop var
+ ;
+ for (var i=0, n=cs.length; i < n; i++) {
+ pair = $.trim(cs[i]).split('='); // name=value pair
+ if (pair[0] == name) // found the layout cookie
+ return decodeURIComponent(pair[1]);
+
+ }
+ return null;
+ }
+
+, write: function (name, val, cookieOpts) {
+ var
+ params = ''
+ , date = ''
+ , clear = false
+ , o = cookieOpts || {}
+ , x = o.expires
+ ;
+ if (x && x.toUTCString)
+ date = x;
+ else if (x === null || typeof x === 'number') {
+ date = new Date();
+ if (x > 0)
+ date.setDate(date.getDate() + x);
+ else {
+ date.setFullYear(1970);
+ clear = true;
+ }
+ }
+ if (date) params += ';expires='+ date.toUTCString();
+ if (o.path) params += ';path='+ o.path;
+ if (o.domain) params += ';domain='+ o.domain;
+ if (o.secure) params += ';secure';
+ document.cookie = name +'='+ (clear ? "" : encodeURIComponent( val )) + params; // write or clear cookie
+ }
+
+, clear: function (name) {
+ $.ui.cookie.write(name, '', {expires: -1});
+ }
+
+};
+// if cookie.jquery.js is not loaded, create an alias to replicate it
+// this may be useful to other plugins or code dependent on that plugin
+if (!$.cookie) $.cookie = function (k, v, o) {
+ var C = $.ui.cookie;
+ if (v === null)
+ C.clear(k);
+ else if (v === undefined)
+ return C.read(k);
+ else
+ C.write(k, v, o);
+};
+
+
+// tell Layout that the state plugin is available
+$.layout.plugins.stateManagement = true;
+
+// Add State-Management options to layout.defaults
+$.layout.config.optionRootKeys.push("stateManagement");
+$.layout.defaults.stateManagement = {
+ enabled: false // true = enable state-management, even if not using cookies
+, autoSave: true // Save a state-cookie when page exits?
+, autoLoad: true // Load the state-cookie when Layout inits?
+ // List state-data to save - must be pane-specific
+, stateKeys: "north.size,south.size,east.size,west.size,"+
+ "north.isClosed,south.isClosed,east.isClosed,west.isClosed,"+
+ "north.isHidden,south.isHidden,east.isHidden,west.isHidden"
+, cookie: {
+ name: "" // If not specified, will use Layout.name, else just "Layout"
+ , domain: "" // blank = current domain
+ , path: "" // blank = current page, '/' = entire website
+ , expires: "" // 'days' to keep cookie - leave blank for 'session cookie'
+ , secure: false
+ }
+};
+// Set stateManagement as a layout-option, NOT a pane-option
+$.layout.optionsMap.layout.push("stateManagement");
+
+/*
+ * State Management methods
+ */
+$.layout.state = {
+
+ /**
+ * Get the current layout state and save it to a cookie
+ *
+ * myLayout.saveCookie( keys, cookieOpts )
+ *
+ * @param {Object} inst
+ * @param {(string|Array)=} keys
+ * @param {Object=} cookieOpts
+ */
+ saveCookie: function (inst, keys, cookieOpts) {
+ var o = inst.options
+ , oS = o.stateManagement
+ , oC = $.extend(true, {}, oS.cookie, cookieOpts || null)
+ , data = inst.state.stateData = inst.readState( keys || oS.stateKeys ) // read current panes-state
+ ;
+ $.ui.cookie.write( oC.name || o.name || "Layout", $.layout.state.encodeJSON(data), oC );
+ return $.extend(true, {}, data); // return COPY of state.stateData data
+ }
+
+ /**
+ * Remove the state cookie
+ *
+ * @param {Object} inst
+ */
+, deleteCookie: function (inst) {
+ var o = inst.options;
+ $.ui.cookie.clear( o.stateManagement.cookie.name || o.name || "Layout" );
+ }
+
+ /**
+ * Read & return data from the cookie - as JSON
+ *
+ * @param {Object} inst
+ */
+, readCookie: function (inst) {
+ var o = inst.options;
+ var c = $.ui.cookie.read( o.stateManagement.cookie.name || o.name || "Layout" );
+ // convert cookie string back to a hash and return it
+ return c ? $.layout.state.decodeJSON(c) : {};
+ }
+
+ /**
+ * Get data from the cookie and USE IT to loadState
+ *
+ * @param {Object} inst
+ */
+, loadCookie: function (inst) {
+ var c = $.layout.state.readCookie(inst); // READ the cookie
+ if (c) {
+ inst.state.stateData = $.extend(true, {}, c); // SET state.stateData
+ inst.loadState(c); // LOAD the retrieved state
+ }
+ return c;
+ }
+
+ /**
+ * Update layout options from the cookie, if one exists
+ *
+ * @param {Object} inst
+ * @param {Object=} stateData
+ * @param {boolean=} animate
+ */
+, loadState: function (inst, stateData, animate) {
+ stateData = $.layout.transformData( stateData ); // panes = default subkey
+ if ($.isEmptyObject( stateData )) return;
+ $.extend(true, inst.options, stateData); // update layout options
+ // if layout has already been initialized, then UPDATE layout state
+ if (inst.state.initialized) {
+ var pane, vis, o, s, h, c
+ , noAnimate = (animate===false)
+ ;
+ $.each($.layout.config.borderPanes, function (idx, pane) {
+ state = inst.state[pane];
+ o = stateData[ pane ];
+ if (typeof o != 'object') return; // no key, continue
+ s = o.size;
+ c = o.initClosed;
+ h = o.initHidden;
+ vis = state.isVisible;
+ // resize BEFORE opening
+ if (!vis)
+ inst.sizePane(pane, s, false, false);
+ if (h === true) inst.hide(pane, noAnimate);
+ else if (c === false) inst.open (pane, false, noAnimate);
+ else if (c === true) inst.close(pane, false, noAnimate);
+ else if (h === false) inst.show (pane, false, noAnimate);
+ // resize AFTER any other actions
+ if (vis)
+ inst.sizePane(pane, s, false, noAnimate); // animate resize if option passed
+ });
+ };
+ }
+
+ /**
+ * Get the *current layout state* and return it as a hash
+ *
+ * @param {Object=} inst
+ * @param {(string|Array)=} keys
+ */
+, readState: function (inst, keys) {
+ var
+ data = {}
+ , alt = { isClosed: 'initClosed', isHidden: 'initHidden' }
+ , state = inst.state
+ , panes = $.layout.config.allPanes
+ , pair, pane, key, val
+ ;
+ if (!keys) keys = inst.options.stateManagement.stateKeys; // if called by user
+ if ($.isArray(keys)) keys = keys.join(",");
+ // convert keys to an array and change delimiters from '__' to '.'
+ keys = keys.replace(/__/g, ".").split(',');
+ // loop keys and create a data hash
+ for (var i=0, n=keys.length; i < n; i++) {
+ pair = keys[i].split(".");
+ pane = pair[0];
+ key = pair[1];
+ if ($.inArray(pane, panes) < 0) continue; // bad pane!
+ val = state[ pane ][ key ];
+ if (val == undefined) continue;
+ if (key=="isClosed" && state[pane]["isSliding"])
+ val = true; // if sliding, then *really* isClosed
+ ( data[pane] || (data[pane]={}) )[ alt[key] ? alt[key] : key ] = val;
+ }
+ return data;
+ }
+
+ /**
+ * Stringify a JSON hash so can save in a cookie or db-field
+ */
+, encodeJSON: function (JSON) {
+ return parse(JSON);
+ function parse (h) {
+ var D=[], i=0, k, v, t; // k = key, v = value
+ for (k in h) {
+ v = h[k];
+ t = typeof v;
+ if (t == 'string') // STRING - add quotes
+ v = '"'+ v +'"';
+ else if (t == 'object') // SUB-KEY - recurse into it
+ v = parse(v);
+ D[i++] = '"'+ k +'":'+ v;
+ }
+ return '{'+ D.join(',') +'}';
+ };
+ }
+
+ /**
+ * Convert stringified JSON back to a hash object
+ * @see $.parseJSON(), adding in jQuery 1.4.1
+ */
+, decodeJSON: function (str) {
+ try { return $.parseJSON ? $.parseJSON(str) : window["eval"]("("+ str +")") || {}; }
+ catch (e) { return {}; }
+ }
+
+
+, _create: function (inst) {
+ var _ = $.layout.state;
+ // ADD State-Management plugin methods to inst
+ $.extend( inst, {
+ // readCookie - update options from cookie - returns hash of cookie data
+ readCookie: function () { return _.readCookie(inst); }
+ // deleteCookie
+ , deleteCookie: function () { _.deleteCookie(inst); }
+ // saveCookie - optionally pass keys-list and cookie-options (hash)
+ , saveCookie: function (keys, cookieOpts) { return _.saveCookie(inst, keys, cookieOpts); }
+ // loadCookie - readCookie and use to loadState() - returns hash of cookie data
+ , loadCookie: function () { return _.loadCookie(inst); }
+ // loadState - pass a hash of state to use to update options
+ , loadState: function (stateData, animate) { _.loadState(inst, stateData, animate); }
+ // readState - returns hash of current layout-state
+ , readState: function (keys) { return _.readState(inst, keys); }
+ // add JSON utility methods too...
+ , encodeJSON: _.encodeJSON
+ , decodeJSON: _.decodeJSON
+ });
+
+ // init state.stateData key, even if plugin is initially disabled
+ inst.state.stateData = {};
+
+ // read and load cookie-data per options
+ var oS = inst.options.stateManagement;
+ if (oS.enabled) {
+ if (oS.autoLoad) // update the options from the cookie
+ inst.loadCookie();
+ else // don't modify options - just store cookie data in state.stateData
+ inst.state.stateData = inst.readCookie();
+ }
+ }
+
+, _unload: function (inst) {
+ var oS = inst.options.stateManagement;
+ if (oS.enabled) {
+ if (oS.autoSave) // save a state-cookie automatically
+ inst.saveCookie();
+ else // don't save a cookie, but do store state-data in state.stateData key
+ inst.state.stateData = inst.readState();
+ }
+ }
+
+};
+
+// add state initialization method to Layout's onCreate array of functions
+$.layout.onCreate.push( $.layout.state._create );
+$.layout.onUnload.push( $.layout.state._unload );
+
+
+
+
+/**
+ * jquery.layout.buttons 1.0
+ * $Date: 2011-07-16 08:00:00 (Sat, 16 July 2011) $
+ *
+ * Copyright (c) 2010
+ * Kevin Dalman (http://allpro.net)
+ *
+ * Dual licensed under the GPL (http://www.gnu.org/licenses/gpl.html)
+ * and MIT (http://www.opensource.org/licenses/mit-license.php) licenses.
+ *
+ * @dependancies: UI Layout 1.3.0.rc30.1 or higher
+ *
+ * @support: http://groups.google.com/group/jquery-ui-layout
+ *
+ * Docs: [ to come ]
+ * Tips: [ to come ]
+ */
+
+// tell Layout that the state plugin is available
+$.layout.plugins.buttons = true;
+
+// Add buttons options to layout.defaults
+$.layout.defaults.autoBindCustomButtons = false;
+// Specify autoBindCustomButtons as a layout-option, NOT a pane-option
+$.layout.optionsMap.layout.push("autoBindCustomButtons");
+
+/*
+ * Button methods
+ */
+$.layout.buttons = {
+
+ /**
+ * Searches for .ui-layout-button-xxx elements and auto-binds them as layout-buttons
+ *
+ * @see _create()
+ *
+ * @param {Object} inst Layout Instance object
+ */
+ init: function (inst) {
+ var pre = "ui-layout-button-"
+ , layout = inst.options.name || ""
+ , name;
+ $.each("toggle,open,close,pin,toggle-slide,open-slide".split(","), function (i, action) {
+ $.each($.layout.config.borderPanes, function (ii, pane) {
+ $("."+pre+action+"-"+pane).each(function(){
+ // if button was previously 'bound', data.layoutName was set, but is blank if layout has no 'name'
+ name = $(this).data("layoutName") || $(this).attr("layoutName");
+ if (name == undefined || name === layout)
+ inst.bindButton(this, action, pane);
+ });
+ });
+ });
+ }
+
+ /**
+ * Helper function to validate params received by addButton utilities
+ *
+ * Two classes are added to the element, based on the buttonClass...
+ * The type of button is appended to create the 2nd className:
+ * - ui-layout-button-pin // action btnClass
+ * - ui-layout-button-pin-west // action btnClass + pane
+ * - ui-layout-button-toggle
+ * - ui-layout-button-open
+ * - ui-layout-button-close
+ *
+ * @param {Object} inst Layout Instance object
+ * @param {(string|!Object)} selector jQuery selector (or element) for button, eg: ".ui-layout-north .toggle-button"
+ * @param {string} pane Name of the pane the button is for: 'north', 'south', etc.
+ *
+ * @return {Array.} If both params valid, the element matching 'selector' in a jQuery wrapper - otherwise returns null
+ */
+, get: function (inst, selector, pane, action) {
+ var $E = $(selector)
+ , o = inst.options
+ , err = o.errors.addButtonError
+ ;
+ if (!$E.length) { // element not found
+ $.layout.msg(err +" "+ o.errors.selector +": "+ selector, true);
+ }
+ else if ($.inArray(pane, $.layout.config.borderPanes) < 0) { // invalid 'pane' sepecified
+ $.layout.msg(err +" "+ o.errors.pane +": "+ pane, true);
+ $E = $(""); // NO BUTTON
+ }
+ else { // VALID
+ var btn = o[pane].buttonClass +"-"+ action;
+ $E .addClass( btn +" "+ btn +"-"+ pane )
+ .data("layoutName", o.name); // add layout identifier - even if blank!
+ }
+ return $E;
+ }
+
+
+ /**
+ * NEW syntax for binding layout-buttons - will eventually replace addToggle, addOpen, etc.
+ *
+ * @param {Object} inst Layout Instance object
+ * @param {(string|!Object)} selector jQuery selector (or element) for button, eg: ".ui-layout-north .toggle-button"
+ * @param {string} action
+ * @param {string} pane
+ */
+, bind: function (inst, selector, action, pane) {
+ var _ = $.layout.buttons;
+ switch (action.toLowerCase()) {
+ case "toggle": _.addToggle (inst, selector, pane); break;
+ case "open": _.addOpen (inst, selector, pane); break;
+ case "close": _.addClose (inst, selector, pane); break;
+ case "pin": _.addPin (inst, selector, pane); break;
+ case "toggle-slide": _.addToggle (inst, selector, pane, true); break;
+ case "open-slide": _.addOpen (inst, selector, pane, true); break;
+ }
+ return inst;
+ }
+
+ /**
+ * Add a custom Toggler button for a pane
+ *
+ * @param {Object} inst Layout Instance object
+ * @param {(string|!Object)} selector jQuery selector (or element) for button, eg: ".ui-layout-north .toggle-button"
+ * @param {string} pane Name of the pane the button is for: 'north', 'south', etc.
+ * @param {boolean=} slide true = slide-open, false = pin-open
+ */
+, addToggle: function (inst, selector, pane, slide) {
+ $.layout.buttons.get(inst, selector, pane, "toggle")
+ .click(function(evt){
+ inst.toggle(pane, !!slide);
+ evt.stopPropagation();
+ });
+ return inst;
+ }
+
+ /**
+ * Add a custom Open button for a pane
+ *
+ * @param {Object} inst Layout Instance object
+ * @param {(string|!Object)} selector jQuery selector (or element) for button, eg: ".ui-layout-north .toggle-button"
+ * @param {string} pane Name of the pane the button is for: 'north', 'south', etc.
+ * @param {boolean=} slide true = slide-open, false = pin-open
+ */
+, addOpen: function (inst, selector, pane, slide) {
+ $.layout.buttons.get(inst, selector, pane, "open")
+ .attr("title", inst.options[pane].tips.Open)
+ .click(function (evt) {
+ inst.open(pane, !!slide);
+ evt.stopPropagation();
+ });
+ return inst;
+ }
+
+ /**
+ * Add a custom Close button for a pane
+ *
+ * @param {Object} inst Layout Instance object
+ * @param {(string|!Object)} selector jQuery selector (or element) for button, eg: ".ui-layout-north .toggle-button"
+ * @param {string} pane Name of the pane the button is for: 'north', 'south', etc.
+ */
+, addClose: function (inst, selector, pane) {
+ $.layout.buttons.get(inst, selector, pane, "close")
+ .attr("title", inst.options[pane].tips.Close)
+ .click(function (evt) {
+ inst.close(pane);
+ evt.stopPropagation();
+ });
+ return inst;
+ }
+
+ /**
+ * Add a custom Pin button for a pane
+ *
+ * Four classes are added to the element, based on the paneClass for the associated pane...
+ * Assuming the default paneClass and the pin is 'up', these classes are added for a west-pane pin:
+ * - ui-layout-pane-pin
+ * - ui-layout-pane-west-pin
+ * - ui-layout-pane-pin-up
+ * - ui-layout-pane-west-pin-up
+ *
+ * @param {Object} inst Layout Instance object
+ * @param {(string|!Object)} selector jQuery selector (or element) for button, eg: ".ui-layout-north .toggle-button"
+ * @param {string} pane Name of the pane the pin is for: 'north', 'south', etc.
+ */
+, addPin: function (inst, selector, pane) {
+ var _ = $.layout.buttons
+ , $E = _.get(inst, selector, pane, "pin");
+ if ($E.length) {
+ var s = inst.state[pane];
+ $E.click(function (evt) {
+ _.setPinState(inst, $(this), pane, (s.isSliding || s.isClosed));
+ if (s.isSliding || s.isClosed) inst.open( pane ); // change from sliding to open
+ else inst.close( pane ); // slide-closed
+ evt.stopPropagation();
+ });
+ // add up/down pin attributes and classes
+ _.setPinState(inst, $E, pane, (!s.isClosed && !s.isSliding));
+ // add this pin to the pane data so we can 'sync it' automatically
+ // PANE.pins key is an array so we can store multiple pins for each pane
+ s.pins.push( selector ); // just save the selector string
+ }
+ return inst;
+ }
+
+ /**
+ * Change the class of the pin button to make it look 'up' or 'down'
+ *
+ * @see addPin(), syncPins()
+ *
+ * @param {Object} inst Layout Instance object
+ * @param {Array.} $Pin The pin-span element in a jQuery wrapper
+ * @param {string} pane These are the params returned to callbacks by layout()
+ * @param {boolean} doPin true = set the pin 'down', false = set it 'up'
+ */
+, setPinState: function (inst, $Pin, pane, doPin) {
+ var updown = $Pin.attr("pin");
+ if (updown && doPin === (updown=="down")) return; // already in correct state
+ var
+ o = inst.options[pane]
+ , pin = o.buttonClass +"-pin"
+ , side = pin +"-"+ pane
+ , UP = pin +"-up "+ side +"-up"
+ , DN = pin +"-down "+side +"-down"
+ ;
+ $Pin
+ .attr("pin", doPin ? "down" : "up") // logic
+ .attr("title", doPin ? o.tips.Unpin : o.tips.Pin)
+ .removeClass( doPin ? UP : DN )
+ .addClass( doPin ? DN : UP )
+ ;
+ }
+
+ /**
+ * INTERNAL function to sync 'pin buttons' when pane is opened or closed
+ * Unpinned means the pane is 'sliding' - ie, over-top of the adjacent panes
+ *
+ * @see open(), close()
+ *
+ * @param {Object} inst Layout Instance object
+ * @param {string} pane These are the params returned to callbacks by layout()
+ * @param {boolean} doPin True means set the pin 'down', False means 'up'
+ */
+, syncPinBtns: function (inst, pane, doPin) {
+ // REAL METHOD IS _INSIDE_ LAYOUT - THIS IS HERE JUST FOR REFERENCE
+ $.each(inst.state[pane].pins, function (i, selector) {
+ $.layout.buttons.setPinState(inst, $(selector), pane, doPin);
+ });
+ }
+
+
+, _load: function (inst) {
+ var _ = $.layout.buttons;
+ // ADD Button methods to Layout Instance
+ // Note: sel = jQuery Selector string
+ $.extend( inst, {
+ bindButton: function (sel, action, pane) { return _.bind(inst, sel, action, pane); }
+ // DEPRECATED METHODS
+ , addToggleBtn: function (sel, pane, slide) { return _.addToggle(inst, sel, pane, slide); }
+ , addOpenBtn: function (sel, pane, slide) { return _.addOpen(inst, sel, pane, slide); }
+ , addCloseBtn: function (sel, pane) { return _.addClose(inst, sel, pane); }
+ , addPinBtn: function (sel, pane) { return _.addPin(inst, sel, pane); }
+ });
+
+ // init state array to hold pin-buttons
+ for (var i=0; i<4; i++) {
+ var pane = $.layout.config.borderPanes[i];
+ inst.state[pane].pins = [];
+ }
+
+ // auto-init buttons onLoad if option is enabled
+ if ( inst.options.autoBindCustomButtons )
+ _.init(inst);
+ }
+
+, _unload: function (inst) {
+ // TODO: unbind all buttons???
+ }
+
+};
+
+// add initialization method to Layout's onLoad array of functions
+$.layout.onLoad.push( $.layout.buttons._load );
+//$.layout.onUnload.push( $.layout.buttons._unload );
+
+
+
+/**
+ * jquery.layout.browserZoom 1.0
+ * $Date: 2011-12-29 08:00:00 (Thu, 29 Dec 2011) $
+ *
+ * Copyright (c) 2012
+ * Kevin Dalman (http://allpro.net)
+ *
+ * Dual licensed under the GPL (http://www.gnu.org/licenses/gpl.html)
+ * and MIT (http://www.opensource.org/licenses/mit-license.php) licenses.
+ *
+ * @dependancies: UI Layout 1.3.0.rc30.1 or higher
+ *
+ * @support: http://groups.google.com/group/jquery-ui-layout
+ *
+ * @todo: Extend logic to handle other problematic zooming in browsers
+ * @todo: Add hotkey/mousewheel bindings to _instantly_ respond to these zoom event
+ */
+
+// tell Layout that the plugin is available
+$.layout.plugins.browserZoom = true;
+
+$.layout.defaults.browserZoomCheckInterval = 1000;
+$.layout.optionsMap.layout.push("browserZoomCheckInterval");
+
+/*
+ * browserZoom methods
+ */
+$.layout.browserZoom = {
+
+ _init: function (inst) {
+ // abort if browser does not need this check
+ if ($.layout.browserZoom.ratio() !== false)
+ $.layout.browserZoom._setTimer(inst);
+ }
+
+, _setTimer: function (inst) {
+ // abort if layout destroyed or browser does not need this check
+ if (inst.destroyed) return;
+ var o = inst.options
+ , s = inst.state
+ // don't need check if inst has parentLayout, but check occassionally in case parent destroyed!
+ // MINIMUM 100ms interval, for performance
+ , ms = inst.hasParentLayout ? 5000 : Math.max( o.browserZoomCheckInterval, 100 )
+ ;
+ // set the timer
+ setTimeout(function(){
+ if (inst.destroyed || !o.resizeWithWindow) return;
+ var d = $.layout.browserZoom.ratio();
+ if (d !== s.browserZoom) {
+ s.browserZoom = d;
+ inst.resizeAll();
+ }
+ // set a NEW timeout
+ $.layout.browserZoom._setTimer(inst);
+ }
+ , ms );
+ }
+
+, ratio: function () {
+ var w = window
+ , s = screen
+ , d = document
+ , dE = d.documentElement || d.body
+ , b = $.layout.browser
+ , v = b.version
+ , r, sW, cW
+ ;
+ // we can ignore all browsers that fire window.resize event onZoom
+ if ((b.msie && v > 8)
+ || !b.msie
+ ) return false; // don't need to track zoom
+
+ if (s.deviceXDPI)
+ return calc(s.deviceXDPI, s.systemXDPI);
+ // everything below is just for future reference!
+ if (b.webkit && (r = d.body.getBoundingClientRect))
+ return calc((r.left - r.right), d.body.offsetWidth);
+ if (b.webkit && (sW = w.outerWidth))
+ return calc(sW, w.innerWidth);
+ if ((sW = s.width) && (cW = dE.clientWidth))
+ return calc(sW, cW);
+ return false; // no match, so cannot - or don't need to - track zoom
+
+ function calc (x,y) { return (parseInt(x,10) / parseInt(y,10) * 100).toFixed(); }
+ }
+
+};
+// add initialization method to Layout's onLoad array of functions
+$.layout.onReady.push( $.layout.browserZoom._init );
+
+
+
+})( jQuery );
diff --git a/api/lib/modernizr.custom.js b/api/lib/modernizr.custom.js
new file mode 100644
index 0000000..4688d63
--- /dev/null
+++ b/api/lib/modernizr.custom.js
@@ -0,0 +1,4 @@
+/* Modernizr 2.5.3 (Custom Build) | MIT & BSD
+ * Build: http://www.modernizr.com/download/#-inlinesvg
+ */
+;window.Modernizr=function(a,b,c){function u(a){i.cssText=a}function v(a,b){return u(prefixes.join(a+";")+(b||""))}function w(a,b){return typeof a===b}function x(a,b){return!!~(""+a).indexOf(b)}function y(a,b,d){for(var e in a){var f=b[a[e]];if(f!==c)return d===!1?a[e]:w(f,"function")?f.bind(d||b):f}return!1}var d="2.5.3",e={},f=b.documentElement,g="modernizr",h=b.createElement(g),i=h.style,j,k={}.toString,l={svg:"http://www.w3.org/2000/svg"},m={},n={},o={},p=[],q=p.slice,r,s={}.hasOwnProperty,t;!w(s,"undefined")&&!w(s.call,"undefined")?t=function(a,b){return s.call(a,b)}:t=function(a,b){return b in a&&w(a.constructor.prototype[b],"undefined")},Function.prototype.bind||(Function.prototype.bind=function(b){var c=this;if(typeof c!="function")throw new TypeError;var d=q.call(arguments,1),e=function(){if(this instanceof e){var a=function(){};a.prototype=c.prototype;var f=new a,g=c.apply(f,d.concat(q.call(arguments)));return Object(g)===g?g:f}return c.apply(b,d.concat(q.call(arguments)))};return e}),m.inlinesvg=function(){var a=b.createElement("div");return a.innerHTML="root - _root_
+
+
+
+
root package
+
+
+
+
+
+ package
+
+
+ root
+
+
+
+
+
+
+
+
+
+
+
+
Visibility
+
Public All
+
+
+
+
+
+
+
+
+
+
+
Value Members
+
+
+
+ package
+
+
+ com
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/bigquery/src/main/resources/log4j.properties b/bigquery/src/main/resources/log4j.properties
deleted file mode 100644
index 8cb5c8e..0000000
--- a/bigquery/src/main/resources/log4j.properties
+++ /dev/null
@@ -1,13 +0,0 @@
-# Change this to set Spark log level
-log4j.logger.org.apache.spark=WARN
-
-# Silence akka remoting
-log4j.logger.Remoting=WARN
-log4j.logger.akka=WARN
-
-# Silence verbose messages from Hadoop ecosystem
-log4j.logger.org.apache.hadoop=ERROR
-log4j.logger.org.apache.parquet=ERROR
-
-# Ignore messages below warning level from Jetty, because it's a bit verbose
-log4j.logger.org.eclipse.jetty=WARN
diff --git a/bigquery/src/main/resources/reference.conf b/bigquery/src/main/resources/reference.conf
deleted file mode 100644
index 995c43f..0000000
--- a/bigquery/src/main/resources/reference.conf
+++ /dev/null
@@ -1,16 +0,0 @@
-# Based on the Google Cloud Storage settings documented here:
-# https://cloud.google.com/hadoop/google-cloud-storage-connector#configuringhadoop
-spark.hadoop.fs.gs.impl=com.google.cloud.hadoop.fs.gcs.GoogleHadoopFileSystem
-spark.hadoop.fs.AbstractFileSystem.gs.impl=com.google.cloud.hadoop.fs.gcs.GoogleHadoopFS
-spark.hadoop.fs.gs.auth.service.account.json.keyfile = ${?GOOGLE_APPLICATION_CREDENTIALS}
-spark.hadoop.fs.gs.project.id = ${?GOOGLE_PROJECT_ID}
-
-# NOTE: Requires distributed file system to make credential files available
-spark.hadoop.mapred.bq.auth.service.account.json.keyfile = ${?GOOGLE_APPLICATION_CREDENTIALS}
-spark.hadoop.mapred.bq.project.id = ${?GOOGLE_PROJECT_ID}
-
-# Default GCS bucket for uploading to BigQuery
-spark.hadoop.mapred.bq.gcs.bucket = ${?GOOGLE_BQ_BUCKET}
-
-# Google OAuth Credentials
-spark.google.cloud.auth.client.file = ${?GOOGLE_OAUTH_CREDENTIALS}
diff --git a/bigquery/src/main/scala/com.mediative.amadou.bigquery/BigQueryClient.scala b/bigquery/src/main/scala/com.mediative.amadou.bigquery/BigQueryClient.scala
deleted file mode 100644
index ac01570..0000000
--- a/bigquery/src/main/scala/com.mediative.amadou.bigquery/BigQueryClient.scala
+++ /dev/null
@@ -1,298 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou.bigquery
-
-import java.util.UUID
-
-import com.google.api.client.googleapis.auth.oauth2.GoogleCredential
-import com.google.api.client.googleapis.json.GoogleJsonResponseException
-import com.google.api.client.googleapis.json.GoogleJsonError
-import com.google.api.client.http.javanet.NetHttpTransport
-import com.google.api.client.json.jackson2.JacksonFactory
-import com.google.api.services.bigquery.model._
-import com.google.api.services.bigquery.{Bigquery, BigqueryScopes}
-import com.google.cloud.hadoop.io.bigquery._
-import org.apache.hadoop.conf.Configuration
-import org.apache.hadoop.util.Progressable
-import org.slf4j.{Logger, LoggerFactory}
-
-import scala.collection.JavaConverters._
-import scala.util.control.NonFatal
-import scala.util.Try
-
-private[bigquery] object BigQueryClient {
- val STAGING_DATASET_PREFIX = "bq.staging_dataset.prefix"
- val STAGING_DATASET_PREFIX_DEFAULT = "spark_bigquery_staging_"
- val STAGING_DATASET_LOCATION = "bq.staging_dataset.location"
- val STAGING_DATASET_LOCATION_DEFAULT = "US"
- val STAGING_DATASET_TABLE_EXPIRATION_MS = 86400000L
- val STAGING_DATASET_DESCRIPTION = "Spark BigQuery staging dataset"
-
- private var instance: BigQueryClient = null
-
- def getInstance(conf: Configuration): BigQueryClient = {
- if (instance == null) {
- instance = new BigQueryClient(conf)
- }
- instance
- }
-}
-
-private[bigquery] class BigQueryClient(conf: Configuration) {
-
- import BigQueryClient._
-
- private val logger: Logger = LoggerFactory.getLogger(classOf[BigQueryClient])
-
- private val SCOPES = List(BigqueryScopes.BIGQUERY).asJava
-
- private val bigquery: Bigquery = {
- val credential = GoogleCredential.getApplicationDefault.createScoped(SCOPES)
- new Bigquery.Builder(new NetHttpTransport, new JacksonFactory, credential)
- .setApplicationName("spark-bigquery")
- .build()
- }
-
- private def projectId: String = conf.get(BigQueryConfiguration.PROJECT_ID_KEY)
-
- private def inConsole =
- Thread
- .currentThread()
- .getStackTrace
- .exists(_.getClassName.startsWith("scala.tools.nsc.interpreter."))
- private val PRIORITY = if (inConsole) "INTERACTIVE" else "BATCH"
- private val TABLE_ID_PREFIX = "spark_bigquery"
- private val JOB_ID_PREFIX = "spark_bigquery"
-
- /** Matcher for "Missing table" errors. */
- object TableNotFound {
- def unapply(error: Throwable): Option[GoogleJsonError.ErrorInfo] = error match {
- case error: GoogleJsonResponseException =>
- Some(error.getDetails)
- .filter(_.getCode == 404)
- .flatMap(_.getErrors.asScala.find(_.getReason == "notFound"))
- case _ => None
- }
- }
-
- def tableInfo(table: TableReference): Table =
- bigquery.tables().get(table.getProjectId, table.getDatasetId, table.getTableId).execute()
-
- /**
- * Perform a BigQuery SELECT query and save results to the destination table.
- */
- def query(
- sqlQuery: String,
- destinationTable: TableReference,
- writeDisposition: WriteDisposition.Value): TableReference = {
- logger.info(s"Executing query $sqlQuery")
- logger.info(s"Destination table: $destinationTable")
-
- val job =
- createQueryJob(sqlQuery, destinationTable, dryRun = false, PRIORITY, writeDisposition)
- logger.info("JOB ID: " + job.getId)
- waitForJob(job)
- logger.info("JOB STATUS: " + job.getStatus.getState)
- destinationTable
- }
-
- /**
- * Extract table to *.csv.gz files in GCS
- */
- def extract(sourceTable: TableReference, gcsPath: String): Unit = {
- val destination = gcsPath + "/*.csv.gz"
- logger.info(s"extracting $sourceTable to $destination")
- val extractConfig = new JobConfigurationExtract()
- .setDestinationFormat("CSV")
- .setCompression("GZIP")
- .setDestinationUri(destination)
- .setSourceTable(sourceTable)
- val jobConfig = new JobConfiguration().setExtract(extractConfig)
- val jobReference = createJobReference(projectId, JOB_ID_PREFIX)
- val job = new Job().setConfiguration(jobConfig).setJobReference(jobReference)
- bigquery.jobs().insert(projectId, job).execute()
- waitForJob(job)
- }
-
- /**
- * Checks if data has been loaded into a table for a specific date.
- *
- * Performs the following checks and returns false if either succeeds:
- * - the table does not exists
- * - the table never modified on or after the specified date
- * - the table does not contain any data for the specified date
- *
- * The last check will query the table and check whether any entries exists for
- * the column provided via `lastModifiedColumn`.
- */
- def hasDataForDate(
- table: TableReference,
- date: java.sql.Date,
- lastModifiedColumn: String): Boolean = {
- val wasModifiedToday = Try {
- val bqTable =
- bigquery.tables().get(table.getProjectId, table.getDatasetId, table.getTableId).execute()
- bqTable.getLastModifiedTime.longValue() >= date.getTime
- } recover {
- case TableNotFound(message) => false
- }
-
- def partitionHasData = {
- val partition = s"${table.getProjectId}:${table.getDatasetId}.${table.getTableId}"
- val job = createQueryJob(
- s"SELECT count(*) > 1 FROM [$partition] WHERE $lastModifiedColumn >= TIMESTAMP($date) LIMIT 1",
- null,
- false,
- "INTERACTIVE"
- )
- waitForJob(job)
- val result = bigquery.jobs.getQueryResults(projectId, job.getJobReference.getJobId).execute()
- val value = result.getRows.get(0).getF.get(0).getV
- value == "true"
- }
-
- wasModifiedToday.get && partitionHasData
- }
-
- // XXX: Workaround to support CREATE_IF_NEEDED for date-partitioned tables
- private def createPartitionedTableIfMissing(destinationTable: TableReference): Unit = {
- val table = new TableReference()
- .setProjectId(destinationTable.getProjectId)
- .setDatasetId(destinationTable.getDatasetId)
- .setTableId(destinationTable.getTableId.replaceAll("[$].*", ""))
-
- val result = Try {
- bigquery.tables().get(table.getProjectId, table.getDatasetId, table.getTableId).execute()
- } recover {
- case TableNotFound(message) =>
- val tableConfiguration = new Table()
- .setTableReference(table)
- .setTimePartitioning(new TimePartitioning().setType("DAY"))
- logger.info(s"Creating date-partitioned table using $tableConfiguration")
- bigquery
- .tables()
- .insert(table.getProjectId, table.getDatasetId, tableConfiguration)
- .execute()
- }
-
- result.get
- ()
- }
-
- /**
- * Load an JSON data set on GCS to a BigQuery table.
- */
- def load(
- gcsPath: String,
- destinationTable: TableReference,
- schema: TableSchema,
- writeDisposition: WriteDisposition.Value = null,
- createDisposition: CreateDisposition.Value = null): Unit = {
- val tableName = BigQueryStrings.toString(destinationTable)
- logger.info(s"Loading $gcsPath into $tableName using ${writeDisposition}/$createDisposition")
- var loadConfig = new JobConfigurationLoad()
- .setDestinationTable(destinationTable)
- .setSourceFormat("NEWLINE_DELIMITED_JSON")
- .setSourceUris(List(gcsPath + "/*.json").asJava)
- .setSchema(schema)
-
- if (writeDisposition != null) {
- loadConfig = loadConfig.setWriteDisposition(writeDisposition.toString)
- }
-
- if (createDisposition != null) {
- if (createDisposition == CreateDisposition.CREATE_IF_NEEDED && destinationTable.getTableId
- .contains("$"))
- createPartitionedTableIfMissing(destinationTable)
- else
- loadConfig = loadConfig.setCreateDisposition(createDisposition.toString)
- }
-
- val jobConfig = new JobConfiguration().setLoad(loadConfig)
- val jobReference = createJobReference(projectId, JOB_ID_PREFIX)
- val job = new Job().setConfiguration(jobConfig).setJobReference(jobReference)
- bigquery.jobs().insert(projectId, job).execute()
- waitForJob(job)
- }
-
- private def waitForJob(job: Job): Unit =
- BigQueryUtils.waitForJobCompletion(bigquery, projectId, job.getJobReference, new Progressable {
- override def progress(): Unit = println("")
- })
-
- private def stagingDataset(location: String): DatasetReference = {
- // Create staging dataset if it does not already exist
- val prefix = conf.get(STAGING_DATASET_PREFIX, STAGING_DATASET_PREFIX_DEFAULT)
- val datasetId = prefix + location.toLowerCase
- try {
- bigquery.datasets().get(projectId, datasetId).execute()
- logger.info(s"Staging dataset $projectId:$datasetId already exists")
- } catch {
- case e: GoogleJsonResponseException if e.getStatusCode == 404 =>
- logger.info(s"Creating staging dataset $projectId:$datasetId")
- val dsRef = new DatasetReference().setProjectId(projectId).setDatasetId(datasetId)
- val ds = new Dataset()
- .setDatasetReference(dsRef)
- .setDefaultTableExpirationMs(STAGING_DATASET_TABLE_EXPIRATION_MS)
- .setDescription(STAGING_DATASET_DESCRIPTION)
- .setLocation(location)
- bigquery
- .datasets()
- .insert(projectId, ds)
- .execute()
-
- case NonFatal(e) => throw e
- }
- new DatasetReference().setProjectId(projectId).setDatasetId(datasetId)
- }
-
- private def createQueryJob(
- sqlQuery: String,
- destinationTable: TableReference,
- dryRun: Boolean,
- priority: String,
- writeDisposition: WriteDisposition.Value = WriteDisposition.WRITE_EMPTY): Job = {
- var queryConfig = new JobConfigurationQuery()
- .setQuery(sqlQuery)
- .setPriority(priority)
- .setCreateDisposition("CREATE_IF_NEEDED")
- .setWriteDisposition(writeDisposition.toString)
- if (destinationTable != null) {
- queryConfig = queryConfig
- .setDestinationTable(destinationTable)
- .setAllowLargeResults(true)
- }
-
- val jobConfig = new JobConfiguration().setQuery(queryConfig).setDryRun(dryRun)
- val jobReference = createJobReference(projectId, JOB_ID_PREFIX)
- val job = new Job().setConfiguration(jobConfig).setJobReference(jobReference)
- try {
- bigquery.jobs().insert(projectId, job).execute()
- } catch {
- case ex: Exception =>
- logger.error(ex.getMessage, ex)
- ex.printStackTrace()
- throw ex
- }
- }
-
- private def createJobReference(projectId: String, jobIdPrefix: String): JobReference = {
- val fullJobId = projectId + "-" + UUID.randomUUID().toString
- new JobReference().setProjectId(projectId).setJobId(fullJobId)
- }
-
-}
diff --git a/bigquery/src/main/scala/com.mediative.amadou.bigquery/BigQueryTable.scala b/bigquery/src/main/scala/com.mediative.amadou.bigquery/BigQueryTable.scala
deleted file mode 100644
index dfb4044..0000000
--- a/bigquery/src/main/scala/com.mediative.amadou.bigquery/BigQueryTable.scala
+++ /dev/null
@@ -1,69 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-package bigquery
-
-import com.google.api.services.bigquery.model.TableReference
-
-object BigQueryTable {
- type PartitionMapper = DateInterval => DateInterval
- type Reference = com.google.api.services.bigquery.model.TableReference
-
- val PartitionByMonth = BigQueryTable.PartitionStrategy(Month.apply)
- val PartitionByDay = BigQueryTable.PartitionStrategy(Day.apply)
-
- case class PartitionStrategy(mapper: PartitionMapper) {
- def partitionSuffix(date: DateInterval): String = "$" + mapper(date).format("yyyyMMdd")
- }
-}
-
-/**
- * Holds information about how to load data into BigQuery.
- *
- * Example:
- * {{{
- * scala> val date = com.mediative.amadou.Day(2016, 9, 7)
- * scala> val table = BigQueryTable("company_bi", "finance", "billing")
- * scala> table.referenceFor(date)
- * res1: BigQueryTable.Reference = {datasetId=finance, projectId=company_bi, tableId=billing}
- * scala> table.partitionedByDay.referenceFor(date)
- * res1: BigQueryTable.Reference = {datasetId=finance, projectId=company_bi, tableId=billing$20160907}
- * scala> table.partitionedByMonth.referenceFor(date)
- * res1: BigQueryTable.Reference = {datasetId=finance, projectId=company_bi, tableId=billing$20160901}
- * }}}
- *
- * @define 20160907 20160907
- * @define 20160901 20160901
- */
-case class BigQueryTable(
- project: String,
- dataset: String,
- table: String,
- partitionBy: Option[BigQueryTable.PartitionStrategy] = None) {
-
- def partitionedByDay = copy(partitionBy = Some(BigQueryTable.PartitionByDay))
- def partitionedByMonth = copy(partitionBy = Some(BigQueryTable.PartitionByMonth))
-
- def reference(): BigQueryTable.Reference =
- new TableReference()
- .setProjectId(project)
- .setDatasetId(dataset)
- .setTableId(table)
-
- def referenceFor(date: DateInterval): BigQueryTable.Reference =
- reference.setTableId(table + partitionBy.fold("")(_.partitionSuffix(date)))
-}
diff --git a/bigquery/src/main/scala/com.mediative.amadou.bigquery/GoogleAuthentication.scala b/bigquery/src/main/scala/com.mediative.amadou.bigquery/GoogleAuthentication.scala
deleted file mode 100644
index dedc302..0000000
--- a/bigquery/src/main/scala/com.mediative.amadou.bigquery/GoogleAuthentication.scala
+++ /dev/null
@@ -1,75 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou.bigquery
-
-import java.io.{File, FileReader}
-import scala.collection.JavaConversions._
-import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp
-import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver
-import com.google.api.client.googleapis.auth.oauth2.{
- GoogleAuthorizationCodeFlow,
- GoogleClientSecrets
-}
-import com.google.api.client.http.{HttpRequest, HttpRequestInitializer}
-import com.google.api.client.http.javanet.NetHttpTransport
-import com.google.api.client.json.jackson2.JacksonFactory
-import com.google.api.client.util.store.FileDataStoreFactory
-import org.apache.spark.sql.SparkSession
-
-sealed abstract class GoogleAuthentication(val scopes: String*)
-
-object GoogleAuthentication {
- lazy val HTTP_TRANSPORT = new NetHttpTransport()
- lazy val JSON_FACTORY = new JacksonFactory()
-
- case object Dbm
- extends GoogleAuthentication("https://www.googleapis.com/auth/doubleclickbidmanager")
-
- def apply(auth: GoogleAuthentication, spark: SparkSession): HttpRequestInitializer = auth match {
- case Dbm =>
- val clientFilePath = spark.conf.get("spark.google.cloud.auth.client.file")
- require(clientFilePath != null, "'google.cloud.auth.client.file' not configured")
-
- val clientFile = new File(clientFilePath)
- require(clientFile.exists, s"$clientFilePath does not exists")
-
- val clientSecrets = GoogleClientSecrets.load(JSON_FACTORY, new FileReader(clientFile))
- val dataStoreFactory = new FileDataStoreFactory(clientFile.getParentFile)
-
- val flow = new GoogleAuthorizationCodeFlow.Builder(
- HTTP_TRANSPORT,
- JSON_FACTORY,
- clientSecrets,
- auth.scopes)
- .setDataStoreFactory(dataStoreFactory)
- .build()
-
- val cred = new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver())
- .authorize("user")
- new CustomHttpRequestInitializer(cred)
- }
-
- class CustomHttpRequestInitializer(wrapped: HttpRequestInitializer)
- extends HttpRequestInitializer {
- override def initialize(httpRequest: HttpRequest) = {
- wrapped.initialize(httpRequest)
- httpRequest.setConnectTimeout(10 * 60000) // 10 minutes connect timeout
- httpRequest.setReadTimeout(10 * 60000) // 10 minutes read timeout
- ()
- }
- }
-}
diff --git a/bigquery/src/main/scala/com.mediative.amadou.bigquery/package.scala b/bigquery/src/main/scala/com.mediative.amadou.bigquery/package.scala
deleted file mode 100644
index 1c6bcac..0000000
--- a/bigquery/src/main/scala/com.mediative.amadou.bigquery/package.scala
+++ /dev/null
@@ -1,199 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-
-import com.google.api.services.bigquery.model._
-import com.google.cloud.hadoop.fs.gcs.GoogleHadoopFileSystem
-import com.google.cloud.hadoop.io.bigquery._
-import org.apache.hadoop.fs.{FileSystem, Path}
-import net.ceedubs.ficus.readers.ValueReader
-import net.ceedubs.ficus.FicusInstances
-
-import org.apache.spark.sql.{Dataset, SparkSession, Encoder}
-import java.util.concurrent.ThreadLocalRandom
-import scala.collection.JavaConversions._
-
-package object bigquery extends FicusInstances {
-
- object CreateDisposition extends Enumeration {
- val CREATE_IF_NEEDED, CREATE_NEVER = Value
- }
-
- object WriteDisposition extends Enumeration {
- val WRITE_TRUNCATE, WRITE_APPEND, WRITE_EMPTY = Value
- }
-
- val BQ_CSV_DATE_FORMAT = "yyyy-MM-dd HH:mm:ss zzz"
-
- object TableNotFound {
- import com.google.api.client.googleapis.json.GoogleJsonResponseException
- import com.google.api.client.googleapis.json.GoogleJsonError
- import scala.collection.JavaConverters._
-
- def unapply(error: Throwable): Option[GoogleJsonError.ErrorInfo] = error match {
- case error: GoogleJsonResponseException =>
- Some(error.getDetails)
- .filter(_.getCode == 404)
- .flatMap(_.getErrors.asScala.find(_.getReason == "notFound"))
- case _ => None
- }
- }
-
- def tableHasDataForDate(
- spark: SparkSession,
- table: TableReference,
- date: java.sql.Date,
- column: String): Boolean = {
- val bq = BigQueryClient.getInstance(spark.sparkContext.hadoopConfiguration)
- bq.hasDataForDate(table, date, column)
- }
-
- /**
- * Enhanced version of SparkSession with BigQuery support.
- */
- implicit class BigQuerySparkSession(self: SparkSession) {
-
- val sc = self.sqlContext.sparkContext
- val conf = sc.hadoopConfiguration
- lazy val bq = BigQueryClient.getInstance(conf)
-
- // Register GCS implementation
- if (conf.get("fs.gs.impl") == null) {
- conf.set("fs.gs.impl", classOf[GoogleHadoopFileSystem].getName)
- }
-
- /**
- * Set GCP project ID for BigQuery.
- */
- def setBigQueryProjectId(projectId: String): Unit = {
- conf.set(BigQueryConfiguration.PROJECT_ID_KEY, projectId)
-
- // Also set project ID for GCS connector
- if (conf.get("fs.gs.project.id") == null) {
- conf.set("fs.gs.project.id", projectId)
- }
- }
-
- /**
- * Set GCS bucket for temporary BigQuery files.
- */
- def setBigQueryGcsBucket(gcsBucket: String): Unit =
- conf.set(BigQueryConfiguration.GCS_BUCKET_KEY, gcsBucket)
-
- /**
- * Set BigQuery dataset location, e.g. US, EU.
- */
- def setBigQueryDatasetLocation(location: String): Unit =
- conf.set(BigQueryClient.STAGING_DATASET_LOCATION, location)
-
- /**
- * Set GCP JSON key file.
- */
- def setGcpJsonKeyFile(jsonKeyFile: String): Unit = {
- conf.set("mapred.bq.auth.service.account.json.keyfile", jsonKeyFile)
- conf.set("fs.gs.auth.service.account.json.keyfile", jsonKeyFile)
- }
-
- /**
- * Set GCP pk12 key file.
- */
- def setGcpPk12KeyFile(pk12KeyFile: String): Unit = {
- conf.set("google.cloud.auth.service.account.keyfile", pk12KeyFile)
- conf.set("mapred.bq.auth.service.account.keyfile", pk12KeyFile)
- conf.set("fs.gs.auth.service.account.keyfile", pk12KeyFile)
- }
-
- /**
- * Reads a CSV extract of a BigQuery table.
- */
- def readBigQueryCSVExtract[T: Encoder](url: String, dateFormat: String): Seq[T] =
- self.read
- .option("header", true)
- .option("timestampFormat", dateFormat)
- .option("escape", "\"")
- .schema(implicitly[Encoder[T]].schema)
- .csv(url)
- .as[T]
- .collect
- .toSeq
-
- def readBigQueryCSVExtract[T: Encoder](
- url: HdfsUrl,
- dateFormat: String = BQ_CSV_DATE_FORMAT): Seq[T] =
- readBigQueryCSVExtract(url.toString, dateFormat)
- }
-
- /**
- * Enhanced version of DataFrame with BigQuery support.
- */
- implicit class BigQueryDataset[T](self: Dataset[T]) {
-
- val sqlContext = self.sqlContext
- val conf = sqlContext.sparkContext.hadoopConfiguration
- val bq = BigQueryClient.getInstance(conf)
-
- /**
- * Save a DataFrame to a BigQuery table.
- */
- def saveAsBigQueryTable(
- tableRef: TableReference,
- writeDisposition: WriteDisposition.Value,
- createDisposition: CreateDisposition.Value): Unit = {
- val bucket = conf.get(BigQueryConfiguration.GCS_BUCKET_KEY)
- val temp =
- s"spark-bigquery-${System.currentTimeMillis()}=${ThreadLocalRandom.current.nextInt(Int.MaxValue)}"
- val gcsPath = s"gs://$bucket/spark-bigquery-tmp/$temp"
- self.write.json(gcsPath)
-
- val schemaFields = self.schema.fields.map { field =>
- import org.apache.spark.sql.types._
-
- val fieldType = field.dataType match {
- case BooleanType => "BOOLEAN"
- case LongType => "INTEGER"
- case IntegerType => "INTEGER"
- case StringType => "STRING"
- case DoubleType => "FLOAT"
- case TimestampType => "TIMESTAMP"
- case _: DecimalType => "INTEGER"
- }
- new TableFieldSchema().setName(field.name).setType(fieldType)
- }.toList
-
- val tableSchema = new TableSchema().setFields(schemaFields)
-
- bq.load(gcsPath, tableRef, tableSchema, writeDisposition, createDisposition)
- delete(new Path(gcsPath))
- }
-
- private def delete(path: Path): Unit = {
- val fs = FileSystem.get(path.toUri, conf)
- fs.delete(path, true)
- ()
- }
-
- }
-
- implicit val valueReader: ValueReader[BigQueryTable.PartitionStrategy] =
- ValueReader[String].map {
- _ match {
- case "month" => BigQueryTable.PartitionByMonth
- case "day" => BigQueryTable.PartitionByDay
- case other => sys.error(s"Unknown partition strategy")
- }
- }
-}
diff --git a/bin/scalafmt b/bin/scalafmt
deleted file mode 100755
index 3de0a82..0000000
--- a/bin/scalafmt
+++ /dev/null
@@ -1,20 +0,0 @@
-#!/usr/bin/env bash
-
-# set -x
-
-HERE="`dirname $0`"
-VERSION="1.1.0"
-COURSIER="$HERE/.coursier"
-SCALAFMT="$HERE/.scalafmt-$VERSION"
-
-if [ ! -f $COURSIER ]; then
- curl -L -o $COURSIER https://git.io/vgvpD
- chmod +x $COURSIER
-fi
-
-if [ ! -f $SCALAFMT ]; then
- $COURSIER bootstrap com.geirsson:scalafmt-cli_2.12:$VERSION --main org.scalafmt.cli.Cli -o $SCALAFMT
- chmod +x $SCALAFMT
-fi
-
-$SCALAFMT "$@"
diff --git a/build.sbt b/build.sbt
deleted file mode 100644
index 0ce2b3a..0000000
--- a/build.sbt
+++ /dev/null
@@ -1,106 +0,0 @@
-import com.typesafe.sbt.packager.docker.Cmd
-
-Jvm.`1.8`.required
-
-inThisBuild(
- Def.settings(
- organization := "com.mediative",
- scalaVersion := "2.11.11",
- scalacOptions += "-Ywarn-unused-import",
- publishArtifact in (Compile, packageDoc) := false,
- publishArtifact in (Compile, packageSrc) := false,
- doctestTestFramework := DoctestTestFramework.ScalaTest,
- doctestWithDependencies := false,
- resolvers ++= Seq(
- Resolver.bintrayRepo("mediative", "maven"),
- Resolver.jcenterRepo
- ),
- envVars in Test ++= Map(
- "AMADOU_RETRY_MAX" -> "1",
- "SPARK_LOCAL_IP" -> "localhost"
- ),
- envVars in IntegrationTest ++= (envVars in Test).value
- ))
-
-lazy val Versions = new {
- val kafka = "0.8.2.2"
- val spark = "2.1.1"
- val sparkTestingBase = "2.1.0_0.6.0" // FIXME: when available s"${spark}_0.6.0"
- val prometheus = "0.0.23"
- val hadoop = "2.7.2"
-}
-
-lazy val amadou = project
- .in(file("."))
- .enablePlugins(MediativeGitHubPlugin, MediativeReleasePlugin)
- .aggregate(base, testkit, core, bigquery, runtime)
- .settings(
- noPublishSettings,
- postReleaseSteps ++= Seq(base, runtime).map(p => releaseStepTask(publish in Docker in p))
- )
-
-val base = project
- .enablePlugins(MediativeBintrayPlugin, MediativeDockerPlugin)
- .settings(
- name := "amadou-base",
- dockerRepository := Some("mediative-docker-container-registry.bintray.io/amadou"),
- packageName := "base",
- libraryDependencies ++= Seq(
- "com.iheart" %% "ficus" % "1.4.0",
- "com.lihaoyi" %% "upickle" % "0.3.6",
- "io.prometheus" % "simpleclient_common" % Versions.prometheus,
- "io.prometheus" % "simpleclient_hotspot" % Versions.prometheus,
- "com.typesafe.scala-logging" %% "scala-logging" % "3.1.0",
- "org.apache.spark" %% "spark-core" % Versions.spark,
- "org.apache.spark" %% "spark-mllib" % Versions.spark,
- "org.apache.spark" %% "spark-sql" % Versions.spark,
- "org.apache.spark" %% "spark-hive" % Versions.spark,
- "org.apache.hadoop" % "hadoop-aws" % Versions.hadoop
- exclude ("joda-time", "joda-time"),
- "joda-time" % "joda-time" % "2.9.7", // XXX: Use explicit joda-time dependency for AWS SDK
- "org.apache.kafka" % "kafka-clients" % Versions.kafka
- exclude ("org.slf4j", "slf4j-log4j12")
- )
- )
-
-val testkit = project
- .enablePlugins(MediativeBintrayPlugin)
- .dependsOn(base)
- .settings(
- name := "amadou-testkit",
- libraryDependencies ++= Seq(
- "com.holdenkarau" %% "spark-testing-base" % Versions.sparkTestingBase,
- "org.apache.hadoop" % "hadoop-mapreduce-client-core" % Versions.hadoop force ()
- )
- )
-
-val core = project
- .enablePlugins(MediativeBintrayPlugin)
- .dependsOn(base, testkit % Test)
- .settings(
- name := "amadou-core"
- )
-
-val bigquery = project
- .enablePlugins(MediativeBintrayPlugin)
- .dependsOn(core, testkit % Test)
- .settings(
- name := "amadou-bigquery",
- libraryDependencies ++= Seq(
- "com.google.cloud.bigdataoss" % "bigquery-connector" % "0.7.8-hadoop2"
- exclude ("com.google.apis", "google-api-services-bigquery"),
- "com.google.apis" % "google-api-services-bigquery" % "v2-rev320-1.22.0",
- "com.google.oauth-client" % "google-oauth-client-jetty" % "1.20.0"
- exclude ("org.mortbay.jetty", "servlet-api")
- )
- )
-
-val runtime = project
- .enablePlugins(MediativeBintrayPlugin, MediativeDockerPlugin)
- .dependsOn(core, bigquery)
- .settings(
- name := "amadou-runtime",
- dockerBaseImage := (dockerAlias in base).value.versioned,
- dockerRepository := Some("mediative-docker-container-registry.bintray.io/amadou"),
- packageName := "runtime"
- )
diff --git a/core/src/main/resources/log4j.properties b/core/src/main/resources/log4j.properties
deleted file mode 100644
index 8cb5c8e..0000000
--- a/core/src/main/resources/log4j.properties
+++ /dev/null
@@ -1,13 +0,0 @@
-# Change this to set Spark log level
-log4j.logger.org.apache.spark=WARN
-
-# Silence akka remoting
-log4j.logger.Remoting=WARN
-log4j.logger.akka=WARN
-
-# Silence verbose messages from Hadoop ecosystem
-log4j.logger.org.apache.hadoop=ERROR
-log4j.logger.org.apache.parquet=ERROR
-
-# Ignore messages below warning level from Jetty, because it's a bit verbose
-log4j.logger.org.eclipse.jetty=WARN
diff --git a/core/src/main/resources/reference.conf b/core/src/main/resources/reference.conf
deleted file mode 100644
index 1bccda5..0000000
--- a/core/src/main/resources/reference.conf
+++ /dev/null
@@ -1,46 +0,0 @@
-deploy.environment = dev
-deploy.environment = ${?DEPLOY_ENVIRONMENT}
-
-# Settings for retrying failed stage runs
-retry {
- # Delay between retries
- delay = 20 minutes
- delay = ${?AMADOU_RETRY_DELAY}
-
- # Maximum number of retries
- max = 3
- max = ${?AMADOU_RETRY_MAX}
-}
-
-# Example Slack configuration
-#slack {
-# url = "https://hooks.slack.com/services/CHANGE-ME"
-# channel = CHANGE-ME
-# user = CHANGE-ME
-# icon = ":ghost:"
-#}
-
-# Default settings for Kafka-based monitoring
-kafka {
- # Configure the servers to enable Kafka:
- #bootstrap.servers = "host1:1234,host2:1234,host3:1234"
- acks = "all"
- retries = 0
- batch.size = 16384
- linger.ms = 1
- buffer.memory = 33554432
- key.serializer = "org.apache.kafka.common.serialization.StringSerializer"
- value.serializer = "org.apache.kafka.common.serialization.StringSerializer"
- topic.prefix = spark-etl-${deploy.environment}
-}
-
-spark.master = "local[*]"
-spark.logConf = true
-
-# AWS S3 Credentials
-#
-# If the AWS_CREDENTIALS environment variable is defined, credentials
-# are read that file, however, they can also be overridden using
-# environment variables.
-spark.hadoop.fs.s3a.access.key = ${?AWS_ACCESS_KEY_ID}
-spark.hadoop.fs.s3a.secret.key = ${?AWS_SECRET_ACCESS_KEY}
diff --git a/core/src/main/scala/com.mediative.amadou/ConfigLoader.scala b/core/src/main/scala/com.mediative.amadou/ConfigLoader.scala
deleted file mode 100644
index 707b020..0000000
--- a/core/src/main/scala/com.mediative.amadou/ConfigLoader.scala
+++ /dev/null
@@ -1,47 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-
-import net.ceedubs.ficus.{Ficus, FicusConfig, FicusInstances}
-import net.ceedubs.ficus.readers.{ArbitraryTypeReader, ValueReader}
-import java.util.Properties
-
-/**
- * Mixin for loading and injecting values from configuration files.
- */
-trait ConfigLoader extends ArbitraryTypeReader with FicusInstances {
- implicit def toFicusConfig(config: Config): FicusConfig = Ficus.toFicusConfig(config)
-
- /**
- * Value reader for optionally loading properties from a file.
- *
- * When the named path does not exists an empty Properties instance is returned
- *
- * @example
- * {{{
- * case class Database(url: String, properties: Properties)
- * }}}
- */
- implicit val propertiesValueReader: ValueReader[Properties] = new ValueReader[Properties] {
- def read(config: Config, path: String): Properties = {
- val properties = new Properties()
- for (path <- Option(path).filter(config.hasPath).map(config.getString))
- properties.load(new java.io.FileInputStream(path))
- properties
- }
- }
-}
diff --git a/core/src/main/scala/com.mediative.amadou/DatabaseUtils.scala b/core/src/main/scala/com.mediative.amadou/DatabaseUtils.scala
deleted file mode 100644
index eb90621..0000000
--- a/core/src/main/scala/com.mediative.amadou/DatabaseUtils.scala
+++ /dev/null
@@ -1,36 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-
-import java.sql._
-import java.util.Properties
-
-object DatabaseUtils extends Logging {
-
- /**
- * Run a sequence of database scripts.
- */
- def runScripts(url: String, properties: Properties, scripts: String*): Unit =
- for {
- connection <- ManagedIO(DriverManager.getConnection(url, properties))
- statement <- ManagedIO(connection.createStatement)
- sql <- scripts
- } {
- logger.info(s"Executing SQL script in ${url}: $sql")
- statement.executeUpdate(sql)
- }
-}
diff --git a/core/src/main/scala/com.mediative.amadou/DateInterval.scala b/core/src/main/scala/com.mediative.amadou/DateInterval.scala
deleted file mode 100644
index 83d7363..0000000
--- a/core/src/main/scala/com.mediative.amadou/DateInterval.scala
+++ /dev/null
@@ -1,360 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-
-import java.sql.{Date, Timestamp}
-import java.text.SimpleDateFormat
-import java.util.{Calendar, TimeZone}
-
-import scala.util.Try
-
-/**
- * Base class for date intervals.
- *
- * The interval is represented as the half open range between `from` and `to`.
- * For instance, May 2014 is represented as `from = 2014-05-01`, `to = 2014-06-01`.
- *
- * Example:
- * {{{
- * scala> Seq(Day(2016, 8, 11), Week(2016, 32), Month(2016, 8), Quarter(2016, Quarter.Q3), Year(2016))
- * res1: Seq[DateInterval] = List(2016-08-11, 2016-W32, 2016-08, 2016-Q3, 2016)
- * }}}
- */
-sealed abstract class DateInterval(
- val from: Long,
- val interval: DateIntervalType,
- val toOpt: Option[DateInterval] = None)
- extends Ordered[DateInterval] {
-
- def end = toOpt.getOrElse(next)
-
- /**
- * Define a custom interval.
- *
- * Example:
- * {{{
- * scala> Month(2016, 8) to Day(2016, 8, 29)
- * res1: DateInterval = 2016-08:2016-08-29
- * scala> (Day(2016, 8, 11) to Day(2016, 8, 29)).by(Day).size
- * res2: Int = 18
- * }}}
- */
- def to(other: DateInterval): DateInterval =
- if (toOpt.forall(_ < other))
- interval.newBuilder.from(from).to(other).build
- else
- this
-
- def +(delta: Int): DateInterval = interval.newBuilder.from(from).add(delta).build
- def -(delta: Int): DateInterval = this.+(-delta)
-
- override def equals(other: Any): Boolean = other match {
- case that: DateInterval =>
- interval == that.interval && toOpt == that.toOpt && compare(that) == 0
- case _ => false
- }
-
- override def compare(that: DateInterval) = from.compareTo(that.from)
-
- override def toString =
- interval.defaultFormatter.format(asDate) + toOpt.fold("")(":" + _.toString)
-
- def format(dateFormat: String): String = {
- val formatter = interval.formatter(dateFormat)
- formatter.format(asDate) + toOpt.fold("")(":" + _.toString)
- }
-
- def asDate = new Date(from)
- def asTimestamp = new Timestamp(from)
-
- def contains(date: DateInterval): Boolean =
- this <= date && date < end
-
- /**
- * Iterate over all days in this date interval.
- *
- * Example:
- * {{{
- * scala> Week(2016, 11).by(Day).size
- * res1: Int = 7
- * scala> Week(2016, 11).by(Day).toList
- * res2: List[DateInterval] = List(2016-03-14, 2016-03-15, 2016-03-16, 2016-03-17, 2016-03-18, 2016-03-19, 2016-03-20)
- * }}}
- */
- def by(interval: DateIntervalType): Traversable[DateInterval] = {
- var d = interval.apply(this)
-
- Stream.iterate(d)(_.next).takeWhile(_.from < end.from)
- }
-
- /**
- * Returns the preceding corresponding date interval (eg. May -> April).
- *
- * Example:
- * {{{
- * scala> Month(2016, 5).prev
- * res1: DateInterval = 2016-04
- * }}}
- */
- def prev: DateInterval = this - 1
-
- /**
- * Returns the subsequent corresponding date interval (eg. 2014 -> 2015).
- *
- * Example:
- * {{{
- * scala> Year(2014).next
- * res1: DateInterval = 2015
- * }}}
- */
- def next: DateInterval = this + 1
-}
-
-object DateInterval {
- val UTC = TimeZone.getTimeZone("UTC")
-}
-
-/**
- * Base class for specific date intervals
- */
-sealed abstract class DateIntervalType(val calendarField: Int, val dateFormat: String) {
-
- /**
- * Create a date interval with a different type and truncate lower
- * resolution date fields accordingly.
- *
- * Example:
- * {{{
- * scala> Day(1431000000000L)
- * res1: DateInterval = 2015-05-07
- * scala> Week(Day(1431000000000L))
- * res2: DateInterval = 2015-W19
- * scala> Month(Day(1431000000000L))
- * res3: DateInterval = 2015-05
- * scala> Quarter(1431000000000L)
- * res4: DateInterval = 2015-Q2
- * scala> Year(Day(1431000000000L))
- * res5: DateInterval = 2015
- * scala> Year(Day(1431000000000L)).format("yyyy-MM-dd HH:mm ZZ")
- * res6: String = 2015-01-01 00:00 +0000
- * }}}
- */
- def apply(date: DateInterval): DateInterval =
- apply(date.from)
-
- /**
- * Represent the interval for a given timestamp using the specified
- * interval type.
- *
- * This will truncate lower resolution date fields to their initial
- * value, for example for months the day of month field is set to 1.
- *
- * Example:
- * {{{
- * scala> Day(1431000000000L).format("yyyy-MM-dd HH:mm ZZ")
- * res1: String = 2015-05-07 00:00 +0000
- * scala> Month(1431000000000L).format("yyyy-MM-dd HH:mm ZZ")
- * res2: String = 2015-05-01 00:00 +0000
- * scala> Year(1431000000000L).format("yyyy-MM-dd HH:mm ZZ")
- * res3: String = 2015-01-01 00:00 +0000
- * }}}
- */
- def apply(timestamp: Long): DateInterval =
- newBuilder.from(timestamp).build
-
- /**
- * Represent the interval for today using the specified interval type.
- *
- * This will truncate lower resolution date fields to their initial
- * value, for example for months the day of month field is set to 1.
- */
- def today = apply(System.currentTimeMillis())
-
- /**
- * Parse a timestamp into a date interval.
- *
- * Example:
- * {{{
- * scala> Day.parse("2015-05-07")
- * res1: Option[DateInterval] = Some(2015-05-07)
- * scala> Day.parse("2015-05-07").get.format("yyyy-MM-dd HH:mm ZZ")
- * res2: String = 2015-05-07 00:00 +0000
- * }}}
- */
- def parse(input: String): Option[DateInterval] =
- Try(defaultFormatter.parse(input)).map(date => newBuilder.from(date.getTime).build).toOption
-
- private[amadou] def formatter(pattern: String = dateFormat): SimpleDateFormat = {
- val dateFormat = new SimpleDateFormat(pattern)
- dateFormat.setCalendar(Builder.newCalendar)
- dateFormat
- }
-
- private[amadou] def defaultFormatter: SimpleDateFormat =
- formatter(dateFormat)
-
- private[amadou] def newBuilder(): Builder =
- new Builder()
-
- private class Instance(from: Long, toOpt: Option[DateInterval])
- extends DateInterval(from, DateIntervalType.this, toOpt)
-
- private[amadou] case class Builder(from: Long = 0, toOpt: Option[DateInterval] = None) {
- def update(f: Calendar => Unit): Builder = {
- val cal = Builder.newCalendar
- cal.setTimeInMillis(from)
- f(cal)
- copy(from = cal.getTimeInMillis)
- }
-
- def from(date: DateInterval): Builder = copy(from = date.from)
- def from(timestamp: Long): Builder = copy(from = timestamp)
- def to(date: DateInterval): Builder = copy(toOpt = Some(date))
-
- def add(delta: Int): Builder =
- DateIntervalType.this match {
- case Quarter => update(_.add(calendarField, delta * 3))
- case _ => update(_.add(calendarField, delta))
- }
-
- def set(year: Int, month: Int = 1, day: Int = 1): Builder = {
- require(1 <= month && month <= 12, "month must be between 1-12")
- update(_.set(year, month - 1, day))
- }
-
- def build(): DateInterval = {
- val cal = Builder.newCalendar
- cal.setTimeInMillis(from)
- val truncated = Builder.newCalendar
- DateIntervalType.this match {
- case Week =>
- truncated.setWeekDate(cal.getWeekYear(), cal.get(Calendar.WEEK_OF_YEAR), Week.Monday.id)
-
- case Quarter =>
- truncated.set(cal.get(Calendar.YEAR), (cal.get(Calendar.MONTH) / 3) * 3, 1)
-
- case _ =>
- Seq(Calendar.DAY_OF_MONTH, Calendar.MONTH, Calendar.YEAR)
- .dropWhile(_ != calendarField)
- .reverse
- .foreach(field => truncated.set(field, cal.get(field)))
- }
-
- new Instance(truncated.getTimeInMillis, toOpt)
- }
- }
-
- object Builder {
- def newCalendar: Calendar = {
- val cal = Calendar.getInstance(DateInterval.UTC)
- cal.clear()
- cal.setLenient(false)
- /*
- * Configure the calendar for ISO 8601 standard compatible settings:
- * http://docs.oracle.com/javase/7/docs/api/java/util/GregorianCalendar.html#week_and_year
- */
- cal.setFirstDayOfWeek(Week.Monday.id)
- cal.setMinimalDaysInFirstWeek(4)
- cal.setTimeZone(DateInterval.UTC)
- cal
- }
- }
-}
-
-object Day extends DateIntervalType(Calendar.DAY_OF_MONTH, "yyyy-MM-dd") {
- def apply(year: Int, month: Int, day: Int): DateInterval =
- newBuilder.set(year, month, day).build
-}
-
-/**
- * ISO 8601 week. Note that it has some counterintuitive behavior around new year.
- * For instance Monday 29 December 2008 is week 2009-W01, and Sunday 3 January 2010 is week 2009-W53-7
- * This example was taken from from http://en.wikipedia.org/wiki/ISO_8601#Week_dates:
- * {{{
- * scala> Week(Day(2008, 12, 29))
- * res1: DateInterval = 2009-W01
- * scala> Week(Day(2010, 1, 3))
- * res2: DateInterval = 2009-W53
- * scala> Week(2009, 53, dayOfWeek = Week.Sunday).by(Day).last
- * res3: DateInterval = 2010-01-03
- * }}}
- */
-object Week extends DateIntervalType(Calendar.WEEK_OF_YEAR, "YYYY-'W'ww") {
- sealed trait WeekDay {
- def id: Int
- }
- case object Monday extends WeekDay { val id = Calendar.MONDAY }
- case object Tuesday extends WeekDay { val id = Calendar.TUESDAY }
- case object Wednesday extends WeekDay { val id = Calendar.WEDNESDAY }
- case object Thursday extends WeekDay { val id = Calendar.THURSDAY }
- case object Friday extends WeekDay { val id = Calendar.FRIDAY }
- case object Saturday extends WeekDay { val id = Calendar.SATURDAY }
- case object Sunday extends WeekDay { val id = Calendar.SUNDAY }
-
- def apply(year: Int, week: Int, dayOfWeek: WeekDay = Monday): DateInterval = {
- require(1 <= week && week <= 53, "week must be between 1-53")
- newBuilder.update(_.setWeekDate(year, week, dayOfWeek.id)).build
- }
-}
-
-object Month extends DateIntervalType(Calendar.MONTH, "yyyy-MM") {
- def apply(year: Int, month: Int): DateInterval = newBuilder.set(year, month).build
-}
-
-sealed abstract class Quarter(val month: Int)
-
-/**
- * Quarters of the year.
- *
- * {{{
- * scala> Quarter(2017, Quarter.Q1)
- * res1: DateInterval = 2017-Q1
- * scala> Year(2017).by(Quarter).toList
- * res2: List[DateInterval] = List(2017-Q1, 2017-Q2, 2017-Q3, 2017-Q4)
- * scala> Quarter(2017, Quarter.Q1).by(Month).toList
- * res3: List[DateInterval] = List(2017-01, 2017-02, 2017-03)
- * scala> Quarter.parse("2008-Q4")
- * res4: Option[DateInterval] = Some(2008-Q4)
- * scala> Quarter(2017, Quarter.Q2).format("yyyy-MM-dd")
- * res5: String = 2017-04-01
- * }}}
- */
-object Quarter extends DateIntervalType(Calendar.MONTH, "yyyy-MMM") {
- case object Q1 extends Quarter(month = 1)
- case object Q2 extends Quarter(month = 4)
- case object Q3 extends Quarter(month = 7)
- case object Q4 extends Quarter(month = 10)
-
- private val MonthSymbols = Array(Q1, Q2, Q3, Q4).flatMap(q => Array.fill(3)(q.toString))
- private def dateFormatSymbols = new java.text.DateFormatSymbols() {
- setMonths(MonthSymbols)
- setShortMonths(MonthSymbols)
- }
-
- override private[amadou] def defaultFormatter: SimpleDateFormat = {
- val format = super.formatter(dateFormat)
- format.setDateFormatSymbols(dateFormatSymbols)
- format
- }
-
- def apply(year: Int, quarter: Quarter): DateInterval =
- newBuilder.set(year, quarter.month).build
-}
-
-object Year extends DateIntervalType(Calendar.YEAR, "yyyy") {
- def apply(year: Int): DateInterval = newBuilder.set(year).build
-}
diff --git a/core/src/main/scala/com.mediative.amadou/HdfsUrl.scala b/core/src/main/scala/com.mediative.amadou/HdfsUrl.scala
deleted file mode 100644
index 3bc11f6..0000000
--- a/core/src/main/scala/com.mediative.amadou/HdfsUrl.scala
+++ /dev/null
@@ -1,59 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-
-import org.apache.hadoop.fs.{Path, FSDataOutputStream}
-import org.apache.spark.sql.SparkSession
-
-/**
- * Utility class for working with HDFS URLs.
- *
- * It allows to customize how dates are formatted and then
- * {{{
- * scala> HdfsUrl("some/path") / "somewhere" / Day(2016, 8, 28)
- * res1: HdfsUrl = some/path/somewhere/2016-08-28
- * scala> HdfsUrl("root", dateFormat = Some("'year='yyyy/'month'=MM")) / Day(2016, 8, 28)
- * res2: HdfsUrl = root/year=2016/month=08
- * }}}
- */
-case class HdfsUrl(url: String, dateFormat: Option[String] = None) {
- def path = new Path(url)
-
- def /(subPath: String): HdfsUrl =
- copy(url = new Path(path, subPath).toString)
-
- def /(date: DateInterval): HdfsUrl = {
- val datePath = dateFormat.fold(date.toString)(date.format)
- this./(datePath)
- }
-
- def exists(spark: SparkSession) = fileSystem(spark).exists(path)
-
- def open[T](spark: SparkSession)(f: FSDataOutputStream => T): T = {
- val stream = fileSystem(spark).create(path)
- try {
- f(stream)
- } finally {
- stream.close()
- }
- }
-
- def fileSystem(spark: SparkSession) =
- path.getFileSystem(spark.sparkContext.hadoopConfiguration)
-
- override def toString = path.toString
-}
diff --git a/core/src/main/scala/com.mediative.amadou/Logging.scala b/core/src/main/scala/com.mediative.amadou/Logging.scala
deleted file mode 100644
index 98ca639..0000000
--- a/core/src/main/scala/com.mediative.amadou/Logging.scala
+++ /dev/null
@@ -1,21 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-
-import com.typesafe.scalalogging.LazyLogging
-
-trait Logging extends LazyLogging
diff --git a/core/src/main/scala/com.mediative.amadou/ManagedIO.scala b/core/src/main/scala/com.mediative.amadou/ManagedIO.scala
deleted file mode 100644
index 404a6ca..0000000
--- a/core/src/main/scala/com.mediative.amadou/ManagedIO.scala
+++ /dev/null
@@ -1,41 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-
-import scala.util.Try
-
-/**
- * Manage auto closeable resources.
- */
-case class ManagedIO[T <: AutoCloseable](t: Try[T]) {
- def flatMap[U <: AutoCloseable](f: T => ManagedIO[U]): ManagedIO[U] = run(f)
- def map[U](f: T => U): U = run(f)
- def foreach(f: T => Unit): Unit = run(f)
-
- private def run[U](f: T => U): U = {
- val result = t.flatMap(v => Try(f(v)))
- val close = t.flatMap(v => Try(v.close))
- if (result.isSuccess)
- close.get
- result.get
- }
-}
-
-object ManagedIO {
- def apply[T <: AutoCloseable](open: => T): ManagedIO[T] =
- ManagedIO(Try(open))
-}
diff --git a/core/src/main/scala/com.mediative.amadou/Schedule.scala b/core/src/main/scala/com.mediative.amadou/Schedule.scala
deleted file mode 100644
index 6685f9f..0000000
--- a/core/src/main/scala/com.mediative.amadou/Schedule.scala
+++ /dev/null
@@ -1,91 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-
-/**
- * Mixin providing a DSL for defining schedules.
- *
- * If for example, we want to run a report against a cumulative data source
- * each day and must ensure that it runs the first of every month to generate
- * a report for all of the previous month. This schedule can be defined as:
- *
- * {{{
- * val schedule = today and monthly
- * }}}
- *
- * If we are only interested in "backfilling" jobs from a specific date use
- * a `where` clause, e.g.:
- *
- * {{{
- * val schedule = daily where (_ >= Date(2016, 4, 12)
- * }}}
- */
-trait ScheduleDsl {
- def today = Schedule(Day.today)
- def daily = Schedule.iterate(Day.today)
- def monthly = Schedule.iterate(Month.today)
- def quarterly = Schedule.iterate(Quarter.today)
- def yearly = Schedule.iterate(Year.today)
-}
-
-/**
- * A schedule is a sequence of monotonic decreasing dates. It can be
- * composed with other schedules to form more complex execution plans.
- *
- * Generating a list of days for a daily schedule:
- * {{{
- * scala> Schedule.iterate(Day(2016, 7, 2)).take(3).toList
- * res2: List[DateInterval] = List(2016-07-02, 2016-07-01, 2016-06-30)
- * }}}
- *
- * Generate a list of days for a monthly schedule:
- * {{{
- * scala> Schedule.iterate(Month(2016, 3)).where(Year(2016).<=).toList
- * res1: List[DateInterval] = List(2016-03, 2016-02, 2016-01)
- * }}}
- */
-case class Schedule(dates: Stream[DateInterval]) extends Traversable[DateInterval] {
- override final def foreach[U](f: DateInterval => U): Unit = {
- @scala.annotation.tailrec
- def ensureMonotonicDecreasingOrder(stream: Stream[DateInterval]): Unit =
- if (stream.nonEmpty) {
- val head = stream.head
- f(head)
- val tail = stream.tail.dropWhile(_ >= head)
- ensureMonotonicDecreasingOrder(tail)
- }
-
- ensureMonotonicDecreasingOrder(dates)
- }
-
- /**
- * Combine two date streams.
- */
- def and(that: Schedule): Schedule = Schedule(dates #::: that.dates)
-
- /**
- * Only includes dates newer than a given date.
- */
- def where(predicate: DateInterval => Boolean): Schedule = Schedule(dates.takeWhile(predicate))
-}
-
-object Schedule {
- val empty = Schedule(Stream.empty[DateInterval])
- def apply(date: DateInterval): Schedule = Schedule(Stream(date))
- def iterate(interval: DateInterval): Schedule =
- Schedule(Stream.iterate(interval)(_.prev))
-}
diff --git a/core/src/main/scala/com.mediative.amadou/Schema.scala b/core/src/main/scala/com.mediative.amadou/Schema.scala
deleted file mode 100644
index d8958bd..0000000
--- a/core/src/main/scala/com.mediative.amadou/Schema.scala
+++ /dev/null
@@ -1,28 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-
-import scala.reflect.runtime.universe.TypeTag
-import org.apache.spark.sql.{Encoder, Encoders}
-
-/**
- * Marker trait for case classes to automatically provide a Spark
- * encoder.
- */
-object Schema {
- implicit def encoder[T <: Product: TypeTag]: Encoder[T] = Encoders.product[T]
-}
diff --git a/core/src/main/scala/com.mediative.amadou/Slack.scala b/core/src/main/scala/com.mediative.amadou/Slack.scala
deleted file mode 100644
index ceb984b..0000000
--- a/core/src/main/scala/com.mediative.amadou/Slack.scala
+++ /dev/null
@@ -1,67 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-
-import org.apache.http.client.methods.HttpPost
-import org.apache.http.entity.{ContentType, StringEntity}
-import org.apache.http.impl.client.HttpClients
-import org.json4s.NoTypeHints
-import org.json4s.jackson.Serialization
-import org.json4s.jackson.Serialization.{write}
-
-object Slack {
- case class PostException(msg: String) extends RuntimeException(msg)
-
- case class Payload(
- channel: String,
- text: String,
- username: String,
- icon_emoji: String,
- link_names: Boolean)
-}
-
-/**
- * Wrap the functionality to send messages to a Slack channel.
- */
-case class Slack(url: String, channel: String, user: String, icon: String) extends Logging {
- import Slack._
-
- implicit val formats = Serialization.formats(NoTypeHints)
-
- /**
- * Post the given message to a Slack channel.
- *
- * @param message the text of the message to send.
- * @param icon optional icon for the message.
- */
- def post(message: String, icon: String = this.icon): Unit = {
- val payload = Payload(channel, message, user, icon, true)
- logger.info(s"Posting $payload to $url")
-
- val client = HttpClients.createDefault()
- val requestEntity = new StringEntity(write(payload), ContentType.APPLICATION_JSON)
- val postMethod = new HttpPost(url)
- postMethod.setEntity(requestEntity)
-
- val response = client.execute(postMethod)
- client.close()
- val status = response.getStatusLine
- if (status.getStatusCode != 200)
- throw PostException(
- s"$url replied with status ${status.getStatusCode}: ${status.getReasonPhrase}")
- }
-}
diff --git a/core/src/main/scala/com.mediative.amadou/SparkJob.scala b/core/src/main/scala/com.mediative.amadou/SparkJob.scala
deleted file mode 100644
index c739659..0000000
--- a/core/src/main/scala/com.mediative.amadou/SparkJob.scala
+++ /dev/null
@@ -1,46 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-
-import org.apache.spark.sql._
-
-object SparkJob {
-
- /**
- * Maximum number of dates considered from a schedule.
- */
- val MaxScheduledDates = 60
-}
-
-/**
- * A Spark ETL job
- *
- * Jobs have a schedule of dates which is filtered using job specific
- * logic and run in chronological order. For example, for jobs which run
- * each day and at end of month, we check if it ran correctly "today"
- * and if not we traverse if it ran for previous "month's end" etc.,
- * until we find a completed run or we have traversed some magical max
- * number.
- *
- * The schedule can be overridden by defining the `start` environment
- * variable with a date formatted as "yyyy-MM-dd". In this case the job
- * is only run the the specified date.
- */
-trait SparkJob extends Logging {
- def shouldRunForDate(spark: SparkSession, date: DateInterval): Boolean
- def stages: Stage[SparkSession, _]
-}
diff --git a/core/src/main/scala/com.mediative.amadou/SparkRunner.scala b/core/src/main/scala/com.mediative.amadou/SparkRunner.scala
deleted file mode 100644
index 95a3d92..0000000
--- a/core/src/main/scala/com.mediative.amadou/SparkRunner.scala
+++ /dev/null
@@ -1,217 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-
-import scala.collection.JavaConversions._
-import scala.concurrent.duration._
-import scala.util.{Failure, Success, Try}
-import com.typesafe.config._
-import org.apache.spark.SparkConf
-import org.apache.spark.sql.SparkSession
-import org.apache.spark.scheduler.{SparkListener, SparkListenerTaskEnd}
-import com.amazonaws.auth.profile.ProfilesConfigFile
-import io.prometheus.client._
-
-import monitoring.MessagingSystem
-
-case class RetryOptions(delay: FiniteDuration, max: Int)
-
-abstract class SparkRunner[Job <: SparkJob] extends Logging with ScheduleDsl with ConfigLoader {
- def jobName: String
- def schedule: Schedule
- def createJob(config: Config): Job
- def recordsProcessed: Collector = sparkRecordsRead
-
- def main(args: Array[String]): Unit =
- Try(run) match {
- case Failure(failure) =>
- // Manual print error to not depend on any logger
- System.err.println("Spark job failed")
- failure.printStackTrace(System.err)
- System.exit(1)
- case _ =>
- System.exit(0)
- }
-
- def run(): Unit = {
- val config =
- sys.env
- .get("DEPLOY_ENVIRONMENT")
- .fold(ConfigFactory.empty) { env =>
- ConfigFactory.defaultOverrides().withFallback(ConfigFactory.load(env))
- }
- .withFallback(ConfigFactory.load())
-
- val messaging = MessagingSystem.create(config)
- val retryOptions = config.as[RetryOptions]("retry")
-
- val singleDate = sys.env.get("start").flatMap(Day.parse)
- val job = createJob(config)
- val sparkConfig = new SparkConf().setAppName(jobName)
-
- for {
- setting <- config.entrySet.toSeq
- if setting.getKey.startsWith("spark.")
- // `.getString` does not support LIST types
- if setting.getValue.valueType != ConfigValueType.LIST
- // Ensure the key path is unquoted
- key = ConfigUtil.splitPath(setting.getKey).mkString(".")
- } yield sparkConfig.setIfMissing(key, config.getString(setting.getKey))
-
- val spark = SparkSession.builder
- .config(sparkConfig)
- .getOrCreate()
-
- /*
- * XXX: Add S3 credentials after creating the Spark session so they are
- * not logged.
- */
- sys.env.get("AWS_CREDENTIALS").foreach { file =>
- val creds = new ProfilesConfigFile(file).getCredentials("default")
- spark.sparkContext.hadoopConfiguration.set("fs.s3a.access.key", creds.getAWSAccessKeyId)
- spark.sparkContext.hadoopConfiguration.set("fs.s3a.secret.key", creds.getAWSSecretKey)
- }
-
- spark.sparkContext.addSparkListener(sparkListener)
-
- val shouldRunForDate: DateInterval => Boolean = singleDate match {
- case Some(date) => date.<=
- case None => job.shouldRunForDate(spark, _)
- }
-
- val dates = schedule
- .take(SparkJob.MaxScheduledDates)
- .takeWhile(shouldRunForDate)
- .toList
- .reverse
-
- logger.info(s"Scheduled dates are: $dates")
- dates.foreach { date =>
- val ctx = new Context(jobName, date, job, retryOptions, spark, messaging, spark)
-
- messaging.publishProcessStarting(ctx)
- job.stages.run(ctx)
- messaging.publishProcessComplete(ctx)
- }
-
- messaging.stop()
- spark.stop()
- }
-
- class Context[+I](
- val jobId: String,
- val eventDate: DateInterval,
- job: Job,
- retryOptions: RetryOptions,
- spark: SparkSession,
- messaging: MessagingSystem,
- value: I)
- extends Stage.Context(spark, eventDate, value)
- with MessagingSystem.Context {
-
- override def withValue[U](value: U) =
- new Context(jobId, eventDate, job, retryOptions, spark, messaging, value)
-
- override def run[T](stage: Stage[I, T], result: => T): Stage.Result[T] = {
- def runStage(callCount: Int): Stage.Result[T] = {
- val stageId = s"$jobName/$eventDate/$processId/${stage.name}"
- logger.info(s"[$stageId] Running stage ${stage.name} try #$callCount")
- counters.foreach(_.clear())
- messaging.publishStageStarting(this, stage.name)
- Try(result) match {
- case v @ Success(_) =>
- messaging.publishStageComplete(this, stage.name)
- messaging.publishMetrics(this, stage.name, collectMetrics())
- v
- case Failure(failure) =>
- if (callCount >= retryOptions.max) {
- logger.error(s"[$stageId] Giving up after ${retryOptions.max} retries", failure)
- messaging.publishStageFailed(this, stage.name, failure)
- messaging.publishProcessFailed(this, failure)
- throw failure
- } else {
- logger.error(
- s"[$stageId] Will retry stage ${stage.name} in ${retryOptions.delay}",
- failure)
- messaging.publishStageRetrying(this, stage.name)
- Thread.sleep(retryOptions.delay.toMillis)
- runStage(callCount + 1)
- }
- }
- }
-
- runStage(1)
- }
- }
-
- /*
- * Metrics management
- */
-
- private val counters = scala.collection.mutable.ArrayBuffer[Counter]()
-
- /**
- * Counters will be reset before each job run.
- */
- protected def counter(name: String, help: String, labels: String*): Counter = {
- val collector = Counter.build().name(name).labelNames(labels: _*).help(help).register()
- counters += collector
- collector
- }
-
- protected def gauge(name: String, help: String, labels: String*): Gauge =
- Gauge.build().name(name).labelNames(labels: _*).help(help).register()
-
- private def collectMetrics(): Map[String, Double] = {
- def labeledSamples(sample: Collector.MetricFamilySamples.Sample) =
- for {
- (label, labelValue) <- sample.labelNames.toSeq.zip(sample.labelValues.toSeq)
- value <- Try(labelValue.toDouble).toOption
- } yield s"${sample.name}_$label" -> value
-
- val metrics = for {
- family <- CollectorRegistry.defaultRegistry.metricFamilySamples()
- sample <- family.samples
- metric <- labeledSamples(sample) :+ (sample.name -> sample.value)
- } yield metric
-
- val recordsProcessedMetrics = for {
- family <- recordsProcessed.collect
- sample <- family.samples
- } yield ("recordsProcessed" -> sample.value)
-
- metrics.toMap ++ recordsProcessedMetrics.headOption
- }
-
- hotspot.DefaultExports.initialize()
-
- private lazy val sparkBytesRead = counter("spark_bytes_read", "Number of bytes read.")
- private lazy val sparkRecordsRead = counter("spark_records_read", "Number of records read.")
- private lazy val sparkRecordsWritten =
- counter("spark_records_written", "Number of records written.")
-
- private def sparkListener() =
- new SparkListener() {
- override def onTaskEnd(taskEnd: SparkListenerTaskEnd): Unit = {
- sparkBytesRead.inc(taskEnd.taskMetrics.inputMetrics.bytesRead)
- sparkRecordsRead.inc(taskEnd.taskMetrics.inputMetrics.recordsRead)
- // FIXME: This seems to always be 0L. Look into using information from
- // `taskEnd.taskInfo.accumulables` and/or `taskEnd.taskMetrics.shuffleWriteMetrics.recordsWritten`
- sparkRecordsWritten.inc(taskEnd.taskMetrics.outputMetrics.recordsWritten)
- }
- }
-}
diff --git a/core/src/main/scala/com.mediative.amadou/Stage.scala b/core/src/main/scala/com.mediative.amadou/Stage.scala
deleted file mode 100644
index 989ac36..0000000
--- a/core/src/main/scala/com.mediative.amadou/Stage.scala
+++ /dev/null
@@ -1,139 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-
-import org.apache.spark.sql._
-import scala.util.{Failure, Success, Try}
-
-sealed trait Stage[-I, +T] { self =>
- def name: String
-
- def map[U](f: T => U): Stage[I, U] = new Stage[I, U] {
- override def name = self.name
- override def run(ctx: Stage.Context[I]): Stage.Result[U] = self.run(ctx).map(f)
- }
-
- def flatMap[U](f: T => Stage[T, U]): Stage[I, U] = new Stage[I, U] {
- override def name = self.name
- override def run(ctx: Stage.Context[I]): Stage.Result[U] =
- self.run(ctx).flatMap(data => f(data).run(ctx.withValue(data)))
- }
-
- def andThen[U](s: Stage[T, U]): Stage[I, U] = flatMap(_ => s)
- def ~>[U](s: Stage[T, U]): Stage[I, U] = andThen(s)
-
- def run(ctx: Stage.Context[I]): Stage.Result[T]
-}
-
-object Stage {
- type Result[A] = Try[A]
-
- abstract class Context[+I](val spark: SparkSession, val date: DateInterval, val value: I) {
- def withValue[U](value: U): Context[U]
- def run[T](stage: Stage[I, T], result: => T): Result[T] = Try(result)
- }
-
- object Context {
- def apply(spark: SparkSession, date: DateInterval): Context[SparkSession] =
- new SimpleContext(spark, date, spark)
- }
-
- class SimpleContext[+I](spark: SparkSession, date: DateInterval, value: I)
- extends Context[I](spark, date, value) {
- override def withValue[U](value: U) = new SimpleContext(spark, date, value)
- }
-
- def apply[S, T](stageName: String)(f: Stage.Context[S] => T): Stage[S, T] = new Stage[S, T] {
- override def name = stageName
- override def run(ctx: Stage.Context[S]) = ctx.run(this, f(ctx))
- }
-
- /**
- * Read data from a data source.
- *
- * May be used anywhere in a for-expression to read from a data source.
- */
- def source[T](name: String)(read: Stage.Context[SparkSession] => Dataset[T]) =
- Stage(name) { ctx: Stage.Context[_] =>
- read(ctx.withValue(ctx.spark))
- }
-
- def transform[S, T](name: String)(transform: Stage.Context[Dataset[S]] => Dataset[T]) =
- Stage(name)(transform)
-
- def sink[T](name: String)(write: Stage.Context[Dataset[T]] => Unit) =
- Stage(name)((ctx: Stage.Context[Dataset[T]]) => { write(ctx); ctx.value })
-
- def sequence[S, T](stages: Seq[Stage[S, T]]): Stage[S, Seq[T]] = new Stage[S, Seq[T]] {
- override def name = "sequence"
- override def run(ctx: Stage.Context[S]): Stage.Result[Seq[T]] = {
- @scala.annotation.tailrec
- def iterate(stages: Seq[Stage[S, T]], results: Seq[T]): Stage.Result[Seq[T]] =
- stages match {
- case Seq() => Success(results)
- case Seq(stage, rest @ _*) =>
- stage.run(ctx) match {
- case Success(result) => iterate(rest, results :+ result)
- case Failure(exception) => Failure(exception)
- }
- }
-
- iterate(stages, Seq.empty)
- }
- }
-
- case class SequenceAllException[S, T](failures: Seq[(Stage[S, T], Throwable)]) extends Exception {
- override def getMessage =
- failures
- .map {
- case (stage, failure) =>
- s"${stage.name} failed: (${failure.getClass.getName}) ${failure.getMessage}"
- }
- .mkString(s"${failures.size} stage(s) failed:\n - ", "\n - ", "")
- }
-
- /**
- * Combine multiple stages into a single stage which fails if any of them results
- * in a failure.
- */
- def sequenceAll[S, T](stages: Seq[Stage[S, T]]): Stage[S, Seq[T]] = new Stage[S, Seq[T]] {
- override def name = "sequenceAll"
- override def run(ctx: Stage.Context[S]): Stage.Result[Seq[T]] = {
- val results: Seq[(Stage[S, T], Stage.Result[T])] =
- stages.map(stage => stage -> stage.run(ctx))
- results.filter(_._2.isFailure) match {
- case Seq() => Success(results.map(_._2.get))
- case failures =>
- Failure(SequenceAllException(failures.map {
- case (stage, result) => stage -> result.failed.get
- }))
- }
- }
- }
-
- def identity[T] = new Stage[T, T] { self =>
- override def name = "identity"
-
- override def flatMap[U](f: T => Stage[T, U]): Stage[T, U] = new Stage[T, U] {
- override def name = self.name
- override def run(ctx: Stage.Context[T]): Stage.Result[U] =
- Try(f(ctx.value)).flatMap(stage => stage.run(ctx))
- }
-
- override def run(ctx: Stage.Context[T]) = ctx.run(this, ctx.value)
- }
-}
diff --git a/core/src/main/scala/com.mediative.amadou/monitoring/Events.scala b/core/src/main/scala/com.mediative.amadou/monitoring/Events.scala
deleted file mode 100644
index b8dced3..0000000
--- a/core/src/main/scala/com.mediative.amadou/monitoring/Events.scala
+++ /dev/null
@@ -1,55 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-package monitoring
-
-/**
- * Process and stage states registry.
- */
-sealed trait StateRecord {
- def identifier = toString
-}
-
-case object Processing extends StateRecord
-case object Retrying extends StateRecord
-case object Failed extends StateRecord
-case object Complete extends StateRecord
-
-case class MetricsEvent(
- jobId: String,
- processId: String,
- stage: String,
- timestamp: Long,
- message: Map[String, Double])
-
-case class RunEvent(
- jobId: String,
- processId: String,
- state: String,
- processingDate: String,
- timestamp: Long,
- duration: Long,
- message: String)
-
-case class StageEvent(
- jobId: String,
- processId: String,
- stage: String,
- state: String,
- timestamp: Long,
- duration: Long,
- message: String)
diff --git a/core/src/main/scala/com.mediative.amadou/monitoring/KafkaMessagingSystem.scala b/core/src/main/scala/com.mediative.amadou/monitoring/KafkaMessagingSystem.scala
deleted file mode 100644
index d51cd79..0000000
--- a/core/src/main/scala/com.mediative.amadou/monitoring/KafkaMessagingSystem.scala
+++ /dev/null
@@ -1,66 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-package monitoring
-
-import java.util.Properties
-import com.typesafe.config.Config
-import org.apache.kafka.clients.producer.{Callback, KafkaProducer, ProducerRecord, RecordMetadata}
-
-class KafkaMessagingSystem(config: Config) extends MessagingSystem with Logging {
- private val properties = KafkaMessagingSystem.readProperties(config)
- private val producer = new KafkaProducer[String, String](properties)
- private val topicPrefix = properties.getProperty("topic.prefix")
-
- override def publish(topic: String, message: String): Unit = {
- val topicName = s"$topicPrefix-$topic"
-
- logger.info(s"Publishing to $topicName :\n$message\n")
-
- producer.send(new ProducerRecord[String, String](topicName, message), new Callback {
- override def onCompletion(metadata: RecordMetadata, exception: Exception): Unit =
- if (exception != null) {
- logger
- .error(s"Cannot publish to $topicName. Caused by: ${exception.getMessage}", exception)
- }
- })
- ()
- }
-
- override def stop(): Unit =
- producer.close()
-}
-
-object KafkaMessagingSystem {
- def readProperties(config: Config): Properties = {
- val propertiesKeys = Seq(
- "bootstrap.servers",
- "acks",
- "retries",
- "batch.size",
- "linger.ms",
- "buffer.memory",
- "key.serializer",
- "value.serializer",
- "topic.prefix")
-
- val properties = new Properties()
- propertiesKeys.foreach(key => properties.setProperty(key, config.getString(key)))
-
- properties
- }
-}
diff --git a/core/src/main/scala/com.mediative.amadou/monitoring/MessagingSystem.scala b/core/src/main/scala/com.mediative.amadou/monitoring/MessagingSystem.scala
deleted file mode 100644
index 3557c7e..0000000
--- a/core/src/main/scala/com.mediative.amadou/monitoring/MessagingSystem.scala
+++ /dev/null
@@ -1,121 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-package monitoring
-
-import com.typesafe.config.Config
-import scala.language.implicitConversions
-
-object MessagingSystem {
- def create(config: Config) = config.hasPath("kafka.bootstrap.servers") match {
- case true => new KafkaMessagingSystem(config.getConfig("kafka"))
- case false => new PrintMessagingSystem
- }
-
- trait Context {
- def jobId: String
- def eventDate: DateInterval
- def processId: String = java.util.UUID.randomUUID().toString
- def startTime: Long = System.currentTimeMillis
- def duration: Long = System.currentTimeMillis - startTime
- }
-}
-
-abstract class MessagingSystem {
- import MessagingSystem.Context
-
- def publish(topic: String, message: String): Unit
- def stop(): Unit = ()
-
- // high level helper functions
- def publishProcessStarting(context: Context): Unit =
- publishRunEvent(context, state = Processing)
-
- def publishProcessComplete(context: Context): Unit =
- publishRunEvent(context, state = Complete)
-
- def publishProcessFailed(context: Context, failure: Throwable): Unit =
- publishRunEvent(context, state = Failed, message = failureToMessage(failure))
-
- def publishStageStarting(context: Context, stage: String, message: String = ""): Unit =
- publishStageEvent(context, state = Processing, stage = stage, message = message)
-
- def publishStageComplete(context: Context, stage: String, message: String = ""): Unit =
- publishStageEvent(context, state = Complete, stage = stage, message = message)
-
- def publishStageRetrying(context: Context, stage: String): Unit =
- publishStageEvent(context, state = Retrying, stage = stage)
-
- def publishStageFailed(context: Context, stage: String, failure: Throwable): Unit =
- publishStageEvent(context, state = Failed, stage = stage, message = failureToMessage(failure))
-
- def publishMetrics(context: Context, stage: String, metrics: Map[String, Double]): Unit =
- publish(
- "metrics",
- MetricsEvent(
- jobId = context.jobId,
- processId = context.processId,
- timestamp = System.currentTimeMillis(),
- stage = stage,
- message = metrics
- ))
-
- private def publishRunEvent(context: Context, state: StateRecord, message: String = "") =
- publish(
- "jobs",
- RunEvent(
- jobId = context.jobId,
- processId = context.processId,
- timestamp = System.currentTimeMillis(),
- processingDate = context.eventDate.format("yyyy-MM-dd"),
- state = state.identifier,
- duration = state match {
- case Complete => context.duration
- case _ => 0L
- },
- message = message
- ))
-
- private def publishStageEvent(
- context: Context,
- state: StateRecord,
- stage: String,
- message: String = ""): Unit =
- publish(
- "stages",
- StageEvent(
- jobId = context.jobId,
- processId = context.processId,
- timestamp = System.currentTimeMillis(),
- stage = stage,
- state = state.identifier,
- duration = state match {
- case Complete => context.duration
- case _ => 0L
- },
- message = message
- ))
-
- private implicit def processMessageToString(message: RunEvent): String =
- upickle.default.write(message)
- private implicit def stageMessageToString(message: StageEvent): String =
- upickle.default.write(message)
- private implicit def metricsMessageToString(message: MetricsEvent): String =
- upickle.default.write(message)
- private def failureToMessage(failure: Throwable) =
- s"${failure.getClass.getName}: ${failure.getMessage}"
-}
diff --git a/core/src/main/scala/com.mediative.amadou/monitoring/PrintMessagingSystem.scala b/core/src/main/scala/com.mediative.amadou/monitoring/PrintMessagingSystem.scala
deleted file mode 100644
index 19326f8..0000000
--- a/core/src/main/scala/com.mediative.amadou/monitoring/PrintMessagingSystem.scala
+++ /dev/null
@@ -1,23 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-package monitoring
-
-class PrintMessagingSystem extends MessagingSystem with Logging {
- override def publish(topic: String, message: String): Unit =
- logger.info(s"Publishing to $topic: $message")
-}
diff --git a/core/src/main/scala/com.mediative.amadou/package.scala b/core/src/main/scala/com.mediative.amadou/package.scala
deleted file mode 100644
index 00d9784..0000000
--- a/core/src/main/scala/com.mediative.amadou/package.scala
+++ /dev/null
@@ -1,81 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative
-
-import org.apache.spark.sql._
-
-package object amadou {
- type Config = com.typesafe.config.Config
- type Gauge = io.prometheus.client.Gauge
- type Counter = io.prometheus.client.Counter
-
- implicit class SparkHdfsUrlReaderOps(val self: DataFrameReader) extends AnyVal {
- def csv(url: HdfsUrl*) = self.csv(url.map(_.toString): _*)
- def json(url: HdfsUrl*) = self.json(url.map(_.toString): _*)
- def load(url: HdfsUrl*) = self.load(url.map(_.toString): _*)
- def orc(url: HdfsUrl*) = self.orc(url.map(_.toString): _*)
- def parquet(url: HdfsUrl*) = self.parquet(url.map(_.toString): _*)
- def text(url: HdfsUrl*) = self.text(url.map(_.toString): _*)
- def textFile(url: HdfsUrl*) = self.textFile(url.map(_.toString): _*)
- }
-
- implicit class SparkHdfsUrlWriteOps[T](val self: DataFrameWriter[T]) extends AnyVal {
- def csv(url: HdfsUrl) = self.csv(url.toString)
- def json(url: HdfsUrl) = self.json(url.toString)
- def save(url: HdfsUrl) = self.save(url.toString)
- def orc(url: HdfsUrl) = self.orc(url.toString)
- def parquet(url: HdfsUrl) = self.parquet(url.toString)
- def text(url: HdfsUrl) = self.text(url.toString)
- }
-
- implicit class SymbolToStage(val self: Symbol) extends AnyVal {
- def stage[I, T](f: Stage.Context[I] => T) = Stage(self.name)(f)
- def source[T](read: Stage.Context[SparkSession] => Dataset[T]) = Stage.source(self.name)(read)
- def transform[S, T](transform: Stage.Context[Dataset[S]] => Dataset[T]) =
- Stage.transform(self.name)(transform)
- def sink[T](write: Stage.Context[Dataset[T]] => Unit) = Stage.sink(self.name)(write)
- }
-
- /**
- * Helpers for working with Dataset columns.
- */
- implicit class SparkColumnOps(val self: Column) extends AnyVal {
- import org.apache.spark.sql.functions.when
-
- /**
- * Filter out values which are null, empty or "null".
- *
- * @example
- * {{{
- * dataset.filter($"UserId".isDefined)
- * }}}
- */
- def isDefined: Column =
- self.isNotNull && !(self === "") && !(self === "null")
-
- /**
- * Replace "null" string with NULL value.
- *
- * @example
- * {{{
- * dataset.select($"Description".nullify as "description")
- * }}}
- */
- def nullify: Column =
- when(self === "null", null).otherwise(self)
- }
-}
diff --git a/core/src/test/resources/application.conf b/core/src/test/resources/application.conf
deleted file mode 100644
index 8231c6b..0000000
--- a/core/src/test/resources/application.conf
+++ /dev/null
@@ -1,20 +0,0 @@
-hdfs {
- root = target/hdfs-root
-
- raw {
- url = ${hdfs.root}/data
- dateFormat = "yyyy/MM/dd"
- }
-
- clean {
- url = ${hdfs.root}/etl
- dateFormat = "'date='yyyy-MM-dd"
- }
-}
-
-retry.max = 1
-
-test_etl {
- url = src/test/resources/hdfs/test_etl
- dateFormat = "'year='yyyy'/month='MM"
-}
diff --git a/core/src/test/resources/config-reader-spec.properties b/core/src/test/resources/config-reader-spec.properties
deleted file mode 100644
index ea07941..0000000
--- a/core/src/test/resources/config-reader-spec.properties
+++ /dev/null
@@ -1,2 +0,0 @@
-user = john
-pass = secret
diff --git a/core/src/test/resources/hdfs/quotes.txt b/core/src/test/resources/hdfs/quotes.txt
deleted file mode 100644
index 084e60a..0000000
--- a/core/src/test/resources/hdfs/quotes.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-Jeg taler helst med Børn; thi om dem tør man dog haabe, at de kan blive Fornuft-Væsener; men de, der ere blevne det! Herre Jemini!
-Livet må forstås baglæns, men må leves forlæns.
-Hvad er det Umagen værd at erindre det Forbigangne, der ikke kan blive et Nærværende
-Nu skal man til Australien nu til Maanen, nu ned i en Hule under Jorden, nu Fanden i Vold i Røven - efter en Indvoldsorm; nu skal Teleskopet bruges, nu Mikroskopet: hvo Satan kan holde det ud!
-Folk forstaae mig saa lidt, at de ikke engang forstaae mine Klager over, at de ikke forstaae mig.
diff --git a/core/src/test/resources/hdfs/test_etl/year=2017/month=02/data.csv b/core/src/test/resources/hdfs/test_etl/year=2017/month=02/data.csv
deleted file mode 100644
index 4db0c79..0000000
--- a/core/src/test/resources/hdfs/test_etl/year=2017/month=02/data.csv
+++ /dev/null
@@ -1,4 +0,0 @@
-Object Name,Object Colour,Observed Time,Observed Latitude,Observed Longitude,Speed
-Bus,Yellow,2015-09-12,42.4,51.2,0
-Car,Pink,2016-03-04,11.3,23.0,30
-Truck,Orange,2017-01-30,12.4,56.7,89
diff --git a/core/src/test/scala/com.mediative.amadou/ConfigLoaderSpec.scala b/core/src/test/scala/com.mediative.amadou/ConfigLoaderSpec.scala
deleted file mode 100644
index f7f4a0d..0000000
--- a/core/src/test/scala/com.mediative.amadou/ConfigLoaderSpec.scala
+++ /dev/null
@@ -1,67 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-
-import org.scalatest.{WordSpec, Matchers}
-import com.typesafe.config.ConfigFactory
-import java.util.Properties
-
-object ConfigLoaderSpec {
- case class Database(url: String, properties: Properties)
-}
-
-class ConfigLoaderSpec extends WordSpec with Matchers with ConfigLoader {
- import ConfigLoaderSpec.Database
-
- "propertiesValueReader" should {
- "load from given path" in {
- val config =
- ConfigFactory.parseString("""
- database {
- url = "jdbc:postgresql:testdb"
- properties = src/test/resources/config-reader-spec.properties
- }
- """)
- val db = config.as[Database]("database")
- db.properties.size should be(2)
- db.properties.getProperty("user") should be("john")
- db.properties.getProperty("pass") should be("secret")
- }
-
- "be empty when no path is given" in {
- val config = ConfigFactory.parseString("""
- database.url = "jdbc:postgresql:testdb"
- """)
- val db = config.as[Database]("database")
- db.properties.isEmpty should be(true)
- }
-
- "fail when given path does not exist" in {
- val config =
- ConfigFactory.parseString("""
- database {
- url = "jdbc:postgresql:testdb"
- properties = src/test/resources/doesn-not-exists.properties
- }
- """)
-
- the[java.io.FileNotFoundException] thrownBy {
- config.as[Database]("database")
- } should have message "src/test/resources/doesn-not-exists.properties (No such file or directory)"
- }
- }
-}
diff --git a/core/src/test/scala/com.mediative.amadou/DateIntervalSpec.scala b/core/src/test/scala/com.mediative.amadou/DateIntervalSpec.scala
deleted file mode 100644
index ac6a83f..0000000
--- a/core/src/test/scala/com.mediative.amadou/DateIntervalSpec.scala
+++ /dev/null
@@ -1,197 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-
-import org.scalatest._
-
-class DateIntervalSpec extends FreeSpec {
-
- "Day" - {
- "should print date" in {
- assert(Day(1999, 12, 31).toString == "1999-12-31")
- assert(Day(2016, 6, 5).toString == "2016-06-05")
- }
-
- "should parse date" in {
- val date = Day.parse("2016-06-05")
- assert(date == Some(Day(2016, 6, 5)))
- }
-
- "should have next/prev" in {
- val dt = Day(2016, 6, 5)
- assert(dt.prev < dt)
- assert(dt < dt.next)
- assert(dt.prev == Day(2016, 6, 4))
- assert(dt.next == Day(2016, 6, 6))
-
- val dt2 = Day(1999, 12, 31)
- assert(dt2.prev == Day(1999, 12, 30))
- assert(dt2.next == Day(2000, 1, 1))
- }
-
- "should have iterator for dates" in {
- val dt = Day(2016, 6, 5)
- assert(dt.by(Day).size == 1)
- }
- }
-
- "Week" - {
- "should print date" in {
- assert(Week(1999, 52).toString == "1999-W52")
- assert(Week(2016, 1).toString == "2016-W01")
- }
-
- "should parse date" in {
- assert(Week.parse("2016-W01") == Some(Week(2016, 1)))
- assert(Week.parse("1999-W51") == Some(Week(1999, 51)))
- }
-
- "should have next/prev" in {
- val dt = Week(2016, 6)
- assert(dt.prev < dt)
- assert(dt < dt.next)
- assert(dt.prev == Week(2016, 5))
- assert(dt.next == Week(2016, 7))
-
- val dt2 = Week(1999, 52)
- assert(dt2.prev == Week(1999, 51))
- assert(dt2.next == Week(2000, 1))
- }
-
- "should have iterator for dates" in {
- val dt = Week(2016, 6)
- assert(dt.by(Day).size == 7)
- }
- }
-
- "Month" - {
- "should print date" in {
- assert(Month(1999, 12).toString == "1999-12")
- assert(Month(2016, 6).toString == "2016-06")
- }
-
- "should parse date" in {
- val dt = Month.parse("2016-06")
- assert(dt == Some(Month(2016, 6)))
- }
-
- "should have next/prev" in {
- val dt = Month(2016, 6)
- assert(dt.prev < dt)
- assert(dt < dt.next)
- assert(dt.prev == Month(2016, 5))
- assert(dt.next == Month(2016, 7))
-
- val dt2 = Month(1999, 12)
- assert(dt2.prev == Month(1999, 11))
- assert(dt2.next == Month(2000, 1))
- }
-
- "should have iterator for dates" in {
- val dt = Month(2016, 6)
- assert(dt.by(Day).size == 30)
-
- val dt2 = Month(2016, 2)
- assert(dt2.by(Day).size == 29)
-
- val dt3 = Month(1999, 2)
- assert(dt3.by(Day).size == 28)
- }
- }
-
- "Quarter" - {
- "should truncate month" in {
- assert(Month(Quarter(2016, Quarter.Q1)) == Month(2016, 1))
- assert(Month(Quarter(2016, Quarter.Q2)) == Month(2016, 4))
- assert(Month(Quarter(2016, Quarter.Q3)) == Month(2016, 7))
- assert(Month(Quarter(2016, Quarter.Q4)) == Month(2016, 10))
-
- assert(Month(Quarter(Month(2016, 2))) == Month(2016, 1))
- assert(Month(Quarter(Month(2016, 3))) == Month(2016, 1))
- assert(Month(Quarter(Month(2016, 12))) == Month(2016, 10))
- }
-
- "should print date" in {
- assert(Quarter(1999, Quarter.Q1).toString == "1999-Q1")
- assert(Quarter(2016, Quarter.Q3).toString == "2016-Q3")
- }
-
- "should parse date" in {
- val dt = Quarter.parse("2016-Q4")
- assert(dt == Some(Quarter(2016, Quarter.Q4)))
- assert(Month(dt.get) == Month(2016, 10))
- }
-
- "should have next/prev" in {
- val dt = Quarter(2014, Quarter.Q1)
- assert(dt.prev < dt)
- assert(dt < dt.next)
- assert(dt.prev == Quarter(2013, Quarter.Q4))
- assert(dt.next == Quarter(2014, Quarter.Q2))
-
- val dt2 = Quarter(1999, Quarter.Q4)
- assert(dt2.prev == Quarter(1999, Quarter.Q3))
- assert(dt2.next == Quarter(2000, Quarter.Q1))
- }
-
- "should have iterator for dates" in {
- val dt = Quarter(2016, Quarter.Q1)
- assert(dt.by(Day).size == 91)
-
- val dt2 = Quarter(1999, Quarter.Q1)
- assert(dt2.by(Day).size == 90)
-
- val dt3 = Quarter(1999, Quarter.Q4)
- assert(dt3.by(Day).size == 92)
- }
- }
-
- "Year" - {
- "should print date" in {
- assert(Year(1999).toString == "1999")
- assert(Year(2016).toString == "2016")
- }
-
- "should parse date" in {
- val dt = Year.parse("2016")
- assert(dt == Some(Year(2016)))
- }
-
- "should have next/prev" in {
- val dt = Year(2016)
- assert(dt.prev < dt)
- assert(dt < dt.next)
- assert(dt.prev == Year(2015))
- assert(dt.next == Year(2017))
-
- val dt2 = Year(1999)
- assert(dt2.prev == Year(1998))
- assert(dt2.next == Year(2000))
- }
-
- "should have iterator for dates" in {
- val dt = Year(2016)
- assert(dt.by(Day).size == 366)
-
- val dt2 = Year(1999)
- assert(dt2.by(Day).size == 365)
-
- assert(Year(1999).by(Quarter).size == 4)
- }
- }
-
-}
diff --git a/core/src/test/scala/com.mediative.amadou/ImplicitsSpec.scala b/core/src/test/scala/com.mediative.amadou/ImplicitsSpec.scala
deleted file mode 100644
index a4fcfce..0000000
--- a/core/src/test/scala/com.mediative.amadou/ImplicitsSpec.scala
+++ /dev/null
@@ -1,85 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-
-import org.scalatest.{WordSpec, Matchers}
-
-object SparkImplicitsSpec {
- case class Account(id: Int, name: String, externalId: String)
-}
-
-class SparkImplicitsSpec extends WordSpec with Matchers with SparkJobSuiteBase {
- import SparkImplicitsSpec._
-
- "SparkColumnOps.isDefined" should {
- "filter values which are null, empty or the string 'null'" in {
- import spark.implicits._
-
- val accounts = List(
- Account(0, "Account #0", ""),
- Account(1, "Account #1", "00000000001"),
- Account(2, "Account #2", "null"),
- Account(3, "Account #3", "Not null"),
- Account(4, "Account #4", null),
- Account(5, "Account #5", "00000000002")
- )
- val data = spark.createDataset(accounts)
- data.count shouldBe 6
-
- val filtered = data.filter($"externalId".isDefined)
- filtered.collect.toList shouldBe List(
- Account(1, "Account #1", "00000000001"),
- Account(3, "Account #3", "Not null"),
- Account(5, "Account #5", "00000000002")
- )
- }
- }
-
- "SparkColumnOps.nullify" should {
- "turn 'null' string values into null" in {
- import spark.implicits._
-
- val accounts = List(
- Account(0, "Account #0", ""),
- Account(1, "Account #1", "00000000001"),
- Account(2, "Account #2", "null"),
- Account(3, "Account #3", "Not null"),
- Account(4, "Account #4", null),
- Account(5, "Account #5", "00000000002")
- )
- val data = spark.createDataset(accounts)
- data.count shouldBe 6
-
- val filtered = data
- .select(
- $"id",
- $"name".nullify as "name",
- $"externalId".nullify as "externalId"
- )
- .as[Account]
-
- filtered.collect.toList shouldBe List(
- Account(0, "Account #0", ""),
- Account(1, "Account #1", "00000000001"),
- Account(2, "Account #2", null),
- Account(3, "Account #3", "Not null"),
- Account(4, "Account #4", null),
- Account(5, "Account #5", "00000000002")
- )
- }
- }
-}
diff --git a/core/src/test/scala/com.mediative.amadou/ManagedIOSpec.scala b/core/src/test/scala/com.mediative.amadou/ManagedIOSpec.scala
deleted file mode 100644
index 3a5af49..0000000
--- a/core/src/test/scala/com.mediative.amadou/ManagedIOSpec.scala
+++ /dev/null
@@ -1,118 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-
-import org.scalatest.{WordSpec, Matchers}
-import java.io.IOException
-
-object ManagedIOSpec {
- class IO extends AutoCloseable {
- var closed = false
- def fail = throw new IOException("IO failed")
- override def close(): Unit =
- closed = true
- }
-
- object IO {
- def openFail(): IO =
- throw new IOException("IO open failed")
- }
-
- class IOWithFailingClose extends IO {
- override def close(): Unit = {
- closed = true
- throw new IOException("IO close failed")
- }
- }
-}
-
-class ManagedIOSpec extends WordSpec with Matchers {
- import ManagedIOSpec._
-
- "ManagedIO" should {
- "call close on happy path" in {
- val io0 = new IO
- val io1 = new IO
- for {
- x0 <- ManagedIO(io0)
- x1 <- ManagedIO(io1)
- } {
- x0.closed shouldBe false
- x1.closed shouldBe false
- ()
- }
-
- io0.closed shouldBe true
- io1.closed shouldBe true
- }
-
- "call close when open fails" in {
- val io0 = new IO
-
- the[IOException] thrownBy {
- for {
- x0 <- ManagedIO(io0)
- x1 <- ManagedIO(IO.openFail())
- } ()
- } should have message "IO open failed"
-
- io0.closed shouldBe true
- }
-
- "not call close for inner open calls" in {
- the[IOException] thrownBy {
- for {
- x0 <- ManagedIO(IO.openFail())
- } fail("Should not be called")
- } should have message "IO open failed"
- }
-
- "call close with nested failures" in {
- val io0 = new IO
- val io1 = new IO
-
- the[IOException] thrownBy {
- for {
- x0 <- ManagedIO(io0)
- x1 <- ManagedIO(io1)
- } {
- x1.fail
- }
- } should have message "IO failed"
-
- io0.closed shouldBe true
- io1.closed shouldBe true
- }
-
- "propagate close failures" in {
- val io0 = new IO
- val io1 = new IOWithFailingClose
-
- the[IOException] thrownBy {
- for {
- x0 <- ManagedIO(io0)
- x1 <- ManagedIO(io1)
- } {
- ()
- }
- } should have message "IO close failed"
-
- io0.closed shouldBe true
- io1.closed shouldBe true
- }
- }
-}
diff --git a/core/src/test/scala/com.mediative.amadou/StageSpec.scala b/core/src/test/scala/com.mediative.amadou/StageSpec.scala
deleted file mode 100644
index 4352e1f..0000000
--- a/core/src/test/scala/com.mediative.amadou/StageSpec.scala
+++ /dev/null
@@ -1,296 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-
-import org.scalatest._
-import org.apache.spark.sql.SparkSession
-import scala.util.{Success, Try}
-
-object StageSpec {
- case class Raw(a: String, b: String)
- case class Clean(a: Long, b: Int)
-
- case class TestContext[+I](
- override val spark: SparkSession,
- override val date: DateInterval,
- override val value: I)
- extends Stage.Context(spark, date, value) { self =>
-
- override def withValue[U](u: U) = new TestContext(spark, date, u) {
- override protected var stageNames = self.stageNames
- }
- override def run[T](stage: Stage[I, T], result: => T): Stage.Result[T] = {
- stageNames += stage.name
- Try(result)
- }
-
- def stagesRun = List(stageNames: _*)
- protected var stageNames = scala.collection.mutable.ArrayBuffer[String]()
- }
-}
-
-class StageSpec extends FreeSpec with Matchers with SparkJobSuiteBase {
-
- import StageSpec._
-
- val InitStage = Stage[Int, Int]("init")(_.value)
- val ToStringStage = Stage[Any, String]("toString")(_.value.toString)
- val ToIntStage = Stage[String, Int]("toInt")(_.value.toInt)
- val FailStage = Stage[Int, Int]("fail")(_.value / 0)
-
- "Stage" - {
- "name" - {
- "from string" in {
- InitStage.name should be("init")
- }
-
- "from scala.Symbol" in {
- 'NameFromSymbol.stage[Int, Int](_ => 1).name should be("NameFromSymbol")
- }
- }
-
- "run" - {
- "succeeding operation" in {
- val ctx = TestContext(spark, Day.today, 1)
- InitStage.run(ctx) should be(Success(1))
- ctx.stagesRun should be("init" :: Nil)
- }
-
- "failing operation" in {
- val ctx = TestContext(spark, Day.today, 1)
- the[ArithmeticException] thrownBy FailStage.run(ctx).get should have message "/ by zero"
- ctx.stagesRun should be("fail" :: Nil)
- }
- }
-
- "map" - {
- "succeeding operation" in {
- val ctx = TestContext(spark, Day.today, 42)
- InitStage.map(_ + 1).run(ctx) should be(Success(43))
- ctx.stagesRun should be("init" :: Nil)
- }
-
- "multiple" in {
- val ctx = TestContext(spark, Day.today, 42)
- InitStage.map(_ + 1).map(_ + 1).run(ctx) should be(Success(44))
- ctx.stagesRun should be("init" :: Nil)
- }
-
- "failing operation" in {
- val ctx = TestContext(spark, Day.today, 1)
- the[ArithmeticException] thrownBy InitStage
- .map(_ / 0)
- .run(ctx)
- .get should have message "/ by zero"
- ctx.stagesRun should be("init" :: Nil)
- }
-
- "failing operation with unreachable mapping" in {
- val ctx = TestContext(spark, Day.today, 1)
- the[ArithmeticException] thrownBy InitStage
- .map(_ / 0)
- .map(_ + 1)
- .run(ctx)
- .get should have message "/ by zero"
- ctx.stagesRun should be("init" :: Nil)
- }
- }
-
- "flatMap" - {
- "succeeding operation" in {
- val ctx = TestContext(spark, Day.today, 42)
- InitStage.flatMap(_ => ToStringStage).run(ctx) should be(Success("42"))
- ctx.stagesRun should be("init" :: "toString" :: Nil)
- }
-
- "multiple" in {
- val ctx = TestContext(spark, Day.today, 42)
- val stages = for {
- init <- InitStage
- toString <- ToStringStage
- value <- 'stringToInt.stage[String, Int](_.value.toInt)
- } yield value
-
- stages.run(ctx) should be(Success(42))
- ctx.stagesRun should be("init" :: "toString" :: "stringToInt" :: Nil)
- }
-
- "failing operation" in {
- val ctx = TestContext(spark, Day.today, 42)
- val stages = for {
- init <- InitStage
- value <- FailStage
- toString <- ToStringStage
- } yield ()
-
- the[ArithmeticException] thrownBy stages.run(ctx).get should have message "/ by zero"
- ctx.stagesRun should be("init" :: "fail" :: Nil)
- }
-
- "failing last operation" in {
- val ctx = TestContext(spark, Day.today, 42)
- val stages = for {
- init <- InitStage
- toString <- ToStringStage
- toInt <- ToIntStage
- value <- FailStage
- } yield ()
-
- the[ArithmeticException] thrownBy stages.run(ctx).get should have message "/ by zero"
- ctx.stagesRun should be("init" :: "toString" :: "toInt" :: "fail" :: Nil)
- }
- }
-
- "andThen and ~>" - {
- "succeeding operation" in {
- val ctx = TestContext(spark, Day.today, 42)
- (InitStage andThen ToStringStage).run(ctx) should be(Success("42"))
- ctx.stagesRun should be("init" :: "toString" :: Nil)
- }
-
- "succeeding operation using ~>" in {
- val ctx2 = TestContext(spark, Day.today, 42)
- (InitStage ~> ToStringStage ~> ToIntStage).run(ctx2) should be(Success(42))
- ctx2.stagesRun should be("init" :: "toString" :: "toInt" :: Nil)
- }
-
- "failing operation" in {
- val ctx = TestContext(spark, Day.today, 42)
- val stages: Stage[Int, String] = InitStage ~> FailStage ~> ToStringStage
-
- the[ArithmeticException] thrownBy stages.run(ctx).get should have message "/ by zero"
- ctx.stagesRun should be("init" :: "fail" :: Nil)
- }
-
- "failing last operation" in {
- val ctx = TestContext(spark, Day.today, 42)
- val stages: Stage[Int, Int] = InitStage ~> ToStringStage ~> ToIntStage ~> FailStage
-
- the[ArithmeticException] thrownBy stages.run(ctx).get should have message "/ by zero"
- ctx.stagesRun should be("init" :: "toString" :: "toInt" :: "fail" :: Nil)
- }
- }
-
- "sequence" - {
- "combines list of stages into one list of results" in {
- val ctx = TestContext(spark, Day.today, 42)
- val sequence = for (i <- 0 to 10)
- yield
- Stage[Int, Int](i.toString) { ctx =>
- i + 1
- }
- val stages = Stage.sequence(sequence)
-
- stages.run(ctx) should be(Success(Seq(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11)))
- ctx.stagesRun should be(List("0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10"))
- }
-
- "failing operation" in {
- val ctx = TestContext(spark, Day.today, 42)
- val sequence = for (i <- 0 to 10)
- yield
- Stage[Int, Int](i.toString) { ctx =>
- i / (i - 5)
- }
- val stages = Stage.sequence(sequence)
-
- the[ArithmeticException] thrownBy stages.run(ctx).get should have message "/ by zero"
- ctx.stagesRun should be("0" :: "1" :: "2" :: "3" :: "4" :: "5" :: Nil)
- }
- }
-
- "sequenceAll" - {
- "combines list of stages into one list of results" in {
- val ctx = TestContext(spark, Day.today, 42)
- val sequence = for (i <- 0 to 3)
- yield
- Stage[Int, Int](i.toString) { ctx =>
- i + 1
- }
- val stages = Stage.sequenceAll(sequence)
-
- stages.run(ctx) should be(Success(Seq(1, 2, 3, 4)))
- ctx.stagesRun should be("0" :: "1" :: "2" :: "3" :: Nil)
- }
-
- "failing operation" in {
- val ctx = TestContext(spark, Day.today, 42)
- val sequence = for (i <- 0 to 3)
- yield
- Stage[Int, Int](i.toString) { ctx =>
- i / (i - 2)
- }
- val stages = Stage.sequenceAll(sequence)
- val result = stages.run(ctx)
-
- result.isFailure should be(true)
- the[Stage.SequenceAllException[Int, Int]] thrownBy result.get should have message (
- """1 stage(s) failed:
- | - 2 failed: (java.lang.ArithmeticException) / by zero""".stripMargin
- )
- ctx.stagesRun should be("0" :: "1" :: "2" :: "3" :: Nil)
- }
- }
-
- "identity" - {
- "passes original value" in {
- val ctx = TestContext(spark, Day.today, 42)
- val empty: Stage[Int, Int] = Stage.identity
-
- empty.run(ctx) should be(Success(42))
- ctx.stagesRun should be("identity" :: Nil)
- }
-
- "map run via the identity stage" in {
- val ctx = TestContext(spark, Day.today, 42)
- Stage.identity[Int].map(_.toDouble).run(ctx) should be(Success(42.0))
- ctx.stagesRun should be("identity" :: Nil)
- }
-
- "flatMap ignores the identity stage" in {
- val ctx = TestContext(spark, Day.today, 42)
- Stage.identity[Int].flatMap(_ => ToStringStage).run(ctx) should be(Success("42"))
- ctx.stagesRun should be("toString" :: Nil)
- }
- }
-
- "source" - {
- "passes original value" in {
- val ctx = TestContext(spark, Day.today, 42)
- import spark.implicits._
-
- val stages = for {
- raw1 <- 'Read1.source[String] { ctx =>
- ctx.spark.read.textFile("src/test/resources/hdfs/test_etl/year=2017/month=02/data.csv")
- }
-
- wordCount1 <- 'CountWords1.transform[String, Int](_.value.map(_.split(" ").length))
-
- raw2 <- 'Read2.source[String] { ctx =>
- ctx.spark.read.textFile("src/test/resources/hdfs/quotes.txt")
- }
-
- wordCount2 <- 'CountWords2.transform[String, Int](_.value.map(_.split(" ").length))
-
- } yield wordCount1.collect.sum + wordCount2.collect.sum
-
- stages.run(ctx) should be(Success(112))
- ctx.stagesRun should be("Read1" :: "CountWords1" :: "Read2" :: "CountWords2" :: Nil)
- }
- }
- }
-}
diff --git a/core/src/test/scala/com.mediative.amadou/test/TestEtl.scala b/core/src/test/scala/com.mediative.amadou/test/TestEtl.scala
deleted file mode 100644
index 756369e..0000000
--- a/core/src/test/scala/com.mediative.amadou/test/TestEtl.scala
+++ /dev/null
@@ -1,106 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-package test
-
-import org.apache.spark.sql._
-import org.apache.spark.sql.functions._
-import org.apache.spark.sql.types._
-
-object TestEtl extends SparkRunner[TestEtlJob] {
- val jobName = "test_etl"
- val schedule = today
-
- override val recordsProcessed = gauge("test_etl_processed", "Number of processed rows")
-
- val RawSchema = StructType(
- Array(
- StructField("Object Name", StringType),
- StructField("Object Colour", StringType),
- StructField("Observed Time", TimestampType),
- StructField("Observed Latitude", DoubleType),
- StructField("Observed Longitude", DoubleType),
- StructField("Speed", LongType)
- ))
-
- case class Clean(
- name: String,
- isPink: Boolean,
- eventDate: java.sql.Timestamp,
- latitude: Double,
- longitude: Double,
- speed: Long,
- processingDate: java.sql.Timestamp)
-
- override def createJob(config: Config) =
- TestEtlJob(
- config.as[HdfsUrl]("test_etl"),
- config.as[HdfsUrl]("hdfs.raw") / jobName,
- config.as[HdfsUrl]("hdfs.clean") / jobName,
- recordsProcessed
- )
-
-}
-
-case class TestEtlJob(
- testEtlUrl: HdfsUrl,
- rawUrl: HdfsUrl,
- cleanUrl: HdfsUrl,
- recordsProcessed: Gauge)
- extends SparkJob {
-
- import TestEtl.{RawSchema, Clean}
-
- def shouldRunForDate(spark: SparkSession, date: DateInterval): Boolean = true
-
- override val stages =
- clean ~> 'SaveClean.sink[Clean](ctx =>
- ctx.value.write.mode(SaveMode.Overwrite).parquet(cleanUrl / ctx.date))
-
- def clean: Stage[SparkSession, Dataset[Clean]] =
- for {
- // Read raw input from input
- rawData <- 'ReadRaw.source[Row] { ctx =>
- ctx.spark.read
- .option("header", true)
- .option("dateFormat", "yyyy-MM-dd")
- .schema(RawSchema)
- .csv(testEtlUrl / ctx.date / "*.csv")
- }
-
- saveRaw <- 'SaveRaw.sink[Row](ctx =>
- ctx.value.write.mode(SaveMode.Overwrite).csv(rawUrl / ctx.date))
-
- cleanData <- 'CleanData.transform[Row, Clean] { ctx =>
- import ctx.spark.implicits._
-
- val CleanSchema = implicitly[Encoder[Clean]].schema
- val isPink = udf((colorName: String) => colorName.compareToIgnoreCase("pink") == 0)
-
- ctx.value
- .withColumnRenamed("Object Name", "name")
- .withColumnRenamed("Observed Time", "eventDate")
- .withColumnRenamed("Observed Latitude", "latitude")
- .withColumnRenamed("Observed Longitude", "longitude")
- .withColumnRenamed("Speed", "speed")
- .withColumn("isPink", isPink($"Object Colour"))
- .withColumn("processingDate", lit(ctx.date.asTimestamp))
- .select(CleanSchema.fieldNames.map(col): _*)
- .as[Clean]
- }
- } yield cleanData
-}
diff --git a/core/src/test/scala/com.mediative.amadou/test/TestEtlSpec.scala b/core/src/test/scala/com.mediative.amadou/test/TestEtlSpec.scala
deleted file mode 100644
index c630fa7..0000000
--- a/core/src/test/scala/com.mediative.amadou/test/TestEtlSpec.scala
+++ /dev/null
@@ -1,61 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-package test
-
-import org.scalatest._
-import org.apache.spark.sql.types._
-
-class TestEtlSpec extends FreeSpec with SparkJobSuiteBase {
-
- val job = TestEtl.createJob(config)
- val date = Day(2017, 2, 21)
-
- val cleanSchema = StructType(
- Array(
- StructField("name", StringType),
- StructField("isPink", BooleanType),
- StructField("eventDate", TimestampType),
- StructField("latitude", DoubleType),
- StructField("longitude", DoubleType),
- StructField("speed", LongType),
- StructField("processingDate", TimestampType, false)
- ))
-
- "TestEtl" - {
- "should have expected schema and number of entries" in {
- val clean = job.clean.run(Stage.Context(spark, date))
-
- assert(clean.isSuccess)
- assert(clean.get.schema == cleanSchema)
- assert(clean.get.count == 3)
- }
-
- "should persist raw data" in {
- val rawPath = job.rawUrl / "2017/02/21"
-
- assert(rawPath.exists(spark), s"$rawPath does not exist")
- }
-
- "should persist clean data" in {
- val cleanPath = job.cleanUrl / "date=2017-02-21"
-
- job.stages.run(Stage.Context(spark, date))
- assert(cleanPath.exists(spark), s"$cleanPath does not exist")
- }
- }
-}
diff --git a/project/build.properties b/project/build.properties
deleted file mode 100644
index 64317fd..0000000
--- a/project/build.properties
+++ /dev/null
@@ -1 +0,0 @@
-sbt.version=0.13.15
diff --git a/project/plugins.sbt b/project/plugins.sbt
deleted file mode 100644
index f19135f..0000000
--- a/project/plugins.sbt
+++ /dev/null
@@ -1,7 +0,0 @@
-resolvers += Resolver.bintrayIvyRepo("mediative", "sbt-plugins")
-resolvers += Resolver.bintrayIvyRepo("fonseca", "sbt-plugins")
-
-addSbtPlugin("com.mediative.sbt" % "sbt-mediative-core" % "0.5.6")
-addSbtPlugin("com.mediative.sbt" % "sbt-mediative-oss" % "0.5.6")
-addSbtPlugin("com.mediative.sbt" % "sbt-mediative-devops" % "0.5.6")
-addSbtPlugin("com.github.tkawachi" % "sbt-doctest" % "0.4.1")
diff --git a/testkit/src/main/resources/reference.conf b/testkit/src/main/resources/reference.conf
deleted file mode 100644
index 3fa68bd..0000000
--- a/testkit/src/main/resources/reference.conf
+++ /dev/null
@@ -1 +0,0 @@
-spark.sql.warehouse.dir = target/spark-warehouse
diff --git a/testkit/src/main/scala/com.mediative.amadou/SparkJobSuiteBase.scala b/testkit/src/main/scala/com.mediative.amadou/SparkJobSuiteBase.scala
deleted file mode 100644
index 4dfc7d0..0000000
--- a/testkit/src/main/scala/com.mediative.amadou/SparkJobSuiteBase.scala
+++ /dev/null
@@ -1,49 +0,0 @@
-/*
- * Copyright 2017 Mediative
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.mediative.amadou
-
-import org.scalatest.BeforeAndAfterAll
-import org.scalatest.Suite
-import com.holdenkarau.spark.testing.DatasetSuiteBase
-import com.typesafe.config.ConfigFactory
-import org.apache.hadoop.conf.Configuration
-import org.apache.hadoop.fs.{FileSystem, Path}
-
-/**
- * Base class which provides an environment for running tasks.
- */
-trait SparkJobSuiteBase extends DatasetSuiteBase with BeforeAndAfterAll { self: Suite =>
- val config = ConfigFactory.load()
- val fileSystem = FileSystem.get(new Configuration())
-
- System.setProperty("derby.stream.error.file", "target/spark-warehouse-derby.log")
-
- override def beforeAll() = {
- super.beforeAll()
-
- if (config.hasPath("hdfs.root")) {
- val rootUrl = config.getString("hdfs.root")
- val path = new Path(rootUrl)
-
- /* Cleanup the HDFS root before running the test. */
- if (rootUrl.startsWith("target/") && fileSystem.exists(path)) {
- assert(fileSystem.delete(path, true))
- }
- }
- ()
- }
-}
+ 
+ 
+ 
+ 
+ 
+
+ 
+ 
+
+ 
+
+
+ 
+ 
+ 
+
+
+ 
+ 
+
+ 
+
+ 
+ 
+ 
+ 
+ 
+ 
'
+ ].join('');
+ }
+
+ function createPackageHeader(pack) {
+ return [
+ '
Mixin for loading and injecting values from configuration files. +