From 986c292739b7f0a7d1b5939dbbddea4bb3d5efa8 Mon Sep 17 00:00:00 2001
From: "Niels Erik G. Nielsen" <nielserik@indexdata.com>
Date: Wed, 27 Feb 2013 21:12:45 -0500
Subject: [PATCH 1/1] Adds pazpar2 listeners

---
 .gitignore                                        |    5 +
 pom.xml                                           |   58 +++++++++++
 src/META-INF/MANIFEST.MF                          |    3 +
 src/META-INF/resources/pz2utils/fieldlisteners.js |  113 +++++++++++++++++++++
 src/META-INF/resources/pz2utils/pz2watch.xhtml    |   48 +++++++++
 5 files changed, 227 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 pom.xml
 create mode 100644 src/META-INF/MANIFEST.MF
 create mode 100644 src/META-INF/resources/pz2utils/fieldlisteners.js
 create mode 100644 src/META-INF/resources/pz2utils/pz2watch.xhtml

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..bf98bbd
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,5 @@
+.classpath
+.project
+.settings/
+build/
+target/
diff --git a/pom.xml b/pom.xml
new file mode 100644
index 0000000..7d6dd9c
--- /dev/null
+++ b/pom.xml
@@ -0,0 +1,58 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.indexdata</groupId>
+  <artifactId>pz2utils4jsf</artifactId>
+  <version>0.0.1-SNAPSHOT</version>
+  <name>pz2utils4jsf</name>
+  <packaging>jar</packaging>
+  <description>Components for building Pazpar2 application using JSF</description>
+    <dependencies>
+    <dependency>
+      <groupId>javax</groupId>
+      <artifactId>javaee-api</artifactId>
+      <version>6.0</version>
+      <scope>provided</scope>
+    </dependency>
+
+    <!-- JSF 2 -->
+    <dependency>
+      <groupId>org.glassfish</groupId>
+      <artifactId>javax.faces</artifactId>
+      <version>2.1.16</version>
+      <scope>compile</scope>
+    </dependency>
+    <dependency>
+      <groupId>javax.servlet.jsp.jstl</groupId>
+      <artifactId>javax.servlet.jsp.jstl-api</artifactId>
+      <version>1.2.1</version>
+      <scope>compile</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.indexdata</groupId>
+      <artifactId>masterkey-common</artifactId>
+      <version>0.1.9-SNAPSHOT</version>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <sourceDirectory>src</sourceDirectory>
+    <resources>
+      <resource>
+        <directory>src</directory>
+        <excludes>
+          <exclude>**/*.java</exclude>
+        </excludes>
+      </resource>
+    </resources>
+    <plugins>
+      <plugin>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <version>2.3.2</version>
+        <configuration>
+          <source>1.7</source>
+          <target>1.7</target>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+</project>
\ No newline at end of file
diff --git a/src/META-INF/MANIFEST.MF b/src/META-INF/MANIFEST.MF
new file mode 100644
index 0000000..5e94951
--- /dev/null
+++ b/src/META-INF/MANIFEST.MF
@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Class-Path: 
+
diff --git a/src/META-INF/resources/pz2utils/fieldlisteners.js b/src/META-INF/resources/pz2utils/fieldlisteners.js
new file mode 100644
index 0000000..c5cf63a
--- /dev/null
+++ b/src/META-INF/resources/pz2utils/fieldlisteners.js
@@ -0,0 +1,113 @@
+  var renderTargetsReqVar;
+    
+  function renderTargets(doRefresh)
+  {
+	//console.log('rendering ' + renderWhileActiveclients);
+	var sourcecomp = document.getElementById("pz2watch:activeclientsField");
+    jsf.ajax.request(sourcecomp, null,{render: renderWhileActiveclients});
+    if (doRefresh) {
+		//console.log('Will do another ajax request after a timeout in order to render: pz2watch:activeclientsField');  
+	    renderTargetsReqVar=setTimeout(
+	     function() {              
+	       //console.log('Making request for pz2watch:activeclientsField');
+	       jsf.ajax.request(sourcecomp, null,{render: "pz2watch:activeclientsField"});       
+	     }
+	     ,500);
+    } else {
+    	//console.log("No further updates from server requested");
+    }
+  }
+
+  function windowlocationhashListener () {
+	  if (trackHistory) {
+	      //console.log("browser hash update detected");
+	      var stateKey = document.getElementById("pz2watch:windowlocationhash");
+	      if (window.location.hash != stateKey.value) {
+	        //console.log("updating stateKey with new browser hash: " + window.location.hash);
+	        stateKey.value = window.location.hash;
+	        if (! stateKey.value) window.location.hash = '#initial';
+	        stateKey.onchange();
+	      } else {
+	        //console.log("State hash already has the value of the new browser hash - not updating state hash");
+	      }    	  
+	  }	  
+  }      
+
+  function fieldUpdateListener (data) {
+	  if (data.status === "success") {
+		var updates = data.responseXML.getElementsByTagName("update");
+		for (var i=0, max=updates.length; i<max; i++) {
+			var lsnri = fieldListeners.getListener(updates[i].getAttribute("id"));
+			if (lsnri) {
+				lsnri.invoke(updates[i]);
+			}
+		}
+	  }
+  }
+        
+  var Pz2listeners = function () {
+	var lsnrs = {};
+	this.addListener = function (key, lsnr) {
+		lsnrs[key] =lsnr;
+	};
+	this.getListener = function (key) {
+		return lsnrs[key];
+	};
+  };
+
+  var fieldListeners = new Pz2listeners();
+
+  var StateListener = function () {
+	this.invoke = function (field) {
+      var stateKeyDoc = StringtoXML(field.textContent || field.text);
+      var stateKeyValue = stateKeyDoc.childNodes[0].getAttribute("value");
+      //console.log('Application hash update detected. New value: ' + stateKeyValue);
+      if (stateKeyValue != window.location.hash) {
+        window.location.hash = stateKeyValue;
+        //console.log("Browsers hash updated accordingly.");
+      } else {
+        //console.log("Browsers hash already has the value of the state hash. Not updating browser hash."); 
+      }
+
+	};
+  };
+  
+  var ActiveclientsListener = function () {
+    this.invoke = function (field) {
+      var updateDoc = StringtoXML(field.textContent || field.text);
+      var activeClientsValue = (updateDoc.childNodes[0].textContent || updateDoc.childNodes[0].text);
+      //console.log('Activeclients response detected: ' + activeClientsValue);
+      clearTimeout(renderTargetsReqVar);
+      if (activeClientsValue > '0') {
+        renderTargets(true);
+      } else {
+    	renderTargets(false);
+      }
+	};
+  };
+    
+  jsf.ajax.addOnEvent(fieldUpdateListener);
+  
+  function StringtoXML(text){
+		var doc;
+	    if (window.ActiveXObject){
+	      doc=new ActiveXObject('Microsoft.XMLDOM');
+	      doc.async=false;
+	      doc.loadXML(text);
+	    } else {
+	      var parser=new DOMParser();
+	      doc=parser.parseFromString(text,'text/xml');
+	    }
+	    return doc;
+  }
+
+  var setUpListeners = function () {
+    //console.log("Starts tracking activeclientsField");
+    fieldListeners.addListener("pz2watch:activeclientsField", new ActiveclientsListener());
+    if (trackHistory) {
+        //console.log("Starts tracking windowlocationhash field");
+        fieldListeners.addListener("pz2watch:windowlocationhash", new StateListener());
+        //console.log("Setting listener for browser onhashchange");
+        window.onload = window.onhashchange = windowlocationhashListener;
+    }
+  };
\ No newline at end of file
diff --git a/src/META-INF/resources/pz2utils/pz2watch.xhtml b/src/META-INF/resources/pz2utils/pz2watch.xhtml
new file mode 100644
index 0000000..511aae1
--- /dev/null
+++ b/src/META-INF/resources/pz2utils/pz2watch.xhtml
@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<h:html xmlns="http://www.w3.org/1999/xhtml"
+      xmlns:f="http://java.sun.com/jsf/core"
+      xmlns:h="http://java.sun.com/jsf/html"
+      xmlns:ui="http://java.sun.com/jsf/facelets"
+      xmlns:cc="http://java.sun.com/jsf/composite">
+
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+</head>
+<body>
+
+  <cc:interface>
+    <cc:attribute name="renderWhileActiveclients"/>
+    <cc:attribute name="trackHistory"/>
+    <cc:attribute name="renderOnHitoryChange"/> 
+    <cc:attribute name="debug"/>   
+  </cc:interface>
+
+  <cc:implementation>
+    <h:outputScript name="jsf.js" library="javax.faces" target="head" />
+    <h:outputScript name="fieldlisteners.js" library="pz2utils" target="head" />
+    
+    <!-- Initiate Ajax update listeners -->  
+    <script>
+     //<![CDATA[
+       var renderWhileActiveclients = "${cc.attrs.renderWhileActiveclients}";
+       var renderOnHistoryChange = "${cc.attrs.renderOnHistoryChange}";
+       var trackHistory = ("${cc.attrs.trackHistory}" == "true");  
+       setUpListeners();
+     //]]>
+    </script>  
+
+    <h:form id="activeclientsForm" prependId="false" style="${cc.attrs.debug == 'true' ? '' : 'display:none;'}">
+      Active clients: <h:outputText id="activeclientsField" value="${pz2.update()}" />
+    </h:form>
+
+    <h:form id="stateForm" prependId="false" rendered="${cc.attrs.trackHistory == 'true'}" style="${cc.attrs.debug == 'true' ? '' : 'display:none;'}">
+      State: 
+      <h:inputText id="windowlocationhash" value="#{pz2.currentStateKey}" size="100">
+        <f:ajax event="change" render="#{cc.attrs.renderOnHistoryChange} #{pz2watch.activeclients}"/>
+      </h:inputText>
+    </h:form>
+  </cc:implementation>
+  
+</body>
+</h:html>
\ No newline at end of file
-- 
1.7.10.4