ckanext-googleanalytics_v2..../ckanext/googleanalytics/plugin/__init__.py

160 lines
4.9 KiB
Python
Raw Normal View History

2019-12-09 14:23:33 +01:00
# -*- coding: utf-8 -*-
2019-11-22 15:59:22 +01:00
from __future__ import absolute_import
2019-12-09 14:23:33 +01:00
2020-07-28 22:14:15 +02:00
from six.moves.urllib.parse import urlencode
2019-11-22 15:59:22 +01:00
import ast
import logging
2019-12-09 14:23:33 +01:00
import threading
import requests
2019-11-22 15:59:22 +01:00
import ckan.lib.helpers as h
import ckan.plugins as p
import ckan.plugins.toolkit as tk
2019-12-09 14:23:33 +01:00
2019-11-22 15:59:22 +01:00
from ckan.exceptions import CkanVersionException
2019-12-09 14:23:33 +01:00
2020-01-15 08:48:16 +01:00
DEFAULT_RESOURCE_URL_TAG = "/downloads/"
2019-11-22 15:59:22 +01:00
log = logging.getLogger(__name__)
try:
tk.requires_ckan_version("2.9")
except CkanVersionException:
2019-12-06 12:28:13 +01:00
from ckanext.googleanalytics.plugin.pylons_plugin import GAMixinPlugin
2019-11-22 15:59:22 +01:00
else:
from ckanext.googleanalytics.plugin.flask_plugin import GAMixinPlugin
class GoogleAnalyticsException(Exception):
pass
class AnalyticsPostThread(threading.Thread):
"""Threaded Url POST"""
def __init__(self, queue):
threading.Thread.__init__(self)
self.queue = queue
def run(self):
while True:
# grabs host from queue
data_dict = self.queue.get()
2020-07-28 22:14:15 +02:00
data = urlencode(data_dict)
2019-11-22 15:59:22 +01:00
log.debug("Sending API event to Google Analytics: " + data)
# send analytics
2019-12-06 12:28:13 +01:00
res = requests.post(
"http://www.google-analytics.com/collect",
data,
timeout=10,
2019-11-22 15:59:22 +01:00
)
# signals to queue job is done
self.queue.task_done()
class GoogleAnalyticsPlugin(GAMixinPlugin, p.SingletonPlugin):
p.implements(p.IConfigurable, inherit=True)
p.implements(p.IConfigurer, inherit=True)
p.implements(p.ITemplateHelpers)
def configure(self, config):
"""Load config settings for this extension from config file.
See IConfigurable.
"""
if "googleanalytics.id" not in config:
msg = "Missing googleanalytics.id in config"
raise GoogleAnalyticsException(msg)
self.googleanalytics_id = config["googleanalytics.id"]
self.googleanalytics_domain = config.get(
"googleanalytics.domain", "auto"
)
self.googleanalytics_fields = ast.literal_eval(
config.get("googleanalytics.fields", "{}")
)
googleanalytics_linked_domains = config.get(
"googleanalytics.linked_domains", ""
)
self.googleanalytics_linked_domains = [
x.strip() for x in googleanalytics_linked_domains.split(",") if x
]
if self.googleanalytics_linked_domains:
self.googleanalytics_fields["allowLinker"] = "true"
# If resource_prefix is not in config file then write the default value
# to the config dict, otherwise templates seem to get 'true' when they
# try to read resource_prefix from config.
if "googleanalytics_resource_prefix" not in config:
config[
"googleanalytics_resource_prefix"
2020-01-15 08:48:16 +01:00
] = DEFAULT_RESOURCE_URL_TAG
2019-11-22 15:59:22 +01:00
self.googleanalytics_resource_prefix = config[
"googleanalytics_resource_prefix"
]
2019-12-09 14:23:33 +01:00
self.show_downloads = tk.asbool(
2019-11-22 15:59:22 +01:00
config.get("googleanalytics.show_downloads", True)
)
2019-12-09 14:23:33 +01:00
self.track_events = tk.asbool(
2019-11-22 15:59:22 +01:00
config.get("googleanalytics.track_events", False)
)
2019-12-09 14:23:33 +01:00
self.enable_user_id = tk.asbool(
2019-11-22 15:59:22 +01:00
config.get("googleanalytics.enable_user_id", False)
)
2019-12-09 14:23:33 +01:00
p.toolkit.add_resource("../assets", "ckanext-googleanalytics")
2019-11-22 15:59:22 +01:00
2019-12-09 14:23:33 +01:00
# spawn a pool of 5 threads, and pass them queue instance
2019-11-22 15:59:22 +01:00
for i in range(5):
t = AnalyticsPostThread(self.analytics_queue)
t.setDaemon(True)
t.start()
def update_config(self, config):
"""Change the CKAN (Pylons) environment configuration.
See IConfigurer.
"""
2019-12-09 14:23:33 +01:00
p.toolkit.add_template_directory(config, "../templates")
2019-11-22 15:59:22 +01:00
def get_helpers(self):
"""Return the CKAN 2.0 template helper functions this plugin provides.
See ITemplateHelpers.
"""
return {"googleanalytics_header": self.googleanalytics_header}
def googleanalytics_header(self):
"""Render the googleanalytics_header snippet for CKAN 2.0 templates.
This is a template helper function that renders the
googleanalytics_header jinja snippet. To be called from the jinja
templates in this extension, see ITemplateHelpers.
"""
if self.enable_user_id and tk.c.user:
self.googleanalytics_fields["userId"] = str(tk.c.userobj.id)
data = {
"googleanalytics_id": self.googleanalytics_id,
"googleanalytics_domain": self.googleanalytics_domain,
"googleanalytics_fields": str(self.googleanalytics_fields),
"googleanalytics_linked_domains": self.googleanalytics_linked_domains,
}
2023-06-12 15:36:10 +02:00
#return p.toolkit.render_snippet(
# "googleanalytics/snippets/googleanalytics_header.html", data
#)
# Updated to GA4 #25196
2019-11-22 15:59:22 +01:00
return p.toolkit.render_snippet(
2023-06-12 15:36:10 +02:00
"googleanalytics/snippets/gtag_header.html", data
2019-11-22 15:59:22 +01:00
)