ckanext-googleanalytics/ckanext/googleanalytics/views.py

# -*- coding: utf-8 -*-

import hashlib
import logging
import six

from flask import Blueprint

import ckan.plugins.toolkit as tk
import ckan.views.api as api
import ckan.views.resource as resource

from ckan.common import g
from ckan.plugins import PluginImplementations

from ckanext.googleanalytics import utils, config, interfaces

log = logging.getLogger(__name__)
ga = Blueprint("google_analytics", "google_analytics")


def action(logic_function, ver=api.API_MAX_VERSION):
    try:
        function = tk.get_action(logic_function)
        side_effect_free = getattr(function, "side_effect_free", False)
        request_data = api._get_request_data(try_url_params=side_effect_free)
        if isinstance(request_data, dict):
            id = request_data.get("id", "")
            if "q" in request_data:
                id = request_data["q"]
            if "query" in request_data:
                id = request_data[u"query"]
            _post_analytics(g.user, utils.EVENT_API, logic_function, "", id, request_data)
    except Exception as e:
        log.debug(e)
        pass

    return api.action(logic_function, ver)


ga.add_url_rule(
    "/api/action/<logic_function>",
    methods=["GET", "POST"],
    view_func=action,
)
ga.add_url_rule(
    "/api/<int(min=3, max={0}):ver>/action/<logic_function>".format(
        api.API_MAX_VERSION
    ),
    methods=["GET", "POST"],
    view_func=action,
)


def download(id, resource_id, filename=None, package_type="dataset"):
    handler = config.download_handler()
    if not handler:
        log.debug("Use default CKAN callback for resource.download")
        handler = resource.download
    _post_analytics(
        g.user,
        "CKAN Resource Download Request",
        "Resource",
        "Download",
        resource_id,
    )
    return handler(
        package_type=package_type,
        id=id,
        resource_id=resource_id,
        filename=filename,
    )


ga.add_url_rule(
    "/dataset/<id>/resource/<resource_id>/download", view_func=download
)
ga.add_url_rule(
    "/dataset/<id>/resource/<resource_id>/download/<filename>",
    view_func=download,
)


def _post_analytics(
        user, event_type,
        request_obj_type, request_function,
        request_id, request_payload=None
):

    from ckanext.googleanalytics.plugin import GoogleAnalyticsPlugin

    if config.tracking_id():
        if config.measurement_protocol_client_id() and event_type == utils.EVENT_API:
            data_dict = utils.MeasurementProtocolData({
                "event": event_type,
                "object": request_obj_type,
                "function": request_function,
                "id": request_id,
                "payload": request_payload,
            })
        else:
            data_dict = utils.UniversalAnalyticsData({
                "v": 1,
                "tid": config.tracking_id(),
                "cid": hashlib.md5(six.ensure_binary(tk.c.user)).hexdigest(),
                # customer id should be obfuscated
                "t": "event",
                "dh": tk.request.environ["HTTP_HOST"],
                "dp": tk.request.environ["PATH_INFO"],
                "dr": tk.request.environ.get("HTTP_REFERER", ""),
                "ec": event_type,
                "ea": request_obj_type + request_function,
                "el": request_id,
            })

        for p in PluginImplementations(interfaces.IGoogleAnalytics):
            if p.googleanalytics_skip_event(data_dict):
                return

        GoogleAnalyticsPlugin.analytics_queue.put(data_dict)