Skip to content

Inject trackingcode #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
+60 −0
Open

Inject trackingcode #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f83916
adding new section "user_tracking" to settings with one variable JS_CODE
sjanssen2 Jun 21, 2024
89d34b6
inject tracking code if JS_CODE in user_tracking section of settings …
sjanssen2 Jun 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions qiita_core/configuration_manager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,11 @@ class ConfigurationManager(object):
The email address a user should write to when asking for help
sysadmin_email : str
The email address, Qiita sends internal notifications to a sys admin
tracking_js_code : str
You might want to track user on your Qiita instance. The content of the
JS_CODE variable will inject this JavaScript code to the sitebase.html
template, which means it will be added to basically every page of
Qiita.

Raises
------
Expand Down Expand Up @@ -162,6 +167,7 @@ def __init__(self):
self._get_vamps(config)
self._get_portal(config)
self._iframe(config)
self._get_tracking(config)

def _get_main(self, config):
"""Get the configuration of the main section"""
Expand Down Expand Up @@ -390,3 +396,11 @@ def _get_portal(self, config):

def _iframe(self, config):
self.iframe_qiimp = config.get('iframe', 'QIIMP', fallback=None)

def _get_tracking(self, config):
"""Get the configuration of the 'user_tracking' section"""

self.tracking_js_code = config.get(
'user_tracking', 'JS_CODE', fallback=None)
if not self.tracking_js_code:
self.tracking_js_code = None
7 changes: 7 additions & 0 deletions qiita_core/support_files/config_test.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,3 +196,10 @@ STATS_MAP_CENTER_LONGITUDE =
# On May 2024, we removed QIIMP from the code base but we will leave this
# section in case we need to add access to another iframe in the future; note
# that the qiita-terms are also accessed via iframe but this is internal

# ----------------------------- User tracking Settings ---------------------
[user_tracking]
# You might want to track user on your Qiita instance. You can here inject
# JavaScript code to the sitebase.html template, which means it will be added
# to basically every page of Qiita.
JS_CODE =
36 changes: 36 additions & 0 deletions qiita_core/tests/test_configuration_manager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,23 @@ def test_get_portal_latlong(self):
obs._get_portal(self.conf)
self.assertEqual(obs.stats_map_center_longitude, -105.24827)

def test_get_tracking(self):
obs = ConfigurationManager()

# test for multi line content
self.assertTrue(len(obs.tracking_js_code) > 520)
self.assertIn("['setTrackerUrl'", obs.tracking_js_code)

# test that None is returned, if JS_CODE in config file, but not set
self.conf.set('user_tracking', 'JS_CODE', "")
obs._get_tracking(self.conf)
self.assertEqual(obs.tracking_js_code, None)

# test that if JS_CODE is not in config file, result in None
self.conf.remove_option('user_tracking', 'JS_CODE')
obs._get_tracking(self.conf)
self.assertEqual(obs.tracking_js_code, None)


CONF = """
# ------------------------------ Main settings --------------------------------
Expand Down Expand Up @@ -471,6 +488,25 @@ def test_get_portal_latlong(self):

# ----------------------------- iframes settings ---------------------------
[iframe]
# ----------------------------- User tracking Settings ---------------------
[user_tracking]
# You might want to track user on your Qiita instance. You can here inject
# JavaScript code to the sitebase.html template, which means it will be added
# to basically every page of Qiita.
JS_CODE = <!-- Matomo --><script>var _paq = window._paq = window._paq || [];
/* tracker methods like "setCustomDimension" should be called before
"trackPageView" */
_paq.push(['trackPageView']);_paq.push(['enableLinkTracking']);
(function() {var u="https://piwik.cebitec.uni-bielefeld.de/";_
paq.push(['setTrackerUrl', u+'matomo.php']);_
paq.push(['setSiteId', '21']);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName(
'script')[0];
g.async=true;
g.src=u+'matomo.js';
s.parentNode.insertBefore(g,s);})();
</script><!-- End Matomo Code -->

"""

if __name__ == '__main__':
Expand Down
3 changes: 3 additions & 0 deletions qiita_pet/templates/sitebase.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,9 @@
</head>

<body style="padding-top: 70px; height: 100%" onload='overlay_check();'>
{% if qiita_config.tracking_js_code is not None %}
{% raw qiita_config.tracking_js_code %}
{% end %}

<div id="qiita-main" class="qiita-main">
<div id="navigation-bar" class="navbar navbar-default navbar-inverse navbar-fixed-top">
Expand Down
Loading