Simple Google Analytics

More complex virtual page views for tabs/etc to be implemented later.
PavlidisLab · Aug 3, 2016 · a22a81f · a22a81f
1 parent 3c936b7
commit a22a81f
Show file tree

Hide file tree

Showing 15 changed files with 109 additions and 2 deletions.
diff --git a/gotrack/src/main/resources/example_gotrack.properties b/gotrack/src/main/resources/example_gotrack.properties
@@ -17,4 +17,7 @@ gotrack.dryRun=false
 # Load pre-calculated data from database or recalculating them, should be true if new data has just been added
 gotrack.recalculate=false
 # Write pre-calculated data to database (This takes a while), can set to true once during development for speedy start-ups
-gotrack.writeCache=true
+gotrack.writeCache=true
+# Google Analytics (leave tracker empty for sandbox/development versions)
+gotrack.ga_tracker=
+gotrack.ga_domain=chibi.ubc.ca
diff --git a/gotrack/src/main/webapp/WEB-INF/errors/400.xhtml b/gotrack/src/main/webapp/WEB-INF/errors/400.xhtml
@@ -7,4 +7,9 @@
     <ui:define name="errorContent">
         <p>The request could not be understood by the server due to malformed syntax.</p>
     </ui:define>
+	<ui:define name="js">
+		<script type="text/javascript">
+	        	googleAnalyticsTrackPageviewIfConfigured( "/gotrack/error/400" );
+	    </script>
+	</ui:define>
 </ui:composition>
diff --git a/gotrack/src/main/webapp/WEB-INF/errors/404.xhtml b/gotrack/src/main/webapp/WEB-INF/errors/404.xhtml
@@ -7,4 +7,9 @@
     <ui:define name="errorContent">
         <p>The requested resource as specified in your browser's address bar cannot be found.</p>
     </ui:define>
+    <ui:define name="js">
+		<script type="text/javascript">
+	        	googleAnalyticsTrackPageviewIfConfigured( "/gotrack/error/404" );
+	    </script>
+	</ui:define>
 </ui:composition>
diff --git a/gotrack/src/main/webapp/WEB-INF/errors/500.xhtml b/gotrack/src/main/webapp/WEB-INF/errors/500.xhtml
@@ -2,4 +2,9 @@
 	xmlns="http://www.w3.org/1999/xhtml"
 	xmlns:ui="http://java.sun.com/jsf/facelets"
 >
+	<ui:define name="js">
+		<script type="text/javascript">
+	        	googleAnalyticsTrackPageviewIfConfigured( "/gotrack/error/500" );
+	    </script>
+	</ui:define>
 </ui:composition>
diff --git a/gotrack/src/main/webapp/WEB-INF/errors/bug.xhtml b/gotrack/src/main/webapp/WEB-INF/errors/bug.xhtml
@@ -3,4 +3,9 @@
 	xmlns:ui="http://java.sun.com/jsf/facelets"
 >
 	<ui:define name="contentTitle">You got a RuntimeException! There's a BUG somewhere!</ui:define>
+	<ui:define name="js">
+		<script type="text/javascript">
+	        	googleAnalyticsTrackPageviewIfConfigured( "/gotrack/error/bug" );
+	    </script>
+	</ui:define>
 </ui:composition>
diff --git a/gotrack/src/main/webapp/WEB-INF/errors/database.xhtml b/gotrack/src/main/webapp/WEB-INF/errors/database.xhtml
@@ -3,4 +3,9 @@
 	xmlns:ui="http://java.sun.com/jsf/facelets"
 >
 	<ui:define name="contentTitle">Oops! DB fail!</ui:define>
+	<ui:define name="js">
+		<script type="text/javascript">
+	        	googleAnalyticsTrackPageviewIfConfigured( "/gotrack/error/database" );
+	    </script>
+	</ui:define>
 </ui:composition>
diff --git a/gotrack/src/main/webapp/WEB-INF/errors/expired.xhtml b/gotrack/src/main/webapp/WEB-INF/errors/expired.xhtml
@@ -7,4 +7,9 @@
     <ui:define name="errorContent">
         <p>Your session has expired due to inactivity. Please refresh your page.</p>
     </ui:define>
+    <ui:define name="js">
+		<script type="text/javascript">
+	        	googleAnalyticsTrackPageviewIfConfigured( "/gotrack/error/expired" );
+	    </script>
+	</ui:define>
 </ui:composition>
diff --git a/gotrack/src/main/webapp/WEB-INF/errors/gene.xhtml b/gotrack/src/main/webapp/WEB-INF/errors/gene.xhtml
@@ -7,4 +7,9 @@
     <ui:define name="errorContent">
         <p>The selected gene symbol could not be found.</p>
     </ui:define>
+    <ui:define name="js">
+		<script type="text/javascript">
+	        	googleAnalyticsTrackPageviewIfConfigured( "/gotrack/error/gene" );
+	    </script>
+	</ui:define>
 </ui:composition>
diff --git a/gotrack/src/main/webapp/WEB-INF/errors/term.xhtml b/gotrack/src/main/webapp/WEB-INF/errors/term.xhtml
@@ -7,4 +7,9 @@
     <ui:define name="errorContent">
         <p>The selected term id could not be found.</p>
     </ui:define>
+   	<ui:define name="js">
+		<script type="text/javascript">
+	        	googleAnalyticsTrackPageviewIfConfigured( "/gotrack/error/term" );
+	    </script>
+	</ui:define>
 </ui:composition>
diff --git a/gotrack/src/main/webapp/WEB-INF/templates/analytics.xhtml b/gotrack/src/main/webapp/WEB-INF/templates/analytics.xhtml
@@ -0,0 +1,46 @@
+<ui:composition 
+    xmlns="http://www.w3.org/1999/xhtml"
+    xmlns:f="http://xmlns.jcp.org/jsf/core"
+    xmlns:h="http://xmlns.jcp.org/jsf/html"
+    xmlns:ui="http://xmlns.jcp.org/jsf/facelets">
+
+    <f:verbatim rendered="#{empty (settingsCache.getProperty('gotrack.ga_tracker'))}">
+        <script type="text/javascript">
+        		console.log("No Tracker.");
+                if ( typeof googleAnalyticsTrackPageviewIfConfigured === 'undefined' ) {
+                   var googleAnalyticsTrackPageviewIfConfigured = function(pageURL) {/* no op, for sandbox and development */
+                      console.log("Didn't track: " + pageURL);
+                   };
+                }
+        </script>
+        </f:verbatim>
+
+	<f:verbatim rendered="#{not empty (settingsCache.getProperty('gotrack.ga_tracker'))}">
+		<script type="text/javascript">
+		var _gaq = _gaq || [];
+		var pluginUrl = '//www.google-analytics.com/plugins/ga/inpage_linkid.js';
+		_gaq.push([ '_require', 'inpage_linkid', pluginUrl ]);
+		_gaq.push([ '_setAccount', "settingsCache.getProperty('gotrack.ga_tracker')" ]);
+		_gaq.push([ '_setDomainName', "settingsCache.getProperty('gotrack.ga_domain')" ]);
+		_gaq.push([ '_trackPageview' ]);
+		(function() {
+		   var ga = document.createElement('script');
+		   ga.type = 'text/javascript';
+		   ga.async = true;
+		   ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www')
+		         + '.google-analytics.com/ga.js';
+		   var s = document.getElementsByTagName('script')[0];
+		   s.parentNode.insertBefore(ga, s);
+		})();
+		if ( typeof googleAnalyticsTrackPageviewIfConfigured === 'undefined' ) {
+		   var googleAnalyticsTrackPageviewIfConfigured = googleAnalyticsTrackPageviewIfConfigured || function(pageURL) {
+		      if ( typeof _gaq !== 'undefined' ) {
+		         _gaq.push([ '_setAccount', "settingsCache.getProperty('gotrack.ga_tracker')" ]);
+		         _gaq.push([ '_trackPageview', pageURL ]);
+		      }
+		   };
+		}
+      </script>
+	</f:verbatim>
+
+</ui:composition>
diff --git a/gotrack/src/main/webapp/WEB-INF/templates/mainLayout.xhtml b/gotrack/src/main/webapp/WEB-INF/templates/mainLayout.xhtml
@@ -32,6 +32,7 @@
 		<meta name="keywords"
 			content="genomics,bioinformatics,genetics,gene,function,ontology,biotechnology,medicine,biomedical,meta-analysis,statistics,search,open source,database,software" />
 
+		<ui:include src="/WEB-INF/templates/analytics.xhtml" />
 		<h:outputScript library="js" name="common.js" />
 		<ui:insert name="js" />
 

diff --git a/gotrack/src/main/webapp/enrichment.xhtml b/gotrack/src/main/webapp/enrichment.xhtml
@@ -19,6 +19,9 @@
 		<h:outputStylesheet library="css" name="enrichment.css" />
 	</ui:define>
 	<ui:define name="js">
+		<script type="text/javascript">
+	        	googleAnalyticsTrackPageviewIfConfigured( "/gotrack/enrichment" );
+	    </script>
 		<h:outputScript library="js" name="utility.js" />
 
 		<!-- Highcharts stuff -->

diff --git a/gotrack/src/main/webapp/genes.xhtml b/gotrack/src/main/webapp/genes.xhtml
@@ -21,6 +21,9 @@
 		<h:outputStylesheet library="css" name="genes.css" />
 	</ui:define>
 	<ui:define name="js">
+		<script type="text/javascript">
+	        	googleAnalyticsTrackPageviewIfConfigured( "/gotrack/genes" );
+	    </script>
 		<h:outputScript library="js" name="utility.js" />
 
 		<!-- Highcharts stuff -->

diff --git a/gotrack/src/main/webapp/index.xhtml b/gotrack/src/main/webapp/index.xhtml
@@ -4,7 +4,8 @@
 	xmlns:h="http://java.sun.com/jsf/html"
 	xmlns:f="http://java.sun.com/jsf/core"
 	xmlns:p="http://primefaces.org/ui"
-	xmlns:of="http://omnifaces.org/functions">
+	xmlns:of="http://omnifaces.org/functions"
+	xmlns:ui="http://xmlns.jcp.org/jsf/facelets">
 <h:head>
 	<title>GOtrack</title>
 	<h:outputStylesheet library="css" name="style.css" />
@@ -21,6 +22,13 @@
 		content="genomics,bioinformatics,genetics,gene,function,ontology,biotechnology,medicine,biomedical,meta-analysis,statistics,search,open source,database,software,enrichment,GO" />
 	<meta name="author" content="GOtrack admin ([email protected])" />
 
+	<ui:include src="/WEB-INF/templates/analytics.xhtml" />
+
+	<script type="text/javascript">
+        	googleAnalyticsTrackPageviewIfConfigured( "/gotrack/index" );
+    </script>
+
+
 </h:head>
 
 <h:body>

diff --git a/gotrack/src/main/webapp/terms.xhtml b/gotrack/src/main/webapp/terms.xhtml
@@ -20,6 +20,9 @@
 		<h:outputStylesheet library="css" name="tipsy.css" />
 	</ui:define>
 	<ui:define name="js">
+		<script type="text/javascript">
+	        	googleAnalyticsTrackPageviewIfConfigured( "/gotrack/terms" );
+	    </script>
 		<h:outputScript library="js" name="utility.js" />