| *.py[co] | *.py[co] |
| *.py~ | *.py~ |
| .gitignore | .gitignore |
| ckan.log | |
| # Packages | # Packages |
| *.egg | *.egg |
| *.egg-info | *.egg-info |
| dist | dist |
| build | build |
| eggs | eggs |
| parts | parts |
| bin | bin |
| var | var |
| sdist | sdist |
| develop-eggs | develop-eggs |
| .installed.cfg | .installed.cfg |
| # Private info | # Private info |
| credentials.json | credentials.json |
| token.dat | token.dat |
| # Installer logs | # Installer logs |
| pip-log.txt | pip-log.txt |
| # Unit test / coverage reports | # Unit test / coverage reports |
| .coverage | .coverage |
| .tox | .tox |
| #Translations | #Translations |
| *.mo | *.mo |
| #Mr Developer | #Mr Developer |
| .mr.developer.cfg | .mr.developer.cfg |
| import re | import re |
| import csv | import csv |
| import sys | import sys |
| import logging | import logging |
| import operator | import operator |
| import collections | import collections |
| from ckan.lib.base import (BaseController, c, g, render, request, response, abort) | from ckan.lib.base import (BaseController, c, g, render, request, response, abort) |
| import sqlalchemy | import sqlalchemy |
| from sqlalchemy import func, cast, Integer | from sqlalchemy import func, cast, Integer |
| import ckan.model as model | import ckan.model as model |
| from ga_model import GA_Url, GA_Stat, GA_ReferralStat, GA_Publisher | from ga_model import GA_Url, GA_Stat, GA_ReferralStat, GA_Publisher |
| log = logging.getLogger('ckanext.ga-report') | log = logging.getLogger('ckanext.ga-report') |
| def _get_month_name(strdate): | def _get_month_name(strdate): |
| import calendar | import calendar |
| from time import strptime | from time import strptime |
| d = strptime(strdate, '%Y-%m') | d = strptime(strdate, '%Y-%m') |
| return '%s %s' % (calendar.month_name[d.tm_mon], d.tm_year) | return '%s %s' % (calendar.month_name[d.tm_mon], d.tm_year) |
| def _month_details(cls): | def _month_details(cls): |
| ''' | ''' |
| Returns a list of all the periods for which we have data, unfortunately | Returns a list of all the periods for which we have data, unfortunately |
| knows too much about the type of the cls being passed as GA_Url has a | knows too much about the type of the cls being passed as GA_Url has a |
| more complex query | more complex query |
| This may need extending if we add a period_name to the stats | This may need extending if we add a period_name to the stats |
| ''' | ''' |
| months = [] | months = [] |
| day = None | day = None |
| vals = model.Session.query(cls.period_name,cls.period_complete_day)\ | vals = model.Session.query(cls.period_name,cls.period_complete_day)\ |
| .filter(cls.period_name!='All').distinct(cls.period_name)\ | .filter(cls.period_name!='All').distinct(cls.period_name)\ |
| .order_by("period_name desc").all() | .order_by("period_name desc").all() |
| if vals and vals[0][1]: | if vals and vals[0][1]: |
| day = int(vals[0][1]) | day = int(vals[0][1]) |
| ordinal = 'th' if 11 <= day <= 13 \ | ordinal = 'th' if 11 <= day <= 13 \ |
| else {1:'st',2:'nd',3:'rd'}.get(day % 10, 'th') | else {1:'st',2:'nd',3:'rd'}.get(day % 10, 'th') |
| day = "{day}{ordinal}".format(day=day, ordinal=ordinal) | day = "{day}{ordinal}".format(day=day, ordinal=ordinal) |
| for m in vals: | for m in vals: |
| months.append( (m[0], _get_month_name(m[0]))) | months.append( (m[0], _get_month_name(m[0]))) |
| return months, day | return months, day |
| class GaReport(BaseController): | class GaReport(BaseController): |
| def csv(self, month): | def csv(self, month): |
| import csv | import csv |
| q = model.Session.query(GA_Stat) | q = model.Session.query(GA_Stat).filter(GA_Stat.stat_name!='Downloads') |
| if month != 'all': | if month != 'all': |
| q = q.filter(GA_Stat.period_name==month) | q = q.filter(GA_Stat.period_name==month) |
| entries = q.order_by('GA_Stat.period_name, GA_Stat.stat_name, GA_Stat.key').all() | entries = q.order_by('GA_Stat.period_name, GA_Stat.stat_name, GA_Stat.key').all() |
| response.headers['Content-Type'] = "text/csv; charset=utf-8" | response.headers['Content-Type'] = "text/csv; charset=utf-8" |
| response.headers['Content-Disposition'] = str('attachment; filename=stats_%s.csv' % (month,)) | response.headers['Content-Disposition'] = str('attachment; filename=stats_%s.csv' % (month,)) |
| writer = csv.writer(response) | writer = csv.writer(response) |
| writer.writerow(["Period", "Statistic", "Key", "Value"]) | writer.writerow(["Period", "Statistic", "Key", "Value"]) |
| for entry in entries: | for entry in entries: |
| writer.writerow([entry.period_name.encode('utf-8'), | writer.writerow([entry.period_name.encode('utf-8'), |
| entry.stat_name.encode('utf-8'), | entry.stat_name.encode('utf-8'), |
| entry.key.encode('utf-8'), | entry.key.encode('utf-8'), |
| entry.value.encode('utf-8')]) | entry.value.encode('utf-8')]) |
| def csv_downloads(self, month): | |
| import csv | |
| q = model.Session.query(GA_Stat).filter(GA_Stat.stat_name=='Downloads') | |
| if month != 'all': | |
| q = q.filter(GA_Stat.period_name==month) | |
| entries = q.order_by('GA_Stat.period_name, GA_Stat.key').all() | |
| response.headers['Content-Type'] = "text/csv; charset=utf-8" | |
| response.headers['Content-Disposition'] = str('attachment; filename=downloads_%s.csv' % (month,)) | |
| writer = csv.writer(response) | |
| writer.writerow(["Period", "Resource URL", "Count"]) | |
| for entry in entries: | |
| writer.writerow([entry.period_name.encode('utf-8'), | |
| entry.key.encode('utf-8'), | |
| entry.value.encode('utf-8')]) | |
| def index(self): | def index(self): |
| # Get the month details by fetching distinct values and determining the | # Get the month details by fetching distinct values and determining the |
| # month names from the values. | # month names from the values. |
| c.months, c.day = _month_details(GA_Stat) | c.months, c.day = _month_details(GA_Stat) |
| # Work out which month to show, based on query params of the first item | # Work out which month to show, based on query params of the first item |
| c.month_desc = 'all months' | c.month_desc = 'all months' |
| c.month = request.params.get('month', '') | c.month = request.params.get('month', '') |
| if c.month: | if c.month: |
| c.month_desc = ''.join([m[1] for m in c.months if m[0]==c.month]) | c.month_desc = ''.join([m[1] for m in c.months if m[0]==c.month]) |
| q = model.Session.query(GA_Stat).\ | q = model.Session.query(GA_Stat).\ |
| filter(GA_Stat.stat_name=='Totals') | filter(GA_Stat.stat_name=='Totals') |
| if c.month: | if c.month: |
| q = q.filter(GA_Stat.period_name==c.month) | q = q.filter(GA_Stat.period_name==c.month) |
| entries = q.order_by('ga_stat.key').all() | entries = q.order_by('ga_stat.key').all() |
| def clean_key(key, val): | def clean_key(key, val): |
| if key in ['Average time on site', 'Pages per visit', 'New visits', 'Bounce rate (home page)']: | if key in ['Average time on site', 'Pages per visit', 'New visits', 'Bounce rate (home page)']: |
| val = "%.2f" % round(float(val), 2) | val = "%.2f" % round(float(val), 2) |
| if key == 'Average time on site': | if key == 'Average time on site': |
| mins, secs = divmod(float(val), 60) | mins, secs = divmod(float(val), 60) |
| hours, mins = divmod(mins, 60) | hours, mins = divmod(mins, 60) |
| val = '%02d:%02d:%02d (%s seconds) ' % (hours, mins, secs, val) | val = '%02d:%02d:%02d (%s seconds) ' % (hours, mins, secs, val) |
| if key in ['New visits','Bounce rate (home page)']: | if key in ['New visits','Bounce rate (home page)']: |
| val = "%s%%" % val | val = "%s%%" % val |
| if key in ['Total page views', 'Total visits']: | if key in ['Total page views', 'Total visits']: |
| val = int(val) | val = int(val) |
| return key, val | return key, val |
| c.global_totals = [] | c.global_totals = [] |
| if c.month: | if c.month: |
| for e in entries: | for e in entries: |
| key, val = clean_key(e.key, e.value) | key, val = clean_key(e.key, e.value) |
| c.global_totals.append((key, val)) | c.global_totals.append((key, val)) |
| else: | else: |
| d = collections.defaultdict(list) | d = collections.defaultdict(list) |
| for e in entries: | for e in entries: |
| d[e.key].append(float(e.value)) | d[e.key].append(float(e.value)) |
| for k, v in d.iteritems(): | for k, v in d.iteritems(): |
| if k in ['Total page views', 'Total visits']: | if k in ['Total page views', 'Total visits']: |
| v = sum(v) | v = sum(v) |
| else: | else: |
| v = float(sum(v))/float(len(v)) | v = float(sum(v))/float(len(v)) |
| key, val = clean_key(k,v) | key, val = clean_key(k,v) |
| c.global_totals.append((key, val)) | c.global_totals.append((key, val)) |
| c.global_totals = sorted(c.global_totals, key=operator.itemgetter(0)) | c.global_totals = sorted(c.global_totals, key=operator.itemgetter(0)) |
| keys = { | keys = { |
| 'Browser versions': 'browser_versions', | 'Browser versions': 'browser_versions', |
| 'Browsers': 'browsers', | 'Browsers': 'browsers', |
| 'Operating Systems versions': 'os_versions', | 'Operating Systems versions': 'os_versions', |
| 'Operating Systems': 'os', | 'Operating Systems': 'os', |
| 'Social sources': 'social_networks', | 'Social sources': 'social_networks', |
| 'Languages': 'languages', | 'Languages': 'languages', |
| 'Country': 'country' | 'Country': 'country' |
| } | } |
| def shorten_name(name, length=60): | def shorten_name(name, length=60): |
| return (name[:length] + '..') if len(name) > 60 else name | return (name[:length] + '..') if len(name) > 60 else name |
| def fill_out_url(url): | def fill_out_url(url): |
| import urlparse | import urlparse |
| return urlparse.urljoin(g.site_url, url) | return urlparse.urljoin(g.site_url, url) |
| c.social_referrer_totals, c.social_referrers = [], [] | c.social_referrer_totals, c.social_referrers = [], [] |
| q = model.Session.query(GA_ReferralStat) | q = model.Session.query(GA_ReferralStat) |
| q = q.filter(GA_ReferralStat.period_name==c.month) if c.month else q | q = q.filter(GA_ReferralStat.period_name==c.month) if c.month else q |
| q = q.order_by('ga_referrer.count::int desc') | q = q.order_by('ga_referrer.count::int desc') |
| for entry in q.all(): | for entry in q.all(): |
| c.social_referrers.append((shorten_name(entry.url), fill_out_url(entry.url), | c.social_referrers.append((shorten_name(entry.url), fill_out_url(entry.url), |
| entry.source,entry.count)) | entry.source,entry.count)) |
| q = model.Session.query(GA_ReferralStat.url, | q = model.Session.query(GA_ReferralStat.url, |
| func.sum(GA_ReferralStat.count).label('count')) | func.sum(GA_ReferralStat.count).label('count')) |
| q = q.filter(GA_ReferralStat.period_name==c.month) if c.month else q | q = q.filter(GA_ReferralStat.period_name==c.month) if c.month else q |
| q = q.order_by('count desc').group_by(GA_ReferralStat.url) | q = q.order_by('count desc').group_by(GA_ReferralStat.url) |
| for entry in q.all(): | for entry in q.all(): |
| c.social_referrer_totals.append((shorten_name(entry[0]), fill_out_url(entry[0]),'', | c.social_referrer_totals.append((shorten_name(entry[0]), fill_out_url(entry[0]),'', |
| entry[1])) | entry[1])) |
| for k, v in keys.iteritems(): | for k, v in keys.iteritems(): |
| q = model.Session.query(GA_Stat).\ | q = model.Session.query(GA_Stat).\ |
| filter(GA_Stat.stat_name==k) | filter(GA_Stat.stat_name==k) |
| if c.month: | if c.month: |
| entries = [] | entries = [] |
| q = q.filter(GA_Stat.period_name==c.month).\ | q = q.filter(GA_Stat.period_name==c.month).\ |
| order_by('ga_stat.value::int desc') | order_by('ga_stat.value::int desc') |
| d = collections.defaultdict(int) | d = collections.defaultdict(int) |
| for e in q.all(): | for e in q.all(): |
| d[e.key] += int(e.value) | d[e.key] += int(e.value) |
| entries = [] | entries = [] |
| for key, val in d.iteritems(): | for key, val in d.iteritems(): |
| entries.append((key,val,)) | entries.append((key,val,)) |
| entries = sorted(entries, key=operator.itemgetter(1), reverse=True) | entries = sorted(entries, key=operator.itemgetter(1), reverse=True) |
| # Get the total for each set of values and then set the value as | # Get the total for each set of values and then set the value as |
| # a percentage of the total | # a percentage of the total |
| if k == 'Social sources': | if k == 'Social sources': |
| total = sum([x for n,x in c.global_totals if n == 'Total visits']) | total = sum([x for n,x in c.global_totals if n == 'Total visits']) |
| else: | else: |
| total = sum([num for _,num in entries]) | total = sum([num for _,num in entries]) |
| setattr(c, v, [(k,_percent(v,total)) for k,v in entries ]) | setattr(c, v, [(k,_percent(v,total)) for k,v in entries ]) |
| return render('ga_report/site/index.html') | return render('ga_report/site/index.html') |
| def downloads(self): | |
| # Get the month details by fetching distinct values and determining the | |
| # month names from the values. | |
| c.months, c.day = _month_details(GA_Stat) | |
| # Work out which month to show, based on query params of the first item | |
| c.month_desc = 'all months' | |
| c.month = request.params.get('month', '') | |
| if c.month: | |
| c.month_desc = ''.join([m[1] for m in c.months if m[0]==c.month]) | |
| c.downloads = [] | |
| q = model.Session.query(GA_Stat).filter(GA_Stat.stat_name=='Downloads') | |
| q = q.filter(GA_Stat.period_name==c.month) if c.month else q | |
| q = q.order_by("ga_stat.value::int desc") | |
| for entry in q.all(): | |
| print entry.key | |
| r = model.Session.query(model.Resource).filter(model.Resource.url==entry.key).first() | |
| if r: | |
| c.downloads.append((r,entry.value)) | |
| else: | |
| log.info("Failed to find resource for %s" % entry.key) | |
| return render('ga_report/site/downloads.html') | |
| class GaDatasetReport(BaseController): | class GaDatasetReport(BaseController): |
| """ | """ |
| Displays the pageview and visit count for datasets | Displays the pageview and visit count for datasets |
| with options to filter by publisher and time period. | with options to filter by publisher and time period. |
| """ | """ |
| def publisher_csv(self, month): | def publisher_csv(self, month): |
| ''' | ''' |
| Returns a CSV of each publisher with the total number of dataset | Returns a CSV of each publisher with the total number of dataset |
| views & visits. | views & visits. |
| ''' | ''' |
| c.month = month if not month == 'all' else '' | c.month = month if not month == 'all' else '' |
| response.headers['Content-Type'] = "text/csv; charset=utf-8" | response.headers['Content-Type'] = "text/csv; charset=utf-8" |
| response.headers['Content-Disposition'] = str('attachment; filename=publishers_%s.csv' % (month,)) | response.headers['Content-Disposition'] = str('attachment; filename=publishers_%s.csv' % (month,)) |
| writer = csv.writer(response) | writer = csv.writer(response) |
| writer.writerow(["Publisher Title", "Publisher Name", "Views", "Visits", "Period Name"]) | writer.writerow(["Publisher Title", "Publisher Name", "Views", "Visits", "Period Name"]) |
| for publisher,view,visit in _get_top_publishers(None): | for publisher,view,visit in _get_top_publishers(None): |
| writer.writerow([publisher.title.encode('utf-8'), | writer.writerow([publisher.title.encode('utf-8'), |
| publisher.name.encode('utf-8'), | publisher.name.encode('utf-8'), |
| view, | view, |
| visit, | visit, |
| month]) | month]) |
| def dataset_csv(self, id='all', month='all'): | def dataset_csv(self, id='all', month='all'): |
| ''' | ''' |
| Returns a CSV with the number of views & visits for each dataset. | Returns a CSV with the number of views & visits for each dataset. |
| :param id: A Publisher ID or None if you want for all | :param id: A Publisher ID or None if you want for all |
| :param month: The time period, or 'all' | :param month: The time period, or 'all' |
| ''' | ''' |
| c.month = month if not month == 'all' else '' | c.month = month if not month == 'all' else '' |
| if id != 'all': | if id != 'all': |
| c.publisher = model.Group.get(id) | c.publisher = model.Group.get(id) |
| if not c.publisher: | if not c.publisher: |
| abort(404, 'A publisher with that name could not be found') | abort(404, 'A publisher with that name could not be found') |
| packages = self._get_packages(c.publisher) | packages = self._get_packages(c.publisher) |
| response.headers['Content-Type'] = "text/csv; charset=utf-8" | response.headers['Content-Type'] = "text/csv; charset=utf-8" |
| response.headers['Content-Disposition'] = \ | response.headers['Content-Disposition'] = \ |
| str('attachment; filename=datasets_%s_%s.csv' % (c.publisher_name, month,)) | str('attachment; filename=datasets_%s_%s.csv' % (c.publisher_name, month,)) |
| writer = csv.writer(response) | writer = csv.writer(response) |
| writer.writerow(["Dataset Title", "Dataset Name", "Views", "Visits", "Period Name"]) | writer.writerow(["Dataset Title", "Dataset Name", "Views", "Visits", "Period Name"]) |
| for package,view,visit in packages: | for package,view,visit in packages: |
| writer.writerow([package.title.encode('utf-8'), | writer.writerow([package.title.encode('utf-8'), |
| package.name.encode('utf-8'), | package.name.encode('utf-8'), |
| view, | view, |
| visit, | visit, |
| month]) | month]) |
| def publishers(self): | def publishers(self): |
| '''A list of publishers and the number of views/visits for each''' | '''A list of publishers and the number of views/visits for each''' |
| # Get the month details by fetching distinct values and determining the | # Get the month details by fetching distinct values and determining the |
| # month names from the values. | # month names from the values. |
| c.months, c.day = _month_details(GA_Url) | c.months, c.day = _month_details(GA_Url) |
| # Work out which month to show, based on query params of the first item | # Work out which month to show, based on query params of the first item |
| c.month = request.params.get('month', '') | c.month = request.params.get('month', '') |
| c.month_desc = 'all months' | c.month_desc = 'all months' |
| if c.month: | if c.month: |
| c.month_desc = ''.join([m[1] for m in c.months if m[0]==c.month]) | c.month_desc = ''.join([m[1] for m in c.months if m[0]==c.month]) |
| c.top_publishers = _get_top_publishers() | c.top_publishers = _get_top_publishers() |
| return render('ga_report/publisher/index.html') | return render('ga_report/publisher/index.html') |
| def _get_packages(self, publisher=None, count=-1): | def _get_packages(self, publisher=None, count=-1): |
| '''Returns the datasets in order of views''' | '''Returns the datasets in order of views''' |
| if count == -1: | if count == -1: |
| count = sys.maxint | count = sys.maxint |
| month = c.month or 'All' | month = c.month or 'All' |
| q = model.Session.query(GA_Url,model.Package)\ | q = model.Session.query(GA_Url,model.Package)\ |
| .filter(model.Package.name==GA_Url.package_id)\ | .filter(model.Package.name==GA_Url.package_id)\ |
| .filter(GA_Url.url.like('/dataset/%')) | .filter(GA_Url.url.like('/dataset/%')) |
| if publisher: | if publisher: |
| q = q.filter(GA_Url.department_id==publisher.name) | q = q.filter(GA_Url.department_id==publisher.name) |
| q = q.filter(GA_Url.period_name==month) | q = q.filter(GA_Url.period_name==month) |
| q = q.order_by('ga_url.pageviews::int desc') | q = q.order_by('ga_url.pageviews::int desc') |
| top_packages = [] | top_packages = [] |
| for entry,package in q.limit(count): | for entry,package in q.limit(count): |
| if package: | if package: |
| top_packages.append((package, entry.pageviews, entry.visits)) | top_packages.append((package, entry.pageviews, entry.visits)) |
| else: | else: |
| log.warning('Could not find package associated package') | log.warning('Could not find package associated package') |
| return top_packages | return top_packages |
| def read(self): | def read(self): |
| ''' | ''' |
| Lists the most popular datasets across all publishers | Lists the most popular datasets across all publishers |
| ''' | ''' |
| return self.read_publisher(None) | return self.read_publisher(None) |
| def read_publisher(self, id): | def read_publisher(self, id): |
| ''' | ''' |
| Lists the most popular datasets for a publisher (or across all publishers) | Lists the most popular datasets for a publisher (or across all publishers) |
| ''' | ''' |
| count = 20 | count = 20 |
| c.publishers = _get_publishers() | c.publishers = _get_publishers() |
| id = request.params.get('publisher', id) | id = request.params.get('publisher', id) |
| if id and id != 'all': | if id and id != 'all': |
| c.publisher = model.Group.get(id) | c.publisher = model.Group.get(id) |
| if not c.publisher: | if not c.publisher: |
| abort(404, 'A publisher with that name could not be found') | abort(404, 'A publisher with that name could not be found') |
| c.publisher_name = c.publisher.name | c.publisher_name = c.publisher.name |
| c.top_packages = [] # package, dataset_views in c.top_packages | c.top_packages = [] # package, dataset_views in c.top_packages |
| # Get the month details by fetching distinct values and determining the | # Get the month details by fetching distinct values and determining the |
| # month names from the values. | # month names from the values. |
| c.months, c.day = _month_details(GA_Url) | c.months, c.day = _month_details(GA_Url) |
| # Work out which month to show, based on query params of the first item | # Work out which month to show, based on query params of the first item |
| c.month = request.params.get('month', '') | c.month = request.params.get('month', '') |
| if not c.month: | if not c.month: |
| c.month_desc = 'all months' | c.month_desc = 'all months' |
| else: | else: |
| c.month_desc = ''.join([m[1] for m in c.months if m[0]==c.month]) | c.month_desc = ''.join([m[1] for m in c.months if m[0]==c.month]) |
| month = c.month or 'All' | month = c.month or 'All' |
| c.publisher_page_views = 0 | c.publisher_page_views = 0 |
| q = model.Session.query(GA_Url).\ | q = model.Session.query(GA_Url).\ |
| filter(GA_Url.url=='/publisher/%s' % c.publisher_name) | filter(GA_Url.url=='/publisher/%s' % c.publisher_name) |
| entry = q.filter(GA_Url.period_name==c.month).first() | entry = q.filter(GA_Url.period_name==c.month).first() |
| c.publisher_page_views = entry.pageviews if entry else 0 | c.publisher_page_views = entry.pageviews if entry else 0 |
| c.top_packages = self._get_packages(c.publisher, 20) | c.top_packages = self._get_packages(c.publisher, 20) |
| return render('ga_report/publisher/read.html') | return render('ga_report/publisher/read.html') |
| def _get_top_publishers(limit=20): | def _get_top_publishers(limit=20): |
| ''' | ''' |
| Returns a list of the top 20 publishers by dataset visits. | Returns a list of the top 20 publishers by dataset visits. |
| (The number to show can be varied with 'limit') | (The number to show can be varied with 'limit') |
| ''' | ''' |
| month = c.month or 'All' | month = c.month or 'All' |
| connection = model.Session.connection() | connection = model.Session.connection() |
| q = """ | q = """ |
| select department_id, sum(pageviews::int) views, sum(visits::int) visits | select department_id, sum(pageviews::int) views, sum(visits::int) visits |
| from ga_url | from ga_url |
| where department_id <> '' | where department_id <> '' |
| and package_id <> '' | and package_id <> '' |
| and url like '/dataset/%%' | and url like '/dataset/%%' |
| and period_name=%s | and period_name=%s |
| group by department_id order by views desc | group by department_id order by views desc |
| """ | """ |
| if limit: | if limit: |
| q = q + " limit %s;" % (limit) | q = q + " limit %s;" % (limit) |
| top_publishers = [] | top_publishers = [] |
| res = connection.execute(q, month) | res = connection.execute(q, month) |
| for row in res: | for row in res: |
| g = model.Group.get(row[0]) | g = model.Group.get(row[0]) |
| if g: | if g: |
| top_publishers.append((g, row[1], row[2])) | top_publishers.append((g, row[1], row[2])) |
| return top_publishers | return top_publishers |
| def _get_publishers(): | def _get_publishers(): |
| ''' | ''' |
| Returns a list of all publishers. Each item is a tuple: | Returns a list of all publishers. Each item is a tuple: |
| (name, title) | (name, title) |
| ''' | ''' |
| publishers = [] | publishers = [] |
| for pub in model.Session.query(model.Group).\ | for pub in model.Session.query(model.Group).\ |
| filter(model.Group.type=='publisher').\ | filter(model.Group.type=='publisher').\ |
| filter(model.Group.state=='active').\ | filter(model.Group.state=='active').\ |
| order_by(model.Group.name): | order_by(model.Group.name): |
| publishers.append((pub.name, pub.title)) | publishers.append((pub.name, pub.title)) |
| return publishers | return publishers |
| def _percent(num, total): | def _percent(num, total): |
| p = 100 * float(num)/float(total) | p = 100 * float(num)/float(total) |
| return "%.2f%%" % round(p, 2) | return "%.2f%%" % round(p, 2) |
| import os | import os |
| import logging | import logging |
| import datetime | import datetime |
| import collections | import collections |
| from pylons import config | from pylons import config |
| from ga_model import _normalize_url | from ga_model import _normalize_url |
| import ga_model | import ga_model |
| #from ga_client import GA | #from ga_client import GA |
| log = logging.getLogger('ckanext.ga-report') | log = logging.getLogger('ckanext.ga-report') |
| FORMAT_MONTH = '%Y-%m' | FORMAT_MONTH = '%Y-%m' |
| MIN_VIEWS = 50 | MIN_VIEWS = 50 |
| MIN_VISITS = 20 | MIN_VISITS = 20 |
| MIN_DOWNLOADS = 10 | |
| class DownloadAnalytics(object): | class DownloadAnalytics(object): |
| '''Downloads and stores analytics info''' | '''Downloads and stores analytics info''' |
| def __init__(self, service=None, profile_id=None, delete_first=False, | def __init__(self, service=None, profile_id=None, delete_first=False, |
| skip_url_stats=False): | skip_url_stats=False): |
| self.period = config['ga-report.period'] | self.period = config['ga-report.period'] |
| self.service = service | self.service = service |
| self.profile_id = profile_id | self.profile_id = profile_id |
| self.delete_first = delete_first | self.delete_first = delete_first |
| self.skip_url_stats = skip_url_stats | self.skip_url_stats = skip_url_stats |
| def specific_month(self, date): | def specific_month(self, date): |
| import calendar | import calendar |
| first_of_this_month = datetime.datetime(date.year, date.month, 1) | first_of_this_month = datetime.datetime(date.year, date.month, 1) |
| _, last_day_of_month = calendar.monthrange(int(date.year), int(date.month)) | _, last_day_of_month = calendar.monthrange(int(date.year), int(date.month)) |
| last_of_this_month = datetime.datetime(date.year, date.month, last_day_of_month) | last_of_this_month = datetime.datetime(date.year, date.month, last_day_of_month) |
| periods = ((date.strftime(FORMAT_MONTH), | periods = ((date.strftime(FORMAT_MONTH), |
| last_day_of_month, | last_day_of_month, |
| first_of_this_month, last_of_this_month),) | first_of_this_month, last_of_this_month),) |
| self.download_and_store(periods) | self.download_and_store(periods) |
| def latest(self): | def latest(self): |
| if self.period == 'monthly': | if self.period == 'monthly': |
| # from first of this month to today | # from first of this month to today |
| now = datetime.datetime.now() | now = datetime.datetime.now() |
| first_of_this_month = datetime.datetime(now.year, now.month, 1) | first_of_this_month = datetime.datetime(now.year, now.month, 1) |
| periods = ((now.strftime(FORMAT_MONTH), | periods = ((now.strftime(FORMAT_MONTH), |
| now.day, | now.day, |
| first_of_this_month, now),) | first_of_this_month, now),) |
| else: | else: |
| raise NotImplementedError | raise NotImplementedError |
| self.download_and_store(periods) | self.download_and_store(periods) |
| def for_date(self, for_date): | def for_date(self, for_date): |
| assert isinstance(since_date, datetime.datetime) | assert isinstance(since_date, datetime.datetime) |
| periods = [] # (period_name, period_complete_day, start_date, end_date) | periods = [] # (period_name, period_complete_day, start_date, end_date) |
| if self.period == 'monthly': | if self.period == 'monthly': |
| first_of_the_months_until_now = [] | first_of_the_months_until_now = [] |
| year = for_date.year | year = for_date.year |
| month = for_date.month | month = for_date.month |
| now = datetime.datetime.now() | now = datetime.datetime.now() |
| first_of_this_month = datetime.datetime(now.year, now.month, 1) | first_of_this_month = datetime.datetime(now.year, now.month, 1) |
| while True: | while True: |
| first_of_the_month = datetime.datetime(year, month, 1) | first_of_the_month = datetime.datetime(year, month, 1) |
| if first_of_the_month == first_of_this_month: | if first_of_the_month == first_of_this_month: |
| periods.append((now.strftime(FORMAT_MONTH), | periods.append((now.strftime(FORMAT_MONTH), |
| now.day, | now.day, |
| first_of_this_month, now)) | first_of_this_month, now)) |
| break | break |
| elif first_of_the_month < first_of_this_month: | elif first_of_the_month < first_of_this_month: |
| in_the_next_month = first_of_the_month + datetime.timedelta(40) | in_the_next_month = first_of_the_month + datetime.timedelta(40) |
| last_of_the_month = datetime.datetime(in_the_next_month.year, | last_of_the_month = datetime.datetime(in_the_next_month.year, |
| in_the_next_month.month, 1)\ | in_the_next_month.month, 1)\ |
| - datetime.timedelta(1) | - datetime.timedelta(1) |
| periods.append((now.strftime(FORMAT_MONTH), 0, | periods.append((now.strftime(FORMAT_MONTH), 0, |
| first_of_the_month, last_of_the_month)) | first_of_the_month, last_of_the_month)) |
| else: | else: |
| # first_of_the_month has got to the future somehow | # first_of_the_month has got to the future somehow |
| break | break |
| month += 1 | month += 1 |
| if month > 12: | if month > 12: |
| year += 1 | year += 1 |
| month = 1 | month = 1 |
| else: | else: |
| raise NotImplementedError | raise NotImplementedError |
| self.download_and_store(periods) | self.download_and_store(periods) |
| @staticmethod | @staticmethod |
| def get_full_period_name(period_name, period_complete_day): | def get_full_period_name(period_name, period_complete_day): |
| if period_complete_day: | if period_complete_day: |
| return period_name + ' (up to %ith)' % period_complete_day | return period_name + ' (up to %ith)' % period_complete_day |
| else: | else: |
| return period_name | return period_name |
| def download_and_store(self, periods): | def download_and_store(self, periods): |
| for period_name, period_complete_day, start_date, end_date in periods: | for period_name, period_complete_day, start_date, end_date in periods: |
| log.info('Period "%s" (%s - %s)', | log.info('Period "%s" (%s - %s)', |
| self.get_full_period_name(period_name, period_complete_day), | self.get_full_period_name(period_name, period_complete_day), |
| start_date.strftime('%Y-%m-%d'), | start_date.strftime('%Y-%m-%d'), |
| end_date.strftime('%Y-%m-%d')) | end_date.strftime('%Y-%m-%d')) |
| if self.delete_first: | if self.delete_first: |
| log.info('Deleting existing Analytics for this period "%s"', | log.info('Deleting existing Analytics for this period "%s"', |
| period_name) | period_name) |
| ga_model.delete(period_name) | ga_model.delete(period_name) |
| if not self.skip_url_stats: | if not self.skip_url_stats: |
| # Clean out old url data before storing the new | # Clean out old url data before storing the new |
| ga_model.pre_update_url_stats(period_name) | ga_model.pre_update_url_stats(period_name) |
| accountName = config.get('googleanalytics.account') | accountName = config.get('googleanalytics.account') |
| log.info('Downloading analytics for dataset views') | log.info('Downloading analytics for dataset views') |
| data = self.download(start_date, end_date, '~/%s/dataset/[a-z0-9-_]+' % accountName) | data = self.download(start_date, end_date, '~/%s/dataset/[a-z0-9-_]+' % accountName) |
| log.info('Storing dataset views (%i rows)', len(data.get('url'))) | log.info('Storing dataset views (%i rows)', len(data.get('url'))) |
| self.store(period_name, period_complete_day, data, ) | self.store(period_name, period_complete_day, data, ) |
| log.info('Downloading analytics for publisher views') | log.info('Downloading analytics for publisher views') |
| data = self.download(start_date, end_date, '~/%s/publisher/[a-z0-9-_]+' % accountName) | data = self.download(start_date, end_date, '~/%s/publisher/[a-z0-9-_]+' % accountName) |
| log.info('Storing publisher views (%i rows)', len(data.get('url'))) | log.info('Storing publisher views (%i rows)', len(data.get('url'))) |
| self.store(period_name, period_complete_day, data,) | self.store(period_name, period_complete_day, data,) |
| log.info('Aggregating datasets by publisher') | log.info('Aggregating datasets by publisher') |
| ga_model.update_publisher_stats(period_name) # about 30 seconds. | ga_model.update_publisher_stats(period_name) # about 30 seconds. |
| log.info('Downloading and storing analytics for site-wide stats') | log.info('Downloading and storing analytics for site-wide stats') |
| self.sitewide_stats( period_name, period_complete_day ) | self.sitewide_stats( period_name, period_complete_day ) |
| log.info('Downloading and storing analytics for social networks') | log.info('Downloading and storing analytics for social networks') |
| self.update_social_info(period_name, start_date, end_date) | self.update_social_info(period_name, start_date, end_date) |
| def update_social_info(self, period_name, start_date, end_date): | def update_social_info(self, period_name, start_date, end_date): |
| start_date = start_date.strftime('%Y-%m-%d') | start_date = start_date.strftime('%Y-%m-%d') |
| end_date = end_date.strftime('%Y-%m-%d') | end_date = end_date.strftime('%Y-%m-%d') |
| query = 'ga:hasSocialSourceReferral=~Yes$' | query = 'ga:hasSocialSourceReferral=~Yes$' |
| metrics = 'ga:entrances' | metrics = 'ga:entrances' |
| sort = '-ga:entrances' | sort = '-ga:entrances' |
| # Supported query params at | # Supported query params at |
| # https://developers.google.com/analytics/devguides/reporting/core/v3/reference | # https://developers.google.com/analytics/devguides/reporting/core/v3/reference |
| results = self.service.data().ga().get( | results = self.service.data().ga().get( |
| ids='ga:' + self.profile_id, | ids='ga:' + self.profile_id, |
| filters=query, | filters=query, |
| start_date=start_date, | start_date=start_date, |
| metrics=metrics, | metrics=metrics, |
| sort=sort, | sort=sort, |
| dimensions="ga:landingPagePath,ga:socialNetwork", | dimensions="ga:landingPagePath,ga:socialNetwork", |
| max_results=10000, | max_results=10000, |
| end_date=end_date).execute() | end_date=end_date).execute() |
| data = collections.defaultdict(list) | data = collections.defaultdict(list) |
| rows = results.get('rows',[]) | rows = results.get('rows',[]) |
| for row in rows: | for row in rows: |
| url = _normalize_url('http:/' + row[0]) | url = _normalize_url('http:/' + row[0]) |
| data[url].append( (row[1], int(row[2]),) ) | data[url].append( (row[1], int(row[2]),) ) |
| ga_model.update_social(period_name, data) | ga_model.update_social(period_name, data) |
| def download(self, start_date, end_date, path=None): | def download(self, start_date, end_date, path=None): |
| '''Get data from GA for a given time period''' | '''Get data from GA for a given time period''' |
| start_date = start_date.strftime('%Y-%m-%d') | start_date = start_date.strftime('%Y-%m-%d') |
| end_date = end_date.strftime('%Y-%m-%d') | end_date = end_date.strftime('%Y-%m-%d') |
| query = 'ga:pagePath=%s$' % path | query = 'ga:pagePath=%s$' % path |
| metrics = 'ga:pageviews, ga:visits' | metrics = 'ga:pageviews, ga:visits' |
| sort = '-ga:pageviews' | sort = '-ga:pageviews' |
| # Supported query params at | # Supported query params at |
| # https://developers.google.com/analytics/devguides/reporting/core/v3/reference | # https://developers.google.com/analytics/devguides/reporting/core/v3/reference |
| results = self.service.data().ga().get( | results = self.service.data().ga().get( |
| ids='ga:' + self.profile_id, | ids='ga:' + self.profile_id, |
| filters=query, | filters=query, |
| start_date=start_date, | start_date=start_date, |
| metrics=metrics, | metrics=metrics, |
| sort=sort, | sort=sort, |
| dimensions="ga:pagePath", | dimensions="ga:pagePath", |
| max_results=10000, | max_results=10000, |
| end_date=end_date).execute() | end_date=end_date).execute() |
| packages = [] | packages = [] |
| for entry in results.get('rows'): | for entry in results.get('rows'): |
| (loc,pageviews,visits) = entry | (loc,pageviews,visits) = entry |
| url = _normalize_url('http:/' + loc) # strips off domain e.g. www.data.gov.uk or data.gov.uk | url = _normalize_url('http:/' + loc) # strips off domain e.g. www.data.gov.uk or data.gov.uk |
| if not url.startswith('/dataset/') and not url.startswith('/publisher/'): | if not url.startswith('/dataset/') and not url.startswith('/publisher/'): |
| # filter out strays like: | # filter out strays like: |
| # /data/user/login?came_from=http://data.gov.uk/dataset/os-code-point-open | # /data/user/login?came_from=http://data.gov.uk/dataset/os-code-point-open |
| # /403.html?page=/about&from=http://data.gov.uk/publisher/planning-inspectorate | # /403.html?page=/about&from=http://data.gov.uk/publisher/planning-inspectorate |
| continue | continue |
| packages.append( (url, pageviews, visits,) ) # Temporary hack | packages.append( (url, pageviews, visits,) ) # Temporary hack |
| return dict(url=packages) | return dict(url=packages) |
| def store(self, period_name, period_complete_day, data): | def store(self, period_name, period_complete_day, data): |
| if 'url' in data: | if 'url' in data: |
| ga_model.update_url_stats(period_name, period_complete_day, data['url']) | ga_model.update_url_stats(period_name, period_complete_day, data['url']) |
| def sitewide_stats(self, period_name, period_complete_day): | def sitewide_stats(self, period_name, period_complete_day): |
| import calendar | import calendar |
| year, month = period_name.split('-') | year, month = period_name.split('-') |
| _, last_day_of_month = calendar.monthrange(int(year), int(month)) | _, last_day_of_month = calendar.monthrange(int(year), int(month)) |
| start_date = '%s-01' % period_name | start_date = '%s-01' % period_name |
| end_date = '%s-%s' % (period_name, last_day_of_month) | end_date = '%s-%s' % (period_name, last_day_of_month) |
| funcs = ['_totals_stats', '_social_stats', '_os_stats', | funcs = ['_totals_stats', '_social_stats', '_os_stats', |
| '_locale_stats', '_browser_stats', '_mobile_stats'] | '_locale_stats', '_browser_stats', '_mobile_stats', '_download_stats'] |
| for f in funcs: | for f in funcs: |
| log.info('Downloading analytics for %s' % f.split('_')[1]) | log.info('Downloading analytics for %s' % f.split('_')[1]) |
| getattr(self, f)(start_date, end_date, period_name, period_complete_day) | getattr(self, f)(start_date, end_date, period_name, period_complete_day) |
| def _get_results(result_data, f): | def _get_results(result_data, f): |
| data = {} | data = {} |
| for result in result_data: | for result in result_data: |
| key = f(result) | key = f(result) |
| data[key] = data.get(key,0) + result[1] | data[key] = data.get(key,0) + result[1] |
| return data | return data |
| def _totals_stats(self, start_date, end_date, period_name, period_complete_day): | def _totals_stats(self, start_date, end_date, period_name, period_complete_day): |
| """ Fetches distinct totals, total pageviews etc """ | """ Fetches distinct totals, total pageviews etc """ |
| results = self.service.data().ga().get( | results = self.service.data().ga().get( |
| ids='ga:' + self.profile_id, | ids='ga:' + self.profile_id, |
| start_date=start_date, | start_date=start_date, |
| metrics='ga:pageviews', | metrics='ga:pageviews', |
| sort='-ga:pageviews', | sort='-ga:pageviews', |
| max_results=10000, | max_results=10000, |
| end_date=end_date).execute() | end_date=end_date).execute() |
| result_data = results.get('rows') | result_data = results.get('rows') |
| ga_model.update_sitewide_stats(period_name, "Totals", {'Total page views': result_data[0][0]}, | ga_model.update_sitewide_stats(period_name, "Totals", {'Total page views': result_data[0][0]}, |
| period_complete_day) | period_complete_day) |
| results = self.service.data().ga().get( | results = self.service.data().ga().get( |
| ids='ga:' + self.profile_id, | ids='ga:' + self.profile_id, |
| start_date=start_date, | start_date=start_date, |
| metrics='ga:pageviewsPerVisit,ga:avgTimeOnSite,ga:percentNewVisits,ga:visits', | metrics='ga:pageviewsPerVisit,ga:avgTimeOnSite,ga:percentNewVisits,ga:visits', |
| max_results=10000, | max_results=10000, |
| end_date=end_date).execute() | end_date=end_date).execute() |
| result_data = results.get('rows') | result_data = results.get('rows') |
| data = { | data = { |
| 'Pages per visit': result_data[0][0], | 'Pages per visit': result_data[0][0], |
| 'Average time on site': result_data[0][1], | 'Average time on site': result_data[0][1], |
| 'New visits': result_data[0][2], | 'New visits': result_data[0][2], |
| 'Total visits': result_data[0][3], | 'Total visits': result_data[0][3], |
| } | } |
| ga_model.update_sitewide_stats(period_name, "Totals", data, period_complete_day) | ga_model.update_sitewide_stats(period_name, "Totals", data, period_complete_day) |
| # Bounces from / or another configurable page. | # Bounces from / or another configurable page. |
| path = '/%s%s' % (config.get('googleanalytics.account'), | path = '/%s%s' % (config.get('googleanalytics.account'), |
| config.get('ga-report.bounce_url', '/')) | config.get('ga-report.bounce_url', '/')) |
| results = self.service.data().ga().get( | results = self.service.data().ga().get( |
| ids='ga:' + self.profile_id, | ids='ga:' + self.profile_id, |
| filters='ga:pagePath==%s' % (path,), | filters='ga:pagePath==%s' % (path,), |
| start_date=start_date, | start_date=start_date, |
| metrics='ga:visitBounceRate', | metrics='ga:visitBounceRate', |
| dimensions='ga:pagePath', | dimensions='ga:pagePath', |
| max_results=10000, | max_results=10000, |
| end_date=end_date).execute() | end_date=end_date).execute() |
| result_data = results.get('rows') | result_data = results.get('rows') |
| if not result_data or len(result_data) != 1: | if not result_data or len(result_data) != 1: |
| log.error('Could not pinpoint the bounces for path: %s. Got results: %r', | log.error('Could not pinpoint the bounces for path: %s. Got results: %r', |
| path, result_data) | path, result_data) |
| return | return |
| results = result_data[0] | results = result_data[0] |
| bounces = float(results[1]) | bounces = float(results[1]) |
| # visitBounceRate is already a % | # visitBounceRate is already a % |
| log.info('Google reports visitBounceRate as %s', bounces) | log.info('Google reports visitBounceRate as %s', bounces) |
| ga_model.update_sitewide_stats(period_name, "Totals", {'Bounce rate (home page)': float(bounces)}, | ga_model.update_sitewide_stats(period_name, "Totals", {'Bounce rate (home page)': float(bounces)}, |
| period_complete_day) | period_complete_day) |
| def _locale_stats(self, start_date, end_date, period_name, period_complete_day): | def _locale_stats(self, start_date, end_date, period_name, period_complete_day): |
| """ Fetches stats about language and country """ | """ Fetches stats about language and country """ |
| results = self.service.data().ga().get( | results = self.service.data().ga().get( |
| ids='ga:' + self.profile_id, | ids='ga:' + self.profile_id, |
| start_date=start_date, | start_date=start_date, |
| metrics='ga:pageviews', | metrics='ga:pageviews', |
| sort='-ga:pageviews', | sort='-ga:pageviews', |
| dimensions="ga:language,ga:country", | dimensions="ga:language,ga:country", |
| max_results=10000, | max_results=10000, |
| end_date=end_date).execute() | end_date=end_date).execute() |
| result_data = results.get('rows') | result_data = results.get('rows') |
| data = {} | data = {} |
| for result in result_data: | for result in result_data: |
| data[result[0]] = data.get(result[0], 0) + int(result[2]) | data[result[0]] = data.get(result[0], 0) + int(result[2]) |
| self._filter_out_long_tail(data, MIN_VIEWS) | self._filter_out_long_tail(data, MIN_VIEWS) |
| ga_model.update_sitewide_stats(period_name, "Languages", data, period_complete_day) | ga_model.update_sitewide_stats(period_name, "Languages", data, period_complete_day) |
| data = {} | data = {} |
| for result in result_data: | for result in result_data: |
| data[result[1]] = data.get(result[1], 0) + int(result[2]) | data[result[1]] = data.get(result[1], 0) + int(result[2]) |
| self._filter_out_long_tail(data, MIN_VIEWS) | self._filter_out_long_tail(data, MIN_VIEWS) |
| ga_model.update_sitewide_stats(period_name, "Country", data, period_complete_day) | ga_model.update_sitewide_stats(period_name, "Country", data, period_complete_day) |
| def _download_stats(self, start_date, end_date, period_name, period_complete_day): | |
| """ Fetches stats about language and country """ | |
| results = self.service.data().ga().get( | |
| ids='ga:' + self.profile_id, | |
| start_date=start_date, | |
| filters='ga:eventAction==download', | |
| metrics='ga:totalEvents', | |
| sort='-ga:totalEvents', | |
| dimensions="ga:eventLabel", | |
| max_results=10000, | |
| end_date=end_date).execute() | |
| result_data = results.get('rows') | |
| # [[url, count], [url],count] | |
| data = {} | |
| for result in result_data: | |
| data[result[0]] = data.get(result[0], 0) + int(result[1]) | |
| self._filter_out_long_tail(data, MIN_DOWNLOADS) | |
| ga_model.update_sitewide_stats(period_name, "Downloads", data, period_complete_day) | |
| def _social_stats(self, start_date, end_date, period_name, period_complete_day): | def _social_stats(self, start_date, end_date, period_name, period_complete_day): |
| """ Finds out which social sites people are referred from """ | """ Finds out which social sites people are referred from """ |
| results = self.service.data().ga().get( | results = self.service.data().ga().get( |
| ids='ga:' + self.profile_id, | ids='ga:' + self.profile_id, |
| start_date=start_date, | start_date=start_date, |
| metrics='ga:pageviews', | metrics='ga:pageviews', |
| sort='-ga:pageviews', | sort='-ga:pageviews', |
| dimensions="ga:socialNetwork,ga:referralPath", | dimensions="ga:socialNetwork,ga:referralPath", |
| max_results=10000, | max_results=10000, |
| end_date=end_date).execute() | end_date=end_date).execute() |
| result_data = results.get('rows') | result_data = results.get('rows') |
| data = {} | data = {} |
| for result in result_data: | for result in result_data: |
| if not result[0] == '(not set)': | if not result[0] == '(not set)': |
| data[result[0]] = data.get(result[0], 0) + int(result[2]) | data[result[0]] = data.get(result[0], 0) + int(result[2]) |
| self._filter_out_long_tail(data, 3) | self._filter_out_long_tail(data, 3) |
| ga_model.update_sitewide_stats(period_name, "Social sources", data, period_complete_day) | ga_model.update_sitewide_stats(period_name, "Social sources", data, period_complete_day) |
| def _os_stats(self, start_date, end_date, period_name, period_complete_day): | def _os_stats(self, start_date, end_date, period_name, period_complete_day): |
| """ Operating system stats """ | """ Operating system stats """ |
| results = self.service.data().ga().get( | results = self.service.data().ga().get( |
| ids='ga:' + self.profile_id, | ids='ga:' + self.profile_id, |
| start_date=start_date, | start_date=start_date, |
| metrics='ga:pageviews', | metrics='ga:pageviews', |
| sort='-ga:pageviews', | sort='-ga:pageviews', |
| dimensions="ga:operatingSystem,ga:operatingSystemVersion", | dimensions="ga:operatingSystem,ga:operatingSystemVersion", |
| max_results=10000, | max_results=10000, |
| end_date=end_date).execute() | end_date=end_date).execute() |
| result_data = results.get('rows') | result_data = results.get('rows') |
| data = {} | data = {} |
| for result in result_data: | for result in result_data: |
| data[result[0]] = data.get(result[0], 0) + int(result[2]) | data[result[0]] = data.get(result[0], 0) + int(result[2]) |
| self._filter_out_long_tail(data, MIN_VIEWS) | self._filter_out_long_tail(data, MIN_VIEWS) |
| ga_model.update_sitewide_stats(period_name, "Operating Systems", data, period_complete_day) | ga_model.update_sitewide_stats(period_name, "Operating Systems", data, period_complete_day) |
| data = {} | data = {} |
| for result in result_data: | for result in result_data: |
| if int(result[2]) >= MIN_VIEWS: | if int(result[2]) >= MIN_VIEWS: |
| key = "%s %s" % (result[0],result[1]) | key = "%s %s" % (result[0],result[1]) |
| data[key] = result[2] | data[key] = result[2] |
| ga_model.update_sitewide_stats(period_name, "Operating Systems versions", data, period_complete_day) | ga_model.update_sitewide_stats(period_name, "Operating Systems versions", data, period_complete_day) |
| def _browser_stats(self, start_date, end_date, period_name, period_complete_day): | def _browser_stats(self, start_date, end_date, period_name, period_complete_day): |
| """ Information about browsers and browser versions """ | """ Information about browsers and browser versions """ |
| results = self.service.data().ga().get( | results = self.service.data().ga().get( |
| ids='ga:' + self.profile_id, | ids='ga:' + self.profile_id, |
| start_date=start_date, | start_date=start_date, |
| metrics='ga:pageviews', | metrics='ga:pageviews', |
| sort='-ga:pageviews', | sort='-ga:pageviews', |
| dimensions="ga:browser,ga:browserVersion", | dimensions="ga:browser,ga:browserVersion", |
| max_results=10000, | max_results=10000, |
| end_date=end_date).execute() | end_date=end_date).execute() |
| result_data = results.get('rows') | result_data = results.get('rows') |
| # e.g. [u'Firefox', u'19.0', u'20'] | # e.g. [u'Firefox', u'19.0', u'20'] |
| data = {} | data = {} |
| for result in result_data: | for result in result_data: |
| data[result[0]] = data.get(result[0], 0) + int(result[2]) | data[result[0]] = data.get(result[0], 0) + int(result[2]) |
| self._filter_out_long_tail(data, MIN_VIEWS) | self._filter_out_long_tail(data, MIN_VIEWS) |
| ga_model.update_sitewide_stats(period_name, "Browsers", data, period_complete_day) | ga_model.update_sitewide_stats(period_name, "Browsers", data, period_complete_day) |
| data = {} | data = {} |
| for result in result_data: | for result in result_data: |
| key = "%s %s" % (result[0], self._filter_browser_version(result[0], result[1])) | key = "%s %s" % (result[0], self._filter_browser_version(result[0], result[1])) |
| data[key] = data.get(key, 0) + int(result[2]) | data[key] = data.get(key, 0) + int(result[2]) |
| self._filter_out_long_tail(data, MIN_VIEWS) | self._filter_out_long_tail(data, MIN_VIEWS) |
| ga_model.update_sitewide_stats(period_name, "Browser versions", data, period_complete_day) | ga_model.update_sitewide_stats(period_name, "Browser versions", data, period_complete_day) |
| @classmethod | @classmethod |
| def _filter_browser_version(cls, browser, version_str): | def _filter_browser_version(cls, browser, version_str): |
| ''' | ''' |
| Simplifies a browser version string if it is detailed. | Simplifies a browser version string if it is detailed. |
| i.e. groups together Firefox 3.5.1 and 3.5.2 to be just 3. | i.e. groups together Firefox 3.5.1 and 3.5.2 to be just 3. |
| This is helpful when viewing stats and good to protect privacy. | This is helpful when viewing stats and good to protect privacy. |
| ''' | ''' |
| ver = version_str | ver = version_str |
| parts = ver.split('.') | parts = ver.split('.') |
| if len(parts) > 1: | if len(parts) > 1: |
| if parts[1][0] == '0': | if parts[1][0] == '0': |
| ver = parts[0] | ver = parts[0] |
| else: | else: |
| ver = "%s" % (parts[0]) | ver = "%s" % (parts[0]) |
| # Special case complex version nums | # Special case complex version nums |
| if browser in ['Safari', 'Android Browser']: | if browser in ['Safari', 'Android Browser']: |
| ver = parts[0] | ver = parts[0] |
| if len(ver) > 2: | if len(ver) > 2: |
| num_hidden_digits = len(ver) - 2 | num_hidden_digits = len(ver) - 2 |
| ver = ver[0] + ver[1] + 'X' * num_hidden_digits | ver = ver[0] + ver[1] + 'X' * num_hidden_digits |
| return ver | return ver |
| def _mobile_stats(self, start_date, end_date, period_name, period_complete_day): | def _mobile_stats(self, start_date, end_date, period_name, period_complete_day): |
| """ Info about mobile devices """ | """ Info about mobile devices """ |
| results = self.service.data().ga().get( | results = self.service.data().ga().get( |
| ids='ga:' + self.profile_id, | ids='ga:' + self.profile_id, |
| start_date=start_date, | start_date=start_date, |
| metrics='ga:pageviews', | metrics='ga:pageviews', |
| sort='-ga:pageviews', | sort='-ga:pageviews', |
| dimensions="ga:mobileDeviceBranding, ga:mobileDeviceInfo", | dimensions="ga:mobileDeviceBranding, ga:mobileDeviceInfo", |
| max_results=10000, | max_results=10000, |
| end_date=end_date).execute() | end_date=end_date).execute() |
| result_data = results.get('rows') | result_data = results.get('rows') |
| data = {} | data = {} |
| for result in result_data: | for result in result_data: |
| data[result[0]] = data.get(result[0], 0) + int(result[2]) | data[result[0]] = data.get(result[0], 0) + int(result[2]) |
| self._filter_out_long_tail(data, MIN_VIEWS) | self._filter_out_long_tail(data, MIN_VIEWS) |
| ga_model.update_sitewide_stats(period_name, "Mobile brands", data, period_complete_day) | ga_model.update_sitewide_stats(period_name, "Mobile brands", data, period_complete_day) |
| data = {} | data = {} |
| for result in result_data: | for result in result_data: |
| data[result[1]] = data.get(result[1], 0) + int(result[2]) | data[result[1]] = data.get(result[1], 0) + int(result[2]) |
| self._filter_out_long_tail(data, MIN_VIEWS) | self._filter_out_long_tail(data, MIN_VIEWS) |
| ga_model.update_sitewide_stats(period_name, "Mobile devices", data, period_complete_day) | ga_model.update_sitewide_stats(period_name, "Mobile devices", data, period_complete_day) |
| @classmethod | @classmethod |
| def _filter_out_long_tail(cls, data, threshold=10): | def _filter_out_long_tail(cls, data, threshold=10): |
| ''' | ''' |
| Given data which is a frequency distribution, filter out | Given data which is a frequency distribution, filter out |
| results which are below a threshold count. This is good to protect | results which are below a threshold count. This is good to protect |
| privacy. | privacy. |
| ''' | ''' |
| for key, value in data.items(): | for key, value in data.items(): |
| if value < threshold: | if value < threshold: |
| del data[key] | del data[key] |
| import logging | import logging |
| import ckan.lib.helpers as h | import ckan.lib.helpers as h |
| import ckan.plugins as p | import ckan.plugins as p |
| from ckan.plugins import implements, toolkit | from ckan.plugins import implements, toolkit |
| from ckanext.ga_report.helpers import (most_popular_datasets, | from ckanext.ga_report.helpers import (most_popular_datasets, |
| popular_datasets, | popular_datasets, |
| single_popular_dataset) | single_popular_dataset) |
| log = logging.getLogger('ckanext.ga-report') | log = logging.getLogger('ckanext.ga-report') |
| class GAReportPlugin(p.SingletonPlugin): | class GAReportPlugin(p.SingletonPlugin): |
| implements(p.IConfigurer, inherit=True) | implements(p.IConfigurer, inherit=True) |
| implements(p.IRoutes, inherit=True) | implements(p.IRoutes, inherit=True) |
| implements(p.ITemplateHelpers, inherit=True) | implements(p.ITemplateHelpers, inherit=True) |
| def update_config(self, config): | def update_config(self, config): |
| toolkit.add_template_directory(config, 'templates') | toolkit.add_template_directory(config, 'templates') |
| toolkit.add_public_directory(config, 'public') | toolkit.add_public_directory(config, 'public') |
| def get_helpers(self): | def get_helpers(self): |
| """ | """ |
| A dictionary of extra helpers that will be available to provide | A dictionary of extra helpers that will be available to provide |
| ga report info to templates. | ga report info to templates. |
| """ | """ |
| return { | return { |
| 'ga_report_installed': lambda: True, | 'ga_report_installed': lambda: True, |
| 'popular_datasets': popular_datasets, | 'popular_datasets': popular_datasets, |
| 'most_popular_datasets': most_popular_datasets, | 'most_popular_datasets': most_popular_datasets, |
| 'single_popular_dataset': single_popular_dataset | 'single_popular_dataset': single_popular_dataset |
| } | } |
| def after_map(self, map): | def after_map(self, map): |
| # GaReport | # GaReport |
| map.connect( | map.connect( |
| '/data/site-usage', | '/data/site-usage', |
| controller='ckanext.ga_report.controller:GaReport', | controller='ckanext.ga_report.controller:GaReport', |
| action='index' | action='index' |
| ) | ) |
| map.connect( | map.connect( |
| '/data/site-usage/data_{month}.csv', | '/data/site-usage/data_{month}.csv', |
| controller='ckanext.ga_report.controller:GaReport', | controller='ckanext.ga_report.controller:GaReport', |
| action='csv' | action='csv' |
| ) | ) |
| map.connect( | |
| '/data/site-usage/downloads', | |
| controller='ckanext.ga_report.controller:GaReport', | |
| action='downloads' | |
| ) | |
| map.connect( | |
| '/data/site-usage/downloads_{month}.csv', | |
| controller='ckanext.ga_report.controller:GaReport', | |
| action='csv_downloads' | |
| ) | |
| # GaDatasetReport | # GaDatasetReport |
| map.connect( | map.connect( |
| '/data/site-usage/publisher', | '/data/site-usage/publisher', |
| controller='ckanext.ga_report.controller:GaDatasetReport', | controller='ckanext.ga_report.controller:GaDatasetReport', |
| action='publishers' | action='publishers' |
| ) | ) |
| map.connect( | map.connect( |
| '/data/site-usage/publishers_{month}.csv', | '/data/site-usage/publishers_{month}.csv', |
| controller='ckanext.ga_report.controller:GaDatasetReport', | controller='ckanext.ga_report.controller:GaDatasetReport', |
| action='publisher_csv' | action='publisher_csv' |
| ) | ) |
| map.connect( | map.connect( |
| '/data/site-usage/dataset/datasets_{id}_{month}.csv', | '/data/site-usage/dataset/datasets_{id}_{month}.csv', |
| controller='ckanext.ga_report.controller:GaDatasetReport', | controller='ckanext.ga_report.controller:GaDatasetReport', |
| action='dataset_csv' | action='dataset_csv' |
| ) | ) |
| map.connect( | map.connect( |
| '/data/site-usage/dataset', | '/data/site-usage/dataset', |
| controller='ckanext.ga_report.controller:GaDatasetReport', | controller='ckanext.ga_report.controller:GaDatasetReport', |
| action='read' | action='read' |
| ) | ) |
| map.connect( | map.connect( |
| '/data/site-usage/dataset/{id}', | '/data/site-usage/dataset/{id}', |
| controller='ckanext.ga_report.controller:GaDatasetReport', | controller='ckanext.ga_report.controller:GaDatasetReport', |
| action='read_publisher' | action='read_publisher' |
| ) | ) |
| return map | return map |
| <html | <html |
| xmlns="http://www.w3.org/1999/xhtml" | xmlns="http://www.w3.org/1999/xhtml" |
| xmlns:i18n="http://genshi.edgewall.org/i18n" | xmlns:i18n="http://genshi.edgewall.org/i18n" |
| xmlns:py="http://genshi.edgewall.org/" | xmlns:py="http://genshi.edgewall.org/" |
| xmlns:xi="http://www.w3.org/2001/XInclude" | xmlns:xi="http://www.w3.org/2001/XInclude" |
| py:strip="" | py:strip="" |
| > | > |
| <select name="month" py:def="month_selector(current_month, months, day)"> | <select name="month" py:def="month_selector(current_month, months, day)"> |
| <option value='' py:attrs="{'selected': 'selected' if not current_month else None}">All months</option> | <option value='' py:attrs="{'selected': 'selected' if not current_month else None}">All months</option> |
| <py:for each="i, (val,desc) in enumerate(months)"> | <py:for each="i, (val,desc) in enumerate(months)"> |
| <option value='${val}' py:attrs="{'selected': 'selected' if current_month == val else None}">${desc}<py:if test="i == 0 and day"> (up to ${day})</py:if></option> | <option value='${val}' py:attrs="{'selected': 'selected' if current_month == val else None}">${desc}<py:if test="i == 0 and day"> (up to ${day})</py:if></option> |
| </py:for> | </py:for> |
| </select> | </select> |
| <table py:def="social_table(items, with_source=False)" class="table table-condensed table-bordered table-striped"> | <table py:def="social_table(items, with_source=False)" class="table table-condensed table-bordered table-striped"> |
| <tr> | <tr> |
| <th>Name</th> | <th>Name</th> |
| <th py:if="with_source">Source</th> | <th py:if="with_source">Source</th> |
| <th>Visits</th> | <th>Visits</th> |
| </tr> | </tr> |
| <py:for each="name, url, source, count in items"> | <py:for each="name, url, source, count in items"> |
| <tr> | <tr> |
| <td><a href="${url}">${name}</a></td> | <td><a href="${url}">${name}</a></td> |
| <td py:if="with_source">${source}</td> | <td py:if="with_source">${source}</td> |
| <td>${count}</td> | <td>${count}</td> |
| </tr> | </tr> |
| </py:for> | </py:for> |
| </table> | </table> |
| <table py:def="stat_table(items, title='Views')" class="table table-condensed table-bordered table-striped"> | <table py:def="stat_table(items, title='Views')" class="table table-condensed table-bordered table-striped"> |
| <tr> | <tr> |
| <th>Name</th> | <th>Name</th> |
| <th>% ${title}</th> | <th>% ${title}</th> |
| </tr> | </tr> |
| <py:for each="name, value in items"> | <py:for each="name, value in items"> |
| <tr> | <tr> |
| <td>${name}</td> | <td>${name}</td> |
| <td>${value}</td> | <td>${value}</td> |
| </tr> | </tr> |
| </py:for> | </py:for> |
| </table> | </table> |
| <table py:def="downloads_table(items)" class="table table-condensed table-bordered table-striped"> | |
| <tr> | |
| <th>Name</th> | |
| <th>Downloads</th> | |
| </tr> | |
| <py:for each="resource, value in items"> | |
| <tr> | |
| <td> | |
| <strong>${resource.resource_group.package.title}</strong><br/> | |
| ${h.link_to((resource.name or resource.description).strip() or "No name", h.url_for(controller='package', action='resource_read', id=resource.resource_group.package.name, resource_id=resource.id))}<br/> | |
| </td> | |
| <td>${value}</td> | |
| </tr> | |
| </py:for> | |
| </table> | |
| <div py:def="usage_nav(active_name)" id="minornavigation"> | <div py:def="usage_nav(active_name)" id="minornavigation"> |
| <div id="minornavigation-bg-left"> | <div id="minornavigation-bg-left"> |
| <div id="minornavigation-bg-right"> | <div id="minornavigation-bg-right"> |
| <ul class="nav nav-pills"> | <ul class="nav nav-pills"> |
| <li py:attrs="{'class': 'active' if active_name=='Site-wide' else None}"><a py:attrs="{'class': 'active' if active_name=='Site-wide' else None}" href="${h.url_for(controller='ckanext.ga_report.controller:GaReport',action='index')}"><img src="/images/icons/page_white.png" height="16px" width="16px" alt="None" class="inline-icon "/> Site-wide</a></li> | <li py:attrs="{'class': 'active' if active_name=='Site-wide' else None}"><a py:attrs="{'class': 'active' if active_name=='Site-wide' else None}" href="${h.url_for(controller='ckanext.ga_report.controller:GaReport',action='index')}"><img src="/images/icons/page_white.png" height="16px" width="16px" alt="None" class="inline-icon "/> Site-wide</a></li> |
| <li py:attrs="{'class': 'active' if active_name=='Publishers' else None}"> | <li py:attrs="{'class': 'active' if active_name=='Publishers' else None}"> |
| <a py:attrs="{'class': 'active' if active_name=='Publishers' else None}" href="${h.url_for(controller='ckanext.ga_report.controller:GaDatasetReport',action='publishers')}"><img src="/images/icons/page_white.png" height="16px" width="16px" alt="None" class="inline-icon "/> Publishers</a> | <a py:attrs="{'class': 'active' if active_name=='Publishers' else None}" href="${h.url_for(controller='ckanext.ga_report.controller:GaDatasetReport',action='publishers')}"><img src="/images/icons/page_white.png" height="16px" width="16px" alt="None" class="inline-icon "/> Publishers</a> |
| </li> | </li> |
| <li py:attrs="{'class': 'active' if active_name=='Datasets' else None}"> | <li py:attrs="{'class': 'active' if active_name=='Datasets' else None}"> |
| <a py:attrs="{'class': 'active' if active_name=='Datasets' else None}" href="${h.url_for(controller='ckanext.ga_report.controller:GaDatasetReport',action='read')}"><img src="/images/icons/page_white.png" height="16px" width="16px" alt="None" class="inline-icon "/> Datasets</a> | <a py:attrs="{'class': 'active' if active_name=='Datasets' else None}" href="${h.url_for(controller='ckanext.ga_report.controller:GaDatasetReport',action='read')}"><img src="/images/icons/page_white.png" height="16px" width="16px" alt="None" class="inline-icon "/> Datasets</a> |
| </li> | </li> |
| <li py:attrs="{'class': 'active' if active_name=='Downloads' else None}"> | |
| <a py:attrs="{'class': 'active' if active_name=='Downloads' else None}" href="${h.url_for(controller='ckanext.ga_report.controller:GaReport',action='downloads')}"><img src="/images/icons/page_white.png" height="16px" width="16px" alt="None" class="inline-icon "/> Downloads</a> | |
| </li> | |
| </ul> | </ul> |
| </div> | </div> |
| </div> | </div> |
| </div> | </div> |
| </html> | </html> |
| <html xmlns:py="http://genshi.edgewall.org/" | |
| xmlns:i18n="http://genshi.edgewall.org/i18n" | |
| xmlns:xi="http://www.w3.org/2001/XInclude" | |
| py:strip=""> | |
| <xi:include href="../ga_util.html" /> | |
| <py:def function="page_title">Downloads</py:def> | |
| <py:match path="primarysidebar"> | |
| <li py:if="c.downloads" class="widget-container boxed widget_text"> | |
| <h4>Download</h4> | |
| <p><center> | |
| <a class="btn button btn-primary" href="${h.url_for(controller='ckanext.ga_report.controller:GaReport',action='csv_downloads',month=c.month or 'all')}">Download as CSV</a></center> | |
| </p> | |
| </li> | |
| <xi:include href="../notes.html" /> | |
| </py:match> | |
| <div py:match="content"> | |
| <h1>Downloads</h1> | |
| ${usage_nav('Downloads')} | |
| <form class="form-inline" action="${h.url_for(controller='ckanext.ga_report.controller:GaReport',action='downloads')}" method="get"> | |
| <div class="controls"> | |
| ${month_selector(c.month, c.months, c.day)} | |
| <input class="btn button btn-primary" type='submit' value="Update"/> | |
| </div> | |
| </form> | |
| <py:if test="c.downloads"> | |
| ${downloads_table(c.downloads)} | |
| </py:if> | |
| <py:if test="not c.downloads"> | |
| <h4>No data</h4> | |
| <p>There is no download data available for this month</p> | |
| </py:if> | |
| </div> | |
| <xi:include href="../../layout.html" /> | |
| <py:def function="optional_footer"> | |
| <script type='text/javascript'> | |
| $('.dropdown-toggle').dropdown(); | |
| $('.nav-tabs li a').click(function (e) { | |
| e.preventDefault(); | |
| $(this).tab('show'); | |
| }) | |
| alert(window.location.hash); | |
| </script> | |
| </py:def> | |
| </html> | |