virtual-labs-archive · mohandidugu · Mar 22, 2020 · Mar 24, 2020 · Mar 24, 2020 · Jul 1, 2020
diff --git a/.gitignore b/.gitignore
@@ -3,4 +3,5 @@ template1.html
 scrap.py
 scraplab.py
 *~
-content.html
+content.html
+submission*.html
diff --git a/README.txt b/README.txt
@@ -99,4 +99,3 @@ Go to Command Terminal
 	 $ make theme=blue-icon
 
 * Now, open ui/build/index.html in the browser to test the template.
-
diff --git a/changelog.org b/changelog.org
@@ -0,0 +1,21 @@
+#+NAME: Changelog
+
+* <2020-07-03 Fri>
+
+  - Author :: Ojas Mohril
+  - Changes ::
+    - Updated makefile =patch-analytics= command to use
+      =scripts/patch-analytics.sh= instead of the script
+      from [[https://github.com/virtual-labs/vlabs-analytics][vlabs-analytics]].
+    - This script is taken from the [[https://github.com/virtual-labs/vlabs-analytics][vlabs-analytics]] repo but updated
+      to ignore =content*.html= files.  Justification for why this is
+      needed can be found in [[https://github.com/virtual-labs/problem-solving-iiith/issues/1213][this]] issue.  (In brief, content*.html
+      files are not really html and break when touched by the
+      analytics code.)
+    - As a result of this change, the submission files will no longer
+      have analytics snippet and these page views will not be tracked.
+    - Removed all committed submission*.html files and added the
+      pattern to gitignore.  These are radomly generated files and
+      should not be added to version control.
+    - As the broken content files were comitted at some point on the
+      master, the working files had to extracted from [[https://github.com/virtual-labs/problem-solving-iiith/commit/591c7f3c91d260a9a0ef12385c62be3b63577e44][this]] commit.
diff --git a/scripts/gtm-patcher.py b/scripts/gtm-patcher.py
@@ -0,0 +1,110 @@
+#!/usr/bin/python
+
+from bs4 import BeautifulSoup, Tag, Comment
+import sys
+
+headSnippet = """(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+})(window,document,'script','dataLayer','GTM-W59SWTR');"""
+
+iframeSrc = "https://www.googletagmanager.com/ns.html?id=GTM-W59SWTR"
+
+
+insert_head = "<script class='gtm'>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-W59SWTR');</script>"
+def patch_php(filepath):
+    # print(filepath)
+    try:
+        if(1):
+            f1 = open(filepath,"r")
+            lines = f1.readlines()
+            string_inserted = ''
+            for line in lines:
+                if("<script class='gtm'>" in line):
+                    return
+            f1.close()
+        if(1):
+            # print(filepath)
+            f1 = open(filepath,"r")
+            lines = f1.readlines()
+            # print(lines)
+            string_inserted = ''
+            for line in lines:
+                if('<head>' in line):
+                    line = line.split('<head>')
+                    temp_string = line[0]
+                    temp_string+='<head>\n'
+                    temp_string+=insert_head+'\n'
+                    for i in line[1:]:
+                        temp_string+=i
+                    line = temp_string
+                string_inserted+=line
+            print(string_inserted)
+            f1.close()
+            f = open(filepath,"w")
+            f.write(string_inserted)
+            f.close()
+
+    except IOError as e:
+        print "I/O error({0}): {1}".format(e.errno, e.strerror)
+        return -1
+    except:
+        print "Unexpected error:", sys.exc_info()[0]
+        return -2
+    print "Analytics Patched Successfully"
+    return 0
+
+# load the file
+def patch(filepath):
+    if("php" in filepath):
+        patch_php(filepath)
+        return 0
+    try:
+        with open(filepath) as inf:
+            txt = inf.read()
+            # soup = BeautifulSoup(txt, 'html.parser')
+            soup = BeautifulSoup(txt, "html5lib")
+        mydiv = soup.head.find('script', { 'class': 'gtm' })
+        if not mydiv:
+            scrTag = Tag(soup, name = 'script')
+            scrTag['class'] = "gtm"
+            scrTag.string = headSnippet
+            soup.head.insert(0, Comment('End Google Tag Manager'))
+            soup.head.insert(0, scrTag)
+            soup.head.insert(0, Comment('Google Tag Manager'))
+            #scrTag.insert_before(Comment('Google Tag Manager'))
+            #scrTag.insert_after(Comment('End Google Tag Manager'))
+
+            # insert body snippet into the document
+            iframeTag = Tag(soup, name = 'iframe')
+            iframeTag['src'] = iframeSrc
+            iframeTag['height'] = "0"
+            iframeTag['width'] = "0"
+            iframeTag['style'] = "display:none;visibility:hidden"
+
+            noscrTag = Tag(soup, name = 'noscript')
+            noscrTag['class'] = 'gtm'
+            noscrTag.insert(0, iframeTag)
+            soup.body.insert(0, Comment('End Google Tag Manager (noscript)'))
+            soup.body.insert(0, noscrTag)
+            soup.body.insert(0, Comment('Google Tag Manager (noscript)'))
+            #noscrTag.insert_before(Comment('Google Tag Manager (noscript)'))
+            #noscrTag.insert_after(Comment('End Google Tag Manager (noscript)'))
+
+        # save the file again
+        with open(filepath, 'w') as outf:
+            outf.write(str(soup))
+
+    except IOError as e:
+        print "I/O error({0}): {1}".format(e.errno, e.strerror)
+        return -1
+    except:
+        print "Unexpected error:", sys.exc_info()[0]
+        return -2
+    print "Analytics Patched Successfully " + filepath
+    return 0
+
+
+if __name__=='__main__':
+    patch(sys.argv[1])
diff --git a/scripts/patch-analytics.sh b/scripts/patch-analytics.sh
@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# This command applies the gtm-patcher.py script to each html and php file
+# recursively in the directory where it is executed.  As this intended
+# applying analytics code to each lab and experiment file, this script
+# should be executed in the src/ directory.
+
+# Any html file that starts with 'content' in its name, will be ignored
+# by the script as applying the script to these files breaks the page
+# structure.
+
+# The gtm-patcher.py file comes from vlabs-analytics project which
+# can be found here: https://github.com/virtual-labs/vlabs-analytics
+
+# NOTE: This command will change the src files.
+
+find . -type f \
+     \( \
+     \( -name "*.html" -or -name "*.php" \) \
+     ! -name "content*.html" \
+     \) \
+     -exec ../scripts/gtm-patcher.py {} \;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -99,4 +99,3 @@ Go to Command Terminal
		$ make theme=blue-icon

		* Now, open ui/build/index.html in the browser to test the template.