umbraBehavior refactor initial commit

brozzler/behaviors.yaml

@@ -37,6 +37,15 @@
   url_regex: '^https?://(?:www\.)?instagram\.com/.*$'
   behavior_js_template: instagram.js
   request_idle_timeout_sec: 10
+-
+  url_regex: '^https?://(?:www\.)?huffingtonpost\.com/.*$'
+  behavior_js_template: umbraBehavior.js.j2
+  default_parameters:
+    actions:
+      - selector: .slideshow
+        do: click
+      - selector: .slideshow-overlay__container__left__nav__next
+        do: click
 -
   url_regex: '^https?://(?:www\.)?huffingtonpost\.com/.*$'
   behavior_js_template: huffpostslides.js
@@ -108,6 +117,13 @@
   url_regex: '^https?://(?:www\.)?fec.gov/data/.*$'
   behavior_js_template: fec_gov.js
   request_idle_timeout_sec: 10
+- url_regex: '^https?://(?:www\.)?news\.com\.au/.*$'
+  behavior_js_template: umbraBehavior.js.j2
+  default_parameters:
+    actions:
+      - selector: .menu-item a
+        do: mouseover
+        do_until_hard_timeout: False
 - url_regex: '^https?://(?:www\.)?news\.com\.au/.*$'
   behavior_js_template: mouseovers.js.j2
   default_parameters:

brozzler/js-templates/umbraBehavior.js.j2

@@ -0,0 +1,158 @@
+/*
+ * brozzler/js-templates/umbrabehavior.js.j2 - a library for umbra/brozzler behaviors
+ *
+ * Copyright (C) 2017 Internet Archive
+ *
+ * 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.
+ */
+
+var umbraBehavior = {
+    IDLE_TIMEOUT_SEC : 10,
+
+    alreadyDone : [],
+    idleSince : null,
+    intervalId : null,
+
+    intervalFunc: function() {
+        var didSomething = false;
+        var somethingLeftBelow = false;
+        var somethingLeftAbove = false;
+
+        var actions = {{actions|json}};
+        var actionsLength = actions.length;
+
+        for (var k = 0; k < actionsLength; k++) {
+            var selector = actions[k].selector;
+            var action = actions[k].do;
+
+            var iframes = document.querySelectorAll("iframe");
+            var documents = Array(iframes.length + 1);
+            documents[0] = document;
+
+            iframesLength = iframes.length;
+            for (var i = 0; i < iframesLength; i++) {
+                documents[i+1] = iframes[i].contentWindow.document;
+            }
+
+            documentsLength = documents.length;
+            for (var j = 0; j < documentsLength; j++) {
+
+                var doTargets = documents[j].querySelectorAll(selector);
+
+                doTargetsLength = doTargets.length;
+                for ( var i = 0; i < doTargetsLength; i++) {
+                    if (this.alreadyDone.indexOf(doTargets[i]) > -1) {
+                        continue;
+                    }
+                    if (!this.isVisible(doTargets[i])) {
+                        continue;
+                    }
+                    var where = this.aboveBelowOrOnScreen(doTargets[i]);
+                    if (where == 0) {
+                        this.doTarget(doTargets[i], action);
+                        didSomething = true;
+                    } else if (where > 0) {
+                        somethingLeftBelow = true;
+                    } else if (where < 0) {
+                        somethingLeftAbove = true;
+                    }
+                    if (didSomething) {
+                        break; // break from doTargets loop, but not from documents loop
+                    }
+                }
+            }
+
+            if (!didSomething) {
+                if (somethingLeftAbove) {
+                    // console.log("scrolling UP because everything on this screen has been done but we missed something above");
+                    window.scrollBy(0, -500);
+                    this.idleSince = null;
+                } else if (somethingLeftBelow) {
+                    // console.log("scrolling because everything on this screen has been done but there's more below");
+                    window.scrollBy(0, 200);
+                    this.idleSince = null;
+                } else if (window.scrollY + window.innerHeight < document.documentElement.scrollHeight) {
+                    // console.log("scrolling because we're not to the bottom yet");
+                    window.scrollBy(0, 200);
+                    this.idleSince = null;
+                }  else if (this.idleSince == null) {
+                    this.idleSince = Date.now();
+                }
+            }
+
+            if (!idleSince) {
+                this.idleSince = Date.now();
+            }
+        }
+    },
+
+    start : function() {
+        var that = this;
+        this.intervalId = setInterval(function() {
+            that.intervalFunc()
+        }, 250);
+    },
+
+    isFinished : function() {
+        if (this.idleSince != null) {
+            var idleTimeMs = Date.now() - this.idleSince;
+            if (idleTimeMs / 1000 > this.IDLE_TIMEOUT_SEC) {
+                clearInterval(this.intervalId);
+                return true;
+            }
+        }
+        return false;
+    },
+
+    aboveBelowOrOnScreen : function(elem) {
+        var eTop = elem.getBoundingClientRect().top;
+        if (eTop < window.scrollY) {
+            return -1; // above
+        } else if (eTop > window.scrollY + window.innerHeight) {
+            return 1; // below
+        } else {
+            return 0; // on screen
+        }
+    },
+
+    isVisible : function(elem) {
+        return !!(elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length);
+    },
+
+    doTarget : function(target, action) {
+        // console.log("doing " + action + target.outerHTML);
+        // do mouse over event on target
+        // since some urls are requsted only on
+        // this event - see
+        // https://webarchive.jira.com/browse/AITFIVE-451
+        var mouseOverEvent = document.createEvent("Events");
+        mouseOverEvent.initEvent("mouseover", true, false);
+        target.dispatchEvent(mouseOverEvent);
+
+        if (action == "click") {
+            target.click();
+        } // add new do's here!
+
+        this.alreadyDone.push(target);
+        this.idleSince = null;
+    },
+
+// end umbraBehavior definition
+};
+
+// Called from outside of this script.
+var umbraBehaviorFinished = function() {
+    return umbraBehavior.isFinished();
+};
+
+umbraBehavior.start();