From c493abfe0885e8dc9283ebae6254e0d8454f9c68 Mon Sep 17 00:00:00 2001 From: sgiehl Date: Wed, 1 May 2013 11:50:43 +0200 Subject: improved jquery id selector usage --- plugins/Annotations/templates/annotations.js | 2 +- plugins/CoreAdminHome/templates/generalSettings.js | 7 ++++--- .../CoreAdminHome/templates/jsTrackingGenerator.js | 18 +++++++++--------- .../templates/jsTrackingGenerator.tpl | 6 +++--- plugins/CoreHome/templates/calendar.js | 12 ++++++------ plugins/CoreHome/templates/datatable.js | 2 +- plugins/CoreHome/templates/date.js | 4 ++-- plugins/Dashboard/templates/dashboard.js | 22 +++++++++++----------- plugins/Dashboard/templates/dashboardObject.js | 2 +- plugins/Feedback/templates/feedback.js | 2 +- plugins/Feedback/templates/index.tpl | 2 +- plugins/Goals/templates/GoalForm.js | 2 +- plugins/PDFReports/templates/pdf.js | 10 +++++----- plugins/PDFReports/templates/report_parameters.tpl | 6 +++--- .../PrivacyManager/templates/privacySettings.js | 8 ++++---- plugins/SegmentEditor/templates/Segmentation.js | 2 +- plugins/SitesManager/templates/SitesManager.js | 8 ++++---- plugins/UserCountry/templates/admin.js | 2 +- plugins/UserCountryMap/js/realtime-map.js | 4 ++-- plugins/UsersManager/templates/UsersManager.js | 2 +- plugins/UsersManager/templates/userSettings.js | 6 +++--- 21 files changed, 65 insertions(+), 64 deletions(-) (limited to 'plugins') diff --git a/plugins/Annotations/templates/annotations.js b/plugins/Annotations/templates/annotations.js index 941ae4486a..817aade8ac 100755 --- a/plugins/Annotations/templates/annotations.js +++ b/plugins/Annotations/templates/annotations.js @@ -211,7 +211,7 @@ * @return {boolean} */ var isAnnotationStarred = function (annotation) { - return +$('.annotation-star', annotation).attr('data-starred') == 1 ? true : false; + return !!(+$('.annotation-star', annotation).attr('data-starred') == 1); }; /** diff --git a/plugins/CoreAdminHome/templates/generalSettings.js b/plugins/CoreAdminHome/templates/generalSettings.js index 6a493626c7..303e0d4e32 100644 --- a/plugins/CoreAdminHome/templates/generalSettings.js +++ b/plugins/CoreAdminHome/templates/generalSettings.js @@ -123,16 +123,17 @@ $(document).ready(function () { $('#customLogo').change(function () {$("#logoUploadForm").submit()}); // trusted hosts event handling - $('#trustedHostSettings .adminTable').on('click', '.remove-trusted-host', function (e) { + var trustedHostSettings = $('#trustedHostSettings'); + trustedHostSettings.find('.adminTable').on('click', '.remove-trusted-host', function (e) { e.preventDefault(); $(this).parent().parent().remove(); return false; }); - $('#trustedHostSettings .add-trusted-host').click(function (e) { + trustedHostSettings.find('.add-trusted-host').click(function (e) { e.preventDefault(); // append new row to the table - $('#trustedHostSettings tbody').append('' + $('#trustedHostSettings').find('tbody').append('' + '' + 'x' + ''); diff --git a/plugins/CoreAdminHome/templates/jsTrackingGenerator.js b/plugins/CoreAdminHome/templates/jsTrackingGenerator.js index d1ecd3705f..034d7dbe32 100644 --- a/plugins/CoreAdminHome/templates/jsTrackingGenerator.js +++ b/plugins/CoreAdminHome/templates/jsTrackingGenerator.js @@ -65,7 +65,7 @@ siteUrls = {}, siteCurrencies = {}, allGoals = {}, - noneText = $('#image-tracker-goal>option').text(); + noneText = $('#image-tracker-goal').find('>option').text(); // queries Piwik for needed site info for one site var getSiteData = function (idSite, sectionSelect, callback) { @@ -142,7 +142,7 @@ // function that generates JS code var generateJsCode = function () { // get data - var idSite = $('#js-tracker-website .custom_select_main_link').attr('siteid'), + var idSite = $('#js-tracker-website').find('.custom_select_main_link').attr('siteid'), groupPageTitlesByDomain = $('#javascript-tracking-group-by-domain').is(':checked'), mergeSubdomains = $('#javascript-tracking-all-subdomains').is(':checked'), mergeAliasUrls = $('#javascript-tracking-all-aliases').is(':checked'), @@ -214,13 +214,13 @@ \n\ '; - $('#javascript-text textarea').val(result) + $('#javascript-text').find('textarea').val(result) }; // function that generates image tracker link var generateImageTrackerLink = function () { // get data ( (("https:" == document.location.protocol)?"https://' + piwikHost + '":"http://' + piwikHost + '") ) - var idSite = $('#image-tracker-website .custom_select_main_link').attr('siteid'), + var idSite = $('#image-tracker-website').find('.custom_select_main_link').attr('siteid'), path = document.location.pathname, piwikURL = ("https:" == document.location.protocol ? "https://" + piwikHost : "http://" + piwikHost) + path.substring(0, path.lastIndexOf('/')) + '/piwik.php', actionName = $('#image-tracker-action-name').val(), @@ -230,7 +230,7 @@ if ($('#image-tracking-goal-check').is(':checked')) { idGoal = $('#image-tracker-goal').val(); if (idGoal) { - revenue = $('#image-tracker-advanced-options .revenue').val(); + revenue = $('#image-tracker-advanced-options').find('.revenue').val(); } } @@ -256,7 +256,7 @@ '; result = result.replace("&", "&", "g"); - $('#image-tracking-link textarea').val(result); + $('#image-tracking-link').find('textarea').val(result); }; // on image link tracker site change, change available goals @@ -328,11 +328,11 @@ }); // initial generation - getSiteData($( - '#js-tracker-website .custom_select_main_link').attr('siteid'), + getSiteData( + $('#js-tracker-website').find('.custom_select_main_link').attr('siteid'), '#js-code-options,#image-tracking-code-options', function () { - var imageTrackerSiteId = $('#image-tracker-website .custom_select_main_link').attr('siteid'); + var imageTrackerSiteId = $('#image-tracker-website').find('.custom_select_main_link').attr('siteid'); resetGoalSelectItems(imageTrackerSiteId, 'image-tracker-goal'); generateJsCode(); diff --git a/plugins/CoreAdminHome/templates/jsTrackingGenerator.tpl b/plugins/CoreAdminHome/templates/jsTrackingGenerator.tpl index b78d88cbf0..b4ba358e83 100644 --- a/plugins/CoreAdminHome/templates/jsTrackingGenerator.tpl +++ b/plugins/CoreAdminHome/templates/jsTrackingGenerator.tpl @@ -1,5 +1,5 @@ {include file="CoreAdminHome/templates/header.tpl"} - +

{'CoreAdminHome_JSTrackingIntro2'|translate} {'CoreAdminHome_JSTrackingIntro3'|translate:'':''}

- {'CoreAdminHome_JSTrackingIntro4'|translate:'':''} + {'CoreAdminHome_JSTrackingIntro4'|translate:'':''}

{'CoreAdminHome_JSTrackingIntro5'|translate:'':''}

@@ -174,7 +174,7 @@
- +

{'CoreAdminHome_ImageTracking'|translate}

diff --git a/plugins/CoreHome/templates/calendar.js b/plugins/CoreHome/templates/calendar.js index e531e375a9..9952ac281b 100644 --- a/plugins/CoreHome/templates/calendar.js +++ b/plugins/CoreHome/templates/calendar.js @@ -289,8 +289,8 @@ }; var togglePeriodPickers = function (showSingle) { - $('#periodString .period-date').toggle(showSingle); - $('#periodString .period-range').toggle(!showSingle); + $('#periodString').find('.period-date').toggle(showSingle); + $('#periodString').find('.period-range').toggle(!showSingle); $('#calendarRangeApply').toggle(!showSingle); }; @@ -379,13 +379,13 @@ return false; }; - $("#otherPeriods label").on('click', function (e) { + $("#otherPeriods").find("label").on('click', function (e) { var id = $(e.target).attr('for'); changePeriodOnClick($('#' + id)); }); // when non-range period is clicked, change the period & refresh the date picker - $("#otherPeriods input").on('click', function (e) { + $("#otherPeriods").find("input").on('click', function (e) { var request_URL = $(e.target).val(), period = broadcast.getValueFromUrl('period', request_URL), lastPeriod = selectedPeriod; @@ -443,7 +443,7 @@ // reset date/period when opening calendar var firstClick = true; - $('#periodString #date').click(function () { + $('#periodString').find('#date').click(function () { if (!firstClick) { datepickerElem.datepicker('setDate', currentDate); $('#period_id_' + piwik.period).click(); @@ -497,7 +497,7 @@ if (!isValidDate(oDateFrom) || !isValidDate(oDateTo) || oDateFrom > oDateTo) { - $('#alert h2').text(_pk_translate('General_InvalidDateRange_js')); + $('#alert').find('h2').text(_pk_translate('General_InvalidDateRange_js')); piwikHelper.modalConfirm('#alert', {}); return false; } diff --git a/plugins/CoreHome/templates/datatable.js b/plugins/CoreHome/templates/datatable.js index 49725bead6..1369b11786 100644 --- a/plugins/CoreHome/templates/datatable.js +++ b/plugins/CoreHome/templates/datatable.js @@ -1366,7 +1366,7 @@ dataTable.prototype = // if this url is also the url of a menu item, better to click that menu item instead of // doing AJAX request var menuItem = null; - $("#root>ul.nav a").each(function () { + $("#root").find(">ul.nav a").each(function () { if ($(this).attr('name') == url) { menuItem = this; return false diff --git a/plugins/CoreHome/templates/date.js b/plugins/CoreHome/templates/date.js index 1c6c5971bd..9e4ca30c72 100644 --- a/plugins/CoreHome/templates/date.js +++ b/plugins/CoreHome/templates/date.js @@ -23,7 +23,7 @@ $(document).ready(function () { } }; - $("#periodString #date") + $("#periodString").find("#date") .hover(function () { $(this).css({ cursor: "pointer"}); }, function () { @@ -32,7 +32,7 @@ $(document).ready(function () { .click(function () { periodWidget.toggle(); if ($("#periodMore").is(":visible")) { - $("#periodMore .ui-state-highlight").removeClass('ui-state-highlight'); + $("#periodMore").find(".ui-state-highlight").removeClass('ui-state-highlight'); } }); diff --git a/plugins/Dashboard/templates/dashboard.js b/plugins/Dashboard/templates/dashboard.js index c1c6996f93..40a3cb04fd 100644 --- a/plugins/Dashboard/templates/dashboard.js +++ b/plugins/Dashboard/templates/dashboard.js @@ -24,7 +24,7 @@ function initDashboard(dashboardId, dashboardLayout) { if (!$('#topBars').length) { $('#dashboardSettings').css({left: 0}); $('#dashboardSettings').after($('#Dashboard')); - $('#Dashboard > ul li a').each(function () {$(this).css({width: this.offestWidth + 30, paddingLeft: 0, paddingRight: 0});}); + $('#Dashboard').find('> ul li a').each(function () {$(this).css({width: this.offestWidth + 30, paddingLeft: 0, paddingRight: 0});}); $('#Dashboard_embeddedIndex_' + dashboardId).addClass('sfHover'); } @@ -36,7 +36,7 @@ function initDashboard(dashboardId, dashboardLayout) { $('#removeDashboardLink').show(); } // fix position - $('#dashboardSettings .widgetpreview-widgetlist').css('paddingTop', $('#dashboardSettings .widgetpreview-categorylist').parent('li').position().top); + $('#dashboardSettings').find('.widgetpreview-widgetlist').css('paddingTop', $('#dashboardSettings').find('.widgetpreview-categorylist').parent('li').position().top); }); $('body').on('mouseup', function (e) { if (!$(e.target).parents('#dashboardSettings').length && !$(e.target).is('#dashboardSettings')) { @@ -56,7 +56,7 @@ function initDashboard(dashboardId, dashboardLayout) { $('#dashboardSettings').widgetPreview({ isWidgetAvailable: function (widgetUniqueId) { - return !$('#dashboardWidgetsArea [widgetId=' + widgetUniqueId + ']').length; + return !$('#dashboardWidgetsArea').find('[widgetId=' + widgetUniqueId + ']').length; }, onSelect: function (widgetUniqueId) { var widget = widgetsHelper.getWidgetObjectFromUniqueId(widgetUniqueId); @@ -66,7 +66,7 @@ function initDashboard(dashboardId, dashboardLayout) { resetOnSelect: true }); - $('#columnPreview>div').each(function () { + $('#columnPreview').find('>div').each(function () { var width = []; $('div', this).each(function () { width.push(this.className.replace(/width-/, '')); @@ -74,8 +74,8 @@ function initDashboard(dashboardId, dashboardLayout) { $(this).attr('layout', width.join('-')); }); - $('#columnPreview>div').on('click', function () { - $('#columnPreview>div').removeClass('choosen'); + $('#columnPreview').find('>div').on('click', function () { + $('#columnPreview').find('>div').removeClass('choosen'); $(this).addClass('choosen'); }); @@ -122,15 +122,15 @@ function renameDashboard() { } function removeDashboard() { - $('#removeDashboardConfirm h2 span').html($('#dashboardWidgetsArea').dashboard('getDashboardName')); + $('#removeDashboardConfirm').find('h2 span').html($('#dashboardWidgetsArea').dashboard('getDashboardName')); piwikHelper.modalConfirm('#removeDashboardConfirm', {yes: function () { $('#dashboardWidgetsArea').dashboard('removeDashboard'); }}); } function showChangeDashboardLayoutDialog() { - $('#columnPreview>div').removeClass('choosen'); - $('#columnPreview>div[layout=' + $('#dashboardWidgetsArea').dashboard('getColumnLayout') + ']').addClass('choosen'); + $('#columnPreview').find('>div').removeClass('choosen'); + $('#columnPreview').find('>div[layout=' + $('#dashboardWidgetsArea').dashboard('getColumnLayout') + ']').addClass('choosen'); piwikHelper.modalConfirm('#changeDashboardLayout', {yes: function () { - $('#dashboardWidgetsArea').dashboard('setColumnLayout', $('#changeDashboardLayout .choosen').attr('layout')); + $('#dashboardWidgetsArea').dashboard('setColumnLayout', $('#changeDashboardLayout').find('.choosen').attr('layout')); }}); } @@ -189,7 +189,7 @@ function copyDashboardToUser() { }, 'post'); ajaxRequest.setCallback( function (id) { - $('#alert h2').text(_pk_translate('Dashboard_DashboardCopied_js')); + $('#alert').find('h2').text(_pk_translate('Dashboard_DashboardCopied_js')); piwikHelper.modalConfirm('#alert', {}); } ); diff --git a/plugins/Dashboard/templates/dashboardObject.js b/plugins/Dashboard/templates/dashboardObject.js index 80d74f3e4d..8ea5037473 100644 --- a/plugins/Dashboard/templates/dashboardObject.js +++ b/plugins/Dashboard/templates/dashboardObject.js @@ -434,7 +434,7 @@ function buildMenu() { var success = function (dashboards) { - var dashboardMenuList = $('#Dashboard > ul'); + var dashboardMenuList = $('#Dashboard').find('> ul'); dashboardMenuList.empty(); if (dashboards.length > 1) { dashboardMenuList.show(); diff --git a/plugins/Feedback/templates/feedback.js b/plugins/Feedback/templates/feedback.js index cbf07b4863..9fa2b1be01 100644 --- a/plugins/Feedback/templates/feedback.js +++ b/plugins/Feedback/templates/feedback.js @@ -10,7 +10,7 @@ $(function () { if (feedback.size()) { var fbDiv = $('
').appendTo('body'); - $('a#topmenu-feedback').click(function () { + feedback.click(function () { if (fbDiv.html() == '') { fbDiv.html('
' + _pk_translate('General_Loading_js') + '
'); } diff --git a/plugins/Feedback/templates/index.tpl b/plugins/Feedback/templates/index.tpl index adff78c214..fb79427a6a 100644 --- a/plugins/Feedback/templates/index.tpl +++ b/plugins/Feedback/templates/index.tpl @@ -14,7 +14,7 @@ }); $('#feedback-form-submit').click(function () { - var feedback = $('#feedback-form form'); + var feedback = $('#feedback-form').find('form'); $('#feedback-form').hide(); $.post(feedback.attr('action'), feedback.serialize(), function (data) { $('#feedback-sent').show().html(data); diff --git a/plugins/Goals/templates/GoalForm.js b/plugins/Goals/templates/GoalForm.js index fa1d0beceb..354e061978 100644 --- a/plugins/Goals/templates/GoalForm.js +++ b/plugins/Goals/templates/GoalForm.js @@ -155,7 +155,7 @@ function bindListGoalEdit() { var goalId = $(this).attr('id'); var goal = piwik.goals[goalId]; - $('#confirm h2').text(sprintf(_pk_translate('Goals_DeleteGoalConfirm_js'), '"' + goal.name + '"')); + $('#confirm').find('h2').text(sprintf(_pk_translate('Goals_DeleteGoalConfirm_js'), '"' + goal.name + '"')); piwikHelper.modalConfirm('#confirm', {yes: function () { ajaxDeleteGoal(goalId); }}); diff --git a/plugins/PDFReports/templates/pdf.js b/plugins/PDFReports/templates/pdf.js index 75e3ff831b..266c403adf 100644 --- a/plugins/PDFReports/templates/pdf.js +++ b/plugins/PDFReports/templates/pdf.js @@ -30,8 +30,8 @@ function formSetEditReport(idReport) { toggleReportType(report.type); $('#report_description').html(report.description); - $('#report_type option[value=' + report.type + ']').prop('selected', 'selected'); - $('#report_period option[value=' + report.period + ']').prop('selected', 'selected'); + $('#report_type').find('option[value=' + report.type + ']').prop('selected', 'selected'); + $('#report_period').find('option[value=' + report.period + ']').prop('selected', 'selected'); $('#report_hour').val(report.hour); $('[name=report_format].' + report.type + ' option[value=' + report.format + ']').prop('selected', 'selected'); @@ -61,7 +61,7 @@ function getReportAjaxRequest(idReport, defaultApiMethod) { function toggleReportType(reportType) { resetReportParametersFunctions[reportType](); - $('#report_type option').each(function (index, type) { + $('#report_type').find('option').each(function (index, type) { $('.' + $(type).val()).hide(); }); $('.' + reportType).show(); @@ -74,7 +74,7 @@ function initManagePdf() { var apiParameters = getReportAjaxRequest(idReport, 'PDFReports.updateReport'); apiParameters.idReport = idReport; apiParameters.description = $('#report_description').val(); - apiParameters.reportType = $('#report_type option:selected').val(); + apiParameters.reportType = $('#report_type').find('option:selected').val(); apiParameters.reportFormat = $('[name=report_format].' + apiParameters.reportType + ' option:selected').val(); var reports = []; @@ -89,7 +89,7 @@ function initManagePdf() { var ajaxHandler = new ajaxHelper(); ajaxHandler.addParams(apiParameters, 'POST'); - ajaxHandler.addParams({period: $('#report_period option:selected').val()}, 'GET'); + ajaxHandler.addParams({period: $('#report_period').find('option:selected').val()}, 'GET'); ajaxHandler.addParams({hour: $('#report_hour').val()}, 'GET'); ajaxHandler.redirectOnSuccess(); ajaxHandler.setLoadingElement(); diff --git a/plugins/PDFReports/templates/report_parameters.tpl b/plugins/PDFReports/templates/report_parameters.tpl index 9afe1c409c..00b88a20ad 100644 --- a/plugins/PDFReports/templates/report_parameters.tpl +++ b/plugins/PDFReports/templates/report_parameters.tpl @@ -3,7 +3,7 @@ function updateEvolutionGraphParameterVisibility() {ldelim} var evolutionGraphParameterInput = $('.report_evolution_graph'); var nonApplicableDisplayFormats = ['1', '4']; - $.inArray($('#display_format option:selected').val(), nonApplicableDisplayFormats) != -1 ? + $.inArray($('#display_format').find('option:selected').val(), nonApplicableDisplayFormats) != -1 ? evolutionGraphParameterInput.hide() : evolutionGraphParameterInput.show(); {rdelim } @@ -29,7 +29,7 @@ if (reportParameters == null) return; - $('#display_format option[value=' + reportParameters.displayFormat + ']').prop('selected', 'selected'); + $('#display_format').find('option[value=' + reportParameters.displayFormat + ']').prop('selected', 'selected'); updateEvolutionGraphParameterVisibility(); if (reportParameters.emailMe === true) @@ -54,7 +54,7 @@ var parameters = Object(); - parameters.displayFormat = $('#display_format option:selected').val(); + parameters.displayFormat = $('#display_format').find('option:selected').val(); parameters.emailMe = $('#report_email_me').prop('checked'); parameters.evolutionGraph = $('#report_evolution_graph').prop('checked'); diff --git a/plugins/PrivacyManager/templates/privacySettings.js b/plugins/PrivacyManager/templates/privacySettings.js index 75de9b8caa..d420118fdc 100644 --- a/plugins/PrivacyManager/templates/privacySettings.js +++ b/plugins/PrivacyManager/templates/privacySettings.js @@ -95,10 +95,10 @@ $(document).ready(function () { }); // make sure the DB size estimate is reloaded every time a delete logs/reports setting is changed - $('#formDeleteSettings input[type=text]').each(function () { + $('#formDeleteSettings').find('input[type=text]').each(function () { $(this).change(reloadDbStats); }); - $('#formDeleteSettings input[type=checkbox]').each(function () { + $('#formDeleteSettings').find('input[type=checkbox]').each(function () { $(this).click(reloadDbStats); }); @@ -111,7 +111,7 @@ $(document).ready(function () { // hide all confirmation texts, then show the correct one based on what // type of deletion is enabled. - $('#confirmDeleteSettings>h2').each(function () { + $('#confirmDeleteSettings').find('>h2').each(function () { $(this).hide(); }); @@ -145,7 +145,7 @@ $(document).ready(function () { // if any option has been modified, abort purging and instruct user to save first var modified = false; - $('#formDeleteSettings input').each(function () { + $('#formDeleteSettings').find('input').each(function () { if (this.type === 'checkbox' || this.type === 'radio') { modified |= this.defaultChecked !== this.checked; } else { diff --git a/plugins/SegmentEditor/templates/Segmentation.js b/plugins/SegmentEditor/templates/Segmentation.js index d18dc9ee47..c6bb72080e 100644 --- a/plugins/SegmentEditor/templates/Segmentation.js +++ b/plugins/SegmentEditor/templates/Segmentation.js @@ -840,7 +840,7 @@ Segmentation = (function($) { "name": segmentName, "definition": segmentStr, "enabledAllUsers": user, - "idSite": $('#visible_to_website option:selected').attr('value') + "idSite": $('#visible_to_website').find('option:selected').attr('value') }; // determine if save or update should be performed if(segmentId === ""){ diff --git a/plugins/SitesManager/templates/SitesManager.js b/plugins/SitesManager/templates/SitesManager.js index 4d32b283f3..2f3c777927 100644 --- a/plugins/SitesManager/templates/SitesManager.js +++ b/plugins/SitesManager/templates/SitesManager.js @@ -117,8 +117,8 @@ function SitesManager(_timezones, _currencies, _defaultTimezone, _defaultCurrenc } function sendGlobalSettingsAJAX() { - var timezone = $('#defaultTimezone option:selected').val(); - var currency = $('#defaultCurrency option:selected').val(); + var timezone = $('#defaultTimezone').find('option:selected').val(); + var currency = $('#defaultCurrency').find('option:selected').val(); var excludedIps = $('textarea#globalExcludedIps').val(); excludedIps = piwikHelper.getApiFormatTextarea(excludedIps); var excludedQueryParameters = $('textarea#globalExcludedQueryParameters').val(); @@ -199,7 +199,7 @@ function SitesManager(_timezones, _currencies, _defaultTimezone, _defaultCurrenc var nameToDelete = $(this).parent().parent().find('input#siteName').val() || $(this).parent().parent().find('td#siteName').html(); var idsiteToDelete = $(this).parent().parent().find('#idSite').html(); - $('#confirm h2').text(sprintf(_pk_translate('SitesManager_DeleteConfirm_js'), '"' + nameToDelete + '" (idSite = ' + idsiteToDelete + ')')); + $('#confirm').find('h2').text(sprintf(_pk_translate('SitesManager_DeleteConfirm_js'), '"' + nameToDelete + '" (idSite = ' + idsiteToDelete + ')')); piwikHelper.modalConfirm('#confirm', {yes: function () { sendDeleteSiteAJAX(idsiteToDelete); }}); @@ -213,7 +213,7 @@ function SitesManager(_timezones, _currencies, _defaultTimezone, _defaultCurrenc var idRow = $(this).attr('id'); if (alreadyEdited[idRow] == 1) return; if (siteBeingEdited) { - $('#alert h2').text(sprintf(_pk_translate('SitesManager_OnlyOneSiteAtTime_js'), '"' + $("
").html(siteBeingEditedName).text() + '"')); + $('#alert').find('h2').text(sprintf(_pk_translate('SitesManager_OnlyOneSiteAtTime_js'), '"' + $("
").html(siteBeingEditedName).text() + '"')); piwikHelper.modalConfirm('#alert', {}); return; } diff --git a/plugins/UserCountry/templates/admin.js b/plugins/UserCountry/templates/admin.js index 69857b7294..4b7e191076 100755 --- a/plugins/UserCountry/templates/admin.js +++ b/plugins/UserCountry/templates/admin.js @@ -177,7 +177,7 @@ $(document).ready(function () { // setup the auto-updater var ajaxRequest = new ajaxHelper(); ajaxRequest.addParams({ - period: $('#geoip-update-period-cell>input:checked').val() + period: $('#geoip-update-period-cell').find('>input:checked').val() }, 'get'); ajaxRequest.addParams({ module: 'UserCountry', diff --git a/plugins/UserCountryMap/js/realtime-map.js b/plugins/UserCountryMap/js/realtime-map.js index 431b749089..54d5cdfdc3 100644 --- a/plugins/UserCountryMap/js/realtime-map.js +++ b/plugins/UserCountryMap/js/realtime-map.js @@ -215,7 +215,7 @@ * that corresponds to a visit on the map */ function highlightVisit(r) { - $('#visitsLive li#' + r.idVisit + ' .datetime') + $('#visitsLive').find('li#' + r.idVisit + ' .datetime') .css('background', '#E4CD74'); } @@ -224,7 +224,7 @@ * the visit marker on the map */ function unhighlightVisit(r) { - $('#visitsLive li#' + r.idVisit + ' .datetime') + $('#visitsLive').find('li#' + r.idVisit + ' .datetime') .css({ background: '#E4E2D7' }); } diff --git a/plugins/UsersManager/templates/UsersManager.js b/plugins/UsersManager/templates/UsersManager.js index 0db663d7c2..c24cbf73e6 100644 --- a/plugins/UsersManager/templates/UsersManager.js +++ b/plugins/UsersManager/templates/UsersManager.js @@ -196,7 +196,7 @@ $(document).ready(function () { piwikHelper.hideAjaxError(); var idRow = $(this).attr('id'); var loginToDelete = $(this).parent().parent().find('#userLogin').html(); - $('#confirmUserRemove h2').text(sprintf(_pk_translate('UsersManager_DeleteConfirm_js'), '"' + loginToDelete + '"')); + $('#confirmUserRemove').find('h2').text(sprintf(_pk_translate('UsersManager_DeleteConfirm_js'), '"' + loginToDelete + '"')); piwikHelper.modalConfirm('#confirmUserRemove', {yes: function () { sendDeleteUserAJAX(loginToDelete); }}); } ); diff --git a/plugins/UsersManager/templates/userSettings.js b/plugins/UsersManager/templates/userSettings.js index 0bfdf3d8bb..5708ca7a72 100644 --- a/plugins/UsersManager/templates/userSettings.js +++ b/plugins/UsersManager/templates/userSettings.js @@ -23,7 +23,7 @@ function sendUserSettingsAJAX() { var passwordBis = $('#passwordBis').val(); var defaultReport = $('input[name=defaultReport]:checked').val(); if (defaultReport == 1) { - defaultReport = $('#defaultReportSiteSelector .custom_select_main_link').attr('siteid'); + defaultReport = $('#defaultReportSiteSelector').find('.custom_select_main_link').attr('siteid'); } var postParams = {}; postParams.alias = alias; @@ -52,7 +52,7 @@ function sendUserSettingsAJAX() { function sendAnonymousUserSettingsAJAX() { var anonymousDefaultReport = $('input[name=anonymousDefaultReport]:checked').val(); if (anonymousDefaultReport == 1) { - anonymousDefaultReport = $('#anonymousDefaultReportWebsite option:selected').val(); + anonymousDefaultReport = $('#anonymousDefaultReportWebsite').find('option:selected').val(); } var anonymousDefaultDate = $('input[name=anonymousDefaultDate]:checked').val(); @@ -81,7 +81,7 @@ $(document).ready(function () { } }); - $('#userSettingsTable input').keypress(function (e) { + $('#userSettingsTable').find('input').keypress(function (e) { var key = e.keyCode || e.which; if (key == 13) { $('#userSettingsSubmit').click(); -- cgit v1.2.3 From fa4b7c4aad5f6e715f922f3528560139ecf462ef Mon Sep 17 00:00:00 2001 From: mattab Date: Sat, 27 Apr 2013 02:47:27 +1200 Subject: Refs #3913 adding XML files so the build passes, but tests output is empty for now. Also moving to private unused methods (lets delete any unused method) --- plugins/Dashboard/API.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'plugins') diff --git a/plugins/Dashboard/API.php b/plugins/Dashboard/API.php index 14a058b2aa..7c5df1e858 100644 --- a/plugins/Dashboard/API.php +++ b/plugins/Dashboard/API.php @@ -46,7 +46,7 @@ class Piwik_Dashboard_API * * @return array[] */ - public function getDashboards() + private function getDashboards() { $dashboards = $this->getUserDashboards(); @@ -62,7 +62,7 @@ class Piwik_Dashboard_API * * @return array[] */ - public function getDefaultDashboard() + private function getDefaultDashboard() { $defaultLayout = $this->dashboard->getDefaultLayout(); $defaultLayout = $this->dashboard->decodeLayout($defaultLayout); -- cgit v1.2.3 From 096f8904eba39dd35e29dacea6f103576580f807 Mon Sep 17 00:00:00 2001 From: mattab Date: Tue, 7 May 2013 17:24:04 +1200 Subject: Fixing build refs #3913 Fixes API for dashboards + disabling Dashboard API tests for now --- plugins/Dashboard/API.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'plugins') diff --git a/plugins/Dashboard/API.php b/plugins/Dashboard/API.php index 7c5df1e858..59ae8b9ae1 100644 --- a/plugins/Dashboard/API.php +++ b/plugins/Dashboard/API.php @@ -46,7 +46,7 @@ class Piwik_Dashboard_API * * @return array[] */ - private function getDashboards() + public function getDashboards() { $dashboards = $this->getUserDashboards(); @@ -79,7 +79,7 @@ class Piwik_Dashboard_API * * @return array[] */ - public function getUserDashboards() + private function getUserDashboards() { $userLogin = Piwik::getCurrentUserLogin(); $userDashboards = $this->dashboard->getAllDashboards($userLogin); -- cgit v1.2.3 From c76b1e77a37ae930ea9cc8bc5b01eed737556d1c Mon Sep 17 00:00:00 2001 From: mattab Date: Tue, 7 May 2013 17:45:34 +1200 Subject: missing files for build --- plugins/SegmentEditor/API.php | 48 ++++++++++++++++----------------- plugins/SegmentEditor/SegmentEditor.php | 4 +-- 2 files changed, 25 insertions(+), 27 deletions(-) (limited to 'plugins') diff --git a/plugins/SegmentEditor/API.php b/plugins/SegmentEditor/API.php index 19083f8e42..f0d699005b 100644 --- a/plugins/SegmentEditor/API.php +++ b/plugins/SegmentEditor/API.php @@ -153,25 +153,6 @@ class Piwik_SegmentEditor_API return $db->lastInsertId(); } - public function getSegmentsToAutoArchive($idSite = false) - { - Piwik::checkUserIsSuperUser(); - - $sqlRestrictSite = ''; - $bind = array(); - if ($idSite) { - $sqlRestrictSite = 'OR enable_only_idsite = ?'; - $bind = array($idSite); - } - $segments = Zend_Registry::get('db')->fetchAll("SELECT * - FROM " . Piwik_Common::prefixTable("segment") . " - WHERE auto_archive = 1 - AND deleted = 0 - AND (enable_only_idsite IS NULL " . $sqlRestrictSite . " )", $bind - ); - return $segments; - } - public function get($idSegment) { Piwik::checkUserHasSomeViewAccess(); @@ -188,7 +169,8 @@ class Piwik_SegmentEditor_API try { Piwik::checkUserIsSuperUserOrTheUser($segment['login']); } catch (Exception $e) { - throw new Exception("You can only manage your own segments (unless you are Super User)."); + throw new Exception("You can only edit the custom segments you have created yourself. This segment was created and 'shared with you' by the Super User. " . + "To modify this segment, you can create a new one, by clicking on 'Add new segment' where you can then further customize the segment's definition."); } if ($segment['deleted']) { @@ -211,17 +193,33 @@ class Piwik_SegmentEditor_API return $segment; } - public function getAll($idSite) + public function getAll($idSite = false, $returnAutoArchived = false) { - Piwik::checkUserHasViewAccess($idSite); + if(!empty($idSite) ) { + Piwik::checkUserHasViewAccess($idSite); + } else { + Piwik::checkUserHasSomeViewAccess(); + } + + $extraWhere = ''; + if($returnAutoArchived) { + $extraWhere = ' AND auto_archive = 1'; + } + + $whereIdSite = ''; + $bind = array(Piwik::getCurrentUserLogin()); + if(!empty($idSite)) { + $whereIdSite = 'enable_only_idsite = ? OR '; + $bind = array($idSite, Piwik::getCurrentUserLogin()); + } $sql = "SELECT * " . - " FROM " . Piwik_Common::prefixTable("segment") . - " WHERE (enable_only_idsite = ? OR enable_only_idsite IS NULL) + " FROM " . Piwik_Common::prefixTable("segment") . + " WHERE ($whereIdSite enable_only_idsite IS NULL) AND (enable_all_users = 1 OR login = ?) AND deleted = 0 + $extraWhere ORDER BY name ASC"; - $bind = array($idSite, Piwik::getCurrentUserLogin()); $segments = Zend_Registry::get('db')->fetchAll($sql, $bind); return $segments; diff --git a/plugins/SegmentEditor/SegmentEditor.php b/plugins/SegmentEditor/SegmentEditor.php index 0087f2e614..7c587c4a18 100644 --- a/plugins/SegmentEditor/SegmentEditor.php +++ b/plugins/SegmentEditor/SegmentEditor.php @@ -45,7 +45,7 @@ class Piwik_SegmentEditor extends Piwik_Plugin public function getKnownSegmentsToArchiveAllSites($notification) { $segments =& $notification->getNotificationObject(); - $segmentToAutoArchive = Piwik_SegmentEditor_API::getInstance()->getSegmentsToAutoArchive(); + $segmentToAutoArchive = Piwik_SegmentEditor_API::getInstance()->getAll($idSite = false, $returnAutoArchived = true); if (!empty($segmentToAutoArchive)) { $segments = array_merge($segments, $segmentToAutoArchive); } @@ -55,7 +55,7 @@ class Piwik_SegmentEditor extends Piwik_Plugin { $segments =& $notification->getNotificationObject(); $idSite = $notification->getNotificationInfo(); - $segmentToAutoArchive = Piwik_SegmentEditor_API::getInstance()->getSegmentsToAutoArchive($idSite); + $segmentToAutoArchive = Piwik_SegmentEditor_API::getInstance()->getAll($idSite, $returnAutoArchived = true); foreach ($segmentToAutoArchive as $segmentInfo) { $segments[] = $segmentInfo['definition']; -- cgit v1.2.3 From 47cda36e60359e8a3de01eaeb86b4edbac315532 Mon Sep 17 00:00:00 2001 From: mattab Date: Tue, 7 May 2013 18:20:49 +1200 Subject: fixes #3926 thanks for the suggestion, fixing Piwik core to allow several translations whether the period is used in the sentence or standalone --- plugins/PDFReports/PDFReports.php | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) (limited to 'plugins') diff --git a/plugins/PDFReports/PDFReports.php b/plugins/PDFReports/PDFReports.php index 1533a70192..a6f0b1d572 100644 --- a/plugins/PDFReports/PDFReports.php +++ b/plugins/PDFReports/PDFReports.php @@ -310,7 +310,7 @@ class Piwik_PDFReports extends Piwik_Plugin $filename = $notificationInfo[Piwik_PDFReports_API::FILENAME_KEY]; $additionalFiles = $notificationInfo[Piwik_PDFReports_API::ADDITIONAL_FILES_KEY]; - $periods = self::getPeriodToFrequency(); + $periods = self::getPeriodToFrequencyAsAdjective(); $message = Piwik_Translate('PDFReports_EmailHello'); $subject = Piwik_Translate('General_Report') . ' ' . $reportTitle . " - " . $prettyDate; @@ -606,6 +606,7 @@ class Piwik_PDFReports extends Piwik_Plugin } /** + * Used in the Report Listing * @ignore */ static public function getPeriodToFrequency() @@ -617,4 +618,18 @@ class Piwik_PDFReports extends Piwik_Plugin Piwik_ScheduledTime::PERIOD_MONTH => Piwik_Translate('General_Monthly'), ); } + + /** + * Used in the Report's email content, ie "monthly report" + * @ignore + */ + static public function getPeriodToFrequencyAsAdjective() + { + return array( + Piwik_ScheduledTime::PERIOD_DAY => Piwik_Translate('General_DailyReport'), + Piwik_ScheduledTime::PERIOD_WEEK => Piwik_Translate('General_WeeklyReport'), + Piwik_ScheduledTime::PERIOD_MONTH => Piwik_Translate('General_MonthlyReport'), + Piwik_ScheduledTime::PERIOD_YEAR => Piwik_Translate('General_YearlyReport'), + ); + } } -- cgit v1.2.3 From 9302709b4beccdd1d94b58e0791a8373b89d355e Mon Sep 17 00:00:00 2001 From: mattab Date: Fri, 10 May 2013 20:17:14 +1200 Subject: * fixing error/bug in Transition * Multi-Row evolution + Limit selector "10/50/100/500" now works as expected --- plugins/CoreHome/DataTableRowAction/MultiRowEvolution.php | 3 ++- plugins/Transitions/API.php | 5 +---- 2 files changed, 3 insertions(+), 5 deletions(-) (limited to 'plugins') diff --git a/plugins/CoreHome/DataTableRowAction/MultiRowEvolution.php b/plugins/CoreHome/DataTableRowAction/MultiRowEvolution.php index 4c4a964c2e..1e761a0aae 100644 --- a/plugins/CoreHome/DataTableRowAction/MultiRowEvolution.php +++ b/plugins/CoreHome/DataTableRowAction/MultiRowEvolution.php @@ -74,12 +74,13 @@ class Piwik_CoreHome_DataTableRowAction_MultiRowEvolution /** * Generic method to get an evolution graph or a sparkline for the row evolution popover. * Do as much as possible from outside the controller. + * * @return Piwik_ViewDataTable */ public function getRowEvolutionGraph() { $view = parent::getRowEvolutionGraph(); - $view->setCustomParameter(self::IS_MULTI_EVOLUTION_PARAM, true); + $view->setCustomParameter(self::IS_MULTI_EVOLUTION_PARAM, 1); // set in JS return $view; } } diff --git a/plugins/Transitions/API.php b/plugins/Transitions/API.php index 4457d71046..6712045238 100644 --- a/plugins/Transitions/API.php +++ b/plugins/Transitions/API.php @@ -139,7 +139,7 @@ class Piwik_Transitions_API if ($id < 0) { // an example where this is needed is urls containing < or > $actionName = $originalActionName; - $id = $actionsPlugin->getIdActionFromSegment($actionName, 'idaction_url', Piwik_SegmentExpression::MATCH_EQUALs, 'pageUrl'); + $id = $actionsPlugin->getIdActionFromSegment($actionName, 'idaction_url', Piwik_SegmentExpression::MATCH_EQUAL, 'pageUrl'); } return $id; @@ -289,9 +289,6 @@ class Piwik_Transitions_API } } - /** - * @ignore - */ public function getTranslations() { $controller = new Piwik_Transitions_Controller(); -- cgit v1.2.3 From 028342ad359aa86515c7d404c76b780ab3addcc4 Mon Sep 17 00:00:00 2001 From: mattab Date: Fri, 10 May 2013 20:19:05 +1200 Subject: Refs #2135 * Fixing some encoding issues and many small bugs * When user is anonymous, show message inviting user to login to try the feature --- plugins/API/API.php | 7 +- .../CoreHome/DataTableRowAction/RowEvolution.php | 7 +- plugins/CoreHome/templates/broadcast.js | 43 ++++++---- plugins/SegmentEditor/API.php | 11 ++- plugins/SegmentEditor/Controller.php | 5 +- plugins/SegmentEditor/templates/Segmentation.css | 5 +- plugins/SegmentEditor/templates/Segmentation.js | 91 +++++++++++++--------- plugins/SegmentEditor/templates/selector.tpl | 11 ++- 8 files changed, 116 insertions(+), 64 deletions(-) (limited to 'plugins') diff --git a/plugins/API/API.php b/plugins/API/API.php index c8a92f5ca0..e9d3511f19 100644 --- a/plugins/API/API.php +++ b/plugins/API/API.php @@ -1161,14 +1161,11 @@ class Piwik_API_API throw new Exception("Row evolutions can not be processed with this combination of \'date\' and \'period\' parameters."); } - // this is needed because Piwik_API_Proxy uses Piwik_Common::getRequestVar which in turn - // uses Piwik_Common::sanitizeInputValue. This causes the > that separates recursive labels - // to become > and we need to undo that here. - $label = Piwik_Common::unsanitizeInputValue($label); - + $label = Piwik_API_ResponseBuilder::unsanitizeLabelParameter($label); if ($label) { $labels = explode(',', $label); $labels = array_unique($labels); + $labels = array_map('urldecode', $labels); } else { $labels = array(); } diff --git a/plugins/CoreHome/DataTableRowAction/RowEvolution.php b/plugins/CoreHome/DataTableRowAction/RowEvolution.php index 8561d8734a..5df1ce3e16 100644 --- a/plugins/CoreHome/DataTableRowAction/RowEvolution.php +++ b/plugins/CoreHome/DataTableRowAction/RowEvolution.php @@ -74,8 +74,9 @@ class Piwik_CoreHome_DataTableRowAction_RowEvolution $this->apiMethod = Piwik_Common::getRequestVar('apiMethod', '', 'string'); if (empty($this->apiMethod)) throw new Exception("Parameter apiMethod not set."); - $this->label = Piwik_Common::getRequestVar('label', '', 'string'); - $this->label = Piwik_Common::unsanitizeInputValue($this->label); + $this->label = Piwik_API_ResponseBuilder::getLabelFromRequest($_GET); + $this->label = $this->label[0]; + if ($this->label === '') throw new Exception("Parameter label not set."); $this->period = Piwik_Common::getRequestVar('period', '', 'string'); @@ -132,7 +133,7 @@ class Piwik_CoreHome_DataTableRowAction_RowEvolution $parameters = array( 'method' => 'API.getRowEvolution', - 'label' => urlencode($this->label), + 'label' => $this->label, 'apiModule' => $apiModule, 'apiAction' => $apiAction, 'idSite' => $this->idSite, diff --git a/plugins/CoreHome/templates/broadcast.js b/plugins/CoreHome/templates/broadcast.js index 0301425875..31c3fb6c29 100644 --- a/plugins/CoreHome/templates/broadcast.js +++ b/plugins/CoreHome/templates/broadcast.js @@ -307,10 +307,13 @@ var broadcast = { if (paramValue == '') { newParamValue = ''; } + var getQuotedRegex = function(str) { + return (str+'').replace(/([.?*+^$[\]\\(){}|-])/g, "\\$1"); + }; + if (valFromUrl != '') { // replacing current param=value to newParamValue; - valFromUrl = valFromUrl.replace(/\$/g, '\\$'); - valFromUrl = valFromUrl.replace(/\./g, '\\.'); + valFromUrl = getQuotedRegex(valFromUrl); var regToBeReplace = new RegExp(paramName + '=' + valFromUrl, 'ig'); if (newParamValue == '') { // if new value is empty remove leading &, aswell @@ -459,7 +462,7 @@ var broadcast = { hashStr = url.substring(url.indexOf("#"), url.length); } else { - hashStr = decodeURIComponent(location.hash); + hashStr = (location.hash); } return hashStr; @@ -485,26 +488,35 @@ var broadcast = { }, /** - * Returns all key-value pairs in query string of url. - * - * @param {string} url url to check. if undefined, null or empty, current url is used. - * @return {object} key value pair describing query string parameters + * Extracts from a query strings, the request array + * @param queryString + * @returns {object} */ - getValuesFromUrl: function (url) { - var searchString = this._removeHashFromUrl(url).split('?')[1] || '', - pairs = searchString.split('&'); - + extractKeyValuePairsFromQueryString: function (queryString) { + var pairs = queryString.split('&'); var result = {}; for (var i = 0; i != pairs.length; ++i) { // attn: split with regex has bugs in several browsers such as IE 8 // so we need to split, use the first part as key and rejoin the rest var pair = pairs[i].split('='); - var key = pair.shift(); + var key = pair.shift(); result[key] = pair.join('='); } return result; }, + /** + * Returns all key-value pairs in query string of url. + * + * @param {string} url url to check. if undefined, null or empty, current url is used. + * @return {object} key value pair describing query string parameters + */ + getValuesFromUrl: function (url) { + var searchString = this._removeHashFromUrl(url).split('?')[1] || ''; + return this.extractKeyValuePairsFromQueryString(searchString); + }, + + /** * help to get param value for any given url string with provided param name * if no url is provided, it will get param from current address. @@ -558,9 +570,12 @@ var broadcast = { endStr = url.length; } var value = url.substring(startStr + param.length + 1, endStr); - // sanitize values - value = value.replace(/[^_%\+\-\<\>!@\$\.=,;0-9a-zA-Z]/gi, ''); + // we sanitize values to add a protection layer against XSS + // &segment= value is not sanitized, since segments are designed to accept any user input + if(param != 'segment') { + value = value.replace(/[^_%~\*\+\-\<\>!@\$\.()=,;0-9a-zA-Z]/gi, ''); + } return value; } else { return ''; diff --git a/plugins/SegmentEditor/API.php b/plugins/SegmentEditor/API.php index f0d699005b..ad6ab062f8 100644 --- a/plugins/SegmentEditor/API.php +++ b/plugins/SegmentEditor/API.php @@ -31,12 +31,19 @@ class Piwik_SegmentEditor_API protected function checkSegmentValue($definition, $idSite) { + // unsanitize so we don't record the HTML entitied segment + $definition = Piwik_Common::unsanitizeInputValue($definition); + $definition = str_replace("#", '%23', $definition); // hash delimiter + $definition = str_replace("'", '%27', $definition); // not encoded in JS + $definition = str_replace("&", '%26', $definition); + try { $segment = new Piwik_Segment($definition, $idSite); $segment->getHash(); } catch (Exception $e) { throw new Exception("The specified segment is invalid: " . $e->getMessage()); } + return $definition; } protected function checkSegmentName($name) @@ -106,7 +113,7 @@ class Piwik_SegmentEditor_API { $this->checkIdSite($idSite); $this->checkSegmentName($name); - $this->checkSegmentValue($definition, $idSite); + $definition = $this->checkSegmentValue($definition, $idSite); $enabledAllUsers = $this->checkEnabledAllUsers($enabledAllUsers); $autoArchive = $this->checkAutoArchive($autoArchive, $idSite); @@ -134,7 +141,7 @@ class Piwik_SegmentEditor_API Piwik::checkUserIsNotAnonymous(); $this->checkIdSite($idSite); $this->checkSegmentName($name); - $this->checkSegmentValue($definition, $idSite); + $definition = $this->checkSegmentValue($definition, $idSite); $enabledAllUsers = $this->checkEnabledAllUsers($enabledAllUsers); $autoArchive = $this->checkAutoArchive($autoArchive, $idSite); diff --git a/plugins/SegmentEditor/Controller.php b/plugins/SegmentEditor/Controller.php index 848171044f..3693b14f76 100644 --- a/plugins/SegmentEditor/Controller.php +++ b/plugins/SegmentEditor/Controller.php @@ -34,9 +34,12 @@ class Piwik_SegmentEditor_Controller extends Piwik_Controller $view->segmentsByCategory = $segmentsByCategory; - $savedSegments = Piwik_SegmentEditor_API::getInstance()->getAll($idSite); + foreach($savedSegments as &$savedSegment) { + $savedSegment['definition'] = str_replace( ''', "'", $savedSegment['definition']); + } $view->savedSegmentsJson = Piwik_Common::json_encode($savedSegments); + $view->authorizedToCreateSegments = !Piwik::isUserIsAnonymous(); $out = $view->render(); echo $out; diff --git a/plugins/SegmentEditor/templates/Segmentation.css b/plugins/SegmentEditor/templates/Segmentation.css index 0f40b15474..1767c4ac1f 100644 --- a/plugins/SegmentEditor/templates/Segmentation.css +++ b/plugins/SegmentEditor/templates/Segmentation.css @@ -371,7 +371,7 @@ div.scrollable { z-index: 2; background: #f7f7f7; border: 1px solid #e4e5e4; - padding: 5px 10px 6px 5px; + padding: 5px 10px 6px 10px; border-radius: 4px; -moz-border-radius: 4px; -webkit-border-radius: 4px; @@ -387,7 +387,6 @@ div.scrollable { } .segmentationContainer .submenu { font-size: 13px; - font-weight: bold; min-width: 180px; } .segmentationContainer .submenu ul { @@ -402,7 +401,7 @@ div.scrollable { padding-top: 10px; } .segmentationContainer .submenu ul li { - padding: 2px 0px 1px 10px; + padding: 2px 0px 1px 6px; margin: 3px 0 0 0; cursor: pointer; } diff --git a/plugins/SegmentEditor/templates/Segmentation.js b/plugins/SegmentEditor/templates/Segmentation.js index c6bb72080e..eb8379efe9 100644 --- a/plugins/SegmentEditor/templates/Segmentation.js +++ b/plugins/SegmentEditor/templates/Segmentation.js @@ -42,7 +42,10 @@ Segmentation = (function($) { segmentation.prototype.getSegment = function(){ var self = this; - return self.currentSegmentStr; + if($.browser.mozilla) { + return self.currentSegmentStr; + } + return decodeURIComponent(self.currentSegmentStr); } var setSegment = function(segmentStr){ @@ -51,7 +54,7 @@ Segmentation = (function($) { segmentation.prototype.shortenSegmentName = function(name, length){ - if(typeof length === "undefined") length = 30; + if(typeof length === "undefined") length = 26; if(typeof name === "undefined") name = ""; var i; @@ -73,24 +76,22 @@ Segmentation = (function($) { var markCurrentSegment = function(){ var current = self.getSegment(); -// window.setTimeout(function(){ - var segmentationTitle = $(self.content).find(".segmentationTitle"); - if( current != "") - { - var foundItems = $(self.content).find('div.segmentList > ul > li[data-definition="'+current+'"]'); - if( foundItems.length > 0) - { - var name = $(foundItems).first().find("span.segname").text(); - segmentationTitle.html(""+name+""); - } - else{ - segmentationTitle.html("Custom Segment"); - } - } - else { - $(self.content).find(".segmentationTitle").text("All visits"); + + var segmentationTitle = $(self.content).find(".segmentationTitle"); + if( current != "") + { + var selector = 'div.segmentList ul li[data-definition="'+current+'"]'; + var foundItems = $(selector); + if( foundItems.length > 0) { + var name = $(foundItems).first().find("span.segname").text(); + segmentationTitle.html(""+name+""); + } else { + segmentationTitle.html("Custom Segment"); } -// }, 20); + } + else { + $(self.content).find(".segmentationTitle").text("All visits"); + } } var getAndDiv = function(){ @@ -185,17 +186,17 @@ Segmentation = (function($) { var segment, injClass; var listHtml = '
  • All Visits (default)
    • '; if(self.segmentList.length > 0) { for(var key in self.segmentList) { segment = self.segmentList[key]; injClass = ""; - if( segment.definition == self.currentSegmentsGlobal){ + if( segment.definition == self.currentSegmentStr){ injClass = 'class="segmentSelected"'; } - listHtml += '
  • ' + self.shortenSegmentName(segment.name)+''; if(self.segmentAccess == "write") { @@ -224,12 +225,12 @@ Segmentation = (function($) { //$("body").append(html); var segmentsDropdown = $(html).find("#available_segments_select"); var segment, newOption; - newOption = ''; + newOption = ''; segmentsDropdown.append(newOption); for(var key in self.segmentList) { segment = self.segmentList[key]; - newOption = ''; + newOption = ''; segmentsDropdown.append(newOption); } $(html).find(".segment-content > h3").after(getInitialStateRowsHtml()).show(); @@ -274,7 +275,7 @@ Segmentation = (function($) { if( index != -1){ if(index < minPos){ minPos = index; - if(match == ">" || match == "<"){ + if(match.length == 1){ singleChar = true; } } @@ -301,6 +302,10 @@ Segmentation = (function($) { newMetric.value = ""; } } + + // the segment values are URL encoded to prevent ",;<>@= etc. from being misinterpreted + newMetric.value = decodeURIComponent(newMetric.value); + return newMetric; } @@ -363,7 +368,7 @@ Segmentation = (function($) { var target = $(this).parent("li"); var segment = {}; segment.idsegment = target.attr("data-idsegment"); - segment.definition = target.attr("data-definition"); + segment.definition = target.data("definition"); segment.name = target.attr("title"); openEditForm(segment); e.stopPropagation(); @@ -374,9 +379,9 @@ Segmentation = (function($) { if($(e.currentTarget).hasClass("grayed") !== true){ var segment = {}; segment.idsegment = $(this).attr("data-idsegment"); - segment.definition = $(this).attr("data-definition"); + segment.definition = $(this).data("definition"); segment.name = $(this).attr("title"); - self.segmentSelectMethod(segment); + self.segmentSelectMethod( segment.definition ); setSegment(segment.definition); markCurrentSegment(); } @@ -518,7 +523,7 @@ Segmentation = (function($) { var segment = {}; segment.idsegment = option.attr("data-idsegment"); segment.name = option.attr("title"); - segment.definition = option.attr("data-definition"); + segment.definition = option.data("definition"); openEditForm(segment); }); @@ -940,12 +945,24 @@ $(document).ready( function(){ return; } - var changeSegment = function(params){ + var changeSegment = function(segmentDefinition){ $('#segmentEditorPanel a.close').click(); + segmentDefinition = cleanupSegmentDefinition(segmentDefinition); + +// if($.browser.mozilla ) { + segmentDefinition = encodeURIComponent(segmentDefinition); +// } +// alert('new segment to reload='+segmentDefinition); - return broadcast.propagateNewPage('segment=' + params.definition, true, true); + return broadcast.propagateNewPage('segment=' + segmentDefinition, true); }; + var cleanupSegmentDefinition = function(definition) { + definition = definition.replace("'", "%29"); + definition = definition.replace("&", "%26"); + return definition; + } + var addSegment = function(params){ var ajaxHandler = new ajaxHelper(); ajaxHandler.setLoadingElement(); @@ -954,13 +971,15 @@ $(document).ready( function(){ "format": 'json', "method": 'SegmentEditor.add' }); + params.definition = cleanupSegmentDefinition(params.definition); + ajaxHandler.addParams(params, 'GET'); ajaxHandler.useCallbackInCaseOfError(); ajaxHandler.setCallback(function (response) { if (response && response.result == 'error') { alert(response.message); } else { - changeSegment(params); + changeSegment(params.definition); } }); ajaxHandler.send(true); @@ -974,13 +993,15 @@ $(document).ready( function(){ "format": 'json', "method": 'SegmentEditor.update' }); + params.definition = cleanupSegmentDefinition(params.definition); + ajaxHandler.addParams(params, 'GET'); ajaxHandler.useCallbackInCaseOfError(); ajaxHandler.setCallback(function (response) { if (response && response.result == 'error') { alert(response.message); } else { - changeSegment(params); + changeSegment(params.definition); } }); ajaxHandler.send(true); @@ -1006,6 +1027,7 @@ $(document).ready( function(){ console.log(segmentStr); } + var segmentFromHash = broadcast.getParamValue('segment', location.hash); var segmentationFtw = new Segmentation({ "targetId" : "segmentList", "segmentAccess" : "write", @@ -1015,8 +1037,7 @@ $(document).ready( function(){ "deleteMethod": deleteSegment, "segmentSelectMethod": changeSegment, "testSegmentMethod": testSegment, - "currentSegmentStr": broadcast.getValueFromHash('segment'), - "currentSegmentsGlobal": broadcast.getValueFromHash('segment') + "currentSegmentStr": segmentFromHash }); $('body').on('mouseup',function(e){ diff --git a/plugins/SegmentEditor/templates/selector.tpl b/plugins/SegmentEditor/templates/selector.tpl index 2fb81cde55..8c0206c36b 100644 --- a/plugins/SegmentEditor/templates/selector.tpl +++ b/plugins/SegmentEditor/templates/selector.tpl @@ -1,8 +1,9 @@ @@ -131,11 +134,12 @@
    -

    Are you sure you want to delete this segment?

    +

    {'SegmentEditor_AreYouSureDeleteSegment'|translate}

    diff --git a/plugins/UserSettings/UserSettings.php b/plugins/UserSettings/UserSettings.php index 90be882806..a9e458536b 100644 --- a/plugins/UserSettings/UserSettings.php +++ b/plugins/UserSettings/UserSettings.php @@ -232,7 +232,7 @@ class Piwik_UserSettings extends Piwik_Plugin if (empty($segment)) continue; $segments[] = array( 'type' => 'dimension', - 'category' => 'Visit', + 'category' => Piwik_Translate('General_Visit'), 'name' => $columnName, 'segment' => $segment, 'acceptedValues' => $acceptedValues, diff --git a/plugins/VisitTime/VisitTime.php b/plugins/VisitTime/VisitTime.php index 5b05342bed..5e86570d44 100644 --- a/plugins/VisitTime/VisitTime.php +++ b/plugins/VisitTime/VisitTime.php @@ -114,7 +114,7 @@ class Piwik_VisitTime extends Piwik_Plugin $acceptedValues = "0, 1, 2, 3, ..., 20, 21, 22, 23"; $segments[] = array( 'type' => 'dimension', - 'category' => 'Visit', + 'category' => Piwik_Translate('General_Visit'), 'name' => Piwik_Translate('VisitTime_ColumnServerTime'), 'segment' => 'visitServerHour', 'sqlSegment' => 'HOUR(log_visit.visit_last_action_time)', @@ -122,7 +122,7 @@ class Piwik_VisitTime extends Piwik_Plugin ); $segments[] = array( 'type' => 'dimension', - 'category' => 'Visit', + 'category' => Piwik_Translate('General_Visit'), 'name' => Piwik_Translate('VisitTime_ColumnLocalTime'), 'segment' => 'visitLocalHour', 'sqlSegment' => 'HOUR(log_visit.visitor_localtime)', -- cgit v1.2.3 From 36fc4ca1db9840fe25bd0f6ac6f8e51ac5bd9a06 Mon Sep 17 00:00:00 2001 From: mattab Date: Wed, 15 May 2013 17:03:59 +1200 Subject: Refs #2135 * when changing website in the selector, the segment parameter will be reset (to no segment). --- plugins/CoreHome/templates/autocomplete.js | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) (limited to 'plugins') diff --git a/plugins/CoreHome/templates/autocomplete.js b/plugins/CoreHome/templates/autocomplete.js index 0e5fa3d1fa..1a9a523c21 100644 --- a/plugins/CoreHome/templates/autocomplete.js +++ b/plugins/CoreHome/templates/autocomplete.js @@ -14,7 +14,7 @@ function switchSite(id, name, showAjaxLoading, idCanBeAll) { $('.sites_autocomplete input').val(id); $('.custom_select_main_link').text(name); $('.custom_select_main_link').addClass('custom_select_loading'); - broadcast.propagateNewPage('idSite=' + id, showAjaxLoading); + broadcast.propagateNewPage('segment=&idSite=' + id, showAjaxLoading); } return false; } @@ -29,6 +29,15 @@ $(function () { // sets up every un-inited site selector widget piwik.initSiteSelectors = function () { + function getUrlForWebsiteId(idSite) { + var idSiteParam = 'idSite=' + idSite; + var newParameters = 'segment=&' + idSiteParam; + var hash = broadcast.isHashExists() ? broadcast.getHashFromUrl() : "", + linkUrl = piwikHelper.getCurrentQueryStringWithParametersModified(newParameters) + + '#' + piwikHelper.getQueryStringWithParametersModified(hash.substring(1), newParameters); + return linkUrl; + } + $('.sites_autocomplete').each(function () { var selector = $(this); @@ -117,11 +126,8 @@ $(function () { } }).data("ui-autocomplete")._renderItem = function (ul, item) { $(ul).addClass('siteSelect'); - - var idSiteParam = 'idSite=' + item.id, - hash = broadcast.isHashExists() ? broadcast.getHashFromUrl().replace(/idSite=[0-9]+/, idSiteParam) : "", - linkUrl = piwikHelper.getCurrentQueryStringWithParametersModified(idSiteParam) + hash, - link = $("").html(item.label).attr('href', linkUrl), + var linkUrl = getUrlForWebsiteId(item.id); + var link = $("").html(item.label).attr('href', linkUrl), listItem = $('
  • '); listItem.data("item.ui-autocomplete", item) @@ -162,12 +168,10 @@ $(function () { $('.custom_select_block', selector).on('mouseenter', function () { $('.custom_select_ul_list li a', selector).each(function () { - var hash = broadcast.getHashFromUrl(); - hash = hash ? hash.replace(/idSite=[0-9]+/, 'idSite=' + $(this).attr('siteid')) : ""; + var idSite = $(this).attr('siteid'); - var queryString = piwikHelper.getCurrentQueryStringWithParametersModified( - 'idSite=' + $(this).attr('siteid')); - $(this).attr('href', queryString + hash); + var linkUrl = getUrlForWebsiteId(idSite); + $(this).attr('href', linkUrl); }); }); -- cgit v1.2.3 From 7c58869c60a2b6b3cdf68dca4d0a4046449942aa Mon Sep 17 00:00:00 2001 From: sgiehl Date: Thu, 16 May 2013 09:11:32 +0200 Subject: refs #2135 always show autocomplete when clicking on the input element --- plugins/SegmentEditor/templates/Segmentation.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'plugins') diff --git a/plugins/SegmentEditor/templates/Segmentation.js b/plugins/SegmentEditor/templates/Segmentation.js index 3c22b47686..c22a4d3949 100644 --- a/plugins/SegmentEditor/templates/Segmentation.js +++ b/plugins/SegmentEditor/templates/Segmentation.js @@ -434,7 +434,9 @@ Segmentation = (function($) { } }); - inputElement.click(function(e){ inputElement.keydown() }); + inputElement.click(function(e){ + inputElement.autocomplete('search', $(inputElement).val()); + }); }); ajaxHandler.send(); } -- cgit v1.2.3 From ed60fae0cb3a151a03070bbe24d022f3e4e01e5c Mon Sep 17 00:00:00 2001 From: Benaka Moorthi Date: Thu, 16 May 2013 18:45:58 -0700 Subject: Make sure excluded user agent textarea displayed when adding a new site to Manage > Websites is only displayed when option to use site specific exclusion criteria is set. --- plugins/SitesManager/templates/SitesManager.js | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) (limited to 'plugins') diff --git a/plugins/SitesManager/templates/SitesManager.js b/plugins/SitesManager/templates/SitesManager.js index 2f3c777927..4ff38d2159 100644 --- a/plugins/SitesManager/templates/SitesManager.js +++ b/plugins/SitesManager/templates/SitesManager.js @@ -157,6 +157,11 @@ function SitesManager(_timezones, _currencies, _defaultTimezone, _defaultCurrenc $('.addRowSite').click(function () { piwikHelper.hideAjaxError(); $('.addRowSite').toggle(); + + var excludedUserAgentCell = ''; + if ($('#exclude-user-agent-header').is(':visible')) { + excludedUserAgentCell = '
    ' + excludedUserAgentsHelp + ''; + } var numberOfRows = $('table#editSites')[0].rows.length; var newRowId = 'rowNew' + numberOfRows; @@ -166,9 +171,9 @@ function SitesManager(_timezones, _currencies, _defaultTimezone, _defaultCurrenc


    ' + submitButtonHtml + '\
    ' + aliasUrlsHelp + keepURLFragmentSelectHTML + '\
    ' + excludedIpHelp + '\ -
    ' + excludedQueryParametersHelp + '\ -
    ' + excludedUserAgentsHelp + '\ - ' + getSitesearchSelector(false) + '\ +
    ' + excludedQueryParametersHelp + '' + + excludedUserAgentCell + + '' + getSitesearchSelector(false) + '\ ' + getTimezoneSelector(defaultTimezone) + '
    ' + timezoneHelp + '\ ' + getCurrencySelector(defaultCurrency) + '
    ' + currencyHelp + '\ ' + getEcommerceSelector(0) + '
    ' + ecommerceHelp + '\ -- cgit v1.2.3 From 229a3f213f1102c197549e282d6324416d9412cf Mon Sep 17 00:00:00 2001 From: mattab Date: Fri, 17 May 2013 14:32:59 +1200 Subject: Refs #2135 * Fixing select boxes logic/API * better design for anonymous user. He can apply the segments that are shared * better message in case anonymous tries delete/edit a custom segment * Adding ability to set a segment as "PRE-PROCESS" or "PROCESSED ON DEMAND (Real time, default)" --- plugins/SegmentEditor/API.php | 49 +++++++---- plugins/SegmentEditor/Controller.php | 1 - plugins/SegmentEditor/templates/Segmentation.css | 5 ++ plugins/SegmentEditor/templates/Segmentation.js | 106 ++++++++++++++++------- plugins/SegmentEditor/templates/selector.tpl | 25 ++++-- 5 files changed, 129 insertions(+), 57 deletions(-) (limited to 'plugins') diff --git a/plugins/SegmentEditor/API.php b/plugins/SegmentEditor/API.php index 39c204ea18..cacd742ae6 100644 --- a/plugins/SegmentEditor/API.php +++ b/plugins/SegmentEditor/API.php @@ -81,6 +81,8 @@ class Piwik_SegmentEditor_API } Piwik::checkUserHasViewAccess($idSite); } + $idSite = (int)$idSite; + return $idSite; } protected function checkAutoArchive($autoArchive, $idSite) @@ -115,8 +117,16 @@ class Piwik_SegmentEditor_API return $segment; } + protected function checkUserIsNotAnonymous() + { + if(Piwik::isUserIsAnonymous()) { + throw new Exception("To create, edit or delete Custom Segments, please sign in first."); + } + } + public function delete($idSegment) { + $this->checkUserIsNotAnonymous(); $segment = $this->getSegmentOrFail($idSegment); $db = Zend_Registry::get('db'); $db->delete(Piwik_Common::prefixTable('segment'), 'idsegment = ' . $idSegment); @@ -125,9 +135,10 @@ class Piwik_SegmentEditor_API public function update($idSegment, $name, $definition, $idSite = false, $autoArchive = false, $enabledAllUsers = false) { + $this->checkUserIsNotAnonymous(); $segment = $this->getSegmentOrFail($idSegment); - $this->checkIdSite($idSite); + $idSite = $this->checkIdSite($idSite); $this->checkSegmentName($name); $definition = $this->checkSegmentValue($definition, $idSite); $enabledAllUsers = $this->checkEnabledAllUsers($enabledAllUsers); @@ -153,8 +164,8 @@ class Piwik_SegmentEditor_API public function add($name, $definition, $idSite = false, $autoArchive = false, $enabledAllUsers = false) { - Piwik::checkUserIsNotAnonymous(); - $this->checkIdSite($idSite); + $this->checkUserIsNotAnonymous(); + $idSite = $this->checkIdSite($idSite); $this->checkSegmentName($name); $definition = $this->checkSegmentValue($definition, $idSite); $enabledAllUsers = $this->checkEnabledAllUsers($enabledAllUsers); @@ -201,33 +212,37 @@ class Piwik_SegmentEditor_API return $segment; } - public function getAll($idSite = false, $returnAutoArchived = false) + public function getAll($idSite = false, $returnOnlyAutoArchived = false) { if(!empty($idSite) ) { Piwik::checkUserHasViewAccess($idSite); } else { Piwik::checkUserHasSomeViewAccess(); } + $bind = array(); - $extraWhere = ''; - if($returnAutoArchived) { - $extraWhere = ' AND auto_archive = 1'; - } - + // Build basic segment filtering $whereIdSite = ''; - $bind = array(Piwik::getCurrentUserLogin()); if(!empty($idSite)) { $whereIdSite = 'enable_only_idsite = ? OR '; - $bind = array($idSite, Piwik::getCurrentUserLogin()); + $bind[] = $idSite; + } + + $bind[] = Piwik::getCurrentUserLogin(); + + $extraWhere = ''; + if($returnOnlyAutoArchived) { + $extraWhere = ' AND auto_archive = 1'; } + // Query $sql = "SELECT * " . - " FROM " . Piwik_Common::prefixTable("segment") . - " WHERE ($whereIdSite enable_only_idsite IS NULL) - AND (enable_all_users = 1 OR login = ?) - AND deleted = 0 - $extraWhere - ORDER BY name ASC"; + " FROM " . Piwik_Common::prefixTable("segment") . + " WHERE ($whereIdSite enable_only_idsite = 0) + AND (enable_all_users = 1 OR login = ?) + AND deleted = 0 + $extraWhere + ORDER BY name ASC"; $segments = Zend_Registry::get('db')->fetchAll($sql, $bind); return $segments; diff --git a/plugins/SegmentEditor/Controller.php b/plugins/SegmentEditor/Controller.php index d402f442c7..a540ce4a72 100644 --- a/plugins/SegmentEditor/Controller.php +++ b/plugins/SegmentEditor/Controller.php @@ -41,7 +41,6 @@ class Piwik_SegmentEditor_Controller extends Piwik_Controller $view->savedSegmentsJson = Piwik_Common::json_encode($savedSegments); $view->authorizedToCreateSegments = !Piwik::isUserIsAnonymous(); - $view->segmentTranslations = Piwik_Common::json_encode($this->getTranslations()); $out = $view->render(); echo $out; diff --git a/plugins/SegmentEditor/templates/Segmentation.css b/plugins/SegmentEditor/templates/Segmentation.css index bffe989623..fa5e61346e 100644 --- a/plugins/SegmentEditor/templates/Segmentation.css +++ b/plugins/SegmentEditor/templates/Segmentation.css @@ -1,4 +1,9 @@ /* ADDITIONAL STYLES*/ +.youMustBeLoggedIn { + font-size:8pt; + font-style: italic; + +} .loadingSegment { color: grey; display: block; diff --git a/plugins/SegmentEditor/templates/Segmentation.js b/plugins/SegmentEditor/templates/Segmentation.js index c22a4d3949..8e2050ea25 100644 --- a/plugins/SegmentEditor/templates/Segmentation.js +++ b/plugins/SegmentEditor/templates/Segmentation.js @@ -14,7 +14,7 @@ Segmentation = (function($) { self.currentSegmentStr = ""; self.targetId = "segmentEditorPanel"; self.segmentAccess = "read"; - self.segmentList = []; + self.availableSegments = []; for(var item in config) { @@ -182,7 +182,20 @@ Segmentation = (function($) { $(self.form).find(".segment-content").append(getInitialStateRowsHtml()); doDragDropBindings(); } - + + var getSegmentFromId = function (id) { + if(self.availableSegments.length > 0) { + for(var key in self.availableSegments) + { + segment = self.availableSegments[key]; + if(segment.idsegment == id) { + return segment; + } + } + } + return false; + } + var getListHtml = function() { var html = $("#SegmentEditor > .listHtml").clone(); var segment, injClass; @@ -192,10 +205,10 @@ Segmentation = (function($) { + ' data-definition="">' + self.translations['SegmentEditor_DefaultAllVisits'] + ' ' + self.translations['General_DefaultAppended'] + ' '; - if(self.segmentList.length > 0) { - for(var key in self.segmentList) + if(self.availableSegments.length > 0) { + for(var key in self.availableSegments) { - segment = self.segmentList[key]; + segment = self.availableSegments[key]; injClass = ""; if( segment.definition == self.currentSegmentStr){ injClass = 'class="segmentSelected"'; @@ -234,9 +247,9 @@ Segmentation = (function($) { + '">' + self.translations['SegmentEditor_AddNewSegment'] + ''; segmentsDropdown.append(newOption); - for(var key in self.segmentList) + for(var key in self.availableSegments) { - segment = self.segmentList[key]; + segment = self.availableSegments[key]; newOption = ''; segmentsDropdown.append(newOption); } @@ -325,11 +338,15 @@ Segmentation = (function($) { } var openEditForm = function(segment){ - addForm(); + addForm("edit", segment); + $(self.form).find(".segment-content > h3 > span").text(segment.name); $(self.form).find('#available_segments_select > option[data-idsegment="'+segment.idsegment+'"]').prop("selected",true); + $(self.form).find('#available_segments a.dropList').html(self.shortenSegmentName(segment.name, 16)); - + + + if(segment.definition != ""){ revokeInitialStateRows(); var blocks = parseSegmentStr(segment.definition); @@ -368,11 +385,8 @@ Segmentation = (function($) { $(self.content).off("click",".editSegment").on("click", ".editSegment", function(e){ $(this).parents(".segmentationContainer").trigger("click"); var target = $(this).parent("li"); - var segment = {}; - segment.idsegment = target.attr("data-idsegment"); - segment.definition = target.data("definition"); - segment.name = target.attr("title"); - openEditForm(segment); + + openEditFormGivenSegment(target); e.stopPropagation(); e.preventDefault(); }); @@ -492,6 +506,22 @@ Segmentation = (function($) { }); } + function openEditFormGivenSegment(option) { + var segment = {}; + segment.idsegment = option.attr("data-idsegment"); + segment.name = option.attr("title"); + segment.definition = option.data("definition"); + + + var segmentExtra = getSegmentFromId(segment.idsegment); + for(var item in segmentExtra) + { + segment[item] = segmentExtra[item]; + } + + openEditForm(segment); + } + var bindFormEvents = function(){ $(self.form).on("click", "a", function(e){ @@ -530,12 +560,7 @@ Segmentation = (function($) { $(self.form).find("#available_segments_select").bind("change", function(e){ var option = $(e.currentTarget).find('option:selected'); - var segment = {}; - segment.idsegment = option.attr("data-idsegment"); - segment.name = option.attr("title"); - segment.definition = option.data("definition"); - openEditForm(segment); - + openEditFormGivenSegment(option); }); // attach event that shows/hides child elements of each metric category @@ -777,7 +802,8 @@ Segmentation = (function($) { }); } - var addForm = function(mode){ + // Mode = 'new' or 'edit' + var addForm = function(mode, segment){ $("#segmentEditorPanel").find(".segment-element:visible").unbind().remove(); if(typeof self.form !== "undefined") @@ -792,8 +818,17 @@ Segmentation = (function($) { setLeftMargin('#segmentEditorPanel > .segment-element'); bindFormEvents(); bindSegmentManipulationEvents(); - makeDropList("#enabledAllUsers" , "#enabledAllUsers_select"); + + if(mode == "edit") { + $(self.form).find('#enable_all_users_select > option[value="'+segment.enable_all_users+'"]').prop("selected",true); + $(self.form).find('#visible_to_website_select > option[value="'+segment.enable_only_idsite+'"]').prop("selected",true); + $(self.form).find('#auto_archive_select > option[value="'+segment.auto_archive+'"]').prop("selected",true); + + } + + makeDropList("#enable_all_users" , "#enable_all_users_select"); makeDropList("#visible_to_website" , "#visible_to_website_select"); + makeDropList("#auto_archive" , "#auto_archive_select"); makeDropList("#available_segments" , "#available_segments_select"); $(self.form).find(".saveAndApply").bind("click", function(e){ e.preventDefault(); @@ -844,13 +879,16 @@ Segmentation = (function($) { var segmentName = $(self.form).find(".segment-content > h3 >span").text(); var segmentStr = parseForm(); var segmentId = $(self.form).find('#available_segments_select > option:selected').attr("data-idsegment"); - var user = $(self.form).find("#enabledAllUsers_select option:selected").val(); + var user = $(self.form).find("#enable_all_users_select option:selected").val(); + var autoArchive = $(self.form).find("#auto_archive_select option:selected").val() || 0; var params = { "name": segmentName, "definition": segmentStr, "enabledAllUsers": user, - "idSite": $('#visible_to_website').find('option:selected').attr('value') + "autoArchive": autoArchive, + "idSite": $(self.form).find("#visible_to_website_select option:selected").val() }; + // determine if save or update should be performed if(segmentId === ""){ self.addMethod(params); @@ -885,10 +923,10 @@ Segmentation = (function($) { select: function( event, ui ) { event.preventDefault(); ui.item.option.selected = true; - if(ui.item.value) { - dropList.text(ui.item.label); - $(self.form).find(selectId).trigger("change"); - } + // Mark original select>option + $('#SegmentEditor ' + spanId + ' option[value="' + ui.item.value + '"]').prop('selected', true); + dropList.text(ui.item.label); + $(self.form).find(selectId).trigger("change"); } }) .click(function() { @@ -1020,15 +1058,23 @@ $(document).ready( function(){ }, 'POST'); // ajaxHandler.redirectOnSuccess(); ajaxHandler.setLoadingElement(); + ajaxHandler.useCallbackInCaseOfError(); + ajaxHandler.setCallback(function (response) { + if (response && response.result == 'error') { + alert(response.message); + } else { + return broadcast.propagateNewPage('segment='); + } + }); + ajaxHandler.send(true); - return broadcast.propagateNewPage('segment='); }; var segmentFromHash = broadcast.getParamValue('segment', location.hash); var segmentationFtw = new Segmentation({ "targetId" : "segmentList", "segmentAccess" : "write", - "segmentList" : availableSegments, + "availableSegments" : availableSegments, "addMethod": addSegment, "updateMethod": updateSegment, "deleteMethod": deleteSegment, diff --git a/plugins/SegmentEditor/templates/selector.tpl b/plugins/SegmentEditor/templates/selector.tpl index 0179aaef38..ff4b583f18 100644 --- a/plugins/SegmentEditor/templates/selector.tpl +++ b/plugins/SegmentEditor/templates/selector.tpl @@ -1,7 +1,7 @@
    - The Segment Editor was crowdfunded with the awesome support of 80 companies and Piwik users worldwide! + The Segment Editor was crowdfunded with the awesome support of 80 companies and Piwik users worldwide! {'General_Delete'|translate} {'General_Close'|translate} diff --git a/plugins/UserCountryMap/css/visitor-map.css b/plugins/UserCountryMap/css/visitor-map.css index cc3340d895..534db96fd5 100644 --- a/plugins/UserCountryMap/css/visitor-map.css +++ b/plugins/UserCountryMap/css/visitor-map.css @@ -13,7 +13,7 @@ top: 42% !important; right: 10px !important; left: 10px !important; - z-index: 999 !important; + z-index: 990 !important; display: block; font-size: 12px; color: #000; -- cgit v1.2.3 From 3032245d535f444201766c3b80528416eb926c0f Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 23 May 2013 12:37:55 +1200 Subject: Fixing lcfirst not available yet --- plugins/SegmentEditor/Controller.php | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'plugins') diff --git a/plugins/SegmentEditor/Controller.php b/plugins/SegmentEditor/Controller.php index a540ce4a72..f61239798a 100644 --- a/plugins/SegmentEditor/Controller.php +++ b/plugins/SegmentEditor/Controller.php @@ -26,7 +26,9 @@ class Piwik_SegmentEditor_Controller extends Piwik_Controller foreach($segments as $segment) { if($segment['category'] == Piwik_Translate('General_Visit') && $segment['type'] == 'metric') { - $segment['category'] .= ' (' . lcfirst(Piwik_Translate('General_Metrics')) . ')'; + $metricsLabel = Piwik_Translate('General_Metrics'); + $metricsLabel[0] = strtolower($metricsLabel[0]); + $segment['category'] .= ' (' . $metricsLabel . ')'; } $segmentsByCategory[$segment['category']][] = $segment; } -- cgit v1.2.3 From a930ce4289a90a168d7f9d37ad0f813569617e10 Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 23 May 2013 13:38:03 +1200 Subject: Refs #3934 much better fix --- plugins/API/API.php | 3 +-- plugins/PDFReports/API.php | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) (limited to 'plugins') diff --git a/plugins/API/API.php b/plugins/API/API.php index 557cbaf3eb..262800accf 100644 --- a/plugins/API/API.php +++ b/plugins/API/API.php @@ -733,7 +733,6 @@ class Piwik_API_API 'idSubtable' => $idSubtable, )); if (!empty($segment)) $parameters['segment'] = $segment; - $parameters = array_map('urlencode', $parameters); $url = Piwik_Url::getQueryStringFromParameters($parameters); $request = new Piwik_API_Request($url); @@ -1153,7 +1152,7 @@ class Piwik_API_API public function getRowEvolution($idSite, $period, $date, $apiModule, $apiAction, $label = false, $segment = false, $column = false, $language = false, $idGoal = false, $legendAppendMetric = true, $labelUseAbsoluteUrl = true) { // validation of requested $period & $date - if ($period == 'range') { + if ($period == 'range') { // load days in the range $period = 'day'; } diff --git a/plugins/PDFReports/API.php b/plugins/PDFReports/API.php index e65d6bbe36..d3b0fccb95 100644 --- a/plugins/PDFReports/API.php +++ b/plugins/PDFReports/API.php @@ -370,7 +370,7 @@ class Piwik_PDFReports_API $processedReport = Piwik_API_API::getInstance()->getProcessedReport( $idSite, $period, $date, $apiModule, $apiAction, - $segment != null ? $segment['definition'] : false, + $segment != null ? urlencode($segment['definition']) : false, $apiParameters, $idGoal = false, $language ); -- cgit v1.2.3 From debae0756cba9e5bd2bafc9e8e037757b740e783 Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 23 May 2013 14:18:58 +1200 Subject: Fixes #3940 Adding '&format=php' to ensure the data within the bulk request, is converted only once and is valid JSON. Also works in XML (not in CSV). I updated the bulk request doc at: http://piwik.org/docs/analytics-api/reference/#toc-advanced-users-send-multiple-api-requests-at-once --- plugins/API/API.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'plugins') diff --git a/plugins/API/API.php b/plugins/API/API.php index 262800accf..01c3acb3af 100644 --- a/plugins/API/API.php +++ b/plugins/API/API.php @@ -1619,7 +1619,7 @@ class Piwik_API_API $result = array(); foreach ($urls as $url) { - $req = new Piwik_API_Request($url); + $req = new Piwik_API_Request($url . '&format=php&serialize=0'); $result[] = $req->process(); } return $result; -- cgit v1.2.3 From 2d5b0aca2c0bbbe0f740182134c0162b11466fd2 Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 23 May 2013 17:02:06 +1200 Subject: Fixes #3887 Hiding row evolution graph URL from output for Referrer.getAll Please double test it's all working! --- plugins/Referers/Referers.php | 1 + 1 file changed, 1 insertion(+) (limited to 'plugins') diff --git a/plugins/Referers/Referers.php b/plugins/Referers/Referers.php index 3e40f2d9a9..145cd05de6 100644 --- a/plugins/Referers/Referers.php +++ b/plugins/Referers/Referers.php @@ -80,6 +80,7 @@ class Piwik_Referers extends Piwik_Plugin 'module' => 'Referers', 'action' => 'getAll', 'dimension' => Piwik_Translate('Referers_Referrer'), + 'constantRowsCount' => true, 'documentation' => Piwik_Translate('Referers_AllReferersReportDocumentation', '
    '), 'order' => 2, ), -- cgit v1.2.3 From 7268be654896f68c5762ca1bea1be8b591ea4e41 Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 23 May 2013 22:36:35 +1200 Subject: Fixing tracking code generator + better display of Loading messages (more often, but not too much) BETA 17 will become 1.12 if nothing comes up (EXCEPT for MOBILE DEVICE detection plugin coming shortly :)) --- plugins/CoreAdminHome/templates/jsTrackingGenerator.js | 5 ----- plugins/SegmentEditor/templates/Segmentation.js | 16 +++++++++++++--- 2 files changed, 13 insertions(+), 8 deletions(-) (limited to 'plugins') diff --git a/plugins/CoreAdminHome/templates/jsTrackingGenerator.js b/plugins/CoreAdminHome/templates/jsTrackingGenerator.js index 034d7dbe32..32e0aa52ed 100644 --- a/plugins/CoreAdminHome/templates/jsTrackingGenerator.js +++ b/plugins/CoreAdminHome/templates/jsTrackingGenerator.js @@ -104,11 +104,6 @@ } ); ajaxRequest.setCallback(function (data) { - for (var i = 0; i != data.length; ++i) { - data[i] = JSON.parse(data[i]); - } - - // set data var currency = data[0][0].currency || ''; siteCurrencies[idSite] = currencySymbols[currency.toUpperCase()]; siteUrls[idSite] = data[1] || []; diff --git a/plugins/SegmentEditor/templates/Segmentation.js b/plugins/SegmentEditor/templates/Segmentation.js index b0993e36c0..7ca9ebdffc 100644 --- a/plugins/SegmentEditor/templates/Segmentation.js +++ b/plugins/SegmentEditor/templates/Segmentation.js @@ -398,6 +398,7 @@ Segmentation = (function($) { segment.definition = $(this).data("definition"); segment.name = $(this).attr("title"); self.segmentSelectMethod( segment.definition ); + toggleLoadingMessage( segment.definition.length ); setSegment(segment.definition); markCurrentSegment(); } @@ -955,6 +956,14 @@ Segmentation = (function($) { $(selector).css({left: Math.max($('#periodString')[0].offsetWidth) + 10}); } + function toggleLoadingMessage(segmentIsSet) { + if (segmentIsSet) { + $('#ajaxLoading .loadingSegment').show(); + } else { + $('#ajaxLoading .loadingSegment').hide(); + } + } + var initHtml = function() { if(typeof self.content !== "undefined"){ self.content.unbind(); @@ -972,6 +981,10 @@ Segmentation = (function($) { // assign content to object attribute to make it easil accesible through all widget methods bindListEvents(); markCurrentSegment(); + + // Loading message + var segmentIsSet = self.getSegment().length; + toggleLoadingMessage(segmentIsSet); } initHtml(); }; @@ -990,9 +1003,6 @@ $(document).ready( function(){ $('#segmentEditorPanel a.close').click(); segmentDefinition = cleanupSegmentDefinition(segmentDefinition); segmentDefinition = encodeURIComponent(segmentDefinition); - if(segmentDefinition.length) { - $('.loadingSegment').show(); - } return broadcast.propagateNewPage('segment=' + segmentDefinition, true); }; -- cgit v1.2.3 From 6804733ddcb9fcf72b2df3f796a0d5b228bb0ab2 Mon Sep 17 00:00:00 2001 From: mattab Date: Fri, 24 May 2013 20:01:03 +1200 Subject: Adding new DevicesDetection plugin, developed by Clearcode and sponsored by a client of Piwik Professional Services. A beautiful work of engineering, all released under GNU/GPL license! Fixes #3612 * when enabled, the plugin will add a new submenu: Visitors> Devices * the new devices report contains NEW reports: * Much improved Device type (tracking 'car browser', 'console', 'desktop', 'feature phone', 'smartphone', 'tablet', 'tv') * Device brand (tracking more than 100 brands such as Nokia, Nintendo, Lenovo or Apple. * Device model (tracking hundreds of phone/console models) * Operating System versions (tracking 70 variations of operating systems including Ubuntu vs Kubuntu vs Debian vs Lubuntu vs Xubuntu) * Operating System families (Android vs Google TV vs Windows vs Windows mobile vs Mobile gaming consoles) * Browser versions * Browser families Refs #3505 There is some basic TV detection included and maybe you can help contribute better detections (see the .yml data files containing the regular expressions in YAML format) HOW DOES IT WORK This is quite beautiful system. It is a plugin that disabled by default. when enabled, it will create additional columns in the DB. Also at tracking, it will look at the user agent, and try to match it against one browser we know in the databases. The databases of user agent matching are composed by 3 YML files, parsed by spyc.php into php array. These 3 YML took dozens of hours of work and testing with dozens of mobile phones and devices for accuracy. We are happy with the result as they should cover > 80% of the devices commonly used. We hope the community will help us build up these YML files and make them better, so we can track accurately 90% or 95% of requests. The performance overhead is pretty small, but parsing the YML files + running dozens of regex will add some overhead. This is why it is still disabled by default. We will think about how to integrate it in core, in the next few months. Please let me know if you find any problem with this new awesome code! --- plugins/DevicesDetection/API.php | 163 +++ plugins/DevicesDetection/Controller.php | 177 ++++ plugins/DevicesDetection/DevicesDetection.php | 323 ++++++ .../UserAgentParserEnhanced.php | 719 ++++++++++++++ .../UserAgentParserEnhanced/regexes/browsers.yml | 408 ++++++++ .../UserAgentParserEnhanced/regexes/mobiles.yml | 958 ++++++++++++++++++ .../UserAgentParserEnhanced/regexes/oss.yml | 427 ++++++++ .../UserAgentParserEnhanced/spyc.php | 1046 ++++++++++++++++++++ plugins/DevicesDetection/functions.php | 152 +++ plugins/DevicesDetection/images/brand/Acer.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/Alcatel.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/Apple.ico | Bin 0 -> 2982 bytes plugins/DevicesDetection/images/brand/Asus.ico | Bin 0 -> 1406 bytes plugins/DevicesDetection/images/brand/Audiovox.ico | Bin 0 -> 1406 bytes plugins/DevicesDetection/images/brand/Avvio.ico | Bin 0 -> 1406 bytes plugins/DevicesDetection/images/brand/Becker.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/Beetel.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/BenQ.ico | Bin 0 -> 2326 bytes plugins/DevicesDetection/images/brand/Compal.ico | Bin 0 -> 1406 bytes plugins/DevicesDetection/images/brand/Cricket.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/Dell.ico | Bin 0 -> 1494 bytes plugins/DevicesDetection/images/brand/DoCoMo.ico | Bin 0 -> 1494 bytes plugins/DevicesDetection/images/brand/Ericsson.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/Google.ico | Bin 0 -> 1150 bytes .../DevicesDetection/images/brand/Gradiente.ico | Bin 0 -> 1910 bytes plugins/DevicesDetection/images/brand/Grundig.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/HP.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/HTC.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/Haier.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/Huawei.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/INQ.ico | Bin 0 -> 1095 bytes plugins/DevicesDetection/images/brand/KDDI.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/Karbonn.ico | Bin 0 -> 894 bytes plugins/DevicesDetection/images/brand/Kindle.ico | Bin 0 -> 2254 bytes plugins/DevicesDetection/images/brand/Kyocera.ico | Bin 0 -> 1406 bytes plugins/DevicesDetection/images/brand/LG.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/LGUPlus.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/Lanix.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/Lenovo.ico | Bin 0 -> 1406 bytes plugins/DevicesDetection/images/brand/MicroMax.ico | Bin 0 -> 1150 bytes .../DevicesDetection/images/brand/Microsoft.ico | Bin 0 -> 2110 bytes plugins/DevicesDetection/images/brand/Mio.ico | Bin 0 -> 2326 bytes .../DevicesDetection/images/brand/Mitsubishi.ico | Bin 0 -> 1406 bytes plugins/DevicesDetection/images/brand/Motorola.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/MyPhone.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/NGM.ico | Bin 0 -> 1214 bytes plugins/DevicesDetection/images/brand/Nintendo.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/Nokia.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/O2.ico | Bin 0 -> 1406 bytes plugins/DevicesDetection/images/brand/OPPO.ico | Bin 0 -> 2326 bytes plugins/DevicesDetection/images/brand/Onda.ico | Bin 0 -> 894 bytes plugins/DevicesDetection/images/brand/Orange.ico | Bin 0 -> 1145 bytes plugins/DevicesDetection/images/brand/Palm.ico | Bin 0 -> 631 bytes .../DevicesDetection/images/brand/Panasonic.ico | Bin 0 -> 3998 bytes plugins/DevicesDetection/images/brand/Pantech.ico | Bin 0 -> 3201 bytes plugins/DevicesDetection/images/brand/Philips.ico | Bin 0 -> 1406 bytes plugins/DevicesDetection/images/brand/RIM.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/Samsung.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/Sanyo.ico | Bin 0 -> 1406 bytes plugins/DevicesDetection/images/brand/Sega.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/Softbank.ico | Bin 0 -> 1910 bytes .../images/brand/Sony Ericsson.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/Sony.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/T-Mobile.ico | Bin 0 -> 1406 bytes plugins/DevicesDetection/images/brand/Telit.ico | Bin 0 -> 2550 bytes plugins/DevicesDetection/images/brand/TiPhone.ico | Bin 0 -> 2582 bytes plugins/DevicesDetection/images/brand/Vertu.ico | Bin 0 -> 2946 bytes plugins/DevicesDetection/images/brand/Videocon.ico | Bin 0 -> 1150 bytes plugins/DevicesDetection/images/brand/Zonda.ico | Bin 0 -> 295 bytes plugins/DevicesDetection/images/brand/eTouch.ico | Bin 0 -> 2254 bytes plugins/DevicesDetection/images/brand/i-mobile.ico | Bin 0 -> 2582 bytes plugins/DevicesDetection/images/brand/unknown.ico | Bin 0 -> 1150 bytes .../DevicesDetection/images/screens/computer.png | Bin 0 -> 550 bytes .../DevicesDetection/images/screens/console.gif | Bin 0 -> 617 bytes plugins/DevicesDetection/images/screens/dual.gif | Bin 0 -> 1082 bytes plugins/DevicesDetection/images/screens/mobile.gif | Bin 0 -> 324 bytes plugins/DevicesDetection/images/screens/normal.gif | Bin 0 -> 1088 bytes .../DevicesDetection/images/screens/smartphone.png | Bin 0 -> 547 bytes plugins/DevicesDetection/images/screens/tablet.png | Bin 0 -> 602 bytes plugins/DevicesDetection/images/screens/tv.png | Bin 0 -> 644 bytes .../DevicesDetection/images/screens/unknown.gif | Bin 0 -> 80 bytes plugins/DevicesDetection/images/screens/wide.gif | Bin 0 -> 1025 bytes plugins/DevicesDetection/lang/en.php | 29 + plugins/DevicesDetection/templates/index.tpl | 15 + plugins/ImageGraph/StaticGraph/HorizontalBar.php | 12 +- 85 files changed, 4424 insertions(+), 5 deletions(-) create mode 100644 plugins/DevicesDetection/API.php create mode 100644 plugins/DevicesDetection/Controller.php create mode 100644 plugins/DevicesDetection/DevicesDetection.php create mode 100644 plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php create mode 100644 plugins/DevicesDetection/UserAgentParserEnhanced/regexes/browsers.yml create mode 100644 plugins/DevicesDetection/UserAgentParserEnhanced/regexes/mobiles.yml create mode 100644 plugins/DevicesDetection/UserAgentParserEnhanced/regexes/oss.yml create mode 100644 plugins/DevicesDetection/UserAgentParserEnhanced/spyc.php create mode 100644 plugins/DevicesDetection/functions.php create mode 100644 plugins/DevicesDetection/images/brand/Acer.ico create mode 100644 plugins/DevicesDetection/images/brand/Alcatel.ico create mode 100644 plugins/DevicesDetection/images/brand/Apple.ico create mode 100644 plugins/DevicesDetection/images/brand/Asus.ico create mode 100644 plugins/DevicesDetection/images/brand/Audiovox.ico create mode 100644 plugins/DevicesDetection/images/brand/Avvio.ico create mode 100644 plugins/DevicesDetection/images/brand/Becker.ico create mode 100644 plugins/DevicesDetection/images/brand/Beetel.ico create mode 100644 plugins/DevicesDetection/images/brand/BenQ.ico create mode 100644 plugins/DevicesDetection/images/brand/Compal.ico create mode 100644 plugins/DevicesDetection/images/brand/Cricket.ico create mode 100644 plugins/DevicesDetection/images/brand/Dell.ico create mode 100644 plugins/DevicesDetection/images/brand/DoCoMo.ico create mode 100644 plugins/DevicesDetection/images/brand/Ericsson.ico create mode 100644 plugins/DevicesDetection/images/brand/Google.ico create mode 100644 plugins/DevicesDetection/images/brand/Gradiente.ico create mode 100644 plugins/DevicesDetection/images/brand/Grundig.ico create mode 100644 plugins/DevicesDetection/images/brand/HP.ico create mode 100644 plugins/DevicesDetection/images/brand/HTC.ico create mode 100644 plugins/DevicesDetection/images/brand/Haier.ico create mode 100644 plugins/DevicesDetection/images/brand/Huawei.ico create mode 100644 plugins/DevicesDetection/images/brand/INQ.ico create mode 100644 plugins/DevicesDetection/images/brand/KDDI.ico create mode 100644 plugins/DevicesDetection/images/brand/Karbonn.ico create mode 100644 plugins/DevicesDetection/images/brand/Kindle.ico create mode 100644 plugins/DevicesDetection/images/brand/Kyocera.ico create mode 100644 plugins/DevicesDetection/images/brand/LG.ico create mode 100644 plugins/DevicesDetection/images/brand/LGUPlus.ico create mode 100644 plugins/DevicesDetection/images/brand/Lanix.ico create mode 100644 plugins/DevicesDetection/images/brand/Lenovo.ico create mode 100644 plugins/DevicesDetection/images/brand/MicroMax.ico create mode 100644 plugins/DevicesDetection/images/brand/Microsoft.ico create mode 100644 plugins/DevicesDetection/images/brand/Mio.ico create mode 100644 plugins/DevicesDetection/images/brand/Mitsubishi.ico create mode 100644 plugins/DevicesDetection/images/brand/Motorola.ico create mode 100644 plugins/DevicesDetection/images/brand/MyPhone.ico create mode 100644 plugins/DevicesDetection/images/brand/NGM.ico create mode 100644 plugins/DevicesDetection/images/brand/Nintendo.ico create mode 100644 plugins/DevicesDetection/images/brand/Nokia.ico create mode 100644 plugins/DevicesDetection/images/brand/O2.ico create mode 100644 plugins/DevicesDetection/images/brand/OPPO.ico create mode 100644 plugins/DevicesDetection/images/brand/Onda.ico create mode 100644 plugins/DevicesDetection/images/brand/Orange.ico create mode 100644 plugins/DevicesDetection/images/brand/Palm.ico create mode 100644 plugins/DevicesDetection/images/brand/Panasonic.ico create mode 100644 plugins/DevicesDetection/images/brand/Pantech.ico create mode 100644 plugins/DevicesDetection/images/brand/Philips.ico create mode 100644 plugins/DevicesDetection/images/brand/RIM.ico create mode 100644 plugins/DevicesDetection/images/brand/Samsung.ico create mode 100644 plugins/DevicesDetection/images/brand/Sanyo.ico create mode 100644 plugins/DevicesDetection/images/brand/Sega.ico create mode 100644 plugins/DevicesDetection/images/brand/Softbank.ico create mode 100644 plugins/DevicesDetection/images/brand/Sony Ericsson.ico create mode 100644 plugins/DevicesDetection/images/brand/Sony.ico create mode 100644 plugins/DevicesDetection/images/brand/T-Mobile.ico create mode 100644 plugins/DevicesDetection/images/brand/Telit.ico create mode 100644 plugins/DevicesDetection/images/brand/TiPhone.ico create mode 100644 plugins/DevicesDetection/images/brand/Vertu.ico create mode 100644 plugins/DevicesDetection/images/brand/Videocon.ico create mode 100644 plugins/DevicesDetection/images/brand/Zonda.ico create mode 100644 plugins/DevicesDetection/images/brand/eTouch.ico create mode 100644 plugins/DevicesDetection/images/brand/i-mobile.ico create mode 100644 plugins/DevicesDetection/images/brand/unknown.ico create mode 100644 plugins/DevicesDetection/images/screens/computer.png create mode 100644 plugins/DevicesDetection/images/screens/console.gif create mode 100644 plugins/DevicesDetection/images/screens/dual.gif create mode 100644 plugins/DevicesDetection/images/screens/mobile.gif create mode 100644 plugins/DevicesDetection/images/screens/normal.gif create mode 100644 plugins/DevicesDetection/images/screens/smartphone.png create mode 100644 plugins/DevicesDetection/images/screens/tablet.png create mode 100644 plugins/DevicesDetection/images/screens/tv.png create mode 100644 plugins/DevicesDetection/images/screens/unknown.gif create mode 100644 plugins/DevicesDetection/images/screens/wide.gif create mode 100644 plugins/DevicesDetection/lang/en.php create mode 100644 plugins/DevicesDetection/templates/index.tpl (limited to 'plugins') diff --git a/plugins/DevicesDetection/API.php b/plugins/DevicesDetection/API.php new file mode 100644 index 0000000000..32dca0760b --- /dev/null +++ b/plugins/DevicesDetection/API.php @@ -0,0 +1,163 @@ +getDataTable($name); + $dataTable->filter('Sort', array(Piwik_Archive::INDEX_NB_VISITS)); + $dataTable->queueFilter('ReplaceColumnNames'); + $dataTable->queueFilter('ReplaceSummaryRowLabel'); + return $dataTable; + } + + /** + * Gets datatable displaying number of visits by device type (eg. desktop, smartphone, tablet) + * @param int $idSite + * @param string $period + * @param string $date + * @param string $segment + * @return DataTable + */ + public function getType($idSite, $period, $date, $segment = false) + { + $dataTable = $this->getDataTable('DevicesDetection_types', $idSite, $period, $date, $segment); + $dataTable->filter('ColumnCallbackReplace', array('label', 'Piwik_getDeviceTypeLabel')); + $dataTable->filter('ColumnCallbackAddMetadata', array('label', 'logo', 'Piwik_getDeviceTypeLogo')); + return $dataTable; + } + + /** + * Gets datatable displaying number of visits by device manufacturer name + * @param int $idSite + * @param string $period + * @param string $date + * @param string $segment + * @return DataTable + */ + public function getBrand($idSite, $period, $date, $segment = false) + { + $dataTable = $this->getDataTable('DevicesDetection_brands', $idSite, $period, $date, $segment); + $dataTable->filter('ColumnCallbackReplace', array('label', 'Piwik_getDeviceBrandLabel')); + $dataTable->filter('ColumnCallbackAddMetadata', array('label', 'logo', 'Piwik_GetBrandLogo')); + return $dataTable; + } + + /** + * Gets datatable displaying number of visits by device model + * @param int $idSite + * @param string $period + * @param string $date + * @param string $segment + * @return DataTable + */ + public function getModel($idSite, $period, $date, $segment = false) + { + $dataTable = $this->getDataTable('DevicesDetection_models', $idSite, $period, $date, $segment); + $dataTable->filter('ColumnCallbackReplace', array('label', 'Piwik_getModelName')); + return $dataTable; + } + + /** + * Gets datatable displaying number of visits by OS family (eg. Windows, Android, Linux) + * @param int $idSite + * @param string $period + * @param string $date + * @param string $segment + * @return DataTable + */ + public function getOsFamilies($idSite, $period, $date, $segment = false) + { + $dataTable = $this->getDataTable('DevicesDetection_os', $idSite, $period, $date, $segment); + $dataTable->filter('GroupBy', array('label', 'Piwik_getOSFamilyFullNameExtended')); + $dataTable->filter('ColumnCallbackAddMetadata', array('label', 'logo', 'Piwik_getOsFamilyLogoExtended')); + return $dataTable; + } + + /** + * Gets datatable displaying number of visits by OS version (eg. Android 4.0, Windows 7) + * @param int $idSite + * @param string $period + * @param string $date + * @param string $segment + * @return DataTable + */ + public function getOsVersions($idSite, $period, $date, $segment = false) + { + $dataTable = $this->getDataTable('DevicesDetection_osVersions', $idSite, $period, $date, $segment); + $dataTable->filter('ColumnCallbackAddMetadata', array('label', 'logo', 'Piwik_getOsLogoExtended')); + $dataTable->filter('ColumnCallbackReplace', array('label', 'Piwik_getOsFullNameExtended')); + + return $dataTable; + } + + /** + * Gets datatable displaying number of visits by Browser family (eg. Firefox, InternetExplorer) + * @param int $idSite + * @param string $period + * @param string $date + * @param string $segment + * @return DataTable + */ + public function getBrowserFamilies($idSite, $period, $date, $segment = false) + { + $dataTable = $this->getDataTable('DevicesDetection_browsers', $idSite, $period, $date, $segment); + $dataTable->filter('GroupBy', array('label', 'Piwik_getBrowserFamilyFullNameExtended')); + $dataTable->filter('ColumnCallbackAddMetadata', array('label', 'logo', 'Piwik_getBrowserFamilyLogoExtended')); + return $dataTable; + } + + /** + * Gets datatable displaying number of visits by Browser version (eg. Firefox 20, Safari 6.0) + * @param int $idSite + * @param string $period + * @param string $date + * @param string $segment + * @return DataTable + */ + public function getBrowserVersions($idSite, $period, $date, $segment = false) + { + $dataTable = $this->getDataTable('DevicesDetection_browserVersions', $idSite, $period, $date, $segment); + $dataTable->filter('ColumnCallbackAddMetadata', array('label', 'logo', 'Piwik_getBrowserLogoExtended')); + $dataTable->filter('ColumnCallbackReplace', array('label', 'Piwik_getBrowserNameExtended')); + return $dataTable; + } + +} \ No newline at end of file diff --git a/plugins/DevicesDetection/Controller.php b/plugins/DevicesDetection/Controller.php new file mode 100644 index 0000000000..4ac0644f5b --- /dev/null +++ b/plugins/DevicesDetection/Controller.php @@ -0,0 +1,177 @@ +osRelatedReports = array( + 'DevicesDetection.getOsFamilies' => Piwik_Translate('DeviceDetection_OperatingSystemFamilies'), + 'DevicesDetection.getOsVersions' => Piwik_Translate('DeviceDetection_OperatingSystemVersions') + ); + $this->browserRelatedReports = array( + 'DevicesDetection.getBrowserFamilies' => Piwik_Translate('DevicesDetection_BrowsersFamily'), + 'DevicesDetection.getBrowserVersions' => Piwik_Translate('DevicesDetection_BrowserVersions') + ); + } + + public function index($fetch = false) + { + $view = Piwik_View::factory('index'); + $view->deviceTypes = $view->deviceModels = $view->deviceBrands = $view->osReport = $view->browserReport = "blank"; + $view->deviceTypes = $this->getType(true); + $view->deviceBrands = $this->getBrand(true); + $view->deviceModels = $this->getModel(true); + $view->osReport = $this->getOsFamilies(true); + $view->browserReport = $this->getBrowserFamilies(true); + echo $view->render(); + } + + public function getType($fetch = false) + { + $view = $this->getStandardDataTableUserSettings( + __FUNCTION__, 'DevicesDetection.getType' + ); + + $view->setColumnTranslation('label', Piwik_Translate("DevicesDetection_dataTableLabelTypes")); + return $this->renderView($view, $fetch); + } + + public function getBrand($fetch = false) + { + $view = $this->getStandardDataTableUserSettings( + __FUNCTION__, 'DevicesDetection.getBrand' + ); + + $view->setColumnTranslation('label', Piwik_Translate("DevicesDetection_dataTableLabelBrands")); + return $this->renderView($view, $fetch); + } + + public function getModel($fetch = false) + { + $view = $this->getStandardDataTableUserSettings( + __FUNCTION__, 'DevicesDetection.getModel' + ); + + $view->setColumnTranslation('label', Piwik_Translate("DevicesDetection_dataTableLabelModels")); + + return $this->renderView($view, $fetch); + } + + public function getOsFamilies($fetch = false) + { + $view = $this->getStandardDataTableUserSettings( + __FUNCTION__, 'DevicesDetection.getOsFamilies' + ); + + $view->setColumnTranslation('label', Piwik_Translate("DevicesDetection_dataTableLabelSystemFamily")); + $view->addRelatedReports(Piwik_Translate('DeviceDetection_OperatingSystemFamilies'), $this->osRelatedReports); + return $this->renderView($view, $fetch); + } + + public function getOsVersions($fetch = false) + { + $view = $this->getStandardDataTableUserSettings( + __FUNCTION__, 'DevicesDetection.getOsVersions' + ); + + $view->setColumnTranslation('label', Piwik_Translate("DevicesDetection_dataTableLabelSystemVersion")); + $view->addRelatedReports(Piwik_Translate('DeviceDetection_OperatingSystemVersions'), $this->osRelatedReports); + return $this->renderView($view, $fetch); + } + + public function getBrowserFamilies($fetch = false) + { + $view = $this->getStandardDataTableUserSettings( + __FUNCTION__, 'DevicesDetection.getBrowserFamilies' + ); + + $view->setColumnTranslation('label', Piwik_Translate("DevicesDetection_dataTableLabelBrowserFamily")); + $view->addRelatedReports(Piwik_Translate('DevicesDetection_BrowsersFamily'), $this->browserRelatedReports); + return $this->renderView($view, $fetch); + } + + public function getBrowserVersions($fetch = false) + { + $view = $this->getStandardDataTableUserSettings( + __FUNCTION__, 'DevicesDetection.getBrowserVersions' + ); + + $view->setColumnTranslation('label', Piwik_Translate("DevicesDetection_dataTableLabelBrowserVersion")); + $view->addRelatedReports(Piwik_Translate('DevicesDetection_BrowserVersions'), $this->browserRelatedReports); + return $this->renderView($view, $fetch); + } + + protected function getStandardDataTableUserSettings($currentControllerAction, $APItoCall, $defaultDatatableType = null) + { + $view = Piwik_ViewDataTable::factory($defaultDatatableType); + $view->init($this->pluginName, $currentControllerAction, $APItoCall); + $view->disableSearchBox(); + $view->disableExcludeLowPopulation(); + $this->setPeriodVariablesView($view); + $this->setMetricsVariablesView($view); + return $view; + } + + /** + * You may manually call this controller action to force re-processing of past user agents + */ + public function refreshParsedUserAgents() + { + $q = "SELECT idvisit, config_debug_ua FROM " . Piwik_Common::prefixTable("log_visit"); + $res = Piwik_FetchAll($q); + foreach ($res as $rec) { + $UAParser = new UserAgentParserEnhanced($rec['config_debug_ua']); + $UAParser->parse(); + echo "Processing idvisit = " . $rec['idvisit'] . "
    "; + echo "UserAgent string: " . $rec['config_debug_ua'] . "
    Decoded values:"; + $uaDetails = $this->getArray($UAParser); + var_dump($uaDetails); + echo "
    "; + $this->updateVisit($rec['idvisit'], $uaDetails); + unset($UAParser); + } + echo "Please remember to truncate your archives !"; + } + + private function getArray(UserAgentParserEnhanced $UAParser) + { + $UADetails['config_browser_name'] = $UAParser->getBrowser("short_name"); + $UADetails['config_browser_version'] = $UAParser->getBrowser("version"); + $UADetails['config_os'] = $UAParser->getOs("short_name"); + $UADetails['config_os_version'] = $UAParser->getOs("version"); + $UADetails['config_device_type'] = $UAParser->getDevice(); + $UADetails['config_device_model'] = $UAParser->getModel(); + $UADetails['config_device_brand'] = $UAParser->getBrand(); + return $UADetails; + } + + private function updateVisit($idVisit, $uaDetails) + { + $q = "UPDATE " . Piwik_Common::prefixTable("log_visit") . " SET " . + "config_browser_name = '" . $uaDetails['config_browser_name'] . "' ," . + "config_browser_version = '" . $uaDetails['config_browser_version'] . "' ," . + "config_os = '" . $uaDetails['config_os'] . "' ," . + "config_os_version = '" . $uaDetails['config_os_version'] . "' ," . + "config_device_type = " . (isset($uaDetails['config_device_type']) ? "'" . $uaDetails['config_device_type'] . "'" : "NULL") . " ," . + "config_device_model = " . (isset($uaDetails['config_device_model']) ? "'" . $uaDetails['config_device_model'] . "'" : "NULL") . " ," . + "config_device_brand = " . (isset($uaDetails['config_device_brand']) ? "'" . $uaDetails['config_device_brand'] . "'" : "NULL") . " + WHERE idvisit = " . $idVisit; + Piwik_Query($q); + } + +} \ No newline at end of file diff --git a/plugins/DevicesDetection/DevicesDetection.php b/plugins/DevicesDetection/DevicesDetection.php new file mode 100644 index 0000000000..7403f29329 --- /dev/null +++ b/plugins/DevicesDetection/DevicesDetection.php @@ -0,0 +1,323 @@ + Piwik_Translate("DevicesDetection_description"), + 'author' => 'Clearcode.cc', + 'author_homepage' => 'http://clearcode.cc', + 'version' => '1.12-b6', + 'TrackerPlugin' => true, + 'translationAvailable' => true, + ); + } + + /* + * Defines API reports. + * Also used to define Widgets. + * + * @array Category, Report Name, API Module, API action, Translated column name, + * W + */ + + protected $reportMetadata = array( + // device types report + array( + 'DevicesDetection_DevicesDetection', + 'DevicesDetection_DeviceType', + 'DevicesDetection', + 'getType', + 'DevicesDetection_DeviceType', + ), + // device brands report + array( + 'DevicesDetection_DevicesDetection', + 'DevicesDetection_DeviceBrand', + 'DevicesDetection', + 'getBrand', + 'DevicesDetection_DeviceBrand', + ), + // device model report + array( + 'DevicesDetection_DevicesDetection', + 'DevicesDetection_DeviceModel', + 'DevicesDetection', + 'getModel', + 'DevicesDetection_DeviceModel', + ), + // device OS family report + array( + 'DevicesDetection_DevicesDetection', + 'DeviceDetection_OperatingSystemFamilies', + 'DevicesDetection', + 'getOsFamilies', + 'DeviceDetection_OperatingSystemFamilies', + ), + // device OS version report + array( + 'DevicesDetection_DevicesDetection', + 'DeviceDetection_OperatingSystemVersions', + 'DevicesDetection', + 'getOsVersions', + 'DeviceDetection_OperatingSystemVersions', + ), + // Browser family report + array( + 'DevicesDetection_DevicesDetection', + 'DevicesDetection_BrowsersFamily', + 'DevicesDetection', + 'getBrowserFamilies', + 'DevicesDetection_BrowsersFamily', + ), + // Browser versions report + array( + 'DevicesDetection_DevicesDetection', + 'DevicesDetection_BrowserVersions', + 'DevicesDetection', + 'getBrowserVersions', + 'DevicesDetection_BrowserVersions', + ), + ); + + public function getListHooksRegistered() + { + return array( + 'ArchiveProcessing_Day.compute' => "archiveDay", + 'ArchiveProcessing_Period.compute' => 'archivePeriod', + 'Menu.add' => 'addMenu', + 'Tracker.newVisitorInformation' => 'parseMobileVisitData', + 'WidgetsList.add' => 'addWidgets', + 'API.getReportMetadata' => 'getReportMetadata', + ); + } + + public function addWidgets() + { + foreach ($this->reportMetadata as $report) { + list($category, $name, $controllerName, $controllerAction) = $report; + if ($category == false) + continue; + Piwik_AddWidget($category, $name, $controllerName, $controllerAction); + } + } + + /** + * @param Piwik_Event_Notification $notification notification object + */ + public function getReportMetadata($notification) + { + $reports = & $notification->getNotificationObject(); + + $i = 0; + foreach ($this->reportMetadata as $report) { + list($category, $name, $apiModule, $apiAction, $columnName) = $report; + if ($category == false) + continue; + + $report = array( + 'category' => Piwik_Translate($category), + 'name' => Piwik_Translate($name), + 'module' => $apiModule, + 'action' => $apiAction, + 'dimension' => Piwik_Translate($columnName), + 'order' => $i++ + ); + + $translation = $name . 'Documentation'; + $translated = Piwik_Translate($translation, '
    '); + if ($translated != $translation) { + $report['documentation'] = $translated; + } + + + $reports[] = $report; + } + } + + public function install() + { +// we catch the exception + try { + $q1 = "ALTER TABLE `" . Piwik_Common::prefixTable("log_visit") . "` + ADD `config_os_version` VARCHAR( 10 ) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL AFTER `config_os` , + ADD `config_device_type` TINYINT( 10 ) NULL DEFAULT NULL AFTER `config_browser_version` , + ADD `config_device_brand` VARCHAR( 100 ) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL AFTER `config_device_type` , + ADD `config_device_model` VARCHAR( 100 ) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL AFTER `config_device_brand`"; + Piwik_Exec($q1); + // conditionaly add this column + if (@Piwik_Config::getInstance()->Debug['store_user_agent_in_visit']) { + $q2 = "ALTER TABLE `" . Piwik_Common::prefixTable("log_visit") . "` + ADD `config_debug_ua` VARCHAR( 512 ) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL AFTER `config_device_model`"; + Piwik_Exec($q2); + } + } catch (Exception $e) { + throw $e; + } + } + + public function parseMobileVisitData($notification) + { + $visitorInfo = &$notification->getNotificationObject(); + + $extraInfo = $notification->getNotificationInfo(); + $userAgent = $extraInfo['UserAgent']; + + $UAParser = new UserAgentParserEnhanced($userAgent); + $UAParser->parse(); + $deviceInfo['config_browser_name'] = $UAParser->getBrowser("short_name"); + $deviceInfo['config_browser_version'] = $UAParser->getBrowser("version"); + $deviceInfo['config_os'] = $UAParser->getOs("short_name"); + $deviceInfo['config_os_version'] = $UAParser->getOs("version"); + $deviceInfo['config_device_type'] = $UAParser->getDevice(); + $deviceInfo['config_device_model'] = $UAParser->getModel(); + $deviceInfo['config_device_brand'] = $UAParser->getBrand(); + + if (@Piwik_Config::getInstance()->Debug['store_user_agent_in_visit']) { + $deviceInfo['config_debug_ua'] = $userAgent; + } + + $visitorInfo = array_merge($visitorInfo, $deviceInfo); + printDebug("Device Detection:"); + printDebug($deviceInfo); + } + + private function archiveDayDeviceTypes($archiveProcessing) + { + $recordName = 'DevicesDetection_types'; + $labelSQL = "log_visit.config_device_type"; + $interestByType = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $tableType = $archiveProcessing->getDataTableFromArray($interestByType); + + $archiveProcessing->insertBlobRecord($recordName, $tableType->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + destroy($tableType); + } + + private function archiveDayDeviceBrands($archiveProcessing) + { + $recordName = 'DevicesDetection_brands'; + $labelSQL = "log_visit.config_device_brand"; + $interestByBrand = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $tableBrand = $archiveProcessing->getDataTableFromArray($interestByBrand); + + $archiveProcessing->insertBlobRecord($recordName, $tableBrand->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + destroy($tableBrand); + } + + private function archiveDayDeviceModels($archiveProcessing) + { + $recordName = 'DevicesDetection_models'; + $labelSQL = "log_visit.config_device_model"; + $interestByModel = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $tableModel = $archiveProcessing->getDataTableFromArray($interestByModel); + + $archiveProcessing->insertBlobRecord($recordName, $tableModel->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + destroy($tableModel); + } + + private function archiveDayOs($archiveProcessing) + { + $recordName = 'DevicesDetection_os'; + $labelSQL = "log_visit.config_os"; + $interestByOs = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $tableOs = $archiveProcessing->getDataTableFromArray($interestByOs); + + $archiveProcessing->insertBlobRecord($recordName, $tableOs->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + destroy($tableOs); + } + + private function archiveDayBrowserFamilies($archiveProcessing) + { + $recordName = 'DevicesDetection_browsers'; + $labelSQL = "log_visit.config_browser_name"; + $interestByBrowser = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $tableBrowser = $archiveProcessing->getDataTableFromArray($interestByBrowser); + + $archiveProcessing->insertBlobRecord($recordName, $tableBrowser->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + destroy($tableBrowser); + } + + private function archiveDayBrowsersVersions($archiveProcessing) + { + $recordName = 'DevicesDetection_browserVersions'; + $labelSQL = "CONCAT(log_visit.config_browser_name, ';', log_visit.config_browser_version)"; + $interestByBrowserVersion = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $tableBrowserVersion = $archiveProcessing->getDataTableFromArray($interestByBrowserVersion); + $archiveProcessing->insertBlobRecord($recordName, $tableBrowserVersion->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + destroy($tableBrowserVersion); + } + + private function archiveDayOsVersions($archiveProcessing) + { + $recordName = 'DevicesDetection_osVersions'; + $labelSQL = "CONCAT(log_visit.config_os, ';', log_visit.config_os_version)"; + $interestByBrowserVersion = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $tableOsVersion = $archiveProcessing->getDataTableFromArray($interestByBrowserVersion); + $archiveProcessing->insertBlobRecord($recordName, $tableOsVersion->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + destroy($tableOsVersion); + } + + public function archiveDay($notification) + { + $archiveProcessing = $notification->getNotificationObject(); + + if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) + return; + + $this->maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; + $this->columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; + + $this->archiveDayDeviceTypes($archiveProcessing); + $this->archiveDayDeviceBrands($archiveProcessing); + $this->archiveDayDeviceModels($archiveProcessing); + $this->archiveDayOs($archiveProcessing); + $this->archiveDayOsVersions($archiveProcessing); + $this->archiveDayBrowserFamilies($archiveProcessing); + $this->archiveDayBrowsersVersions($archiveProcessing); + } + + public function archivePeriod($notification) + { + $this->maximumRowsInDataTableLevelZero = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_referers']; + $this->maximumRowsInSubDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_subtable_referers']; + $archiveProcessing = $notification->getNotificationObject(); + + if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) + return; + + $dataTablesToSum[] = 'DevicesDetection_types'; + $dataTablesToSum[] = 'DevicesDetection_brands'; + $dataTablesToSum[] = "DevicesDetection_models"; + $dataTablesToSum[] = "DevicesDetection_os"; + $dataTablesToSum[] = "DevicesDetection_osVersions"; + $dataTablesToSum[] = "DevicesDetection_browsers"; + $dataTablesToSum[] = "DevicesDetection_browserVersions"; + foreach ($dataTablesToSum as $dt) { + $archiveProcessing->archiveDataTable( + $dt, null, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $columnToSort = "nb_visits"); + } + } + + public function addMenu() + { + Piwik_AddMenu('General_Visitors', 'DevicesDetection_submenu', array('module' => 'DevicesDetection', 'action' => 'index')); + } + +} \ No newline at end of file diff --git a/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php b/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php new file mode 100644 index 0000000000..c0a2825811 --- /dev/null +++ b/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php @@ -0,0 +1,719 @@ + 'Acer', + 'AI' => 'Airness', + 'AL' => 'Alcatel', + 'AO' => 'Amoi', + 'AP' => 'Apple', + 'AU' => 'Asus', + 'AV' => 'Avvio', + 'AX' => 'Audiovox', + 'BE' => 'Becker', + 'BI' => 'Bird', + 'BL' => 'Beetel', + 'BQ' => 'BenQ', + 'BS' => 'BenQ-Siemens', + 'CK' => 'Cricket', + 'CL' => 'Compal', + 'CT' => 'Capitel', + 'DB' => 'Dbtel', + 'DC' => 'DoCoMo', + 'DI' => 'Dicam', + 'DL' => 'Dell', + 'DP' => 'Dopod', + 'EC' => 'Ericsson', + 'EI' => 'Ezio', + 'ER' => 'Ericy', + 'ET' => 'eTouch', + 'EZ' => 'Ezze', + 'FL' => 'Fly', + 'GI' => 'Gionee', + 'GO' => 'Google', + 'GR' => 'Gradiente', + 'GU' => 'Grundig', + 'HA' => 'Haier', + 'HP' => 'HP', + 'HT' => 'HTC', + 'HU' => 'Huawei', + 'IK' => 'iKoMo', + 'IM' => 'i-mate', + 'IN' => 'Innostream', + 'IO' => 'i-mobile', + 'IQ' => 'INQ', + 'KA' => 'Karbonn', + 'KD' => 'KDDI', + 'KN' => 'Kindle', + 'KO' => 'Konka', + 'KY' => 'Kyocera', + 'LA' => 'Lanix', + 'LC' => 'LCT', + 'LE' => 'Lenovo', + 'LG' => 'LG', + 'LU' => 'LGUPlus', + 'MI' => 'MicroMax', + 'MO' => 'Mio', + 'MR' => 'Motorola', + 'MS' => 'Microsoft', + 'MT' => 'Mitsubishi', + 'MY' => 'MyPhone', + 'NE' => 'NEC', + 'NG' => 'NGM', + 'NI' => 'Nintendo', + 'NK' => 'Nokia', + 'NW' => 'Newgen', + 'NX' => 'Nexian', + 'OD' => 'Onda', + 'OP' => 'OPPO', + 'OR' => 'Orange', + 'OT' => 'O2', + 'PA' => 'Panasonic', + 'PH' => 'Philips', + 'PM' => 'Palm', + 'PO' => 'phoneOne', + 'PT' => 'Pantech', + 'QT' => 'Qtek', + 'RM' => 'RIM', + 'RO' => 'Rover', + 'SA' => 'Samsung', + 'SD' => 'Sega', + 'SE' => 'Sony Ericsson', + 'SF' => 'Softbank', + 'SG' => 'Sagem', + 'SH' => 'Sharp', + 'SI' => 'Siemens', + 'SN' => 'Sendo', + 'SO' => 'Sony', + 'SP' => 'Spice', + 'SY' => 'Sanyo', + 'TA' => 'Tesla', + 'TC' => 'TCL', + 'TE' => 'Telit', + 'TH' => 'TiPhone', + 'TI' => 'TIANYU', + 'TM' => 'T-Mobile', + 'TO' => 'Toplux', + 'TS' => 'Toshiba', + 'UT' => 'UTStarcom', + 'VD' => 'Videocon', + 'VE' => 'Vertu', + 'VI' => 'Vitelcom', + 'VK' => 'VK Mobile', + 'VO' => 'Voxtel', + 'WB' => 'Web TV', + 'WE' => 'WellcoM', + 'WO' => 'Wonu', + 'XX' => 'Unknown', + 'ZO' => 'Zonda', + 'ZT' => 'ZTE', + ); + public static $osShorts = array( + 'AIX' => 'AIX', + 'Android' => 'AND', + 'Apple TV' => 'ATV', + 'Arch Linux' => 'ARL', + 'BackTrack' => 'BTR', + 'Bada' => 'SBA', + 'BlackBerry OS' => 'BLB', + 'BlackBerry Tablet OS' => 'QNX', + 'Bot' => 'BOT', + 'Brew' => 'BMP', + 'CentOS' => 'CES', + 'Chrome OS' => 'COS', + 'Debian' => 'DEB', + 'DragonFly' => 'DFB', + 'Fedora' => 'FED', + 'Firefox OS' => 'FOS', + 'FreeBSD' => 'BSD', + 'Gentoo' => 'GNT', + 'Google TV' => 'GTV', + 'HP-UX' => 'HPX', + 'IRIX' => 'IRI', + 'Knoppix' => 'KNO', + 'Kubuntu' => 'KBT', + 'Linux' => 'LIN', + 'Lubuntu' => 'LBT', + 'Mac' => 'MAC', + 'Mandriva' => 'MDR', + 'MeeGo' => 'SMG', + 'Mint' => 'MIN', + 'NetBSD' => 'NBS', + 'Nintendo' => 'WII', + 'Nintendo Mobile' => 'NDS', + 'OS/2' => 'OS2', + 'OSF1' => 'T64', + 'OpenBSD' => 'OBS', + 'PlayStation' => 'PSP', + 'PlayStation 3' => 'PS3', + 'Presto' => 'PRS', + 'Puppy' => 'PPY', + 'Red Hat' => 'RHT', + 'SUSE' => 'SSE', + 'Slackware' => 'SLW', + 'Solaris' => 'SOS', + 'Syllable' => 'SYL', + 'Symbian' => 'SYM', + 'Symbian OS' => 'SYS', + 'Symbian OS Series 40' => 'S40', + 'Symbian OS Series 60' => 'S60', + 'Symbian^3' => 'SY3', + 'Talkatone' => 'TKT', + 'Tizen' => 'TIZ', + 'Ubuntu' => 'UBT', + 'WebTV' => 'WTV', + 'WinWAP' => 'WWP', + 'Windows' => 'WIN', + 'Windows 2000' => 'W2K', + 'Windows 3.1' => 'W31', + 'Windows 7' => 'WI7', + 'Windows 8' => 'WI8', + 'Windows 95' => 'W95', + 'Windows 98' => 'W98', + 'Windows CE' => 'WCE', + 'Windows ME' => 'WME', + 'Windows Mobile' => 'WMO', + 'Windows NT' => 'WNT', + 'Windows Phone' => 'WPH', + 'Windows RT' => 'WRT', + 'Windows Server 2003' => 'WS3', + 'Windows Vista' => 'WVI', + 'Windows XP' => 'WXP', + 'Xbox' => 'XBX', + 'Xubuntu' => 'XBT', + 'YunOs' => 'YNS', + 'iOS' => 'IOS', + 'palmOS' => 'POS', + 'webOS' => 'WOS' + ); + protected static $desktopOsArray = array('IBM', 'Linux', 'Mac', 'Unix', 'Windows'); + public static $osFamilies = array( + 'Android' => array('AND'), + 'Apple TV' => array('ATV'), + 'BlackBerry' => array('BLB'), + 'Bot' => array('BOT'), + 'Brew' => array('BMP'), + 'Chrome OS' => array('COS'), + 'Firefox OS' => array('FOS'), + 'Gaming Console' => array('WII', 'PS3'), + 'Google TV' => array('GTV'), + 'IBM' => array('OS2'), + 'iOS' => array('IOS'), + 'Linux' => array('LIN', 'ARL', 'DEB', 'KNO', 'MIN', 'UBT', 'KBT', 'XBT', 'LBT', 'FED', 'RHT', 'MDR', 'GNT', 'SLW', 'SSE', 'PPY', 'CES', 'BTR', 'YNS', 'PRS'), + 'Mac' => array('MAC'), + 'Mobile Gaming Console' => array('PSP', 'NDS', 'XBX'), + 'Other Mobile' => array('WOS', 'POS', 'QNX', 'SBA', 'TIZ'), + 'Simulator' => array('TKT', 'WWP'), + 'Symbian' => array('SYM', 'SYS', 'SY3', 'S60', 'S40', 'SMG'), + 'Unix' => array('SOS', 'AIX', 'HPX', 'BSD', 'NBS', 'OBS', 'DFB', 'SYL', 'IRI', 'T64'), + 'WebTV' => array('WTV'), + 'Windows' => array('WI8', 'WI7', 'WVI', 'WS3', 'WXP', 'W2K', 'WNT', 'WME', 'W98', 'W95', 'WRT', 'W31', 'WIN'), + 'Windows Mobile' => array('WPH', 'WMO', 'WCE') + ); + public static $browserFamilies = array( + 'Android Browser' => array('AN'), + 'BlackBerry Browser' => array('BB'), + 'Chrome' => array('CH', 'CM', 'CI', 'CF', 'CR'), + 'Firefox' => array('FF', 'FE', 'SX', 'FB', 'PX', 'MB'), + 'Internet Explorer' => array('IE', 'IM'), + 'Konqueror' => array('KO'), + 'NetFront' => array('NF'), + 'Nokia Browser' => array('NB'), + 'Opera' => array('OP', 'OM', 'OI'), + 'Safari' => array('SF', 'MF') + ); + public static $browsers = array( + 'AB' => 'ABrowse', + 'AM' => 'Amaya', + 'AN' => 'Android Browser', + 'AR' => 'Arora', + 'AV' => 'Amiga Voyager', + 'AW' => 'Amiga Aweb', + 'BB' => 'BlackBerry Browser', + 'BD' => 'Baidu Browser', + 'BE' => 'Beonex', + 'BX' => 'BrowseX', + 'CA' => 'Camino', + 'CF' => 'Chrome Frame', + 'CH' => 'Chrome', + 'CI' => 'Chrome Mobile iOS', + 'CK' => 'Conkeror', + 'CM' => 'Chrome Mobile', + 'CO' => 'CometBird', + 'CR' => 'Chromium', + 'CS' => 'Cheshire', + 'DF' => 'Dolphin', + 'DI' => 'Dillo', + 'EL' => 'Elinks', + 'EP' => 'Epiphany', + 'FB' => 'Firebird', + 'FD' => 'Fluid', + 'FE' => 'Fennec', + 'FF' => 'Firefox', + 'FL' => 'Flock', + 'FN' => 'Fireweb Navigator', + 'GA' => 'Galeon', + 'GE' => 'Google Earth', + 'HJ' => 'HotJava', + 'IB' => 'IBrowse', + 'IC' => 'iCab', + 'IE' => 'Internet Explorer', + 'IM' => 'IE Mobile', + 'IR' => 'Iron', + 'JS' => 'Jasmine', + 'KI' => 'Kindle Browser', + 'KM' => 'K-meleon', + 'KO' => 'Konqueror', + 'KP' => 'Kapiko', + 'KZ' => 'Kazehakase', + 'LG' => 'Lightning', + 'LI' => 'Links', + 'LX' => 'Lynx', + 'MB' => 'MicroB', + 'MC' => 'NCSA Mosaic', + 'MF' => 'Mobile Safari', + 'MI' => 'Midori', + 'MS' => 'Mobile Silk', + 'MX' => 'Maxthon', + 'NB' => 'Nokia Browser', + 'NF' => 'NetFront', + 'NL' => 'NetFront Life', + 'NS' => 'Netscape', + 'OB' => 'Obigo', + 'OI' => 'Opera Mini', + 'OM' => 'Opera Mobile', + 'OP' => 'Opera', + 'OV' => 'Openwave Mobile Browser', + 'OW' => 'OmniWeb', + 'PL' => 'Palm Blazer', + 'PR' => 'Palm Pre', + 'PX' => 'Phoenix', + 'RK' => 'Rekonq', + 'RM' => 'RockMelt', + 'SF' => 'Safari', + 'SM' => 'SeaMonkey', + 'SN' => 'Snowshoe', + 'SX' => 'Swiftfox', + 'TZ' => 'Tizen Browser', + 'UC' => 'UC Browser', + 'WO' => 'wOSBrowser', + 'YA' => 'Yandex Browser' + ); + protected static $regexesDir = '/regexes/'; + protected static $osRegexesFile = 'oss.yml'; + protected static $browserRegexesFile = 'browsers.yml'; + protected static $mobileRegexesFile = 'mobiles.yml'; + protected $userAgent; + protected $os; + protected $browser; + protected $device; + protected $brand; + protected $model; + protected $debug = false; + + public function __construct($userAgent) + { + $this->userAgent = $userAgent; + } + + protected function getOsRegexes() + { + return Spyc::YAMLLoad(__DIR__ . self::$regexesDir . self::$osRegexesFile); + } + + protected function getBrowserRegexes() + { + return Spyc::YAMLLoad(__DIR__ . self::$regexesDir . self::$browserRegexesFile); + } + + protected function getMobileRegexes() + { + return Spyc::YAMLLoad(__DIR__ . self::$regexesDir . self::$mobileRegexesFile); + } + + public function parse() + { + $this->parseOs(); + if ($this->isBot() || $this->isSimulator()) + return; + + $this->parseBrowser(); + + if ($this->isMobile()) { + $this->parseMobile(); + } else { + $this->device = array_search('desktop', self::$deviceTypes); + } + if ($this->debug) { + var_dump($this->brand, $this->model, $this->device); + } + } + + protected function parseOs() + { + foreach ($this->getOsRegexes() as $osRegex) { + $matches = $this->matchUserAgent($osRegex['regex']); + if ($matches) + break; + } + + if (!$matches) + return; + + if (in_array($osRegex['name'], self::$osShorts)) { + $short = self::$osShorts[$osRegex['name']]; + } else { + $short = 'UNK'; + } + + $this->os = array( + 'name' => $this->buildOsName($osRegex['name'], $matches), + 'short_name' => $short, + 'version' => $this->buildOsVersion($osRegex['version'], $matches) + ); + + if (array_key_exists($this->os['name'], self::$osShorts)) { + $this->os['short_name'] = self::$osShorts[$this->os['name']]; + } + } + + protected function parseBrowser() + { + foreach ($this->getBrowserRegexes() as $browserRegex) { + $matches = $this->matchUserAgent($browserRegex['regex']); + if ($matches) + break; + } + + if (!$matches) + return; + + if (in_array($browserRegex['name'], self::$browsers)) { + $short = array_search($browserRegex['name'], self::$browsers); + } else { + $short = 'UN'; + } + + $this->browser = array( + 'name' => $this->buildBrowserName($browserRegex['name'], $matches), + 'short_name' => $short, + 'version' => $this->buildBrowserVersion($browserRegex['version'], $matches) + ); + } + + protected function parseMobile() + { + $mobileRegexes = $this->getMobileRegexes(); + $this->parseBrand($mobileRegexes); + $this->parseModel($mobileRegexes); + } + + protected function parseBrand($mobileRegexes) + { + foreach ($mobileRegexes as $brand => $mobileRegex) { + $matches = $this->matchUserAgent($mobileRegex['regex']); + if ($matches) + break; + } + + if (!$matches) + return; + $this->brand = array_search($brand, self::$deviceBrands); + $this->fullName = $brand; + + if (isset($mobileRegex['device'])) { + $this->device = array_search($mobileRegex['device'],self::$deviceTypes); + } + + if (isset($mobileRegex['model'])) { + $this->model = $this->buildModel($mobileRegex['model'], $matches); + } + } + + protected function parseModel($mobileRegexes) + { + if (empty($this->brand) || !empty($this->model)) + return; + + foreach ($mobileRegexes[$this->fullName]['models'] as $modelRegex) { + $matches = $this->matchUserAgent($modelRegex['regex']); + if ($matches) + break; + } + + if (!$matches) { + return; + } + + $this->model = $this->buildModel($modelRegex['model'], $matches); + + if (isset($modelRegex['device'])) { + $this->device = array_search($modelRegex['device'], self::$deviceTypes); + } + } + + protected function matchUserAgent($regex) + { + $regex = '/' . str_replace('/', '\/', $regex) . '/i'; + + if (preg_match($regex, $this->userAgent, $matches)) { + return $matches; + } + + return false; + } + + protected function buildOsName($osName, $matches) + { + return $this->buildByMatch($osName, $matches); + } + + protected function buildOsVersion($osVersion, $matches) + { + $osVersion = $this->buildByMatch($osVersion, $matches); + + $osVersion = $this->buildByMatch($osVersion, $matches, '2'); + + $osVersion = str_replace('_', '.', $osVersion); + + return $osVersion; + } + + protected function buildBrowserName($browserName, $matches) + { + return $this->buildByMatch($browserName, $matches); + } + + protected function buildBrowserVersion($browserVersion, $matches) + { + $browserVersion = $this->buildByMatch($browserVersion, $matches); + + $browserVersion = $this->buildByMatch($browserVersion, $matches, '2'); + + $browserVersion = str_replace('_', '.', $browserVersion); + + return $browserVersion; + } + + protected function buildModel($model, $matches) + { + $model = $this->buildByMatch($model, $matches); + + $model = $this->buildByMatch($model, $matches, '2'); + + $model = $this->buildModelExceptions($model); + + $model = str_replace('_', ' ', $model); + + return $model; + } + + protected function buildModelExceptions($model) + { + if ($this->brand == 'O2') { + $model = preg_replace('/([a-z])([A-Z])/', '$1 $2', $model); + $model = ucwords(str_replace('_', ' ', $model)); + } + + return $model; + } + + /** + * This method is used in this class for processing results of pregmatch + * results into string containing recognized information. + * + * General algorithm: + * Parsing UserAgent string consists of trying to match it against list of + * regular expressions for three different information: + * browser + version, + * OS + version, + * device manufacturer + model. + * + * After match has been found iteration stops, and results are processed + * by buildByMatch. + * As $item we get decoded name (name of browser, name of OS, name of manufacturer). + * In array $match we recieve preg_match results containing whole string matched at index 0 + * and following matches in further indexes. Desired action now is to concatenate + * decoded name ($item) with matches found. First step is to append first found match, + * which is located in index=1 (that's why $nb is 1 by default). + * In other cases, where whe know that preg_match may return more than 1 result, + * we call buildByMatch with $nb = 2 or more, depending on what will be returned from + * regular expression. + * + * Example: + * We are parsing UserAgent of Firefox 20.0 browser. + * UserAgentParserEnhanced calls buildBrowserName() and buildBrowserVersion() in order + * to retrieve those information. + * In buildBrowserName() we only have one call of buildByMatch, where passed argument + * is regular expression testing given string for browser name. In this case, we are only + * interrested in first hit, so no $nb parameter will be set to 1. After finding match, and calling + * buildByMatch - we will receive just the name of browser. + * + * Also after decoding browser we will get list of regular expressions for this browser name + * testing UserAgent string for version number. Again we iterate over this list, and after finding first + * occurence - we break loop and proceed to build by match. Since browser regular expressions can + * contain two hits (major version and minor version) in function buildBrowserVersion() we have + * two calls to buildByMatch, one without 3rd parameter, and second with $nb set to 2. + * This way we can retrieve version number, and assign it to object property. + * + * In case of mobiles.yml this schema slightly varies, but general idea is the same. + * + * @param string $item + * @param array $matches + * @param int $nb + * @return type + */ + protected function buildByMatch($item, $matches, $nb = '1') + { + if (strpos($item, '$' . $nb) === false) + return $item; + + $replace = isset($matches[$nb]) ? $matches[$nb] : ''; + return trim(str_replace('$' . $nb, $replace, $item)); + } + + public function isBot() + { + $decodedFamily = ''; + if (in_array($this->getOs('name'), self::$osShorts)) { + $osShort = self::$osShorts[$this->getOs('name')]; + } else { + $osShort = ''; + } + foreach (self::$osFamilies as $family => $familyOs) { + if (in_array($osShort, $familyOs)) { + $decodedFamily = $family; + break; + } + } + + return $decodedFamily == 'Bot'; + } + + public function isSimulator() + { + $decodedFamily = ''; + if (in_array($this->getOs('name'), self::$osShorts)) { + $osShort = self::$osShorts[$this->getOs('name')]; + } else { + $osShort = ''; + } + foreach (self::$osFamilies as $family => $familyOs) { + if (in_array($osShort, $familyOs)) { + $decodedFamily = $family; + break; + } + } + return $decodedFamily == 'Simulator'; + } + + public function isMobile() + { + return !$this->isDesktop(); + } + + public function isDesktop() + { + $osName = $this->getOs('name'); + if (empty($osName)) + return false; + + $osShort = self::$osShorts[$osName]; + foreach (self::$osFamilies as $family => $familyOs) { + if (in_array($osShort, $familyOs)) { + $decodedFamily = $family; + break; + } + } + return in_array($decodedFamily, self::$desktopOsArray); + } + + public function getOs($attr = '') + { + if ($attr == '') { + return $this->os; + } + + if (!isset($this->os[$attr])) { + return ''; + } + + if ($attr == 'version') { + $this->os['version'] = $this->os['version']; + } + return $this->os[$attr]; + } + + public function getBrowser($attr = '') + { + if ($attr == '') { + return $this->browser; + } + + if (!isset($this->browser[$attr])) { + return ''; + } + + return $this->browser[$attr]; + } + + public function getDevice() + { + return $this->device; + } + + public function getBrand() + { + return $this->brand; + } + + public function getModel() + { + return $this->model; + } + + public function getUserAgent() + { + return $this->userAgent; + } + + public static function getOsFamily($osLabel) + { + $osShortName = substr($osLabel, 0, 3); + + foreach (self::$osFamilies as $osFamily => $osShortNames) { + if (in_array($osShortName, $osShortNames)) { + return $osFamily; + } + } + error_log($osLabel); + return 'Other'; + } + + public static function getBrowserFamily($browserLabel) + { + foreach (self::$browserFamilies as $browserFamily => $browserShortNames) { + if (in_array($browserLabel, $browserShortNames)) { + return $browserFamily; + } + } + + return 'Other'; + } + +} \ No newline at end of file diff --git a/plugins/DevicesDetection/UserAgentParserEnhanced/regexes/browsers.yml b/plugins/DevicesDetection/UserAgentParserEnhanced/regexes/browsers.yml new file mode 100644 index 0000000000..c9f3a72e5a --- /dev/null +++ b/plugins/DevicesDetection/UserAgentParserEnhanced/regexes/browsers.yml @@ -0,0 +1,408 @@ +############### +# Piwik - Open source web analytics +# +# @link http://piwik.org +# @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later +# +# @category Piwik_Plugins +# @package Piwik_DevicesDetection +############### + +# SeaMonkey +- regex: '(Iceape|SeaMonkey)/(\d+\.\d+)' + name: $1 + version: '$2' + +# Camino +- regex: 'Camino/(\d+\.\d+)' + name: Camino + version: '$1' + +#Fennec (Firefox for mobile) +- regex: 'Fennec/(\d+\.\d+)' + name: Fennec + version: '$1' + +#MicroB +- regex: 'Firefox.*Tablet browser (\d+\.\d+)' + name: MicroB + version: '$1' + +#Firefox +- regex: 'Firefox/(\d+\.\d+)' + name: Firefox + version: '$1' +- regex: '(BonEcho|GranParadiso|Lorentz|Minefield|Namoroka|Shiretoko)/(\d+\.\d+)' + name: Firefox '$1' + version: '$2' + +#Flock +- regex: 'Flock/(\d+\.\d+)' + name: Flock + version: '$1' + +#RockMelt +- regex: 'RockMelt/(\d+\.\d+)' + name: RockMelt + version: '$1' + +#Netscape +- regex: '(?:Navigator|Netscape6)/(\d+\.\d+)' + name: Netscape + version: '$1' + +#Opera +- regex: '(:?Opera Tablet.*Version|Opera/.+Opera Mobi.+Version|Safari.*OPR)/(\d+\.\d+)' + name: Opera Mobile + version: '$2' +- regex: 'Opera Mini/(:?att/)?(\d+\.\d+)' + name: Opera Mini + version: '$2' +- regex: 'Opera[/ ](?:9.80.*Version/)?(\d+\.\d+)' + name: Opera + version: '$1' + +#wOSBrowser +- regex: '(?:hpw|web)OS/(\d+\.\d+)' + name: wOSBrowser + version: '$1' + +#Swiftfox +- regex: 'Firefox/(\d+\.\d+).*\(Swiftfox\)' + name: Swiftfox + version: '$1' + +#Rekonq +- regex: 'rekonq' + name: Rekonq + version: '' + +#Conkeror +- regex: 'Conkeror/(\d+\.\d+)' + name: Conkeror + version: '$1' + +#Konqueror +- regex: 'Konqueror/(\d+\.\d+)' + name: Konqueror + version: '$1' + +#Baidu Browser +- regex: 'baidubrowser[/ ](\d+)' + name: Baidu Browser + version: '$1' + +#Yandex Browser +- regex: 'YaBrowser/(\d+)' + name: Yandex Browser + version: '$1' + +#Chrome +- regex: 'CrMo/(\d+\.\d+)' + name: Chrome Mobile + version: '$1' +- regex: 'CriOS/(\d+\.\d+)' + name: Chrome Mobile iOS + version: '$1' +- regex: 'Chrome/(\d+\.\d+).*Mobile' + name: Chrome Mobile + version: '$1' +- regex: 'chromeframe/(\d+\.\d+)' + name: Chrome Frame + version: '$1' +- regex: 'Chrome/(\d+\.\d+)' + name: Chrome + version: '$1' +- regex: 'Chromium/(\d+\.\d+)' + name: Chromium + version: '$1' + +#UC Browser +- regex: 'UC[ ]?Browser[ /](\d+\.\d+)' + name: UC Browser + version: '$1' +- regex: '(?:UC Browser|UCBrowser|UCWEB)(\d+\.\d+)' + name: UC Browser + version: '$1' + +#Tizen Browser +- regex: '(?:Tizen|SLP) Browser/(\d+\.\d+)' + name: Tizen Browser + version: '$1' + +#Epiphany +- regex: 'Epiphany/(\d+\.\d+)' + name: Epiphany + version: '$1' + +#Fireweb Navigator +- regex: 'Fireweb Navigator/(\d+\.\d+)' + name: Fireweb Navigator + version: '$1' + +#Jasmine +- regex: 'Jasmine[ /](\d+\.\d+)' + name: Jasmine + version: '$1' + +#Lynx +- regex: 'Lynx/(\d+\.\d+)' + name: Lynx + version: '$1' + +#Midori +- regex: 'Midori/(\d+\.\d+)' + name: Midori + version: '$1' + +#NCSA Mosaic +- regex: 'NCSA_Mosaic/(\d+\.\d+)' + name: NCSA Mosaic + version: '$1' + +#ABrowse +- regex: 'ABrowse (\d+\.\d+)' + name: ABrowse + version: '$1' + +#Amaya +- regex: 'amaya/(\d+\.\d+)' + name: Amaya + version: '$1' + +#Amiga Voyager +- regex: 'AmigaVoyager/(\d+\.\d+)' + name: Amiga Voyager + version: '$1' + +#Amiga Aweb +- regex: 'Amiga-Aweb/(\d+\.\d+)' + name: Amiga Aweb + version: '$1' + +#Arora +- regex: 'Arora/(\d+\.\d+)' + name: Arora + version: '$1' + +#Beonex +- regex: 'Beonex/(\d+\.\d+)' + name: Beonex + version: '$1' + +#BlackBerry Browser +- regex: 'Black[bB]erry|PlayBook|BB10' + name: BlackBerry Browser + version: '' + +#BrowseX +- regex: 'BrowseX \((\d+\.\d+)' + name: BrowseX + version: '$1' + +#Cheshire +- regex: 'Cheshire/(\d+\.\d+)' + name: Cheshire + version: '$1' + +#CometBird +- regex: 'CometBird/(\d+\.\d+)' + name: CometBird + version: '$1' + +#Dillo +- regex: 'Dillo/(\d+\.\d+)' + name: Dillo + version: '$1' + +#Dolphin +- regex: 'Dolfin/(\d+\.\d+)|dolphin' + name: Dolphin + version: '$1' + +#Elinks +- regex: 'Elinks/(\d+\.\d+)' + name: Elinks + version: '$1' + +#Firebird +- regex: 'Firebird/(\d+\.\d+)' + name: Firebird + version: '$1' + +#Fluid +- regex: 'Fluid/(\d+\.\d+)' + name: Fluid + version: '$1' + +#Galeon +- regex: 'Galeon/(\d+\.\d+)' + name: Galeon + version: '$1' + +#Google Earth +- regex: 'Google Earth/(\d+\.\d+)' + name: Google Earth + version: '$1' + +#HotJava +- regex: 'HotJava/(\d+\.\d+)' + name: HotJava + version: '$1' + +#IBrowse +- regex: 'IBrowse[ /](\d+\.\d+)' + name: IBrowse + version: '$1' + +#iCab +- regex: 'iCab[ /](\d+\.\d+)' + name: iCab + version: '$1' + +#Internet Explorer +- regex: 'IEMobile[ /](\d+\.\d+)' + name: IE Mobile + version: '$1' +- regex: 'MSIE (\d+\.\d+).*XBLWP7' + name: IE Mobile + version: '$1' +- regex: 'MSIE (\d+\.\d+)' + name: Internet Explorer + version: '$1' + +#Iron +- regex: 'Iron/(\d+\.\d+)' + name: Iron + version: '$1' + +#Kapiko +- regex: 'Kapiko/(\d+\.\d+)' + name: Kapiko + version: '$1' + +#Kazehakase +- regex: 'Kazehakase/(\d+\.\d+)' + name: Kazehakase + version: '$1' + +#Kindle Browser +- regex: 'Kindle/(\d+\.\d+)' + name: Kindle Browser + version: '$1' + +#K-meleon +- regex: 'K-meleon/(\d+\.\d+)' + name: K-meleon + version: '$1' + +#Lightning +- regex: 'Lightning/(\d+\.\d+)' + name: Lightning + version: '$1' + +#Links +- regex: 'Links \((\d+\.\d+)' + name: Links + version: '$1' + +#Maxthon +- regex: 'Maxthon (\d+\.\d+)' + name: Maxthon + version: '$1' +- regex: '(?:Maxthon|MyIE2|Uzbl|Shiira)' + name: Maxthon + version: '' + +#Openwave Mobile Browser +- regex: 'UP.Browser/(\d+\.\d+)' + name: Openwave Mobile Browser + version: '$1' + +#OmniWeb +- regex: 'OmniWeb/[v]?(\d+\.\d+)' + name: OmniWeb + version: '$1' + +#Phoenix +- regex: 'Phoenix/(\d+\.\d+)' + name: Phoenix + version: '$1' + +#Mobile Silk +- regex: 'Silk/(\d+\.\d+)' + name: Mobile Silk + version: '$1' + +#Nokia Browser +- regex: '(?:NokiaBrowser|BrowserNG)/(\d+\.\d+)' + name: Nokia Browser + version: '$1' +- regex: 'Series60/5\.0' + name: Nokia Browser + version: '7.0' +- regex: 'Series60/(\d+\.\d+)' + name: Nokia OSS Browser + version: '$1' +- regex: 'S40OviBrowser/(\d+\.\d+)' + name: Nokia Ovi Browser + version: '$1' +- regex: '^Nokia|Nokia[EN]?\d+' + name: Nokia Browser + version: '' + +#NetFront +- regex: 'NetFrontLifeBrowser/(\d+\.\d+)' + name: NetFront Life + version: '$1' +- regex: 'NetFront/(\d+\.\d+)' + name: NetFront + version: '$1' +- regex: 'PLAYSTATION|NINTENDO 3|AppleWebKit.+ NX/\d+\.\d+\.\d+' + name: NetFront + version: '' + +#Obigo +- regex: 'Obigo[ ]?(?:InternetBrowser|Browser)?[ /]([A-Za-z0-9]*)' + name: Obigo + version: '$1' +- regex: 'Obigo|Teleca' + name: Obigo + version: '' + +#Palm Blazer +- regex: 'Blazer/(\d+\.\d+)' + name: Palm Blazer + version: '$1' +- regex: 'Pre/(\d+\.\d+)' + name: Palm Pre + version: '$1' + +#Polaris +- regex: '(?:Polaris|Embider)/(\d+\.\d+)' + name: Polaris + version: '$1' + +#Snowshoe +- regex: 'Snowshoe/(\d+\.\d+)' + name: Snowshoe + version: '$1' + +#Safari +- regex: '(?:iPod|iPad|iPhone).+Version/(\d+\.\d+)' + name: Mobile Safari + version: '$1' +- regex: 'Version/(\d+\.\d+).*Mobile.*Safari/' + name: Mobile Safari + version: '$1' +- regex: '(?:iPod|iPhone|iPad)' + name: Mobile Safari + version: '' +- regex: 'Version/(\d+\.\d+).*Safari/|Safari/\d+' + name: Safari + version: '$1' + +#Android Browser +- regex: 'Android' + name: Android Browser + version: '' \ No newline at end of file diff --git a/plugins/DevicesDetection/UserAgentParserEnhanced/regexes/mobiles.yml b/plugins/DevicesDetection/UserAgentParserEnhanced/regexes/mobiles.yml new file mode 100644 index 0000000000..64b1470ef2 --- /dev/null +++ b/plugins/DevicesDetection/UserAgentParserEnhanced/regexes/mobiles.yml @@ -0,0 +1,958 @@ +############### +# Piwik - Open source web analytics +# +# @link http://piwik.org +# @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later +# +# @category Piwik_Plugins +# @package Piwik_DevicesDetection +############### + +# HTC +HTC: + regex: 'HTC|Sprint APA|ADR[A-Za-z0-9]+' + device: 'smartphone' + models: + - regex: 'HTC ([A-Za-z0-9]+) Build' + model: '$1' + - regex: 'HTC ([A-Za-z0-9]+(?: [A-Za-z0-9]+)?)' + model: '$1' + - regex: 'USCCHTC(\d+)' + model: '$1' + - regex: 'Sprint APA(9292)' + model: '$1 (Sprint)' + - regex: 'HTC_([A-Za-z0-9_]+)' + model: '$1' + - regex: 'HTC(?:[\-/ ])?([A-Za-z0-9]+)' + model: '$1' + - regex: 'HTC;(?: )?([A-Za-z0-9 ]+)' + model: '$1' + - regex: '(ADR[A-Za-z0-9]+)' + model: '$1' + +# Tesla Model S +Tesla: + regex: 'QtCarBrowser' + device: 'car browser' + model: 'Model S' + +# Kindle +Kindle: + regex: 'KF(?:OT|TT|JWI|JWA) Build|Kindle|Silk/(\d+)\.(\d+)' + device: 'tablet' + models: + - regex: 'KFOT|Kindle Fire|Silk/(\d+)\.(\d+)' + model: 'Fire' + - regex: 'KFTT' + model: 'Fire HD' + - regex: 'KFJWI' + model: 'Fire HD 8.9" WiFi' + - regex: 'KFJWA' + model: 'Fire HD 8.9" 4G' + +# NOKIA +Nokia: + regex: 'Nokia|Lumia|Maemo RX|portalmmm/2\.0 N7|portalmmm/2\.0 NK|nok[0-9]+|Symbian.*\s([a-zA-Z0-9]+)$' + device: 'smartphone' + models: + - regex: 'NokiaInternal|Nokia-WAP-Toolkit|Nokia-MIT-Browser|Nokia Mobile|Nokia Browser|Nokia/Series' + model: '' + - regex: 'Nokia(N[0-9]+)' + model: '$1' + - regex: 'Nokia-([A-Za-z0-9]+)' + model: 'N$1' + - regex: 'NOKIA; ([A-Za-z0-9\- ]+)' + model: '$1' + - regex: 'NOKIA[ ]?([A-Za-z0-9\-]+)' + model: '$1' + - regex: 'NOKIA/([A-Za-z0-9 ]+)' + model: '$1' + - regex: '(Lumia [A-Za-z0-9\-]+)' + model: '$1' + - regex: 'Maemo RX-51 ([A-Za-z0-9]+)' + model: '$1' + - regex: 'Maemo RX-34' + model: 'N800' + - regex: 'portalmmm/2\.0 (N7[37]|NK[A-Za-z0-9]+)' + model: '$1' + - regex: 'nok([0-9]+)' + model: '$1' + - regex: 'Symbian.*\s([a-zA-Z0-9]+)$' + device: 'feature phone' + model: '$1' + +# RIM/BlackBerry +RIM: + regex: 'BB10;|BlackBerry|rim[0-9]+|PlayBook' + device: 'smartphone' + + models: + - regex: 'BB10; ([A-Za-z0-9\- ]+)\)' + model: 'BlackBerry $1' + - regex: 'PlayBook.+RIM Tablet OS' + model: 'BlackBerry Playbook' + device: 'tablet' + - regex: 'BlackBerry(?: )?([A-Za-z0-9]+)' + model: 'BlackBerry $1' + - regex: 'rim([0-9]+)' + model: 'BlackBerry $1' + - regex: 'BlackBerry' + model: 'BlackBerry' + +# PALM +Palm: + regex: '(?:Pre|Pixi)/(\d+)\.(\d+)|Palm|Treo' + device: 'smartphone' + models: + - regex: '((?:Pre|Pixi))/(\d+\.\d+)' + model: '$1 $2' + - regex: 'Palm(?: )?([A-Za-z0-9]+)' + model: '$1' + - regex: 'Treo([A-Za-z0-9]+)' + model: 'Treo $1' + +# HP +HP: + regex: 'Touch[Pp]ad|hp-tablet|HP(?: )?iPAQ|webOS.*(P160U)' + device: 'smartphone' + models: + - regex: 'Touch[Pp]ad/(\d+\.\d+)|hp-tablet' + model: 'TouchPad' + device: 'tablet' + - regex: 'HP(?: )?iPAQ(?: )?([A-Za-z0-9]+)' + model: 'iPAQ $1' + - regex: 'webOS.*(P160U)' + model: 'Veer' + +# TiPhone +TiPhone: + regex: 'TiPhone(?: )?([A-Za-z0-9]+)' + device: 'smartphone' + model: '$1' + +# Apple +Apple: + regex: 'AppleTV|iPad|iPod|iPhone' + models: + - regex: 'AppleTV' + model: 'Apple TV' + device: 'tv' + - regex: 'iPad' + model: 'iPad' + device: 'tablet' + - regex: 'iPod' + model: 'iPod Touch' + device: 'palmtop' + - regex: 'iPhone' + model: 'iPhone' + device: 'smartphone' + +# Acer +Acer: + regex: 'acer[\-_]([A-Za-z0-9]+)' + device: 'smartphone' + model: '$1' + +# Airness +Airness: + regex: 'AIRNESS-([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# Alcatel +Alcatel: + regex: 'Alcatel|Alc([A-Za-z0-9]+)' + device: 'smartphone' + models: + - regex: 'Alcatel UP' + model: '' + - regex: 'ALCATEL[ \-]([A-Za-z0-9\-]+)' + model: '$1' + - regex: 'ALCATEL_([A-Za-z0-9_]+)' + model: '$1' + - regex: 'Alc([A-Za-z0-9]+)' + model: '$1' + +# Amoi +Amoi: + regex: 'Amoi' + device: 'smartphone' + models: + - regex: 'Amoi[\- /](A-Za-z0-9]+)' + mobile: '$1' + - regex: 'Amoisonic-([A-Za-z0-9]+)' + model: '$1' + +# Asus +Asus: + regex: 'Asus' + device: 'smartphone' + models: + - regex: 'Asus(?:-|;)?([A-Za-z0-9]+)' + model: '$1' + - regex: 'ASUS (Transformer Pad TF300T)' + device: 'tablet' + model: '$1' + +# Audiovox +Audiovox: + regex: 'Audiovox|CDM|UTS(?:TARCOM)?\-|audio([A-Za-z0-9\-]+)' + device: 'smartphone' + models: + - regex: 'Audiovox[_\-]([A-Za-z0-9\-]+)' + model: '$1' + - regex: 'CDM(?:-)?([A-Za-z0-9]+)' + model: 'CDM-$1' + - regex: 'UTS(?:TARCOM)?-([A-Za-z0-9\-]+)' + model: 'CDM-$1' + - regex: 'audio([A-Za-z0-9\-]+)' + model: 'CDM-$1' + +# Avvio +Avvio: + regex: 'Avvio[ _]([A-Za-z0-9\-]+)' + device: 'smartphone' + model: '$1' + +# Bird +Bird: + regex: 'BIRD[\-. _]([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# Becker +Becker: + regex: 'Becker-([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# Beetel +Beetel: + regex: 'Beetel ([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# BenQ-Siemens +BenQ-Siemens: + regex: 'BENQ-SIEMENS - ([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# BenQ +BenQ: + regex: 'BENQ(?:[ \-])?([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# Capitel +Capitel: + regex: 'Capitel-([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# Compal +Compal: + regex: 'Compal-([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# Cricket +Cricket: + regex: 'Cricket-([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# Dell +Dell: + regex: 'Dell ([A-Za-z0-9]+)' + device: 'smartphone' + model: '$1' + +# Dbtel +Dbtel: + regex: 'DBTEL(?:[\-/])?([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# Dicam +Dicam: + regex: 'DICAM-([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# DoCoMo +DoCoMo: + regex: 'DoCoMo|\;FOMA|KGT/1\.0' + device: 'feature phone' + models: + - regex: 'DoCoMo/[12]\.0[/ ]([A-Za-z0-9]+)' + model: '$1' + - regex: '([A-Za-z0-9]+)(?:_W)?\;FOMA' + model: '$1' + - regex: 'KGT/1\.0 ([A-Za-z0-9]+)' + model: '$1' + +# Dopod +Dopod: + regex: 'Dopod(?: )?([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# Ericy +Ericy: + regex: 'Ericy-([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# Sony Ericsson +Sony Ericsson: + regex: 'Sony(?: )?Ericsson|portalmmm/2\.0 K' + device: 'smartphone' + models: + - regex: 'SonyEricsson([A-Za-z0-9]+)' + model: '$1' + - regex: 'Sony(?: )?Ericsson ([A-Za-z0-9\-]+)' + model: '$1' + - regex: 'portalmmm/2.0 K([A-Za-z0-9]+)' + model: 'K$1' + +# Ericsson +Ericsson: + regex: 'Ericsson(?:/ )?([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# eTouch +eTouch: + regex: 'eTouch(?: )?([A-Za-z0-9]+)' + device: 'smartphone' + model: '$1' + +# Ezze +Ezze: + regex: 'EZZE-|EZ([A-Za-z0-9]+)' + device: 'feature phone' + models: + - regex: 'EZZE-([A-Za-z0-9]+)' + model: '$1' + - regex: 'EZ([A-Za-z0-9]+)' + model: 'EZ$1' + +# Ezio +Ezio: + regex: 'EZIO-([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# Gionee +Gionee: + regex: 'GIONEE-([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# Google +Google: + regex: 'Nexus|GoogleTV' + device: 'smartphone' + models: + - regex: '(Galaxy Nexus)' + model: '$1' + - regex: '(Nexus (:?S|4|One))' + model: '$1' + - regex: '(Nexus (:?7|10))' + device: 'tablet' + model: '$1' + - regex: '(GoogleTV)' + device: 'tv' + model: '$1' + +# Gradiente +Gradiente: + regex: 'GRADIENTE' + device: 'feature phone' + models: + - regex: 'GRADIENTE-([A-Za-z0-9]+)' + model: '$1' + - regex: 'GRADIENTE ([A-Za-z0-9\-]+)' + model: '$1' + +# Grundig +Grundig: + regex: 'GRUNDIG|portalmmm/2\.0 G' + device: 'tv' + models: + - regex: 'GRUNDIG ([A-Za-z0-9]+)' + model: '$1' + - regex: 'portalmmm/2\.0 G([A-Za-z0-9]+)' + model: 'G$1' + +# Haier +Haier: + regex: 'Haier[ -]([A-Za-z0-9\-]+)' + device: 'feature phone' + model: '$1' + +# Huawei +Huawei: + regex: 'Huawei|vodafone([A-Za-z0-9]+)' + device: 'smartphone' + models: + - regex: 'Huawei(?:[\- /_]|/1\.0/)?([A-Za-z0-9]+)' + model: '$1' + - regex: 'vodafone([A-Za-z0-9]+)' + model: 'Vodafone $1' + +# Innostream +Innostream: + regex: 'INNO([A-Za-z0-9]+)' + device: 'feature phone' + model: 'INNO$1' + +# Inq +INQ: + regex: 'INQ/([A-Za-z0-9\-]+)' + device: 'feature phone' + model: '$1' + +# i-mate +i-mate: + regex: 'i-mate ([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# i-mobile +i-mobile: + regex: 'i-mobile(?: )?([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# ikomo +iKoMo: + regex: 'iKoMo ([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# kddi +KDDI: + regex: 'kddi-([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# kyocera +Kyocera: + regex: 'Kyocera|KWC-|QC-' + device: 'smartphone' + models: + - regex: 'Kyocera-KZ-([A-Za-z0-9]+)' + model: 'KZ $1' + - regex: 'Kyocera(:?[\-/])?([A-Za-z0-9]+)' + model: '$1' + - regex: '(?:KWC|QC)-([A-Za-z0-9]+)' + model: '$1' + +# lanix +Lanix: + regex: 'LANIX-([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# lct +LCT: + regex: 'LCT_([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# lenovo +Lenovo: + regex: 'Lenovo[\-_]([A-Za-z0-9]+)' + device: 'smartphone' + model: '$1' + +# lguplus +LGUPlus: + regex: 'LGUPlus' + device: 'smartphone' + model: '' + +# lg +LG: + regex: 'LG|portalmmm/2\.0 (?:KE|KG|KP|L3)|VX[0-9]+' + device: 'smartphone' + models: + - regex: 'LGE_DLNA_SDK' + device: 'tv' + model: 'NetCast' + - regex: 'LGE(?: |-LG| LG-AX|-)([A-Za-z0-9]+)' + model: '$1' + - regex: 'LGE;([A-Za-z0-9\-]+)' + model: '$1' + - regex: 'LG(?:/|-LG| |-)?([A-Za-z0-9]+)' + model: '$1' + - regex: 'LG; ([A-Za-z0-9 ]+)' + model: '$1' + - regex: 'portalmmm/2.0 ((?:KE|KG|KP|L3)[A-Za-z0-9]+)' + model: '$1' + - regex: '(VX[0-9]+)' + model: '$1' + +# microsoft +Microsoft: + regex: 'Xbox|KIN\.(?:One|Two)' + device: 'console' + model: 'Xbox 360' + +# Konka +Konka: + regex: 'KONKA_([A-Za-z0-9]+)' + device: 'feature phone' + model: '$1' + +# Karbonn +Karbonn: + regex: 'Karbonn_([A-Za-z0-9]+)' + device: 'smartphone' + model: '$1' + +# Sagem +Sagem: + regex: 'SAGEM|portalmmm/2.0 (?:SG|my)' + device: 'smartphone' + models: + - regex: 'SAGEM ([A-Za-z0-9]+)' + model: '$1' + - regex: 'SAGEM-([A-Za-z0-9\-]+)' + model: '$1' + - regex: 'portalmmm/2.0 ((?:SG|my)[A-Za-z0-9]+)' + model: '$1' + +# micromax +MicroMax: + regex: 'MicroMax(?:[ \-])?([A-Za-z0-9]+)' + device: 'smartphone' + model: '$1' + +# mio +Mio: + regex: 'MIO(?:/)?([A-Za-z0-9]+)' + device: 'smartphone' + model: '$1' + +# mitsubishi +Mitsubishi: + regex: 'MITSU|portalmmm/[12]\.0 M' + device: 'feature phone' + models: + - regex: 'MITSU/[A-Za-z0-9.]+ \(([A-Za-z0-9]+)\)' + model: '$1' + - regex: 'MITSU[ \-]?([A-Za-z0-9]+)' + model: '$1' + - regex: 'portalmmm/[12]\.0 (M[A-Za-z0-9]+)' + model: '$1' + +# motorola +Motorola: + regex: 'MOT|(? + * @author Chris Wanstrath + * @link http://code.google.com/p/spyc/ + * @copyright Copyright 2005-2006 Chris Wanstrath, 2006-2011 Vlad Andersen + * @license http://www.opensource.org/licenses/mit-license.php MIT License + * @package Spyc + */ + +if (!function_exists('spyc_load')) { + /** + * Parses YAML to array. + * @param string $string YAML string. + * @return array + */ + function spyc_load ($string) { + return Spyc::YAMLLoadString($string); + } +} + +if (!function_exists('spyc_load_file')) { + /** + * Parses YAML to array. + * @param string $file Path to YAML file. + * @return array + */ + function spyc_load_file ($file) { + return Spyc::YAMLLoad($file); + } +} + +/** + * The Simple PHP YAML Class. + * + * This class can be used to read a YAML file and convert its contents + * into a PHP array. It currently supports a very limited subsection of + * the YAML spec. + * + * Usage: + * + * $Spyc = new Spyc; + * $array = $Spyc->load($file); + * + * or: + * + * $array = Spyc::YAMLLoad($file); + * + * or: + * + * $array = spyc_load_file($file); + * + * @package Spyc + */ +class Spyc { + + // SETTINGS + + const REMPTY = "\0\0\0\0\0"; + + /** + * Setting this to true will force YAMLDump to enclose any string value in + * quotes. False by default. + * + * @var bool + */ + public $setting_dump_force_quotes = false; + + /** + * Setting this to true will forse YAMLLoad to use syck_load function when + * possible. False by default. + * @var bool + */ + public $setting_use_syck_is_possible = false; + + + + /**#@+ + * @access private + * @var mixed + */ + private $_dumpIndent; + private $_dumpWordWrap; + private $_containsGroupAnchor = false; + private $_containsGroupAlias = false; + private $path; + private $result; + private $LiteralPlaceHolder = '___YAML_Literal_Block___'; + private $SavedGroups = array(); + private $indent; + /** + * Path modifier that should be applied after adding current element. + * @var array + */ + private $delayedPath = array(); + + /**#@+ + * @access public + * @var mixed + */ + public $_nodeId; + +/** + * Load a valid YAML string to Spyc. + * @param string $input + * @return array + */ + public function load ($input) { + return $this->__loadString($input); + } + + /** + * Load a valid YAML file to Spyc. + * @param string $file + * @return array + */ + public function loadFile ($file) { + return $this->__load($file); + } + + /** + * Load YAML into a PHP array statically + * + * The load method, when supplied with a YAML stream (string or file), + * will do its best to convert YAML in a file into a PHP array. Pretty + * simple. + * Usage: + * + * $array = Spyc::YAMLLoad('lucky.yaml'); + * print_r($array); + * + * @access public + * @return array + * @param string $input Path of YAML file or string containing YAML + */ + public static function YAMLLoad($input) { + $Spyc = new Spyc; + return $Spyc->__load($input); + } + + /** + * Load a string of YAML into a PHP array statically + * + * The load method, when supplied with a YAML string, will do its best + * to convert YAML in a string into a PHP array. Pretty simple. + * + * Note: use this function if you don't want files from the file system + * loaded and processed as YAML. This is of interest to people concerned + * about security whose input is from a string. + * + * Usage: + * + * $array = Spyc::YAMLLoadString("---\n0: hello world\n"); + * print_r($array); + * + * @access public + * @return array + * @param string $input String containing YAML + */ + public static function YAMLLoadString($input) { + $Spyc = new Spyc; + return $Spyc->__loadString($input); + } + + /** + * Dump YAML from PHP array statically + * + * The dump method, when supplied with an array, will do its best + * to convert the array into friendly YAML. Pretty simple. Feel free to + * save the returned string as nothing.yaml and pass it around. + * + * Oh, and you can decide how big the indent is and what the wordwrap + * for folding is. Pretty cool -- just pass in 'false' for either if + * you want to use the default. + * + * Indent's default is 2 spaces, wordwrap's default is 40 characters. And + * you can turn off wordwrap by passing in 0. + * + * @access public + * @return string + * @param array $array PHP array + * @param int $indent Pass in false to use the default, which is 2 + * @param int $wordwrap Pass in 0 for no wordwrap, false for default (40) + */ + public static function YAMLDump($array,$indent = false,$wordwrap = false) { + $spyc = new Spyc; + return $spyc->dump($array,$indent,$wordwrap); + } + + + /** + * Dump PHP array to YAML + * + * The dump method, when supplied with an array, will do its best + * to convert the array into friendly YAML. Pretty simple. Feel free to + * save the returned string as tasteful.yaml and pass it around. + * + * Oh, and you can decide how big the indent is and what the wordwrap + * for folding is. Pretty cool -- just pass in 'false' for either if + * you want to use the default. + * + * Indent's default is 2 spaces, wordwrap's default is 40 characters. And + * you can turn off wordwrap by passing in 0. + * + * @access public + * @return string + * @param array $array PHP array + * @param int $indent Pass in false to use the default, which is 2 + * @param int $wordwrap Pass in 0 for no wordwrap, false for default (40) + */ + public function dump($array,$indent = false,$wordwrap = false) { + // Dumps to some very clean YAML. We'll have to add some more features + // and options soon. And better support for folding. + + // New features and options. + if ($indent === false or !is_numeric($indent)) { + $this->_dumpIndent = 2; + } else { + $this->_dumpIndent = $indent; + } + + if ($wordwrap === false or !is_numeric($wordwrap)) { + $this->_dumpWordWrap = 40; + } else { + $this->_dumpWordWrap = $wordwrap; + } + + // New YAML document + $string = "---\n"; + + // Start at the base of the array and move through it. + if ($array) { + $array = (array)$array; + $previous_key = -1; + foreach ($array as $key => $value) { + if (!isset($first_key)) $first_key = $key; + $string .= $this->_yamlize($key,$value,0,$previous_key, $first_key, $array); + $previous_key = $key; + } + } + return $string; + } + + /** + * Attempts to convert a key / value array item to YAML + * @access private + * @return string + * @param $key The name of the key + * @param $value The value of the item + * @param $indent The indent of the current node + */ + private function _yamlize($key,$value,$indent, $previous_key = -1, $first_key = 0, $source_array = null) { + if (is_array($value)) { + if (empty ($value)) + return $this->_dumpNode($key, array(), $indent, $previous_key, $first_key, $source_array); + // It has children. What to do? + // Make it the right kind of item + $string = $this->_dumpNode($key, self::REMPTY, $indent, $previous_key, $first_key, $source_array); + // Add the indent + $indent += $this->_dumpIndent; + // Yamlize the array + $string .= $this->_yamlizeArray($value,$indent); + } elseif (!is_array($value)) { + // It doesn't have children. Yip. + $string = $this->_dumpNode($key, $value, $indent, $previous_key, $first_key, $source_array); + } + return $string; + } + + /** + * Attempts to convert an array to YAML + * @access private + * @return string + * @param $array The array you want to convert + * @param $indent The indent of the current level + */ + private function _yamlizeArray($array,$indent) { + if (is_array($array)) { + $string = ''; + $previous_key = -1; + foreach ($array as $key => $value) { + if (!isset($first_key)) $first_key = $key; + $string .= $this->_yamlize($key, $value, $indent, $previous_key, $first_key, $array); + $previous_key = $key; + } + return $string; + } else { + return false; + } + } + + /** + * Returns YAML from a key and a value + * @access private + * @return string + * @param $key The name of the key + * @param $value The value of the item + * @param $indent The indent of the current node + */ + private function _dumpNode($key, $value, $indent, $previous_key = -1, $first_key = 0, $source_array = null) { + // do some folding here, for blocks + if (is_string ($value) && ((strpos($value,"\n") !== false || strpos($value,": ") !== false || strpos($value,"- ") !== false || + strpos($value,"*") !== false || strpos($value,"#") !== false || strpos($value,"<") !== false || strpos($value,">") !== false || strpos ($value, ' ') !== false || + strpos($value,"[") !== false || strpos($value,"]") !== false || strpos($value,"{") !== false || strpos($value,"}") !== false) || strpos($value,"&") !== false || strpos($value, "'") !== false || strpos($value, "!") === 0 || + substr ($value, -1, 1) == ':') + ) { + $value = $this->_doLiteralBlock($value,$indent); + } else { + $value = $this->_doFolding($value,$indent); + } + + if ($value === array()) $value = '[ ]'; + if (in_array ($value, array ('true', 'TRUE', 'false', 'FALSE', 'y', 'Y', 'n', 'N', 'null', 'NULL'), true)) { + $value = $this->_doLiteralBlock($value,$indent); + } + if (trim ($value) != $value) + $value = $this->_doLiteralBlock($value,$indent); + + if (is_bool($value)) { + $value = ($value) ? "true" : "false"; + } + + if ($value === null) $value = 'null'; + if ($value === "'" . self::REMPTY . "'") $value = null; + + $spaces = str_repeat(' ',$indent); + + //if (is_int($key) && $key - 1 == $previous_key && $first_key===0) { + if (is_array ($source_array) && array_keys($source_array) === range(0, count($source_array) - 1)) { + // It's a sequence + $string = $spaces.'- '.$value."\n"; + } else { + // if ($first_key===0) throw new Exception('Keys are all screwy. The first one was zero, now it\'s "'. $key .'"'); + // It's mapped + if (strpos($key, ":") !== false || strpos($key, "#") !== false) { $key = '"' . $key . '"'; } + $string = rtrim ($spaces.$key.': '.$value)."\n"; + } + return $string; + } + + /** + * Creates a literal block for dumping + * @access private + * @return string + * @param $value + * @param $indent int The value of the indent + */ + private function _doLiteralBlock($value,$indent) { + if ($value === "\n") return '\n'; + if (strpos($value, "\n") === false && strpos($value, "'") === false) { + return sprintf ("'%s'", $value); + } + if (strpos($value, "\n") === false && strpos($value, '"') === false) { + return sprintf ('"%s"', $value); + } + $exploded = explode("\n",$value); + $newValue = '|'; + $indent += $this->_dumpIndent; + $spaces = str_repeat(' ',$indent); + foreach ($exploded as $line) { + $newValue .= "\n" . $spaces . ($line); + } + return $newValue; + } + + /** + * Folds a string of text, if necessary + * @access private + * @return string + * @param $value The string you wish to fold + */ + private function _doFolding($value,$indent) { + // Don't do anything if wordwrap is set to 0 + + if ($this->_dumpWordWrap !== 0 && is_string ($value) && strlen($value) > $this->_dumpWordWrap) { + $indent += $this->_dumpIndent; + $indent = str_repeat(' ',$indent); + $wrapped = wordwrap($value,$this->_dumpWordWrap,"\n$indent"); + $value = ">\n".$indent.$wrapped; + } else { + if ($this->setting_dump_force_quotes && is_string ($value) && $value !== self::REMPTY) + $value = '"' . $value . '"'; + } + + + return $value; + } + +// LOADING FUNCTIONS + + private function __load($input) { + $Source = $this->loadFromSource($input); + return $this->loadWithSource($Source); + } + + private function __loadString($input) { + $Source = $this->loadFromString($input); + return $this->loadWithSource($Source); + } + + private function loadWithSource($Source) { + if (empty ($Source)) return array(); + if ($this->setting_use_syck_is_possible && function_exists ('syck_load')) { + $array = syck_load (implode ('', $Source)); + return is_array($array) ? $array : array(); + } + + $this->path = array(); + $this->result = array(); + + $cnt = count($Source); + for ($i = 0; $i < $cnt; $i++) { + $line = $Source[$i]; + + $this->indent = strlen($line) - strlen(ltrim($line)); + $tempPath = $this->getParentPathByIndent($this->indent); + $line = self::stripIndent($line, $this->indent); + if (self::isComment($line)) continue; + if (self::isEmpty($line)) continue; + $this->path = $tempPath; + + $literalBlockStyle = self::startsLiteralBlock($line); + if ($literalBlockStyle) { + $line = rtrim ($line, $literalBlockStyle . " \n"); + $literalBlock = ''; + $line .= $this->LiteralPlaceHolder; + $literal_block_indent = strlen($Source[$i+1]) - strlen(ltrim($Source[$i+1])); + while (++$i < $cnt && $this->literalBlockContinues($Source[$i], $this->indent)) { + $literalBlock = $this->addLiteralLine($literalBlock, $Source[$i], $literalBlockStyle, $literal_block_indent); + } + $i--; + } + + while (++$i < $cnt && self::greedilyNeedNextLine($line)) { + $line = rtrim ($line, " \n\t\r") . ' ' . ltrim ($Source[$i], " \t"); + } + $i--; + + + + if (strpos ($line, '#')) { + if (strpos ($line, '"') === false && strpos ($line, "'") === false) + $line = preg_replace('/\s+#(.+)$/','',$line); + } + + $lineArray = $this->_parseLine($line); + + if ($literalBlockStyle) + $lineArray = $this->revertLiteralPlaceHolder ($lineArray, $literalBlock); + + $this->addArray($lineArray, $this->indent); + + foreach ($this->delayedPath as $indent => $delayedPath) + $this->path[$indent] = $delayedPath; + + $this->delayedPath = array(); + + } + return $this->result; + } + + private function loadFromSource ($input) { + if (!empty($input) && strpos($input, "\n") === false && file_exists($input)) + return file($input); + + return $this->loadFromString($input); + } + + private function loadFromString ($input) { + $lines = explode("\n",$input); + foreach ($lines as $k => $_) { + $lines[$k] = rtrim ($_, "\r"); + } + return $lines; + } + + /** + * Parses YAML code and returns an array for a node + * @access private + * @return array + * @param string $line A line from the YAML file + */ + private function _parseLine($line) { + if (!$line) return array(); + $line = trim($line); + if (!$line) return array(); + + $array = array(); + + $group = $this->nodeContainsGroup($line); + if ($group) { + $this->addGroup($line, $group); + $line = $this->stripGroup ($line, $group); + } + + if ($this->startsMappedSequence($line)) + return $this->returnMappedSequence($line); + + if ($this->startsMappedValue($line)) + return $this->returnMappedValue($line); + + if ($this->isArrayElement($line)) + return $this->returnArrayElement($line); + + if ($this->isPlainArray($line)) + return $this->returnPlainArray($line); + + + return $this->returnKeyValuePair($line); + + } + + /** + * Finds the type of the passed value, returns the value as the new type. + * @access private + * @param string $value + * @return mixed + */ + private function _toType($value) { + if ($value === '') return null; + $first_character = $value[0]; + $last_character = substr($value, -1, 1); + + $is_quoted = false; + do { + if (!$value) break; + if ($first_character != '"' && $first_character != "'") break; + if ($last_character != '"' && $last_character != "'") break; + $is_quoted = true; + } while (0); + + if ($is_quoted) + return strtr(substr ($value, 1, -1), array ('\\"' => '"', '\'\'' => '\'', '\\\'' => '\'')); + + if (strpos($value, ' #') !== false && !$is_quoted) + $value = preg_replace('/\s+#(.+)$/','',$value); + + if (!$is_quoted) $value = str_replace('\n', "\n", $value); + + if ($first_character == '[' && $last_character == ']') { + // Take out strings sequences and mappings + $innerValue = trim(substr ($value, 1, -1)); + if ($innerValue === '') return array(); + $explode = $this->_inlineEscape($innerValue); + // Propagate value array + $value = array(); + foreach ($explode as $v) { + $value[] = $this->_toType($v); + } + return $value; + } + + if (strpos($value,': ')!==false && $first_character != '{') { + $array = explode(': ',$value); + $key = trim($array[0]); + array_shift($array); + $value = trim(implode(': ',$array)); + $value = $this->_toType($value); + return array($key => $value); + } + + if ($first_character == '{' && $last_character == '}') { + $innerValue = trim(substr ($value, 1, -1)); + if ($innerValue === '') return array(); + // Inline Mapping + // Take out strings sequences and mappings + $explode = $this->_inlineEscape($innerValue); + // Propagate value array + $array = array(); + foreach ($explode as $v) { + $SubArr = $this->_toType($v); + if (empty($SubArr)) continue; + if (is_array ($SubArr)) { + $array[key($SubArr)] = $SubArr[key($SubArr)]; continue; + } + $array[] = $SubArr; + } + return $array; + } + + if ($value == 'null' || $value == 'NULL' || $value == 'Null' || $value == '' || $value == '~') { + return null; + } + + if ( is_numeric($value) && preg_match ('/^(-|)[1-9]+[0-9]*$/', $value) ){ + $intvalue = (int)$value; + if ($intvalue != PHP_INT_MAX) + $value = $intvalue; + return $value; + } + + if (in_array($value, + array('true', 'on', '+', 'yes', 'y', 'True', 'TRUE', 'On', 'ON', 'YES', 'Yes', 'Y'))) { + return true; + } + + if (in_array(strtolower($value), + array('false', 'off', '-', 'no', 'n'))) { + return false; + } + + if (is_numeric($value)) { + if ($value === '0') return 0; + if (rtrim ($value, 0) === $value) + $value = (float)$value; + return $value; + } + + return $value; + } + + /** + * Used in inlines to check for more inlines or quoted strings + * @access private + * @return array + */ + private function _inlineEscape($inline) { + // There's gotta be a cleaner way to do this... + // While pure sequences seem to be nesting just fine, + // pure mappings and mappings with sequences inside can't go very + // deep. This needs to be fixed. + + $seqs = array(); + $maps = array(); + $saved_strings = array(); + + // Check for strings + $regex = '/(?:(")|(?:\'))((?(1)[^"]+|[^\']+))(?(1)"|\')/'; + if (preg_match_all($regex,$inline,$strings)) { + $saved_strings = $strings[0]; + $inline = preg_replace($regex,'YAMLString',$inline); + } + unset($regex); + + $i = 0; + do { + + // Check for sequences + while (preg_match('/\[([^{}\[\]]+)\]/U',$inline,$matchseqs)) { + $seqs[] = $matchseqs[0]; + $inline = preg_replace('/\[([^{}\[\]]+)\]/U', ('YAMLSeq' . (count($seqs) - 1) . 's'), $inline, 1); + } + + // Check for mappings + while (preg_match('/{([^\[\]{}]+)}/U',$inline,$matchmaps)) { + $maps[] = $matchmaps[0]; + $inline = preg_replace('/{([^\[\]{}]+)}/U', ('YAMLMap' . (count($maps) - 1) . 's'), $inline, 1); + } + + if ($i++ >= 10) break; + + } while (strpos ($inline, '[') !== false || strpos ($inline, '{') !== false); + + $explode = explode(', ',$inline); + $stringi = 0; $i = 0; + + while (1) { + + // Re-add the sequences + if (!empty($seqs)) { + foreach ($explode as $key => $value) { + if (strpos($value,'YAMLSeq') !== false) { + foreach ($seqs as $seqk => $seq) { + $explode[$key] = str_replace(('YAMLSeq'.$seqk.'s'),$seq,$value); + $value = $explode[$key]; + } + } + } + } + + // Re-add the mappings + if (!empty($maps)) { + foreach ($explode as $key => $value) { + if (strpos($value,'YAMLMap') !== false) { + foreach ($maps as $mapk => $map) { + $explode[$key] = str_replace(('YAMLMap'.$mapk.'s'), $map, $value); + $value = $explode[$key]; + } + } + } + } + + + // Re-add the strings + if (!empty($saved_strings)) { + foreach ($explode as $key => $value) { + while (strpos($value,'YAMLString') !== false) { + $explode[$key] = preg_replace('/YAMLString/',$saved_strings[$stringi],$value, 1); + unset($saved_strings[$stringi]); + ++$stringi; + $value = $explode[$key]; + } + } + } + + $finished = true; + foreach ($explode as $key => $value) { + if (strpos($value,'YAMLSeq') !== false) { + $finished = false; break; + } + if (strpos($value,'YAMLMap') !== false) { + $finished = false; break; + } + if (strpos($value,'YAMLString') !== false) { + $finished = false; break; + } + } + if ($finished) break; + + $i++; + if ($i > 10) + break; // Prevent infinite loops. + } + + return $explode; + } + + private function literalBlockContinues ($line, $lineIndent) { + if (!trim($line)) return true; + if (strlen($line) - strlen(ltrim($line)) > $lineIndent) return true; + return false; + } + + private function referenceContentsByAlias ($alias) { + do { + if (!isset($this->SavedGroups[$alias])) { echo "Bad group name: $alias."; break; } + $groupPath = $this->SavedGroups[$alias]; + $value = $this->result; + foreach ($groupPath as $k) { + $value = $value[$k]; + } + } while (false); + return $value; + } + + private function addArrayInline ($array, $indent) { + $CommonGroupPath = $this->path; + if (empty ($array)) return false; + + foreach ($array as $k => $_) { + $this->addArray(array($k => $_), $indent); + $this->path = $CommonGroupPath; + } + return true; + } + + private function addArray ($incoming_data, $incoming_indent) { + + // print_r ($incoming_data); + + if (count ($incoming_data) > 1) + return $this->addArrayInline ($incoming_data, $incoming_indent); + + $key = key ($incoming_data); + $value = isset($incoming_data[$key]) ? $incoming_data[$key] : null; + if ($key === '__!YAMLZero') $key = '0'; + + if ($incoming_indent == 0 && !$this->_containsGroupAlias && !$this->_containsGroupAnchor) { // Shortcut for root-level values. + if ($key || $key === '' || $key === '0') { + $this->result[$key] = $value; + } else { + $this->result[] = $value; end ($this->result); $key = key ($this->result); + } + $this->path[$incoming_indent] = $key; + return; + } + + + + $history = array(); + // Unfolding inner array tree. + $history[] = $_arr = $this->result; + foreach ($this->path as $k) { + $history[] = $_arr = $_arr[$k]; + } + + if ($this->_containsGroupAlias) { + $value = $this->referenceContentsByAlias($this->_containsGroupAlias); + $this->_containsGroupAlias = false; + } + + + // Adding string or numeric key to the innermost level or $this->arr. + if (is_string($key) && $key == '<<') { + if (!is_array ($_arr)) { $_arr = array (); } + + $_arr = array_merge ($_arr, $value); + } else if ($key || $key === '' || $key === '0') { + if (!is_array ($_arr)) + $_arr = array ($key=>$value); + else + $_arr[$key] = $value; + } else { + if (!is_array ($_arr)) { $_arr = array ($value); $key = 0; } + else { $_arr[] = $value; end ($_arr); $key = key ($_arr); } + } + + $reverse_path = array_reverse($this->path); + $reverse_history = array_reverse ($history); + $reverse_history[0] = $_arr; + $cnt = count($reverse_history) - 1; + for ($i = 0; $i < $cnt; $i++) { + $reverse_history[$i+1][$reverse_path[$i]] = $reverse_history[$i]; + } + $this->result = $reverse_history[$cnt]; + + $this->path[$incoming_indent] = $key; + + if ($this->_containsGroupAnchor) { + $this->SavedGroups[$this->_containsGroupAnchor] = $this->path; + if (is_array ($value)) { + $k = key ($value); + if (!is_int ($k)) { + $this->SavedGroups[$this->_containsGroupAnchor][$incoming_indent + 2] = $k; + } + } + $this->_containsGroupAnchor = false; + } + + } + + private static function startsLiteralBlock ($line) { + $lastChar = substr (trim($line), -1); + if ($lastChar != '>' && $lastChar != '|') return false; + if ($lastChar == '|') return $lastChar; + // HTML tags should not be counted as literal blocks. + if (preg_match ('#<.*?>$#', $line)) return false; + return $lastChar; + } + + private static function greedilyNeedNextLine($line) { + $line = trim ($line); + if (!strlen($line)) return false; + if (substr ($line, -1, 1) == ']') return false; + if ($line[0] == '[') return true; + if (preg_match ('#^[^:]+?:\s*\[#', $line)) return true; + return false; + } + + private function addLiteralLine ($literalBlock, $line, $literalBlockStyle, $indent = -1) { + $line = self::stripIndent($line, $indent); + if ($literalBlockStyle !== '|') { + $line = self::stripIndent($line); + } + $line = rtrim ($line, "\r\n\t ") . "\n"; + if ($literalBlockStyle == '|') { + return $literalBlock . $line; + } + if (strlen($line) == 0) + return rtrim($literalBlock, ' ') . "\n"; + if ($line == "\n" && $literalBlockStyle == '>') { + return rtrim ($literalBlock, " \t") . "\n"; + } + if ($line != "\n") + $line = trim ($line, "\r\n ") . " "; + return $literalBlock . $line; + } + + function revertLiteralPlaceHolder ($lineArray, $literalBlock) { + foreach ($lineArray as $k => $_) { + if (is_array($_)) + $lineArray[$k] = $this->revertLiteralPlaceHolder ($_, $literalBlock); + else if (substr($_, -1 * strlen ($this->LiteralPlaceHolder)) == $this->LiteralPlaceHolder) + $lineArray[$k] = rtrim ($literalBlock, " \r\n"); + } + return $lineArray; + } + + private static function stripIndent ($line, $indent = -1) { + if ($indent == -1) $indent = strlen($line) - strlen(ltrim($line)); + return substr ($line, $indent); + } + + private function getParentPathByIndent ($indent) { + if ($indent == 0) return array(); + $linePath = $this->path; + do { + end($linePath); $lastIndentInParentPath = key($linePath); + if ($indent <= $lastIndentInParentPath) array_pop ($linePath); + } while ($indent <= $lastIndentInParentPath); + return $linePath; + } + + + private function clearBiggerPathValues ($indent) { + + + if ($indent == 0) $this->path = array(); + if (empty ($this->path)) return true; + + foreach ($this->path as $k => $_) { + if ($k > $indent) unset ($this->path[$k]); + } + + return true; + } + + + private static function isComment ($line) { + if (!$line) return false; + if ($line[0] == '#') return true; + if (trim($line, " \r\n\t") == '---') return true; + return false; + } + + private static function isEmpty ($line) { + return (trim ($line) === ''); + } + + + private function isArrayElement ($line) { + if (!$line) return false; + if ($line[0] != '-') return false; + if (strlen ($line) > 3) + if (substr($line,0,3) == '---') return false; + + return true; + } + + private function isHashElement ($line) { + return strpos($line, ':'); + } + + private function isLiteral ($line) { + if ($this->isArrayElement($line)) return false; + if ($this->isHashElement($line)) return false; + return true; + } + + + private static function unquote ($value) { + if (!$value) return $value; + if (!is_string($value)) return $value; + if ($value[0] == '\'') return trim ($value, '\''); + if ($value[0] == '"') return trim ($value, '"'); + return $value; + } + + private function startsMappedSequence ($line) { + return ($line[0] == '-' && substr ($line, -1, 1) == ':'); + } + + private function returnMappedSequence ($line) { + $array = array(); + $key = self::unquote(trim(substr($line,1,-1))); + $array[$key] = array(); + $this->delayedPath = array(strpos ($line, $key) + $this->indent => $key); + return array($array); + } + + private function returnMappedValue ($line) { + $array = array(); + $key = self::unquote (trim(substr($line,0,-1))); + $array[$key] = ''; + return $array; + } + + private function startsMappedValue ($line) { + return (substr ($line, -1, 1) == ':'); + } + + private function isPlainArray ($line) { + return ($line[0] == '[' && substr ($line, -1, 1) == ']'); + } + + private function returnPlainArray ($line) { + return $this->_toType($line); + } + + private function returnKeyValuePair ($line) { + $array = array(); + $key = ''; + if (strpos ($line, ':')) { + // It's a key/value pair most likely + // If the key is in double quotes pull it out + if (($line[0] == '"' || $line[0] == "'") && preg_match('/^(["\'](.*)["\'](\s)*:)/',$line,$matches)) { + $value = trim(str_replace($matches[1],'',$line)); + $key = $matches[2]; + } else { + // Do some guesswork as to the key and the value + $explode = explode(':',$line); + $key = trim($explode[0]); + array_shift($explode); + $value = trim(implode(':',$explode)); + } + // Set the type of the value. Int, string, etc + $value = $this->_toType($value); + if ($key === '0') $key = '__!YAMLZero'; + $array[$key] = $value; + } else { + $array = array ($line); + } + return $array; + + } + + + private function returnArrayElement ($line) { + if (strlen($line) <= 1) return array(array()); // Weird %) + $array = array(); + $value = trim(substr($line,1)); + $value = $this->_toType($value); + $array[] = $value; + return $array; + } + + + private function nodeContainsGroup ($line) { + $symbolsForReference = 'A-z0-9_\-'; + if (strpos($line, '&') === false && strpos($line, '*') === false) return false; // Please die fast ;-) + if ($line[0] == '&' && preg_match('/^(&['.$symbolsForReference.']+)/', $line, $matches)) return $matches[1]; + if ($line[0] == '*' && preg_match('/^(\*['.$symbolsForReference.']+)/', $line, $matches)) return $matches[1]; + if (preg_match('/(&['.$symbolsForReference.']+)$/', $line, $matches)) return $matches[1]; + if (preg_match('/(\*['.$symbolsForReference.']+$)/', $line, $matches)) return $matches[1]; + if (preg_match ('#^\s*<<\s*:\s*(\*[^\s]+).*$#', $line, $matches)) return $matches[1]; + return false; + + } + + private function addGroup ($line, $group) { + if ($group[0] == '&') $this->_containsGroupAnchor = substr ($group, 1); + if ($group[0] == '*') $this->_containsGroupAlias = substr ($group, 1); + //print_r ($this->path); + } + + private function stripGroup ($line, $group) { + $line = trim(str_replace($group, '', $line)); + return $line; + } +} + +// Enable use of Spyc from command line +// The syntax is the following: php spyc.php spyc.yaml + +define ('SPYC_FROM_COMMAND_LINE', false); + +do { + if (!SPYC_FROM_COMMAND_LINE) break; + if (empty ($_SERVER['argc']) || $_SERVER['argc'] < 2) break; + if (empty ($_SERVER['PHP_SELF']) || $_SERVER['PHP_SELF'] != 'spyc.php') break; + $file = $argv[1]; + printf ("Spyc loading file: %s\n", $file); + print_r (spyc_load_file ($file)); +} while (0); \ No newline at end of file diff --git a/plugins/DevicesDetection/functions.php b/plugins/DevicesDetection/functions.php new file mode 100644 index 0000000000..55a538d1d6 --- /dev/null +++ b/plugins/DevicesDetection/functions.php @@ -0,0 +1,152 @@ + $family) { + if (in_array($label, $family)) { + return $name; + } + } + return "Unknown"; +} + +function Piwik_getBrowserFamilyLogoExtended($label) +{ + if (array_key_exists($label, UserAgentParserEnhanced::$browserFamilies)) { + $path = 'plugins/UserSettings/images/browsers/' . UserAgentParserEnhanced::$browserFamilies[$label][0] . '.gif'; + } else { + $path = 'plugins/UserSettings/images/browsers/UNK.gif'; + } + return $path; +} + +function Piwik_getBrowserNameExtended($label) +{ + $short = substr($label, 0, 2); + $ver = substr($label, 3, 10); + if (array_key_exists($short, UserAgentParserEnhanced::$browsers)) { + return trim(ucfirst(UserAgentParserEnhanced::$browsers[$short]) . ' ' . $ver); + } else { + return "Unknown"; + } +} + +function Piwik_getBrowserLogoExtended($label) +{ + $short = substr($label, 0, 2); + + $familyName = Piwik_getBrowserFamilyFullNameExtended($short); + $path = Piwik_getBrowserFamilyLogoExtended($familyName); + + return $path; +} + +function Piwik_getDeviceBrandLabel($label) +{ + if (array_key_exists($label, UserAgentParserEnhanced::$deviceBrands)) { + return ucfirst(UserAgentParserEnhanced::$deviceBrands[$label]); + } else { + return "Unknown"; + } +} + +function Piwik_getDeviceTypeLabel($label) +{ + if (isset(UserAgentParserEnhanced::$deviceTypes[$label])) { + return ucfirst(UserAgentParserEnhanced::$deviceTypes[$label]); + } else { + return "Unknown"; + } +} + +function Piwik_getDeviceTypeLogo($label) +{ + $deviceTypeLogos = Array( + "Desktop" => "normal.gif", + "Smartphone" => "smartphone.png", + "Tablet" => "tablet.png", + "Tv" => "tv.png", + "Feature phone" => "mobile.gif", + "Console" => "console.gif"); + + if (!array_key_exists($label, $deviceTypeLogos) || $label == "Unknown") { + $label = 'unknown.gif'; + } else { + $label = $deviceTypeLogos[$label]; + } + $path = 'plugins/DevicesDetection/images/screens/' . $label; + return $path; +} + +function Piwik_getModelName($label) +{ + if (!$label) + return "Unknown"; + else + return $label; +} + +function Piwik_getOSFamilyFullNameExtended($label) +{ + foreach (UserAgentParserEnhanced::$osFamilies as $name => $family) { + if (in_array($label, $family)) { + return $name; + } + } + return "Unknown"; +} + +function Piwik_getOsFamilyLogoExtended($label) +{ + if (array_key_exists($label, UserAgentParserEnhanced::$osFamilies)) { + $path = 'plugins/UserSettings/images/os/' . UserAgentParserEnhanced::$osFamilies[$label][0] . ".gif"; + } else { + $path = 'plugins/UserSettings/images/os/UNK.gif'; + } + return $path; +} + +function Piwik_getOsFullNameExtended($label) +{ + if ($label != "" && $label != ";") { + $os = substr($label, 0, 3); + $ver = substr($label, 4, 15); + $osFullName = array_search($os, UserAgentParserEnhanced::$osShorts); + if ($osFullName) { + if (in_array($os, UserAgentParserEnhanced::$osFamilies['Windows'])) { + return $osFullName; + } else { + return trim($osFullName . " " . $ver); + } + } + } else { + return "Unknown"; + } +} + +function Piwik_getOsLogoExtended($label) +{ + $short = substr($label, 0, 3); + $familyName = Piwik_getOsFamilyFullNameExtended($short); + $path = Piwik_getOsFamilyLogoExtended($familyName); + return $path; +} \ No newline at end of file diff --git a/plugins/DevicesDetection/images/brand/Acer.ico b/plugins/DevicesDetection/images/brand/Acer.ico new file mode 100644 index 0000000000..6c5b9f6a9e Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Acer.ico differ diff --git a/plugins/DevicesDetection/images/brand/Alcatel.ico b/plugins/DevicesDetection/images/brand/Alcatel.ico new file mode 100644 index 0000000000..9d8de98eab Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Alcatel.ico differ diff --git a/plugins/DevicesDetection/images/brand/Apple.ico b/plugins/DevicesDetection/images/brand/Apple.ico new file mode 100644 index 0000000000..8f562cc422 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Apple.ico differ diff --git a/plugins/DevicesDetection/images/brand/Asus.ico b/plugins/DevicesDetection/images/brand/Asus.ico new file mode 100644 index 0000000000..6ca527164a Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Asus.ico differ diff --git a/plugins/DevicesDetection/images/brand/Audiovox.ico b/plugins/DevicesDetection/images/brand/Audiovox.ico new file mode 100644 index 0000000000..1745af087e Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Audiovox.ico differ diff --git a/plugins/DevicesDetection/images/brand/Avvio.ico b/plugins/DevicesDetection/images/brand/Avvio.ico new file mode 100644 index 0000000000..e96d6e7d9c Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Avvio.ico differ diff --git a/plugins/DevicesDetection/images/brand/Becker.ico b/plugins/DevicesDetection/images/brand/Becker.ico new file mode 100644 index 0000000000..414fab5a71 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Becker.ico differ diff --git a/plugins/DevicesDetection/images/brand/Beetel.ico b/plugins/DevicesDetection/images/brand/Beetel.ico new file mode 100644 index 0000000000..c9bef20575 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Beetel.ico differ diff --git a/plugins/DevicesDetection/images/brand/BenQ.ico b/plugins/DevicesDetection/images/brand/BenQ.ico new file mode 100644 index 0000000000..dcfdd0908d Binary files /dev/null and b/plugins/DevicesDetection/images/brand/BenQ.ico differ diff --git a/plugins/DevicesDetection/images/brand/Compal.ico b/plugins/DevicesDetection/images/brand/Compal.ico new file mode 100644 index 0000000000..20c1340e86 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Compal.ico differ diff --git a/plugins/DevicesDetection/images/brand/Cricket.ico b/plugins/DevicesDetection/images/brand/Cricket.ico new file mode 100644 index 0000000000..cdaeffaa01 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Cricket.ico differ diff --git a/plugins/DevicesDetection/images/brand/Dell.ico b/plugins/DevicesDetection/images/brand/Dell.ico new file mode 100644 index 0000000000..1d7e4ac457 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Dell.ico differ diff --git a/plugins/DevicesDetection/images/brand/DoCoMo.ico b/plugins/DevicesDetection/images/brand/DoCoMo.ico new file mode 100644 index 0000000000..7874325557 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/DoCoMo.ico differ diff --git a/plugins/DevicesDetection/images/brand/Ericsson.ico b/plugins/DevicesDetection/images/brand/Ericsson.ico new file mode 100644 index 0000000000..2b91cfd581 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Ericsson.ico differ diff --git a/plugins/DevicesDetection/images/brand/Google.ico b/plugins/DevicesDetection/images/brand/Google.ico new file mode 100644 index 0000000000..cae29b26fd Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Google.ico differ diff --git a/plugins/DevicesDetection/images/brand/Gradiente.ico b/plugins/DevicesDetection/images/brand/Gradiente.ico new file mode 100644 index 0000000000..de530228b9 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Gradiente.ico differ diff --git a/plugins/DevicesDetection/images/brand/Grundig.ico b/plugins/DevicesDetection/images/brand/Grundig.ico new file mode 100644 index 0000000000..3dd1731e0a Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Grundig.ico differ diff --git a/plugins/DevicesDetection/images/brand/HP.ico b/plugins/DevicesDetection/images/brand/HP.ico new file mode 100644 index 0000000000..6870d2a134 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/HP.ico differ diff --git a/plugins/DevicesDetection/images/brand/HTC.ico b/plugins/DevicesDetection/images/brand/HTC.ico new file mode 100644 index 0000000000..a4b722423f Binary files /dev/null and b/plugins/DevicesDetection/images/brand/HTC.ico differ diff --git a/plugins/DevicesDetection/images/brand/Haier.ico b/plugins/DevicesDetection/images/brand/Haier.ico new file mode 100644 index 0000000000..761eba5924 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Haier.ico differ diff --git a/plugins/DevicesDetection/images/brand/Huawei.ico b/plugins/DevicesDetection/images/brand/Huawei.ico new file mode 100644 index 0000000000..d2d72cc39c Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Huawei.ico differ diff --git a/plugins/DevicesDetection/images/brand/INQ.ico b/plugins/DevicesDetection/images/brand/INQ.ico new file mode 100644 index 0000000000..8317daeac5 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/INQ.ico differ diff --git a/plugins/DevicesDetection/images/brand/KDDI.ico b/plugins/DevicesDetection/images/brand/KDDI.ico new file mode 100644 index 0000000000..8ba0c412b4 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/KDDI.ico differ diff --git a/plugins/DevicesDetection/images/brand/Karbonn.ico b/plugins/DevicesDetection/images/brand/Karbonn.ico new file mode 100644 index 0000000000..370ac7081c Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Karbonn.ico differ diff --git a/plugins/DevicesDetection/images/brand/Kindle.ico b/plugins/DevicesDetection/images/brand/Kindle.ico new file mode 100644 index 0000000000..f1c96b70a4 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Kindle.ico differ diff --git a/plugins/DevicesDetection/images/brand/Kyocera.ico b/plugins/DevicesDetection/images/brand/Kyocera.ico new file mode 100644 index 0000000000..5415b00407 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Kyocera.ico differ diff --git a/plugins/DevicesDetection/images/brand/LG.ico b/plugins/DevicesDetection/images/brand/LG.ico new file mode 100644 index 0000000000..ca03ac84c8 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/LG.ico differ diff --git a/plugins/DevicesDetection/images/brand/LGUPlus.ico b/plugins/DevicesDetection/images/brand/LGUPlus.ico new file mode 100644 index 0000000000..cf8b998ce9 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/LGUPlus.ico differ diff --git a/plugins/DevicesDetection/images/brand/Lanix.ico b/plugins/DevicesDetection/images/brand/Lanix.ico new file mode 100644 index 0000000000..9736d9ef90 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Lanix.ico differ diff --git a/plugins/DevicesDetection/images/brand/Lenovo.ico b/plugins/DevicesDetection/images/brand/Lenovo.ico new file mode 100644 index 0000000000..beb7c247f9 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Lenovo.ico differ diff --git a/plugins/DevicesDetection/images/brand/MicroMax.ico b/plugins/DevicesDetection/images/brand/MicroMax.ico new file mode 100644 index 0000000000..d31758326d Binary files /dev/null and b/plugins/DevicesDetection/images/brand/MicroMax.ico differ diff --git a/plugins/DevicesDetection/images/brand/Microsoft.ico b/plugins/DevicesDetection/images/brand/Microsoft.ico new file mode 100644 index 0000000000..94d1a2b3ab Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Microsoft.ico differ diff --git a/plugins/DevicesDetection/images/brand/Mio.ico b/plugins/DevicesDetection/images/brand/Mio.ico new file mode 100644 index 0000000000..16f8ef2e59 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Mio.ico differ diff --git a/plugins/DevicesDetection/images/brand/Mitsubishi.ico b/plugins/DevicesDetection/images/brand/Mitsubishi.ico new file mode 100644 index 0000000000..abd920e561 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Mitsubishi.ico differ diff --git a/plugins/DevicesDetection/images/brand/Motorola.ico b/plugins/DevicesDetection/images/brand/Motorola.ico new file mode 100644 index 0000000000..f388f50c9a Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Motorola.ico differ diff --git a/plugins/DevicesDetection/images/brand/MyPhone.ico b/plugins/DevicesDetection/images/brand/MyPhone.ico new file mode 100644 index 0000000000..4fccc0c0c2 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/MyPhone.ico differ diff --git a/plugins/DevicesDetection/images/brand/NGM.ico b/plugins/DevicesDetection/images/brand/NGM.ico new file mode 100644 index 0000000000..5a0fcfc1ba Binary files /dev/null and b/plugins/DevicesDetection/images/brand/NGM.ico differ diff --git a/plugins/DevicesDetection/images/brand/Nintendo.ico b/plugins/DevicesDetection/images/brand/Nintendo.ico new file mode 100644 index 0000000000..4c949d50c5 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Nintendo.ico differ diff --git a/plugins/DevicesDetection/images/brand/Nokia.ico b/plugins/DevicesDetection/images/brand/Nokia.ico new file mode 100644 index 0000000000..fe54973014 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Nokia.ico differ diff --git a/plugins/DevicesDetection/images/brand/O2.ico b/plugins/DevicesDetection/images/brand/O2.ico new file mode 100644 index 0000000000..15ef4a7a24 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/O2.ico differ diff --git a/plugins/DevicesDetection/images/brand/OPPO.ico b/plugins/DevicesDetection/images/brand/OPPO.ico new file mode 100644 index 0000000000..10af023560 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/OPPO.ico differ diff --git a/plugins/DevicesDetection/images/brand/Onda.ico b/plugins/DevicesDetection/images/brand/Onda.ico new file mode 100644 index 0000000000..3bc55223ee Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Onda.ico differ diff --git a/plugins/DevicesDetection/images/brand/Orange.ico b/plugins/DevicesDetection/images/brand/Orange.ico new file mode 100644 index 0000000000..55437dda38 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Orange.ico differ diff --git a/plugins/DevicesDetection/images/brand/Palm.ico b/plugins/DevicesDetection/images/brand/Palm.ico new file mode 100644 index 0000000000..901c44fa3f Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Palm.ico differ diff --git a/plugins/DevicesDetection/images/brand/Panasonic.ico b/plugins/DevicesDetection/images/brand/Panasonic.ico new file mode 100644 index 0000000000..00a3e9cb24 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Panasonic.ico differ diff --git a/plugins/DevicesDetection/images/brand/Pantech.ico b/plugins/DevicesDetection/images/brand/Pantech.ico new file mode 100644 index 0000000000..6fc39d30cb Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Pantech.ico differ diff --git a/plugins/DevicesDetection/images/brand/Philips.ico b/plugins/DevicesDetection/images/brand/Philips.ico new file mode 100644 index 0000000000..8eb97f5ecd Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Philips.ico differ diff --git a/plugins/DevicesDetection/images/brand/RIM.ico b/plugins/DevicesDetection/images/brand/RIM.ico new file mode 100644 index 0000000000..c7d1bdacc2 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/RIM.ico differ diff --git a/plugins/DevicesDetection/images/brand/Samsung.ico b/plugins/DevicesDetection/images/brand/Samsung.ico new file mode 100644 index 0000000000..b7a852d6aa Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Samsung.ico differ diff --git a/plugins/DevicesDetection/images/brand/Sanyo.ico b/plugins/DevicesDetection/images/brand/Sanyo.ico new file mode 100644 index 0000000000..5415b00407 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Sanyo.ico differ diff --git a/plugins/DevicesDetection/images/brand/Sega.ico b/plugins/DevicesDetection/images/brand/Sega.ico new file mode 100644 index 0000000000..aa5ba9bdfd Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Sega.ico differ diff --git a/plugins/DevicesDetection/images/brand/Softbank.ico b/plugins/DevicesDetection/images/brand/Softbank.ico new file mode 100644 index 0000000000..da354bfb46 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Softbank.ico differ diff --git a/plugins/DevicesDetection/images/brand/Sony Ericsson.ico b/plugins/DevicesDetection/images/brand/Sony Ericsson.ico new file mode 100644 index 0000000000..776a08d5af Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Sony Ericsson.ico differ diff --git a/plugins/DevicesDetection/images/brand/Sony.ico b/plugins/DevicesDetection/images/brand/Sony.ico new file mode 100644 index 0000000000..776a08d5af Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Sony.ico differ diff --git a/plugins/DevicesDetection/images/brand/T-Mobile.ico b/plugins/DevicesDetection/images/brand/T-Mobile.ico new file mode 100644 index 0000000000..0496780292 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/T-Mobile.ico differ diff --git a/plugins/DevicesDetection/images/brand/Telit.ico b/plugins/DevicesDetection/images/brand/Telit.ico new file mode 100644 index 0000000000..bca28a1684 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Telit.ico differ diff --git a/plugins/DevicesDetection/images/brand/TiPhone.ico b/plugins/DevicesDetection/images/brand/TiPhone.ico new file mode 100644 index 0000000000..87a7ccd4da Binary files /dev/null and b/plugins/DevicesDetection/images/brand/TiPhone.ico differ diff --git a/plugins/DevicesDetection/images/brand/Vertu.ico b/plugins/DevicesDetection/images/brand/Vertu.ico new file mode 100644 index 0000000000..48ff28926b Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Vertu.ico differ diff --git a/plugins/DevicesDetection/images/brand/Videocon.ico b/plugins/DevicesDetection/images/brand/Videocon.ico new file mode 100644 index 0000000000..dc1bda5cc6 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Videocon.ico differ diff --git a/plugins/DevicesDetection/images/brand/Zonda.ico b/plugins/DevicesDetection/images/brand/Zonda.ico new file mode 100644 index 0000000000..eede4f8baa Binary files /dev/null and b/plugins/DevicesDetection/images/brand/Zonda.ico differ diff --git a/plugins/DevicesDetection/images/brand/eTouch.ico b/plugins/DevicesDetection/images/brand/eTouch.ico new file mode 100644 index 0000000000..d4487284b2 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/eTouch.ico differ diff --git a/plugins/DevicesDetection/images/brand/i-mobile.ico b/plugins/DevicesDetection/images/brand/i-mobile.ico new file mode 100644 index 0000000000..c5a9b064c2 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/i-mobile.ico differ diff --git a/plugins/DevicesDetection/images/brand/unknown.ico b/plugins/DevicesDetection/images/brand/unknown.ico new file mode 100644 index 0000000000..62a489e293 Binary files /dev/null and b/plugins/DevicesDetection/images/brand/unknown.ico differ diff --git a/plugins/DevicesDetection/images/screens/computer.png b/plugins/DevicesDetection/images/screens/computer.png new file mode 100644 index 0000000000..9763689e6f Binary files /dev/null and b/plugins/DevicesDetection/images/screens/computer.png differ diff --git a/plugins/DevicesDetection/images/screens/console.gif b/plugins/DevicesDetection/images/screens/console.gif new file mode 100644 index 0000000000..7957a9106a Binary files /dev/null and b/plugins/DevicesDetection/images/screens/console.gif differ diff --git a/plugins/DevicesDetection/images/screens/dual.gif b/plugins/DevicesDetection/images/screens/dual.gif new file mode 100644 index 0000000000..a8cb8b2963 Binary files /dev/null and b/plugins/DevicesDetection/images/screens/dual.gif differ diff --git a/plugins/DevicesDetection/images/screens/mobile.gif b/plugins/DevicesDetection/images/screens/mobile.gif new file mode 100644 index 0000000000..814642933f Binary files /dev/null and b/plugins/DevicesDetection/images/screens/mobile.gif differ diff --git a/plugins/DevicesDetection/images/screens/normal.gif b/plugins/DevicesDetection/images/screens/normal.gif new file mode 100644 index 0000000000..afe97e9d9f Binary files /dev/null and b/plugins/DevicesDetection/images/screens/normal.gif differ diff --git a/plugins/DevicesDetection/images/screens/smartphone.png b/plugins/DevicesDetection/images/screens/smartphone.png new file mode 100644 index 0000000000..c5bfb31ca4 Binary files /dev/null and b/plugins/DevicesDetection/images/screens/smartphone.png differ diff --git a/plugins/DevicesDetection/images/screens/tablet.png b/plugins/DevicesDetection/images/screens/tablet.png new file mode 100644 index 0000000000..e6ac30bdd8 Binary files /dev/null and b/plugins/DevicesDetection/images/screens/tablet.png differ diff --git a/plugins/DevicesDetection/images/screens/tv.png b/plugins/DevicesDetection/images/screens/tv.png new file mode 100644 index 0000000000..fb6db07cf4 Binary files /dev/null and b/plugins/DevicesDetection/images/screens/tv.png differ diff --git a/plugins/DevicesDetection/images/screens/unknown.gif b/plugins/DevicesDetection/images/screens/unknown.gif new file mode 100644 index 0000000000..2c44083422 Binary files /dev/null and b/plugins/DevicesDetection/images/screens/unknown.gif differ diff --git a/plugins/DevicesDetection/images/screens/wide.gif b/plugins/DevicesDetection/images/screens/wide.gif new file mode 100644 index 0000000000..1b09fc529b Binary files /dev/null and b/plugins/DevicesDetection/images/screens/wide.gif differ diff --git a/plugins/DevicesDetection/lang/en.php b/plugins/DevicesDetection/lang/en.php new file mode 100644 index 0000000000..3df87d9fd5 --- /dev/null +++ b/plugins/DevicesDetection/lang/en.php @@ -0,0 +1,29 @@ + "Plugin providing extended information about mobile devices visiting page. Also new, more specific reports are available.", + "DevicesDetection_submenu" => "Devices", + 'DevicesDetection_DevicesDetection' => "Visitor devices", + // DataTable label translations for reports + "DevicesDetection_dataTableLabelBrands" => "Brand", + "DevicesDetection_dataTableLabelTypes" => "Type", + "DevicesDetection_dataTableLabelModels" => "Model", + "DevicesDetection_dataTableLabelSystemFamily" => "Operating System family", + "DevicesDetection_dataTableLabelSystemVersion" => "Operating System version", + "DevicesDetection_dataTableLabelBrowserFamily" => "Browser family", + "DevicesDetection_dataTableLabelBrowserVersion" => "Browser version", + // Title translations for reports + "DevicesDetection_DeviceType" => "Device types report", + "DevicesDetection_DeviceBrand" => "Device manufacturers report", + "DevicesDetection_DeviceModel" => "Device model report", + 'DeviceDetection_OperatingSystemVersions' => "Operating System versions", + 'DeviceDetection_OperatingSystemFamilies' => "Operating System families", + 'DevicesDetection_BrowsersFamily' => 'Browsers families', + 'DevicesDetection_BrowserVersions' => 'Browser versions', + // Evolution graph title translations + "DevicesDetection_DeviceType" => "Device type", + 'DevicesDetection_DeviceBrand' => 'Device brand', + 'DevicesDetection_DeviceModel' => 'Device model', +// 'DevicesDetection_OS' => 'Device operating system', +// 'DevicesDetection_Browser' => 'Device browser', +); diff --git a/plugins/DevicesDetection/templates/index.tpl b/plugins/DevicesDetection/templates/index.tpl new file mode 100644 index 0000000000..74e6c0b116 --- /dev/null +++ b/plugins/DevicesDetection/templates/index.tpl @@ -0,0 +1,15 @@ +
    +

    {"DevicesDetection_DeviceType"|Piwik_Translate}

    + {$deviceTypes} +

    {"DevicesDetection_DeviceBrand"|Piwik_Translate}

    + {$deviceBrands} +

    {"DevicesDetection_DeviceModel"|Piwik_Translate}

    + {$deviceModels} +
    + +
    +

    {"DeviceDetection_OperatingSystemFamilies"|Piwik_Translate}

    + {$osReport} +

    {"DevicesDetection_BrowsersFamily"|Piwik_Translate}

    + {$browserReport} +
    diff --git a/plugins/ImageGraph/StaticGraph/HorizontalBar.php b/plugins/ImageGraph/StaticGraph/HorizontalBar.php index 8e6d69147d..fe4cf5b3b4 100644 --- a/plugins/ImageGraph/StaticGraph/HorizontalBar.php +++ b/plugins/ImageGraph/StaticGraph/HorizontalBar.php @@ -173,11 +173,13 @@ class Piwik_ImageGraph_StaticGraph_HorizontalBar extends Piwik_ImageGraph_Static - $logoHeight / 2 + 1; - $this->pImage->$drawingFunction( - $gridLeftMarginBeforePadding, - $logoYPosition, - $logoPath - ); + if(method_exists($this->pImage, $drawingFunction)) { + $this->pImage->$drawingFunction( + $gridLeftMarginBeforePadding, + $logoYPosition, + $logoPath + ); + } } } } -- cgit v1.2.3 From 4f4d377876adcf698c00ca2141f9cff26bf75a83 Mon Sep 17 00:00:00 2001 From: mattab Date: Fri, 24 May 2013 21:11:15 +1200 Subject: Refs #3612 * making some tests pass == fixing bugs --- plugins/DevicesDetection/DevicesDetection.php | 4 +++- .../UserAgentParserEnhanced.php | 15 ++++++++------ plugins/DevicesDetection/functions.php | 23 +++++++++++----------- 3 files changed, 23 insertions(+), 19 deletions(-) (limited to 'plugins') diff --git a/plugins/DevicesDetection/DevicesDetection.php b/plugins/DevicesDetection/DevicesDetection.php index 7403f29329..e9cb732e8c 100644 --- a/plugins/DevicesDetection/DevicesDetection.php +++ b/plugins/DevicesDetection/DevicesDetection.php @@ -169,7 +169,9 @@ class Piwik_DevicesDetection extends Piwik_Plugin Piwik_Exec($q2); } } catch (Exception $e) { - throw $e; + if (!Zend_Registry::get('db')->isErrNo($e, '1060')) { + throw $e; + } } } diff --git a/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php b/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php index c0a2825811..9031b0fd33 100644 --- a/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php +++ b/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php @@ -228,7 +228,7 @@ class UserAgentParserEnhanced public static $browserFamilies = array( 'Android Browser' => array('AN'), 'BlackBerry Browser' => array('BB'), - 'Chrome' => array('CH', 'CM', 'CI', 'CF', 'CR'), + 'Chrome' => array('CH', 'CM', 'CI', 'CF', 'CR', 'RM'), 'Firefox' => array('FF', 'FE', 'SX', 'FB', 'PX', 'MB'), 'Internet Explorer' => array('IE', 'IM'), 'Konqueror' => array('KO'), @@ -314,6 +314,8 @@ class UserAgentParserEnhanced 'WO' => 'wOSBrowser', 'YA' => 'Yandex Browser' ); + + const UNKNOWN = "UNK"; protected static $regexesDir = '/regexes/'; protected static $osRegexesFile = 'oss.yml'; protected static $browserRegexesFile = 'browsers.yml'; @@ -406,7 +408,7 @@ class UserAgentParserEnhanced if (in_array($browserRegex['name'], self::$browsers)) { $short = array_search($browserRegex['name'], self::$browsers); } else { - $short = 'UN'; + $short = 'XX'; } $this->browser = array( @@ -630,8 +632,9 @@ class UserAgentParserEnhanced public function isDesktop() { $osName = $this->getOs('name'); - if (empty($osName)) + if (empty($osName) || empty(self::$osShorts[$osName])) { return false; + } $osShort = self::$osShorts[$osName]; foreach (self::$osFamilies as $family => $familyOs) { @@ -650,7 +653,7 @@ class UserAgentParserEnhanced } if (!isset($this->os[$attr])) { - return ''; + return self::UNKNOWN; } if ($attr == 'version') { @@ -666,7 +669,7 @@ class UserAgentParserEnhanced } if (!isset($this->browser[$attr])) { - return ''; + return self::UNKNOWN; } return $this->browser[$attr]; @@ -701,7 +704,7 @@ class UserAgentParserEnhanced return $osFamily; } } - error_log($osLabel); + return 'Other'; } diff --git a/plugins/DevicesDetection/functions.php b/plugins/DevicesDetection/functions.php index 55a538d1d6..34f8ed8690 100644 --- a/plugins/DevicesDetection/functions.php +++ b/plugins/DevicesDetection/functions.php @@ -26,7 +26,7 @@ function Piwik_getBrowserFamilyFullNameExtended($label) return $name; } } - return "Unknown"; + return Piwik_Translate('General_Unknown'); } function Piwik_getBrowserFamilyLogoExtended($label) @@ -46,7 +46,7 @@ function Piwik_getBrowserNameExtended($label) if (array_key_exists($short, UserAgentParserEnhanced::$browsers)) { return trim(ucfirst(UserAgentParserEnhanced::$browsers[$short]) . ' ' . $ver); } else { - return "Unknown"; + return Piwik_Translate('General_Unknown'); } } @@ -65,7 +65,7 @@ function Piwik_getDeviceBrandLabel($label) if (array_key_exists($label, UserAgentParserEnhanced::$deviceBrands)) { return ucfirst(UserAgentParserEnhanced::$deviceBrands[$label]); } else { - return "Unknown"; + return Piwik_Translate('General_Unknown'); } } @@ -74,7 +74,7 @@ function Piwik_getDeviceTypeLabel($label) if (isset(UserAgentParserEnhanced::$deviceTypes[$label])) { return ucfirst(UserAgentParserEnhanced::$deviceTypes[$label]); } else { - return "Unknown"; + return Piwik_Translate('General_Unknown'); } } @@ -99,10 +99,10 @@ function Piwik_getDeviceTypeLogo($label) function Piwik_getModelName($label) { - if (!$label) - return "Unknown"; - else - return $label; + if (!$label) { + return Piwik_Translate('General_Unknown'); + } + return $label; } function Piwik_getOSFamilyFullNameExtended($label) @@ -112,7 +112,7 @@ function Piwik_getOSFamilyFullNameExtended($label) return $name; } } - return "Unknown"; + return Piwik_Translate('General_Unknown'); } function Piwik_getOsFamilyLogoExtended($label) @@ -127,7 +127,7 @@ function Piwik_getOsFamilyLogoExtended($label) function Piwik_getOsFullNameExtended($label) { - if ($label != "" && $label != ";") { + if (!empty($label) && $label != ";") { $os = substr($label, 0, 3); $ver = substr($label, 4, 15); $osFullName = array_search($os, UserAgentParserEnhanced::$osShorts); @@ -138,9 +138,8 @@ function Piwik_getOsFullNameExtended($label) return trim($osFullName . " " . $ver); } } - } else { - return "Unknown"; } + return Piwik_Translate('General_Unknown'); } function Piwik_getOsLogoExtended($label) -- cgit v1.2.3 From 58c88c1b2980ee1c02a47cb3d35de1480402e6ac Mon Sep 17 00:00:00 2001 From: mattab Date: Fri, 24 May 2013 23:23:17 +1200 Subject: Refs #3612 * making tests pass! * enabling DevicesDetection tests, even though DevicesDetection plugin is disabled by default. --- plugins/DevicesDetection/DevicesDetection.php | 4 +- .../UserAgentParserEnhanced.php | 1455 +++++++------- .../UserAgentParserEnhanced/regexes/browsers.yml | 814 ++++---- .../UserAgentParserEnhanced/regexes/mobiles.yml | 1914 +++++++++--------- .../UserAgentParserEnhanced/regexes/oss.yml | 852 ++++---- .../UserAgentParserEnhanced/spyc.php | 2090 ++++++++++---------- plugins/DevicesDetection/functions.php | 12 +- plugins/DevicesDetection/lang/en.php | 2 +- 8 files changed, 3577 insertions(+), 3566 deletions(-) (limited to 'plugins') diff --git a/plugins/DevicesDetection/DevicesDetection.php b/plugins/DevicesDetection/DevicesDetection.php index e9cb732e8c..d18f768b21 100644 --- a/plugins/DevicesDetection/DevicesDetection.php +++ b/plugins/DevicesDetection/DevicesDetection.php @@ -21,8 +21,8 @@ class Piwik_DevicesDetection extends Piwik_Plugin public function getInformation() { return array( - 'description' => Piwik_Translate("DevicesDetection_description"), - 'author' => 'Clearcode.cc', + 'description' => "[Beta Plugin] " . Piwik_Translate("DevicesDetection_description"), + 'author' => 'Piwik and Clearcode.cc', 'author_homepage' => 'http://clearcode.cc', 'version' => '1.12-b6', 'TrackerPlugin' => true, diff --git a/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php b/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php index 9031b0fd33..f107455ad9 100644 --- a/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php +++ b/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php @@ -1,722 +1,735 @@ - 'Acer', - 'AI' => 'Airness', - 'AL' => 'Alcatel', - 'AO' => 'Amoi', - 'AP' => 'Apple', - 'AU' => 'Asus', - 'AV' => 'Avvio', - 'AX' => 'Audiovox', - 'BE' => 'Becker', - 'BI' => 'Bird', - 'BL' => 'Beetel', - 'BQ' => 'BenQ', - 'BS' => 'BenQ-Siemens', - 'CK' => 'Cricket', - 'CL' => 'Compal', - 'CT' => 'Capitel', - 'DB' => 'Dbtel', - 'DC' => 'DoCoMo', - 'DI' => 'Dicam', - 'DL' => 'Dell', - 'DP' => 'Dopod', - 'EC' => 'Ericsson', - 'EI' => 'Ezio', - 'ER' => 'Ericy', - 'ET' => 'eTouch', - 'EZ' => 'Ezze', - 'FL' => 'Fly', - 'GI' => 'Gionee', - 'GO' => 'Google', - 'GR' => 'Gradiente', - 'GU' => 'Grundig', - 'HA' => 'Haier', - 'HP' => 'HP', - 'HT' => 'HTC', - 'HU' => 'Huawei', - 'IK' => 'iKoMo', - 'IM' => 'i-mate', - 'IN' => 'Innostream', - 'IO' => 'i-mobile', - 'IQ' => 'INQ', - 'KA' => 'Karbonn', - 'KD' => 'KDDI', - 'KN' => 'Kindle', - 'KO' => 'Konka', - 'KY' => 'Kyocera', - 'LA' => 'Lanix', - 'LC' => 'LCT', - 'LE' => 'Lenovo', - 'LG' => 'LG', - 'LU' => 'LGUPlus', - 'MI' => 'MicroMax', - 'MO' => 'Mio', - 'MR' => 'Motorola', - 'MS' => 'Microsoft', - 'MT' => 'Mitsubishi', - 'MY' => 'MyPhone', - 'NE' => 'NEC', - 'NG' => 'NGM', - 'NI' => 'Nintendo', - 'NK' => 'Nokia', - 'NW' => 'Newgen', - 'NX' => 'Nexian', - 'OD' => 'Onda', - 'OP' => 'OPPO', - 'OR' => 'Orange', - 'OT' => 'O2', - 'PA' => 'Panasonic', - 'PH' => 'Philips', - 'PM' => 'Palm', - 'PO' => 'phoneOne', - 'PT' => 'Pantech', - 'QT' => 'Qtek', - 'RM' => 'RIM', - 'RO' => 'Rover', - 'SA' => 'Samsung', - 'SD' => 'Sega', - 'SE' => 'Sony Ericsson', - 'SF' => 'Softbank', - 'SG' => 'Sagem', - 'SH' => 'Sharp', - 'SI' => 'Siemens', - 'SN' => 'Sendo', - 'SO' => 'Sony', - 'SP' => 'Spice', - 'SY' => 'Sanyo', - 'TA' => 'Tesla', - 'TC' => 'TCL', - 'TE' => 'Telit', - 'TH' => 'TiPhone', - 'TI' => 'TIANYU', - 'TM' => 'T-Mobile', - 'TO' => 'Toplux', - 'TS' => 'Toshiba', - 'UT' => 'UTStarcom', - 'VD' => 'Videocon', - 'VE' => 'Vertu', - 'VI' => 'Vitelcom', - 'VK' => 'VK Mobile', - 'VO' => 'Voxtel', - 'WB' => 'Web TV', - 'WE' => 'WellcoM', - 'WO' => 'Wonu', - 'XX' => 'Unknown', - 'ZO' => 'Zonda', - 'ZT' => 'ZTE', - ); - public static $osShorts = array( - 'AIX' => 'AIX', - 'Android' => 'AND', - 'Apple TV' => 'ATV', - 'Arch Linux' => 'ARL', - 'BackTrack' => 'BTR', - 'Bada' => 'SBA', - 'BlackBerry OS' => 'BLB', - 'BlackBerry Tablet OS' => 'QNX', - 'Bot' => 'BOT', - 'Brew' => 'BMP', - 'CentOS' => 'CES', - 'Chrome OS' => 'COS', - 'Debian' => 'DEB', - 'DragonFly' => 'DFB', - 'Fedora' => 'FED', - 'Firefox OS' => 'FOS', - 'FreeBSD' => 'BSD', - 'Gentoo' => 'GNT', - 'Google TV' => 'GTV', - 'HP-UX' => 'HPX', - 'IRIX' => 'IRI', - 'Knoppix' => 'KNO', - 'Kubuntu' => 'KBT', - 'Linux' => 'LIN', - 'Lubuntu' => 'LBT', - 'Mac' => 'MAC', - 'Mandriva' => 'MDR', - 'MeeGo' => 'SMG', - 'Mint' => 'MIN', - 'NetBSD' => 'NBS', - 'Nintendo' => 'WII', - 'Nintendo Mobile' => 'NDS', - 'OS/2' => 'OS2', - 'OSF1' => 'T64', - 'OpenBSD' => 'OBS', - 'PlayStation' => 'PSP', - 'PlayStation 3' => 'PS3', - 'Presto' => 'PRS', - 'Puppy' => 'PPY', - 'Red Hat' => 'RHT', - 'SUSE' => 'SSE', - 'Slackware' => 'SLW', - 'Solaris' => 'SOS', - 'Syllable' => 'SYL', - 'Symbian' => 'SYM', - 'Symbian OS' => 'SYS', - 'Symbian OS Series 40' => 'S40', - 'Symbian OS Series 60' => 'S60', - 'Symbian^3' => 'SY3', - 'Talkatone' => 'TKT', - 'Tizen' => 'TIZ', - 'Ubuntu' => 'UBT', - 'WebTV' => 'WTV', - 'WinWAP' => 'WWP', - 'Windows' => 'WIN', - 'Windows 2000' => 'W2K', - 'Windows 3.1' => 'W31', - 'Windows 7' => 'WI7', - 'Windows 8' => 'WI8', - 'Windows 95' => 'W95', - 'Windows 98' => 'W98', - 'Windows CE' => 'WCE', - 'Windows ME' => 'WME', - 'Windows Mobile' => 'WMO', - 'Windows NT' => 'WNT', - 'Windows Phone' => 'WPH', - 'Windows RT' => 'WRT', - 'Windows Server 2003' => 'WS3', - 'Windows Vista' => 'WVI', - 'Windows XP' => 'WXP', - 'Xbox' => 'XBX', - 'Xubuntu' => 'XBT', - 'YunOs' => 'YNS', - 'iOS' => 'IOS', - 'palmOS' => 'POS', - 'webOS' => 'WOS' - ); - protected static $desktopOsArray = array('IBM', 'Linux', 'Mac', 'Unix', 'Windows'); - public static $osFamilies = array( - 'Android' => array('AND'), - 'Apple TV' => array('ATV'), - 'BlackBerry' => array('BLB'), - 'Bot' => array('BOT'), - 'Brew' => array('BMP'), - 'Chrome OS' => array('COS'), - 'Firefox OS' => array('FOS'), - 'Gaming Console' => array('WII', 'PS3'), - 'Google TV' => array('GTV'), - 'IBM' => array('OS2'), - 'iOS' => array('IOS'), - 'Linux' => array('LIN', 'ARL', 'DEB', 'KNO', 'MIN', 'UBT', 'KBT', 'XBT', 'LBT', 'FED', 'RHT', 'MDR', 'GNT', 'SLW', 'SSE', 'PPY', 'CES', 'BTR', 'YNS', 'PRS'), - 'Mac' => array('MAC'), - 'Mobile Gaming Console' => array('PSP', 'NDS', 'XBX'), - 'Other Mobile' => array('WOS', 'POS', 'QNX', 'SBA', 'TIZ'), - 'Simulator' => array('TKT', 'WWP'), - 'Symbian' => array('SYM', 'SYS', 'SY3', 'S60', 'S40', 'SMG'), - 'Unix' => array('SOS', 'AIX', 'HPX', 'BSD', 'NBS', 'OBS', 'DFB', 'SYL', 'IRI', 'T64'), - 'WebTV' => array('WTV'), - 'Windows' => array('WI8', 'WI7', 'WVI', 'WS3', 'WXP', 'W2K', 'WNT', 'WME', 'W98', 'W95', 'WRT', 'W31', 'WIN'), - 'Windows Mobile' => array('WPH', 'WMO', 'WCE') - ); - public static $browserFamilies = array( - 'Android Browser' => array('AN'), - 'BlackBerry Browser' => array('BB'), - 'Chrome' => array('CH', 'CM', 'CI', 'CF', 'CR', 'RM'), - 'Firefox' => array('FF', 'FE', 'SX', 'FB', 'PX', 'MB'), - 'Internet Explorer' => array('IE', 'IM'), - 'Konqueror' => array('KO'), - 'NetFront' => array('NF'), - 'Nokia Browser' => array('NB'), - 'Opera' => array('OP', 'OM', 'OI'), - 'Safari' => array('SF', 'MF') - ); - public static $browsers = array( - 'AB' => 'ABrowse', - 'AM' => 'Amaya', - 'AN' => 'Android Browser', - 'AR' => 'Arora', - 'AV' => 'Amiga Voyager', - 'AW' => 'Amiga Aweb', - 'BB' => 'BlackBerry Browser', - 'BD' => 'Baidu Browser', - 'BE' => 'Beonex', - 'BX' => 'BrowseX', - 'CA' => 'Camino', - 'CF' => 'Chrome Frame', - 'CH' => 'Chrome', - 'CI' => 'Chrome Mobile iOS', - 'CK' => 'Conkeror', - 'CM' => 'Chrome Mobile', - 'CO' => 'CometBird', - 'CR' => 'Chromium', - 'CS' => 'Cheshire', - 'DF' => 'Dolphin', - 'DI' => 'Dillo', - 'EL' => 'Elinks', - 'EP' => 'Epiphany', - 'FB' => 'Firebird', - 'FD' => 'Fluid', - 'FE' => 'Fennec', - 'FF' => 'Firefox', - 'FL' => 'Flock', - 'FN' => 'Fireweb Navigator', - 'GA' => 'Galeon', - 'GE' => 'Google Earth', - 'HJ' => 'HotJava', - 'IB' => 'IBrowse', - 'IC' => 'iCab', - 'IE' => 'Internet Explorer', - 'IM' => 'IE Mobile', - 'IR' => 'Iron', - 'JS' => 'Jasmine', - 'KI' => 'Kindle Browser', - 'KM' => 'K-meleon', - 'KO' => 'Konqueror', - 'KP' => 'Kapiko', - 'KZ' => 'Kazehakase', - 'LG' => 'Lightning', - 'LI' => 'Links', - 'LX' => 'Lynx', - 'MB' => 'MicroB', - 'MC' => 'NCSA Mosaic', - 'MF' => 'Mobile Safari', - 'MI' => 'Midori', - 'MS' => 'Mobile Silk', - 'MX' => 'Maxthon', - 'NB' => 'Nokia Browser', - 'NF' => 'NetFront', - 'NL' => 'NetFront Life', - 'NS' => 'Netscape', - 'OB' => 'Obigo', - 'OI' => 'Opera Mini', - 'OM' => 'Opera Mobile', - 'OP' => 'Opera', - 'OV' => 'Openwave Mobile Browser', - 'OW' => 'OmniWeb', - 'PL' => 'Palm Blazer', - 'PR' => 'Palm Pre', - 'PX' => 'Phoenix', - 'RK' => 'Rekonq', - 'RM' => 'RockMelt', - 'SF' => 'Safari', - 'SM' => 'SeaMonkey', - 'SN' => 'Snowshoe', - 'SX' => 'Swiftfox', - 'TZ' => 'Tizen Browser', - 'UC' => 'UC Browser', - 'WO' => 'wOSBrowser', - 'YA' => 'Yandex Browser' - ); - - const UNKNOWN = "UNK"; - protected static $regexesDir = '/regexes/'; - protected static $osRegexesFile = 'oss.yml'; - protected static $browserRegexesFile = 'browsers.yml'; - protected static $mobileRegexesFile = 'mobiles.yml'; - protected $userAgent; - protected $os; - protected $browser; - protected $device; - protected $brand; - protected $model; - protected $debug = false; - - public function __construct($userAgent) - { - $this->userAgent = $userAgent; - } - - protected function getOsRegexes() - { - return Spyc::YAMLLoad(__DIR__ . self::$regexesDir . self::$osRegexesFile); - } - - protected function getBrowserRegexes() - { - return Spyc::YAMLLoad(__DIR__ . self::$regexesDir . self::$browserRegexesFile); - } - - protected function getMobileRegexes() - { - return Spyc::YAMLLoad(__DIR__ . self::$regexesDir . self::$mobileRegexesFile); - } - - public function parse() - { - $this->parseOs(); - if ($this->isBot() || $this->isSimulator()) - return; - - $this->parseBrowser(); - - if ($this->isMobile()) { - $this->parseMobile(); - } else { - $this->device = array_search('desktop', self::$deviceTypes); - } - if ($this->debug) { - var_dump($this->brand, $this->model, $this->device); - } - } - - protected function parseOs() - { - foreach ($this->getOsRegexes() as $osRegex) { - $matches = $this->matchUserAgent($osRegex['regex']); - if ($matches) - break; - } - - if (!$matches) - return; - - if (in_array($osRegex['name'], self::$osShorts)) { - $short = self::$osShorts[$osRegex['name']]; - } else { - $short = 'UNK'; - } - - $this->os = array( - 'name' => $this->buildOsName($osRegex['name'], $matches), - 'short_name' => $short, - 'version' => $this->buildOsVersion($osRegex['version'], $matches) - ); - - if (array_key_exists($this->os['name'], self::$osShorts)) { - $this->os['short_name'] = self::$osShorts[$this->os['name']]; - } - } - - protected function parseBrowser() - { - foreach ($this->getBrowserRegexes() as $browserRegex) { - $matches = $this->matchUserAgent($browserRegex['regex']); - if ($matches) - break; - } - - if (!$matches) - return; - - if (in_array($browserRegex['name'], self::$browsers)) { - $short = array_search($browserRegex['name'], self::$browsers); - } else { - $short = 'XX'; - } - - $this->browser = array( - 'name' => $this->buildBrowserName($browserRegex['name'], $matches), - 'short_name' => $short, - 'version' => $this->buildBrowserVersion($browserRegex['version'], $matches) - ); - } - - protected function parseMobile() - { - $mobileRegexes = $this->getMobileRegexes(); - $this->parseBrand($mobileRegexes); - $this->parseModel($mobileRegexes); - } - - protected function parseBrand($mobileRegexes) - { - foreach ($mobileRegexes as $brand => $mobileRegex) { - $matches = $this->matchUserAgent($mobileRegex['regex']); - if ($matches) - break; - } - - if (!$matches) - return; - $this->brand = array_search($brand, self::$deviceBrands); - $this->fullName = $brand; - - if (isset($mobileRegex['device'])) { - $this->device = array_search($mobileRegex['device'],self::$deviceTypes); - } - - if (isset($mobileRegex['model'])) { - $this->model = $this->buildModel($mobileRegex['model'], $matches); - } - } - - protected function parseModel($mobileRegexes) - { - if (empty($this->brand) || !empty($this->model)) - return; - - foreach ($mobileRegexes[$this->fullName]['models'] as $modelRegex) { - $matches = $this->matchUserAgent($modelRegex['regex']); - if ($matches) - break; - } - - if (!$matches) { - return; - } - - $this->model = $this->buildModel($modelRegex['model'], $matches); - - if (isset($modelRegex['device'])) { - $this->device = array_search($modelRegex['device'], self::$deviceTypes); - } - } - - protected function matchUserAgent($regex) - { - $regex = '/' . str_replace('/', '\/', $regex) . '/i'; - - if (preg_match($regex, $this->userAgent, $matches)) { - return $matches; - } - - return false; - } - - protected function buildOsName($osName, $matches) - { - return $this->buildByMatch($osName, $matches); - } - - protected function buildOsVersion($osVersion, $matches) - { - $osVersion = $this->buildByMatch($osVersion, $matches); - - $osVersion = $this->buildByMatch($osVersion, $matches, '2'); - - $osVersion = str_replace('_', '.', $osVersion); - - return $osVersion; - } - - protected function buildBrowserName($browserName, $matches) - { - return $this->buildByMatch($browserName, $matches); - } - - protected function buildBrowserVersion($browserVersion, $matches) - { - $browserVersion = $this->buildByMatch($browserVersion, $matches); - - $browserVersion = $this->buildByMatch($browserVersion, $matches, '2'); - - $browserVersion = str_replace('_', '.', $browserVersion); - - return $browserVersion; - } - - protected function buildModel($model, $matches) - { - $model = $this->buildByMatch($model, $matches); - - $model = $this->buildByMatch($model, $matches, '2'); - - $model = $this->buildModelExceptions($model); - - $model = str_replace('_', ' ', $model); - - return $model; - } - - protected function buildModelExceptions($model) - { - if ($this->brand == 'O2') { - $model = preg_replace('/([a-z])([A-Z])/', '$1 $2', $model); - $model = ucwords(str_replace('_', ' ', $model)); - } - - return $model; - } - - /** - * This method is used in this class for processing results of pregmatch - * results into string containing recognized information. - * - * General algorithm: - * Parsing UserAgent string consists of trying to match it against list of - * regular expressions for three different information: - * browser + version, - * OS + version, - * device manufacturer + model. - * - * After match has been found iteration stops, and results are processed - * by buildByMatch. - * As $item we get decoded name (name of browser, name of OS, name of manufacturer). - * In array $match we recieve preg_match results containing whole string matched at index 0 - * and following matches in further indexes. Desired action now is to concatenate - * decoded name ($item) with matches found. First step is to append first found match, - * which is located in index=1 (that's why $nb is 1 by default). - * In other cases, where whe know that preg_match may return more than 1 result, - * we call buildByMatch with $nb = 2 or more, depending on what will be returned from - * regular expression. - * - * Example: - * We are parsing UserAgent of Firefox 20.0 browser. - * UserAgentParserEnhanced calls buildBrowserName() and buildBrowserVersion() in order - * to retrieve those information. - * In buildBrowserName() we only have one call of buildByMatch, where passed argument - * is regular expression testing given string for browser name. In this case, we are only - * interrested in first hit, so no $nb parameter will be set to 1. After finding match, and calling - * buildByMatch - we will receive just the name of browser. - * - * Also after decoding browser we will get list of regular expressions for this browser name - * testing UserAgent string for version number. Again we iterate over this list, and after finding first - * occurence - we break loop and proceed to build by match. Since browser regular expressions can - * contain two hits (major version and minor version) in function buildBrowserVersion() we have - * two calls to buildByMatch, one without 3rd parameter, and second with $nb set to 2. - * This way we can retrieve version number, and assign it to object property. - * - * In case of mobiles.yml this schema slightly varies, but general idea is the same. - * - * @param string $item - * @param array $matches - * @param int $nb - * @return type - */ - protected function buildByMatch($item, $matches, $nb = '1') - { - if (strpos($item, '$' . $nb) === false) - return $item; - - $replace = isset($matches[$nb]) ? $matches[$nb] : ''; - return trim(str_replace('$' . $nb, $replace, $item)); - } - - public function isBot() - { - $decodedFamily = ''; - if (in_array($this->getOs('name'), self::$osShorts)) { - $osShort = self::$osShorts[$this->getOs('name')]; - } else { - $osShort = ''; - } - foreach (self::$osFamilies as $family => $familyOs) { - if (in_array($osShort, $familyOs)) { - $decodedFamily = $family; - break; - } - } - - return $decodedFamily == 'Bot'; - } - - public function isSimulator() - { - $decodedFamily = ''; - if (in_array($this->getOs('name'), self::$osShorts)) { - $osShort = self::$osShorts[$this->getOs('name')]; - } else { - $osShort = ''; - } - foreach (self::$osFamilies as $family => $familyOs) { - if (in_array($osShort, $familyOs)) { - $decodedFamily = $family; - break; - } - } - return $decodedFamily == 'Simulator'; - } - - public function isMobile() - { - return !$this->isDesktop(); - } - - public function isDesktop() - { - $osName = $this->getOs('name'); - if (empty($osName) || empty(self::$osShorts[$osName])) { - return false; - } - - $osShort = self::$osShorts[$osName]; - foreach (self::$osFamilies as $family => $familyOs) { - if (in_array($osShort, $familyOs)) { - $decodedFamily = $family; - break; - } - } - return in_array($decodedFamily, self::$desktopOsArray); - } - - public function getOs($attr = '') - { - if ($attr == '') { - return $this->os; - } - - if (!isset($this->os[$attr])) { - return self::UNKNOWN; - } - - if ($attr == 'version') { - $this->os['version'] = $this->os['version']; - } - return $this->os[$attr]; - } - - public function getBrowser($attr = '') - { - if ($attr == '') { - return $this->browser; - } - - if (!isset($this->browser[$attr])) { - return self::UNKNOWN; - } - - return $this->browser[$attr]; - } - - public function getDevice() - { - return $this->device; - } - - public function getBrand() - { - return $this->brand; - } - - public function getModel() - { - return $this->model; - } - - public function getUserAgent() - { - return $this->userAgent; - } - - public static function getOsFamily($osLabel) - { - $osShortName = substr($osLabel, 0, 3); - - foreach (self::$osFamilies as $osFamily => $osShortNames) { - if (in_array($osShortName, $osShortNames)) { - return $osFamily; - } - } - - return 'Other'; - } - - public static function getBrowserFamily($browserLabel) - { - foreach (self::$browserFamilies as $browserFamily => $browserShortNames) { - if (in_array($browserLabel, $browserShortNames)) { - return $browserFamily; - } - } - - return 'Other'; - } - + 'Acer', + 'AI' => 'Airness', + 'AL' => 'Alcatel', + 'AO' => 'Amoi', + 'AP' => 'Apple', + 'AU' => 'Asus', + 'AV' => 'Avvio', + 'AX' => 'Audiovox', + 'BE' => 'Becker', + 'BI' => 'Bird', + 'BL' => 'Beetel', + 'BQ' => 'BenQ', + 'BS' => 'BenQ-Siemens', + 'CK' => 'Cricket', + 'CL' => 'Compal', + 'CT' => 'Capitel', + 'DB' => 'Dbtel', + 'DC' => 'DoCoMo', + 'DI' => 'Dicam', + 'DL' => 'Dell', + 'DP' => 'Dopod', + 'EC' => 'Ericsson', + 'EI' => 'Ezio', + 'ER' => 'Ericy', + 'ET' => 'eTouch', + 'EZ' => 'Ezze', + 'FL' => 'Fly', + 'GI' => 'Gionee', + 'GO' => 'Google', + 'GR' => 'Gradiente', + 'GU' => 'Grundig', + 'HA' => 'Haier', + 'HP' => 'HP', + 'HT' => 'HTC', + 'HU' => 'Huawei', + 'IK' => 'iKoMo', + 'IM' => 'i-mate', + 'IN' => 'Innostream', + 'IO' => 'i-mobile', + 'IQ' => 'INQ', + 'KA' => 'Karbonn', + 'KD' => 'KDDI', + 'KN' => 'Kindle', + 'KO' => 'Konka', + 'KY' => 'Kyocera', + 'LA' => 'Lanix', + 'LC' => 'LCT', + 'LE' => 'Lenovo', + 'LG' => 'LG', + 'LU' => 'LGUPlus', + 'MI' => 'MicroMax', + 'MO' => 'Mio', + 'MR' => 'Motorola', + 'MS' => 'Microsoft', + 'MT' => 'Mitsubishi', + 'MY' => 'MyPhone', + 'NE' => 'NEC', + 'NG' => 'NGM', + 'NI' => 'Nintendo', + 'NK' => 'Nokia', + 'NW' => 'Newgen', + 'NX' => 'Nexian', + 'OD' => 'Onda', + 'OP' => 'OPPO', + 'OR' => 'Orange', + 'OT' => 'O2', + 'PA' => 'Panasonic', + 'PH' => 'Philips', + 'PM' => 'Palm', + 'PO' => 'phoneOne', + 'PT' => 'Pantech', + 'QT' => 'Qtek', + 'RM' => 'RIM', + 'RO' => 'Rover', + 'SA' => 'Samsung', + 'SD' => 'Sega', + 'SE' => 'Sony Ericsson', + 'SF' => 'Softbank', + 'SG' => 'Sagem', + 'SH' => 'Sharp', + 'SI' => 'Siemens', + 'SN' => 'Sendo', + 'SO' => 'Sony', + 'SP' => 'Spice', + 'SY' => 'Sanyo', + 'TA' => 'Tesla', + 'TC' => 'TCL', + 'TE' => 'Telit', + 'TH' => 'TiPhone', + 'TI' => 'TIANYU', + 'TM' => 'T-Mobile', + 'TO' => 'Toplux', + 'TS' => 'Toshiba', + 'UT' => 'UTStarcom', + 'VD' => 'Videocon', + 'VE' => 'Vertu', + 'VI' => 'Vitelcom', + 'VK' => 'VK Mobile', + 'VO' => 'Voxtel', + 'WB' => 'Web TV', + 'WE' => 'WellcoM', + 'WO' => 'Wonu', + 'XX' => 'Unknown', + 'ZO' => 'Zonda', + 'ZT' => 'ZTE', + ); + public static $osShorts = array( + 'AIX' => 'AIX', + 'Android' => 'AND', + 'Apple TV' => 'ATV', + 'Arch Linux' => 'ARL', + 'BackTrack' => 'BTR', + 'Bada' => 'SBA', + 'BlackBerry OS' => 'BLB', + 'BlackBerry Tablet OS' => 'QNX', + 'Bot' => 'BOT', + 'Brew' => 'BMP', + 'CentOS' => 'CES', + 'Chrome OS' => 'COS', + 'Debian' => 'DEB', + 'DragonFly' => 'DFB', + 'Fedora' => 'FED', + 'Firefox OS' => 'FOS', + 'FreeBSD' => 'BSD', + 'Gentoo' => 'GNT', + 'Google TV' => 'GTV', + 'HP-UX' => 'HPX', + 'IRIX' => 'IRI', + 'Knoppix' => 'KNO', + 'Kubuntu' => 'KBT', + 'Linux' => 'LIN', + 'Lubuntu' => 'LBT', + 'Mac' => 'MAC', + 'Mandriva' => 'MDR', + 'MeeGo' => 'SMG', + 'Mint' => 'MIN', + 'NetBSD' => 'NBS', + 'Nintendo' => 'WII', + 'Nintendo Mobile' => 'NDS', + 'OS/2' => 'OS2', + 'OSF1' => 'T64', + 'OpenBSD' => 'OBS', + 'PlayStation' => 'PSP', + 'PlayStation 3' => 'PS3', + 'Presto' => 'PRS', + 'Puppy' => 'PPY', + 'Red Hat' => 'RHT', + 'SUSE' => 'SSE', + 'Slackware' => 'SLW', + 'Solaris' => 'SOS', + 'Syllable' => 'SYL', + 'Symbian' => 'SYM', + 'Symbian OS' => 'SYS', + 'Symbian OS Series 40' => 'S40', + 'Symbian OS Series 60' => 'S60', + 'Symbian^3' => 'SY3', + 'Talkatone' => 'TKT', + 'Tizen' => 'TIZ', + 'Ubuntu' => 'UBT', + 'WebTV' => 'WTV', + 'WinWAP' => 'WWP', + 'Windows' => 'WIN', + 'Windows 2000' => 'W2K', + 'Windows 3.1' => 'W31', + 'Windows 7' => 'WI7', + 'Windows 8' => 'WI8', + 'Windows 95' => 'W95', + 'Windows 98' => 'W98', + 'Windows CE' => 'WCE', + 'Windows ME' => 'WME', + 'Windows Mobile' => 'WMO', + 'Windows NT' => 'WNT', + 'Windows Phone' => 'WPH', + 'Windows RT' => 'WRT', + 'Windows Server 2003' => 'WS3', + 'Windows Vista' => 'WVI', + 'Windows XP' => 'WXP', + 'Xbox' => 'XBX', + 'Xubuntu' => 'XBT', + 'YunOs' => 'YNS', + 'iOS' => 'IOS', + 'palmOS' => 'POS', + 'webOS' => 'WOS' + ); + protected static $desktopOsArray = array('IBM', 'Linux', 'Mac', 'Unix', 'Windows'); + public static $osFamilies = array( + 'Android' => array('AND'), + 'Apple TV' => array('ATV'), + 'BlackBerry' => array('BLB'), + 'Bot' => array('BOT'), + 'Brew' => array('BMP'), + 'Chrome OS' => array('COS'), + 'Firefox OS' => array('FOS'), + 'Gaming Console' => array('WII', 'PS3'), + 'Google TV' => array('GTV'), + 'IBM' => array('OS2'), + 'iOS' => array('IOS'), + 'Linux' => array('LIN', 'ARL', 'DEB', 'KNO', 'MIN', 'UBT', 'KBT', 'XBT', 'LBT', 'FED', 'RHT', 'MDR', 'GNT', 'SLW', 'SSE', 'PPY', 'CES', 'BTR', 'YNS', 'PRS'), + 'Mac' => array('MAC'), + 'Mobile Gaming Console' => array('PSP', 'NDS', 'XBX'), + 'Other Mobile' => array('WOS', 'POS', 'QNX', 'SBA', 'TIZ'), + 'Simulator' => array('TKT', 'WWP'), + 'Symbian' => array('SYM', 'SYS', 'SY3', 'S60', 'S40', 'SMG'), + 'Unix' => array('SOS', 'AIX', 'HPX', 'BSD', 'NBS', 'OBS', 'DFB', 'SYL', 'IRI', 'T64'), + 'WebTV' => array('WTV'), + 'Windows' => array('WI8', 'WI7', 'WVI', 'WS3', 'WXP', 'W2K', 'WNT', 'WME', 'W98', 'W95', 'WRT', 'W31', 'WIN'), + 'Windows Mobile' => array('WPH', 'WMO', 'WCE') + ); + public static $browserFamilies = array( + 'Android Browser' => array('AN'), + 'BlackBerry Browser' => array('BB'), + 'Chrome' => array('CH', 'CM', 'CI', 'CF', 'CR', 'RM'), + 'Firefox' => array('FF', 'FE', 'SX', 'FB', 'PX', 'MB'), + 'Internet Explorer' => array('IE', 'IM'), + 'Konqueror' => array('KO'), + 'NetFront' => array('NF'), + 'Nokia Browser' => array('NB'), + 'Opera' => array('OP', 'OM', 'OI'), + 'Safari' => array('SF', 'MF') + ); + public static $browsers = array( + 'AB' => 'ABrowse', + 'AM' => 'Amaya', + 'AN' => 'Android Browser', + 'AR' => 'Arora', + 'AV' => 'Amiga Voyager', + 'AW' => 'Amiga Aweb', + 'BB' => 'BlackBerry Browser', + 'BD' => 'Baidu Browser', + 'BE' => 'Beonex', + 'BX' => 'BrowseX', + 'CA' => 'Camino', + 'CF' => 'Chrome Frame', + 'CH' => 'Chrome', + 'CI' => 'Chrome Mobile iOS', + 'CK' => 'Conkeror', + 'CM' => 'Chrome Mobile', + 'CO' => 'CometBird', + 'CR' => 'Chromium', + 'CS' => 'Cheshire', + 'DF' => 'Dolphin', + 'DI' => 'Dillo', + 'EL' => 'Elinks', + 'EP' => 'Epiphany', + 'FB' => 'Firebird', + 'FD' => 'Fluid', + 'FE' => 'Fennec', + 'FF' => 'Firefox', + 'FL' => 'Flock', + 'FN' => 'Fireweb Navigator', + 'GA' => 'Galeon', + 'GE' => 'Google Earth', + 'HJ' => 'HotJava', + 'IB' => 'IBrowse', + 'IC' => 'iCab', + 'IE' => 'Internet Explorer', + 'IM' => 'IE Mobile', + 'IR' => 'Iron', + 'JS' => 'Jasmine', + 'KI' => 'Kindle Browser', + 'KM' => 'K-meleon', + 'KO' => 'Konqueror', + 'KP' => 'Kapiko', + 'KZ' => 'Kazehakase', + 'LG' => 'Lightning', + 'LI' => 'Links', + 'LX' => 'Lynx', + 'MB' => 'MicroB', + 'MC' => 'NCSA Mosaic', + 'MF' => 'Mobile Safari', + 'MI' => 'Midori', + 'MS' => 'Mobile Silk', + 'MX' => 'Maxthon', + 'NB' => 'Nokia Browser', + 'NF' => 'NetFront', + 'NL' => 'NetFront Life', + 'NS' => 'Netscape', + 'OB' => 'Obigo', + 'OI' => 'Opera Mini', + 'OM' => 'Opera Mobile', + 'OP' => 'Opera', + 'OV' => 'Openwave Mobile Browser', + 'OW' => 'OmniWeb', + 'PL' => 'Palm Blazer', + 'PR' => 'Palm Pre', + 'PX' => 'Phoenix', + 'RK' => 'Rekonq', + 'RM' => 'RockMelt', + 'SF' => 'Safari', + 'SM' => 'SeaMonkey', + 'SN' => 'Snowshoe', + 'SX' => 'Swiftfox', + 'TZ' => 'Tizen Browser', + 'UC' => 'UC Browser', + 'WO' => 'wOSBrowser', + 'YA' => 'Yandex Browser' + ); + + const UNKNOWN = "UNK"; + protected static $regexesDir = '/regexes/'; + protected static $osRegexesFile = 'oss.yml'; + protected static $browserRegexesFile = 'browsers.yml'; + protected static $mobileRegexesFile = 'mobiles.yml'; + protected $userAgent; + protected $os; + protected $browser; + protected $device; + protected $brand; + protected $model; + protected $debug = false; + + public function __construct($userAgent) + { + $this->userAgent = $userAgent; + } + + protected function getOsRegexes() + { + return Spyc::YAMLLoad(__DIR__ . self::$regexesDir . self::$osRegexesFile); + } + + protected function getBrowserRegexes() + { + return Spyc::YAMLLoad(__DIR__ . self::$regexesDir . self::$browserRegexesFile); + } + + protected function getMobileRegexes() + { + return Spyc::YAMLLoad(__DIR__ . self::$regexesDir . self::$mobileRegexesFile); + } + + public function parse() + { + $this->parseOs(); + if ($this->isBot() || $this->isSimulator()) + return; + + $this->parseBrowser(); + + if ($this->isMobile()) { + $this->parseMobile(); + } else { + $this->device = array_search('desktop', self::$deviceTypes); + } + if ($this->debug) { + var_dump($this->brand, $this->model, $this->device); + } + } + + protected function parseOs() + { + foreach ($this->getOsRegexes() as $osRegex) { + $matches = $this->matchUserAgent($osRegex['regex']); + if ($matches) + break; + } + + if (!$matches) + return; + + if (in_array($osRegex['name'], self::$osShorts)) { + $short = self::$osShorts[$osRegex['name']]; + } else { + $short = 'UNK'; + } + + $this->os = array( + 'name' => $this->buildOsName($osRegex['name'], $matches), + 'short_name' => $short, + 'version' => $this->buildOsVersion($osRegex['version'], $matches) + ); + + if (array_key_exists($this->os['name'], self::$osShorts)) { + $this->os['short_name'] = self::$osShorts[$this->os['name']]; + } + } + + protected function parseBrowser() + { + foreach ($this->getBrowserRegexes() as $browserRegex) { + $matches = $this->matchUserAgent($browserRegex['regex']); + if ($matches) + break; + } + + if (!$matches) + return; + + if (in_array($browserRegex['name'], self::$browsers)) { + $short = array_search($browserRegex['name'], self::$browsers); + } else { + $short = 'XX'; + } + + $this->browser = array( + 'name' => $this->buildBrowserName($browserRegex['name'], $matches), + 'short_name' => $short, + 'version' => $this->buildBrowserVersion($browserRegex['version'], $matches) + ); + } + + protected function parseMobile() + { + $mobileRegexes = $this->getMobileRegexes(); + $this->parseBrand($mobileRegexes); + $this->parseModel($mobileRegexes); + } + + protected function parseBrand($mobileRegexes) + { + foreach ($mobileRegexes as $brand => $mobileRegex) { + $matches = $this->matchUserAgent($mobileRegex['regex']); + if ($matches) + break; + } + + if (!$matches) + return; + $this->brand = array_search($brand, self::$deviceBrands); + $this->fullName = $brand; + + if (isset($mobileRegex['device'])) { + $this->device = array_search($mobileRegex['device'],self::$deviceTypes); + } + + if (isset($mobileRegex['model'])) { + $this->model = $this->buildModel($mobileRegex['model'], $matches); + } + } + + protected function parseModel($mobileRegexes) + { + if (empty($this->brand) || !empty($this->model)) + return; + + foreach ($mobileRegexes[$this->fullName]['models'] as $modelRegex) { + $matches = $this->matchUserAgent($modelRegex['regex']); + if ($matches) + break; + } + + if (!$matches) { + return; + } + + $this->model = $this->buildModel($modelRegex['model'], $matches); + + if (isset($modelRegex['device'])) { + $this->device = array_search($modelRegex['device'], self::$deviceTypes); + } + } + + protected function matchUserAgent($regex) + { + $regex = '/' . str_replace('/', '\/', $regex) . '/i'; + + if (preg_match($regex, $this->userAgent, $matches)) { + return $matches; + } + + return false; + } + + protected function buildOsName($osName, $matches) + { + return $this->buildByMatch($osName, $matches); + } + + protected function buildOsVersion($osVersion, $matches) + { + $osVersion = $this->buildByMatch($osVersion, $matches); + + $osVersion = $this->buildByMatch($osVersion, $matches, '2'); + + $osVersion = str_replace('_', '.', $osVersion); + + return $osVersion; + } + + protected function buildBrowserName($browserName, $matches) + { + return $this->buildByMatch($browserName, $matches); + } + + protected function buildBrowserVersion($browserVersion, $matches) + { + $browserVersion = $this->buildByMatch($browserVersion, $matches); + + $browserVersion = $this->buildByMatch($browserVersion, $matches, '2'); + + $browserVersion = str_replace('_', '.', $browserVersion); + + return $browserVersion; + } + + protected function buildModel($model, $matches) + { + $model = $this->buildByMatch($model, $matches); + + $model = $this->buildByMatch($model, $matches, '2'); + + $model = $this->buildModelExceptions($model); + + $model = str_replace('_', ' ', $model); + + return $model; + } + + protected function buildModelExceptions($model) + { + if ($this->brand == 'O2') { + $model = preg_replace('/([a-z])([A-Z])/', '$1 $2', $model); + $model = ucwords(str_replace('_', ' ', $model)); + } + + return $model; + } + + /** + * This method is used in this class for processing results of pregmatch + * results into string containing recognized information. + * + * General algorithm: + * Parsing UserAgent string consists of trying to match it against list of + * regular expressions for three different information: + * browser + version, + * OS + version, + * device manufacturer + model. + * + * After match has been found iteration stops, and results are processed + * by buildByMatch. + * As $item we get decoded name (name of browser, name of OS, name of manufacturer). + * In array $match we recieve preg_match results containing whole string matched at index 0 + * and following matches in further indexes. Desired action now is to concatenate + * decoded name ($item) with matches found. First step is to append first found match, + * which is located in index=1 (that's why $nb is 1 by default). + * In other cases, where whe know that preg_match may return more than 1 result, + * we call buildByMatch with $nb = 2 or more, depending on what will be returned from + * regular expression. + * + * Example: + * We are parsing UserAgent of Firefox 20.0 browser. + * UserAgentParserEnhanced calls buildBrowserName() and buildBrowserVersion() in order + * to retrieve those information. + * In buildBrowserName() we only have one call of buildByMatch, where passed argument + * is regular expression testing given string for browser name. In this case, we are only + * interrested in first hit, so no $nb parameter will be set to 1. After finding match, and calling + * buildByMatch - we will receive just the name of browser. + * + * Also after decoding browser we will get list of regular expressions for this browser name + * testing UserAgent string for version number. Again we iterate over this list, and after finding first + * occurence - we break loop and proceed to build by match. Since browser regular expressions can + * contain two hits (major version and minor version) in function buildBrowserVersion() we have + * two calls to buildByMatch, one without 3rd parameter, and second with $nb set to 2. + * This way we can retrieve version number, and assign it to object property. + * + * In case of mobiles.yml this schema slightly varies, but general idea is the same. + * + * @param string $item + * @param array $matches + * @param int $nb + * @return type + */ + protected function buildByMatch($item, $matches, $nb = '1') + { + if (strpos($item, '$' . $nb) === false) + return $item; + + $replace = isset($matches[$nb]) ? $matches[$nb] : ''; + return trim(str_replace('$' . $nb, $replace, $item)); + } + + public function isBot() + { + $decodedFamily = ''; + if (in_array($this->getOs('name'), self::$osShorts)) { + $osShort = self::$osShorts[$this->getOs('name')]; + } else { + $osShort = ''; + } + foreach (self::$osFamilies as $family => $familyOs) { + if (in_array($osShort, $familyOs)) { + $decodedFamily = $family; + break; + } + } + + return $decodedFamily == 'Bot'; + } + + public function isSimulator() + { + $decodedFamily = ''; + if (in_array($this->getOs('name'), self::$osShorts)) { + $osShort = self::$osShorts[$this->getOs('name')]; + } else { + $osShort = ''; + } + foreach (self::$osFamilies as $family => $familyOs) { + if (in_array($osShort, $familyOs)) { + $decodedFamily = $family; + break; + } + } + return $decodedFamily == 'Simulator'; + } + + public function isMobile() + { + return !$this->isDesktop(); + } + + public function isDesktop() + { + $osName = $this->getOs('name'); + if (empty($osName) || empty(self::$osShorts[$osName])) { + return false; + } + + $osShort = self::$osShorts[$osName]; + foreach (self::$osFamilies as $family => $familyOs) { + if (in_array($osShort, $familyOs)) { + $decodedFamily = $family; + break; + } + } + return in_array($decodedFamily, self::$desktopOsArray); + } + + public function getOs($attr = '') + { + if ($attr == '') { + return $this->os; + } + + if (!isset($this->os[$attr])) { + return self::UNKNOWN; + } + + if ($attr == 'version') { + $this->os['version'] = $this->os['version']; + } + return $this->os[$attr]; + } + + public function getBrowser($attr = '') + { + if ($attr == '') { + return $this->browser; + } + + if (!isset($this->browser[$attr])) { + return self::UNKNOWN; + } + + return $this->browser[$attr]; + } + + public function getDevice() + { + return $this->device; + } + + public function getBrand() + { + return $this->brand; + } + + public function getModel() + { + return $this->model; + } + + public function getUserAgent() + { + return $this->userAgent; + } + + public static function getOsFamily($osLabel) + { + $osShortName = substr($osLabel, 0, 3); + + foreach (self::$osFamilies as $osFamily => $osShortNames) { + if (in_array($osShortName, $osShortNames)) { + return $osFamily; + } + } + + return 'Other'; + } + + public static function getBrowserFamily($browserLabel) + { + foreach (self::$browserFamilies as $browserFamily => $browserShortNames) { + if (in_array($browserLabel, $browserShortNames)) { + return $browserFamily; + } + } + + return 'Other'; + } + + public static function getOsNameFromId($os, $ver = false) + { + $osFullName = array_search($os, self::$osShorts); + if ($osFullName) { + if (in_array($os, self::$osFamilies['Windows'])) { + return $osFullName; + } else { + return trim($osFullName . " " . $ver); + } + } + return false; + } + } \ No newline at end of file diff --git a/plugins/DevicesDetection/UserAgentParserEnhanced/regexes/browsers.yml b/plugins/DevicesDetection/UserAgentParserEnhanced/regexes/browsers.yml index c9f3a72e5a..0a4d2a6669 100644 --- a/plugins/DevicesDetection/UserAgentParserEnhanced/regexes/browsers.yml +++ b/plugins/DevicesDetection/UserAgentParserEnhanced/regexes/browsers.yml @@ -1,408 +1,408 @@ -############### -# Piwik - Open source web analytics -# -# @link http://piwik.org -# @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later -# -# @category Piwik_Plugins -# @package Piwik_DevicesDetection -############### - -# SeaMonkey -- regex: '(Iceape|SeaMonkey)/(\d+\.\d+)' - name: $1 - version: '$2' - -# Camino -- regex: 'Camino/(\d+\.\d+)' - name: Camino - version: '$1' - -#Fennec (Firefox for mobile) -- regex: 'Fennec/(\d+\.\d+)' - name: Fennec - version: '$1' - -#MicroB -- regex: 'Firefox.*Tablet browser (\d+\.\d+)' - name: MicroB - version: '$1' - -#Firefox -- regex: 'Firefox/(\d+\.\d+)' - name: Firefox - version: '$1' -- regex: '(BonEcho|GranParadiso|Lorentz|Minefield|Namoroka|Shiretoko)/(\d+\.\d+)' - name: Firefox '$1' - version: '$2' - -#Flock -- regex: 'Flock/(\d+\.\d+)' - name: Flock - version: '$1' - -#RockMelt -- regex: 'RockMelt/(\d+\.\d+)' - name: RockMelt - version: '$1' - -#Netscape -- regex: '(?:Navigator|Netscape6)/(\d+\.\d+)' - name: Netscape - version: '$1' - -#Opera -- regex: '(:?Opera Tablet.*Version|Opera/.+Opera Mobi.+Version|Safari.*OPR)/(\d+\.\d+)' - name: Opera Mobile - version: '$2' -- regex: 'Opera Mini/(:?att/)?(\d+\.\d+)' - name: Opera Mini - version: '$2' -- regex: 'Opera[/ ](?:9.80.*Version/)?(\d+\.\d+)' - name: Opera - version: '$1' - -#wOSBrowser -- regex: '(?:hpw|web)OS/(\d+\.\d+)' - name: wOSBrowser - version: '$1' - -#Swiftfox -- regex: 'Firefox/(\d+\.\d+).*\(Swiftfox\)' - name: Swiftfox - version: '$1' - -#Rekonq -- regex: 'rekonq' - name: Rekonq - version: '' - -#Conkeror -- regex: 'Conkeror/(\d+\.\d+)' - name: Conkeror - version: '$1' - -#Konqueror -- regex: 'Konqueror/(\d+\.\d+)' - name: Konqueror - version: '$1' - -#Baidu Browser -- regex: 'baidubrowser[/ ](\d+)' - name: Baidu Browser - version: '$1' - -#Yandex Browser -- regex: 'YaBrowser/(\d+)' - name: Yandex Browser - version: '$1' - -#Chrome -- regex: 'CrMo/(\d+\.\d+)' - name: Chrome Mobile - version: '$1' -- regex: 'CriOS/(\d+\.\d+)' - name: Chrome Mobile iOS - version: '$1' -- regex: 'Chrome/(\d+\.\d+).*Mobile' - name: Chrome Mobile - version: '$1' -- regex: 'chromeframe/(\d+\.\d+)' - name: Chrome Frame - version: '$1' -- regex: 'Chrome/(\d+\.\d+)' - name: Chrome - version: '$1' -- regex: 'Chromium/(\d+\.\d+)' - name: Chromium - version: '$1' - -#UC Browser -- regex: 'UC[ ]?Browser[ /](\d+\.\d+)' - name: UC Browser - version: '$1' -- regex: '(?:UC Browser|UCBrowser|UCWEB)(\d+\.\d+)' - name: UC Browser - version: '$1' - -#Tizen Browser -- regex: '(?:Tizen|SLP) Browser/(\d+\.\d+)' - name: Tizen Browser - version: '$1' - -#Epiphany -- regex: 'Epiphany/(\d+\.\d+)' - name: Epiphany - version: '$1' - -#Fireweb Navigator -- regex: 'Fireweb Navigator/(\d+\.\d+)' - name: Fireweb Navigator - version: '$1' - -#Jasmine -- regex: 'Jasmine[ /](\d+\.\d+)' - name: Jasmine - version: '$1' - -#Lynx -- regex: 'Lynx/(\d+\.\d+)' - name: Lynx - version: '$1' - -#Midori -- regex: 'Midori/(\d+\.\d+)' - name: Midori - version: '$1' - -#NCSA Mosaic -- regex: 'NCSA_Mosaic/(\d+\.\d+)' - name: NCSA Mosaic - version: '$1' - -#ABrowse -- regex: 'ABrowse (\d+\.\d+)' - name: ABrowse - version: '$1' - -#Amaya -- regex: 'amaya/(\d+\.\d+)' - name: Amaya - version: '$1' - -#Amiga Voyager -- regex: 'AmigaVoyager/(\d+\.\d+)' - name: Amiga Voyager - version: '$1' - -#Amiga Aweb -- regex: 'Amiga-Aweb/(\d+\.\d+)' - name: Amiga Aweb - version: '$1' - -#Arora -- regex: 'Arora/(\d+\.\d+)' - name: Arora - version: '$1' - -#Beonex -- regex: 'Beonex/(\d+\.\d+)' - name: Beonex - version: '$1' - -#BlackBerry Browser -- regex: 'Black[bB]erry|PlayBook|BB10' - name: BlackBerry Browser - version: '' - -#BrowseX -- regex: 'BrowseX \((\d+\.\d+)' - name: BrowseX - version: '$1' - -#Cheshire -- regex: 'Cheshire/(\d+\.\d+)' - name: Cheshire - version: '$1' - -#CometBird -- regex: 'CometBird/(\d+\.\d+)' - name: CometBird - version: '$1' - -#Dillo -- regex: 'Dillo/(\d+\.\d+)' - name: Dillo - version: '$1' - -#Dolphin -- regex: 'Dolfin/(\d+\.\d+)|dolphin' - name: Dolphin - version: '$1' - -#Elinks -- regex: 'Elinks/(\d+\.\d+)' - name: Elinks - version: '$1' - -#Firebird -- regex: 'Firebird/(\d+\.\d+)' - name: Firebird - version: '$1' - -#Fluid -- regex: 'Fluid/(\d+\.\d+)' - name: Fluid - version: '$1' - -#Galeon -- regex: 'Galeon/(\d+\.\d+)' - name: Galeon - version: '$1' - -#Google Earth -- regex: 'Google Earth/(\d+\.\d+)' - name: Google Earth - version: '$1' - -#HotJava -- regex: 'HotJava/(\d+\.\d+)' - name: HotJava - version: '$1' - -#IBrowse -- regex: 'IBrowse[ /](\d+\.\d+)' - name: IBrowse - version: '$1' - -#iCab -- regex: 'iCab[ /](\d+\.\d+)' - name: iCab - version: '$1' - -#Internet Explorer -- regex: 'IEMobile[ /](\d+\.\d+)' - name: IE Mobile - version: '$1' -- regex: 'MSIE (\d+\.\d+).*XBLWP7' - name: IE Mobile - version: '$1' -- regex: 'MSIE (\d+\.\d+)' - name: Internet Explorer - version: '$1' - -#Iron -- regex: 'Iron/(\d+\.\d+)' - name: Iron - version: '$1' - -#Kapiko -- regex: 'Kapiko/(\d+\.\d+)' - name: Kapiko - version: '$1' - -#Kazehakase -- regex: 'Kazehakase/(\d+\.\d+)' - name: Kazehakase - version: '$1' - -#Kindle Browser -- regex: 'Kindle/(\d+\.\d+)' - name: Kindle Browser - version: '$1' - -#K-meleon -- regex: 'K-meleon/(\d+\.\d+)' - name: K-meleon - version: '$1' - -#Lightning -- regex: 'Lightning/(\d+\.\d+)' - name: Lightning - version: '$1' - -#Links -- regex: 'Links \((\d+\.\d+)' - name: Links - version: '$1' - -#Maxthon -- regex: 'Maxthon (\d+\.\d+)' - name: Maxthon - version: '$1' -- regex: '(?:Maxthon|MyIE2|Uzbl|Shiira)' - name: Maxthon - version: '' - -#Openwave Mobile Browser -- regex: 'UP.Browser/(\d+\.\d+)' - name: Openwave Mobile Browser - version: '$1' - -#OmniWeb -- regex: 'OmniWeb/[v]?(\d+\.\d+)' - name: OmniWeb - version: '$1' - -#Phoenix -- regex: 'Phoenix/(\d+\.\d+)' - name: Phoenix - version: '$1' - -#Mobile Silk -- regex: 'Silk/(\d+\.\d+)' - name: Mobile Silk - version: '$1' - -#Nokia Browser -- regex: '(?:NokiaBrowser|BrowserNG)/(\d+\.\d+)' - name: Nokia Browser - version: '$1' -- regex: 'Series60/5\.0' - name: Nokia Browser - version: '7.0' -- regex: 'Series60/(\d+\.\d+)' - name: Nokia OSS Browser - version: '$1' -- regex: 'S40OviBrowser/(\d+\.\d+)' - name: Nokia Ovi Browser - version: '$1' -- regex: '^Nokia|Nokia[EN]?\d+' - name: Nokia Browser - version: '' - -#NetFront -- regex: 'NetFrontLifeBrowser/(\d+\.\d+)' - name: NetFront Life - version: '$1' -- regex: 'NetFront/(\d+\.\d+)' - name: NetFront - version: '$1' -- regex: 'PLAYSTATION|NINTENDO 3|AppleWebKit.+ NX/\d+\.\d+\.\d+' - name: NetFront - version: '' - -#Obigo -- regex: 'Obigo[ ]?(?:InternetBrowser|Browser)?[ /]([A-Za-z0-9]*)' - name: Obigo - version: '$1' -- regex: 'Obigo|Teleca' - name: Obigo - version: '' - -#Palm Blazer -- regex: 'Blazer/(\d+\.\d+)' - name: Palm Blazer - version: '$1' -- regex: 'Pre/(\d+\.\d+)' - name: Palm Pre - version: '$1' - -#Polaris -- regex: '(?:Polaris|Embider)/(\d+\.\d+)' - name: Polaris - version: '$1' - -#Snowshoe -- regex: 'Snowshoe/(\d+\.\d+)' - name: Snowshoe - version: '$1' - -#Safari -- regex: '(?:iPod|iPad|iPhone).+Version/(\d+\.\d+)' - name: Mobile Safari - version: '$1' -- regex: 'Version/(\d+\.\d+).*Mobile.*Safari/' - name: Mobile Safari - version: '$1' -- regex: '(?:iPod|iPhone|iPad)' - name: Mobile Safari - version: '' -- regex: 'Version/(\d+\.\d+).*Safari/|Safari/\d+' - name: Safari - version: '$1' - -#Android Browser -- regex: 'Android' - name: Android Browser +############### +# Piwik - Open source web analytics +# +# @link http://piwik.org +# @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later +# +# @category Piwik_Plugins +# @package Piwik_DevicesDetection +############### + +# SeaMonkey +- regex: '(Iceape|SeaMonkey)/(\d+\.\d+)' + name: $1 + version: '$2' + +# Camino +- regex: 'Camino/(\d+\.\d+)' + name: Camino + version: '$1' + +#Fennec (Firefox for mobile) +- regex: 'Fennec/(\d+\.\d+)' + name: Fennec + version: '$1' + +#MicroB +- regex: 'Firefox.*Tablet browser (\d+\.\d+)' + name: MicroB + version: '$1' + +#Firefox +- regex: 'Firefox/(\d+\.\d+)' + name: Firefox + version: '$1' +- regex: '(BonEcho|GranParadiso|Lorentz|Minefield|Namoroka|Shiretoko)/(\d+\.\d+)' + name: Firefox '$1' + version: '$2' + +#Flock +- regex: 'Flock/(\d+\.\d+)' + name: Flock + version: '$1' + +#RockMelt +- regex: 'RockMelt/(\d+\.\d+)' + name: RockMelt + version: '$1' + +#Netscape +- regex: '(?:Navigator|Netscape6)/(\d+\.\d+)' + name: Netscape + version: '$1' + +#Opera +- regex: '(:?Opera Tablet.*Version|Opera/.+Opera Mobi.+Version|Safari.*OPR)/(\d+\.\d+)' + name: Opera Mobile + version: '$2' +- regex: 'Opera Mini/(:?att/)?(\d+\.\d+)' + name: Opera Mini + version: '$2' +- regex: 'Opera[/ ](?:9.80.*Version/)?(\d+\.\d+)' + name: Opera + version: '$1' + +#wOSBrowser +- regex: '(?:hpw|web)OS/(\d+\.\d+)' + name: wOSBrowser + version: '$1' + +#Swiftfox +- regex: 'Firefox/(\d+\.\d+).*\(Swiftfox\)' + name: Swiftfox + version: '$1' + +#Rekonq +- regex: 'rekonq' + name: Rekonq + version: '' + +#Conkeror +- regex: 'Conkeror/(\d+\.\d+)' + name: Conkeror + version: '$1' + +#Konqueror +- regex: 'Konqueror/(\d+\.\d+)' + name: Konqueror + version: '$1' + +#Baidu Browser +- regex: 'baidubrowser[/ ](\d+)' + name: Baidu Browser + version: '$1' + +#Yandex Browser +- regex: 'YaBrowser/(\d+)' + name: Yandex Browser + version: '$1' + +#Chrome +- regex: 'CrMo/(\d+\.\d+)' + name: Chrome Mobile + version: '$1' +- regex: 'CriOS/(\d+\.\d+)' + name: Chrome Mobile iOS + version: '$1' +- regex: 'Chrome/(\d+\.\d+).*Mobile' + name: Chrome Mobile + version: '$1' +- regex: 'chromeframe/(\d+\.\d+)' + name: Chrome Frame + version: '$1' +- regex: 'Chrome/(\d+\.\d+)' + name: Chrome + version: '$1' +- regex: 'Chromium/(\d+\.\d+)' + name: Chromium + version: '$1' + +#UC Browser +- regex: 'UC[ ]?Browser[ /](\d+\.\d+)' + name: UC Browser + version: '$1' +- regex: '(?:UC Browser|UCBrowser|UCWEB)(\d+\.\d+)' + name: UC Browser + version: '$1' + +#Tizen Browser +- regex: '(?:Tizen|SLP) Browser/(\d+\.\d+)' + name: Tizen Browser + version: '$1' + +#Epiphany +- regex: 'Epiphany/(\d+\.\d+)' + name: Epiphany + version: '$1' + +#Fireweb Navigator +- regex: 'Fireweb Navigator/(\d+\.\d+)' + name: Fireweb Navigator + version: '$1' + +#Jasmine +- regex: 'Jasmine[ /](\d+\.\d+)' + name: Jasmine + version: '$1' + +#Lynx +- regex: 'Lynx/(\d+\.\d+)' + name: Lynx + version: '$1' + +#Midori +- regex: 'Midori/(\d+\.\d+)' + name: Midori + version: '$1' + +#NCSA Mosaic +- regex: 'NCSA_Mosaic/(\d+\.\d+)' + name: NCSA Mosaic + version: '$1' + +#ABrowse +- regex: 'ABrowse (\d+\.\d+)' + name: ABrowse + version: '$1' + +#Amaya +- regex: 'amaya/(\d+\.\d+)' + name: Amaya + version: '$1' + +#Amiga Voyager +- regex: 'AmigaVoyager/(\d+\.\d+)' + name: Amiga Voyager + version: '$1' + +#Amiga Aweb +- regex: 'Amiga-Aweb/(\d+\.\d+)' + name: Amiga Aweb + version: '$1' + +#Arora +- regex: 'Arora/(\d+\.\d+)' + name: Arora + version: '$1' + +#Beonex +- regex: 'Beonex/(\d+\.\d+)' + name: Beonex + version: '$1' + +#BlackBerry Browser +- regex: 'Black[bB]erry|PlayBook|BB10' + name: BlackBerry Browser + version: '' + +#BrowseX +- regex: 'BrowseX \((\d+\.\d+)' + name: BrowseX + version: '$1' + +#Cheshire +- regex: 'Cheshire/(\d+\.\d+)' + name: Cheshire + version: '$1' + +#CometBird +- regex: 'CometBird/(\d+\.\d+)' + name: CometBird + version: '$1' + +#Dillo +- regex: 'Dillo/(\d+\.\d+)' + name: Dillo + version: '$1' + +#Dolphin +- regex: 'Dolfin/(\d+\.\d+)|dolphin' + name: Dolphin + version: '$1' + +#Elinks +- regex: 'Elinks/(\d+\.\d+)' + name: Elinks + version: '$1' + +#Firebird +- regex: 'Firebird/(\d+\.\d+)' + name: Firebird + version: '$1' + +#Fluid +- regex: 'Fluid/(\d+\.\d+)' + name: Fluid + version: '$1' + +#Galeon +- regex: 'Galeon/(\d+\.\d+)' + name: Galeon + version: '$1' + +#Google Earth +- regex: 'Google Earth/(\d+\.\d+)' + name: Google Earth + version: '$1' + +#HotJava +- regex: 'HotJava/(\d+\.\d+)' + name: HotJava + version: '$1' + +#IBrowse +- regex: 'IBrowse[ /](\d+\.\d+)' + name: IBrowse + version: '$1' + +#iCab +- regex: 'iCab[ /](\d+\.\d+)' + name: iCab + version: '$1' + +#Internet Explorer +- regex: 'IEMobile[ /](\d+\.\d+)' + name: IE Mobile + version: '$1' +- regex: 'MSIE (\d+\.\d+).*XBLWP7' + name: IE Mobile + version: '$1' +- regex: 'MSIE (\d+\.\d+)' + name: Internet Explorer + version: '$1' + +#Iron +- regex: 'Iron/(\d+\.\d+)' + name: Iron + version: '$1' + +#Kapiko +- regex: 'Kapiko/(\d+\.\d+)' + name: Kapiko + version: '$1' + +#Kazehakase +- regex: 'Kazehakase/(\d+\.\d+)' + name: Kazehakase + version: '$1' + +#Kindle Browser +- regex: 'Kindle/(\d+\.\d+)' + name: Kindle Browser + version: '$1' + +#K-meleon +- regex: 'K-meleon/(\d+\.\d+)' + name: K-meleon + version: '$1' + +#Lightning +- regex: 'Lightning/(\d+\.\d+)' + name: Lightning + version: '$1' + +#Links +- regex: 'Links \((\d+\.\d+)' + name: Links + version: '$1' + +#Maxthon +- regex: 'Maxthon (\d+\.\d+)' + name: Maxthon + version: '$1' +- regex: '(?:Maxthon|MyIE2|Uzbl|Shiira)' + name: Maxthon + version: '' + +#Openwave Mobile Browser +- regex: 'UP.Browser/(\d+\.\d+)' + name: Openwave Mobile Browser + version: '$1' + +#OmniWeb +- regex: 'OmniWeb/[v]?(\d+\.\d+)' + name: OmniWeb + version: '$1' + +#Phoenix +- regex: 'Phoenix/(\d+\.\d+)' + name: Phoenix + version: '$1' + +#Mobile Silk +- regex: 'Silk/(\d+\.\d+)' + name: Mobile Silk + version: '$1' + +#Nokia Browser +- regex: '(?:NokiaBrowser|BrowserNG)/(\d+\.\d+)' + name: Nokia Browser + version: '$1' +- regex: 'Series60/5\.0' + name: Nokia Browser + version: '7.0' +- regex: 'Series60/(\d+\.\d+)' + name: Nokia OSS Browser + version: '$1' +- regex: 'S40OviBrowser/(\d+\.\d+)' + name: Nokia Ovi Browser + version: '$1' +- regex: '^Nokia|Nokia[EN]?\d+' + name: Nokia Browser + version: '' + +#NetFront +- regex: 'NetFrontLifeBrowser/(\d+\.\d+)' + name: NetFront Life + version: '$1' +- regex: 'NetFront/(\d+\.\d+)' + name: NetFront + version: '$1' +- regex: 'PLAYSTATION|NINTENDO 3|AppleWebKit.+ NX/\d+\.\d+\.\d+' + name: NetFront + version: '' + +#Obigo +- regex: 'Obigo[ ]?(?:InternetBrowser|Browser)?[ /]([A-Za-z0-9]*)' + name: Obigo + version: '$1' +- regex: 'Obigo|Teleca' + name: Obigo + version: '' + +#Palm Blazer +- regex: 'Blazer/(\d+\.\d+)' + name: Palm Blazer + version: '$1' +- regex: 'Pre/(\d+\.\d+)' + name: Palm Pre + version: '$1' + +#Polaris +- regex: '(?:Polaris|Embider)/(\d+\.\d+)' + name: Polaris + version: '$1' + +#Snowshoe +- regex: 'Snowshoe/(\d+\.\d+)' + name: Snowshoe + version: '$1' + +#Safari +- regex: '(?:iPod|iPad|iPhone).+Version/(\d+\.\d+)' + name: Mobile Safari + version: '$1' +- regex: 'Version/(\d+\.\d+).*Mobile.*Safari/' + name: Mobile Safari + version: '$1' +- regex: '(?:iPod|iPhone|iPad)' + name: Mobile Safari + version: '' +- regex: 'Version/(\d+\.\d+).*Safari/|Safari/\d+' + name: Safari + version: '$1' + +#Android Browser +- regex: 'Android' + name: Android Browser version: '' \ No newline at end of file diff --git a/plugins/DevicesDetection/UserAgentParserEnhanced/regexes/mobiles.yml b/plugins/DevicesDetection/UserAgentParserEnhanced/regexes/mobiles.yml index 64b1470ef2..d9a2a22f88 100644 --- a/plugins/DevicesDetection/UserAgentParserEnhanced/regexes/mobiles.yml +++ b/plugins/DevicesDetection/UserAgentParserEnhanced/regexes/mobiles.yml @@ -1,958 +1,958 @@ -############### -# Piwik - Open source web analytics -# -# @link http://piwik.org -# @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later -# -# @category Piwik_Plugins -# @package Piwik_DevicesDetection -############### - -# HTC -HTC: - regex: 'HTC|Sprint APA|ADR[A-Za-z0-9]+' - device: 'smartphone' - models: - - regex: 'HTC ([A-Za-z0-9]+) Build' - model: '$1' - - regex: 'HTC ([A-Za-z0-9]+(?: [A-Za-z0-9]+)?)' - model: '$1' - - regex: 'USCCHTC(\d+)' - model: '$1' - - regex: 'Sprint APA(9292)' - model: '$1 (Sprint)' - - regex: 'HTC_([A-Za-z0-9_]+)' - model: '$1' - - regex: 'HTC(?:[\-/ ])?([A-Za-z0-9]+)' - model: '$1' - - regex: 'HTC;(?: )?([A-Za-z0-9 ]+)' - model: '$1' - - regex: '(ADR[A-Za-z0-9]+)' - model: '$1' - -# Tesla Model S -Tesla: - regex: 'QtCarBrowser' - device: 'car browser' - model: 'Model S' - -# Kindle -Kindle: - regex: 'KF(?:OT|TT|JWI|JWA) Build|Kindle|Silk/(\d+)\.(\d+)' - device: 'tablet' - models: - - regex: 'KFOT|Kindle Fire|Silk/(\d+)\.(\d+)' - model: 'Fire' - - regex: 'KFTT' - model: 'Fire HD' - - regex: 'KFJWI' - model: 'Fire HD 8.9" WiFi' - - regex: 'KFJWA' - model: 'Fire HD 8.9" 4G' - -# NOKIA -Nokia: - regex: 'Nokia|Lumia|Maemo RX|portalmmm/2\.0 N7|portalmmm/2\.0 NK|nok[0-9]+|Symbian.*\s([a-zA-Z0-9]+)$' - device: 'smartphone' - models: - - regex: 'NokiaInternal|Nokia-WAP-Toolkit|Nokia-MIT-Browser|Nokia Mobile|Nokia Browser|Nokia/Series' - model: '' - - regex: 'Nokia(N[0-9]+)' - model: '$1' - - regex: 'Nokia-([A-Za-z0-9]+)' - model: 'N$1' - - regex: 'NOKIA; ([A-Za-z0-9\- ]+)' - model: '$1' - - regex: 'NOKIA[ ]?([A-Za-z0-9\-]+)' - model: '$1' - - regex: 'NOKIA/([A-Za-z0-9 ]+)' - model: '$1' - - regex: '(Lumia [A-Za-z0-9\-]+)' - model: '$1' - - regex: 'Maemo RX-51 ([A-Za-z0-9]+)' - model: '$1' - - regex: 'Maemo RX-34' - model: 'N800' - - regex: 'portalmmm/2\.0 (N7[37]|NK[A-Za-z0-9]+)' - model: '$1' - - regex: 'nok([0-9]+)' - model: '$1' - - regex: 'Symbian.*\s([a-zA-Z0-9]+)$' - device: 'feature phone' - model: '$1' - -# RIM/BlackBerry -RIM: - regex: 'BB10;|BlackBerry|rim[0-9]+|PlayBook' - device: 'smartphone' - - models: - - regex: 'BB10; ([A-Za-z0-9\- ]+)\)' - model: 'BlackBerry $1' - - regex: 'PlayBook.+RIM Tablet OS' - model: 'BlackBerry Playbook' - device: 'tablet' - - regex: 'BlackBerry(?: )?([A-Za-z0-9]+)' - model: 'BlackBerry $1' - - regex: 'rim([0-9]+)' - model: 'BlackBerry $1' - - regex: 'BlackBerry' - model: 'BlackBerry' - -# PALM -Palm: - regex: '(?:Pre|Pixi)/(\d+)\.(\d+)|Palm|Treo' - device: 'smartphone' - models: - - regex: '((?:Pre|Pixi))/(\d+\.\d+)' - model: '$1 $2' - - regex: 'Palm(?: )?([A-Za-z0-9]+)' - model: '$1' - - regex: 'Treo([A-Za-z0-9]+)' - model: 'Treo $1' - -# HP -HP: - regex: 'Touch[Pp]ad|hp-tablet|HP(?: )?iPAQ|webOS.*(P160U)' - device: 'smartphone' - models: - - regex: 'Touch[Pp]ad/(\d+\.\d+)|hp-tablet' - model: 'TouchPad' - device: 'tablet' - - regex: 'HP(?: )?iPAQ(?: )?([A-Za-z0-9]+)' - model: 'iPAQ $1' - - regex: 'webOS.*(P160U)' - model: 'Veer' - -# TiPhone -TiPhone: - regex: 'TiPhone(?: )?([A-Za-z0-9]+)' - device: 'smartphone' - model: '$1' - -# Apple -Apple: - regex: 'AppleTV|iPad|iPod|iPhone' - models: - - regex: 'AppleTV' - model: 'Apple TV' - device: 'tv' - - regex: 'iPad' - model: 'iPad' - device: 'tablet' - - regex: 'iPod' - model: 'iPod Touch' - device: 'palmtop' - - regex: 'iPhone' - model: 'iPhone' - device: 'smartphone' - -# Acer -Acer: - regex: 'acer[\-_]([A-Za-z0-9]+)' - device: 'smartphone' - model: '$1' - -# Airness -Airness: - regex: 'AIRNESS-([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# Alcatel -Alcatel: - regex: 'Alcatel|Alc([A-Za-z0-9]+)' - device: 'smartphone' - models: - - regex: 'Alcatel UP' - model: '' - - regex: 'ALCATEL[ \-]([A-Za-z0-9\-]+)' - model: '$1' - - regex: 'ALCATEL_([A-Za-z0-9_]+)' - model: '$1' - - regex: 'Alc([A-Za-z0-9]+)' - model: '$1' - -# Amoi -Amoi: - regex: 'Amoi' - device: 'smartphone' - models: - - regex: 'Amoi[\- /](A-Za-z0-9]+)' - mobile: '$1' - - regex: 'Amoisonic-([A-Za-z0-9]+)' - model: '$1' - -# Asus -Asus: - regex: 'Asus' - device: 'smartphone' - models: - - regex: 'Asus(?:-|;)?([A-Za-z0-9]+)' - model: '$1' - - regex: 'ASUS (Transformer Pad TF300T)' - device: 'tablet' - model: '$1' - -# Audiovox -Audiovox: - regex: 'Audiovox|CDM|UTS(?:TARCOM)?\-|audio([A-Za-z0-9\-]+)' - device: 'smartphone' - models: - - regex: 'Audiovox[_\-]([A-Za-z0-9\-]+)' - model: '$1' - - regex: 'CDM(?:-)?([A-Za-z0-9]+)' - model: 'CDM-$1' - - regex: 'UTS(?:TARCOM)?-([A-Za-z0-9\-]+)' - model: 'CDM-$1' - - regex: 'audio([A-Za-z0-9\-]+)' - model: 'CDM-$1' - -# Avvio -Avvio: - regex: 'Avvio[ _]([A-Za-z0-9\-]+)' - device: 'smartphone' - model: '$1' - -# Bird -Bird: - regex: 'BIRD[\-. _]([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# Becker -Becker: - regex: 'Becker-([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# Beetel -Beetel: - regex: 'Beetel ([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# BenQ-Siemens -BenQ-Siemens: - regex: 'BENQ-SIEMENS - ([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# BenQ -BenQ: - regex: 'BENQ(?:[ \-])?([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# Capitel -Capitel: - regex: 'Capitel-([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# Compal -Compal: - regex: 'Compal-([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# Cricket -Cricket: - regex: 'Cricket-([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# Dell -Dell: - regex: 'Dell ([A-Za-z0-9]+)' - device: 'smartphone' - model: '$1' - -# Dbtel -Dbtel: - regex: 'DBTEL(?:[\-/])?([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# Dicam -Dicam: - regex: 'DICAM-([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# DoCoMo -DoCoMo: - regex: 'DoCoMo|\;FOMA|KGT/1\.0' - device: 'feature phone' - models: - - regex: 'DoCoMo/[12]\.0[/ ]([A-Za-z0-9]+)' - model: '$1' - - regex: '([A-Za-z0-9]+)(?:_W)?\;FOMA' - model: '$1' - - regex: 'KGT/1\.0 ([A-Za-z0-9]+)' - model: '$1' - -# Dopod -Dopod: - regex: 'Dopod(?: )?([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# Ericy -Ericy: - regex: 'Ericy-([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# Sony Ericsson -Sony Ericsson: - regex: 'Sony(?: )?Ericsson|portalmmm/2\.0 K' - device: 'smartphone' - models: - - regex: 'SonyEricsson([A-Za-z0-9]+)' - model: '$1' - - regex: 'Sony(?: )?Ericsson ([A-Za-z0-9\-]+)' - model: '$1' - - regex: 'portalmmm/2.0 K([A-Za-z0-9]+)' - model: 'K$1' - -# Ericsson -Ericsson: - regex: 'Ericsson(?:/ )?([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# eTouch -eTouch: - regex: 'eTouch(?: )?([A-Za-z0-9]+)' - device: 'smartphone' - model: '$1' - -# Ezze -Ezze: - regex: 'EZZE-|EZ([A-Za-z0-9]+)' - device: 'feature phone' - models: - - regex: 'EZZE-([A-Za-z0-9]+)' - model: '$1' - - regex: 'EZ([A-Za-z0-9]+)' - model: 'EZ$1' - -# Ezio -Ezio: - regex: 'EZIO-([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# Gionee -Gionee: - regex: 'GIONEE-([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# Google -Google: - regex: 'Nexus|GoogleTV' - device: 'smartphone' - models: - - regex: '(Galaxy Nexus)' - model: '$1' - - regex: '(Nexus (:?S|4|One))' - model: '$1' - - regex: '(Nexus (:?7|10))' - device: 'tablet' - model: '$1' - - regex: '(GoogleTV)' - device: 'tv' - model: '$1' - -# Gradiente -Gradiente: - regex: 'GRADIENTE' - device: 'feature phone' - models: - - regex: 'GRADIENTE-([A-Za-z0-9]+)' - model: '$1' - - regex: 'GRADIENTE ([A-Za-z0-9\-]+)' - model: '$1' - -# Grundig -Grundig: - regex: 'GRUNDIG|portalmmm/2\.0 G' - device: 'tv' - models: - - regex: 'GRUNDIG ([A-Za-z0-9]+)' - model: '$1' - - regex: 'portalmmm/2\.0 G([A-Za-z0-9]+)' - model: 'G$1' - -# Haier -Haier: - regex: 'Haier[ -]([A-Za-z0-9\-]+)' - device: 'feature phone' - model: '$1' - -# Huawei -Huawei: - regex: 'Huawei|vodafone([A-Za-z0-9]+)' - device: 'smartphone' - models: - - regex: 'Huawei(?:[\- /_]|/1\.0/)?([A-Za-z0-9]+)' - model: '$1' - - regex: 'vodafone([A-Za-z0-9]+)' - model: 'Vodafone $1' - -# Innostream -Innostream: - regex: 'INNO([A-Za-z0-9]+)' - device: 'feature phone' - model: 'INNO$1' - -# Inq -INQ: - regex: 'INQ/([A-Za-z0-9\-]+)' - device: 'feature phone' - model: '$1' - -# i-mate -i-mate: - regex: 'i-mate ([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# i-mobile -i-mobile: - regex: 'i-mobile(?: )?([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# ikomo -iKoMo: - regex: 'iKoMo ([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# kddi -KDDI: - regex: 'kddi-([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# kyocera -Kyocera: - regex: 'Kyocera|KWC-|QC-' - device: 'smartphone' - models: - - regex: 'Kyocera-KZ-([A-Za-z0-9]+)' - model: 'KZ $1' - - regex: 'Kyocera(:?[\-/])?([A-Za-z0-9]+)' - model: '$1' - - regex: '(?:KWC|QC)-([A-Za-z0-9]+)' - model: '$1' - -# lanix -Lanix: - regex: 'LANIX-([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# lct -LCT: - regex: 'LCT_([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# lenovo -Lenovo: - regex: 'Lenovo[\-_]([A-Za-z0-9]+)' - device: 'smartphone' - model: '$1' - -# lguplus -LGUPlus: - regex: 'LGUPlus' - device: 'smartphone' - model: '' - -# lg -LG: - regex: 'LG|portalmmm/2\.0 (?:KE|KG|KP|L3)|VX[0-9]+' - device: 'smartphone' - models: - - regex: 'LGE_DLNA_SDK' - device: 'tv' - model: 'NetCast' - - regex: 'LGE(?: |-LG| LG-AX|-)([A-Za-z0-9]+)' - model: '$1' - - regex: 'LGE;([A-Za-z0-9\-]+)' - model: '$1' - - regex: 'LG(?:/|-LG| |-)?([A-Za-z0-9]+)' - model: '$1' - - regex: 'LG; ([A-Za-z0-9 ]+)' - model: '$1' - - regex: 'portalmmm/2.0 ((?:KE|KG|KP|L3)[A-Za-z0-9]+)' - model: '$1' - - regex: '(VX[0-9]+)' - model: '$1' - -# microsoft -Microsoft: - regex: 'Xbox|KIN\.(?:One|Two)' - device: 'console' - model: 'Xbox 360' - -# Konka -Konka: - regex: 'KONKA_([A-Za-z0-9]+)' - device: 'feature phone' - model: '$1' - -# Karbonn -Karbonn: - regex: 'Karbonn_([A-Za-z0-9]+)' - device: 'smartphone' - model: '$1' - -# Sagem -Sagem: - regex: 'SAGEM|portalmmm/2.0 (?:SG|my)' - device: 'smartphone' - models: - - regex: 'SAGEM ([A-Za-z0-9]+)' - model: '$1' - - regex: 'SAGEM-([A-Za-z0-9\-]+)' - model: '$1' - - regex: 'portalmmm/2.0 ((?:SG|my)[A-Za-z0-9]+)' - model: '$1' - -# micromax -MicroMax: - regex: 'MicroMax(?:[ \-])?([A-Za-z0-9]+)' - device: 'smartphone' - model: '$1' - -# mio -Mio: - regex: 'MIO(?:/)?([A-Za-z0-9]+)' - device: 'smartphone' - model: '$1' - -# mitsubishi -Mitsubishi: - regex: 'MITSU|portalmmm/[12]\.0 M' - device: 'feature phone' - models: - - regex: 'MITSU/[A-Za-z0-9.]+ \(([A-Za-z0-9]+)\)' - model: '$1' - - regex: 'MITSU[ \-]?([A-Za-z0-9]+)' - model: '$1' - - regex: 'portalmmm/[12]\.0 (M[A-Za-z0-9]+)' - model: '$1' - -# motorola -Motorola: - regex: 'MOT|(? - * @author Chris Wanstrath - * @link http://code.google.com/p/spyc/ - * @copyright Copyright 2005-2006 Chris Wanstrath, 2006-2011 Vlad Andersen - * @license http://www.opensource.org/licenses/mit-license.php MIT License - * @package Spyc - */ - -if (!function_exists('spyc_load')) { - /** - * Parses YAML to array. - * @param string $string YAML string. - * @return array - */ - function spyc_load ($string) { - return Spyc::YAMLLoadString($string); - } -} - -if (!function_exists('spyc_load_file')) { - /** - * Parses YAML to array. - * @param string $file Path to YAML file. - * @return array - */ - function spyc_load_file ($file) { - return Spyc::YAMLLoad($file); - } -} - -/** - * The Simple PHP YAML Class. - * - * This class can be used to read a YAML file and convert its contents - * into a PHP array. It currently supports a very limited subsection of - * the YAML spec. - * - * Usage: - * - * $Spyc = new Spyc; - * $array = $Spyc->load($file); - * - * or: - * - * $array = Spyc::YAMLLoad($file); - * - * or: - * - * $array = spyc_load_file($file); - * - * @package Spyc - */ -class Spyc { - - // SETTINGS - - const REMPTY = "\0\0\0\0\0"; - - /** - * Setting this to true will force YAMLDump to enclose any string value in - * quotes. False by default. - * - * @var bool - */ - public $setting_dump_force_quotes = false; - - /** - * Setting this to true will forse YAMLLoad to use syck_load function when - * possible. False by default. - * @var bool - */ - public $setting_use_syck_is_possible = false; - - - - /**#@+ - * @access private - * @var mixed - */ - private $_dumpIndent; - private $_dumpWordWrap; - private $_containsGroupAnchor = false; - private $_containsGroupAlias = false; - private $path; - private $result; - private $LiteralPlaceHolder = '___YAML_Literal_Block___'; - private $SavedGroups = array(); - private $indent; - /** - * Path modifier that should be applied after adding current element. - * @var array - */ - private $delayedPath = array(); - - /**#@+ - * @access public - * @var mixed - */ - public $_nodeId; - -/** - * Load a valid YAML string to Spyc. - * @param string $input - * @return array - */ - public function load ($input) { - return $this->__loadString($input); - } - - /** - * Load a valid YAML file to Spyc. - * @param string $file - * @return array - */ - public function loadFile ($file) { - return $this->__load($file); - } - - /** - * Load YAML into a PHP array statically - * - * The load method, when supplied with a YAML stream (string or file), - * will do its best to convert YAML in a file into a PHP array. Pretty - * simple. - * Usage: - * - * $array = Spyc::YAMLLoad('lucky.yaml'); - * print_r($array); - * - * @access public - * @return array - * @param string $input Path of YAML file or string containing YAML - */ - public static function YAMLLoad($input) { - $Spyc = new Spyc; - return $Spyc->__load($input); - } - - /** - * Load a string of YAML into a PHP array statically - * - * The load method, when supplied with a YAML string, will do its best - * to convert YAML in a string into a PHP array. Pretty simple. - * - * Note: use this function if you don't want files from the file system - * loaded and processed as YAML. This is of interest to people concerned - * about security whose input is from a string. - * - * Usage: - * - * $array = Spyc::YAMLLoadString("---\n0: hello world\n"); - * print_r($array); - * - * @access public - * @return array - * @param string $input String containing YAML - */ - public static function YAMLLoadString($input) { - $Spyc = new Spyc; - return $Spyc->__loadString($input); - } - - /** - * Dump YAML from PHP array statically - * - * The dump method, when supplied with an array, will do its best - * to convert the array into friendly YAML. Pretty simple. Feel free to - * save the returned string as nothing.yaml and pass it around. - * - * Oh, and you can decide how big the indent is and what the wordwrap - * for folding is. Pretty cool -- just pass in 'false' for either if - * you want to use the default. - * - * Indent's default is 2 spaces, wordwrap's default is 40 characters. And - * you can turn off wordwrap by passing in 0. - * - * @access public - * @return string - * @param array $array PHP array - * @param int $indent Pass in false to use the default, which is 2 - * @param int $wordwrap Pass in 0 for no wordwrap, false for default (40) - */ - public static function YAMLDump($array,$indent = false,$wordwrap = false) { - $spyc = new Spyc; - return $spyc->dump($array,$indent,$wordwrap); - } - - - /** - * Dump PHP array to YAML - * - * The dump method, when supplied with an array, will do its best - * to convert the array into friendly YAML. Pretty simple. Feel free to - * save the returned string as tasteful.yaml and pass it around. - * - * Oh, and you can decide how big the indent is and what the wordwrap - * for folding is. Pretty cool -- just pass in 'false' for either if - * you want to use the default. - * - * Indent's default is 2 spaces, wordwrap's default is 40 characters. And - * you can turn off wordwrap by passing in 0. - * - * @access public - * @return string - * @param array $array PHP array - * @param int $indent Pass in false to use the default, which is 2 - * @param int $wordwrap Pass in 0 for no wordwrap, false for default (40) - */ - public function dump($array,$indent = false,$wordwrap = false) { - // Dumps to some very clean YAML. We'll have to add some more features - // and options soon. And better support for folding. - - // New features and options. - if ($indent === false or !is_numeric($indent)) { - $this->_dumpIndent = 2; - } else { - $this->_dumpIndent = $indent; - } - - if ($wordwrap === false or !is_numeric($wordwrap)) { - $this->_dumpWordWrap = 40; - } else { - $this->_dumpWordWrap = $wordwrap; - } - - // New YAML document - $string = "---\n"; - - // Start at the base of the array and move through it. - if ($array) { - $array = (array)$array; - $previous_key = -1; - foreach ($array as $key => $value) { - if (!isset($first_key)) $first_key = $key; - $string .= $this->_yamlize($key,$value,0,$previous_key, $first_key, $array); - $previous_key = $key; - } - } - return $string; - } - - /** - * Attempts to convert a key / value array item to YAML - * @access private - * @return string - * @param $key The name of the key - * @param $value The value of the item - * @param $indent The indent of the current node - */ - private function _yamlize($key,$value,$indent, $previous_key = -1, $first_key = 0, $source_array = null) { - if (is_array($value)) { - if (empty ($value)) - return $this->_dumpNode($key, array(), $indent, $previous_key, $first_key, $source_array); - // It has children. What to do? - // Make it the right kind of item - $string = $this->_dumpNode($key, self::REMPTY, $indent, $previous_key, $first_key, $source_array); - // Add the indent - $indent += $this->_dumpIndent; - // Yamlize the array - $string .= $this->_yamlizeArray($value,$indent); - } elseif (!is_array($value)) { - // It doesn't have children. Yip. - $string = $this->_dumpNode($key, $value, $indent, $previous_key, $first_key, $source_array); - } - return $string; - } - - /** - * Attempts to convert an array to YAML - * @access private - * @return string - * @param $array The array you want to convert - * @param $indent The indent of the current level - */ - private function _yamlizeArray($array,$indent) { - if (is_array($array)) { - $string = ''; - $previous_key = -1; - foreach ($array as $key => $value) { - if (!isset($first_key)) $first_key = $key; - $string .= $this->_yamlize($key, $value, $indent, $previous_key, $first_key, $array); - $previous_key = $key; - } - return $string; - } else { - return false; - } - } - - /** - * Returns YAML from a key and a value - * @access private - * @return string - * @param $key The name of the key - * @param $value The value of the item - * @param $indent The indent of the current node - */ - private function _dumpNode($key, $value, $indent, $previous_key = -1, $first_key = 0, $source_array = null) { - // do some folding here, for blocks - if (is_string ($value) && ((strpos($value,"\n") !== false || strpos($value,": ") !== false || strpos($value,"- ") !== false || - strpos($value,"*") !== false || strpos($value,"#") !== false || strpos($value,"<") !== false || strpos($value,">") !== false || strpos ($value, ' ') !== false || - strpos($value,"[") !== false || strpos($value,"]") !== false || strpos($value,"{") !== false || strpos($value,"}") !== false) || strpos($value,"&") !== false || strpos($value, "'") !== false || strpos($value, "!") === 0 || - substr ($value, -1, 1) == ':') - ) { - $value = $this->_doLiteralBlock($value,$indent); - } else { - $value = $this->_doFolding($value,$indent); - } - - if ($value === array()) $value = '[ ]'; - if (in_array ($value, array ('true', 'TRUE', 'false', 'FALSE', 'y', 'Y', 'n', 'N', 'null', 'NULL'), true)) { - $value = $this->_doLiteralBlock($value,$indent); - } - if (trim ($value) != $value) - $value = $this->_doLiteralBlock($value,$indent); - - if (is_bool($value)) { - $value = ($value) ? "true" : "false"; - } - - if ($value === null) $value = 'null'; - if ($value === "'" . self::REMPTY . "'") $value = null; - - $spaces = str_repeat(' ',$indent); - - //if (is_int($key) && $key - 1 == $previous_key && $first_key===0) { - if (is_array ($source_array) && array_keys($source_array) === range(0, count($source_array) - 1)) { - // It's a sequence - $string = $spaces.'- '.$value."\n"; - } else { - // if ($first_key===0) throw new Exception('Keys are all screwy. The first one was zero, now it\'s "'. $key .'"'); - // It's mapped - if (strpos($key, ":") !== false || strpos($key, "#") !== false) { $key = '"' . $key . '"'; } - $string = rtrim ($spaces.$key.': '.$value)."\n"; - } - return $string; - } - - /** - * Creates a literal block for dumping - * @access private - * @return string - * @param $value - * @param $indent int The value of the indent - */ - private function _doLiteralBlock($value,$indent) { - if ($value === "\n") return '\n'; - if (strpos($value, "\n") === false && strpos($value, "'") === false) { - return sprintf ("'%s'", $value); - } - if (strpos($value, "\n") === false && strpos($value, '"') === false) { - return sprintf ('"%s"', $value); - } - $exploded = explode("\n",$value); - $newValue = '|'; - $indent += $this->_dumpIndent; - $spaces = str_repeat(' ',$indent); - foreach ($exploded as $line) { - $newValue .= "\n" . $spaces . ($line); - } - return $newValue; - } - - /** - * Folds a string of text, if necessary - * @access private - * @return string - * @param $value The string you wish to fold - */ - private function _doFolding($value,$indent) { - // Don't do anything if wordwrap is set to 0 - - if ($this->_dumpWordWrap !== 0 && is_string ($value) && strlen($value) > $this->_dumpWordWrap) { - $indent += $this->_dumpIndent; - $indent = str_repeat(' ',$indent); - $wrapped = wordwrap($value,$this->_dumpWordWrap,"\n$indent"); - $value = ">\n".$indent.$wrapped; - } else { - if ($this->setting_dump_force_quotes && is_string ($value) && $value !== self::REMPTY) - $value = '"' . $value . '"'; - } - - - return $value; - } - -// LOADING FUNCTIONS - - private function __load($input) { - $Source = $this->loadFromSource($input); - return $this->loadWithSource($Source); - } - - private function __loadString($input) { - $Source = $this->loadFromString($input); - return $this->loadWithSource($Source); - } - - private function loadWithSource($Source) { - if (empty ($Source)) return array(); - if ($this->setting_use_syck_is_possible && function_exists ('syck_load')) { - $array = syck_load (implode ('', $Source)); - return is_array($array) ? $array : array(); - } - - $this->path = array(); - $this->result = array(); - - $cnt = count($Source); - for ($i = 0; $i < $cnt; $i++) { - $line = $Source[$i]; - - $this->indent = strlen($line) - strlen(ltrim($line)); - $tempPath = $this->getParentPathByIndent($this->indent); - $line = self::stripIndent($line, $this->indent); - if (self::isComment($line)) continue; - if (self::isEmpty($line)) continue; - $this->path = $tempPath; - - $literalBlockStyle = self::startsLiteralBlock($line); - if ($literalBlockStyle) { - $line = rtrim ($line, $literalBlockStyle . " \n"); - $literalBlock = ''; - $line .= $this->LiteralPlaceHolder; - $literal_block_indent = strlen($Source[$i+1]) - strlen(ltrim($Source[$i+1])); - while (++$i < $cnt && $this->literalBlockContinues($Source[$i], $this->indent)) { - $literalBlock = $this->addLiteralLine($literalBlock, $Source[$i], $literalBlockStyle, $literal_block_indent); - } - $i--; - } - - while (++$i < $cnt && self::greedilyNeedNextLine($line)) { - $line = rtrim ($line, " \n\t\r") . ' ' . ltrim ($Source[$i], " \t"); - } - $i--; - - - - if (strpos ($line, '#')) { - if (strpos ($line, '"') === false && strpos ($line, "'") === false) - $line = preg_replace('/\s+#(.+)$/','',$line); - } - - $lineArray = $this->_parseLine($line); - - if ($literalBlockStyle) - $lineArray = $this->revertLiteralPlaceHolder ($lineArray, $literalBlock); - - $this->addArray($lineArray, $this->indent); - - foreach ($this->delayedPath as $indent => $delayedPath) - $this->path[$indent] = $delayedPath; - - $this->delayedPath = array(); - - } - return $this->result; - } - - private function loadFromSource ($input) { - if (!empty($input) && strpos($input, "\n") === false && file_exists($input)) - return file($input); - - return $this->loadFromString($input); - } - - private function loadFromString ($input) { - $lines = explode("\n",$input); - foreach ($lines as $k => $_) { - $lines[$k] = rtrim ($_, "\r"); - } - return $lines; - } - - /** - * Parses YAML code and returns an array for a node - * @access private - * @return array - * @param string $line A line from the YAML file - */ - private function _parseLine($line) { - if (!$line) return array(); - $line = trim($line); - if (!$line) return array(); - - $array = array(); - - $group = $this->nodeContainsGroup($line); - if ($group) { - $this->addGroup($line, $group); - $line = $this->stripGroup ($line, $group); - } - - if ($this->startsMappedSequence($line)) - return $this->returnMappedSequence($line); - - if ($this->startsMappedValue($line)) - return $this->returnMappedValue($line); - - if ($this->isArrayElement($line)) - return $this->returnArrayElement($line); - - if ($this->isPlainArray($line)) - return $this->returnPlainArray($line); - - - return $this->returnKeyValuePair($line); - - } - - /** - * Finds the type of the passed value, returns the value as the new type. - * @access private - * @param string $value - * @return mixed - */ - private function _toType($value) { - if ($value === '') return null; - $first_character = $value[0]; - $last_character = substr($value, -1, 1); - - $is_quoted = false; - do { - if (!$value) break; - if ($first_character != '"' && $first_character != "'") break; - if ($last_character != '"' && $last_character != "'") break; - $is_quoted = true; - } while (0); - - if ($is_quoted) - return strtr(substr ($value, 1, -1), array ('\\"' => '"', '\'\'' => '\'', '\\\'' => '\'')); - - if (strpos($value, ' #') !== false && !$is_quoted) - $value = preg_replace('/\s+#(.+)$/','',$value); - - if (!$is_quoted) $value = str_replace('\n', "\n", $value); - - if ($first_character == '[' && $last_character == ']') { - // Take out strings sequences and mappings - $innerValue = trim(substr ($value, 1, -1)); - if ($innerValue === '') return array(); - $explode = $this->_inlineEscape($innerValue); - // Propagate value array - $value = array(); - foreach ($explode as $v) { - $value[] = $this->_toType($v); - } - return $value; - } - - if (strpos($value,': ')!==false && $first_character != '{') { - $array = explode(': ',$value); - $key = trim($array[0]); - array_shift($array); - $value = trim(implode(': ',$array)); - $value = $this->_toType($value); - return array($key => $value); - } - - if ($first_character == '{' && $last_character == '}') { - $innerValue = trim(substr ($value, 1, -1)); - if ($innerValue === '') return array(); - // Inline Mapping - // Take out strings sequences and mappings - $explode = $this->_inlineEscape($innerValue); - // Propagate value array - $array = array(); - foreach ($explode as $v) { - $SubArr = $this->_toType($v); - if (empty($SubArr)) continue; - if (is_array ($SubArr)) { - $array[key($SubArr)] = $SubArr[key($SubArr)]; continue; - } - $array[] = $SubArr; - } - return $array; - } - - if ($value == 'null' || $value == 'NULL' || $value == 'Null' || $value == '' || $value == '~') { - return null; - } - - if ( is_numeric($value) && preg_match ('/^(-|)[1-9]+[0-9]*$/', $value) ){ - $intvalue = (int)$value; - if ($intvalue != PHP_INT_MAX) - $value = $intvalue; - return $value; - } - - if (in_array($value, - array('true', 'on', '+', 'yes', 'y', 'True', 'TRUE', 'On', 'ON', 'YES', 'Yes', 'Y'))) { - return true; - } - - if (in_array(strtolower($value), - array('false', 'off', '-', 'no', 'n'))) { - return false; - } - - if (is_numeric($value)) { - if ($value === '0') return 0; - if (rtrim ($value, 0) === $value) - $value = (float)$value; - return $value; - } - - return $value; - } - - /** - * Used in inlines to check for more inlines or quoted strings - * @access private - * @return array - */ - private function _inlineEscape($inline) { - // There's gotta be a cleaner way to do this... - // While pure sequences seem to be nesting just fine, - // pure mappings and mappings with sequences inside can't go very - // deep. This needs to be fixed. - - $seqs = array(); - $maps = array(); - $saved_strings = array(); - - // Check for strings - $regex = '/(?:(")|(?:\'))((?(1)[^"]+|[^\']+))(?(1)"|\')/'; - if (preg_match_all($regex,$inline,$strings)) { - $saved_strings = $strings[0]; - $inline = preg_replace($regex,'YAMLString',$inline); - } - unset($regex); - - $i = 0; - do { - - // Check for sequences - while (preg_match('/\[([^{}\[\]]+)\]/U',$inline,$matchseqs)) { - $seqs[] = $matchseqs[0]; - $inline = preg_replace('/\[([^{}\[\]]+)\]/U', ('YAMLSeq' . (count($seqs) - 1) . 's'), $inline, 1); - } - - // Check for mappings - while (preg_match('/{([^\[\]{}]+)}/U',$inline,$matchmaps)) { - $maps[] = $matchmaps[0]; - $inline = preg_replace('/{([^\[\]{}]+)}/U', ('YAMLMap' . (count($maps) - 1) . 's'), $inline, 1); - } - - if ($i++ >= 10) break; - - } while (strpos ($inline, '[') !== false || strpos ($inline, '{') !== false); - - $explode = explode(', ',$inline); - $stringi = 0; $i = 0; - - while (1) { - - // Re-add the sequences - if (!empty($seqs)) { - foreach ($explode as $key => $value) { - if (strpos($value,'YAMLSeq') !== false) { - foreach ($seqs as $seqk => $seq) { - $explode[$key] = str_replace(('YAMLSeq'.$seqk.'s'),$seq,$value); - $value = $explode[$key]; - } - } - } - } - - // Re-add the mappings - if (!empty($maps)) { - foreach ($explode as $key => $value) { - if (strpos($value,'YAMLMap') !== false) { - foreach ($maps as $mapk => $map) { - $explode[$key] = str_replace(('YAMLMap'.$mapk.'s'), $map, $value); - $value = $explode[$key]; - } - } - } - } - - - // Re-add the strings - if (!empty($saved_strings)) { - foreach ($explode as $key => $value) { - while (strpos($value,'YAMLString') !== false) { - $explode[$key] = preg_replace('/YAMLString/',$saved_strings[$stringi],$value, 1); - unset($saved_strings[$stringi]); - ++$stringi; - $value = $explode[$key]; - } - } - } - - $finished = true; - foreach ($explode as $key => $value) { - if (strpos($value,'YAMLSeq') !== false) { - $finished = false; break; - } - if (strpos($value,'YAMLMap') !== false) { - $finished = false; break; - } - if (strpos($value,'YAMLString') !== false) { - $finished = false; break; - } - } - if ($finished) break; - - $i++; - if ($i > 10) - break; // Prevent infinite loops. - } - - return $explode; - } - - private function literalBlockContinues ($line, $lineIndent) { - if (!trim($line)) return true; - if (strlen($line) - strlen(ltrim($line)) > $lineIndent) return true; - return false; - } - - private function referenceContentsByAlias ($alias) { - do { - if (!isset($this->SavedGroups[$alias])) { echo "Bad group name: $alias."; break; } - $groupPath = $this->SavedGroups[$alias]; - $value = $this->result; - foreach ($groupPath as $k) { - $value = $value[$k]; - } - } while (false); - return $value; - } - - private function addArrayInline ($array, $indent) { - $CommonGroupPath = $this->path; - if (empty ($array)) return false; - - foreach ($array as $k => $_) { - $this->addArray(array($k => $_), $indent); - $this->path = $CommonGroupPath; - } - return true; - } - - private function addArray ($incoming_data, $incoming_indent) { - - // print_r ($incoming_data); - - if (count ($incoming_data) > 1) - return $this->addArrayInline ($incoming_data, $incoming_indent); - - $key = key ($incoming_data); - $value = isset($incoming_data[$key]) ? $incoming_data[$key] : null; - if ($key === '__!YAMLZero') $key = '0'; - - if ($incoming_indent == 0 && !$this->_containsGroupAlias && !$this->_containsGroupAnchor) { // Shortcut for root-level values. - if ($key || $key === '' || $key === '0') { - $this->result[$key] = $value; - } else { - $this->result[] = $value; end ($this->result); $key = key ($this->result); - } - $this->path[$incoming_indent] = $key; - return; - } - - - - $history = array(); - // Unfolding inner array tree. - $history[] = $_arr = $this->result; - foreach ($this->path as $k) { - $history[] = $_arr = $_arr[$k]; - } - - if ($this->_containsGroupAlias) { - $value = $this->referenceContentsByAlias($this->_containsGroupAlias); - $this->_containsGroupAlias = false; - } - - - // Adding string or numeric key to the innermost level or $this->arr. - if (is_string($key) && $key == '<<') { - if (!is_array ($_arr)) { $_arr = array (); } - - $_arr = array_merge ($_arr, $value); - } else if ($key || $key === '' || $key === '0') { - if (!is_array ($_arr)) - $_arr = array ($key=>$value); - else - $_arr[$key] = $value; - } else { - if (!is_array ($_arr)) { $_arr = array ($value); $key = 0; } - else { $_arr[] = $value; end ($_arr); $key = key ($_arr); } - } - - $reverse_path = array_reverse($this->path); - $reverse_history = array_reverse ($history); - $reverse_history[0] = $_arr; - $cnt = count($reverse_history) - 1; - for ($i = 0; $i < $cnt; $i++) { - $reverse_history[$i+1][$reverse_path[$i]] = $reverse_history[$i]; - } - $this->result = $reverse_history[$cnt]; - - $this->path[$incoming_indent] = $key; - - if ($this->_containsGroupAnchor) { - $this->SavedGroups[$this->_containsGroupAnchor] = $this->path; - if (is_array ($value)) { - $k = key ($value); - if (!is_int ($k)) { - $this->SavedGroups[$this->_containsGroupAnchor][$incoming_indent + 2] = $k; - } - } - $this->_containsGroupAnchor = false; - } - - } - - private static function startsLiteralBlock ($line) { - $lastChar = substr (trim($line), -1); - if ($lastChar != '>' && $lastChar != '|') return false; - if ($lastChar == '|') return $lastChar; - // HTML tags should not be counted as literal blocks. - if (preg_match ('#<.*?>$#', $line)) return false; - return $lastChar; - } - - private static function greedilyNeedNextLine($line) { - $line = trim ($line); - if (!strlen($line)) return false; - if (substr ($line, -1, 1) == ']') return false; - if ($line[0] == '[') return true; - if (preg_match ('#^[^:]+?:\s*\[#', $line)) return true; - return false; - } - - private function addLiteralLine ($literalBlock, $line, $literalBlockStyle, $indent = -1) { - $line = self::stripIndent($line, $indent); - if ($literalBlockStyle !== '|') { - $line = self::stripIndent($line); - } - $line = rtrim ($line, "\r\n\t ") . "\n"; - if ($literalBlockStyle == '|') { - return $literalBlock . $line; - } - if (strlen($line) == 0) - return rtrim($literalBlock, ' ') . "\n"; - if ($line == "\n" && $literalBlockStyle == '>') { - return rtrim ($literalBlock, " \t") . "\n"; - } - if ($line != "\n") - $line = trim ($line, "\r\n ") . " "; - return $literalBlock . $line; - } - - function revertLiteralPlaceHolder ($lineArray, $literalBlock) { - foreach ($lineArray as $k => $_) { - if (is_array($_)) - $lineArray[$k] = $this->revertLiteralPlaceHolder ($_, $literalBlock); - else if (substr($_, -1 * strlen ($this->LiteralPlaceHolder)) == $this->LiteralPlaceHolder) - $lineArray[$k] = rtrim ($literalBlock, " \r\n"); - } - return $lineArray; - } - - private static function stripIndent ($line, $indent = -1) { - if ($indent == -1) $indent = strlen($line) - strlen(ltrim($line)); - return substr ($line, $indent); - } - - private function getParentPathByIndent ($indent) { - if ($indent == 0) return array(); - $linePath = $this->path; - do { - end($linePath); $lastIndentInParentPath = key($linePath); - if ($indent <= $lastIndentInParentPath) array_pop ($linePath); - } while ($indent <= $lastIndentInParentPath); - return $linePath; - } - - - private function clearBiggerPathValues ($indent) { - - - if ($indent == 0) $this->path = array(); - if (empty ($this->path)) return true; - - foreach ($this->path as $k => $_) { - if ($k > $indent) unset ($this->path[$k]); - } - - return true; - } - - - private static function isComment ($line) { - if (!$line) return false; - if ($line[0] == '#') return true; - if (trim($line, " \r\n\t") == '---') return true; - return false; - } - - private static function isEmpty ($line) { - return (trim ($line) === ''); - } - - - private function isArrayElement ($line) { - if (!$line) return false; - if ($line[0] != '-') return false; - if (strlen ($line) > 3) - if (substr($line,0,3) == '---') return false; - - return true; - } - - private function isHashElement ($line) { - return strpos($line, ':'); - } - - private function isLiteral ($line) { - if ($this->isArrayElement($line)) return false; - if ($this->isHashElement($line)) return false; - return true; - } - - - private static function unquote ($value) { - if (!$value) return $value; - if (!is_string($value)) return $value; - if ($value[0] == '\'') return trim ($value, '\''); - if ($value[0] == '"') return trim ($value, '"'); - return $value; - } - - private function startsMappedSequence ($line) { - return ($line[0] == '-' && substr ($line, -1, 1) == ':'); - } - - private function returnMappedSequence ($line) { - $array = array(); - $key = self::unquote(trim(substr($line,1,-1))); - $array[$key] = array(); - $this->delayedPath = array(strpos ($line, $key) + $this->indent => $key); - return array($array); - } - - private function returnMappedValue ($line) { - $array = array(); - $key = self::unquote (trim(substr($line,0,-1))); - $array[$key] = ''; - return $array; - } - - private function startsMappedValue ($line) { - return (substr ($line, -1, 1) == ':'); - } - - private function isPlainArray ($line) { - return ($line[0] == '[' && substr ($line, -1, 1) == ']'); - } - - private function returnPlainArray ($line) { - return $this->_toType($line); - } - - private function returnKeyValuePair ($line) { - $array = array(); - $key = ''; - if (strpos ($line, ':')) { - // It's a key/value pair most likely - // If the key is in double quotes pull it out - if (($line[0] == '"' || $line[0] == "'") && preg_match('/^(["\'](.*)["\'](\s)*:)/',$line,$matches)) { - $value = trim(str_replace($matches[1],'',$line)); - $key = $matches[2]; - } else { - // Do some guesswork as to the key and the value - $explode = explode(':',$line); - $key = trim($explode[0]); - array_shift($explode); - $value = trim(implode(':',$explode)); - } - // Set the type of the value. Int, string, etc - $value = $this->_toType($value); - if ($key === '0') $key = '__!YAMLZero'; - $array[$key] = $value; - } else { - $array = array ($line); - } - return $array; - - } - - - private function returnArrayElement ($line) { - if (strlen($line) <= 1) return array(array()); // Weird %) - $array = array(); - $value = trim(substr($line,1)); - $value = $this->_toType($value); - $array[] = $value; - return $array; - } - - - private function nodeContainsGroup ($line) { - $symbolsForReference = 'A-z0-9_\-'; - if (strpos($line, '&') === false && strpos($line, '*') === false) return false; // Please die fast ;-) - if ($line[0] == '&' && preg_match('/^(&['.$symbolsForReference.']+)/', $line, $matches)) return $matches[1]; - if ($line[0] == '*' && preg_match('/^(\*['.$symbolsForReference.']+)/', $line, $matches)) return $matches[1]; - if (preg_match('/(&['.$symbolsForReference.']+)$/', $line, $matches)) return $matches[1]; - if (preg_match('/(\*['.$symbolsForReference.']+$)/', $line, $matches)) return $matches[1]; - if (preg_match ('#^\s*<<\s*:\s*(\*[^\s]+).*$#', $line, $matches)) return $matches[1]; - return false; - - } - - private function addGroup ($line, $group) { - if ($group[0] == '&') $this->_containsGroupAnchor = substr ($group, 1); - if ($group[0] == '*') $this->_containsGroupAlias = substr ($group, 1); - //print_r ($this->path); - } - - private function stripGroup ($line, $group) { - $line = trim(str_replace($group, '', $line)); - return $line; - } -} - -// Enable use of Spyc from command line -// The syntax is the following: php spyc.php spyc.yaml - -define ('SPYC_FROM_COMMAND_LINE', false); - -do { - if (!SPYC_FROM_COMMAND_LINE) break; - if (empty ($_SERVER['argc']) || $_SERVER['argc'] < 2) break; - if (empty ($_SERVER['PHP_SELF']) || $_SERVER['PHP_SELF'] != 'spyc.php') break; - $file = $argv[1]; - printf ("Spyc loading file: %s\n", $file); - print_r (spyc_load_file ($file)); + + * @author Chris Wanstrath + * @link http://code.google.com/p/spyc/ + * @copyright Copyright 2005-2006 Chris Wanstrath, 2006-2011 Vlad Andersen + * @license http://www.opensource.org/licenses/mit-license.php MIT License + * @package Spyc + */ + +if (!function_exists('spyc_load')) { + /** + * Parses YAML to array. + * @param string $string YAML string. + * @return array + */ + function spyc_load ($string) { + return Spyc::YAMLLoadString($string); + } +} + +if (!function_exists('spyc_load_file')) { + /** + * Parses YAML to array. + * @param string $file Path to YAML file. + * @return array + */ + function spyc_load_file ($file) { + return Spyc::YAMLLoad($file); + } +} + +/** + * The Simple PHP YAML Class. + * + * This class can be used to read a YAML file and convert its contents + * into a PHP array. It currently supports a very limited subsection of + * the YAML spec. + * + * Usage: + * + * $Spyc = new Spyc; + * $array = $Spyc->load($file); + * + * or: + * + * $array = Spyc::YAMLLoad($file); + * + * or: + * + * $array = spyc_load_file($file); + * + * @package Spyc + */ +class Spyc { + + // SETTINGS + + const REMPTY = "\0\0\0\0\0"; + + /** + * Setting this to true will force YAMLDump to enclose any string value in + * quotes. False by default. + * + * @var bool + */ + public $setting_dump_force_quotes = false; + + /** + * Setting this to true will forse YAMLLoad to use syck_load function when + * possible. False by default. + * @var bool + */ + public $setting_use_syck_is_possible = false; + + + + /**#@+ + * @access private + * @var mixed + */ + private $_dumpIndent; + private $_dumpWordWrap; + private $_containsGroupAnchor = false; + private $_containsGroupAlias = false; + private $path; + private $result; + private $LiteralPlaceHolder = '___YAML_Literal_Block___'; + private $SavedGroups = array(); + private $indent; + /** + * Path modifier that should be applied after adding current element. + * @var array + */ + private $delayedPath = array(); + + /**#@+ + * @access public + * @var mixed + */ + public $_nodeId; + +/** + * Load a valid YAML string to Spyc. + * @param string $input + * @return array + */ + public function load ($input) { + return $this->__loadString($input); + } + + /** + * Load a valid YAML file to Spyc. + * @param string $file + * @return array + */ + public function loadFile ($file) { + return $this->__load($file); + } + + /** + * Load YAML into a PHP array statically + * + * The load method, when supplied with a YAML stream (string or file), + * will do its best to convert YAML in a file into a PHP array. Pretty + * simple. + * Usage: + * + * $array = Spyc::YAMLLoad('lucky.yaml'); + * print_r($array); + * + * @access public + * @return array + * @param string $input Path of YAML file or string containing YAML + */ + public static function YAMLLoad($input) { + $Spyc = new Spyc; + return $Spyc->__load($input); + } + + /** + * Load a string of YAML into a PHP array statically + * + * The load method, when supplied with a YAML string, will do its best + * to convert YAML in a string into a PHP array. Pretty simple. + * + * Note: use this function if you don't want files from the file system + * loaded and processed as YAML. This is of interest to people concerned + * about security whose input is from a string. + * + * Usage: + * + * $array = Spyc::YAMLLoadString("---\n0: hello world\n"); + * print_r($array); + * + * @access public + * @return array + * @param string $input String containing YAML + */ + public static function YAMLLoadString($input) { + $Spyc = new Spyc; + return $Spyc->__loadString($input); + } + + /** + * Dump YAML from PHP array statically + * + * The dump method, when supplied with an array, will do its best + * to convert the array into friendly YAML. Pretty simple. Feel free to + * save the returned string as nothing.yaml and pass it around. + * + * Oh, and you can decide how big the indent is and what the wordwrap + * for folding is. Pretty cool -- just pass in 'false' for either if + * you want to use the default. + * + * Indent's default is 2 spaces, wordwrap's default is 40 characters. And + * you can turn off wordwrap by passing in 0. + * + * @access public + * @return string + * @param array $array PHP array + * @param int $indent Pass in false to use the default, which is 2 + * @param int $wordwrap Pass in 0 for no wordwrap, false for default (40) + */ + public static function YAMLDump($array,$indent = false,$wordwrap = false) { + $spyc = new Spyc; + return $spyc->dump($array,$indent,$wordwrap); + } + + + /** + * Dump PHP array to YAML + * + * The dump method, when supplied with an array, will do its best + * to convert the array into friendly YAML. Pretty simple. Feel free to + * save the returned string as tasteful.yaml and pass it around. + * + * Oh, and you can decide how big the indent is and what the wordwrap + * for folding is. Pretty cool -- just pass in 'false' for either if + * you want to use the default. + * + * Indent's default is 2 spaces, wordwrap's default is 40 characters. And + * you can turn off wordwrap by passing in 0. + * + * @access public + * @return string + * @param array $array PHP array + * @param int $indent Pass in false to use the default, which is 2 + * @param int $wordwrap Pass in 0 for no wordwrap, false for default (40) + */ + public function dump($array,$indent = false,$wordwrap = false) { + // Dumps to some very clean YAML. We'll have to add some more features + // and options soon. And better support for folding. + + // New features and options. + if ($indent === false or !is_numeric($indent)) { + $this->_dumpIndent = 2; + } else { + $this->_dumpIndent = $indent; + } + + if ($wordwrap === false or !is_numeric($wordwrap)) { + $this->_dumpWordWrap = 40; + } else { + $this->_dumpWordWrap = $wordwrap; + } + + // New YAML document + $string = "---\n"; + + // Start at the base of the array and move through it. + if ($array) { + $array = (array)$array; + $previous_key = -1; + foreach ($array as $key => $value) { + if (!isset($first_key)) $first_key = $key; + $string .= $this->_yamlize($key,$value,0,$previous_key, $first_key, $array); + $previous_key = $key; + } + } + return $string; + } + + /** + * Attempts to convert a key / value array item to YAML + * @access private + * @return string + * @param $key The name of the key + * @param $value The value of the item + * @param $indent The indent of the current node + */ + private function _yamlize($key,$value,$indent, $previous_key = -1, $first_key = 0, $source_array = null) { + if (is_array($value)) { + if (empty ($value)) + return $this->_dumpNode($key, array(), $indent, $previous_key, $first_key, $source_array); + // It has children. What to do? + // Make it the right kind of item + $string = $this->_dumpNode($key, self::REMPTY, $indent, $previous_key, $first_key, $source_array); + // Add the indent + $indent += $this->_dumpIndent; + // Yamlize the array + $string .= $this->_yamlizeArray($value,$indent); + } elseif (!is_array($value)) { + // It doesn't have children. Yip. + $string = $this->_dumpNode($key, $value, $indent, $previous_key, $first_key, $source_array); + } + return $string; + } + + /** + * Attempts to convert an array to YAML + * @access private + * @return string + * @param $array The array you want to convert + * @param $indent The indent of the current level + */ + private function _yamlizeArray($array,$indent) { + if (is_array($array)) { + $string = ''; + $previous_key = -1; + foreach ($array as $key => $value) { + if (!isset($first_key)) $first_key = $key; + $string .= $this->_yamlize($key, $value, $indent, $previous_key, $first_key, $array); + $previous_key = $key; + } + return $string; + } else { + return false; + } + } + + /** + * Returns YAML from a key and a value + * @access private + * @return string + * @param $key The name of the key + * @param $value The value of the item + * @param $indent The indent of the current node + */ + private function _dumpNode($key, $value, $indent, $previous_key = -1, $first_key = 0, $source_array = null) { + // do some folding here, for blocks + if (is_string ($value) && ((strpos($value,"\n") !== false || strpos($value,": ") !== false || strpos($value,"- ") !== false || + strpos($value,"*") !== false || strpos($value,"#") !== false || strpos($value,"<") !== false || strpos($value,">") !== false || strpos ($value, ' ') !== false || + strpos($value,"[") !== false || strpos($value,"]") !== false || strpos($value,"{") !== false || strpos($value,"}") !== false) || strpos($value,"&") !== false || strpos($value, "'") !== false || strpos($value, "!") === 0 || + substr ($value, -1, 1) == ':') + ) { + $value = $this->_doLiteralBlock($value,$indent); + } else { + $value = $this->_doFolding($value,$indent); + } + + if ($value === array()) $value = '[ ]'; + if (in_array ($value, array ('true', 'TRUE', 'false', 'FALSE', 'y', 'Y', 'n', 'N', 'null', 'NULL'), true)) { + $value = $this->_doLiteralBlock($value,$indent); + } + if (trim ($value) != $value) + $value = $this->_doLiteralBlock($value,$indent); + + if (is_bool($value)) { + $value = ($value) ? "true" : "false"; + } + + if ($value === null) $value = 'null'; + if ($value === "'" . self::REMPTY . "'") $value = null; + + $spaces = str_repeat(' ',$indent); + + //if (is_int($key) && $key - 1 == $previous_key && $first_key===0) { + if (is_array ($source_array) && array_keys($source_array) === range(0, count($source_array) - 1)) { + // It's a sequence + $string = $spaces.'- '.$value."\n"; + } else { + // if ($first_key===0) throw new Exception('Keys are all screwy. The first one was zero, now it\'s "'. $key .'"'); + // It's mapped + if (strpos($key, ":") !== false || strpos($key, "#") !== false) { $key = '"' . $key . '"'; } + $string = rtrim ($spaces.$key.': '.$value)."\n"; + } + return $string; + } + + /** + * Creates a literal block for dumping + * @access private + * @return string + * @param $value + * @param $indent int The value of the indent + */ + private function _doLiteralBlock($value,$indent) { + if ($value === "\n") return '\n'; + if (strpos($value, "\n") === false && strpos($value, "'") === false) { + return sprintf ("'%s'", $value); + } + if (strpos($value, "\n") === false && strpos($value, '"') === false) { + return sprintf ('"%s"', $value); + } + $exploded = explode("\n",$value); + $newValue = '|'; + $indent += $this->_dumpIndent; + $spaces = str_repeat(' ',$indent); + foreach ($exploded as $line) { + $newValue .= "\n" . $spaces . ($line); + } + return $newValue; + } + + /** + * Folds a string of text, if necessary + * @access private + * @return string + * @param $value The string you wish to fold + */ + private function _doFolding($value,$indent) { + // Don't do anything if wordwrap is set to 0 + + if ($this->_dumpWordWrap !== 0 && is_string ($value) && strlen($value) > $this->_dumpWordWrap) { + $indent += $this->_dumpIndent; + $indent = str_repeat(' ',$indent); + $wrapped = wordwrap($value,$this->_dumpWordWrap,"\n$indent"); + $value = ">\n".$indent.$wrapped; + } else { + if ($this->setting_dump_force_quotes && is_string ($value) && $value !== self::REMPTY) + $value = '"' . $value . '"'; + } + + + return $value; + } + +// LOADING FUNCTIONS + + private function __load($input) { + $Source = $this->loadFromSource($input); + return $this->loadWithSource($Source); + } + + private function __loadString($input) { + $Source = $this->loadFromString($input); + return $this->loadWithSource($Source); + } + + private function loadWithSource($Source) { + if (empty ($Source)) return array(); + if ($this->setting_use_syck_is_possible && function_exists ('syck_load')) { + $array = syck_load (implode ('', $Source)); + return is_array($array) ? $array : array(); + } + + $this->path = array(); + $this->result = array(); + + $cnt = count($Source); + for ($i = 0; $i < $cnt; $i++) { + $line = $Source[$i]; + + $this->indent = strlen($line) - strlen(ltrim($line)); + $tempPath = $this->getParentPathByIndent($this->indent); + $line = self::stripIndent($line, $this->indent); + if (self::isComment($line)) continue; + if (self::isEmpty($line)) continue; + $this->path = $tempPath; + + $literalBlockStyle = self::startsLiteralBlock($line); + if ($literalBlockStyle) { + $line = rtrim ($line, $literalBlockStyle . " \n"); + $literalBlock = ''; + $line .= $this->LiteralPlaceHolder; + $literal_block_indent = strlen($Source[$i+1]) - strlen(ltrim($Source[$i+1])); + while (++$i < $cnt && $this->literalBlockContinues($Source[$i], $this->indent)) { + $literalBlock = $this->addLiteralLine($literalBlock, $Source[$i], $literalBlockStyle, $literal_block_indent); + } + $i--; + } + + while (++$i < $cnt && self::greedilyNeedNextLine($line)) { + $line = rtrim ($line, " \n\t\r") . ' ' . ltrim ($Source[$i], " \t"); + } + $i--; + + + + if (strpos ($line, '#')) { + if (strpos ($line, '"') === false && strpos ($line, "'") === false) + $line = preg_replace('/\s+#(.+)$/','',$line); + } + + $lineArray = $this->_parseLine($line); + + if ($literalBlockStyle) + $lineArray = $this->revertLiteralPlaceHolder ($lineArray, $literalBlock); + + $this->addArray($lineArray, $this->indent); + + foreach ($this->delayedPath as $indent => $delayedPath) + $this->path[$indent] = $delayedPath; + + $this->delayedPath = array(); + + } + return $this->result; + } + + private function loadFromSource ($input) { + if (!empty($input) && strpos($input, "\n") === false && file_exists($input)) + return file($input); + + return $this->loadFromString($input); + } + + private function loadFromString ($input) { + $lines = explode("\n",$input); + foreach ($lines as $k => $_) { + $lines[$k] = rtrim ($_, "\r"); + } + return $lines; + } + + /** + * Parses YAML code and returns an array for a node + * @access private + * @return array + * @param string $line A line from the YAML file + */ + private function _parseLine($line) { + if (!$line) return array(); + $line = trim($line); + if (!$line) return array(); + + $array = array(); + + $group = $this->nodeContainsGroup($line); + if ($group) { + $this->addGroup($line, $group); + $line = $this->stripGroup ($line, $group); + } + + if ($this->startsMappedSequence($line)) + return $this->returnMappedSequence($line); + + if ($this->startsMappedValue($line)) + return $this->returnMappedValue($line); + + if ($this->isArrayElement($line)) + return $this->returnArrayElement($line); + + if ($this->isPlainArray($line)) + return $this->returnPlainArray($line); + + + return $this->returnKeyValuePair($line); + + } + + /** + * Finds the type of the passed value, returns the value as the new type. + * @access private + * @param string $value + * @return mixed + */ + private function _toType($value) { + if ($value === '') return null; + $first_character = $value[0]; + $last_character = substr($value, -1, 1); + + $is_quoted = false; + do { + if (!$value) break; + if ($first_character != '"' && $first_character != "'") break; + if ($last_character != '"' && $last_character != "'") break; + $is_quoted = true; + } while (0); + + if ($is_quoted) + return strtr(substr ($value, 1, -1), array ('\\"' => '"', '\'\'' => '\'', '\\\'' => '\'')); + + if (strpos($value, ' #') !== false && !$is_quoted) + $value = preg_replace('/\s+#(.+)$/','',$value); + + if (!$is_quoted) $value = str_replace('\n', "\n", $value); + + if ($first_character == '[' && $last_character == ']') { + // Take out strings sequences and mappings + $innerValue = trim(substr ($value, 1, -1)); + if ($innerValue === '') return array(); + $explode = $this->_inlineEscape($innerValue); + // Propagate value array + $value = array(); + foreach ($explode as $v) { + $value[] = $this->_toType($v); + } + return $value; + } + + if (strpos($value,': ')!==false && $first_character != '{') { + $array = explode(': ',$value); + $key = trim($array[0]); + array_shift($array); + $value = trim(implode(': ',$array)); + $value = $this->_toType($value); + return array($key => $value); + } + + if ($first_character == '{' && $last_character == '}') { + $innerValue = trim(substr ($value, 1, -1)); + if ($innerValue === '') return array(); + // Inline Mapping + // Take out strings sequences and mappings + $explode = $this->_inlineEscape($innerValue); + // Propagate value array + $array = array(); + foreach ($explode as $v) { + $SubArr = $this->_toType($v); + if (empty($SubArr)) continue; + if (is_array ($SubArr)) { + $array[key($SubArr)] = $SubArr[key($SubArr)]; continue; + } + $array[] = $SubArr; + } + return $array; + } + + if ($value == 'null' || $value == 'NULL' || $value == 'Null' || $value == '' || $value == '~') { + return null; + } + + if ( is_numeric($value) && preg_match ('/^(-|)[1-9]+[0-9]*$/', $value) ){ + $intvalue = (int)$value; + if ($intvalue != PHP_INT_MAX) + $value = $intvalue; + return $value; + } + + if (in_array($value, + array('true', 'on', '+', 'yes', 'y', 'True', 'TRUE', 'On', 'ON', 'YES', 'Yes', 'Y'))) { + return true; + } + + if (in_array(strtolower($value), + array('false', 'off', '-', 'no', 'n'))) { + return false; + } + + if (is_numeric($value)) { + if ($value === '0') return 0; + if (rtrim ($value, 0) === $value) + $value = (float)$value; + return $value; + } + + return $value; + } + + /** + * Used in inlines to check for more inlines or quoted strings + * @access private + * @return array + */ + private function _inlineEscape($inline) { + // There's gotta be a cleaner way to do this... + // While pure sequences seem to be nesting just fine, + // pure mappings and mappings with sequences inside can't go very + // deep. This needs to be fixed. + + $seqs = array(); + $maps = array(); + $saved_strings = array(); + + // Check for strings + $regex = '/(?:(")|(?:\'))((?(1)[^"]+|[^\']+))(?(1)"|\')/'; + if (preg_match_all($regex,$inline,$strings)) { + $saved_strings = $strings[0]; + $inline = preg_replace($regex,'YAMLString',$inline); + } + unset($regex); + + $i = 0; + do { + + // Check for sequences + while (preg_match('/\[([^{}\[\]]+)\]/U',$inline,$matchseqs)) { + $seqs[] = $matchseqs[0]; + $inline = preg_replace('/\[([^{}\[\]]+)\]/U', ('YAMLSeq' . (count($seqs) - 1) . 's'), $inline, 1); + } + + // Check for mappings + while (preg_match('/{([^\[\]{}]+)}/U',$inline,$matchmaps)) { + $maps[] = $matchmaps[0]; + $inline = preg_replace('/{([^\[\]{}]+)}/U', ('YAMLMap' . (count($maps) - 1) . 's'), $inline, 1); + } + + if ($i++ >= 10) break; + + } while (strpos ($inline, '[') !== false || strpos ($inline, '{') !== false); + + $explode = explode(', ',$inline); + $stringi = 0; $i = 0; + + while (1) { + + // Re-add the sequences + if (!empty($seqs)) { + foreach ($explode as $key => $value) { + if (strpos($value,'YAMLSeq') !== false) { + foreach ($seqs as $seqk => $seq) { + $explode[$key] = str_replace(('YAMLSeq'.$seqk.'s'),$seq,$value); + $value = $explode[$key]; + } + } + } + } + + // Re-add the mappings + if (!empty($maps)) { + foreach ($explode as $key => $value) { + if (strpos($value,'YAMLMap') !== false) { + foreach ($maps as $mapk => $map) { + $explode[$key] = str_replace(('YAMLMap'.$mapk.'s'), $map, $value); + $value = $explode[$key]; + } + } + } + } + + + // Re-add the strings + if (!empty($saved_strings)) { + foreach ($explode as $key => $value) { + while (strpos($value,'YAMLString') !== false) { + $explode[$key] = preg_replace('/YAMLString/',$saved_strings[$stringi],$value, 1); + unset($saved_strings[$stringi]); + ++$stringi; + $value = $explode[$key]; + } + } + } + + $finished = true; + foreach ($explode as $key => $value) { + if (strpos($value,'YAMLSeq') !== false) { + $finished = false; break; + } + if (strpos($value,'YAMLMap') !== false) { + $finished = false; break; + } + if (strpos($value,'YAMLString') !== false) { + $finished = false; break; + } + } + if ($finished) break; + + $i++; + if ($i > 10) + break; // Prevent infinite loops. + } + + return $explode; + } + + private function literalBlockContinues ($line, $lineIndent) { + if (!trim($line)) return true; + if (strlen($line) - strlen(ltrim($line)) > $lineIndent) return true; + return false; + } + + private function referenceContentsByAlias ($alias) { + do { + if (!isset($this->SavedGroups[$alias])) { echo "Bad group name: $alias."; break; } + $groupPath = $this->SavedGroups[$alias]; + $value = $this->result; + foreach ($groupPath as $k) { + $value = $value[$k]; + } + } while (false); + return $value; + } + + private function addArrayInline ($array, $indent) { + $CommonGroupPath = $this->path; + if (empty ($array)) return false; + + foreach ($array as $k => $_) { + $this->addArray(array($k => $_), $indent); + $this->path = $CommonGroupPath; + } + return true; + } + + private function addArray ($incoming_data, $incoming_indent) { + + // print_r ($incoming_data); + + if (count ($incoming_data) > 1) + return $this->addArrayInline ($incoming_data, $incoming_indent); + + $key = key ($incoming_data); + $value = isset($incoming_data[$key]) ? $incoming_data[$key] : null; + if ($key === '__!YAMLZero') $key = '0'; + + if ($incoming_indent == 0 && !$this->_containsGroupAlias && !$this->_containsGroupAnchor) { // Shortcut for root-level values. + if ($key || $key === '' || $key === '0') { + $this->result[$key] = $value; + } else { + $this->result[] = $value; end ($this->result); $key = key ($this->result); + } + $this->path[$incoming_indent] = $key; + return; + } + + + + $history = array(); + // Unfolding inner array tree. + $history[] = $_arr = $this->result; + foreach ($this->path as $k) { + $history[] = $_arr = $_arr[$k]; + } + + if ($this->_containsGroupAlias) { + $value = $this->referenceContentsByAlias($this->_containsGroupAlias); + $this->_containsGroupAlias = false; + } + + + // Adding string or numeric key to the innermost level or $this->arr. + if (is_string($key) && $key == '<<') { + if (!is_array ($_arr)) { $_arr = array (); } + + $_arr = array_merge ($_arr, $value); + } else if ($key || $key === '' || $key === '0') { + if (!is_array ($_arr)) + $_arr = array ($key=>$value); + else + $_arr[$key] = $value; + } else { + if (!is_array ($_arr)) { $_arr = array ($value); $key = 0; } + else { $_arr[] = $value; end ($_arr); $key = key ($_arr); } + } + + $reverse_path = array_reverse($this->path); + $reverse_history = array_reverse ($history); + $reverse_history[0] = $_arr; + $cnt = count($reverse_history) - 1; + for ($i = 0; $i < $cnt; $i++) { + $reverse_history[$i+1][$reverse_path[$i]] = $reverse_history[$i]; + } + $this->result = $reverse_history[$cnt]; + + $this->path[$incoming_indent] = $key; + + if ($this->_containsGroupAnchor) { + $this->SavedGroups[$this->_containsGroupAnchor] = $this->path; + if (is_array ($value)) { + $k = key ($value); + if (!is_int ($k)) { + $this->SavedGroups[$this->_containsGroupAnchor][$incoming_indent + 2] = $k; + } + } + $this->_containsGroupAnchor = false; + } + + } + + private static function startsLiteralBlock ($line) { + $lastChar = substr (trim($line), -1); + if ($lastChar != '>' && $lastChar != '|') return false; + if ($lastChar == '|') return $lastChar; + // HTML tags should not be counted as literal blocks. + if (preg_match ('#<.*?>$#', $line)) return false; + return $lastChar; + } + + private static function greedilyNeedNextLine($line) { + $line = trim ($line); + if (!strlen($line)) return false; + if (substr ($line, -1, 1) == ']') return false; + if ($line[0] == '[') return true; + if (preg_match ('#^[^:]+?:\s*\[#', $line)) return true; + return false; + } + + private function addLiteralLine ($literalBlock, $line, $literalBlockStyle, $indent = -1) { + $line = self::stripIndent($line, $indent); + if ($literalBlockStyle !== '|') { + $line = self::stripIndent($line); + } + $line = rtrim ($line, "\r\n\t ") . "\n"; + if ($literalBlockStyle == '|') { + return $literalBlock . $line; + } + if (strlen($line) == 0) + return rtrim($literalBlock, ' ') . "\n"; + if ($line == "\n" && $literalBlockStyle == '>') { + return rtrim ($literalBlock, " \t") . "\n"; + } + if ($line != "\n") + $line = trim ($line, "\r\n ") . " "; + return $literalBlock . $line; + } + + function revertLiteralPlaceHolder ($lineArray, $literalBlock) { + foreach ($lineArray as $k => $_) { + if (is_array($_)) + $lineArray[$k] = $this->revertLiteralPlaceHolder ($_, $literalBlock); + else if (substr($_, -1 * strlen ($this->LiteralPlaceHolder)) == $this->LiteralPlaceHolder) + $lineArray[$k] = rtrim ($literalBlock, " \r\n"); + } + return $lineArray; + } + + private static function stripIndent ($line, $indent = -1) { + if ($indent == -1) $indent = strlen($line) - strlen(ltrim($line)); + return substr ($line, $indent); + } + + private function getParentPathByIndent ($indent) { + if ($indent == 0) return array(); + $linePath = $this->path; + do { + end($linePath); $lastIndentInParentPath = key($linePath); + if ($indent <= $lastIndentInParentPath) array_pop ($linePath); + } while ($indent <= $lastIndentInParentPath); + return $linePath; + } + + + private function clearBiggerPathValues ($indent) { + + + if ($indent == 0) $this->path = array(); + if (empty ($this->path)) return true; + + foreach ($this->path as $k => $_) { + if ($k > $indent) unset ($this->path[$k]); + } + + return true; + } + + + private static function isComment ($line) { + if (!$line) return false; + if ($line[0] == '#') return true; + if (trim($line, " \r\n\t") == '---') return true; + return false; + } + + private static function isEmpty ($line) { + return (trim ($line) === ''); + } + + + private function isArrayElement ($line) { + if (!$line) return false; + if ($line[0] != '-') return false; + if (strlen ($line) > 3) + if (substr($line,0,3) == '---') return false; + + return true; + } + + private function isHashElement ($line) { + return strpos($line, ':'); + } + + private function isLiteral ($line) { + if ($this->isArrayElement($line)) return false; + if ($this->isHashElement($line)) return false; + return true; + } + + + private static function unquote ($value) { + if (!$value) return $value; + if (!is_string($value)) return $value; + if ($value[0] == '\'') return trim ($value, '\''); + if ($value[0] == '"') return trim ($value, '"'); + return $value; + } + + private function startsMappedSequence ($line) { + return ($line[0] == '-' && substr ($line, -1, 1) == ':'); + } + + private function returnMappedSequence ($line) { + $array = array(); + $key = self::unquote(trim(substr($line,1,-1))); + $array[$key] = array(); + $this->delayedPath = array(strpos ($line, $key) + $this->indent => $key); + return array($array); + } + + private function returnMappedValue ($line) { + $array = array(); + $key = self::unquote (trim(substr($line,0,-1))); + $array[$key] = ''; + return $array; + } + + private function startsMappedValue ($line) { + return (substr ($line, -1, 1) == ':'); + } + + private function isPlainArray ($line) { + return ($line[0] == '[' && substr ($line, -1, 1) == ']'); + } + + private function returnPlainArray ($line) { + return $this->_toType($line); + } + + private function returnKeyValuePair ($line) { + $array = array(); + $key = ''; + if (strpos ($line, ':')) { + // It's a key/value pair most likely + // If the key is in double quotes pull it out + if (($line[0] == '"' || $line[0] == "'") && preg_match('/^(["\'](.*)["\'](\s)*:)/',$line,$matches)) { + $value = trim(str_replace($matches[1],'',$line)); + $key = $matches[2]; + } else { + // Do some guesswork as to the key and the value + $explode = explode(':',$line); + $key = trim($explode[0]); + array_shift($explode); + $value = trim(implode(':',$explode)); + } + // Set the type of the value. Int, string, etc + $value = $this->_toType($value); + if ($key === '0') $key = '__!YAMLZero'; + $array[$key] = $value; + } else { + $array = array ($line); + } + return $array; + + } + + + private function returnArrayElement ($line) { + if (strlen($line) <= 1) return array(array()); // Weird %) + $array = array(); + $value = trim(substr($line,1)); + $value = $this->_toType($value); + $array[] = $value; + return $array; + } + + + private function nodeContainsGroup ($line) { + $symbolsForReference = 'A-z0-9_\-'; + if (strpos($line, '&') === false && strpos($line, '*') === false) return false; // Please die fast ;-) + if ($line[0] == '&' && preg_match('/^(&['.$symbolsForReference.']+)/', $line, $matches)) return $matches[1]; + if ($line[0] == '*' && preg_match('/^(\*['.$symbolsForReference.']+)/', $line, $matches)) return $matches[1]; + if (preg_match('/(&['.$symbolsForReference.']+)$/', $line, $matches)) return $matches[1]; + if (preg_match('/(\*['.$symbolsForReference.']+$)/', $line, $matches)) return $matches[1]; + if (preg_match ('#^\s*<<\s*:\s*(\*[^\s]+).*$#', $line, $matches)) return $matches[1]; + return false; + + } + + private function addGroup ($line, $group) { + if ($group[0] == '&') $this->_containsGroupAnchor = substr ($group, 1); + if ($group[0] == '*') $this->_containsGroupAlias = substr ($group, 1); + //print_r ($this->path); + } + + private function stripGroup ($line, $group) { + $line = trim(str_replace($group, '', $line)); + return $line; + } +} + +// Enable use of Spyc from command line +// The syntax is the following: php spyc.php spyc.yaml + +define ('SPYC_FROM_COMMAND_LINE', false); + +do { + if (!SPYC_FROM_COMMAND_LINE) break; + if (empty ($_SERVER['argc']) || $_SERVER['argc'] < 2) break; + if (empty ($_SERVER['PHP_SELF']) || $_SERVER['PHP_SELF'] != 'spyc.php') break; + $file = $argv[1]; + printf ("Spyc loading file: %s\n", $file); + print_r (spyc_load_file ($file)); } while (0); \ No newline at end of file diff --git a/plugins/DevicesDetection/functions.php b/plugins/DevicesDetection/functions.php index 34f8ed8690..0812741aec 100644 --- a/plugins/DevicesDetection/functions.php +++ b/plugins/DevicesDetection/functions.php @@ -130,18 +130,16 @@ function Piwik_getOsFullNameExtended($label) if (!empty($label) && $label != ";") { $os = substr($label, 0, 3); $ver = substr($label, 4, 15); - $osFullName = array_search($os, UserAgentParserEnhanced::$osShorts); - if ($osFullName) { - if (in_array($os, UserAgentParserEnhanced::$osFamilies['Windows'])) { - return $osFullName; - } else { - return trim($osFullName . " " . $ver); - } + $name = UserAgentParserEnhanced::getOsNameFromId($os, $ver); + if(!empty($name)) { + return $name; } } return Piwik_Translate('General_Unknown'); } + + function Piwik_getOsLogoExtended($label) { $short = substr($label, 0, 3); diff --git a/plugins/DevicesDetection/lang/en.php b/plugins/DevicesDetection/lang/en.php index 3df87d9fd5..d6470a95fe 100644 --- a/plugins/DevicesDetection/lang/en.php +++ b/plugins/DevicesDetection/lang/en.php @@ -1,7 +1,7 @@ "Plugin providing extended information about mobile devices visiting page. Also new, more specific reports are available.", + "DevicesDetection_description" => "This plugin provides extended information about mobile devices, such as Brand (manufacturer), Model (device version), better Device type detection (tv, consoles, smart phones, desktop, etc) and more. This plugin adds a new report in 'Visitors > Devices'.", "DevicesDetection_submenu" => "Devices", 'DevicesDetection_DevicesDetection' => "Visitor devices", // DataTable label translations for reports -- cgit v1.2.3 From 58ce6ff3923c76cc242e301ef0cc124964f00117 Mon Sep 17 00:00:00 2001 From: Timo Besenreuther Date: Fri, 24 May 2013 13:52:59 +0200 Subject: DeviceDetection compatibility with PHP 5.2 --- .../UserAgentParserEnhanced/UserAgentParserEnhanced.php | 6 +++--- plugins/DevicesDetection/functions.php | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'plugins') diff --git a/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php b/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php index f107455ad9..300b02d04c 100644 --- a/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php +++ b/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php @@ -335,17 +335,17 @@ class UserAgentParserEnhanced protected function getOsRegexes() { - return Spyc::YAMLLoad(__DIR__ . self::$regexesDir . self::$osRegexesFile); + return Spyc::YAMLLoad(dirname(__FILE__) . self::$regexesDir . self::$osRegexesFile); } protected function getBrowserRegexes() { - return Spyc::YAMLLoad(__DIR__ . self::$regexesDir . self::$browserRegexesFile); + return Spyc::YAMLLoad(dirname(__FILE__) . self::$regexesDir . self::$browserRegexesFile); } protected function getMobileRegexes() { - return Spyc::YAMLLoad(__DIR__ . self::$regexesDir . self::$mobileRegexesFile); + return Spyc::YAMLLoad(dirname(__FILE__) . self::$regexesDir . self::$mobileRegexesFile); } public function parse() diff --git a/plugins/DevicesDetection/functions.php b/plugins/DevicesDetection/functions.php index 0812741aec..7bf70a98c6 100644 --- a/plugins/DevicesDetection/functions.php +++ b/plugins/DevicesDetection/functions.php @@ -11,7 +11,7 @@ */ function Piwik_GetBrandLogo($label) { - $path = __DIR__ . '/images/brand/' . $label . '.ico'; + $path = dirname(__FILE__) . '/images/brand/' . $label . '.ico'; if (file_exists($path)) { return 'plugins/DevicesDetection/images/brand/' . $label . '.ico'; } else { -- cgit v1.2.3 From 21877807842483cc4a3c1b3d472ddc549bb4dee7 Mon Sep 17 00:00:00 2001 From: mattab Date: Sat, 25 May 2013 10:16:37 +1200 Subject: Refs #2135 fixing CSS/image which wasnt big enough for German button label --- plugins/SegmentEditor/images/dashboard_h_bg_hover.png | Bin 333 -> 378 bytes plugins/SegmentEditor/templates/Segmentation.css | 1 + 2 files changed, 1 insertion(+) (limited to 'plugins') diff --git a/plugins/SegmentEditor/images/dashboard_h_bg_hover.png b/plugins/SegmentEditor/images/dashboard_h_bg_hover.png index 37e4bd54e8..e46d8cc6df 100644 Binary files a/plugins/SegmentEditor/images/dashboard_h_bg_hover.png and b/plugins/SegmentEditor/images/dashboard_h_bg_hover.png differ diff --git a/plugins/SegmentEditor/templates/Segmentation.css b/plugins/SegmentEditor/templates/Segmentation.css index fa5e61346e..39aaa4c2fd 100644 --- a/plugins/SegmentEditor/templates/Segmentation.css +++ b/plugins/SegmentEditor/templates/Segmentation.css @@ -470,6 +470,7 @@ div.scrollable { margin: 12px 0 10px; padding: 3px 10px; text-decoration: none; + width:130px; } .segmentationContainer > ul.submenu > li { padding: 5px 0; -- cgit v1.2.3 From 771239a7dafff862f25be8abf1d4d68bacd91f03 Mon Sep 17 00:00:00 2001 From: mattab Date: Sat, 25 May 2013 10:17:46 +1200 Subject: Adding Chrome mobile icon (ideally we need a unit test to check we have icons for all browsers/OS referenced in the UserAgentParserEnhanced) Refs #3612 --- plugins/DevicesDetection/lang/en.php | 2 +- plugins/UserSettings/images/browsers/CM.gif | Bin 0 -> 1074 bytes 2 files changed, 1 insertion(+), 1 deletion(-) create mode 100644 plugins/UserSettings/images/browsers/CM.gif (limited to 'plugins') diff --git a/plugins/DevicesDetection/lang/en.php b/plugins/DevicesDetection/lang/en.php index d6470a95fe..93d4504957 100644 --- a/plugins/DevicesDetection/lang/en.php +++ b/plugins/DevicesDetection/lang/en.php @@ -3,7 +3,7 @@ $translations = array( "DevicesDetection_description" => "This plugin provides extended information about mobile devices, such as Brand (manufacturer), Model (device version), better Device type detection (tv, consoles, smart phones, desktop, etc) and more. This plugin adds a new report in 'Visitors > Devices'.", "DevicesDetection_submenu" => "Devices", - 'DevicesDetection_DevicesDetection' => "Visitor devices", + 'DevicesDetection_DevicesDetection' => "Visitor Devices", // DataTable label translations for reports "DevicesDetection_dataTableLabelBrands" => "Brand", "DevicesDetection_dataTableLabelTypes" => "Type", diff --git a/plugins/UserSettings/images/browsers/CM.gif b/plugins/UserSettings/images/browsers/CM.gif new file mode 100644 index 0000000000..793e0fad3b Binary files /dev/null and b/plugins/UserSettings/images/browsers/CM.gif differ -- cgit v1.2.3 From 826eb9549cc43defe3c7f82cb2d06fc316bb4d09 Mon Sep 17 00:00:00 2001 From: mattab Date: Sat, 25 May 2013 14:50:24 +1200 Subject: Small fixes [ciskip] --- plugins/API/API.php | 1 + plugins/SegmentEditor/templates/Segmentation.css | 1 + 2 files changed, 2 insertions(+) (limited to 'plugins') diff --git a/plugins/API/API.php b/plugins/API/API.php index 01c3acb3af..4eafaae726 100644 --- a/plugins/API/API.php +++ b/plugins/API/API.php @@ -1036,6 +1036,7 @@ class Piwik_API_API Piwik_Translate('Goals_Goals'), Piwik_Translate('General_Visitors'), Piwik_Translate('UserSettings_VisitorSettings'), + Piwik_Translate('DevicesDetection_DevicesDetection'), ); } return ($category = strcmp(array_search($a['category'], $order), array_search($b['category'], $order))) == 0 diff --git a/plugins/SegmentEditor/templates/Segmentation.css b/plugins/SegmentEditor/templates/Segmentation.css index 39aaa4c2fd..7468b33fe7 100644 --- a/plugins/SegmentEditor/templates/Segmentation.css +++ b/plugins/SegmentEditor/templates/Segmentation.css @@ -433,6 +433,7 @@ div.scrollable { .segmentationContainer .submenu ul li:hover { color: #255792; margin: 0; + margin-left:-3px; border: 1px solid #d5d2c6; border-bottom: 2px solid #918f88; border-radius: 4px; -- cgit v1.2.3 From 70b46eceba318a55d17d4aee0cb03eddb90e5d2c Mon Sep 17 00:00:00 2001 From: mattab Date: Sun, 26 May 2013 11:35:07 +1200 Subject: Fixes #3887 Proper fix for this problem, adding static array of "Row evolution not supported" Also I decided to enable tests so they all run on my box /standard ubuntu, rather than travis CI. Fixed a bug in tests that plugins language files were not loaded early enough. --- plugins/API/API.php | 2 +- plugins/ImageGraph/ImageGraph.php | 12 +++++++++++- plugins/Referers/Referers.php | 1 - 3 files changed, 12 insertions(+), 3 deletions(-) (limited to 'plugins') diff --git a/plugins/API/API.php b/plugins/API/API.php index 4eafaae726..0fcb1a54b9 100644 --- a/plugins/API/API.php +++ b/plugins/API/API.php @@ -1035,8 +1035,8 @@ class Piwik_API_API Piwik_Translate('Referers_Referers'), Piwik_Translate('Goals_Goals'), Piwik_Translate('General_Visitors'), - Piwik_Translate('UserSettings_VisitorSettings'), Piwik_Translate('DevicesDetection_DevicesDetection'), + Piwik_Translate('UserSettings_VisitorSettings'), ); } return ($category = strcmp(array_search($a['category'], $order), array_search($b['category'], $order))) == 0 diff --git a/plugins/ImageGraph/ImageGraph.php b/plugins/ImageGraph/ImageGraph.php index f149150d23..4e48e93d1d 100644 --- a/plugins/ImageGraph/ImageGraph.php +++ b/plugins/ImageGraph/ImageGraph.php @@ -15,6 +15,11 @@ class Piwik_ImageGraph extends Piwik_Plugin 'Referers_getRefererType', ); + // row evolution support not yet implemented for these APIs + static private $REPORTS_DISABLED_EVOLUTION_GRAPH = array( + 'Referers_getAll', + ); + public function getInformation() { return array( @@ -130,7 +135,12 @@ class Piwik_ImageGraph extends Piwik_Plugin // thanks to API.getRowEvolution, reports with dimensions can now be plotted using an evolution graph // however, most reports with a fixed set of dimension values are excluded // this is done so Piwik Mobile and Scheduled Reports do not display them - if (empty($report['constantRowsCount']) || in_array($reportUniqueId, self::$CONSTANT_ROW_COUNT_REPORT_EXCEPTIONS)) { + $reportWithDimensionsSupportsEvolution = empty($report['constantRowsCount']) || in_array($reportUniqueId, self::$CONSTANT_ROW_COUNT_REPORT_EXCEPTIONS); + + $reportSupportsEvolution = !in_array($reportUniqueId, self::$REPORTS_DISABLED_EVOLUTION_GRAPH); + + if ( $reportSupportsEvolution + && $reportWithDimensionsSupportsEvolution) { $parameters['period'] = $periodForMultiplePeriodGraph; $parameters['date'] = $dateForMultiplePeriodGraph; $report['imageGraphEvolutionUrl'] = $urlPrefix . Piwik_Url::getQueryStringFromParameters($parameters); diff --git a/plugins/Referers/Referers.php b/plugins/Referers/Referers.php index 145cd05de6..3e40f2d9a9 100644 --- a/plugins/Referers/Referers.php +++ b/plugins/Referers/Referers.php @@ -80,7 +80,6 @@ class Piwik_Referers extends Piwik_Plugin 'module' => 'Referers', 'action' => 'getAll', 'dimension' => Piwik_Translate('Referers_Referrer'), - 'constantRowsCount' => true, 'documentation' => Piwik_Translate('Referers_AllReferersReportDocumentation', '
    '), 'order' => 2, ), -- cgit v1.2.3 From ea10798591570ab7dbd3193e8112ed6a0487b3be Mon Sep 17 00:00:00 2001 From: sgiehl Date: Sun, 26 May 2013 18:27:08 +0200 Subject: send default params only as get if they aren't given as post param --- plugins/Annotations/templates/annotations.js | 3 --- plugins/CoreHome/templates/misc.js | 3 +-- plugins/UserCountry/templates/admin.js | 2 -- 3 files changed, 1 insertion(+), 7 deletions(-) (limited to 'plugins') diff --git a/plugins/Annotations/templates/annotations.js b/plugins/Annotations/templates/annotations.js index 817aade8ac..ce345257f1 100755 --- a/plugins/Annotations/templates/annotations.js +++ b/plugins/Annotations/templates/annotations.js @@ -45,7 +45,6 @@ var ajaxRequest = new ajaxHelper(); ajaxRequest.addParams(ajaxParams, 'get'); - ajaxRequest.addParams({token_auth: piwik.token_auth}, 'post'); ajaxRequest.setCallback(callback); ajaxRequest.setFormat('html'); ajaxRequest.send(false); @@ -68,7 +67,6 @@ var ajaxRequest = new ajaxHelper(); ajaxRequest.addParams(ajaxParams, 'get'); - ajaxRequest.addParams({token_auth: piwik.token_auth}, 'post'); ajaxRequest.setCallback(callback); ajaxRequest.setFormat('html'); ajaxRequest.send(false); @@ -88,7 +86,6 @@ var ajaxRequest = new ajaxHelper(); ajaxRequest.addParams(ajaxParams, 'get'); - ajaxRequest.addParams({token_auth: piwik.token_auth}, 'post'); ajaxRequest.setCallback(callback); ajaxRequest.setFormat('html'); ajaxRequest.send(false); diff --git a/plugins/CoreHome/templates/misc.js b/plugins/CoreHome/templates/misc.js index 7c2ede9c2f..b80b54e57a 100755 --- a/plugins/CoreHome/templates/misc.js +++ b/plugins/CoreHome/templates/misc.js @@ -25,8 +25,7 @@ ajaxRequest.setLoadingElement('#header_message .loadingPiwik'); ajaxRequest.addParams({ module: 'CoreHome', - action: 'checkForUpdates', - token_auth: piwik.token_auth + action: 'checkForUpdates' }, 'get'); ajaxRequest.setCallback(function (response) { headerMessage.fadeOut('slow', function () { diff --git a/plugins/UserCountry/templates/admin.js b/plugins/UserCountry/templates/admin.js index 4b7e191076..75bda9e841 100755 --- a/plugins/UserCountry/templates/admin.js +++ b/plugins/UserCountry/templates/admin.js @@ -68,7 +68,6 @@ $(document).ready(function () { var data = { module: 'UserCountry', action: action, - token_auth: piwik.token_auth, 'continue': cont ? 1 : 0 }; for (var k in extraData) { @@ -182,7 +181,6 @@ $(document).ready(function () { ajaxRequest.addParams({ module: 'UserCountry', action: 'updateGeoIPLinks', - token_auth: piwik.token_auth, loc_db: $('#geoip-location-db').val(), isp_db: $('#geoip-isp-db').val(), org_db: $('#geoip-org-db').val() -- cgit v1.2.3 From d3b0e02cbda4981967a39ed6574edd56c8c9a656 Mon Sep 17 00:00:00 2001 From: sgiehl Date: Sun, 26 May 2013 19:55:58 +0200 Subject: no need to set idSite as param as that is done by default --- plugins/SegmentEditor/templates/Segmentation.js | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'plugins') diff --git a/plugins/SegmentEditor/templates/Segmentation.js b/plugins/SegmentEditor/templates/Segmentation.js index 7ca9ebdffc..a44ef86598 100644 --- a/plugins/SegmentEditor/templates/Segmentation.js +++ b/plugins/SegmentEditor/templates/Segmentation.js @@ -434,8 +434,7 @@ Segmentation = (function($) { module: 'API', format: 'json', method: 'API.getSuggestedValuesForSegment', - segmentName: segmentName, - idSite: piwik.idSite + segmentName: segmentName }, 'GET'); ajaxHandler.setCallback(function(response) { loadingElement.hide(); -- cgit v1.2.3 From 367a411520fef0f3e7388919b8157670d549145e Mon Sep 17 00:00:00 2001 From: Benaka Moorthi Date: Sun, 26 May 2013 13:53:18 -0700 Subject: Make sure goals data is not double encoded when editing an existing goal. --- plugins/Goals/Controller.php | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'plugins') diff --git a/plugins/Goals/Controller.php b/plugins/Goals/Controller.php index 639bcb7708..9d0a97018c 100644 --- a/plugins/Goals/Controller.php +++ b/plugins/Goals/Controller.php @@ -201,7 +201,18 @@ class Piwik_Goals_Controller extends Piwik_Controller public function index() { $view = $this->getOverviewView(); - $view->goalsJSON = Piwik_Common::json_encode($this->goals); + + // unsanitize goal names and other text data (not done in API so as not to break + // any other code/cause security issues) + $goals = $this->goals; + foreach ($goals as &$goal) { + $goal['name'] = Piwik_Common::unsanitizeInputValue($goal['name']); + if (isset($goal['pattern'])) { + $goal['pattern'] = Piwik_Common::unsanitizeInputValue($goal['pattern']); + } + } + $view->goalsJSON = Piwik_Common::json_encode($goals); + $view->userCanEditGoals = Piwik::isUserHasAdminAccess($this->idSite); $view->ecommerceEnabled = $this->site->isEcommerceEnabled(); $view->displayFullReport = true; -- cgit v1.2.3 From d0b1eea2345d13e64a6eef476eacb5fd87f87770 Mon Sep 17 00:00:00 2001 From: Benaka Moorthi Date: Sun, 26 May 2013 15:35:50 -0700 Subject: Hopefully fix safari/ie8 issue w/ calendar icon background in period selector. --- plugins/CoreHome/templates/period_select.tpl | 1 + 1 file changed, 1 insertion(+) (limited to 'plugins') diff --git a/plugins/CoreHome/templates/period_select.tpl b/plugins/CoreHome/templates/period_select.tpl index 1e0c2a6209..61e19274d2 100644 --- a/plugins/CoreHome/templates/period_select.tpl +++ b/plugins/CoreHome/templates/period_select.tpl @@ -2,6 +2,7 @@
    {'General_DateRange'|translate} {$prettyDate}
    +
    {'General_Date'|translate}
    -- cgit v1.2.3 From b860c81382926ae7a12102b035bb9e16da57e972 Mon Sep 17 00:00:00 2001 From: Benaka Moorthi Date: Sun, 26 May 2013 15:55:48 -0700 Subject: Do not display header + blank space in reports by goal dimension part of Goal Overview if there are no conversions. --- plugins/Goals/templates/overview.tpl | 2 ++ 1 file changed, 2 insertions(+) (limited to 'plugins') diff --git a/plugins/Goals/templates/overview.tpl b/plugins/Goals/templates/overview.tpl index 0e971602ce..dc20c84390 100644 --- a/plugins/Goals/templates/overview.tpl +++ b/plugins/Goals/templates/overview.tpl @@ -32,6 +32,7 @@ {/foreach} {if $displayFullReport} + {if $sum_nb_conversions neq 0}

    {if isset($idGoal)} {'Goals_GoalConversionsBy'|translate:$goalName} @@ -40,6 +41,7 @@ {/if}

    {$goalReportsByDimension} + {/if} {if $userCanEditGoals} {include file="Goals/templates/add_edit_goal.tpl"} -- cgit v1.2.3 From 8a749f135d57244ca8e2b886145e68168f86135f Mon Sep 17 00:00:00 2001 From: Benaka Moorthi Date: Sun, 26 May 2013 16:17:30 -0700 Subject: Make sure UserSettings reports getOS & getBrowsers check that a logo image exists before adding it to the report (if a logo does not exist, the unknown image). --- plugins/UserSettings/functions.php | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) (limited to 'plugins') diff --git a/plugins/UserSettings/functions.php b/plugins/UserSettings/functions.php index e1c5579608..44b8dafd12 100644 --- a/plugins/UserSettings/functions.php +++ b/plugins/UserSettings/functions.php @@ -153,6 +153,16 @@ function Piwik_getBrowserVersion($str) return substr($str, strpos($str, ';') + 1); } +function Piwik_getLogoImageFromId($dir, $id) +{ + $path = $dir.'/'.$id.'.gif'; + if (file_exists($path)) { + return $path; + } else { + return $dir.'/UNK.gif'; + } +} + function Piwik_getBrowsersLogo($label) { $id = Piwik_getBrowserId($label); @@ -160,7 +170,7 @@ function Piwik_getBrowsersLogo($label) if (empty($id)) { $id = 'UNK'; } - return 'plugins/UserSettings/images/browsers/' . $id . '.gif'; + return Piwik_getLogoImageFromId('plugins/UserSettings/images/browsers', $id); } function Piwik_getOSLogo($label) @@ -169,8 +179,7 @@ function Piwik_getOSLogo($label) if (empty($label)) { $label = 'UNK'; } - $path = 'plugins/UserSettings/images/os/' . $label . '.gif'; - return $path; + return Piwik_getLogoImageFromId('plugins/UserSettings/images/os', $label); } function Piwik_getScreensLogo($label) -- cgit v1.2.3 From 2394fe583c7ea20334157263c3d1547e883d4843 Mon Sep 17 00:00:00 2001 From: Benaka Moorthi Date: Sun, 26 May 2013 16:19:35 -0700 Subject: Tweak to last commit, use full path when checking if image exists. --- plugins/UserSettings/functions.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'plugins') diff --git a/plugins/UserSettings/functions.php b/plugins/UserSettings/functions.php index 44b8dafd12..80a63a589e 100644 --- a/plugins/UserSettings/functions.php +++ b/plugins/UserSettings/functions.php @@ -156,7 +156,7 @@ function Piwik_getBrowserVersion($str) function Piwik_getLogoImageFromId($dir, $id) { $path = $dir.'/'.$id.'.gif'; - if (file_exists($path)) { + if (file_exists(PIWIK_INCLUDE_PATH . '/' . $path)) { return $path; } else { return $dir.'/UNK.gif'; -- cgit v1.2.3 From 9824c498d7c180a17a562872b171f31c61da13f5 Mon Sep 17 00:00:00 2001 From: Benaka Moorthi Date: Sun, 26 May 2013 18:06:00 -0700 Subject: Make sure provider segment suggestion values use non-prettified provider values, add tests for getProvider report & provider segment, and fix build. --- plugins/Live/Visitor.php | 14 ++++++++++++-- plugins/Live/templates/lastVisits.tpl | 2 +- plugins/Live/templates/visitorLog.tpl | 6 +++--- 3 files changed, 16 insertions(+), 6 deletions(-) (limited to 'plugins') diff --git a/plugins/Live/Visitor.php b/plugins/Live/Visitor.php index 45a3ec7f08..fe839a67d8 100644 --- a/plugins/Live/Visitor.php +++ b/plugins/Live/Visitor.php @@ -85,6 +85,7 @@ class Piwik_Live_Visitor 'latitude' => $this->getLatitude(), 'longitude' => $this->getLongitude(), 'provider' => $this->getProvider(), + 'providerName' => $this->getProviderName(), 'providerUrl' => $this->getProviderUrl(), 'referrerType' => $this->getRefererType(), @@ -515,10 +516,19 @@ class Piwik_Live_Visitor { return Piwik_getScreensLogo($this->getScreenType()); } - + function getProvider() { - return Piwik_Provider_getPrettyProviderName(@$this->details['location_provider']); + if (isset($this->details['location_provider'])) { + return $this->details['location_provider']; + } else { + return Piwik_Translate('General_Unknown'); + } + } + + function getProviderName() + { + return Piwik_Provider_getPrettyProviderName($this->getProvider()); } function getProviderUrl() diff --git a/plugins/Live/templates/lastVisits.tpl b/plugins/Live/templates/lastVisits.tpl index 5a9ffec542..ef00a82217 100644 --- a/plugins/Live/templates/lastVisits.tpl +++ b/plugins/Live/templates/lastVisits.tpl @@ -8,7 +8,7 @@
    {$visitor.serverDatePretty} - {$visitor.serverTimePretty} {if $visitor.visitDuration > 0}({$visitor.visitDurationPretty}){/if} -   +         diff --git a/plugins/Live/templates/visitorLog.tpl b/plugins/Live/templates/visitorLog.tpl index 928fecc296..a64584b009 100644 --- a/plugins/Live/templates/visitorLog.tpl +++ b/plugins/Live/templates/visitorLog.tpl @@ -48,7 +48,7 @@ {capture assign='visitorColumnContent'}   - +   {if $visitor.columns.plugins} @@ -107,11 +107,11 @@ GPS (lat/long): {$visitor.columns.latitude|escape:'html'},{$visitor.columns.longitude|escape:'html'}{/if}"> IP: {$visitor.columns.visitIp}{/if} - {if (isset($visitor.columns.provider)&&$visitor.columns.provider!='IP')} + {if (isset($visitor.columns.providerName)&&$visitor.columns.providerName!='IP')}
    {'Provider_ColumnProvider'|translate}: - {$visitor.columns.provider} + {$visitor.columns.providerName} {/if} {if !empty($visitor.columns.customVariables)} -- cgit v1.2.3 From f75cbfdfe38d921507b43e87d0860f4aca22cbe2 Mon Sep 17 00:00:00 2001 From: Benaka Moorthi Date: Sun, 26 May 2013 19:42:01 -0700 Subject: Make sure total rows changes when switching between reports/report-views in browser. --- plugins/CoreHome/templates/datatable.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'plugins') diff --git a/plugins/CoreHome/templates/datatable.js b/plugins/CoreHome/templates/datatable.js index a0a9b4afd4..8dc9f61d8d 100644 --- a/plugins/CoreHome/templates/datatable.js +++ b/plugins/CoreHome/templates/datatable.js @@ -84,7 +84,8 @@ dataTable.prototype = 'disable_generic_filters', 'columns', 'flat', - 'include_aggregate_rows' + 'include_aggregate_rows', + 'totalRows' ]; for (var key in filters) { -- cgit v1.2.3 From fd0cdc89ffac8ff5d1574a0824a39a26f7dbaeee Mon Sep 17 00:00:00 2001 From: Benaka Moorthi Date: Sun, 26 May 2013 20:57:31 -0700 Subject: Make sure clicking on calendar icon in period select shows period selector dropdown. --- plugins/CoreHome/templates/date.js | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) (limited to 'plugins') diff --git a/plugins/CoreHome/templates/date.js b/plugins/CoreHome/templates/date.js index 9e4ca30c72..776ac417ae 100644 --- a/plugins/CoreHome/templates/date.js +++ b/plugins/CoreHome/templates/date.js @@ -23,18 +23,12 @@ $(document).ready(function () { } }; - $("#periodString").find("#date") - .hover(function () { - $(this).css({ cursor: "pointer"}); - }, function () { - - }) - .click(function () { - periodWidget.toggle(); - if ($("#periodMore").is(":visible")) { - $("#periodMore").find(".ui-state-highlight").removeClass('ui-state-highlight'); - } - }); + $("#periodString").on('click', "#date,.calendar-icon", function () { + periodWidget.toggle(); + if ($("#periodMore").is(":visible")) { + $("#periodMore").find(".ui-state-highlight").removeClass('ui-state-highlight'); + } + }); //close periodString onClickOutside $('body').on('mouseup', function (e) { -- cgit v1.2.3 From 047586ce989d5a5a5b451612963fa1324538c568 Mon Sep 17 00:00:00 2001 From: Benaka Moorthi Date: Sun, 26 May 2013 21:25:05 -0700 Subject: Fixes #3956, don't rename last piece of data to Others in Pie static graph (in ImageGraph) since logic is handled by truncate filter. --- plugins/ImageGraph/StaticGraph/PieGraph.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'plugins') diff --git a/plugins/ImageGraph/StaticGraph/PieGraph.php b/plugins/ImageGraph/StaticGraph/PieGraph.php index d2b8df51c5..a44bf79418 100644 --- a/plugins/ImageGraph/StaticGraph/PieGraph.php +++ b/plugins/ImageGraph/StaticGraph/PieGraph.php @@ -114,7 +114,7 @@ abstract class Piwik_ImageGraph_StaticGraph_PieGraph extends Piwik_ImageGraph_St $smallValuesSum += $this->ordinateSeries[$metricColumn][$ordinateValuesCount - 1]; if (($smallValuesSum / $ordinateValuesSum) > 0.01) { $truncatedOrdinateSeries[$metricColumn][] = $smallValuesSum; - $truncatedAbscissaSeries[] = Piwik_Translate('General_Others'); + $truncatedAbscissaSeries[] = end($this->abscissaSeries); } $this->ordinateSeries = $truncatedOrdinateSeries; -- cgit v1.2.3 From 32266f76b737d4da7394d4501470d8d0620405d7 Mon Sep 17 00:00:00 2001 From: mattab Date: Mon, 27 May 2013 17:05:46 +1200 Subject: hiding segment loading message when SegmentEditor plugin disabled --- plugins/SegmentEditor/templates/Segmentation.css | 7 ------- 1 file changed, 7 deletions(-) (limited to 'plugins') diff --git a/plugins/SegmentEditor/templates/Segmentation.css b/plugins/SegmentEditor/templates/Segmentation.css index 7468b33fe7..76c3464a41 100644 --- a/plugins/SegmentEditor/templates/Segmentation.css +++ b/plugins/SegmentEditor/templates/Segmentation.css @@ -4,13 +4,6 @@ font-style: italic; } -.loadingSegment { - color: grey; - display: block; - font-size: 10pt; - margin-left: 28px; - display:none; -} .segment-footer .segmentFooterNote { display:none; float: left; -- cgit v1.2.3 From 0a3f274286713aa55b2c00eb43e1c8ec40686279 Mon Sep 17 00:00:00 2001 From: mattab Date: Wed, 29 May 2013 15:18:09 +1200 Subject: Small fixes for issues reported in forum + Doc API --- plugins/SegmentEditor/API.php | 51 +++++++++++++++++++----- plugins/SegmentEditor/templates/Segmentation.css | 2 +- plugins/SegmentEditor/templates/Segmentation.js | 3 +- 3 files changed, 42 insertions(+), 14 deletions(-) (limited to 'plugins') diff --git a/plugins/SegmentEditor/API.php b/plugins/SegmentEditor/API.php index f94683db24..ad420009ea 100644 --- a/plugins/SegmentEditor/API.php +++ b/plugins/SegmentEditor/API.php @@ -10,7 +10,7 @@ */ /** - * The SegmentEditor API lets you add, update, delete custom Segments, and list saved segments. + * The SegmentEditor API lets you add, update, delete custom Segments, and list saved segments.a * * @package Piwik_SegmentEditor */ @@ -66,11 +66,6 @@ class Piwik_SegmentEditor_API return $enabledAllUsers; } - - /** - * @param $idSite - * @throws Exception - */ protected function checkIdSite($idSite) { if (empty($idSite)) { @@ -105,10 +100,6 @@ class Piwik_SegmentEditor_API return $autoArchive; } - /** - * @param $idSegment - * @throws Exception - */ protected function getSegmentOrFail($idSegment) { $segment = $this->get($idSegment); @@ -126,6 +117,11 @@ class Piwik_SegmentEditor_API } } + /** + * Deletes a stored segment. + * + * @param $idSegment + */ public function delete($idSegment) { $this->checkUserIsNotAnonymous(); @@ -139,6 +135,17 @@ class Piwik_SegmentEditor_API return true; } + /** + * Modifies an existing stored segment. + * + * @param $idSegment The ID of the stored segment to modify. + * @param $name The new name of the segment. + * @param $definition The new definition of the segment. + * @param bool $idSite If supplied, associates the stored segment with as single site. + * @param bool $autoArchive Whether to automatically archive data with the segment or not. + * @param bool $enabledAllUsers Whether the stored segment is viewable by all users or just the one that created it. + * + */ public function update($idSegment, $name, $definition, $idSite = false, $autoArchive = false, $enabledAllUsers = false) { $this->checkUserIsNotAnonymous(); @@ -167,7 +174,17 @@ class Piwik_SegmentEditor_API return true; } - + /** + * Adds a new stored segment. + * + * @param $name The new name of the segment. + * @param $definition The new definition of the segment. + * @param bool $idSite If supplied, associates the stored segment with as single site. + * @param bool $autoArchive Whether to automatically archive data with the segment or not. + * @param bool $enabledAllUsers Whether the stored segment is viewable by all users or just the one that created it. + * + * @return int The newly created segment Id + */ public function add($name, $definition, $idSite = false, $autoArchive = false, $enabledAllUsers = false) { $this->checkUserIsNotAnonymous(); @@ -192,6 +209,11 @@ class Piwik_SegmentEditor_API return $db->lastInsertId(); } + /** + * Returns a stored segment by ID + * + * @param $idSegment + */ public function get($idSegment) { Piwik::checkUserHasSomeViewAccess(); @@ -218,6 +240,13 @@ class Piwik_SegmentEditor_API return $segment; } + /** + * Returns all stored segments. + * + * @param bool $idSite Whether to return stored segments that are only auto-archived for a specific idSite, or all of them. If supplied, must be a valid site ID. + * @param bool $returnOnlyAutoArchived Whether to only return stored segments that are auto-archived or not. + * @return array + */ public function getAll($idSite = false, $returnOnlyAutoArchived = false) { if(!empty($idSite) ) { diff --git a/plugins/SegmentEditor/templates/Segmentation.css b/plugins/SegmentEditor/templates/Segmentation.css index 76c3464a41..fdf3b477ac 100644 --- a/plugins/SegmentEditor/templates/Segmentation.css +++ b/plugins/SegmentEditor/templates/Segmentation.css @@ -367,7 +367,7 @@ div.scrollable { } .segment-element .segment-footer button { - width: 178px; + min-width: 178px; height: 30px; background-image: url(data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiA/Pgo8c3ZnIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgd2lkdGg9IjEwMCUiIGhlaWdodD0iMTAwJSIgdmlld0JveD0iMCAwIDE3OCAzMCIgcHJlc2VydmVBc3BlY3RSYXRpbz0ibm9uZSI+PGxpbmVhckdyYWRpZW50IGlkPSJoYXQwIiBncmFkaWVudFVuaXRzPSJvYmplY3RCb3VuZGluZ0JveCIgeDE9IjUwJSIgeTE9IjEwMCUiIHgyPSI1MCUiIHkyPSItMS40MjEwODU0NzE1MjAyZS0xNCUiPgo8c3RvcCBvZmZzZXQ9IjAlIiBzdG9wLWNvbG9yPSIjODM3OTZiIiBzdG9wLW9wYWNpdHk9IjEiLz4KPHN0b3Agb2Zmc2V0PSIxMDAlIiBzdG9wLWNvbG9yPSIjYWJhMzkzIiBzdG9wLW9wYWNpdHk9IjEiLz4KICAgPC9saW5lYXJHcmFkaWVudD4KCjxyZWN0IHg9IjAiIHk9IjAiIHdpZHRoPSIxNzgiIGhlaWdodD0iMzAiIGZpbGw9InVybCgjaGF0MCkiIC8+Cjwvc3ZnPg==); background-image: -moz-linear-gradient(bottom, #83796b 0%, #aba393 100%); diff --git a/plugins/SegmentEditor/templates/Segmentation.js b/plugins/SegmentEditor/templates/Segmentation.js index a44ef86598..d343eb0f1a 100644 --- a/plugins/SegmentEditor/templates/Segmentation.js +++ b/plugins/SegmentEditor/templates/Segmentation.js @@ -1100,10 +1100,9 @@ $(document).ready( function(){ $("#segmentList").show(); } - if($(e.target).parents('.segmentList').length === 0 && $(".segmentationContainer").hasClass("visible")){ + if($(e.target).parents('#segmentList').length === 0 && $(".segmentationContainer").hasClass("visible")){ $(".segmentationContainer").trigger("click"); } - }); }); \ No newline at end of file -- cgit v1.2.3 From 13481874334755273e56fa06581c6b90128a1d62 Mon Sep 17 00:00:00 2001 From: mattab Date: Wed, 29 May 2013 22:07:50 +1200 Subject: Fixing wrong display in selector --- plugins/SegmentEditor/Controller.php | 2 +- plugins/SegmentEditor/templates/Segmentation.js | 7 +++++-- 2 files changed, 6 insertions(+), 3 deletions(-) (limited to 'plugins') diff --git a/plugins/SegmentEditor/Controller.php b/plugins/SegmentEditor/Controller.php index f61239798a..9703cbe6b3 100644 --- a/plugins/SegmentEditor/Controller.php +++ b/plugins/SegmentEditor/Controller.php @@ -38,7 +38,7 @@ class Piwik_SegmentEditor_Controller extends Piwik_Controller $savedSegments = Piwik_SegmentEditor_API::getInstance()->getAll($idSite); foreach($savedSegments as &$savedSegment) { - $savedSegment['definition'] = str_replace( ''', "'", $savedSegment['definition']); + $savedSegment['name'] = Piwik_Common::sanitizeInputValue($savedSegment['name']); } $view->savedSegmentsJson = Piwik_Common::json_encode($savedSegments); $view->authorizedToCreateSegments = !Piwik::isUserIsAnonymous(); diff --git a/plugins/SegmentEditor/templates/Segmentation.js b/plugins/SegmentEditor/templates/Segmentation.js index d343eb0f1a..8f38611b6d 100644 --- a/plugins/SegmentEditor/templates/Segmentation.js +++ b/plugins/SegmentEditor/templates/Segmentation.js @@ -213,7 +213,7 @@ Segmentation = (function($) { if( segment.definition == self.currentSegmentStr){ injClass = 'class="segmentSelected"'; } - listHtml += '
  • ' + self.shortenSegmentName(segment.name)+''; if(self.segmentAccess == "write") { @@ -250,7 +250,7 @@ Segmentation = (function($) { for(var key in self.availableSegments) { segment = self.availableSegments[key]; - newOption = ''; + newOption = ''; segmentsDropdown.append(newOption); } $(html).find(".segment-content > h3").after(getInitialStateRowsHtml()).show(); @@ -397,6 +397,7 @@ Segmentation = (function($) { segment.idsegment = $(this).attr("data-idsegment"); segment.definition = $(this).data("definition"); segment.name = $(this).attr("title"); + self.segmentSelectMethod( segment.definition ); toggleLoadingMessage( segment.definition.length ); setSegment(segment.definition); @@ -516,7 +517,9 @@ Segmentation = (function($) { { segment[item] = segmentExtra[item]; } + segment.name = option.attr("title"); + segment.definition = option.data("definition"); openEditForm(segment); -- cgit v1.2.3 From e8cc57830af7c639d3d305eaa43570cda262b78b Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 30 May 2013 08:47:47 +1200 Subject: minor --- plugins/CoreHome/templates/reports_by_dimension.tpl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'plugins') diff --git a/plugins/CoreHome/templates/reports_by_dimension.tpl b/plugins/CoreHome/templates/reports_by_dimension.tpl index e18f560958..e39c808e48 100644 --- a/plugins/CoreHome/templates/reports_by_dimension.tpl +++ b/plugins/CoreHome/templates/reports_by_dimension.tpl @@ -16,7 +16,7 @@ {/foreach}
    • -
    +
    -- cgit v1.2.3 From 51ad9e7459fc28f470e12fdec833ca8dd637861e Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 30 May 2013 12:38:44 +1200 Subject: Fixing bug in SEO template, and tweaking readme --- plugins/SEO/templates/index.tpl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'plugins') diff --git a/plugins/SEO/templates/index.tpl b/plugins/SEO/templates/index.tpl index 0a100bddb3..4145414f68 100644 --- a/plugins/SEO/templates/index.tpl +++ b/plugins/SEO/templates/index.tpl @@ -23,8 +23,8 @@ {foreach from=$ranks item=rank} - {capture assign=seoLink}{/capture} +{capture assign=seoLink}{if !empty($rank.logo_link)}{/if}{/capture} {capture assign=majesticLink}{$seoLink}Majestic{/capture}
    {if !empty($rank.logo_link)}{$seoLink}{/if} Date: Thu, 30 May 2013 16:59:23 +1200 Subject: fixes #3961 Adding new segment deviceType --- plugins/DevicesDetection/API.php | 4 +- plugins/DevicesDetection/DevicesDetection.php | 167 +++++++++++++-------- .../UserAgentParserEnhanced.php | 2 +- plugins/DevicesDetection/functions.php | 2 +- plugins/Live/Visitor.php | 9 ++ 5 files changed, 114 insertions(+), 70 deletions(-) (limited to 'plugins') diff --git a/plugins/DevicesDetection/API.php b/plugins/DevicesDetection/API.php index 32dca0760b..c6572f28ad 100644 --- a/plugins/DevicesDetection/API.php +++ b/plugins/DevicesDetection/API.php @@ -9,9 +9,6 @@ * @category Piwik_Plugins * @package Piwik_DevicesDetection */ -require_once PIWIK_INCLUDE_PATH . '/plugins/DevicesDetection/functions.php'; -require_once PIWIK_INCLUDE_PATH . '/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php'; - class Piwik_DevicesDetection_API { @@ -60,6 +57,7 @@ class Piwik_DevicesDetection_API { $dataTable = $this->getDataTable('DevicesDetection_types', $idSite, $period, $date, $segment); $dataTable->filter('ColumnCallbackReplace', array('label', 'Piwik_getDeviceTypeLabel')); + $dataTable->filter('ColumnCallbackReplace', array('label', 'ucfirst')); $dataTable->filter('ColumnCallbackAddMetadata', array('label', 'logo', 'Piwik_getDeviceTypeLogo')); return $dataTable; } diff --git a/plugins/DevicesDetection/DevicesDetection.php b/plugins/DevicesDetection/DevicesDetection.php index d18f768b21..2f97c48203 100644 --- a/plugins/DevicesDetection/DevicesDetection.php +++ b/plugins/DevicesDetection/DevicesDetection.php @@ -9,7 +9,8 @@ * @category Piwik_Plugins * @package Piwik_DevicesDetection */ -require_once "UserAgentParserEnhanced/UserAgentParserEnhanced.php"; +require_once PIWIK_INCLUDE_PATH . "/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php"; +require_once PIWIK_INCLUDE_PATH . '/plugins/DevicesDetection/functions.php'; class Piwik_DevicesDetection extends Piwik_Plugin { @@ -32,70 +33,78 @@ class Piwik_DevicesDetection extends Piwik_Plugin /* * Defines API reports. - * Also used to define Widgets. + * Also used to define Widgets, and Segment(s) + * + * @return array Category, Report Name, API Module, API action, Translated column name, & optional segment info * - * @array Category, Report Name, API Module, API action, Translated column name, - * W */ - - protected $reportMetadata = array( - // device types report - array( - 'DevicesDetection_DevicesDetection', - 'DevicesDetection_DeviceType', - 'DevicesDetection', - 'getType', - 'DevicesDetection_DeviceType', - ), - // device brands report - array( - 'DevicesDetection_DevicesDetection', - 'DevicesDetection_DeviceBrand', - 'DevicesDetection', - 'getBrand', - 'DevicesDetection_DeviceBrand', - ), - // device model report - array( - 'DevicesDetection_DevicesDetection', - 'DevicesDetection_DeviceModel', - 'DevicesDetection', - 'getModel', - 'DevicesDetection_DeviceModel', - ), - // device OS family report - array( - 'DevicesDetection_DevicesDetection', - 'DeviceDetection_OperatingSystemFamilies', - 'DevicesDetection', - 'getOsFamilies', - 'DeviceDetection_OperatingSystemFamilies', - ), - // device OS version report - array( - 'DevicesDetection_DevicesDetection', - 'DeviceDetection_OperatingSystemVersions', - 'DevicesDetection', - 'getOsVersions', - 'DeviceDetection_OperatingSystemVersions', - ), - // Browser family report - array( - 'DevicesDetection_DevicesDetection', - 'DevicesDetection_BrowsersFamily', - 'DevicesDetection', - 'getBrowserFamilies', - 'DevicesDetection_BrowsersFamily', - ), - // Browser versions report - array( - 'DevicesDetection_DevicesDetection', - 'DevicesDetection_BrowserVersions', - 'DevicesDetection', - 'getBrowserVersions', - 'DevicesDetection_BrowserVersions', - ), - ); + protected function getRawMetadataReports() + { + $report = array( + array( + 'DevicesDetection_DevicesDetection', + 'DevicesDetection_DeviceType', + 'DevicesDetection', + 'getType', + 'DevicesDetection_DeviceType', + + // Segment + 'deviceType', + 'log_visit.config_device_type', + implode(", ", UserAgentParserEnhanced::$deviceTypes), // comma separated examples + create_function('$type', 'return array_search( strtolower(trim(urldecode($type))), UserAgentParserEnhanced::$deviceTypes);') + ), + // device brands report + array( + 'DevicesDetection_DevicesDetection', + 'DevicesDetection_DeviceBrand', + 'DevicesDetection', + 'getBrand', + 'DevicesDetection_DeviceBrand', + ), + // device model report + array( + 'DevicesDetection_DevicesDetection', + 'DevicesDetection_DeviceModel', + 'DevicesDetection', + 'getModel', + 'DevicesDetection_DeviceModel', + ), + // device OS family report + array( + 'DevicesDetection_DevicesDetection', + 'DeviceDetection_OperatingSystemFamilies', + 'DevicesDetection', + 'getOsFamilies', + 'DeviceDetection_OperatingSystemFamilies', + ), + // device OS version report + array( + 'DevicesDetection_DevicesDetection', + 'DeviceDetection_OperatingSystemVersions', + 'DevicesDetection', + 'getOsVersions', + 'DeviceDetection_OperatingSystemVersions', + ), + // Browser family report + array( + 'DevicesDetection_DevicesDetection', + 'DevicesDetection_BrowsersFamily', + 'DevicesDetection', + 'getBrowserFamilies', + 'DevicesDetection_BrowsersFamily', + ), + // Browser versions report + array( + 'DevicesDetection_DevicesDetection', + 'DevicesDetection_BrowserVersions', + 'DevicesDetection', + 'getBrowserVersions', + 'DevicesDetection_BrowserVersions', + ), + ); + return $report; + } public function getListHooksRegistered() { @@ -106,12 +115,13 @@ class Piwik_DevicesDetection extends Piwik_Plugin 'Tracker.newVisitorInformation' => 'parseMobileVisitData', 'WidgetsList.add' => 'addWidgets', 'API.getReportMetadata' => 'getReportMetadata', + 'API.getSegmentsMetadata' => 'getSegmentsMetadata', ); } public function addWidgets() { - foreach ($this->reportMetadata as $report) { + foreach ($this->getRawMetadataReports() as $report) { list($category, $name, $controllerName, $controllerAction) = $report; if ($category == false) continue; @@ -119,6 +129,33 @@ class Piwik_DevicesDetection extends Piwik_Plugin } } + + /** + * Get segments meta data + * + * @param Piwik_Event_Notification $notification notification object + */ + public function getSegmentsMetadata($notification) + { + // Note: only one field segmented so far: deviceType + $segments =& $notification->getNotificationObject(); + foreach ($this->getRawMetadataReports() as $report) { + @list($category, $name, $apiModule, $apiAction, $columnName, $segment, $sqlSegment, $acceptedValues) = $report; + + if (empty($segment)) continue; + $segments[] = array( + 'type' => 'dimension', + 'category' => Piwik_Translate('General_Visit'), + 'name' => $columnName, + 'segment' => $segment, + 'acceptedValues' => $acceptedValues, + 'sqlSegment' => $sqlSegment, + 'sqlFilter' => isset($sqlFilter) ? $sqlFilter : false, + ); + } + } + + /** * @param Piwik_Event_Notification $notification notification object */ @@ -127,7 +164,7 @@ class Piwik_DevicesDetection extends Piwik_Plugin $reports = & $notification->getNotificationObject(); $i = 0; - foreach ($this->reportMetadata as $report) { + foreach ($this->getRawMetadataReports() as $report) { list($category, $name, $apiModule, $apiAction, $columnName) = $report; if ($category == false) continue; diff --git a/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php b/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php index 300b02d04c..d67c26f755 100644 --- a/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php +++ b/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php @@ -14,8 +14,8 @@ require_once('spyc.php'); class UserAgentParserEnhanced { + public static $deviceTypes = array( 'desktop', 'smartphone', 'tablet', 'feature phone', 'console', 'tv', 'car browser' ); - public static $deviceTypes = array('car browser', 'console', 'desktop', 'feature phone', 'smartphone', 'tablet', 'tv'); public static $deviceBrands = array( 'AC' => 'Acer', 'AI' => 'Airness', diff --git a/plugins/DevicesDetection/functions.php b/plugins/DevicesDetection/functions.php index 7bf70a98c6..4819cd6974 100644 --- a/plugins/DevicesDetection/functions.php +++ b/plugins/DevicesDetection/functions.php @@ -72,7 +72,7 @@ function Piwik_getDeviceBrandLabel($label) function Piwik_getDeviceTypeLabel($label) { if (isset(UserAgentParserEnhanced::$deviceTypes[$label])) { - return ucfirst(UserAgentParserEnhanced::$deviceTypes[$label]); + return UserAgentParserEnhanced::$deviceTypes[$label]; } else { return Piwik_Translate('General_Unknown'); } diff --git a/plugins/Live/Visitor.php b/plugins/Live/Visitor.php index fe839a67d8..8a8c984021 100644 --- a/plugins/Live/Visitor.php +++ b/plugins/Live/Visitor.php @@ -107,6 +107,7 @@ class Piwik_Live_Visitor 'browserCode' => $this->getBrowserCode(), 'browserVersion' => $this->getBrowserVersion(), 'screenType' => $this->getScreenType(), + 'deviceType' => $this->getDeviceType(), 'resolution' => $this->getResolution(), 'screenTypeIcon' => $this->getScreenTypeIcon(), 'plugins' => $this->getPlugins(), @@ -507,6 +508,14 @@ class Piwik_Live_Visitor return Piwik_getScreenTypeFromResolution($this->details['config_resolution']); } + function getDeviceType() + { + if(Piwik_PluginsManager::getInstance()->isPluginActivated('DevicesDetection')) { + return Piwik_getDeviceTypeLabel($this->details['config_device_type']); + } + return false; + } + function getResolution() { return $this->details['config_resolution']; -- cgit v1.2.3 From 6abbacb9575087161ade571de2b0ad373b03d115 Mon Sep 17 00:00:00 2001 From: Benaka Moorthi Date: Fri, 31 May 2013 00:36:25 -0700 Subject: Refactored archive data querying code. Removed tree-like data structure from Piwik_Archive, added memory optimizations for archiving (not storing archive processing instances), added optimization for querying data indexed by site + date, added ability to select multiple blobs/metrics at once (from different plugins), added optimization to Piwik_ArchiveProcessing_Period where numerics/records are selected all at once instead of one at a time. Also added data access layer object for archive querying code, allowed anonymous function objects to be used as DataTable filters, and removed 'timestamp' DataTable metadata. --- plugins/Goals/API.php | 3 ++- plugins/MultiSites/API.php | 4 +++- plugins/UserSettings/API.php | 14 +++++++++----- plugins/VisitTime/API.php | 1 + plugins/VisitsSummary/API.php | 7 ++++--- 5 files changed, 19 insertions(+), 10 deletions(-) (limited to 'plugins') diff --git a/plugins/Goals/API.php b/plugins/Goals/API.php index aea16ad70e..ad58ec4310 100644 --- a/plugins/Goals/API.php +++ b/plugins/Goals/API.php @@ -210,6 +210,7 @@ class Piwik_Goals_API } $archive = Piwik_Archive::build($idSite, $period, $date); $dataTable = $archive->getDataTable($recordNameFinal); + $dataTable->filter('Sort', array(Piwik_Archive::INDEX_ECOMMERCE_ITEM_REVENUE)); $dataTable->queueFilter('ReplaceColumnNames'); $dataTable->queueFilter('ReplaceSummaryRowLabel'); @@ -428,7 +429,7 @@ class Piwik_Goals_API { Piwik::checkUserHasViewAccess($idSite); $archive = Piwik_Archive::build($idSite, $period, $date, $segment); - $dataTable = $archive->getNumeric($toFetch); + $dataTable = $archive->getDataTableFromNumeric($toFetch); return $dataTable; } diff --git a/plugins/MultiSites/API.php b/plugins/MultiSites/API.php index b6b0a4d1ae..5aba1c4764 100755 --- a/plugins/MultiSites/API.php +++ b/plugins/MultiSites/API.php @@ -218,7 +218,9 @@ class Piwik_MultiSites_API ) { $dataTable = $dataTable->mergeChildren(); } else { - if (!$dataTable instanceof Piwik_DataTable_Array) { + if (!$dataTable instanceof Piwik_DataTable_Array + && $dataTable->getRowsCount() > 0 + ) { $firstDataTableRow = $dataTable->getFirstRow(); $firstDataTableRow->setColumn('label', $sites); } diff --git a/plugins/UserSettings/API.php b/plugins/UserSettings/API.php index e438b96b2f..dd3820fff7 100644 --- a/plugins/UserSettings/API.php +++ b/plugins/UserSettings/API.php @@ -171,7 +171,7 @@ class Piwik_UserSettings_API $dataTable = $this->getDataTable('UserSettings_plugin', $idSite, $period, $date, $segment); $browserTypes = $this->getDataTable('UserSettings_browserType', $idSite, $period, $date, $segment); $archive = Piwik_Archive::build($idSite, $period, $date, $segment); - $visitsSums = $archive->getNumeric('nb_visits'); + $visitsSums = $archive->getDataTableFromNumeric('nb_visits'); // check whether given tables are arrays if ($dataTable instanceof Piwik_DataTable_Array) { @@ -179,9 +179,9 @@ class Piwik_UserSettings_API $browserTypesArray = $browserTypes->getArray(); $visitSumsArray = $visitsSums->getArray(); } else { - $tableArray = Array($dataTable); - $browserTypesArray = Array($browserTypes); - $visitSumsArray = Array($visitsSums); + $tableArray = array($dataTable); + $browserTypesArray = array($browserTypes); + $visitSumsArray = array($visitsSums); } // walk through the results and calculate the percentage @@ -198,7 +198,11 @@ class Piwik_UserSettings_API foreach ($visitSumsArray AS $k => $visits) { if ($k == $key) { if (is_object($visits)) { - $visitsSumTotal = (float)$visits->getFirstRow()->getColumn(0); + if ($visits->getRowsCount() == 0) { + $visitsSumTotal = 0; + } else { + $visitsSumTotal = (float)$visits->getFirstRow()->getColumn('nb_visits'); + } } else { $visitsSumTotal = (float)$visits; } diff --git a/plugins/VisitTime/API.php b/plugins/VisitTime/API.php index 3da0646fb7..973a8d3dd8 100644 --- a/plugins/VisitTime/API.php +++ b/plugins/VisitTime/API.php @@ -85,6 +85,7 @@ class Piwik_VisitTime_API $dataTable = $archive->getDataTableFromNumeric($metrics)->mergeChildren(); // if there's no data for this report, don't bother w/ anything else + // TODO: with changes to getDataTableFromNumeric, this code would have to check if every row has 0 column values. is it really necessary? (assuming no for now) if ($dataTable->getRowsCount() == 0) { return $dataTable; } diff --git a/plugins/VisitsSummary/API.php b/plugins/VisitsSummary/API.php index 0864c517b5..9221d941bd 100644 --- a/plugins/VisitsSummary/API.php +++ b/plugins/VisitsSummary/API.php @@ -100,7 +100,7 @@ class Piwik_VisitsSummary_API { Piwik::checkUserHasViewAccess($idSite); $archive = Piwik_Archive::build($idSite, $period, $date, $segment); - $dataTable = $archive->getNumeric($toFetch); + $dataTable = $archive->getDataTableFromNumeric($toFetch); return $dataTable; } @@ -142,8 +142,9 @@ class Piwik_VisitsSummary_API public function getSumVisitsLengthPretty($idSite, $period, $date, $segment = false) { $table = $this->getSumVisitsLength($idSite, $period, $date, $segment); - if ($table instanceof Piwik_DataTable_Array) { - $table->filter('ColumnCallbackReplace', array(0, array('Piwik', 'getPrettyTimeFromSeconds'))); + if (is_object($table)) { + $table->filter('ColumnCallbackReplace', + array('sum_visit_length', array('Piwik', 'getPrettyTimeFromSeconds'))); } else { $table = Piwik::getPrettyTimeFromSeconds($table); } -- cgit v1.2.3 From 631bacf0b31dde12531d39a57a0e6eaf7a0e0388 Mon Sep 17 00:00:00 2001 From: sgiehl Date: Sat, 1 Jun 2013 18:23:43 +0200 Subject: added missing search engine; refactored & fixed search engine tests --- .../UserAgentParserEnhanced/spyc.php | 1046 -------------------- 1 file changed, 1046 deletions(-) delete mode 100644 plugins/DevicesDetection/UserAgentParserEnhanced/spyc.php (limited to 'plugins') diff --git a/plugins/DevicesDetection/UserAgentParserEnhanced/spyc.php b/plugins/DevicesDetection/UserAgentParserEnhanced/spyc.php deleted file mode 100644 index e19d562035..0000000000 --- a/plugins/DevicesDetection/UserAgentParserEnhanced/spyc.php +++ /dev/null @@ -1,1046 +0,0 @@ - - * @author Chris Wanstrath - * @link http://code.google.com/p/spyc/ - * @copyright Copyright 2005-2006 Chris Wanstrath, 2006-2011 Vlad Andersen - * @license http://www.opensource.org/licenses/mit-license.php MIT License - * @package Spyc - */ - -if (!function_exists('spyc_load')) { - /** - * Parses YAML to array. - * @param string $string YAML string. - * @return array - */ - function spyc_load ($string) { - return Spyc::YAMLLoadString($string); - } -} - -if (!function_exists('spyc_load_file')) { - /** - * Parses YAML to array. - * @param string $file Path to YAML file. - * @return array - */ - function spyc_load_file ($file) { - return Spyc::YAMLLoad($file); - } -} - -/** - * The Simple PHP YAML Class. - * - * This class can be used to read a YAML file and convert its contents - * into a PHP array. It currently supports a very limited subsection of - * the YAML spec. - * - * Usage: - * - * $Spyc = new Spyc; - * $array = $Spyc->load($file); - * - * or: - * - * $array = Spyc::YAMLLoad($file); - * - * or: - * - * $array = spyc_load_file($file); - * - * @package Spyc - */ -class Spyc { - - // SETTINGS - - const REMPTY = "\0\0\0\0\0"; - - /** - * Setting this to true will force YAMLDump to enclose any string value in - * quotes. False by default. - * - * @var bool - */ - public $setting_dump_force_quotes = false; - - /** - * Setting this to true will forse YAMLLoad to use syck_load function when - * possible. False by default. - * @var bool - */ - public $setting_use_syck_is_possible = false; - - - - /**#@+ - * @access private - * @var mixed - */ - private $_dumpIndent; - private $_dumpWordWrap; - private $_containsGroupAnchor = false; - private $_containsGroupAlias = false; - private $path; - private $result; - private $LiteralPlaceHolder = '___YAML_Literal_Block___'; - private $SavedGroups = array(); - private $indent; - /** - * Path modifier that should be applied after adding current element. - * @var array - */ - private $delayedPath = array(); - - /**#@+ - * @access public - * @var mixed - */ - public $_nodeId; - -/** - * Load a valid YAML string to Spyc. - * @param string $input - * @return array - */ - public function load ($input) { - return $this->__loadString($input); - } - - /** - * Load a valid YAML file to Spyc. - * @param string $file - * @return array - */ - public function loadFile ($file) { - return $this->__load($file); - } - - /** - * Load YAML into a PHP array statically - * - * The load method, when supplied with a YAML stream (string or file), - * will do its best to convert YAML in a file into a PHP array. Pretty - * simple. - * Usage: - * - * $array = Spyc::YAMLLoad('lucky.yaml'); - * print_r($array); - * - * @access public - * @return array - * @param string $input Path of YAML file or string containing YAML - */ - public static function YAMLLoad($input) { - $Spyc = new Spyc; - return $Spyc->__load($input); - } - - /** - * Load a string of YAML into a PHP array statically - * - * The load method, when supplied with a YAML string, will do its best - * to convert YAML in a string into a PHP array. Pretty simple. - * - * Note: use this function if you don't want files from the file system - * loaded and processed as YAML. This is of interest to people concerned - * about security whose input is from a string. - * - * Usage: - * - * $array = Spyc::YAMLLoadString("---\n0: hello world\n"); - * print_r($array); - * - * @access public - * @return array - * @param string $input String containing YAML - */ - public static function YAMLLoadString($input) { - $Spyc = new Spyc; - return $Spyc->__loadString($input); - } - - /** - * Dump YAML from PHP array statically - * - * The dump method, when supplied with an array, will do its best - * to convert the array into friendly YAML. Pretty simple. Feel free to - * save the returned string as nothing.yaml and pass it around. - * - * Oh, and you can decide how big the indent is and what the wordwrap - * for folding is. Pretty cool -- just pass in 'false' for either if - * you want to use the default. - * - * Indent's default is 2 spaces, wordwrap's default is 40 characters. And - * you can turn off wordwrap by passing in 0. - * - * @access public - * @return string - * @param array $array PHP array - * @param int $indent Pass in false to use the default, which is 2 - * @param int $wordwrap Pass in 0 for no wordwrap, false for default (40) - */ - public static function YAMLDump($array,$indent = false,$wordwrap = false) { - $spyc = new Spyc; - return $spyc->dump($array,$indent,$wordwrap); - } - - - /** - * Dump PHP array to YAML - * - * The dump method, when supplied with an array, will do its best - * to convert the array into friendly YAML. Pretty simple. Feel free to - * save the returned string as tasteful.yaml and pass it around. - * - * Oh, and you can decide how big the indent is and what the wordwrap - * for folding is. Pretty cool -- just pass in 'false' for either if - * you want to use the default. - * - * Indent's default is 2 spaces, wordwrap's default is 40 characters. And - * you can turn off wordwrap by passing in 0. - * - * @access public - * @return string - * @param array $array PHP array - * @param int $indent Pass in false to use the default, which is 2 - * @param int $wordwrap Pass in 0 for no wordwrap, false for default (40) - */ - public function dump($array,$indent = false,$wordwrap = false) { - // Dumps to some very clean YAML. We'll have to add some more features - // and options soon. And better support for folding. - - // New features and options. - if ($indent === false or !is_numeric($indent)) { - $this->_dumpIndent = 2; - } else { - $this->_dumpIndent = $indent; - } - - if ($wordwrap === false or !is_numeric($wordwrap)) { - $this->_dumpWordWrap = 40; - } else { - $this->_dumpWordWrap = $wordwrap; - } - - // New YAML document - $string = "---\n"; - - // Start at the base of the array and move through it. - if ($array) { - $array = (array)$array; - $previous_key = -1; - foreach ($array as $key => $value) { - if (!isset($first_key)) $first_key = $key; - $string .= $this->_yamlize($key,$value,0,$previous_key, $first_key, $array); - $previous_key = $key; - } - } - return $string; - } - - /** - * Attempts to convert a key / value array item to YAML - * @access private - * @return string - * @param $key The name of the key - * @param $value The value of the item - * @param $indent The indent of the current node - */ - private function _yamlize($key,$value,$indent, $previous_key = -1, $first_key = 0, $source_array = null) { - if (is_array($value)) { - if (empty ($value)) - return $this->_dumpNode($key, array(), $indent, $previous_key, $first_key, $source_array); - // It has children. What to do? - // Make it the right kind of item - $string = $this->_dumpNode($key, self::REMPTY, $indent, $previous_key, $first_key, $source_array); - // Add the indent - $indent += $this->_dumpIndent; - // Yamlize the array - $string .= $this->_yamlizeArray($value,$indent); - } elseif (!is_array($value)) { - // It doesn't have children. Yip. - $string = $this->_dumpNode($key, $value, $indent, $previous_key, $first_key, $source_array); - } - return $string; - } - - /** - * Attempts to convert an array to YAML - * @access private - * @return string - * @param $array The array you want to convert - * @param $indent The indent of the current level - */ - private function _yamlizeArray($array,$indent) { - if (is_array($array)) { - $string = ''; - $previous_key = -1; - foreach ($array as $key => $value) { - if (!isset($first_key)) $first_key = $key; - $string .= $this->_yamlize($key, $value, $indent, $previous_key, $first_key, $array); - $previous_key = $key; - } - return $string; - } else { - return false; - } - } - - /** - * Returns YAML from a key and a value - * @access private - * @return string - * @param $key The name of the key - * @param $value The value of the item - * @param $indent The indent of the current node - */ - private function _dumpNode($key, $value, $indent, $previous_key = -1, $first_key = 0, $source_array = null) { - // do some folding here, for blocks - if (is_string ($value) && ((strpos($value,"\n") !== false || strpos($value,": ") !== false || strpos($value,"- ") !== false || - strpos($value,"*") !== false || strpos($value,"#") !== false || strpos($value,"<") !== false || strpos($value,">") !== false || strpos ($value, ' ') !== false || - strpos($value,"[") !== false || strpos($value,"]") !== false || strpos($value,"{") !== false || strpos($value,"}") !== false) || strpos($value,"&") !== false || strpos($value, "'") !== false || strpos($value, "!") === 0 || - substr ($value, -1, 1) == ':') - ) { - $value = $this->_doLiteralBlock($value,$indent); - } else { - $value = $this->_doFolding($value,$indent); - } - - if ($value === array()) $value = '[ ]'; - if (in_array ($value, array ('true', 'TRUE', 'false', 'FALSE', 'y', 'Y', 'n', 'N', 'null', 'NULL'), true)) { - $value = $this->_doLiteralBlock($value,$indent); - } - if (trim ($value) != $value) - $value = $this->_doLiteralBlock($value,$indent); - - if (is_bool($value)) { - $value = ($value) ? "true" : "false"; - } - - if ($value === null) $value = 'null'; - if ($value === "'" . self::REMPTY . "'") $value = null; - - $spaces = str_repeat(' ',$indent); - - //if (is_int($key) && $key - 1 == $previous_key && $first_key===0) { - if (is_array ($source_array) && array_keys($source_array) === range(0, count($source_array) - 1)) { - // It's a sequence - $string = $spaces.'- '.$value."\n"; - } else { - // if ($first_key===0) throw new Exception('Keys are all screwy. The first one was zero, now it\'s "'. $key .'"'); - // It's mapped - if (strpos($key, ":") !== false || strpos($key, "#") !== false) { $key = '"' . $key . '"'; } - $string = rtrim ($spaces.$key.': '.$value)."\n"; - } - return $string; - } - - /** - * Creates a literal block for dumping - * @access private - * @return string - * @param $value - * @param $indent int The value of the indent - */ - private function _doLiteralBlock($value,$indent) { - if ($value === "\n") return '\n'; - if (strpos($value, "\n") === false && strpos($value, "'") === false) { - return sprintf ("'%s'", $value); - } - if (strpos($value, "\n") === false && strpos($value, '"') === false) { - return sprintf ('"%s"', $value); - } - $exploded = explode("\n",$value); - $newValue = '|'; - $indent += $this->_dumpIndent; - $spaces = str_repeat(' ',$indent); - foreach ($exploded as $line) { - $newValue .= "\n" . $spaces . ($line); - } - return $newValue; - } - - /** - * Folds a string of text, if necessary - * @access private - * @return string - * @param $value The string you wish to fold - */ - private function _doFolding($value,$indent) { - // Don't do anything if wordwrap is set to 0 - - if ($this->_dumpWordWrap !== 0 && is_string ($value) && strlen($value) > $this->_dumpWordWrap) { - $indent += $this->_dumpIndent; - $indent = str_repeat(' ',$indent); - $wrapped = wordwrap($value,$this->_dumpWordWrap,"\n$indent"); - $value = ">\n".$indent.$wrapped; - } else { - if ($this->setting_dump_force_quotes && is_string ($value) && $value !== self::REMPTY) - $value = '"' . $value . '"'; - } - - - return $value; - } - -// LOADING FUNCTIONS - - private function __load($input) { - $Source = $this->loadFromSource($input); - return $this->loadWithSource($Source); - } - - private function __loadString($input) { - $Source = $this->loadFromString($input); - return $this->loadWithSource($Source); - } - - private function loadWithSource($Source) { - if (empty ($Source)) return array(); - if ($this->setting_use_syck_is_possible && function_exists ('syck_load')) { - $array = syck_load (implode ('', $Source)); - return is_array($array) ? $array : array(); - } - - $this->path = array(); - $this->result = array(); - - $cnt = count($Source); - for ($i = 0; $i < $cnt; $i++) { - $line = $Source[$i]; - - $this->indent = strlen($line) - strlen(ltrim($line)); - $tempPath = $this->getParentPathByIndent($this->indent); - $line = self::stripIndent($line, $this->indent); - if (self::isComment($line)) continue; - if (self::isEmpty($line)) continue; - $this->path = $tempPath; - - $literalBlockStyle = self::startsLiteralBlock($line); - if ($literalBlockStyle) { - $line = rtrim ($line, $literalBlockStyle . " \n"); - $literalBlock = ''; - $line .= $this->LiteralPlaceHolder; - $literal_block_indent = strlen($Source[$i+1]) - strlen(ltrim($Source[$i+1])); - while (++$i < $cnt && $this->literalBlockContinues($Source[$i], $this->indent)) { - $literalBlock = $this->addLiteralLine($literalBlock, $Source[$i], $literalBlockStyle, $literal_block_indent); - } - $i--; - } - - while (++$i < $cnt && self::greedilyNeedNextLine($line)) { - $line = rtrim ($line, " \n\t\r") . ' ' . ltrim ($Source[$i], " \t"); - } - $i--; - - - - if (strpos ($line, '#')) { - if (strpos ($line, '"') === false && strpos ($line, "'") === false) - $line = preg_replace('/\s+#(.+)$/','',$line); - } - - $lineArray = $this->_parseLine($line); - - if ($literalBlockStyle) - $lineArray = $this->revertLiteralPlaceHolder ($lineArray, $literalBlock); - - $this->addArray($lineArray, $this->indent); - - foreach ($this->delayedPath as $indent => $delayedPath) - $this->path[$indent] = $delayedPath; - - $this->delayedPath = array(); - - } - return $this->result; - } - - private function loadFromSource ($input) { - if (!empty($input) && strpos($input, "\n") === false && file_exists($input)) - return file($input); - - return $this->loadFromString($input); - } - - private function loadFromString ($input) { - $lines = explode("\n",$input); - foreach ($lines as $k => $_) { - $lines[$k] = rtrim ($_, "\r"); - } - return $lines; - } - - /** - * Parses YAML code and returns an array for a node - * @access private - * @return array - * @param string $line A line from the YAML file - */ - private function _parseLine($line) { - if (!$line) return array(); - $line = trim($line); - if (!$line) return array(); - - $array = array(); - - $group = $this->nodeContainsGroup($line); - if ($group) { - $this->addGroup($line, $group); - $line = $this->stripGroup ($line, $group); - } - - if ($this->startsMappedSequence($line)) - return $this->returnMappedSequence($line); - - if ($this->startsMappedValue($line)) - return $this->returnMappedValue($line); - - if ($this->isArrayElement($line)) - return $this->returnArrayElement($line); - - if ($this->isPlainArray($line)) - return $this->returnPlainArray($line); - - - return $this->returnKeyValuePair($line); - - } - - /** - * Finds the type of the passed value, returns the value as the new type. - * @access private - * @param string $value - * @return mixed - */ - private function _toType($value) { - if ($value === '') return null; - $first_character = $value[0]; - $last_character = substr($value, -1, 1); - - $is_quoted = false; - do { - if (!$value) break; - if ($first_character != '"' && $first_character != "'") break; - if ($last_character != '"' && $last_character != "'") break; - $is_quoted = true; - } while (0); - - if ($is_quoted) - return strtr(substr ($value, 1, -1), array ('\\"' => '"', '\'\'' => '\'', '\\\'' => '\'')); - - if (strpos($value, ' #') !== false && !$is_quoted) - $value = preg_replace('/\s+#(.+)$/','',$value); - - if (!$is_quoted) $value = str_replace('\n', "\n", $value); - - if ($first_character == '[' && $last_character == ']') { - // Take out strings sequences and mappings - $innerValue = trim(substr ($value, 1, -1)); - if ($innerValue === '') return array(); - $explode = $this->_inlineEscape($innerValue); - // Propagate value array - $value = array(); - foreach ($explode as $v) { - $value[] = $this->_toType($v); - } - return $value; - } - - if (strpos($value,': ')!==false && $first_character != '{') { - $array = explode(': ',$value); - $key = trim($array[0]); - array_shift($array); - $value = trim(implode(': ',$array)); - $value = $this->_toType($value); - return array($key => $value); - } - - if ($first_character == '{' && $last_character == '}') { - $innerValue = trim(substr ($value, 1, -1)); - if ($innerValue === '') return array(); - // Inline Mapping - // Take out strings sequences and mappings - $explode = $this->_inlineEscape($innerValue); - // Propagate value array - $array = array(); - foreach ($explode as $v) { - $SubArr = $this->_toType($v); - if (empty($SubArr)) continue; - if (is_array ($SubArr)) { - $array[key($SubArr)] = $SubArr[key($SubArr)]; continue; - } - $array[] = $SubArr; - } - return $array; - } - - if ($value == 'null' || $value == 'NULL' || $value == 'Null' || $value == '' || $value == '~') { - return null; - } - - if ( is_numeric($value) && preg_match ('/^(-|)[1-9]+[0-9]*$/', $value) ){ - $intvalue = (int)$value; - if ($intvalue != PHP_INT_MAX) - $value = $intvalue; - return $value; - } - - if (in_array($value, - array('true', 'on', '+', 'yes', 'y', 'True', 'TRUE', 'On', 'ON', 'YES', 'Yes', 'Y'))) { - return true; - } - - if (in_array(strtolower($value), - array('false', 'off', '-', 'no', 'n'))) { - return false; - } - - if (is_numeric($value)) { - if ($value === '0') return 0; - if (rtrim ($value, 0) === $value) - $value = (float)$value; - return $value; - } - - return $value; - } - - /** - * Used in inlines to check for more inlines or quoted strings - * @access private - * @return array - */ - private function _inlineEscape($inline) { - // There's gotta be a cleaner way to do this... - // While pure sequences seem to be nesting just fine, - // pure mappings and mappings with sequences inside can't go very - // deep. This needs to be fixed. - - $seqs = array(); - $maps = array(); - $saved_strings = array(); - - // Check for strings - $regex = '/(?:(")|(?:\'))((?(1)[^"]+|[^\']+))(?(1)"|\')/'; - if (preg_match_all($regex,$inline,$strings)) { - $saved_strings = $strings[0]; - $inline = preg_replace($regex,'YAMLString',$inline); - } - unset($regex); - - $i = 0; - do { - - // Check for sequences - while (preg_match('/\[([^{}\[\]]+)\]/U',$inline,$matchseqs)) { - $seqs[] = $matchseqs[0]; - $inline = preg_replace('/\[([^{}\[\]]+)\]/U', ('YAMLSeq' . (count($seqs) - 1) . 's'), $inline, 1); - } - - // Check for mappings - while (preg_match('/{([^\[\]{}]+)}/U',$inline,$matchmaps)) { - $maps[] = $matchmaps[0]; - $inline = preg_replace('/{([^\[\]{}]+)}/U', ('YAMLMap' . (count($maps) - 1) . 's'), $inline, 1); - } - - if ($i++ >= 10) break; - - } while (strpos ($inline, '[') !== false || strpos ($inline, '{') !== false); - - $explode = explode(', ',$inline); - $stringi = 0; $i = 0; - - while (1) { - - // Re-add the sequences - if (!empty($seqs)) { - foreach ($explode as $key => $value) { - if (strpos($value,'YAMLSeq') !== false) { - foreach ($seqs as $seqk => $seq) { - $explode[$key] = str_replace(('YAMLSeq'.$seqk.'s'),$seq,$value); - $value = $explode[$key]; - } - } - } - } - - // Re-add the mappings - if (!empty($maps)) { - foreach ($explode as $key => $value) { - if (strpos($value,'YAMLMap') !== false) { - foreach ($maps as $mapk => $map) { - $explode[$key] = str_replace(('YAMLMap'.$mapk.'s'), $map, $value); - $value = $explode[$key]; - } - } - } - } - - - // Re-add the strings - if (!empty($saved_strings)) { - foreach ($explode as $key => $value) { - while (strpos($value,'YAMLString') !== false) { - $explode[$key] = preg_replace('/YAMLString/',$saved_strings[$stringi],$value, 1); - unset($saved_strings[$stringi]); - ++$stringi; - $value = $explode[$key]; - } - } - } - - $finished = true; - foreach ($explode as $key => $value) { - if (strpos($value,'YAMLSeq') !== false) { - $finished = false; break; - } - if (strpos($value,'YAMLMap') !== false) { - $finished = false; break; - } - if (strpos($value,'YAMLString') !== false) { - $finished = false; break; - } - } - if ($finished) break; - - $i++; - if ($i > 10) - break; // Prevent infinite loops. - } - - return $explode; - } - - private function literalBlockContinues ($line, $lineIndent) { - if (!trim($line)) return true; - if (strlen($line) - strlen(ltrim($line)) > $lineIndent) return true; - return false; - } - - private function referenceContentsByAlias ($alias) { - do { - if (!isset($this->SavedGroups[$alias])) { echo "Bad group name: $alias."; break; } - $groupPath = $this->SavedGroups[$alias]; - $value = $this->result; - foreach ($groupPath as $k) { - $value = $value[$k]; - } - } while (false); - return $value; - } - - private function addArrayInline ($array, $indent) { - $CommonGroupPath = $this->path; - if (empty ($array)) return false; - - foreach ($array as $k => $_) { - $this->addArray(array($k => $_), $indent); - $this->path = $CommonGroupPath; - } - return true; - } - - private function addArray ($incoming_data, $incoming_indent) { - - // print_r ($incoming_data); - - if (count ($incoming_data) > 1) - return $this->addArrayInline ($incoming_data, $incoming_indent); - - $key = key ($incoming_data); - $value = isset($incoming_data[$key]) ? $incoming_data[$key] : null; - if ($key === '__!YAMLZero') $key = '0'; - - if ($incoming_indent == 0 && !$this->_containsGroupAlias && !$this->_containsGroupAnchor) { // Shortcut for root-level values. - if ($key || $key === '' || $key === '0') { - $this->result[$key] = $value; - } else { - $this->result[] = $value; end ($this->result); $key = key ($this->result); - } - $this->path[$incoming_indent] = $key; - return; - } - - - - $history = array(); - // Unfolding inner array tree. - $history[] = $_arr = $this->result; - foreach ($this->path as $k) { - $history[] = $_arr = $_arr[$k]; - } - - if ($this->_containsGroupAlias) { - $value = $this->referenceContentsByAlias($this->_containsGroupAlias); - $this->_containsGroupAlias = false; - } - - - // Adding string or numeric key to the innermost level or $this->arr. - if (is_string($key) && $key == '<<') { - if (!is_array ($_arr)) { $_arr = array (); } - - $_arr = array_merge ($_arr, $value); - } else if ($key || $key === '' || $key === '0') { - if (!is_array ($_arr)) - $_arr = array ($key=>$value); - else - $_arr[$key] = $value; - } else { - if (!is_array ($_arr)) { $_arr = array ($value); $key = 0; } - else { $_arr[] = $value; end ($_arr); $key = key ($_arr); } - } - - $reverse_path = array_reverse($this->path); - $reverse_history = array_reverse ($history); - $reverse_history[0] = $_arr; - $cnt = count($reverse_history) - 1; - for ($i = 0; $i < $cnt; $i++) { - $reverse_history[$i+1][$reverse_path[$i]] = $reverse_history[$i]; - } - $this->result = $reverse_history[$cnt]; - - $this->path[$incoming_indent] = $key; - - if ($this->_containsGroupAnchor) { - $this->SavedGroups[$this->_containsGroupAnchor] = $this->path; - if (is_array ($value)) { - $k = key ($value); - if (!is_int ($k)) { - $this->SavedGroups[$this->_containsGroupAnchor][$incoming_indent + 2] = $k; - } - } - $this->_containsGroupAnchor = false; - } - - } - - private static function startsLiteralBlock ($line) { - $lastChar = substr (trim($line), -1); - if ($lastChar != '>' && $lastChar != '|') return false; - if ($lastChar == '|') return $lastChar; - // HTML tags should not be counted as literal blocks. - if (preg_match ('#<.*?>$#', $line)) return false; - return $lastChar; - } - - private static function greedilyNeedNextLine($line) { - $line = trim ($line); - if (!strlen($line)) return false; - if (substr ($line, -1, 1) == ']') return false; - if ($line[0] == '[') return true; - if (preg_match ('#^[^:]+?:\s*\[#', $line)) return true; - return false; - } - - private function addLiteralLine ($literalBlock, $line, $literalBlockStyle, $indent = -1) { - $line = self::stripIndent($line, $indent); - if ($literalBlockStyle !== '|') { - $line = self::stripIndent($line); - } - $line = rtrim ($line, "\r\n\t ") . "\n"; - if ($literalBlockStyle == '|') { - return $literalBlock . $line; - } - if (strlen($line) == 0) - return rtrim($literalBlock, ' ') . "\n"; - if ($line == "\n" && $literalBlockStyle == '>') { - return rtrim ($literalBlock, " \t") . "\n"; - } - if ($line != "\n") - $line = trim ($line, "\r\n ") . " "; - return $literalBlock . $line; - } - - function revertLiteralPlaceHolder ($lineArray, $literalBlock) { - foreach ($lineArray as $k => $_) { - if (is_array($_)) - $lineArray[$k] = $this->revertLiteralPlaceHolder ($_, $literalBlock); - else if (substr($_, -1 * strlen ($this->LiteralPlaceHolder)) == $this->LiteralPlaceHolder) - $lineArray[$k] = rtrim ($literalBlock, " \r\n"); - } - return $lineArray; - } - - private static function stripIndent ($line, $indent = -1) { - if ($indent == -1) $indent = strlen($line) - strlen(ltrim($line)); - return substr ($line, $indent); - } - - private function getParentPathByIndent ($indent) { - if ($indent == 0) return array(); - $linePath = $this->path; - do { - end($linePath); $lastIndentInParentPath = key($linePath); - if ($indent <= $lastIndentInParentPath) array_pop ($linePath); - } while ($indent <= $lastIndentInParentPath); - return $linePath; - } - - - private function clearBiggerPathValues ($indent) { - - - if ($indent == 0) $this->path = array(); - if (empty ($this->path)) return true; - - foreach ($this->path as $k => $_) { - if ($k > $indent) unset ($this->path[$k]); - } - - return true; - } - - - private static function isComment ($line) { - if (!$line) return false; - if ($line[0] == '#') return true; - if (trim($line, " \r\n\t") == '---') return true; - return false; - } - - private static function isEmpty ($line) { - return (trim ($line) === ''); - } - - - private function isArrayElement ($line) { - if (!$line) return false; - if ($line[0] != '-') return false; - if (strlen ($line) > 3) - if (substr($line,0,3) == '---') return false; - - return true; - } - - private function isHashElement ($line) { - return strpos($line, ':'); - } - - private function isLiteral ($line) { - if ($this->isArrayElement($line)) return false; - if ($this->isHashElement($line)) return false; - return true; - } - - - private static function unquote ($value) { - if (!$value) return $value; - if (!is_string($value)) return $value; - if ($value[0] == '\'') return trim ($value, '\''); - if ($value[0] == '"') return trim ($value, '"'); - return $value; - } - - private function startsMappedSequence ($line) { - return ($line[0] == '-' && substr ($line, -1, 1) == ':'); - } - - private function returnMappedSequence ($line) { - $array = array(); - $key = self::unquote(trim(substr($line,1,-1))); - $array[$key] = array(); - $this->delayedPath = array(strpos ($line, $key) + $this->indent => $key); - return array($array); - } - - private function returnMappedValue ($line) { - $array = array(); - $key = self::unquote (trim(substr($line,0,-1))); - $array[$key] = ''; - return $array; - } - - private function startsMappedValue ($line) { - return (substr ($line, -1, 1) == ':'); - } - - private function isPlainArray ($line) { - return ($line[0] == '[' && substr ($line, -1, 1) == ']'); - } - - private function returnPlainArray ($line) { - return $this->_toType($line); - } - - private function returnKeyValuePair ($line) { - $array = array(); - $key = ''; - if (strpos ($line, ':')) { - // It's a key/value pair most likely - // If the key is in double quotes pull it out - if (($line[0] == '"' || $line[0] == "'") && preg_match('/^(["\'](.*)["\'](\s)*:)/',$line,$matches)) { - $value = trim(str_replace($matches[1],'',$line)); - $key = $matches[2]; - } else { - // Do some guesswork as to the key and the value - $explode = explode(':',$line); - $key = trim($explode[0]); - array_shift($explode); - $value = trim(implode(':',$explode)); - } - // Set the type of the value. Int, string, etc - $value = $this->_toType($value); - if ($key === '0') $key = '__!YAMLZero'; - $array[$key] = $value; - } else { - $array = array ($line); - } - return $array; - - } - - - private function returnArrayElement ($line) { - if (strlen($line) <= 1) return array(array()); // Weird %) - $array = array(); - $value = trim(substr($line,1)); - $value = $this->_toType($value); - $array[] = $value; - return $array; - } - - - private function nodeContainsGroup ($line) { - $symbolsForReference = 'A-z0-9_\-'; - if (strpos($line, '&') === false && strpos($line, '*') === false) return false; // Please die fast ;-) - if ($line[0] == '&' && preg_match('/^(&['.$symbolsForReference.']+)/', $line, $matches)) return $matches[1]; - if ($line[0] == '*' && preg_match('/^(\*['.$symbolsForReference.']+)/', $line, $matches)) return $matches[1]; - if (preg_match('/(&['.$symbolsForReference.']+)$/', $line, $matches)) return $matches[1]; - if (preg_match('/(\*['.$symbolsForReference.']+$)/', $line, $matches)) return $matches[1]; - if (preg_match ('#^\s*<<\s*:\s*(\*[^\s]+).*$#', $line, $matches)) return $matches[1]; - return false; - - } - - private function addGroup ($line, $group) { - if ($group[0] == '&') $this->_containsGroupAnchor = substr ($group, 1); - if ($group[0] == '*') $this->_containsGroupAlias = substr ($group, 1); - //print_r ($this->path); - } - - private function stripGroup ($line, $group) { - $line = trim(str_replace($group, '', $line)); - return $line; - } -} - -// Enable use of Spyc from command line -// The syntax is the following: php spyc.php spyc.yaml - -define ('SPYC_FROM_COMMAND_LINE', false); - -do { - if (!SPYC_FROM_COMMAND_LINE) break; - if (empty ($_SERVER['argc']) || $_SERVER['argc'] < 2) break; - if (empty ($_SERVER['PHP_SELF']) || $_SERVER['PHP_SELF'] != 'spyc.php') break; - $file = $argv[1]; - printf ("Spyc loading file: %s\n", $file); - print_r (spyc_load_file ($file)); -} while (0); \ No newline at end of file -- cgit v1.2.3 From e405e216f504396554b9f0d1e88e7dc768b32b2d Mon Sep 17 00:00:00 2001 From: Chris Bower Date: Sat, 1 Jun 2013 12:45:39 -0400 Subject: Fixing IE8 error in segmentation IE8 was iterating a method name as a key and throwing an error. --- plugins/SegmentEditor/templates/Segmentation.js | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'plugins') diff --git a/plugins/SegmentEditor/templates/Segmentation.js b/plugins/SegmentEditor/templates/Segmentation.js index 8f38611b6d..38a6f1f2cb 100644 --- a/plugins/SegmentEditor/templates/Segmentation.js +++ b/plugins/SegmentEditor/templates/Segmentation.js @@ -185,9 +185,9 @@ Segmentation = (function($) { var getSegmentFromId = function (id) { if(self.availableSegments.length > 0) { - for(var key in self.availableSegments) + for(var i = 0; i < self.availableSegments.length; i++) { - segment = self.availableSegments[key]; + segment = self.availableSegments[i]; if(segment.idsegment == id) { return segment; } @@ -206,9 +206,9 @@ Segmentation = (function($) { + ' ' + self.translations['General_DefaultAppended'] + ' '; if(self.availableSegments.length > 0) { - for(var key in self.availableSegments) + for(var i = 0; i < self.availableSegments.length; i++) { - segment = self.availableSegments[key]; + segment = self.availableSegments[i]; injClass = ""; if( segment.definition == self.currentSegmentStr){ injClass = 'class="segmentSelected"'; @@ -247,9 +247,9 @@ Segmentation = (function($) { + '">' + self.translations['SegmentEditor_AddNewSegment'] + ''; segmentsDropdown.append(newOption); - for(var key in self.availableSegments) + for(var i = 0; i < self.availableSegments.length; i++) { - segment = self.availableSegments[key]; + segment = self.availableSegments[i]; newOption = ''; segmentsDropdown.append(newOption); } -- cgit v1.2.3 From 9a31213523ba6dda20bef3b4937a195d1b9683af Mon Sep 17 00:00:00 2001 From: sgiehl Date: Sat, 1 Jun 2013 23:22:27 +0200 Subject: added some more search engines & tests --- plugins/Referers/images/searchEngines/search.snap.do.png | Bin 0 -> 570 bytes plugins/Referers/images/searchEngines/www.talimba.com.png | Bin 0 -> 735 bytes 2 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 plugins/Referers/images/searchEngines/search.snap.do.png create mode 100644 plugins/Referers/images/searchEngines/www.talimba.com.png (limited to 'plugins') diff --git a/plugins/Referers/images/searchEngines/search.snap.do.png b/plugins/Referers/images/searchEngines/search.snap.do.png new file mode 100644 index 0000000000..fc8131e8bc Binary files /dev/null and b/plugins/Referers/images/searchEngines/search.snap.do.png differ diff --git a/plugins/Referers/images/searchEngines/www.talimba.com.png b/plugins/Referers/images/searchEngines/www.talimba.com.png new file mode 100644 index 0000000000..4403a249b1 Binary files /dev/null and b/plugins/Referers/images/searchEngines/www.talimba.com.png differ -- cgit v1.2.3 From 2bf8b298477ec0c09eba6c5b33bcd6b2b74372c2 Mon Sep 17 00:00:00 2001 From: sgiehl Date: Sun, 2 Jun 2013 00:23:32 +0200 Subject: fixed require path --- .../UserAgentParserEnhanced/UserAgentParserEnhanced.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'plugins') diff --git a/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php b/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php index d67c26f755..5691033bf5 100644 --- a/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php +++ b/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php @@ -10,7 +10,7 @@ * @package Piwik_DevicesDetection */ //yml parser -require_once('spyc.php'); +require_once(PIWIK_INCLUDE_PATH.'/libs/spyc.php'); class UserAgentParserEnhanced { -- cgit v1.2.3 From 5953050021df0e4ff1fed6db7ef4c30dea2e0fec Mon Sep 17 00:00:00 2001 From: Benaka Moorthi Date: Sun, 2 Jun 2013 16:11:25 -0700 Subject: Use redirect from Piwik controller method to send users to paypal instead of supplying the paypal URL in HTML. --- plugins/CoreHome/Controller.php | 21 +++++++++++++++++++++ plugins/CoreHome/templates/donate.tpl | 4 ++-- 2 files changed, 23 insertions(+), 2 deletions(-) (limited to 'plugins') diff --git a/plugins/CoreHome/Controller.php b/plugins/CoreHome/Controller.php index 8070d536a1..5c9cc655ad 100644 --- a/plugins/CoreHome/Controller.php +++ b/plugins/CoreHome/Controller.php @@ -219,4 +219,25 @@ class Piwik_CoreHome_Controller extends Piwik_Controller $view->promoVideoUrl = 'http://www.youtube.com/watch?v=OslfF_EH81g'; echo $view->render(); } + + /** + * Redirects the user to a paypal so they can donate to Piwik. + */ + public function redirectToPaypal() + { + $parameters = Piwik_API_Request::getRequestArrayFromString($request = null); + foreach ($paramaters as $name => $param) { + if ($name == 'idSite' + || $name == 'module' + || $name == 'action' + ) { + unset($parameters[$name]); + } + } + + $url = "https://www.paypal.com/cgi-bin/webscr?".Piwik_Url::getQueryStringFromParameters($parameters); + + header("Location: $url"); + exit; + } } diff --git a/plugins/CoreHome/templates/donate.tpl b/plugins/CoreHome/templates/donate.tpl index e684684d04..f74c6a3753 100755 --- a/plugins/CoreHome/templates/donate.tpl +++ b/plugins/CoreHome/templates/donate.tpl @@ -13,7 +13,7 @@ -
    + @@ -36,7 +36,7 @@ - -- cgit v1.2.3 From 3fe83f56fb6ea12c9ba324f528415df6ab3dab2c Mon Sep 17 00:00:00 2001 From: sgiehl Date: Mon, 3 Jun 2013 21:50:40 +0200 Subject: refs #2885 added a couple of new search engines --- .../Referers/images/searchEngines/search.imesh.com.png | Bin 0 -> 644 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 plugins/Referers/images/searchEngines/search.imesh.com.png (limited to 'plugins') diff --git a/plugins/Referers/images/searchEngines/search.imesh.com.png b/plugins/Referers/images/searchEngines/search.imesh.com.png new file mode 100644 index 0000000000..8d8f1a782e Binary files /dev/null and b/plugins/Referers/images/searchEngines/search.imesh.com.png differ -- cgit v1.2.3 From 2838c069719d7dfddd657b2931abea754dc4520f Mon Sep 17 00:00:00 2001 From: Benaka Moorthi Date: Mon, 3 Jun 2013 15:29:46 -0700 Subject: Fixes #3973, make sure segment delete confirmation div uses unique ID. --- plugins/SegmentEditor/templates/Segmentation.js | 6 +++--- plugins/SegmentEditor/templates/selector.tpl | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'plugins') diff --git a/plugins/SegmentEditor/templates/Segmentation.js b/plugins/SegmentEditor/templates/Segmentation.js index 38a6f1f2cb..16bd22f5d4 100644 --- a/plugins/SegmentEditor/templates/Segmentation.js +++ b/plugins/SegmentEditor/templates/Segmentation.js @@ -618,9 +618,9 @@ Segmentation = (function($) { var params = { "idsegment" : segmentId }; - $('#confirm').find('#name').text( segmentName ); + $('#segment-delete-confirm').find('#name').text( segmentName ); if(segmentId != ""){ - piwikHelper.modalConfirm( '#confirm', { + piwikHelper.modalConfirm( '#segment-delete-confirm', { yes: function(){ self.deleteMethod(params); } @@ -1108,4 +1108,4 @@ $(document).ready( function(){ $(".segmentationContainer").trigger("click"); } }); -}); \ No newline at end of file +}); diff --git a/plugins/SegmentEditor/templates/selector.tpl b/plugins/SegmentEditor/templates/selector.tpl index e1c07a4d4f..26d4e42d7a 100644 --- a/plugins/SegmentEditor/templates/selector.tpl +++ b/plugins/SegmentEditor/templates/selector.tpl @@ -140,7 +140,7 @@
    -
    +

    {'SegmentEditor_AreYouSureDeleteSegment'|translate}

    -- cgit v1.2.3 From e48c41ceebc371d6b2926fb6f1d2d4e2a0823d82 Mon Sep 17 00:00:00 2001 From: mattab Date: Wed, 5 Jun 2013 15:57:44 +1200 Subject: Factoring out archiving Custom variables + cleaning it up (breaking down huge archiveDay function into several methods) Renaming some core code to make sense (sumMetrics and makeEmptyRow instead of ugly names) TODO: continue with other plugins --- plugins/Actions/Archiving.php | 5 - plugins/CustomVariables/API.php | 16 +- plugins/CustomVariables/Archiving.php | 230 ++++++++++++++++++++++++++++ plugins/CustomVariables/Controller.php | 29 ++-- plugins/CustomVariables/CustomVariables.php | 171 +-------------------- plugins/Goals/API.php | 2 +- plugins/Goals/Goals.php | 10 +- plugins/Provider/Provider.php | 4 +- plugins/Referers/Referers.php | 130 ++++++++-------- plugins/UserCountry/UserCountry.php | 8 +- plugins/UserSettings/UserSettings.php | 36 ++--- plugins/VisitTime/VisitTime.php | 24 +-- 12 files changed, 374 insertions(+), 291 deletions(-) create mode 100644 plugins/CustomVariables/Archiving.php (limited to 'plugins') diff --git a/plugins/Actions/Archiving.php b/plugins/Actions/Archiving.php index fa514b6ef9..e44af6f301 100644 --- a/plugins/Actions/Archiving.php +++ b/plugins/Actions/Archiving.php @@ -230,11 +230,6 @@ class Piwik_Actions_Archiving $select .= $selectFlagNoResultKeywords . $selectSiteSearchFollowingPages; - // Not working yet -// $selectRefPageIsStartingSiteSearch = ", -// SUM(CASE WHEN log_action_name_ref.type = " . Piwik_Tracker_Action::TYPE_ACTION_NAME . " THEN 1 ELSE 0 END) AS `". Piwik_Archive::INDEX_PAGE_STARTING_SITE_SEARCH_NB_HITS."`"; -// . $selectRefPageIsStartingSiteSearch -// . ", idaction_url_ref, idaction_name_ref" } $this->archiveDayQueryProcess($select, $from, $where, $orderBy, $groupBy, diff --git a/plugins/CustomVariables/API.php b/plugins/CustomVariables/API.php index 3a47c837c5..282406e679 100644 --- a/plugins/CustomVariables/API.php +++ b/plugins/CustomVariables/API.php @@ -42,8 +42,9 @@ class Piwik_CustomVariables_API protected function getDataTable($idSite, $period, $date, $segment, $expanded, $idSubtable) { $dataTable = Piwik_Archive::getDataTableFromArchive('CustomVariables_valueByName', $idSite, $period, $date, $segment, $expanded, $idSubtable); - $dataTable->filter('Sort', array(Piwik_Archive::INDEX_NB_VISITS, 'desc', $naturalSort = false, $expanded)); + $dataTable->filter('Sort', array(Piwik_Archive::INDEX_NB_ACTIONS, 'desc', $naturalSort = false, $expanded)); $dataTable->queueFilter('ReplaceColumnNames'); + $dataTable->queueFilter('ColumnDelete', 'nb_uniq_visitors'); return $dataTable; } @@ -64,7 +65,7 @@ class Piwik_CustomVariables_API if ($dataTable instanceof Piwik_DataTable && !$_leavePiwikCoreVariables ) { - $mapping = array('_pks', '_pkn', '_pkc', '_pkp', Piwik_Tracker_Action::CVAR_KEY_SEARCH_COUNT, Piwik_Tracker_Action::CVAR_KEY_SEARCH_CATEGORY); + $mapping = self::getReservedCustomVariableKeys(); foreach ($mapping as $name) { $row = $dataTable->getRowFromLabel($name); if ($row) { @@ -75,6 +76,15 @@ class Piwik_CustomVariables_API return $dataTable; } + /** + * @ignore + * @return array + */ + public static function getReservedCustomVariableKeys() + { + return array('_pks', '_pkn', '_pkc', '_pkp', Piwik_Tracker_Action::CVAR_KEY_SEARCH_COUNT, Piwik_Tracker_Action::CVAR_KEY_SEARCH_CATEGORY); + } + /** * @param int $idSite * @param string $period @@ -96,7 +106,7 @@ class Piwik_CustomVariables_API $dataTable->renameColumn('price_viewed', 'price'); } $dataTable->queueFilter('ColumnCallbackReplace', array('label', create_function('$label', ' - return $label == Piwik_CustomVariables::LABEL_CUSTOM_VALUE_NOT_DEFINED + return $label == Piwik_CustomVariables_Archiving::LABEL_CUSTOM_VALUE_NOT_DEFINED ? "' . Piwik_Translate('General_NotDefined', Piwik_Translate('CustomVariables_ColumnCustomVariableValue')) . '" : $label;'))); return $dataTable; diff --git a/plugins/CustomVariables/Archiving.php b/plugins/CustomVariables/Archiving.php new file mode 100644 index 0000000000..e9ca547707 --- /dev/null +++ b/plugins/CustomVariables/Archiving.php @@ -0,0 +1,230 @@ +maximumRowsInDataTableLevelZero = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_referers']; + $this->maximumRowsInSubDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_subtable_referers']; + } + + public function archiveDay(Piwik_ArchiveProcessing_Day $archiveProcessing) + { + $this->archiveDayAggregate($archiveProcessing); + + $table = $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByKeyAndValue, $this->metricsByKey); + + + $blob = $table->getSerialized( + $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, + $columnToSort = Piwik_Archive::INDEX_NB_VISITS + ); + + $archiveProcessing->insertBlobRecord(self::BLOB_NAME, $blob); + } + + /** + * @param Piwik_ArchiveProcessing_Day $archiveProcessing + * @return void + */ + protected function archiveDayAggregate(Piwik_ArchiveProcessing_Day $archiveProcessing) + { + for ($i = 1; $i <= Piwik_Tracker::MAX_CUSTOM_VARIABLES; $i++) { + $this->aggregateCustomVariable($archiveProcessing, $i); + } + + $this->removeVisitsMetricsFromActionsAggregate($archiveProcessing); + $archiveProcessing->enrichConversionsByLabelArray($this->metricsByKey); + $archiveProcessing->enrichConversionsByLabelArrayHasTwoLevels($this->metricsByKeyAndValue); + } + + /** + * @param Piwik_ArchiveProcessing_Day $archiveProcessing + * @param $slot + */ + protected function aggregateCustomVariable(Piwik_ArchiveProcessing_Day $archiveProcessing, $slot) + { + $keyField = "custom_var_k" . $slot; + $valueField = "custom_var_v" . $slot; + $where = "%s.$keyField != ''"; + $dimensions = array($keyField, $valueField); + + $query = $archiveProcessing->queryVisitsByDimension($dimensions, $where); + $this->aggregateFromVisits($archiveProcessing, $query, $keyField, $valueField); + + $query = $archiveProcessing->queryActionsByDimension($dimensions, $where); + $this->aggregateFromActions($archiveProcessing, $query, $keyField, $valueField); + + $query = $archiveProcessing->queryConversionsByDimension($dimensions, $where); + $this->aggregateFromConversions($archiveProcessing, $query, $keyField, $valueField); + } + + protected function aggregateFromVisits(Piwik_ArchiveProcessing_Day $archiveProcessing, $query, $keyField, $valueField) + { + while ($row = $query->fetch()) { + $value = $row[$valueField]; + $value = $this->cleanCustomVarValue($value); + + $key = $row[$keyField]; + if (!isset($this->metricsByKey[$key])) { + $this->metricsByKey[$key] = $archiveProcessing->makeEmptyRow(); + } + if (!isset($this->metricsByKeyAndValue[$key][$value])) { + $this->metricsByKeyAndValue[$key][$value] = $archiveProcessing->makeEmptyRow(); + } + + $archiveProcessing->sumMetrics($row, $this->metricsByKey[$key]); + $archiveProcessing->sumMetrics($row, $this->metricsByKeyAndValue[$key][$value]); + } + } + + protected function cleanCustomVarValue($value) + { + if (strlen($value)) { + return $value; + } + return self::LABEL_CUSTOM_VALUE_NOT_DEFINED; + } + + protected function aggregateFromActions(Piwik_ArchiveProcessing_Day $archiveProcessing, $query, $keyField, $valueField) + { + $keys = array(); + while ($row = $query->fetch()) { + $key = $row[$keyField]; + $value = $row[$valueField]; + $value = $this->cleanCustomVarValue($value); + + $alreadyAggregated = $this->aggregateEcommerceCategories($archiveProcessing, $key, $value, $row); + if (!$alreadyAggregated) { + $this->aggregateAction($archiveProcessing, $key, $value, $row); + + if (!isset($this->metricsByKey[$key])) { + $this->metricsByKey[$key] = $archiveProcessing->makeEmptyActionRow(); + } + $archiveProcessing->sumMetrics($row, $this->metricsByKey[$key], $onlyMetricsAvailableInActionsTable = true); + } + } + } + + /** + * @return bool True if the $row metrics were already added to the ->metrics + */ + protected function aggregateEcommerceCategories(Piwik_ArchiveProcessing_Day $archiveProcessing, $key, $value, $row) + { + $ecommerceCategoriesAggregated = false; + if ($key == '_pkc' + && $value[0] == '[' && $value[1] == '"' + ) { + // In case categories were truncated, try closing the array + if (substr($value, -2) != '"]') { + $value .= '"]'; + } + $decoded = @Piwik_Common::json_decode($value); + if (is_array($decoded)) { + $count = 0; + foreach ($decoded as $category) { + if (empty($category) + || $count >= Piwik_Tracker_GoalManager::MAXIMUM_PRODUCT_CATEGORIES + ) { + continue; + } + $this->aggregateAction($archiveProcessing, $key, $category, $row); + $ecommerceCategoriesAggregated = true; + $count++; + } + } + } + return $ecommerceCategoriesAggregated; + } + + /** + * @param Piwik_ArchiveProcessing_Day $archiveProcessing + * @param $key + * @param $value + * @param $row + */ + protected function aggregateAction(Piwik_ArchiveProcessing_Day $archiveProcessing, $key, $value, $row) + { + if (!isset($this->metricsByKeyAndValue[$key][$value])) { + $this->metricsByKeyAndValue[$key][$value] = $archiveProcessing->makeEmptyActionRow(); + } + $archiveProcessing->sumMetrics($row, $this->metricsByKeyAndValue[$key][$value], $onlyMetricsAvailableInActionsTable = true); + + if ($this->isReservedKey($key)) { + // Price tracking on Ecommerce product/category pages: + // The the AVG is returned from the SQL query so the price is not summed + $index = Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED; + if (!empty($row[$index])) { + $this->metricsByKeyAndValue[$key][$value][$index] = (float)$row[$index]; + } + } + } + + protected static function isReservedKey($key) + { + return in_array($key, Piwik_CustomVariables_API::getReservedCustomVariableKeys()); + } + + protected function aggregateFromConversions(Piwik_ArchiveProcessing_Day $archiveProcessing, $query, $keyField, $valueField) + { + if ($query === false) { + return; + } + while ($row = $query->fetch()) { + $key = $row[$keyField]; + $value = $this->cleanCustomVarValue($row[$valueField]); + $idGoal = $row['idgoal']; + + if (!isset($this->metricsByKey[$key][Piwik_Archive::INDEX_GOALS][$idGoal])) { + $this->metricsByKey[$key][Piwik_Archive::INDEX_GOALS][$idGoal] = $archiveProcessing->makeEmptyGoalRow($idGoal); + } + if (!isset($this->metricsByKeyAndValue[$key][$value][Piwik_Archive::INDEX_GOALS][$idGoal])) { + $this->metricsByKeyAndValue[$key][$value][Piwik_Archive::INDEX_GOALS][$idGoal] = $archiveProcessing->makeEmptyGoalRow($idGoal); + } + + $archiveProcessing->sumGoalMetrics($row, $this->metricsByKey[$key][Piwik_Archive::INDEX_GOALS][$idGoal]); + $archiveProcessing->sumGoalMetrics($row, $this->metricsByKeyAndValue[$key][$value][Piwik_Archive::INDEX_GOALS][$idGoal]); + } + } + + protected function removeVisitsMetricsFromActionsAggregate(Piwik_ArchiveProcessing_Day $archiveProcessing) + { + $emptyActionRow = $archiveProcessing->makeEmptyActionRow(); + + foreach ($this->metricsByKey as $key => &$row) { + $isActionRowAggregate = (count($row) == count($emptyActionRow)); + if (!self::isReservedKey($key) + && $isActionRowAggregate + ) { + unset($row[Piwik_Archive::INDEX_NB_UNIQ_VISITORS]); + unset($row[Piwik_Archive::INDEX_NB_VISITS]); + } + } + } + + public function archivePeriod($archiveProcessing) + { + $nameToCount = $archiveProcessing->archiveDataTable( + self::BLOB_NAME, null, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, + $columnToSort = Piwik_Archive::INDEX_NB_VISITS); + } + +} \ No newline at end of file diff --git a/plugins/CustomVariables/Controller.php b/plugins/CustomVariables/Controller.php index ea00259d3e..867988a79b 100644 --- a/plugins/CustomVariables/Controller.php +++ b/plugins/CustomVariables/Controller.php @@ -10,49 +10,52 @@ */ /** - * * @package Piwik_CustomVariables */ class Piwik_CustomVariables_Controller extends Piwik_Controller { - - function index($fetch = false) + public function index($fetch = false) { return Piwik_View::singleReport( Piwik_Translate('CustomVariables_CustomVariables'), $this->getCustomVariables(true), $fetch); } - function getCustomVariables($fetch = false) + public function getCustomVariables($fetch = false) { $view = Piwik_ViewDataTable::factory(); $view->init($this->pluginName, __FUNCTION__, "CustomVariables.getCustomVariables", "getCustomVariablesValuesFromNameId"); $this->setPeriodVariablesView($view); - $view->enableShowGoals(); + $this->setMetricsVariablesView($view); - $view->setColumnsToDisplay(array('label', 'nb_visits', 'nb_actions')); + $this->configureView($view); $view->setColumnTranslation('label', Piwik_Translate('CustomVariables_ColumnCustomVariableName')); - $view->setSortedColumn('nb_visits'); - $view->setLimit(10); + $view->setFooterMessage(Piwik_Translate('CustomVariables_TrackingHelp', array('', ''))); - $this->setMetricsVariablesView($view); + return $this->renderView($view, $fetch); } - function getCustomVariablesValuesFromNameId($fetch = false) + public function getCustomVariablesValuesFromNameId($fetch = false) { $view = Piwik_ViewDataTable::factory(); $view->init($this->pluginName, __FUNCTION__, 'CustomVariables.getCustomVariablesValuesFromNameId'); + $this->configureView($view); $view->disableSearchBox(); - $view->enableShowGoals(); $view->disableExcludeLowPopulation(); - $view->setColumnsToDisplay(array('label', 'nb_visits', 'nb_actions')); $view->setColumnTranslation('label', Piwik_Translate('CustomVariables_ColumnCustomVariableValue')); - return $this->renderView($view, $fetch); } + protected function configureView($view) + { + $view->setColumnsToDisplay(array('label', 'nb_actions', 'nb_visits')); + $view->setSortedColumn('nb_actions'); + $view->enableShowGoals(); + } + + } diff --git a/plugins/CustomVariables/CustomVariables.php b/plugins/CustomVariables/CustomVariables.php index d76adab5ea..1212f78cd9 100644 --- a/plugins/CustomVariables/CustomVariables.php +++ b/plugins/CustomVariables/CustomVariables.php @@ -14,11 +14,6 @@ */ class Piwik_CustomVariables extends Piwik_Plugin { - public $archiveProcessing; - protected $columnToSortByBeforeTruncation; - protected $maximumRowsInDataTableLevelZero; - protected $maximumRowsInSubDataTable; - public function getInformation() { $info = array( @@ -146,173 +141,24 @@ class Piwik_CustomVariables extends Piwik_Plugin )); } - function __construct() - { - $this->maximumRowsInDataTableLevelZero = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_referers']; - $this->maximumRowsInSubDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_subtable_referers']; - } - - protected $interestByCustomVariables = array(); - protected $interestByCustomVariablesAndValue = array(); - /** * Hooks on daily archive to trigger various log processing * * @param Piwik_Event_Notification $notification notification object - * @return void */ public function archiveDay($notification) { - $this->interestByCustomVariables = $this->interestByCustomVariablesAndValue = array(); - - /** - * @var Piwik_ArchiveProcessing_Day - */ - $this->archiveProcessing = $notification->getNotificationObject(); - - if (!$this->archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - - $this->archiveDayAggregate($this->archiveProcessing); - $this->archiveDayRecordInDatabase($this->archiveProcessing); - destroy($this->interestByCustomVariables); - destroy($this->interestByCustomVariablesAndValue); - } - - const LABEL_CUSTOM_VALUE_NOT_DEFINED = "Value not defined"; - - /** - * @param Piwik_ArchiveProcessing_Day $archiveProcessing - * @return void - */ - protected function archiveDayAggregate(Piwik_ArchiveProcessing_Day $archiveProcessing) - { - for ($i = 1; $i <= Piwik_Tracker::MAX_CUSTOM_VARIABLES; $i++) { - $keyField = "custom_var_k" . $i; - $valueField = "custom_var_v" . $i; - $dimensions = array($keyField, $valueField); - $where = "%s.$keyField != ''"; - - // Custom Vars names and values metrics for visits - $query = $archiveProcessing->queryVisitsByDimension($dimensions, $where); - - while ($row = $query->fetch()) { - // Handle case custom var value is empty - $row[$valueField] = $this->cleanCustomVarValue($row[$valueField]); - - // Aggregate - if (!isset($this->interestByCustomVariables[$row[$keyField]])) $this->interestByCustomVariables[$row[$keyField]] = $archiveProcessing->getNewInterestRow(); - if (!isset($this->interestByCustomVariablesAndValue[$row[$keyField]][$row[$valueField]])) $this->interestByCustomVariablesAndValue[$row[$keyField]][$row[$valueField]] = $archiveProcessing->getNewInterestRow(); - $archiveProcessing->updateInterestStats($row, $this->interestByCustomVariables[$row[$keyField]]); - $archiveProcessing->updateInterestStats($row, $this->interestByCustomVariablesAndValue[$row[$keyField]][$row[$valueField]]); - } - - // Custom Vars names and values metrics for page views - $query = $archiveProcessing->queryActionsByDimension($dimensions, $where); - $onlyMetricsAvailableInActionsTable = true; - while ($row = $query->fetch()) { - // Handle case custom var value is empty - $row[$valueField] = $this->cleanCustomVarValue($row[$valueField]); - - $label = $row[$valueField]; - - // Remove price tracked if it's zero or we if we are not currently tracking an ecommerce var - if (!in_array($row[$keyField], array('_pks', '_pkn', '_pkc'))) { - unset($row[Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED]); - } - - // when custom variable value is a JSON array of categories - // possibly JSON value - $mustInsertCustomVariableValue = true; - if ($row[$keyField] == '_pkc' - && $label[0] == '[' && $label[1] == '"' - ) { - // In case categories were truncated, try closing the array - if (substr($label, -2) != '"]') { - $label .= '"]'; - } - $decoded = @Piwik_Common::json_decode($label); - if (is_array($decoded)) { - $count = 0; - foreach ($decoded as $category) { - if (empty($category) - || $count >= Piwik_Tracker_GoalManager::MAXIMUM_PRODUCT_CATEGORIES - ) { - continue; - } - if (!isset($this->interestByCustomVariablesAndValue[$row[$keyField]][$category])) { - $this->interestByCustomVariablesAndValue[$row[$keyField]][$category] = $archiveProcessing->getNewInterestRow($onlyMetricsAvailableInActionsTable); - } - $archiveProcessing->updateInterestStats($row, $this->interestByCustomVariablesAndValue[$row[$keyField]][$category], $onlyMetricsAvailableInActionsTable); - $mustInsertCustomVariableValue = false; - $count++; - } - } - } // end multi categories hack - - if ($mustInsertCustomVariableValue) { - if (!isset($this->interestByCustomVariablesAndValue[$row[$keyField]][$row[$valueField]])) $this->interestByCustomVariablesAndValue[$row[$keyField]][$row[$valueField]] = $archiveProcessing->getNewInterestRow($onlyMetricsAvailableInActionsTable); - $archiveProcessing->updateInterestStats($row, $this->interestByCustomVariablesAndValue[$row[$keyField]][$row[$valueField]], $onlyMetricsAvailableInActionsTable); - } - - // Do not report on Price viewed for the Custom Variable names - unset($row[Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED]); - - // When tracking Custom Variables with scope=page we do not add up visits numbers - // as it is incorrect to sum visits this way - // for scope=visit this is allowed, since there is supposed to be one custom var value per custom variable name for a given visit - $doNotSumVisits = true; - - if (!isset($this->interestByCustomVariables[$row[$keyField]])) $this->interestByCustomVariables[$row[$keyField]] = $archiveProcessing->getNewInterestRow($onlyMetricsAvailableInActionsTable, $doNotSumVisits); - $archiveProcessing->updateInterestStats($row, $this->interestByCustomVariables[$row[$keyField]], $onlyMetricsAvailableInActionsTable, $doNotSumVisits); - } - - // Custom Vars names and values metrics for Goals - $query = $archiveProcessing->queryConversionsByDimension($dimensions, $where); - - if ($query !== false) { - while ($row = $query->fetch()) { - // Handle case custom var value is empty - $row[$valueField] = $this->cleanCustomVarValue($row[$valueField]); - - if (!isset($this->interestByCustomVariables[$row[$keyField]][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->interestByCustomVariables[$row[$keyField]][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->getNewGoalRow($row['idgoal']); - if (!isset($this->interestByCustomVariablesAndValue[$row[$keyField]][$row[$valueField]][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->interestByCustomVariablesAndValue[$row[$keyField]][$row[$valueField]][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->getNewGoalRow($row['idgoal']); - - $archiveProcessing->updateGoalStats($row, $this->interestByCustomVariables[$row[$keyField]][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - $archiveProcessing->updateGoalStats($row, $this->interestByCustomVariablesAndValue[$row[$keyField]][$row[$valueField]][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - } - } - } - $archiveProcessing->enrichConversionsByLabelArray($this->interestByCustomVariables); - $archiveProcessing->enrichConversionsByLabelArrayHasTwoLevels($this->interestByCustomVariablesAndValue); - } - - protected function cleanCustomVarValue($value) - { - if (strlen($value)) { - return $value; - } - return self::LABEL_CUSTOM_VALUE_NOT_DEFINED; - } + /** @var Piwik_ArchiveProcessing_Day $archiveProcessing */ + $archiveProcessing = $notification->getNotificationObject(); - /** - * @param Piwik_ArchiveProcessing $archiveProcessing - * @return void - */ - protected function archiveDayRecordInDatabase($archiveProcessing) - { - $recordName = 'CustomVariables_valueByName'; - $table = $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->interestByCustomVariablesAndValue, $this->interestByCustomVariables); + if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $blob = $table->getSerialized( - $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, - $columnToSort = Piwik_Archive::INDEX_NB_VISITS); - $archiveProcessing->insertBlobRecord($recordName, $blob); - destroy($table); + $archiving = new Piwik_CustomVariables_Archiving(); + $archiving->archiveDay($archiveProcessing); } /** * @param Piwik_Event_Notification $notification notification object - * @return mixed */ function archivePeriod($notification) { @@ -320,9 +166,8 @@ class Piwik_CustomVariables extends Piwik_Plugin if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $dataTableToSum = 'CustomVariables_valueByName'; - $nameToCount = $archiveProcessing->archiveDataTable( - $dataTableToSum, null, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, - $columnToSort = Piwik_Archive::INDEX_NB_VISITS); + $archiving = new Piwik_CustomVariables_Archiving(); + $archiving->archivePeriod($archiveProcessing); } + } diff --git a/plugins/Goals/API.php b/plugins/Goals/API.php index ad58ec4310..b5422c85c1 100644 --- a/plugins/Goals/API.php +++ b/plugins/Goals/API.php @@ -286,7 +286,7 @@ class Piwik_Goals_API } return; } - $rowNotDefined = $dataTable->getRowFromLabel(Piwik_CustomVariables::LABEL_CUSTOM_VALUE_NOT_DEFINED); + $rowNotDefined = $dataTable->getRowFromLabel(Piwik_CustomVariables_Archiving::LABEL_CUSTOM_VALUE_NOT_DEFINED); if ($rowNotDefined) { $rowNotDefined->setColumn('label', $notDefinedStringPretty); } diff --git a/plugins/Goals/Goals.php b/plugins/Goals/Goals.php index d6e933db0e..20fa1ee6db 100644 --- a/plugins/Goals/Goals.php +++ b/plugins/Goals/Goals.php @@ -645,22 +645,22 @@ class Piwik_Goals extends Piwik_Plugin $daysToConvReport = array(); // Get a standard empty goal row - $overall = $archiveProcessing->getNewGoalRow($idGoal = 1); + $overall = $archiveProcessing->makeEmptyGoalRow($idGoal = 1); while ($row = $query->fetch()) { $idgoal = $row['idgoal']; if (!isset($goals[$idgoal])) { - $goals[$idgoal] = $archiveProcessing->getNewGoalRow($idgoal); + $goals[$idgoal] = $archiveProcessing->makeEmptyGoalRow($idgoal); $visitsToConvReport[$idgoal] = new Piwik_DataTable(); $daysToConvReport[$idgoal] = new Piwik_DataTable(); } - $archiveProcessing->updateGoalStats($row, $goals[$idgoal]); + $archiveProcessing->sumGoalMetrics($row, $goals[$idgoal]); // We don't want to sum Abandoned cart metrics in the overall revenue/conversions/converted visits // since it is a "negative conversion" if ($idgoal != Piwik_Tracker_GoalManager::IDGOAL_CART) { - $archiveProcessing->updateGoalStats($row, $overall); + $archiveProcessing->sumGoalMetrics($row, $overall); } // map the goal + visit number of a visitor with the # of conversions that happened on that visit @@ -777,7 +777,7 @@ class Piwik_Goals extends Piwik_Plugin } // Product Name/Category not defined" if (class_exists('Piwik_CustomVariables')) { - $label = Piwik_CustomVariables::LABEL_CUSTOM_VALUE_NOT_DEFINED; + $label = Piwik_CustomVariables_Archiving::LABEL_CUSTOM_VALUE_NOT_DEFINED; } else { $label = "Value not defined"; } diff --git a/plugins/Provider/Provider.php b/plugins/Provider/Provider.php index 64d18ace74..67a1d35371 100644 --- a/plugins/Provider/Provider.php +++ b/plugins/Provider/Provider.php @@ -142,8 +142,8 @@ class Piwik_Provider extends Piwik_Plugin $recordName = 'Provider_hostnameExt'; $labelSQL = "log_visit.location_provider"; - $interestByProvider = $archiveProcessing->getArrayInterestForLabel($labelSQL); - $tableProvider = $archiveProcessing->getDataTableFromArray($interestByProvider); + $metricsByProvider = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $tableProvider = $archiveProcessing->getDataTableFromArray($metricsByProvider); $columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; $maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; $archiveProcessing->insertBlobRecord($recordName, $tableProvider->getSerialized($maximumRowsInDataTable, null, $columnToSortByBeforeTruncation)); diff --git a/plugins/Referers/Referers.php b/plugins/Referers/Referers.php index 3e40f2d9a9..2c36a17d5a 100644 --- a/plugins/Referers/Referers.php +++ b/plugins/Referers/Referers.php @@ -393,15 +393,15 @@ class Piwik_Referers extends Piwik_Plugin protected function cleanup() { - destroy($this->interestBySearchEngine); - destroy($this->interestByKeyword); - destroy($this->interestBySearchEngineAndKeyword); - destroy($this->interestByKeywordAndSearchEngine); - destroy($this->interestByWebsite); - destroy($this->interestByWebsiteAndUrl); - destroy($this->interestByCampaignAndKeyword); - destroy($this->interestByCampaign); - destroy($this->interestByType); + destroy($this->metricsBySearchEngine); + destroy($this->metricsByKeyword); + destroy($this->metricsBySearchEngineAndKeyword); + destroy($this->metricsByKeywordAndSearchEngine); + destroy($this->metricsByWebsite); + destroy($this->metricsByWebsiteAndUrl); + destroy($this->metricsByCampaignAndKeyword); + destroy($this->metricsByCampaign); + destroy($this->metricsByType); destroy($this->distinctUrls); } @@ -418,15 +418,15 @@ class Piwik_Referers extends Piwik_Plugin $dimension = array("referer_type", "referer_name", "referer_keyword", "referer_url"); $query = $archiveProcessing->queryVisitsByDimension($dimension); - $this->interestBySearchEngine = - $this->interestByKeyword = - $this->interestBySearchEngineAndKeyword = - $this->interestByKeywordAndSearchEngine = - $this->interestByWebsite = - $this->interestByWebsiteAndUrl = - $this->interestByCampaignAndKeyword = - $this->interestByCampaign = - $this->interestByType = + $this->metricsBySearchEngine = + $this->metricsByKeyword = + $this->metricsBySearchEngineAndKeyword = + $this->metricsByKeywordAndSearchEngine = + $this->metricsByWebsite = + $this->metricsByWebsiteAndUrl = + $this->metricsByCampaignAndKeyword = + $this->metricsByCampaign = + $this->metricsByType = $this->distinctUrls = array(); while ($row = $query->fetch()) { if (empty($row['referer_type'])) { @@ -437,24 +437,24 @@ class Piwik_Referers extends Piwik_Plugin if (empty($row['referer_keyword'])) { $row['referer_keyword'] = self::LABEL_KEYWORD_NOT_DEFINED; } - if (!isset($this->interestBySearchEngine[$row['referer_name']])) $this->interestBySearchEngine[$row['referer_name']] = $archiveProcessing->getNewInterestRow(); - if (!isset($this->interestByKeyword[$row['referer_keyword']])) $this->interestByKeyword[$row['referer_keyword']] = $archiveProcessing->getNewInterestRow(); - if (!isset($this->interestBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']])) $this->interestBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']] = $archiveProcessing->getNewInterestRow(); - if (!isset($this->interestByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']])) $this->interestByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']] = $archiveProcessing->getNewInterestRow(); - - $archiveProcessing->updateInterestStats($row, $this->interestBySearchEngine[$row['referer_name']]); - $archiveProcessing->updateInterestStats($row, $this->interestByKeyword[$row['referer_keyword']]); - $archiveProcessing->updateInterestStats($row, $this->interestBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']]); - $archiveProcessing->updateInterestStats($row, $this->interestByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']]); + if (!isset($this->metricsBySearchEngine[$row['referer_name']])) $this->metricsBySearchEngine[$row['referer_name']] = $archiveProcessing->makeEmptyRow(); + if (!isset($this->metricsByKeyword[$row['referer_keyword']])) $this->metricsByKeyword[$row['referer_keyword']] = $archiveProcessing->makeEmptyRow(); + if (!isset($this->metricsBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']])) $this->metricsBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']] = $archiveProcessing->makeEmptyRow(); + if (!isset($this->metricsByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']])) $this->metricsByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']] = $archiveProcessing->makeEmptyRow(); + + $archiveProcessing->sumMetrics($row, $this->metricsBySearchEngine[$row['referer_name']]); + $archiveProcessing->sumMetrics($row, $this->metricsByKeyword[$row['referer_keyword']]); + $archiveProcessing->sumMetrics($row, $this->metricsBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']]); + $archiveProcessing->sumMetrics($row, $this->metricsByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']]); break; case Piwik_Common::REFERER_TYPE_WEBSITE: - if (!isset($this->interestByWebsite[$row['referer_name']])) $this->interestByWebsite[$row['referer_name']] = $archiveProcessing->getNewInterestRow(); - $archiveProcessing->updateInterestStats($row, $this->interestByWebsite[$row['referer_name']]); + if (!isset($this->metricsByWebsite[$row['referer_name']])) $this->metricsByWebsite[$row['referer_name']] = $archiveProcessing->makeEmptyRow(); + $archiveProcessing->sumMetrics($row, $this->metricsByWebsite[$row['referer_name']]); - if (!isset($this->interestByWebsiteAndUrl[$row['referer_name']][$row['referer_url']])) $this->interestByWebsiteAndUrl[$row['referer_name']][$row['referer_url']] = $archiveProcessing->getNewInterestRow(); - $archiveProcessing->updateInterestStats($row, $this->interestByWebsiteAndUrl[$row['referer_name']][$row['referer_url']]); + if (!isset($this->metricsByWebsiteAndUrl[$row['referer_name']][$row['referer_url']])) $this->metricsByWebsiteAndUrl[$row['referer_name']][$row['referer_url']] = $archiveProcessing->makeEmptyRow(); + $archiveProcessing->sumMetrics($row, $this->metricsByWebsiteAndUrl[$row['referer_name']][$row['referer_url']]); if (!isset($this->distinctUrls[$row['referer_url']])) { $this->distinctUrls[$row['referer_url']] = true; @@ -463,15 +463,15 @@ class Piwik_Referers extends Piwik_Plugin case Piwik_Common::REFERER_TYPE_CAMPAIGN: if (!empty($row['referer_keyword'])) { - if (!isset($this->interestByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']])) $this->interestByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']] = $archiveProcessing->getNewInterestRow(); - $archiveProcessing->updateInterestStats($row, $this->interestByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']]); + if (!isset($this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']])) $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']] = $archiveProcessing->makeEmptyRow(); + $archiveProcessing->sumMetrics($row, $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']]); } - if (!isset($this->interestByCampaign[$row['referer_name']])) $this->interestByCampaign[$row['referer_name']] = $archiveProcessing->getNewInterestRow(); - $archiveProcessing->updateInterestStats($row, $this->interestByCampaign[$row['referer_name']]); + if (!isset($this->metricsByCampaign[$row['referer_name']])) $this->metricsByCampaign[$row['referer_name']] = $archiveProcessing->makeEmptyRow(); + $archiveProcessing->sumMetrics($row, $this->metricsByCampaign[$row['referer_name']]); break; case Piwik_Common::REFERER_TYPE_DIRECT_ENTRY: - // direct entry are aggregated below in $this->interestByType array + // direct entry are aggregated below in $this->metricsByType array break; default: @@ -479,8 +479,8 @@ class Piwik_Referers extends Piwik_Plugin break; } } - if (!isset($this->interestByType[$row['referer_type']])) $this->interestByType[$row['referer_type']] = $archiveProcessing->getNewInterestRow(); - $archiveProcessing->updateInterestStats($row, $this->interestByType[$row['referer_type']]); + if (!isset($this->metricsByType[$row['referer_type']])) $this->metricsByType[$row['referer_type']] = $archiveProcessing->makeEmptyRow(); + $archiveProcessing->sumMetrics($row, $this->metricsByType[$row['referer_type']]); } } @@ -505,25 +505,25 @@ class Piwik_Referers extends Piwik_Plugin if (empty($row['referer_keyword'])) { $row['referer_keyword'] = self::LABEL_KEYWORD_NOT_DEFINED; } - if (!isset($this->interestBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->interestBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->getNewGoalRow($row['idgoal']); - if (!isset($this->interestByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->interestByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->getNewGoalRow($row['idgoal']); + if (!isset($this->metricsBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->metricsBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); + if (!isset($this->metricsByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->metricsByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); - $archiveProcessing->updateGoalStats($row, $this->interestBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - $archiveProcessing->updateGoalStats($row, $this->interestByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + $archiveProcessing->sumGoalMetrics($row, $this->metricsBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + $archiveProcessing->sumGoalMetrics($row, $this->metricsByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); break; case Piwik_Common::REFERER_TYPE_WEBSITE: - if (!isset($this->interestByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->interestByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->getNewGoalRow($row['idgoal']); - $archiveProcessing->updateGoalStats($row, $this->interestByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + if (!isset($this->metricsByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->metricsByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); + $archiveProcessing->sumGoalMetrics($row, $this->metricsByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); break; case Piwik_Common::REFERER_TYPE_CAMPAIGN: if (!empty($row['referer_keyword'])) { - if (!isset($this->interestByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->interestByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->getNewGoalRow($row['idgoal']); - $archiveProcessing->updateGoalStats($row, $this->interestByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + if (!isset($this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); + $archiveProcessing->sumGoalMetrics($row, $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); } - if (!isset($this->interestByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->interestByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->getNewGoalRow($row['idgoal']); - $archiveProcessing->updateGoalStats($row, $this->interestByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + if (!isset($this->metricsByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->metricsByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); + $archiveProcessing->sumGoalMetrics($row, $this->metricsByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); break; case Piwik_Common::REFERER_TYPE_DIRECT_ENTRY: @@ -537,16 +537,16 @@ class Piwik_Referers extends Piwik_Plugin break; } } - if (!isset($this->interestByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->interestByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->getNewGoalRow($row['idgoal']); - $archiveProcessing->updateGoalStats($row, $this->interestByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + if (!isset($this->metricsByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->metricsByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); + $archiveProcessing->sumGoalMetrics($row, $this->metricsByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); } - $archiveProcessing->enrichConversionsByLabelArray($this->interestByType); - $archiveProcessing->enrichConversionsByLabelArray($this->interestBySearchEngine); - $archiveProcessing->enrichConversionsByLabelArray($this->interestByKeyword); - $archiveProcessing->enrichConversionsByLabelArray($this->interestByWebsite); - $archiveProcessing->enrichConversionsByLabelArray($this->interestByCampaign); - $archiveProcessing->enrichConversionsByLabelArrayHasTwoLevels($this->interestByCampaignAndKeyword); + $archiveProcessing->enrichConversionsByLabelArray($this->metricsByType); + $archiveProcessing->enrichConversionsByLabelArray($this->metricsBySearchEngine); + $archiveProcessing->enrichConversionsByLabelArray($this->metricsByKeyword); + $archiveProcessing->enrichConversionsByLabelArray($this->metricsByWebsite); + $archiveProcessing->enrichConversionsByLabelArray($this->metricsByCampaign); + $archiveProcessing->enrichConversionsByLabelArrayHasTwoLevels($this->metricsByCampaignAndKeyword); } /** @@ -558,10 +558,10 @@ class Piwik_Referers extends Piwik_Plugin protected function archiveDayRecordInDatabase($archiveProcessing) { $numericRecords = array( - 'Referers_distinctSearchEngines' => count($this->interestBySearchEngineAndKeyword), - 'Referers_distinctKeywords' => count($this->interestByKeywordAndSearchEngine), - 'Referers_distinctCampaigns' => count($this->interestByCampaign), - 'Referers_distinctWebsites' => count($this->interestByWebsite), + 'Referers_distinctSearchEngines' => count($this->metricsBySearchEngineAndKeyword), + 'Referers_distinctKeywords' => count($this->metricsByKeywordAndSearchEngine), + 'Referers_distinctCampaigns' => count($this->metricsByCampaign), + 'Referers_distinctWebsites' => count($this->metricsByWebsite), 'Referers_distinctWebsitesUrls' => count($this->distinctUrls), ); @@ -569,15 +569,15 @@ class Piwik_Referers extends Piwik_Plugin $archiveProcessing->insertNumericRecord($name, $value); } - $dataTable = $archiveProcessing->getDataTableSerialized($this->interestByType); + $dataTable = $archiveProcessing->getDataTableSerialized($this->metricsByType); $archiveProcessing->insertBlobRecord('Referers_type', $dataTable); destroy($dataTable); $blobRecords = array( - 'Referers_keywordBySearchEngine' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->interestBySearchEngineAndKeyword, $this->interestBySearchEngine), - 'Referers_searchEngineByKeyword' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->interestByKeywordAndSearchEngine, $this->interestByKeyword), - 'Referers_keywordByCampaign' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->interestByCampaignAndKeyword, $this->interestByCampaign), - 'Referers_urlByWebsite' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->interestByWebsiteAndUrl, $this->interestByWebsite), + 'Referers_keywordBySearchEngine' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsBySearchEngineAndKeyword, $this->metricsBySearchEngine), + 'Referers_searchEngineByKeyword' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByKeywordAndSearchEngine, $this->metricsByKeyword), + 'Referers_keywordByCampaign' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByCampaignAndKeyword, $this->metricsByCampaign), + 'Referers_urlByWebsite' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByWebsiteAndUrl, $this->metricsByWebsite), ); foreach ($blobRecords as $recordName => $table) { $blob = $table->getSerialized($this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $this->columnToSortByBeforeTruncation); diff --git a/plugins/UserCountry/UserCountry.php b/plugins/UserCountry/UserCountry.php index 34003af178..03df8bc3f7 100644 --- a/plugins/UserCountry/UserCountry.php +++ b/plugins/UserCountry/UserCountry.php @@ -391,9 +391,9 @@ class Piwik_UserCountry extends Piwik_Plugin $label = (string)$row[$dimension]; if (!isset($table[$label])) { - $table[$label] = $archiveProcessing->getNewInterestRow(); + $table[$label] = $archiveProcessing->makeEmptyRow(); } - $archiveProcessing->updateInterestStats($row, $table[$label]); + $archiveProcessing->sumMetrics($row, $table[$label]); } } } @@ -419,10 +419,10 @@ class Piwik_UserCountry extends Piwik_Plugin $label = (string)$row[$dimension]; if (!isset($table[$label][Piwik_Archive::INDEX_GOALS][$idGoal])) { - $table[$label][Piwik_Archive::INDEX_GOALS][$idGoal] = $archiveProcessing->getNewGoalRow($idGoal); + $table[$label][Piwik_Archive::INDEX_GOALS][$idGoal] = $archiveProcessing->makeEmptyGoalRow($idGoal); } - $archiveProcessing->updateGoalStats($row, $table[$label][Piwik_Archive::INDEX_GOALS][$idGoal]); + $archiveProcessing->sumGoalMetrics($row, $table[$label][Piwik_Archive::INDEX_GOALS][$idGoal]); } } diff --git a/plugins/UserSettings/UserSettings.php b/plugins/UserSettings/UserSettings.php index a9e458536b..09fb77ff9e 100644 --- a/plugins/UserSettings/UserSettings.php +++ b/plugins/UserSettings/UserSettings.php @@ -285,23 +285,23 @@ class Piwik_UserSettings extends Piwik_Plugin $recordName = 'UserSettings_configuration'; $labelSQL = "CONCAT(log_visit.config_os, ';', log_visit.config_browser_name, ';', log_visit.config_resolution)"; - $interestByConfiguration = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $metricsByConfiguration = $archiveProcessing->getArrayInterestForLabel($labelSQL); - $tableConfiguration = $archiveProcessing->getDataTableFromArray($interestByConfiguration); + $tableConfiguration = $archiveProcessing->getDataTableFromArray($metricsByConfiguration); $archiveProcessing->insertBlobRecord($recordName, $tableConfiguration->getSerialized($maximumRowsInDataTable, null, $columnToSortByBeforeTruncation)); - destroy($tableConfiguration); + destroy($tableConfiguration); $recordName = 'UserSettings_os'; $labelSQL = "log_visit.config_os"; - $interestByOs = $archiveProcessing->getArrayInterestForLabel($labelSQL); - $tableOs = $archiveProcessing->getDataTableFromArray($interestByOs); + $metricsByOs = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $tableOs = $archiveProcessing->getDataTableFromArray($metricsByOs); $archiveProcessing->insertBlobRecord($recordName, $tableOs->getSerialized($maximumRowsInDataTable, null, $columnToSortByBeforeTruncation)); destroy($tableOs); $recordName = 'UserSettings_browser'; $labelSQL = "CONCAT(log_visit.config_browser_name, ';', log_visit.config_browser_version)"; - $interestByBrowser = $archiveProcessing->getArrayInterestForLabel($labelSQL); - $tableBrowser = $archiveProcessing->getDataTableFromArray($interestByBrowser); + $metricsByBrowser = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $tableBrowser = $archiveProcessing->getDataTableFromArray($metricsByBrowser); $archiveProcessing->insertBlobRecord($recordName, $tableBrowser->getSerialized($maximumRowsInDataTable, null, $columnToSortByBeforeTruncation)); $recordName = 'UserSettings_browserType'; @@ -312,8 +312,8 @@ class Piwik_UserSettings extends Piwik_Plugin $recordName = 'UserSettings_resolution'; $labelSQL = "log_visit.config_resolution"; - $interestByResolution = $archiveProcessing->getArrayInterestForLabel($labelSQL); - $tableResolution = $archiveProcessing->getDataTableFromArray($interestByResolution); + $metricsByResolution = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $tableResolution = $archiveProcessing->getDataTableFromArray($metricsByResolution); $tableResolution->filter('ColumnCallbackDeleteRow', array('label', 'Piwik_UserSettings_keepStrlenGreater')); $archiveProcessing->insertBlobRecord($recordName, $tableResolution->getSerialized($maximumRowsInDataTable, null, $columnToSortByBeforeTruncation)); @@ -433,29 +433,29 @@ class Piwik_UserSettings extends Piwik_Plugin protected function getDataTableLanguages() { $labelSQL = "log_visit.location_browser_lang"; - $interestByLanguage = $this->archiveProcessing->getArrayInterestForLabel($labelSQL); + $metricsByLanguage = $this->archiveProcessing->getArrayInterestForLabel($labelSQL); $languageCodes = array_keys(Piwik_Common::getLanguagesList()); - foreach ($interestByLanguage as $lang => $count) { + foreach ($metricsByLanguage as $lang => $count) { // get clean language code $code = Piwik_Common::extractLanguageCodeFromBrowserLanguage($lang, $languageCodes); if ($code != $lang) { - if (!array_key_exists($code, $interestByLanguage)) { - $interestByLanguage[$code] = array(); + if (!array_key_exists($code, $metricsByLanguage)) { + $metricsByLanguage[$code] = array(); } // Add the values to the primary language foreach ($count as $key => $value) { - if (array_key_exists($key, $interestByLanguage[$code])) { - $interestByLanguage[$code][$key] += $value; + if (array_key_exists($key, $metricsByLanguage[$code])) { + $metricsByLanguage[$code][$key] += $value; } else { - $interestByLanguage[$code][$key] = $value; + $metricsByLanguage[$code][$key] = $value; } } - unset($interestByLanguage[$lang]); + unset($metricsByLanguage[$lang]); } } - $tableLanguage = $this->archiveProcessing->getDataTableFromArray($interestByLanguage); + $tableLanguage = $this->archiveProcessing->getDataTableFromArray($metricsByLanguage); return $tableLanguage; } } diff --git a/plugins/VisitTime/VisitTime.php b/plugins/VisitTime/VisitTime.php index 5e86570d44..093267f41c 100644 --- a/plugins/VisitTime/VisitTime.php +++ b/plugins/VisitTime/VisitTime.php @@ -165,18 +165,18 @@ class Piwik_VisitTime extends Piwik_Plugin protected function archiveDayAggregateVisits($archiveProcessing) { $labelSQL = "HOUR(log_visit.visitor_localtime)"; - $this->interestByLocalTime = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $this->metricsByLocalTime = $archiveProcessing->getArrayInterestForLabel($labelSQL); $labelSQL = "HOUR(log_visit.visit_last_action_time)"; - $this->interestByServerTime = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $this->metricsByServerTime = $archiveProcessing->getArrayInterestForLabel($labelSQL); } - protected function convertServerTimeToLocalTimezone($interestByServerTime, $archiveProcessing) + protected function convertServerTimeToLocalTimezone($metricsByServerTime, $archiveProcessing) { $date = Piwik_Date::factory($archiveProcessing->getStartDatetimeUTC())->toString(); $timezone = $archiveProcessing->site->getTimezone(); $visitsByHourTz = array(); - foreach ($interestByServerTime as $hour => $stats) { + foreach ($metricsByServerTime as $hour => $stats) { $datetime = $date . ' ' . $hour . ':00:00'; $hourInTz = (int)Piwik_Date::factory($datetime, $timezone)->toString('H'); $visitsByHourTz[$hourInTz] = $stats; @@ -191,22 +191,22 @@ class Piwik_VisitTime extends Piwik_Plugin if ($query === false) return; while ($row = $query->fetch()) { - if (!isset($this->interestByServerTime[$row['label']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->interestByServerTime[$row['label']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->getNewGoalRow($row['idgoal']); - $archiveProcessing->updateGoalStats($row, $this->interestByServerTime[$row['label']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + if (!isset($this->metricsByServerTime[$row['label']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->metricsByServerTime[$row['label']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); + $archiveProcessing->sumGoalMetrics($row, $this->metricsByServerTime[$row['label']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); } - $goalByServerTime = $this->convertServerTimeToLocalTimezone($this->interestByServerTime, $archiveProcessing); - $archiveProcessing->enrichConversionsByLabelArray($this->interestByServerTime); + $goalByServerTime = $this->convertServerTimeToLocalTimezone($this->metricsByServerTime, $archiveProcessing); + $archiveProcessing->enrichConversionsByLabelArray($this->metricsByServerTime); } protected function archiveDayRecordInDatabase($archiveProcessing) { - $tableLocalTime = $archiveProcessing->getDataTableFromArray($this->interestByLocalTime); + $tableLocalTime = $archiveProcessing->getDataTableFromArray($this->metricsByLocalTime); $this->makeSureAllHoursAreSet($tableLocalTime, $archiveProcessing); $archiveProcessing->insertBlobRecord('VisitTime_localTime', $tableLocalTime->getSerialized()); destroy($tableLocalTime); - $this->interestByServerTime = $this->convertServerTimeToLocalTimezone($this->interestByServerTime, $archiveProcessing); - $tableServerTime = $archiveProcessing->getDataTableFromArray($this->interestByServerTime); + $this->metricsByServerTime = $this->convertServerTimeToLocalTimezone($this->metricsByServerTime, $archiveProcessing); + $tableServerTime = $archiveProcessing->getDataTableFromArray($this->metricsByServerTime); $this->makeSureAllHoursAreSet($tableServerTime, $archiveProcessing); $archiveProcessing->insertBlobRecord('VisitTime_serverTime', $tableServerTime->getSerialized()); destroy($tableServerTime); @@ -216,7 +216,7 @@ class Piwik_VisitTime extends Piwik_Plugin { for ($i = 0; $i <= 23; $i++) { if ($table->getRowFromLabel($i) === false) { - $row = $archiveProcessing->getNewInterestRowLabeled($i); + $row = $archiveProcessing->makeEmptyRowLabeled($i); $table->addRow($row); } } -- cgit v1.2.3 From 4cad655824f9d5bf2b667ec522f78f499cd59bf0 Mon Sep 17 00:00:00 2001 From: mattab Date: Wed, 5 Jun 2013 16:10:49 +1200 Subject: Adding setting for limiting Custom Variables report in the config file, separate from the referrer config. This is especially useful to fix an ecommerce bug where "Visits" don't display properly for all products, since we used to truncate after 50 rows. Also sets by default to 1000 to ensure ecommerce tracking mostly work. Refs #3569 --- plugins/CustomVariables/Archiving.php | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) (limited to 'plugins') diff --git a/plugins/CustomVariables/Archiving.php b/plugins/CustomVariables/Archiving.php index e9ca547707..166d8c9124 100644 --- a/plugins/CustomVariables/Archiving.php +++ b/plugins/CustomVariables/Archiving.php @@ -21,9 +21,8 @@ class Piwik_CustomVariables_Archiving function __construct() { - //TODO FIX - $this->maximumRowsInDataTableLevelZero = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_referers']; - $this->maximumRowsInSubDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_subtable_referers']; + $this->maximumRowsInDataTableLevelZero = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_custom_variables']; + $this->maximumRowsInSubDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_subtable_custom_variables']; } public function archiveDay(Piwik_ArchiveProcessing_Day $archiveProcessing) @@ -32,7 +31,6 @@ class Piwik_CustomVariables_Archiving $table = $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByKeyAndValue, $this->metricsByKey); - $blob = $table->getSerialized( $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $columnToSort = Piwik_Archive::INDEX_NB_VISITS -- cgit v1.2.3 From 29bb1eb079e08a286faeb837302d8fecc9b67f5f Mon Sep 17 00:00:00 2001 From: mattab Date: Wed, 5 Jun 2013 16:36:05 +1200 Subject: Factoring out + cleanup Archiving DevicesDetection --- plugins/Actions/Actions.php | 8 +- plugins/Actions/Archiving.php | 1 - plugins/CustomVariables/CustomVariables.php | 8 +- plugins/DevicesDetection/Archiving.php | 120 ++++++++++++++++++++++++++ plugins/DevicesDetection/DevicesDetection.php | 111 ++---------------------- 5 files changed, 141 insertions(+), 107 deletions(-) create mode 100644 plugins/DevicesDetection/Archiving.php (limited to 'plugins') diff --git a/plugins/Actions/Actions.php b/plugins/Actions/Actions.php index 8a9be015d7..686601e2d8 100644 --- a/plugins/Actions/Actions.php +++ b/plugins/Actions/Actions.php @@ -571,7 +571,9 @@ class Piwik_Actions extends Piwik_Plugin { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; + if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { + return; + } $actionsArchiving = new Piwik_Actions_Archiving($archiveProcessing->idsite); return $actionsArchiving->archivePeriod($archiveProcessing); @@ -590,7 +592,9 @@ class Piwik_Actions extends Piwik_Plugin /* @var $archiveProcessing Piwik_ArchiveProcessing_Day */ $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; + if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { + return; + } $actionsArchiving = new Piwik_Actions_Archiving($archiveProcessing->idsite); return $actionsArchiving->archiveDay($archiveProcessing); diff --git a/plugins/Actions/Archiving.php b/plugins/Actions/Archiving.php index e44af6f301..41399bea72 100644 --- a/plugins/Actions/Archiving.php +++ b/plugins/Actions/Archiving.php @@ -292,7 +292,6 @@ class Piwik_Actions_Archiving "visit_entry_idaction_name", $archiveProcessing, $rankingQuery); } - /** * Time per action */ diff --git a/plugins/CustomVariables/CustomVariables.php b/plugins/CustomVariables/CustomVariables.php index 1212f78cd9..e6b9d14a90 100644 --- a/plugins/CustomVariables/CustomVariables.php +++ b/plugins/CustomVariables/CustomVariables.php @@ -151,7 +151,9 @@ class Piwik_CustomVariables extends Piwik_Plugin /** @var Piwik_ArchiveProcessing_Day $archiveProcessing */ $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; + if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { + return; + } $archiving = new Piwik_CustomVariables_Archiving(); $archiving->archiveDay($archiveProcessing); @@ -164,7 +166,9 @@ class Piwik_CustomVariables extends Piwik_Plugin { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; + if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { + return; + } $archiving = new Piwik_CustomVariables_Archiving(); $archiving->archivePeriod($archiveProcessing); diff --git a/plugins/DevicesDetection/Archiving.php b/plugins/DevicesDetection/Archiving.php new file mode 100644 index 0000000000..2fc88576a7 --- /dev/null +++ b/plugins/DevicesDetection/Archiving.php @@ -0,0 +1,120 @@ +maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; + $this->columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; + + $this->archiveDayDeviceTypes($archiveProcessing); + $this->archiveDayDeviceBrands($archiveProcessing); + $this->archiveDayDeviceModels($archiveProcessing); + $this->archiveDayOs($archiveProcessing); + $this->archiveDayOsVersions($archiveProcessing); + $this->archiveDayBrowserFamilies($archiveProcessing); + $this->archiveDayBrowsersVersions($archiveProcessing); + } + + private function archiveDayDeviceTypes($archiveProcessing) + { + $recordName = 'DevicesDetection_types'; + $labelSQL = "log_visit.config_device_type"; + $this->aggregateByLabel($archiveProcessing, $labelSQL, $recordName); + } + + /** + * @param $archiveProcessing + * @param $labelSQL + * @param $recordName + */ + private function aggregateByLabel($archiveProcessing, $labelSQL, $recordName) + { + $metricsByLabel = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $tableBrand = $archiveProcessing->getDataTableFromArray($metricsByLabel); + + $archiveProcessing->insertBlobRecord($recordName, $tableBrand->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + destroy($tableBrand); + } + + private function archiveDayDeviceBrands($archiveProcessing) + { + $recordName = 'DevicesDetection_brands'; + $labelSQL = "log_visit.config_device_brand"; + $this->aggregateByLabel($archiveProcessing, $labelSQL, $recordName); + } + + private function archiveDayDeviceModels($archiveProcessing) + { + $recordName = 'DevicesDetection_models'; + $labelSQL = "log_visit.config_device_model"; + $this->aggregateByLabel($archiveProcessing, $labelSQL, $recordName); + } + + private function archiveDayOs($archiveProcessing) + { + $recordName = 'DevicesDetection_os'; + $labelSQL = "log_visit.config_os"; + $this->aggregateByLabel($archiveProcessing, $labelSQL, $recordName); + + } + + private function archiveDayOsVersions($archiveProcessing) + { + $recordName = 'DevicesDetection_osVersions'; + $labelSQL = "CONCAT(log_visit.config_os, ';', log_visit.config_os_version)"; + $this->aggregateByLabel($archiveProcessing, $labelSQL, $recordName); + + } + + private function archiveDayBrowserFamilies($archiveProcessing) + { + $recordName = 'DevicesDetection_browsers'; + $labelSQL = "log_visit.config_browser_name"; + $this->aggregateByLabel($archiveProcessing, $labelSQL, $recordName); + + } + + private function archiveDayBrowsersVersions($archiveProcessing) + { + $recordName = 'DevicesDetection_browserVersions'; + $labelSQL = "CONCAT(log_visit.config_browser_name, ';', log_visit.config_browser_version)"; + + $this->aggregateByLabel($archiveProcessing, $labelSQL, $recordName); + } + + /** + * @param $archiveProcessing + */ + public function archivePeriod($archiveProcessing) + { + $this->maximumRowsInDataTableLevelZero = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; + $this->maximumRowsInSubDataTable = $this->maximumRowsInDataTableLevelZero; + $dataTablesToSum = array( + 'DevicesDetection_types', + 'DevicesDetection_brands', + 'DevicesDetection_models', + 'DevicesDetection_os', + 'DevicesDetection_osVersions', + 'DevicesDetection_browsers', + 'DevicesDetection_browserVersions' + ); + foreach ($dataTablesToSum as $dt) { + $archiveProcessing->archiveDataTable( + $dt, null, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $columnToSort = "nb_visits"); + } + } + +} \ No newline at end of file diff --git a/plugins/DevicesDetection/DevicesDetection.php b/plugins/DevicesDetection/DevicesDetection.php index 2f97c48203..fd06a7d963 100644 --- a/plugins/DevicesDetection/DevicesDetection.php +++ b/plugins/DevicesDetection/DevicesDetection.php @@ -14,7 +14,6 @@ require_once PIWIK_INCLUDE_PATH . '/plugins/DevicesDetection/functions.php'; class Piwik_DevicesDetection extends Piwik_Plugin { - /** * Return information about this plugin. * @return array @@ -238,120 +237,28 @@ class Piwik_DevicesDetection extends Piwik_Plugin printDebug($deviceInfo); } - private function archiveDayDeviceTypes($archiveProcessing) - { - $recordName = 'DevicesDetection_types'; - $labelSQL = "log_visit.config_device_type"; - $interestByType = $archiveProcessing->getArrayInterestForLabel($labelSQL); - $tableType = $archiveProcessing->getDataTableFromArray($interestByType); - - $archiveProcessing->insertBlobRecord($recordName, $tableType->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); - destroy($tableType); - } - - private function archiveDayDeviceBrands($archiveProcessing) - { - $recordName = 'DevicesDetection_brands'; - $labelSQL = "log_visit.config_device_brand"; - $interestByBrand = $archiveProcessing->getArrayInterestForLabel($labelSQL); - $tableBrand = $archiveProcessing->getDataTableFromArray($interestByBrand); - - $archiveProcessing->insertBlobRecord($recordName, $tableBrand->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); - destroy($tableBrand); - } - - private function archiveDayDeviceModels($archiveProcessing) - { - $recordName = 'DevicesDetection_models'; - $labelSQL = "log_visit.config_device_model"; - $interestByModel = $archiveProcessing->getArrayInterestForLabel($labelSQL); - $tableModel = $archiveProcessing->getDataTableFromArray($interestByModel); - - $archiveProcessing->insertBlobRecord($recordName, $tableModel->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); - destroy($tableModel); - } - - private function archiveDayOs($archiveProcessing) - { - $recordName = 'DevicesDetection_os'; - $labelSQL = "log_visit.config_os"; - $interestByOs = $archiveProcessing->getArrayInterestForLabel($labelSQL); - $tableOs = $archiveProcessing->getDataTableFromArray($interestByOs); - - $archiveProcessing->insertBlobRecord($recordName, $tableOs->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); - destroy($tableOs); - } - - private function archiveDayBrowserFamilies($archiveProcessing) - { - $recordName = 'DevicesDetection_browsers'; - $labelSQL = "log_visit.config_browser_name"; - $interestByBrowser = $archiveProcessing->getArrayInterestForLabel($labelSQL); - $tableBrowser = $archiveProcessing->getDataTableFromArray($interestByBrowser); - - $archiveProcessing->insertBlobRecord($recordName, $tableBrowser->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); - destroy($tableBrowser); - } - - private function archiveDayBrowsersVersions($archiveProcessing) - { - $recordName = 'DevicesDetection_browserVersions'; - $labelSQL = "CONCAT(log_visit.config_browser_name, ';', log_visit.config_browser_version)"; - $interestByBrowserVersion = $archiveProcessing->getArrayInterestForLabel($labelSQL); - $tableBrowserVersion = $archiveProcessing->getDataTableFromArray($interestByBrowserVersion); - $archiveProcessing->insertBlobRecord($recordName, $tableBrowserVersion->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); - destroy($tableBrowserVersion); - } - - private function archiveDayOsVersions($archiveProcessing) - { - $recordName = 'DevicesDetection_osVersions'; - $labelSQL = "CONCAT(log_visit.config_os, ';', log_visit.config_os_version)"; - $interestByBrowserVersion = $archiveProcessing->getArrayInterestForLabel($labelSQL); - $tableOsVersion = $archiveProcessing->getDataTableFromArray($interestByBrowserVersion); - $archiveProcessing->insertBlobRecord($recordName, $tableOsVersion->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); - destroy($tableOsVersion); - } - public function archiveDay($notification) { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) + if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { return; + } - $this->maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; - $this->columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; - - $this->archiveDayDeviceTypes($archiveProcessing); - $this->archiveDayDeviceBrands($archiveProcessing); - $this->archiveDayDeviceModels($archiveProcessing); - $this->archiveDayOs($archiveProcessing); - $this->archiveDayOsVersions($archiveProcessing); - $this->archiveDayBrowserFamilies($archiveProcessing); - $this->archiveDayBrowsersVersions($archiveProcessing); + $archiving = new Piwik_DevicesDetection_Archiving(); + $archiving->archiveDay($archiveProcessing); } public function archivePeriod($notification) { - $this->maximumRowsInDataTableLevelZero = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_referers']; - $this->maximumRowsInSubDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_subtable_referers']; - $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) + $archiveProcessing = $notification->getNotificationObject(); + if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { return; - - $dataTablesToSum[] = 'DevicesDetection_types'; - $dataTablesToSum[] = 'DevicesDetection_brands'; - $dataTablesToSum[] = "DevicesDetection_models"; - $dataTablesToSum[] = "DevicesDetection_os"; - $dataTablesToSum[] = "DevicesDetection_osVersions"; - $dataTablesToSum[] = "DevicesDetection_browsers"; - $dataTablesToSum[] = "DevicesDetection_browserVersions"; - foreach ($dataTablesToSum as $dt) { - $archiveProcessing->archiveDataTable( - $dt, null, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $columnToSort = "nb_visits"); } + + $archiving = new Piwik_DevicesDetection_Archiving(); + $archiving->archivePeriod($archiveProcessing); } public function addMenu() -- cgit v1.2.3 From 4b05d275180e8e2271c4630965baa526579f9a9a Mon Sep 17 00:00:00 2001 From: mattab Date: Wed, 5 Jun 2013 16:56:39 +1200 Subject: Factoring out + cleanup Archiving Goals --- plugins/Goals/API.php | 18 +- plugins/Goals/Controller.php | 4 +- plugins/Goals/Goals.php | 520 ++++++------------------------ plugins/MultiSites/API.php | 10 +- plugins/PrivacyManager/PrivacyManager.php | 8 +- 5 files changed, 117 insertions(+), 443 deletions(-) (limited to 'plugins') diff --git a/plugins/Goals/API.php b/plugins/Goals/API.php index b5422c85c1..81ff457d63 100644 --- a/plugins/Goals/API.php +++ b/plugins/Goals/API.php @@ -206,7 +206,7 @@ class Piwik_Goals_API Piwik::checkUserHasViewAccess($idSite); $recordNameFinal = $recordName; if ($abandonedCarts) { - $recordNameFinal = Piwik_Goals::getItemRecordNameAbandonedCart($recordName); + $recordNameFinal = Piwik_Goals_Archiving::getItemRecordNameAbandonedCart($recordName); } $archive = Piwik_Archive::build($idSite, $period, $date); $dataTable = $archive->getDataTable($recordNameFinal); @@ -390,7 +390,7 @@ class Piwik_Goals_API } $columnsToSelect = array(); foreach ($columns as &$columnName) { - $columnsToSelect[] = Piwik_Goals::getRecordName($columnName, $idGoal); + $columnsToSelect[] = Piwik_Goals_Archiving::getRecordName($columnName, $idGoal); } $dataTable = $archive->getDataTableFromNumeric($columnsToSelect); @@ -438,7 +438,7 @@ class Piwik_Goals_API */ public function getConversions($idSite, $period, $date, $segment = false, $idGoal = false) { - return $this->getNumeric($idSite, $period, $date, $segment, Piwik_Goals::getRecordName('nb_conversions', $idGoal)); + return $this->getNumeric($idSite, $period, $date, $segment, Piwik_Goals_Archiving::getRecordName('nb_conversions', $idGoal)); } /** @@ -446,7 +446,7 @@ class Piwik_Goals_API */ public function getNbVisitsConverted($idSite, $period, $date, $segment = false, $idGoal = false) { - return $this->getNumeric($idSite, $period, $date, $segment, Piwik_Goals::getRecordName('nb_visits_converted', $idGoal)); + return $this->getNumeric($idSite, $period, $date, $segment, Piwik_Goals_Archiving::getRecordName('nb_visits_converted', $idGoal)); } /** @@ -454,7 +454,7 @@ class Piwik_Goals_API */ public function getConversionRate($idSite, $period, $date, $segment = false, $idGoal = false) { - return $this->getNumeric($idSite, $period, $date, $segment, Piwik_Goals::getRecordName('conversion_rate', $idGoal)); + return $this->getNumeric($idSite, $period, $date, $segment, Piwik_Goals_Archiving::getRecordName('conversion_rate', $idGoal)); } /** @@ -462,7 +462,7 @@ class Piwik_Goals_API */ public function getRevenue($idSite, $period, $date, $segment = false, $idGoal = false) { - return $this->getNumeric($idSite, $period, $date, $segment, Piwik_Goals::getRecordName('revenue', $idGoal)); + return $this->getNumeric($idSite, $period, $date, $segment, Piwik_Goals_Archiving::getRecordName('revenue', $idGoal)); } /** @@ -488,7 +488,7 @@ class Piwik_Goals_API $realGoalId = $idGoal != true ? false : self::convertSpecialGoalIds($idGoal); // get the data table - $dataTable = $archive->getDataTable(Piwik_Goals::getRecordName($recordName, $realGoalId), $idSubtable = null); + $dataTable = $archive->getDataTable(Piwik_Goals_Archiving::getRecordName($recordName, $realGoalId), $idSubtable = null); $dataTable->queueFilter('ReplaceColumnNames'); return $dataTable; @@ -508,7 +508,7 @@ class Piwik_Goals_API public function getDaysToConversion($idSite, $period, $date, $segment = false, $idGoal = false) { $dataTable = $this->getGoalSpecificDataTable( - Piwik_Goals::DAYS_UNTIL_CONV_RECORD_NAME, $idSite, $period, $date, $segment, $idGoal); + Piwik_Goals_Archiving::DAYS_UNTIL_CONV_RECORD_NAME, $idSite, $period, $date, $segment, $idGoal); $dataTable->queueFilter('Sort', array('label', 'asc', true)); $dataTable->queueFilter( @@ -531,7 +531,7 @@ class Piwik_Goals_API public function getVisitsUntilConversion($idSite, $period, $date, $segment = false, $idGoal = false) { $dataTable = $this->getGoalSpecificDataTable( - Piwik_Goals::VISITS_UNTIL_RECORD_NAME, $idSite, $period, $date, $segment, $idGoal); + Piwik_Goals_Archiving::VISITS_UNTIL_RECORD_NAME, $idSite, $period, $date, $segment, $idGoal); $dataTable->queueFilter('Sort', array('label', 'asc', true)); $dataTable->queueFilter( diff --git a/plugins/Goals/Controller.php b/plugins/Goals/Controller.php index 9d0a97018c..15eb85c345 100644 --- a/plugins/Goals/Controller.php +++ b/plugins/Goals/Controller.php @@ -458,7 +458,7 @@ class Piwik_Goals_Controller extends Piwik_Controller $view->setSortedColumn('label', 'asc'); $view->setColumnTranslation('label', Piwik_Translate('Goals_VisitsUntilConv')); $view->setColumnTranslation('nb_conversions', Piwik_Translate('Goals_ColumnConversions')); - $view->setLimit(count(Piwik_Goals::$visitCountRanges)); + $view->setLimit(count(Piwik_Goals_Archiving::$visitCountRanges)); $view->disableOffsetInformationAndPaginationControls(); $view->disableShowAllViewsIcons(); return $this->renderView($view, $fetch); @@ -480,7 +480,7 @@ class Piwik_Goals_Controller extends Piwik_Controller $view->setColumnTranslation('label', Piwik_Translate('Goals_DaysToConv')); $view->setColumnTranslation('nb_conversions', Piwik_Translate('Goals_ColumnConversions')); $view->disableShowAllViewsIcons(); - $view->setLimit(count(Piwik_Goals::$daysToConvRanges)); + $view->setLimit(count(Piwik_Goals_Archiving::$daysToConvRanges)); $view->disableOffsetInformationAndPaginationControls(); return $this->renderView($view, $fetch); } diff --git a/plugins/Goals/Goals.php b/plugins/Goals/Goals.php index 20fa1ee6db..78e41180d5 100644 --- a/plugins/Goals/Goals.php +++ b/plugins/Goals/Goals.php @@ -15,49 +15,51 @@ */ class Piwik_Goals extends Piwik_Plugin { - const VISITS_UNTIL_RECORD_NAME = 'visits_until_conv'; - const DAYS_UNTIL_CONV_RECORD_NAME = 'days_until_conv'; - - /** - * This array stores the ranges to use when displaying the 'visits to conversion' - * report. - */ - public static $visitCountRanges = array( - array(1, 1), - array(2, 2), - array(3, 3), - array(4, 4), - array(5, 5), - array(6, 6), - array(7, 7), - array(8, 8), - array(9, 14), - array(15, 25), - array(26, 50), - array(51, 100), - array(100) + protected $ecommerceReports = array( + array('Goals_ProductSKU', 'Goals', 'getItemsSku'), + array('Goals_ProductName', 'Goals', 'getItemsName'), + array('Goals_ProductCategory', 'Goals', 'getItemsCategory') ); - /** - * This array stores the ranges to use when displaying the 'days to conversion' - * report. - */ - public static $daysToConvRanges = array( - array(0, 0), - array(1, 1), - array(2, 2), - array(3, 3), - array(4, 4), - array(5, 5), - array(6, 6), - array(7, 7), - array(8, 14), - array(15, 30), - array(31, 60), - array(61, 120), - array(121, 364), - array(364) - ); + static public function getReportsWithGoalMetrics() + { + $dimensions = array(); + Piwik_PostEvent('Goals.getReportsWithGoalMetrics', $dimensions); + $dimensionsByGroup = array(); + foreach ($dimensions as $dimension) { + $group = $dimension['category']; + unset($dimension['category']); + $dimensionsByGroup[$group][] = $dimension; + } + return $dimensionsByGroup; + } + + static public function getGoalColumns($idGoal) + { + $columns = array( + 'nb_conversions', + 'nb_visits_converted', + 'conversion_rate', + 'revenue', + ); + if ($idGoal === false) { + return $columns; + } + // Orders + if ($idGoal === Piwik_Tracker_GoalManager::IDGOAL_ORDER) { + $columns = array_merge($columns, array( + 'revenue_subtotal', + 'revenue_tax', + 'revenue_shipping', + 'revenue_discount', + )); + } + // Abandoned carts & orders + if ($idGoal <= Piwik_Tracker_GoalManager::IDGOAL_ORDER) { + $columns[] = 'items'; + } + return $columns; + } public function getInformation() { @@ -348,28 +350,6 @@ class Piwik_Goals extends Piwik_Plugin } - /** - * @param Piwik_Event_Notification $notification notification object - */ - public function getSegmentsMetadata($notification) - { - $segments =& $notification->getNotificationObject(); - $segments[] = array( - 'type' => 'dimension', - 'category' => Piwik_Translate('General_Visit'), - 'name' => 'General_VisitConvertedGoalId', - 'segment' => 'visitConvertedGoalId', - 'sqlSegment' => 'log_conversion.idgoal', - 'acceptedValues' => '1, 2, 3, etc.', - ); - } - - protected $ecommerceReports = array( - array('Goals_ProductSKU', 'Goals', 'getItemsSku'), - array('Goals_ProductName', 'Goals', 'getItemsName'), - array('Goals_ProductCategory', 'Goals', 'getItemsCategory') - ); - static public function getProductReportColumns() { return array( @@ -383,17 +363,44 @@ class Piwik_Goals extends Piwik_Plugin ); } - static public function getReportsWithGoalMetrics() + /** + * This function executes when the 'Goals.getReportsWithGoalMetrics' event fires. It + * adds the 'visits to conversion' report metadata to the list of goal reports so + * this report will be displayed. + * + * @param Piwik_Event_Notification $notification notification object + */ + function getActualReportsWithGoalMetrics($notification) { - $dimensions = array(); - Piwik_PostEvent('Goals.getReportsWithGoalMetrics', $dimensions); - $dimensionsByGroup = array(); - foreach ($dimensions as $dimension) { - $group = $dimension['category']; - unset($dimension['category']); - $dimensionsByGroup[$group][] = $dimension; - } - return $dimensionsByGroup; + $dimensions =& $notification->getNotificationObject(); + $dimensions = array_merge($dimensions, array( + array('category' => Piwik_Translate('General_Visit'), + 'name' => Piwik_Translate('Goals_VisitsUntilConv'), + 'module' => 'Goals', + 'action' => 'getVisitsUntilConversion' + ), + array('category' => Piwik_Translate('General_Visit'), + 'name' => Piwik_Translate('Goals_DaysToConv'), + 'module' => 'Goals', + 'action' => 'getDaysToConversion' + ) + )); + } + + /** + * @param Piwik_Event_Notification $notification notification object + */ + public function getSegmentsMetadata($notification) + { + $segments =& $notification->getNotificationObject(); + $segments[] = array( + 'type' => 'dimension', + 'category' => Piwik_Translate('General_Visit'), + 'name' => 'General_VisitConvertedGoalId', + 'segment' => 'visitConvertedGoalId', + 'sqlSegment' => 'log_conversion.idgoal', + 'acceptedValues' => '1, 2, 3, etc.', + ); } /** @@ -450,13 +457,6 @@ class Piwik_Goals extends Piwik_Plugin } } - protected function getGoalCategoryName($idSite) - { - $site = new Piwik_Site($idSite); - return $site->isEcommerceEnabled() ? 'Goals_EcommerceAndGoalsMenu' : 'Goals_Goals'; - } - - function addMenus() { $idSite = Piwik_Common::getRequestVar('idSite', null, 'int'); @@ -492,378 +492,52 @@ class Piwik_Goals extends Piwik_Plugin } } - /** - * @param string $recordName 'nb_conversions' - * @param int|bool $idGoal idGoal to return the metrics for, or false to return overall - * @return string Archive record name - */ - static public function getRecordName($recordName, $idGoal = false) + protected function getGoalCategoryName($idSite) { - $idGoalStr = ''; - if ($idGoal !== false) { - $idGoalStr = $idGoal . "_"; - } - return 'Goal_' . $idGoalStr . $recordName; + $site = new Piwik_Site($idSite); + return $site->isEcommerceEnabled() ? 'Goals_EcommerceAndGoalsMenu' : 'Goals_Goals'; } /** - * Hooks on Period archiving. - * Sums up Goal conversions stats, and processes overall conversion rate + * Hooks on the Daily archiving. + * Will process Goal stats overall and for each Goal. + * Also processes the New VS Returning visitors conversion stats. * * @param Piwik_Event_Notification $notification * @return void */ - function archivePeriod($notification) + function archiveDay($notification) { /** - * @var Piwik_ArchiveProcessing + * @var Piwik_ArchiveProcessing_Day */ $archiveProcessing = $notification->getNotificationObject(); if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - /* - * Archive Ecommerce Items - */ - if ($this->shouldArchiveEcommerceItems($archiveProcessing)) { - $dataTableToSum = $this->dimensions; - foreach ($this->dimensions as $recordName) { - $dataTableToSum[] = self::getItemRecordNameAbandonedCart($recordName); - } - $archiveProcessing->archiveDataTable($dataTableToSum); - } - - /* - * Archive General Goal metrics - */ - $goalIdsToSum = Piwik_Tracker_GoalManager::getGoalIds($archiveProcessing->idsite); - - //Ecommerce - $goalIdsToSum[] = Piwik_Tracker_GoalManager::IDGOAL_ORDER; - $goalIdsToSum[] = Piwik_Tracker_GoalManager::IDGOAL_CART; //bug here if idgoal=1 - // Overall goal metrics - $goalIdsToSum[] = false; - - $fieldsToSum = array(); - foreach ($goalIdsToSum as $goalId) { - $metricsToSum = Piwik_Goals::getGoalColumns($goalId); - unset($metricsToSum[array_search('conversion_rate', $metricsToSum)]); - foreach ($metricsToSum as $metricName) { - $fieldsToSum[] = self::getRecordName($metricName, $goalId); - } - } - $records = $archiveProcessing->archiveNumericValuesSum($fieldsToSum); - - // also recording conversion_rate for each goal - foreach ($goalIdsToSum as $goalId) { - $nb_conversions = $records[self::getRecordName('nb_visits_converted', $goalId)]; - $conversion_rate = $this->getConversionRate($nb_conversions, $archiveProcessing); - $archiveProcessing->insertNumericRecord(self::getRecordName('conversion_rate', $goalId), $conversion_rate); - - // sum up the visits to conversion data table & the days to conversion data table - $archiveProcessing->archiveDataTable(array( - self::getRecordName(self::VISITS_UNTIL_RECORD_NAME, $goalId), - self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME, $goalId))); - } - - // sum up goal overview reports - $archiveProcessing->archiveDataTable(array( - self::getRecordName(self::VISITS_UNTIL_RECORD_NAME), - self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME))); - } - - static public function getGoalColumns($idGoal) - { - $columns = array( - 'nb_conversions', - 'nb_visits_converted', - 'conversion_rate', - 'revenue', - ); - if ($idGoal === false) { - return $columns; - } - // Orders - if ($idGoal === Piwik_Tracker_GoalManager::IDGOAL_ORDER) { - $columns = array_merge($columns, array( - 'revenue_subtotal', - 'revenue_tax', - 'revenue_shipping', - 'revenue_discount', - )); - } - // Abandoned carts & orders - if ($idGoal <= Piwik_Tracker_GoalManager::IDGOAL_ORDER) { - $columns[] = 'items'; - } - return $columns; + $archiving = new Piwik_Goals_Archiving(); + $archiving->archiveDay($archiveProcessing); } /** - * Hooks on the Daily archiving. - * Will process Goal stats overall and for each Goal. - * Also processes the New VS Returning visitors conversion stats. + * Hooks on Period archiving. + * Sums up Goal conversions stats, and processes overall conversion rate * * @param Piwik_Event_Notification $notification * @return void */ - function archiveDay($notification) + function archivePeriod($notification) { /** - * @var Piwik_ArchiveProcessing_Day + * @var Piwik_ArchiveProcessing */ $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - - $this->archiveGeneralGoalMetrics($archiveProcessing); - $this->archiveEcommerceItems($archiveProcessing); - } - - /** - * @param Piwik_ArchiveProcessing_Day $archiveProcessing - */ - function archiveGeneralGoalMetrics($archiveProcessing) - { - // extra aggregate selects for the visits to conversion report - $visitToConvExtraCols = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( - 'visitor_count_visits', self::$visitCountRanges, 'log_conversion', 'vcv'); - - // extra aggregate selects for the days to conversion report - $daysToConvExtraCols = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( - 'visitor_days_since_first', self::$daysToConvRanges, 'log_conversion', 'vdsf'); - - $query = $archiveProcessing->queryConversionsByDimension( - array(), '', array_merge($visitToConvExtraCols, $daysToConvExtraCols)); - - if ($query === false) { + if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { return; } - $goals = array(); - $visitsToConvReport = array(); - $daysToConvReport = array(); - - // Get a standard empty goal row - $overall = $archiveProcessing->makeEmptyGoalRow($idGoal = 1); - while ($row = $query->fetch()) { - $idgoal = $row['idgoal']; - - if (!isset($goals[$idgoal])) { - $goals[$idgoal] = $archiveProcessing->makeEmptyGoalRow($idgoal); - - $visitsToConvReport[$idgoal] = new Piwik_DataTable(); - $daysToConvReport[$idgoal] = new Piwik_DataTable(); - } - $archiveProcessing->sumGoalMetrics($row, $goals[$idgoal]); - - // We don't want to sum Abandoned cart metrics in the overall revenue/conversions/converted visits - // since it is a "negative conversion" - if ($idgoal != Piwik_Tracker_GoalManager::IDGOAL_CART) { - $archiveProcessing->sumGoalMetrics($row, $overall); - } - - // map the goal + visit number of a visitor with the # of conversions that happened on that visit - $table = $archiveProcessing->getSimpleDataTableFromRow($row, Piwik_Archive::INDEX_NB_CONVERSIONS, 'vcv'); - $visitsToConvReport[$idgoal]->addDataTable($table); - - // map the goal + day number of a visit with the # of conversion that happened on that day - $table = $archiveProcessing->getSimpleDataTableFromRow($row, Piwik_Archive::INDEX_NB_CONVERSIONS, 'vdsf'); - $daysToConvReport[$idgoal]->addDataTable($table); - } - - // these data tables hold reports for every goal of a site - $visitsToConvOverview = new Piwik_DataTable(); - $daysToConvOverview = new Piwik_DataTable(); - - // Stats by goal, for all visitors - foreach ($goals as $idgoal => $values) { - foreach ($values as $metricId => $value) { - $metricName = Piwik_Archive::$mappingFromIdToNameGoal[$metricId]; - $recordName = self::getRecordName($metricName, $idgoal); - $archiveProcessing->insertNumericRecord($recordName, $value); - } - $conversion_rate = $this->getConversionRate($values[Piwik_Archive::INDEX_GOAL_NB_VISITS_CONVERTED], $archiveProcessing); - $recordName = self::getRecordName('conversion_rate', $idgoal); - $archiveProcessing->insertNumericRecord($recordName, $conversion_rate); - - // if the goal is not a special goal (like ecommerce) add it to the overview report - if ($idgoal !== Piwik_Tracker_GoalManager::IDGOAL_CART && - $idgoal !== Piwik_Tracker_GoalManager::IDGOAL_ORDER - ) { - $visitsToConvOverview->addDataTable($visitsToConvReport[$idgoal]); - $daysToConvOverview->addDataTable($daysToConvReport[$idgoal]); - } - - // visit count until conversion stats - $archiveProcessing->insertBlobRecord( - self::getRecordName(self::VISITS_UNTIL_RECORD_NAME, $idgoal), - $visitsToConvReport[$idgoal]->getSerialized()); - - // day count until conversion stats - $archiveProcessing->insertBlobRecord( - self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME, $idgoal), - $daysToConvReport[$idgoal]->getSerialized()); - } - - // archive overview reports - $archiveProcessing->insertBlobRecord( - self::getRecordName(self::VISITS_UNTIL_RECORD_NAME), $visitsToConvOverview->getSerialized()); - $archiveProcessing->insertBlobRecord( - self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME), $daysToConvOverview->getSerialized()); - - // Stats for all goals - $totalAllGoals = array( - self::getRecordName('conversion_rate') => $this->getConversionRate($archiveProcessing->getNumberOfVisitsConverted(), $archiveProcessing), - self::getRecordName('nb_conversions') => $overall[Piwik_Archive::INDEX_GOAL_NB_CONVERSIONS], - self::getRecordName('nb_visits_converted') => $archiveProcessing->getNumberOfVisitsConverted(), - self::getRecordName('revenue') => $overall[Piwik_Archive::INDEX_GOAL_REVENUE], - ); - foreach ($totalAllGoals as $recordName => $value) { - $archiveProcessing->insertNumericRecord($recordName, $value); - } - } - - protected $dimensions = array( - 'idaction_sku' => 'Goals_ItemsSku', - 'idaction_name' => 'Goals_ItemsName', - 'idaction_category' => 'Goals_ItemsCategory' - ); - - protected function shouldArchiveEcommerceItems($archiveProcessing) - { - // Per item doesn't support segment - // Also, when querying Goal metrics for visitorType==returning, we wouldnt want to trigger an extra request - // event if it did support segment - // (if this is implented, we should have shouldProcessReportsForPlugin() support partial archiving based on which metric is requested) - if (!$archiveProcessing->getSegment()->isEmpty()) { - return false; - } - return true; - } - - /** - * @param Piwik_ArchiveProcessing_Day $archiveProcessing - */ - function archiveEcommerceItems($archiveProcessing) - { - if (!$this->shouldArchiveEcommerceItems($archiveProcessing)) { - return false; - } - $items = array(); - - $dimensionsToQuery = $this->dimensions; - $dimensionsToQuery['idaction_category2'] = 'AdditionalCategory'; - $dimensionsToQuery['idaction_category3'] = 'AdditionalCategory'; - $dimensionsToQuery['idaction_category4'] = 'AdditionalCategory'; - $dimensionsToQuery['idaction_category5'] = 'AdditionalCategory'; - - foreach ($dimensionsToQuery as $dimension => $recordName) { - $query = $archiveProcessing->queryEcommerceItems($dimension); - if ($query == false) { - continue; - } - - while ($row = $query->fetch()) { - $label = $row['label']; - $ecommerceType = $row['ecommerceType']; - - if (empty($label)) { - // idaction==0 case: - // If we are querying any optional category, we do not include idaction=0 - // Otherwise we over-report in the Product Categories report - if ($recordName == 'AdditionalCategory') { - continue; - } - // Product Name/Category not defined" - if (class_exists('Piwik_CustomVariables')) { - $label = Piwik_CustomVariables_Archiving::LABEL_CUSTOM_VALUE_NOT_DEFINED; - } else { - $label = "Value not defined"; - } - } - // For carts, idorder = 0. To count abandoned carts, we must count visits with an abandoned cart - if ($ecommerceType == Piwik_Tracker_GoalManager::IDGOAL_CART) { - $row[Piwik_Archive::INDEX_ECOMMERCE_ORDERS] = $row[Piwik_Archive::INDEX_NB_VISITS]; - } - unset($row[Piwik_Archive::INDEX_NB_VISITS]); - unset($row['label']); - unset($row['ecommerceType']); - - $columnsToRound = array( - Piwik_Archive::INDEX_ECOMMERCE_ITEM_REVENUE, - Piwik_Archive::INDEX_ECOMMERCE_ITEM_QUANTITY, - Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE, - Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED, - ); - foreach ($columnsToRound as $column) { - if (isset($row[$column]) - && $row[$column] == round($row[$column]) - ) { - $row[$column] = round($row[$column]); - } - } - $items[$dimension][$ecommerceType][$label] = $row; - } - } - - foreach ($this->dimensions as $dimension => $recordName) { - foreach (array(Piwik_Tracker_GoalManager::IDGOAL_CART, Piwik_Tracker_GoalManager::IDGOAL_ORDER) as $ecommerceType) { - if (!isset($items[$dimension][$ecommerceType])) { - continue; - } - $recordNameInsert = $recordName; - if ($ecommerceType == Piwik_Tracker_GoalManager::IDGOAL_CART) { - $recordNameInsert = self::getItemRecordNameAbandonedCart($recordName); - } - $table = $archiveProcessing->getDataTableFromArray($items[$dimension][$ecommerceType]); - - // For "category" report, we aggregate all 5 category queries into one datatable - if ($dimension == 'idaction_category') { - foreach (array('idaction_category2', 'idaction_category3', 'idaction_category4', 'idaction_category5') as $categoryToSum) { - if (!empty($items[$categoryToSum][$ecommerceType])) { - $tableToSum = $archiveProcessing->getDataTableFromArray($items[$categoryToSum][$ecommerceType]); - $table->addDataTable($tableToSum); - } - } - } - $archiveProcessing->insertBlobRecord($recordNameInsert, $table->getSerialized()); - } - } - } - - static public function getItemRecordNameAbandonedCart($recordName) - { - return $recordName . '_Cart'; - } - - function getConversionRate($count, $archiveProcessing) - { - $visits = $archiveProcessing->getNumberOfVisits(); - return round(100 * $count / $visits, Piwik_Tracker_GoalManager::REVENUE_PRECISION); - } - - /** - * This function executes when the 'Goals.getReportsWithGoalMetrics' event fires. It - * adds the 'visits to conversion' report metadata to the list of goal reports so - * this report will be displayed. - * - * @param Piwik_Event_Notification $notification notification object - */ - function getActualReportsWithGoalMetrics($notification) - { - $dimensions =& $notification->getNotificationObject(); - $dimensions = array_merge($dimensions, array( - array('category' => Piwik_Translate('General_Visit'), - 'name' => Piwik_Translate('Goals_VisitsUntilConv'), - 'module' => 'Goals', - 'action' => 'getVisitsUntilConversion' - ), - array('category' => Piwik_Translate('General_Visit'), - 'name' => Piwik_Translate('Goals_DaysToConv'), - 'module' => 'Goals', - 'action' => 'getDaysToConversion' - ) - )); + $archiving = new Piwik_Goals_Archiving(); + $archiving->archivePeriod($archiveProcessing); } } diff --git a/plugins/MultiSites/API.php b/plugins/MultiSites/API.php index 5aba1c4764..73db0e5347 100755 --- a/plugins/MultiSites/API.php +++ b/plugins/MultiSites/API.php @@ -351,7 +351,7 @@ class Piwik_MultiSites_API } else { $revenueMetric = ''; if (Piwik_Common::isGoalPluginEnabled()) { - $revenueMetric = Piwik_Goals::getRecordName(self::GOAL_REVENUE_METRIC); + $revenueMetric = Piwik_Goals_Archiving::getRecordName(self::GOAL_REVENUE_METRIC); } $totals = array(); @@ -423,7 +423,7 @@ class Piwik_MultiSites_API $metrics[self::GOAL_REVENUE_METRIC] = array( self::METRIC_TRANSLATION_KEY => 'Goals_ColumnRevenue', self::METRIC_EVOLUTION_COL_NAME_KEY => self::GOAL_REVENUE_METRIC . '_evolution', - self::METRIC_RECORD_NAME_KEY => Piwik_Goals::getRecordName(self::GOAL_REVENUE_METRIC), + self::METRIC_RECORD_NAME_KEY => Piwik_Goals_Archiving::getRecordName(self::GOAL_REVENUE_METRIC), self::METRIC_IS_ECOMMERCE_KEY => false, ); @@ -432,7 +432,7 @@ class Piwik_MultiSites_API $metrics[self::GOAL_CONVERSION_METRIC] = array( self::METRIC_TRANSLATION_KEY => 'Goals_ColumnConversions', self::METRIC_EVOLUTION_COL_NAME_KEY => self::GOAL_CONVERSION_METRIC . '_evolution', - self::METRIC_RECORD_NAME_KEY => Piwik_Goals::getRecordName(self::GOAL_CONVERSION_METRIC), + self::METRIC_RECORD_NAME_KEY => Piwik_Goals_Archiving::getRecordName(self::GOAL_CONVERSION_METRIC), self::METRIC_IS_ECOMMERCE_KEY => false, ); @@ -440,7 +440,7 @@ class Piwik_MultiSites_API $metrics[self::ECOMMERCE_ORDERS_METRIC] = array( self::METRIC_TRANSLATION_KEY => 'General_EcommerceOrders', self::METRIC_EVOLUTION_COL_NAME_KEY => self::ECOMMERCE_ORDERS_METRIC . '_evolution', - self::METRIC_RECORD_NAME_KEY => Piwik_Goals::getRecordName(self::GOAL_CONVERSION_METRIC, 0), + self::METRIC_RECORD_NAME_KEY => Piwik_Goals_Archiving::getRecordName(self::GOAL_CONVERSION_METRIC, 0), self::METRIC_IS_ECOMMERCE_KEY => true, ); @@ -448,7 +448,7 @@ class Piwik_MultiSites_API $metrics[self::ECOMMERCE_REVENUE_METRIC] = array( self::METRIC_TRANSLATION_KEY => 'General_ProductRevenue', self::METRIC_EVOLUTION_COL_NAME_KEY => self::ECOMMERCE_REVENUE_METRIC . '_evolution', - self::METRIC_RECORD_NAME_KEY => Piwik_Goals::getRecordName(self::GOAL_REVENUE_METRIC, 0), + self::METRIC_RECORD_NAME_KEY => Piwik_Goals_Archiving::getRecordName(self::GOAL_REVENUE_METRIC, 0), self::METRIC_IS_ECOMMERCE_KEY => true, ); } diff --git a/plugins/PrivacyManager/PrivacyManager.php b/plugins/PrivacyManager/PrivacyManager.php index 840fe5cfc2..a055d2c132 100644 --- a/plugins/PrivacyManager/PrivacyManager.php +++ b/plugins/PrivacyManager/PrivacyManager.php @@ -354,12 +354,12 @@ class Piwik_PrivacyManager extends Piwik_Plugin foreach ($goalMetricsToKeep as $metric) { for ($i = 1; $i <= $maxGoalId; ++$i) // maxGoalId can be 0 { - $metricsToKeep[] = Piwik_Goals::getRecordName($metric, $i); + $metricsToKeep[] = Piwik_Goals_Archiving::getRecordName($metric, $i); } - $metricsToKeep[] = Piwik_Goals::getRecordName($metric); - $metricsToKeep[] = Piwik_Goals::getRecordName($metric, Piwik_Tracker_GoalManager::IDGOAL_ORDER); - $metricsToKeep[] = Piwik_Goals::getRecordName($metric, Piwik_Tracker_GoalManager::IDGOAL_CART); + $metricsToKeep[] = Piwik_Goals_Archiving::getRecordName($metric); + $metricsToKeep[] = Piwik_Goals_Archiving::getRecordName($metric, Piwik_Tracker_GoalManager::IDGOAL_ORDER); + $metricsToKeep[] = Piwik_Goals_Archiving::getRecordName($metric, Piwik_Tracker_GoalManager::IDGOAL_CART); } } -- cgit v1.2.3 From 6bf302feef0d5624c18d6830be2c9a62826ef1e9 Mon Sep 17 00:00:00 2001 From: mattab Date: Wed, 5 Jun 2013 18:13:36 +1200 Subject: Factoring out + cleanup Provider, UserCountry, Goals --- plugins/CustomVariables/Archiving.php | 24 +-- plugins/Goals/Archiving.php | 346 ++++++++++++++++++++++++++++++++++ plugins/Goals/Controller.php | 2 +- plugins/Live/Visitor.php | 4 +- plugins/Provider/Archiving.php | 30 +++ plugins/Provider/Provider.php | 70 ++++--- plugins/Referers/API.php | 22 ++- plugins/Referers/Archiving.php | 346 ++++++++++++++++++++++++++++++++++ plugins/Referers/Referers.php | 294 ++--------------------------- plugins/Referers/functions.php | 2 +- plugins/Transitions/Transitions.php | 2 +- plugins/UserCountry/API.php | 12 +- plugins/UserCountry/Archiving.php | 210 +++++++++++++++++++++ plugins/UserCountry/UserCountry.php | 201 +------------------- plugins/UserCountry/functions.php | 6 +- 15 files changed, 1032 insertions(+), 539 deletions(-) create mode 100644 plugins/Goals/Archiving.php create mode 100644 plugins/Provider/Archiving.php create mode 100644 plugins/Referers/Archiving.php create mode 100644 plugins/UserCountry/Archiving.php (limited to 'plugins') diff --git a/plugins/CustomVariables/Archiving.php b/plugins/CustomVariables/Archiving.php index 166d8c9124..c85d230b3b 100644 --- a/plugins/CustomVariables/Archiving.php +++ b/plugins/CustomVariables/Archiving.php @@ -27,10 +27,15 @@ class Piwik_CustomVariables_Archiving public function archiveDay(Piwik_ArchiveProcessing_Day $archiveProcessing) { - $this->archiveDayAggregate($archiveProcessing); + for ($i = 1; $i <= Piwik_Tracker::MAX_CUSTOM_VARIABLES; $i++) { + $this->aggregateCustomVariable($archiveProcessing, $i); + } - $table = $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByKeyAndValue, $this->metricsByKey); + $this->removeVisitsMetricsFromActionsAggregate($archiveProcessing); + $archiveProcessing->enrichConversionsByLabelArray($this->metricsByKey); + $archiveProcessing->enrichConversionsByLabelArrayHasTwoLevels($this->metricsByKeyAndValue); + $table = $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByKeyAndValue, $this->metricsByKey); $blob = $table->getSerialized( $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $columnToSort = Piwik_Archive::INDEX_NB_VISITS @@ -39,21 +44,6 @@ class Piwik_CustomVariables_Archiving $archiveProcessing->insertBlobRecord(self::BLOB_NAME, $blob); } - /** - * @param Piwik_ArchiveProcessing_Day $archiveProcessing - * @return void - */ - protected function archiveDayAggregate(Piwik_ArchiveProcessing_Day $archiveProcessing) - { - for ($i = 1; $i <= Piwik_Tracker::MAX_CUSTOM_VARIABLES; $i++) { - $this->aggregateCustomVariable($archiveProcessing, $i); - } - - $this->removeVisitsMetricsFromActionsAggregate($archiveProcessing); - $archiveProcessing->enrichConversionsByLabelArray($this->metricsByKey); - $archiveProcessing->enrichConversionsByLabelArrayHasTwoLevels($this->metricsByKeyAndValue); - } - /** * @param Piwik_ArchiveProcessing_Day $archiveProcessing * @param $slot diff --git a/plugins/Goals/Archiving.php b/plugins/Goals/Archiving.php new file mode 100644 index 0000000000..c99ba4d48d --- /dev/null +++ b/plugins/Goals/Archiving.php @@ -0,0 +1,346 @@ + 'Goals_ItemsSku', + 'idaction_name' => 'Goals_ItemsName', + 'idaction_category' => 'Goals_ItemsCategory' + ); + + /** + * @param $archiveProcessing + */ + public function archiveDay($archiveProcessing) + { + $this->archiveGeneralGoalMetrics($archiveProcessing); + $this->archiveEcommerceItems($archiveProcessing); + } + + /** + * @param Piwik_ArchiveProcessing_Day $archiveProcessing + */ + function archiveGeneralGoalMetrics($archiveProcessing) + { + // extra aggregate selects for the visits to conversion report + $visitToConvExtraCols = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( + 'visitor_count_visits', self::$visitCountRanges, 'log_conversion', 'vcv'); + + // extra aggregate selects for the days to conversion report + $daysToConvExtraCols = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( + 'visitor_days_since_first', self::$daysToConvRanges, 'log_conversion', 'vdsf'); + + $query = $archiveProcessing->queryConversionsByDimension( + array(), '', array_merge($visitToConvExtraCols, $daysToConvExtraCols)); + + if ($query === false) { + return; + } + + $goals = array(); + $visitsToConvReport = array(); + $daysToConvReport = array(); + + // Get a standard empty goal row + $overall = $archiveProcessing->makeEmptyGoalRow($idGoal = 1); + while ($row = $query->fetch()) { + $idgoal = $row['idgoal']; + + if (!isset($goals[$idgoal])) { + $goals[$idgoal] = $archiveProcessing->makeEmptyGoalRow($idgoal); + + $visitsToConvReport[$idgoal] = new Piwik_DataTable(); + $daysToConvReport[$idgoal] = new Piwik_DataTable(); + } + $archiveProcessing->sumGoalMetrics($row, $goals[$idgoal]); + + // We don't want to sum Abandoned cart metrics in the overall revenue/conversions/converted visits + // since it is a "negative conversion" + if ($idgoal != Piwik_Tracker_GoalManager::IDGOAL_CART) { + $archiveProcessing->sumGoalMetrics($row, $overall); + } + + // map the goal + visit number of a visitor with the # of conversions that happened on that visit + $table = $archiveProcessing->getSimpleDataTableFromRow($row, Piwik_Archive::INDEX_NB_CONVERSIONS, 'vcv'); + $visitsToConvReport[$idgoal]->addDataTable($table); + + // map the goal + day number of a visit with the # of conversion that happened on that day + $table = $archiveProcessing->getSimpleDataTableFromRow($row, Piwik_Archive::INDEX_NB_CONVERSIONS, 'vdsf'); + $daysToConvReport[$idgoal]->addDataTable($table); + } + + // these data tables hold reports for every goal of a site + $visitsToConvOverview = new Piwik_DataTable(); + $daysToConvOverview = new Piwik_DataTable(); + + // Stats by goal, for all visitors + foreach ($goals as $idgoal => $values) { + foreach ($values as $metricId => $value) { + $metricName = Piwik_Archive::$mappingFromIdToNameGoal[$metricId]; + $recordName = self::getRecordName($metricName, $idgoal); + $archiveProcessing->insertNumericRecord($recordName, $value); + } + $conversion_rate = $this->getConversionRate($values[Piwik_Archive::INDEX_GOAL_NB_VISITS_CONVERTED], $archiveProcessing); + $recordName = self::getRecordName('conversion_rate', $idgoal); + $archiveProcessing->insertNumericRecord($recordName, $conversion_rate); + + // if the goal is not a special goal (like ecommerce) add it to the overview report + if ($idgoal !== Piwik_Tracker_GoalManager::IDGOAL_CART && + $idgoal !== Piwik_Tracker_GoalManager::IDGOAL_ORDER + ) { + $visitsToConvOverview->addDataTable($visitsToConvReport[$idgoal]); + $daysToConvOverview->addDataTable($daysToConvReport[$idgoal]); + } + + // visit count until conversion stats + $archiveProcessing->insertBlobRecord( + self::getRecordName(self::VISITS_UNTIL_RECORD_NAME, $idgoal), + $visitsToConvReport[$idgoal]->getSerialized()); + + // day count until conversion stats + $archiveProcessing->insertBlobRecord( + self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME, $idgoal), + $daysToConvReport[$idgoal]->getSerialized()); + } + + // archive overview reports + $archiveProcessing->insertBlobRecord( + self::getRecordName(self::VISITS_UNTIL_RECORD_NAME), $visitsToConvOverview->getSerialized()); + $archiveProcessing->insertBlobRecord( + self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME), $daysToConvOverview->getSerialized()); + + // Stats for all goals + $totalAllGoals = array( + self::getRecordName('conversion_rate') => $this->getConversionRate($archiveProcessing->getNumberOfVisitsConverted(), $archiveProcessing), + self::getRecordName('nb_conversions') => $overall[Piwik_Archive::INDEX_GOAL_NB_CONVERSIONS], + self::getRecordName('nb_visits_converted') => $archiveProcessing->getNumberOfVisitsConverted(), + self::getRecordName('revenue') => $overall[Piwik_Archive::INDEX_GOAL_REVENUE], + ); + foreach ($totalAllGoals as $recordName => $value) { + $archiveProcessing->insertNumericRecord($recordName, $value); + } + } + + /** + * @param string $recordName 'nb_conversions' + * @param int|bool $idGoal idGoal to return the metrics for, or false to return overall + * @return string Archive record name + */ + static public function getRecordName($recordName, $idGoal = false) + { + $idGoalStr = ''; + if ($idGoal !== false) { + $idGoalStr = $idGoal . "_"; + } + return 'Goal_' . $idGoalStr . $recordName; + } + + private function getConversionRate($count, $archiveProcessing) + { + $visits = $archiveProcessing->getNumberOfVisits(); + return round(100 * $count / $visits, Piwik_Tracker_GoalManager::REVENUE_PRECISION); + } + + /** + * @param Piwik_ArchiveProcessing_Day $archiveProcessing + */ + function archiveEcommerceItems($archiveProcessing) + { + if (!$this->shouldArchiveEcommerceItems($archiveProcessing)) { + return false; + } + $items = array(); + + $dimensionsToQuery = $this->dimensions; + $dimensionsToQuery['idaction_category2'] = 'AdditionalCategory'; + $dimensionsToQuery['idaction_category3'] = 'AdditionalCategory'; + $dimensionsToQuery['idaction_category4'] = 'AdditionalCategory'; + $dimensionsToQuery['idaction_category5'] = 'AdditionalCategory'; + + foreach ($dimensionsToQuery as $dimension => $recordName) { + $query = $archiveProcessing->queryEcommerceItems($dimension); + if ($query == false) { + continue; + } + + while ($row = $query->fetch()) { + $label = $row['label']; + $ecommerceType = $row['ecommerceType']; + + if (empty($label)) { + // idaction==0 case: + // If we are querying any optional category, we do not include idaction=0 + // Otherwise we over-report in the Product Categories report + if ($recordName == 'AdditionalCategory') { + continue; + } + // Product Name/Category not defined" + if (class_exists('Piwik_CustomVariables')) { + $label = Piwik_CustomVariables_Archiving::LABEL_CUSTOM_VALUE_NOT_DEFINED; + } else { + $label = "Value not defined"; + } + } + // For carts, idorder = 0. To count abandoned carts, we must count visits with an abandoned cart + if ($ecommerceType == Piwik_Tracker_GoalManager::IDGOAL_CART) { + $row[Piwik_Archive::INDEX_ECOMMERCE_ORDERS] = $row[Piwik_Archive::INDEX_NB_VISITS]; + } + unset($row[Piwik_Archive::INDEX_NB_VISITS]); + unset($row['label']); + unset($row['ecommerceType']); + + $columnsToRound = array( + Piwik_Archive::INDEX_ECOMMERCE_ITEM_REVENUE, + Piwik_Archive::INDEX_ECOMMERCE_ITEM_QUANTITY, + Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE, + Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED, + ); + foreach ($columnsToRound as $column) { + if (isset($row[$column]) + && $row[$column] == round($row[$column]) + ) { + $row[$column] = round($row[$column]); + } + } + $items[$dimension][$ecommerceType][$label] = $row; + } + } + + foreach ($this->dimensions as $dimension => $recordName) { + foreach (array(Piwik_Tracker_GoalManager::IDGOAL_CART, Piwik_Tracker_GoalManager::IDGOAL_ORDER) as $ecommerceType) { + if (!isset($items[$dimension][$ecommerceType])) { + continue; + } + $recordNameInsert = $recordName; + if ($ecommerceType == Piwik_Tracker_GoalManager::IDGOAL_CART) { + $recordNameInsert = self::getItemRecordNameAbandonedCart($recordName); + } + $table = $archiveProcessing->getDataTableFromArray($items[$dimension][$ecommerceType]); + + // For "category" report, we aggregate all 5 category queries into one datatable + if ($dimension == 'idaction_category') { + foreach (array('idaction_category2', 'idaction_category3', 'idaction_category4', 'idaction_category5') as $categoryToSum) { + if (!empty($items[$categoryToSum][$ecommerceType])) { + $tableToSum = $archiveProcessing->getDataTableFromArray($items[$categoryToSum][$ecommerceType]); + $table->addDataTable($tableToSum); + } + } + } + $archiveProcessing->insertBlobRecord($recordNameInsert, $table->getSerialized()); + } + } + } + + protected function shouldArchiveEcommerceItems($archiveProcessing) + { + // Per item doesn't support segment + // Also, when querying Goal metrics for visitorType==returning, we wouldnt want to trigger an extra request + // event if it did support segment + // (if this is implented, we should have shouldProcessReportsForPlugin() support partial archiving based on which metric is requested) + if (!$archiveProcessing->getSegment()->isEmpty()) { + return false; + } + return true; + } + + static public function getItemRecordNameAbandonedCart($recordName) + { + return $recordName . '_Cart'; + } + + /** + * @param $archiveProcessing + */ + public function archivePeriod($archiveProcessing) + { + /* + * Archive Ecommerce Items + */ + if ($this->shouldArchiveEcommerceItems($archiveProcessing)) { + $dataTableToSum = $this->dimensions; + foreach ($this->dimensions as $recordName) { + $dataTableToSum[] = self::getItemRecordNameAbandonedCart($recordName); + } + $archiveProcessing->archiveDataTable($dataTableToSum); + } + + /* + * Archive General Goal metrics + */ + $goalIdsToSum = Piwik_Tracker_GoalManager::getGoalIds($archiveProcessing->idsite); + + //Ecommerce + $goalIdsToSum[] = Piwik_Tracker_GoalManager::IDGOAL_ORDER; + $goalIdsToSum[] = Piwik_Tracker_GoalManager::IDGOAL_CART; //bug here if idgoal=1 + // Overall goal metrics + $goalIdsToSum[] = false; + + $fieldsToSum = array(); + foreach ($goalIdsToSum as $goalId) { + $metricsToSum = Piwik_Goals::getGoalColumns($goalId); + unset($metricsToSum[array_search('conversion_rate', $metricsToSum)]); + foreach ($metricsToSum as $metricName) { + $fieldsToSum[] = self::getRecordName($metricName, $goalId); + } + } + $records = $archiveProcessing->archiveNumericValuesSum($fieldsToSum); + + // also recording conversion_rate for each goal + foreach ($goalIdsToSum as $goalId) { + $nb_conversions = $records[self::getRecordName('nb_visits_converted', $goalId)]; + $conversion_rate = $this->getConversionRate($nb_conversions, $archiveProcessing); + $archiveProcessing->insertNumericRecord(self::getRecordName('conversion_rate', $goalId), $conversion_rate); + + // sum up the visits to conversion data table & the days to conversion data table + $archiveProcessing->archiveDataTable(array( + self::getRecordName(self::VISITS_UNTIL_RECORD_NAME, $goalId), + self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME, $goalId))); + } + + // sum up goal overview reports + $archiveProcessing->archiveDataTable(array( + self::getRecordName(self::VISITS_UNTIL_RECORD_NAME), + self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME))); + } + +} \ No newline at end of file diff --git a/plugins/Goals/Controller.php b/plugins/Goals/Controller.php index 15eb85c345..7f374e40f3 100644 --- a/plugins/Goals/Controller.php +++ b/plugins/Goals/Controller.php @@ -361,7 +361,7 @@ class Piwik_Goals_Controller extends Piwik_Controller $keywordNotDefinedString = ''; if (Piwik_PluginsManager::getInstance()->isPluginActivated('Referers')) { - $keywordNotDefinedString = Piwik_Referers::getKeywordNotDefinedString(); + $keywordNotDefinedString = Piwik_Referers_API::getKeywordNotDefinedString(); $topDimensionsToLoad += array( 'keyword' => 'Referers.getKeywords', 'website' => 'Referers.getWebsites', diff --git a/plugins/Live/Visitor.php b/plugins/Live/Visitor.php index 8a8c984021..5228e18aa8 100644 --- a/plugins/Live/Visitor.php +++ b/plugins/Live/Visitor.php @@ -344,7 +344,7 @@ class Piwik_Live_Visitor if (Piwik_PluginsManager::getInstance()->isPluginActivated('Referers') && $this->getRefererType() == 'search' ) { - $keyword = Piwik_Referers::getCleanKeyword($keyword); + $keyword = Piwik_Referers_API::getCleanKeyword($keyword); } return urldecode($keyword); } @@ -353,7 +353,7 @@ class Piwik_Live_Visitor { if ($this->getRefererType() == 'search') { if (Piwik_PluginsManager::getInstance()->isPluginActivated('Referers') - && $this->details['referer_keyword'] == Piwik_Referers::LABEL_KEYWORD_NOT_DEFINED + && $this->details['referer_keyword'] == Piwik_Referers_API::LABEL_KEYWORD_NOT_DEFINED ) { return 'http://piwik.org/faq/general/#faq_144'; } // Case URL is google.XX/url.... then we rewrite to the search result page url diff --git a/plugins/Provider/Archiving.php b/plugins/Provider/Archiving.php new file mode 100644 index 0000000000..c0228e788f --- /dev/null +++ b/plugins/Provider/Archiving.php @@ -0,0 +1,30 @@ +getArrayInterestForLabel($labelSQL); + $tableProvider = $archiveProcessing->getDataTableFromArray($metricsByProvider); + $columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; + $maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; + $archiveProcessing->insertBlobRecord($recordName, $tableProvider->getSerialized($maximumRowsInDataTable, null, $columnToSortByBeforeTruncation)); + } + + /** + * @param $archiveProcessing + */ + public function archivePeriod($archiveProcessing) + { + $maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; + $dataTableToSum = array('Provider_hostnameExt'); + $archiveProcessing->archiveDataTable($dataTableToSum, null, $maximumRowsInDataTable); + } + +} \ No newline at end of file diff --git a/plugins/Provider/Provider.php b/plugins/Provider/Provider.php index 67a1d35371..87c7de7efb 100644 --- a/plugins/Provider/Provider.php +++ b/plugins/Provider/Provider.php @@ -114,42 +114,6 @@ class Piwik_Provider extends Piwik_Plugin Piwik_AddAction('template_footerUserCountry', array('Piwik_Provider', 'footerUserCountry')); } - /** - * @param Piwik_Event_Notification $notification notification object - * @return mixed - */ - function archivePeriod($notification) - { - $maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; - $archiveProcessing = $notification->getNotificationObject(); - - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - - $dataTableToSum = array('Provider_hostnameExt'); - $archiveProcessing->archiveDataTable($dataTableToSum, null, $maximumRowsInDataTable); - } - - /** - * Daily archive: processes the report Visits by Provider - * - * @param Piwik_Event_Notification $notification notification object - */ - function archiveDay($notification) - { - $archiveProcessing = $notification->getNotificationObject(); - - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - - $recordName = 'Provider_hostnameExt'; - $labelSQL = "log_visit.location_provider"; - $metricsByProvider = $archiveProcessing->getArrayInterestForLabel($labelSQL); - $tableProvider = $archiveProcessing->getDataTableFromArray($metricsByProvider); - $columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; - $maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; - $archiveProcessing->insertBlobRecord($recordName, $tableProvider->getSerialized($maximumRowsInDataTable, null, $columnToSortByBeforeTruncation)); - destroy($tableProvider); - } - /** * Logs the provider in the log_visit table * @@ -250,4 +214,38 @@ class Piwik_Provider extends Piwik_Plugin $out .= '
    '; } + /** + * Daily archive: processes the report Visits by Provider + * + * @param Piwik_Event_Notification $notification notification object + */ + function archiveDay($notification) + { + $archiveProcessing = $notification->getNotificationObject(); + + if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { + return; + } + + $archiving = new Piwik_Provider_Archiving(); + $archiving->archiveDay($archiveProcessing); + } + + /** + * @param Piwik_Event_Notification $notification notification object + * @return mixed + */ + function archivePeriod($notification) + { + $archiveProcessing = $notification->getNotificationObject(); + + if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { + return; + } + + $archiving = new Piwik_Provider_Archiving(); + $archiving->archivePeriod($archiveProcessing); + } + + } diff --git a/plugins/Referers/API.php b/plugins/Referers/API.php index 6516228fd6..327fa59c2c 100644 --- a/plugins/Referers/API.php +++ b/plugins/Referers/API.php @@ -138,10 +138,30 @@ class Piwik_Referers_API protected function handleKeywordNotDefined($dataTable) { - $dataTable->queueFilter('ColumnCallbackReplace', array('label', array('Piwik_Referers', 'getCleanKeyword'))); + $dataTable->queueFilter('ColumnCallbackReplace', array('label', array('Piwik_Referers_API', 'getCleanKeyword'))); return $dataTable; } + const LABEL_KEYWORD_NOT_DEFINED = ""; + + /** + * @ignore + */ + static public function getKeywordNotDefinedString() + { + return Piwik_Translate('General_NotDefined', Piwik_Translate('Referers_ColumnKeyword')); + } + + /** + * @ignore + */ + static public function getCleanKeyword($label) + { + return $label == self::LABEL_KEYWORD_NOT_DEFINED + ? self::getKeywordNotDefinedString() + : $label; + } + public function getKeywordsForPageUrl($idSite, $period, $date, $url) { // Fetch the Top keywords for this page diff --git a/plugins/Referers/Archiving.php b/plugins/Referers/Archiving.php new file mode 100644 index 0000000000..0fca433ba3 --- /dev/null +++ b/plugins/Referers/Archiving.php @@ -0,0 +1,346 @@ +columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; + $this->maximumRowsInDataTableLevelZero = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_referers']; + $this->maximumRowsInSubDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_subtable_referers']; + } + + /** + * @param $archiveProcessing + */ + public function archiveDay($archiveProcessing) + { + $query = $archiveProcessing->queryVisitsByDimension(array("referer_type", "referer_name", "referer_keyword", "referer_url")); + $this->aggregateFromVisits($archiveProcessing, $query); + + $query = $archiveProcessing->queryConversionsByDimension(array("referer_type", "referer_name", "referer_keyword")); + $this->aggregateFromConversions($archiveProcessing, $query); + + Piwik_PostEvent('Referers.archiveDay', $this); + $this->archiveDayRecordInDatabase($archiveProcessing); + } + + /** + * @param Piwik_ArchiveProcessing_Day $archiveProcessing + * @param $query + * @throws Exception + */ + protected function aggregateFromVisits(Piwik_ArchiveProcessing_Day $archiveProcessing, $query) + { + $this->metricsBySearchEngine = + $this->metricsByKeyword = + $this->metricsBySearchEngineAndKeyword = + $this->metricsByKeywordAndSearchEngine = + $this->metricsByWebsite = + $this->metricsByWebsiteAndUrl = + $this->metricsByCampaignAndKeyword = + $this->metricsByCampaign = + $this->metricsByType = + $this->distinctUrls = array(); + while ($row = $query->fetch()) { + $this->makeRefererTypeNonEmpty($row); + $this->aggregateVisit($archiveProcessing, $row); + $this->aggregateVisitByType($archiveProcessing, $row); + + } + } + + protected function makeRefererTypeNonEmpty(&$row) + { + if (empty($row['referer_type'])) { + $row['referer_type'] = Piwik_Common::REFERER_TYPE_DIRECT_ENTRY; + } + } + + protected function aggregateVisit(Piwik_ArchiveProcessing_Day $archiveProcessing, $row) + { + switch ($row['referer_type']) { + case Piwik_Common::REFERER_TYPE_SEARCH_ENGINE: + $this->aggregateVisitBySearchEngine($archiveProcessing, $row); + break; + + case Piwik_Common::REFERER_TYPE_WEBSITE: + $this->aggregateVisitByWebsite($archiveProcessing, $row); + break; + + case Piwik_Common::REFERER_TYPE_CAMPAIGN: + $this->aggregateVisitByCampaign($archiveProcessing, $row); + break; + + case Piwik_Common::REFERER_TYPE_DIRECT_ENTRY: + // direct entry are aggregated below in $this->metricsByType array + break; + + default: + throw new Exception("Non expected referer_type = " . $row['referer_type']); + break; + } + } + + protected function aggregateVisitBySearchEngine(Piwik_ArchiveProcessing_Day $archiveProcessing, $row) + { + if (empty($row['referer_keyword'])) { + $row['referer_keyword'] = Piwik_Referers_API::LABEL_KEYWORD_NOT_DEFINED; + } + if (!isset($this->metricsBySearchEngine[$row['referer_name']])) { + $this->metricsBySearchEngine[$row['referer_name']] = $archiveProcessing->makeEmptyRow(); + } + if (!isset($this->metricsByKeyword[$row['referer_keyword']])) { + $this->metricsByKeyword[$row['referer_keyword']] = $archiveProcessing->makeEmptyRow(); + } + if (!isset($this->metricsBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']])) { + $this->metricsBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']] = $archiveProcessing->makeEmptyRow(); + } + if (!isset($this->metricsByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']])) { + $this->metricsByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']] = $archiveProcessing->makeEmptyRow(); + } + + $archiveProcessing->sumMetrics($row, $this->metricsBySearchEngine[$row['referer_name']]); + $archiveProcessing->sumMetrics($row, $this->metricsByKeyword[$row['referer_keyword']]); + $archiveProcessing->sumMetrics($row, $this->metricsBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']]); + $archiveProcessing->sumMetrics($row, $this->metricsByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']]); + } + + protected function aggregateVisitByWebsite(Piwik_ArchiveProcessing_Day $archiveProcessing, $row) + { + if (!isset($this->metricsByWebsite[$row['referer_name']])) { + $this->metricsByWebsite[$row['referer_name']] = $archiveProcessing->makeEmptyRow(); + } + $archiveProcessing->sumMetrics($row, $this->metricsByWebsite[$row['referer_name']]); + + if (!isset($this->metricsByWebsiteAndUrl[$row['referer_name']][$row['referer_url']])) { + $this->metricsByWebsiteAndUrl[$row['referer_name']][$row['referer_url']] = $archiveProcessing->makeEmptyRow(); + } + $archiveProcessing->sumMetrics($row, $this->metricsByWebsiteAndUrl[$row['referer_name']][$row['referer_url']]); + + $urlHash = substr(md5($row['referer_url']), 0, 10); + if (!isset($this->distinctUrls[$urlHash])) { + $this->distinctUrls[$urlHash] = true; + } + } + + protected function aggregateVisitByCampaign(Piwik_ArchiveProcessing_Day $archiveProcessing, $row) + { + if (!empty($row['referer_keyword'])) { + if (!isset($this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']])) { + $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']] = $archiveProcessing->makeEmptyRow(); + } + $archiveProcessing->sumMetrics($row, $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']]); + } + if (!isset($this->metricsByCampaign[$row['referer_name']])) { + $this->metricsByCampaign[$row['referer_name']] = $archiveProcessing->makeEmptyRow(); + } + $archiveProcessing->sumMetrics($row, $this->metricsByCampaign[$row['referer_name']]); + } + + protected function aggregateVisitByType(Piwik_ArchiveProcessing_Day $archiveProcessing, $row) + { + if (!isset($this->metricsByType[$row['referer_type']])) { + $this->metricsByType[$row['referer_type']] = $archiveProcessing->makeEmptyRow(); + } + $archiveProcessing->sumMetrics($row, $this->metricsByType[$row['referer_type']]); + } + + protected function aggregateFromConversions($archiveProcessing, $query) + { + if ($query === false) { + return; + } + while ($row = $query->fetch()) { + $this->makeRefererTypeNonEmpty($row); + + $skipAggregateByType = $this->aggregateConversion($archiveProcessing, $row); + if (!$skipAggregateByType) { + $this->aggregateConversionByType($archiveProcessing, $row); + } + } + + $archiveProcessing->enrichConversionsByLabelArray($this->metricsByType); + $archiveProcessing->enrichConversionsByLabelArray($this->metricsBySearchEngine); + $archiveProcessing->enrichConversionsByLabelArray($this->metricsByKeyword); + $archiveProcessing->enrichConversionsByLabelArray($this->metricsByWebsite); + $archiveProcessing->enrichConversionsByLabelArray($this->metricsByCampaign); + $archiveProcessing->enrichConversionsByLabelArrayHasTwoLevels($this->metricsByCampaignAndKeyword); + } + + protected function aggregateConversion($archiveProcessing, $row) + { + $skipAggregateByType = false; + switch ($row['referer_type']) { + case Piwik_Common::REFERER_TYPE_SEARCH_ENGINE: + $this->aggregateConversionBySearchEngine($archiveProcessing, $row); + break; + + case Piwik_Common::REFERER_TYPE_WEBSITE: + $this->aggregateConversionByWebsite($archiveProcessing, $row); + break; + + case Piwik_Common::REFERER_TYPE_CAMPAIGN: + $this->aggregateConversionByCampaign($archiveProcessing, $row); + break; + + case Piwik_Common::REFERER_TYPE_DIRECT_ENTRY: + // Direct entry, no sub dimension + break; + + default: + // The referer type is user submitted for goal conversions, we ignore any malformed value + // Continue to the next while iteration + $skipAggregateByType = true; + break; + } + return $skipAggregateByType; + } + + protected function aggregateConversionBySearchEngine($archiveProcessing, $row) + { + if (empty($row['referer_keyword'])) { + $row['referer_keyword'] = Piwik_Referers_API::LABEL_KEYWORD_NOT_DEFINED; + } + if (!isset($this->metricsBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { + $this->metricsBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); + } + if (!isset($this->metricsByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { + $this->metricsByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); + } + + $archiveProcessing->sumGoalMetrics($row, $this->metricsBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + $archiveProcessing->sumGoalMetrics($row, $this->metricsByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + } + + protected function aggregateConversionByWebsite($archiveProcessing, $row) + { + if (!isset($this->metricsByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { + $this->metricsByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); + } + $archiveProcessing->sumGoalMetrics($row, $this->metricsByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + } + + protected function aggregateConversionByCampaign($archiveProcessing, $row) + { + if (!empty($row['referer_keyword'])) { + if (!isset($this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { + $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); + } + $archiveProcessing->sumGoalMetrics($row, $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + } + if (!isset($this->metricsByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { + $this->metricsByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); + } + $archiveProcessing->sumGoalMetrics($row, $this->metricsByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + } + + protected function aggregateConversionByType($archiveProcessing, $row) + { + if (!isset($this->metricsByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { + $this->metricsByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); + } + $archiveProcessing->sumGoalMetrics($row, $this->metricsByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + } + + /** + * Records the daily stats (numeric or datatable blob) into the archive tables. + * + * @param Piwik_ArchiveProcessing $archiveProcessing + * @return void + */ + protected function archiveDayRecordInDatabase($archiveProcessing) + { + $numericRecords = array( + 'Referers_distinctSearchEngines' => count($this->metricsBySearchEngineAndKeyword), + 'Referers_distinctKeywords' => count($this->metricsByKeywordAndSearchEngine), + 'Referers_distinctCampaigns' => count($this->metricsByCampaign), + 'Referers_distinctWebsites' => count($this->metricsByWebsite), + 'Referers_distinctWebsitesUrls' => count($this->distinctUrls), + ); + + foreach ($numericRecords as $name => $value) { + $archiveProcessing->insertNumericRecord($name, $value); + } + + $dataTable = $archiveProcessing->getDataTableSerialized($this->metricsByType); + $archiveProcessing->insertBlobRecord('Referers_type', $dataTable); + destroy($dataTable); + + $blobRecords = array( + 'Referers_keywordBySearchEngine' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsBySearchEngineAndKeyword, $this->metricsBySearchEngine), + 'Referers_searchEngineByKeyword' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByKeywordAndSearchEngine, $this->metricsByKeyword), + 'Referers_keywordByCampaign' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByCampaignAndKeyword, $this->metricsByCampaign), + 'Referers_urlByWebsite' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByWebsiteAndUrl, $this->metricsByWebsite), + ); + foreach ($blobRecords as $recordName => $table) { + $blob = $table->getSerialized($this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $this->columnToSortByBeforeTruncation); + $archiveProcessing->insertBlobRecord($recordName, $blob); + destroy($table); + } + } + + /** + * @param $archiveProcessing + */ + public function archivePeriod($archiveProcessing) + { + $dataTableToSum = array( + 'Referers_type', + 'Referers_keywordBySearchEngine', + 'Referers_searchEngineByKeyword', + 'Referers_keywordByCampaign', + 'Referers_urlByWebsite', + ); + $nameToCount = $archiveProcessing->archiveDataTable($dataTableToSum, null, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $this->columnToSortByBeforeTruncation); + + $mappingFromArchiveName = array( + 'Referers_distinctSearchEngines' => + array('typeCountToUse' => 'level0', + 'nameTableToUse' => 'Referers_keywordBySearchEngine', + ), + 'Referers_distinctKeywords' => + array('typeCountToUse' => 'level0', + 'nameTableToUse' => 'Referers_searchEngineByKeyword', + ), + 'Referers_distinctCampaigns' => + array('typeCountToUse' => 'level0', + 'nameTableToUse' => 'Referers_keywordByCampaign', + ), + 'Referers_distinctWebsites' => + array('typeCountToUse' => 'level0', + 'nameTableToUse' => 'Referers_urlByWebsite', + ), + 'Referers_distinctWebsitesUrls' => + array('typeCountToUse' => 'recursive', + 'nameTableToUse' => 'Referers_urlByWebsite', + ), + ); + + foreach ($mappingFromArchiveName as $name => $infoMapping) { + $typeCountToUse = $infoMapping['typeCountToUse']; + $nameTableToUse = $infoMapping['nameTableToUse']; + + if ($typeCountToUse == 'recursive') { + + $countValue = $nameToCount[$nameTableToUse]['recursive'] + - $nameToCount[$nameTableToUse]['level0']; + } else { + $countValue = $nameToCount[$nameTableToUse]['level0']; + } + $archiveProcessing->insertNumericRecord($name, $countValue); + } + } +} \ No newline at end of file diff --git a/plugins/Referers/Referers.php b/plugins/Referers/Referers.php index 2c36a17d5a..814e78f19b 100644 --- a/plugins/Referers/Referers.php +++ b/plugins/Referers/Referers.php @@ -19,21 +19,14 @@ require_once PIWIK_INCLUDE_PATH . '/plugins/Referers/functions.php'; */ class Piwik_Referers extends Piwik_Plugin { - public $archiveProcessing; - protected $columnToSortByBeforeTruncation; - protected $maximumRowsInDataTableLevelZero; - protected $maximumRowsInSubDataTable; - public function getInformation() { - $info = array( + return array( 'description' => Piwik_Translate('Referers_PluginDescription'), 'author' => 'Piwik', 'author_homepage' => 'http://piwik.org/', 'version' => Piwik_Version::VERSION, ); - - return $info; } function getListHooksRegistered() @@ -289,86 +282,6 @@ class Piwik_Referers extends Piwik_Plugin )); } - function __construct() - { - $this->columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; - $this->maximumRowsInDataTableLevelZero = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_referers']; - $this->maximumRowsInSubDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_subtable_referers']; - } - - /** - * Period archiving: sums up daily stats and sums report tables, - * making sure that tables are still truncated. - * - * @param Piwik_Event_Notification $notification notification object - * @return void - */ - function archivePeriod($notification) - { - $archiveProcessing = $notification->getNotificationObject(); - - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - - $dataTableToSum = array( - 'Referers_type', - 'Referers_keywordBySearchEngine', - 'Referers_searchEngineByKeyword', - 'Referers_keywordByCampaign', - 'Referers_urlByWebsite', - ); - $nameToCount = $archiveProcessing->archiveDataTable($dataTableToSum, null, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $this->columnToSortByBeforeTruncation); - - $mappingFromArchiveName = array( - 'Referers_distinctSearchEngines' => - array('typeCountToUse' => 'level0', - 'nameTableToUse' => 'Referers_keywordBySearchEngine', - ), - 'Referers_distinctKeywords' => - array('typeCountToUse' => 'level0', - 'nameTableToUse' => 'Referers_searchEngineByKeyword', - ), - 'Referers_distinctCampaigns' => - array('typeCountToUse' => 'level0', - 'nameTableToUse' => 'Referers_keywordByCampaign', - ), - 'Referers_distinctWebsites' => - array('typeCountToUse' => 'level0', - 'nameTableToUse' => 'Referers_urlByWebsite', - ), - 'Referers_distinctWebsitesUrls' => - array('typeCountToUse' => 'recursive', - 'nameTableToUse' => 'Referers_urlByWebsite', - ), - ); - - foreach ($mappingFromArchiveName as $name => $infoMapping) { - $typeCountToUse = $infoMapping['typeCountToUse']; - $nameTableToUse = $infoMapping['nameTableToUse']; - - if ($typeCountToUse == 'recursive') { - - $countValue = $nameToCount[$nameTableToUse]['recursive'] - - $nameToCount[$nameTableToUse]['level0']; - } else { - $countValue = $nameToCount[$nameTableToUse]['level0']; - } - $archiveProcessing->insertNumericRecord($name, $countValue); - } - } - - const LABEL_KEYWORD_NOT_DEFINED = ""; - - static public function getKeywordNotDefinedString() - { - return Piwik_Translate('General_NotDefined', Piwik_Translate('Referers_ColumnKeyword')); - } - - static public function getCleanKeyword($label) - { - return $label == Piwik_Referers::LABEL_KEYWORD_NOT_DEFINED - ? self::getKeywordNotDefinedString() - : $label; - } /** * Hooks on daily archive to trigger various log processing @@ -381,208 +294,33 @@ class Piwik_Referers extends Piwik_Plugin /** * @var Piwik_ArchiveProcessing_Day */ - $this->archiveProcessing = $notification->getNotificationObject(); - if (!$this->archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - - $this->archiveDayAggregateVisits($this->archiveProcessing); - $this->archiveDayAggregateGoals($this->archiveProcessing); - Piwik_PostEvent('Referers.archiveDay', $this); - $this->archiveDayRecordInDatabase($this->archiveProcessing); - $this->cleanup(); - } - - protected function cleanup() - { - destroy($this->metricsBySearchEngine); - destroy($this->metricsByKeyword); - destroy($this->metricsBySearchEngineAndKeyword); - destroy($this->metricsByKeywordAndSearchEngine); - destroy($this->metricsByWebsite); - destroy($this->metricsByWebsiteAndUrl); - destroy($this->metricsByCampaignAndKeyword); - destroy($this->metricsByCampaign); - destroy($this->metricsByType); - destroy($this->distinctUrls); - } - - /** - * Daily archive: processes all Referers reports, eg. Visits by Keyword, - * Visits by websites, etc. - * - * @param Piwik_ArchiveProcessing $archiveProcessing - * @throws Exception - * @return void - */ - protected function archiveDayAggregateVisits(Piwik_ArchiveProcessing_Day $archiveProcessing) - { - $dimension = array("referer_type", "referer_name", "referer_keyword", "referer_url"); - $query = $archiveProcessing->queryVisitsByDimension($dimension); - - $this->metricsBySearchEngine = - $this->metricsByKeyword = - $this->metricsBySearchEngineAndKeyword = - $this->metricsByKeywordAndSearchEngine = - $this->metricsByWebsite = - $this->metricsByWebsiteAndUrl = - $this->metricsByCampaignAndKeyword = - $this->metricsByCampaign = - $this->metricsByType = - $this->distinctUrls = array(); - while ($row = $query->fetch()) { - if (empty($row['referer_type'])) { - $row['referer_type'] = Piwik_Common::REFERER_TYPE_DIRECT_ENTRY; - } else { - switch ($row['referer_type']) { - case Piwik_Common::REFERER_TYPE_SEARCH_ENGINE: - if (empty($row['referer_keyword'])) { - $row['referer_keyword'] = self::LABEL_KEYWORD_NOT_DEFINED; - } - if (!isset($this->metricsBySearchEngine[$row['referer_name']])) $this->metricsBySearchEngine[$row['referer_name']] = $archiveProcessing->makeEmptyRow(); - if (!isset($this->metricsByKeyword[$row['referer_keyword']])) $this->metricsByKeyword[$row['referer_keyword']] = $archiveProcessing->makeEmptyRow(); - if (!isset($this->metricsBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']])) $this->metricsBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']] = $archiveProcessing->makeEmptyRow(); - if (!isset($this->metricsByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']])) $this->metricsByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']] = $archiveProcessing->makeEmptyRow(); - - $archiveProcessing->sumMetrics($row, $this->metricsBySearchEngine[$row['referer_name']]); - $archiveProcessing->sumMetrics($row, $this->metricsByKeyword[$row['referer_keyword']]); - $archiveProcessing->sumMetrics($row, $this->metricsBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']]); - $archiveProcessing->sumMetrics($row, $this->metricsByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']]); - break; - - case Piwik_Common::REFERER_TYPE_WEBSITE: - - if (!isset($this->metricsByWebsite[$row['referer_name']])) $this->metricsByWebsite[$row['referer_name']] = $archiveProcessing->makeEmptyRow(); - $archiveProcessing->sumMetrics($row, $this->metricsByWebsite[$row['referer_name']]); - - if (!isset($this->metricsByWebsiteAndUrl[$row['referer_name']][$row['referer_url']])) $this->metricsByWebsiteAndUrl[$row['referer_name']][$row['referer_url']] = $archiveProcessing->makeEmptyRow(); - $archiveProcessing->sumMetrics($row, $this->metricsByWebsiteAndUrl[$row['referer_name']][$row['referer_url']]); - - if (!isset($this->distinctUrls[$row['referer_url']])) { - $this->distinctUrls[$row['referer_url']] = true; - } - break; - - case Piwik_Common::REFERER_TYPE_CAMPAIGN: - if (!empty($row['referer_keyword'])) { - if (!isset($this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']])) $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']] = $archiveProcessing->makeEmptyRow(); - $archiveProcessing->sumMetrics($row, $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']]); - } - if (!isset($this->metricsByCampaign[$row['referer_name']])) $this->metricsByCampaign[$row['referer_name']] = $archiveProcessing->makeEmptyRow(); - $archiveProcessing->sumMetrics($row, $this->metricsByCampaign[$row['referer_name']]); - break; - - case Piwik_Common::REFERER_TYPE_DIRECT_ENTRY: - // direct entry are aggregated below in $this->metricsByType array - break; - - default: - throw new Exception("Non expected referer_type = " . $row['referer_type']); - break; - } - } - if (!isset($this->metricsByType[$row['referer_type']])) $this->metricsByType[$row['referer_type']] = $archiveProcessing->makeEmptyRow(); - $archiveProcessing->sumMetrics($row, $this->metricsByType[$row['referer_type']]); + $archiveProcessing = $notification->getNotificationObject(); + if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { + return; } - } - - /** - * Daily Goal archiving: processes reports of Goal conversions by Keyword, - * Goal conversions by Referer Websites, etc. - * - * @param Piwik_ArchiveProcessing $archiveProcessing - * @return void - */ - protected function archiveDayAggregateGoals($archiveProcessing) - { - $query = $archiveProcessing->queryConversionsByDimension(array("referer_type", "referer_name", "referer_keyword")); - - if ($query === false) return; - while ($row = $query->fetch()) { - if (empty($row['referer_type'])) { - $row['referer_type'] = Piwik_Common::REFERER_TYPE_DIRECT_ENTRY; - } else { - switch ($row['referer_type']) { - case Piwik_Common::REFERER_TYPE_SEARCH_ENGINE: - if (empty($row['referer_keyword'])) { - $row['referer_keyword'] = self::LABEL_KEYWORD_NOT_DEFINED; - } - if (!isset($this->metricsBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->metricsBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); - if (!isset($this->metricsByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->metricsByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); - - $archiveProcessing->sumGoalMetrics($row, $this->metricsBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - $archiveProcessing->sumGoalMetrics($row, $this->metricsByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - break; - case Piwik_Common::REFERER_TYPE_WEBSITE: - if (!isset($this->metricsByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->metricsByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); - $archiveProcessing->sumGoalMetrics($row, $this->metricsByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - break; - - case Piwik_Common::REFERER_TYPE_CAMPAIGN: - if (!empty($row['referer_keyword'])) { - if (!isset($this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); - $archiveProcessing->sumGoalMetrics($row, $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - } - if (!isset($this->metricsByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->metricsByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); - $archiveProcessing->sumGoalMetrics($row, $this->metricsByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - break; + $archiving = new Piwik_Referers_Archiving(); + $archiving->archiveDay($archiveProcessing); + } - case Piwik_Common::REFERER_TYPE_DIRECT_ENTRY: - // Direct entry, no sub dimension - break; - default: - // The referer type is user submitted for goal conversions, we ignore any malformed value - // Continue to the next while iteration - continue 2; - break; - } - } - if (!isset($this->metricsByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->metricsByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); - $archiveProcessing->sumGoalMetrics($row, $this->metricsByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - } - - $archiveProcessing->enrichConversionsByLabelArray($this->metricsByType); - $archiveProcessing->enrichConversionsByLabelArray($this->metricsBySearchEngine); - $archiveProcessing->enrichConversionsByLabelArray($this->metricsByKeyword); - $archiveProcessing->enrichConversionsByLabelArray($this->metricsByWebsite); - $archiveProcessing->enrichConversionsByLabelArray($this->metricsByCampaign); - $archiveProcessing->enrichConversionsByLabelArrayHasTwoLevels($this->metricsByCampaignAndKeyword); - } /** - * Records the daily stats (numeric or datatable blob) into the archive tables. + * Period archiving: sums up daily stats and sums report tables, + * making sure that tables are still truncated. * - * @param Piwik_ArchiveProcessing $archiveProcessing + * @param Piwik_Event_Notification $notification notification object * @return void */ - protected function archiveDayRecordInDatabase($archiveProcessing) + function archivePeriod($notification) { - $numericRecords = array( - 'Referers_distinctSearchEngines' => count($this->metricsBySearchEngineAndKeyword), - 'Referers_distinctKeywords' => count($this->metricsByKeywordAndSearchEngine), - 'Referers_distinctCampaigns' => count($this->metricsByCampaign), - 'Referers_distinctWebsites' => count($this->metricsByWebsite), - 'Referers_distinctWebsitesUrls' => count($this->distinctUrls), - ); + $archiveProcessing = $notification->getNotificationObject(); - foreach ($numericRecords as $name => $value) { - $archiveProcessing->insertNumericRecord($name, $value); + if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { + return; } - $dataTable = $archiveProcessing->getDataTableSerialized($this->metricsByType); - $archiveProcessing->insertBlobRecord('Referers_type', $dataTable); - destroy($dataTable); - - $blobRecords = array( - 'Referers_keywordBySearchEngine' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsBySearchEngineAndKeyword, $this->metricsBySearchEngine), - 'Referers_searchEngineByKeyword' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByKeywordAndSearchEngine, $this->metricsByKeyword), - 'Referers_keywordByCampaign' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByCampaignAndKeyword, $this->metricsByCampaign), - 'Referers_urlByWebsite' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByWebsiteAndUrl, $this->metricsByWebsite), - ); - foreach ($blobRecords as $recordName => $table) { - $blob = $table->getSerialized($this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $this->columnToSortByBeforeTruncation); - $archiveProcessing->insertBlobRecord($recordName, $blob); - destroy($table); - } + $archiving = new Piwik_Referers_Archiving(); + $archiving->archivePeriod($archiveProcessing); } } diff --git a/plugins/Referers/functions.php b/plugins/Referers/functions.php index c7d69386c7..46d9e18000 100644 --- a/plugins/Referers/functions.php +++ b/plugins/Referers/functions.php @@ -178,7 +178,7 @@ function Piwik_getSearchEngineHostPathFromUrl($url) */ function Piwik_getSearchEngineUrlFromUrlAndKeyword($url, $keyword) { - if ($keyword === Piwik_Referers::LABEL_KEYWORD_NOT_DEFINED) { + if ($keyword === Piwik_Referers_API::LABEL_KEYWORD_NOT_DEFINED) { return 'http://piwik.org/faq/general/#faq_144'; } $searchEngineUrls = Piwik_Common::getSearchEngineUrls(); diff --git a/plugins/Transitions/Transitions.php b/plugins/Transitions/Transitions.php index 4adaf3f997..765854bff7 100644 --- a/plugins/Transitions/Transitions.php +++ b/plugins/Transitions/Transitions.php @@ -118,7 +118,7 @@ class Piwik_Transitions extends Piwik_Plugin foreach ($subData as &$row) { if ($referrerType == Piwik_Common::REFERER_TYPE_SEARCH_ENGINE && empty($row['referrer_data'])) { - $row['referrer_data'] = Piwik_Referers::LABEL_KEYWORD_NOT_DEFINED; + $row['referrer_data'] = Piwik_Referers_API::LABEL_KEYWORD_NOT_DEFINED; } $referrerData[$referrerType][Piwik_Archive::INDEX_NB_VISITS] += $row[Piwik_Archive::INDEX_NB_VISITS]; diff --git a/plugins/UserCountry/API.php b/plugins/UserCountry/API.php index d8cdb266b6..36dfffe418 100644 --- a/plugins/UserCountry/API.php +++ b/plugins/UserCountry/API.php @@ -32,7 +32,7 @@ class Piwik_UserCountry_API public function getCountry($idSite, $period, $date, $segment = false) { - $recordName = Piwik_UserCountry::VISITS_BY_COUNTRY_RECORD_NAME; + $recordName = Piwik_UserCountry_Archiving::VISITS_BY_COUNTRY_RECORD_NAME; $dataTable = $this->getDataTable($recordName, $idSite, $period, $date, $segment); // apply filter on the whole datatable in order the inline search to work (searches @@ -48,7 +48,7 @@ class Piwik_UserCountry_API public function getContinent($idSite, $period, $date, $segment = false) { - $recordName = Piwik_UserCountry::VISITS_BY_COUNTRY_RECORD_NAME; + $recordName = Piwik_UserCountry_Archiving::VISITS_BY_COUNTRY_RECORD_NAME; $dataTable = $this->getDataTable($recordName, $idSite, $period, $date, $segment); $getContinent = array('Piwik_Common', 'getContinent'); @@ -71,10 +71,10 @@ class Piwik_UserCountry_API */ public function getRegion($idSite, $period, $date, $segment = false) { - $recordName = Piwik_UserCountry::VISITS_BY_REGION_RECORD_NAME; + $recordName = Piwik_UserCountry_Archiving::VISITS_BY_REGION_RECORD_NAME; $dataTable = $this->getDataTable($recordName, $idSite, $period, $date, $segment); - $separator = Piwik_UserCountry::LOCATION_SEPARATOR; + $separator = Piwik_UserCountry_Archiving::LOCATION_SEPARATOR; $unk = Piwik_Tracker_Visit::UNKNOWN_CODE; // split the label and put the elements into the 'region' and 'country' metadata fields @@ -114,10 +114,10 @@ class Piwik_UserCountry_API */ public function getCity($idSite, $period, $date, $segment = false) { - $recordName = Piwik_UserCountry::VISITS_BY_CITY_RECORD_NAME; + $recordName = Piwik_UserCountry_Archiving::VISITS_BY_CITY_RECORD_NAME; $dataTable = $this->getDataTable($recordName, $idSite, $period, $date, $segment); - $separator = Piwik_UserCountry::LOCATION_SEPARATOR; + $separator = Piwik_UserCountry_Archiving::LOCATION_SEPARATOR; $unk = Piwik_Tracker_Visit::UNKNOWN_CODE; // split the label and put the elements into the 'city_name', 'region', 'country', diff --git a/plugins/UserCountry/Archiving.php b/plugins/UserCountry/Archiving.php new file mode 100644 index 0000000000..4c049ff6b9 --- /dev/null +++ b/plugins/UserCountry/Archiving.php @@ -0,0 +1,210 @@ +metricsByDimension = array('location_country' => array(), + 'location_region' => array(), + 'location_city' => array()); + $this->aggregateFromVisits($archiveProcessing); + $this->aggregateFromConversions($archiveProcessing); + $this->archiveDayRecordInDatabase($archiveProcessing); + } + + /** + * @param Piwik_ArchiveProcessing_Day $archiveProcessing + */ + protected function aggregateFromVisits($archiveProcessing) + { + $dimensions = array_keys($this->metricsByDimension); + $query = $archiveProcessing->queryVisitsByDimension( + $dimensions, + $where = '', + $metrics = false, + $orderBy = false, + $rankingQuery = null, + $addSelect = 'MAX(log_visit.location_latitude) as location_latitude, + MAX(log_visit.location_longitude) as location_longitude' + ); + + if ($query === false) { + return; + } + + while ($row = $query->fetch()) { + $this->makeRegionCityLabelsUnique($row); + $this->rememberCityLatLong($row); + $this->aggregateConversion($archiveProcessing, $row); + } + } + + /** + * Makes sure the region and city of a query row are unique. + * + * @param array $row + */ + private function makeRegionCityLabelsUnique(&$row) + { + static $locationColumns = array('location_region', 'location_country', 'location_city'); + + // to be on the safe side, remove the location separator from the region/city/country we + // get from the query + foreach ($locationColumns as $column) { + $row[$column] = str_replace(self::LOCATION_SEPARATOR, '', $row[$column]); + } + + if (!empty($row['location_region'])) // do not differentiate between unknown regions + { + $row['location_region'] = $row['location_region'] . self::LOCATION_SEPARATOR . $row['location_country']; + } + + if (!empty($row['location_city'])) // do not differentiate between unknown cities + { + $row['location_city'] = $row['location_city'] . self::LOCATION_SEPARATOR . $row['location_region']; + } + } + + protected function rememberCityLatLong($row) + { + $lat = $long = false; + if (!empty($row['location_city'])) { + if (!empty($row['location_latitude'])) { + $lat = $row['location_latitude']; + } + if (!empty($row['location_longitude'])) { + $long = $row['location_longitude']; + } + } + + // store latitude/longitude, if we should + if ($lat !== false && $long !== false + && empty($this->latLongForCities[$row['location_city']]) + ) { + $this->latLongForCities[$row['location_city']] = array($lat, $long); + } + } + + protected function aggregateConversion($archiveProcessing, $row) + { + foreach ($this->metricsByDimension as $dimension => &$table) { + $label = (string)$row[$dimension]; + + if (!isset($table[$label])) { + $table[$label] = $archiveProcessing->makeEmptyRow(); + } + $archiveProcessing->sumMetrics($row, $table[$label]); + } + return $table; + } + + /** + * @param Piwik_ArchiveProcessing_Day $archiveProcessing + */ + protected function aggregateFromConversions($archiveProcessing) + { + $dimensions = array_keys($this->metricsByDimension); + $query = $archiveProcessing->queryConversionsByDimension($dimensions); + + if ($query === false) { + return; + } + + while ($row = $query->fetch()) { + $this->makeRegionCityLabelsUnique($row); + + $idGoal = $row['idgoal']; + foreach ($this->metricsByDimension as $dimension => &$table) { + $label = (string)$row[$dimension]; + + if (!isset($table[$label][Piwik_Archive::INDEX_GOALS][$idGoal])) { + $table[$label][Piwik_Archive::INDEX_GOALS][$idGoal] = $archiveProcessing->makeEmptyGoalRow($idGoal); + } + + $archiveProcessing->sumGoalMetrics($row, $table[$label][Piwik_Archive::INDEX_GOALS][$idGoal]); + } + } + + foreach ($this->metricsByDimension as &$table) { + $archiveProcessing->enrichConversionsByLabelArray($table); + } + } + + /** + * @param Piwik_ArchiveProcessing_Day $archiveProcessing + */ + protected function archiveDayRecordInDatabase($archiveProcessing) + { + $maximumRows = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; + + $tableCountry = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->metricsByDimension['location_country']); + $archiveProcessing->insertBlobRecord(self::VISITS_BY_COUNTRY_RECORD_NAME, $tableCountry->getSerialized()); + $archiveProcessing->insertNumericRecord(self::DISTINCT_COUNTRIES_METRIC, $tableCountry->getRowsCount()); + destroy($tableCountry); + + $tableRegion = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->metricsByDimension['location_region']); + $serialized = $tableRegion->getSerialized($maximumRows, $maximumRows, Piwik_Archive::INDEX_NB_VISITS); + $archiveProcessing->insertBlobRecord(self::VISITS_BY_REGION_RECORD_NAME, $serialized); + destroy($tableRegion); + + $tableCity = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->metricsByDimension['location_city']); + $this->setLatitudeLongitude($tableCity); + $serialized = $tableCity->getSerialized($maximumRows, $maximumRows, Piwik_Archive::INDEX_NB_VISITS); + $archiveProcessing->insertBlobRecord(self::VISITS_BY_CITY_RECORD_NAME, $serialized); + destroy($tableCity); + } + + /** + * Utility method, appends latitude/longitude pairs to city table labels, if that data + * exists for the city. + */ + private function setLatitudeLongitude($tableCity) + { + foreach ($tableCity->getRows() as $row) { + $label = $row->getColumn('label'); + if (isset($this->latLongForCities[$label])) { + // get lat/long for city + list($lat, $long) = $this->latLongForCities[$label]; + $lat = round($lat, Piwik_UserCountry_LocationProvider::GEOGRAPHIC_COORD_PRECISION); + $long = round($long, Piwik_UserCountry_LocationProvider::GEOGRAPHIC_COORD_PRECISION); + + // set latitude + longitude metadata + $row->setMetadata('lat', $lat); + $row->setMetadata('long', $long); + } + } + } + + public function archivePeriod($archiveProcessing) + { + $dataTableToSum = array( + self::VISITS_BY_COUNTRY_RECORD_NAME, + self::VISITS_BY_REGION_RECORD_NAME, + self::VISITS_BY_CITY_RECORD_NAME, + ); + + $nameToCount = $archiveProcessing->archiveDataTable($dataTableToSum); + $archiveProcessing->insertNumericRecord(self::DISTINCT_COUNTRIES_METRIC, + $nameToCount[self::VISITS_BY_COUNTRY_RECORD_NAME]['level0']); + } + +} \ No newline at end of file diff --git a/plugins/UserCountry/UserCountry.php b/plugins/UserCountry/UserCountry.php index 03df8bc3f7..fb928ba67b 100644 --- a/plugins/UserCountry/UserCountry.php +++ b/plugins/UserCountry/UserCountry.php @@ -20,14 +20,6 @@ require_once PIWIK_INCLUDE_PATH . '/plugins/UserCountry/GeoIPAutoUpdater.php'; */ class Piwik_UserCountry extends Piwik_Plugin { - const VISITS_BY_COUNTRY_RECORD_NAME = 'UserCountry_country'; - const VISITS_BY_REGION_RECORD_NAME = 'UserCountry_region'; - const VISITS_BY_CITY_RECORD_NAME = 'UserCountry_city'; - - const DISTINCT_COUNTRIES_METRIC = 'UserCountry_distinctCountries'; - - // separate region, city & country info in stored report labels - const LOCATION_SEPARATOR = '|'; public function getInformation() { @@ -299,187 +291,30 @@ class Piwik_UserCountry extends Piwik_Plugin */ function archivePeriod($notification) { - /** - * @param Piwik_ArchiveProcessing_Period $archiveProcessing - */ $archiveProcessing = $notification->getNotificationObject(); + if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { + return; + } - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - - $dataTableToSum = array( - self::VISITS_BY_COUNTRY_RECORD_NAME, - self::VISITS_BY_REGION_RECORD_NAME, - self::VISITS_BY_CITY_RECORD_NAME, - ); - - $nameToCount = $archiveProcessing->archiveDataTable($dataTableToSum); - $archiveProcessing->insertNumericRecord(self::DISTINCT_COUNTRIES_METRIC, - $nameToCount[self::VISITS_BY_COUNTRY_RECORD_NAME]['level0']); + $archiving = new Piwik_UserCountry_Archiving(); + $archiving->archivePeriod($archiveProcessing); } - private $interestTables = null; - private $latLongForCities = null; - /** * @param Piwik_Event_Notification $notification notification object * @return mixed */ function archiveDay($notification) { - /** - * @var Piwik_ArchiveProcessing - */ $archiveProcessing = $notification->getNotificationObject(); - - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - - $this->interestTables = array('location_country' => array(), - 'location_region' => array(), - 'location_city' => array()); - $this->latLongForCities = array(); - - $this->archiveDayAggregateVisits($archiveProcessing); - $this->archiveDayAggregateGoals($archiveProcessing); - $this->archiveDayRecordInDatabase($archiveProcessing); - - unset($this->interestTables); - unset($this->latLongForCities); - } - - /** - * @param Piwik_ArchiveProcessing_Day $archiveProcessing - */ - protected function archiveDayAggregateVisits($archiveProcessing) - { - $dimensions = array_keys($this->interestTables); - $query = $archiveProcessing->queryVisitsByDimension( - $dimensions, - $where = '', - $metrics = false, - $orderBy = false, - $rankingQuery = null, - $addSelect = 'MAX(log_visit.location_latitude) as location_latitude, - MAX(log_visit.location_longitude) as location_longitude' - ); - - if ($query === false) { + if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { return; } - while ($row = $query->fetch()) { - // get latitude/longitude if there's a city - $lat = $long = false; - if (!empty($row['location_city'])) { - if (!empty($row['location_latitude'])) { - $lat = $row['location_latitude']; - } - if (!empty($row['location_longitude'])) { - $long = $row['location_longitude']; - } - } - - // make sure regions & cities w/ the same name don't get merged - $this->setLongCityRegionId($row); - - // store latitude/longitude, if we should - if ($lat !== false && $long !== false) { - $this->latLongForCities[$row['location_city']] = array($lat, $long); - } - - // add the stats to each dimension's table - foreach ($this->interestTables as $dimension => &$table) { - $label = (string)$row[$dimension]; - - if (!isset($table[$label])) { - $table[$label] = $archiveProcessing->makeEmptyRow(); - } - $archiveProcessing->sumMetrics($row, $table[$label]); - } - } + $archiving = new Piwik_UserCountry_Archiving(); + $archiving->archiveDay($archiveProcessing); } - /** - * @param Piwik_ArchiveProcessing_Day $archiveProcessing - */ - protected function archiveDayAggregateGoals($archiveProcessing) - { - $dimensions = array_keys($this->interestTables); - $query = $archiveProcessing->queryConversionsByDimension($dimensions); - - if ($query === false) { - return; - } - - while ($row = $query->fetch()) { - // make sure regions & cities w/ the same name don't get merged - $this->setLongCityRegionId($row); - - $idGoal = $row['idgoal']; - foreach ($this->interestTables as $dimension => &$table) { - $label = (string)$row[$dimension]; - - if (!isset($table[$label][Piwik_Archive::INDEX_GOALS][$idGoal])) { - $table[$label][Piwik_Archive::INDEX_GOALS][$idGoal] = $archiveProcessing->makeEmptyGoalRow($idGoal); - } - - $archiveProcessing->sumGoalMetrics($row, $table[$label][Piwik_Archive::INDEX_GOALS][$idGoal]); - } - } - - foreach ($this->interestTables as &$table) { - $archiveProcessing->enrichConversionsByLabelArray($table); - } - } - - /** - * @param Piwik_ArchiveProcessing_Day $archiveProcessing - */ - protected function archiveDayRecordInDatabase($archiveProcessing) - { - $maximumRows = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; - - $tableCountry = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->interestTables['location_country']); - $archiveProcessing->insertBlobRecord(self::VISITS_BY_COUNTRY_RECORD_NAME, $tableCountry->getSerialized()); - $archiveProcessing->insertNumericRecord(self::DISTINCT_COUNTRIES_METRIC, $tableCountry->getRowsCount()); - destroy($tableCountry); - - $tableRegion = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->interestTables['location_region']); - $serialized = $tableRegion->getSerialized($maximumRows, $maximumRows, Piwik_Archive::INDEX_NB_VISITS); - $archiveProcessing->insertBlobRecord(self::VISITS_BY_REGION_RECORD_NAME, $serialized); - destroy($tableRegion); - - $tableCity = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->interestTables['location_city']); - $this->setLatitudeLongitude($tableCity); - $serialized = $tableCity->getSerialized($maximumRows, $maximumRows, Piwik_Archive::INDEX_NB_VISITS); - $archiveProcessing->insertBlobRecord(self::VISITS_BY_CITY_RECORD_NAME, $serialized); - destroy($tableCity); - } - - /** - * Makes sure the region and city of a query row are unique. - * - * @param array $row - */ - private function setLongCityRegionId(&$row) - { - static $locationColumns = array('location_region', 'location_country', 'location_city'); - - // to be on the safe side, remove the location separator from the region/city/country we - // get from the query - foreach ($locationColumns as $column) { - $row[$column] = str_replace(self::LOCATION_SEPARATOR, '', $row[$column]); - } - - if (!empty($row['location_region'])) // do not differentiate between unknown regions - { - $row['location_region'] = $row['location_region'] . self::LOCATION_SEPARATOR . $row['location_country']; - } - - if (!empty($row['location_city'])) // do not differentiate between unknown cities - { - $row['location_city'] = $row['location_city'] . self::LOCATION_SEPARATOR . $row['location_region']; - } - } /** * Returns a list of country codes for a given continent code. @@ -500,24 +335,4 @@ class Piwik_UserCountry extends Piwik_Plugin 'bind' => '-'); // HACK: SegmentExpression requires a $bind, even if there's nothing to bind } - /** - * Utility method, appends latitude/longitude pairs to city table labels, if that data - * exists for the city. - */ - private function setLatitudeLongitude($tableCity) - { - foreach ($tableCity->getRows() as $row) { - $label = $row->getColumn('label'); - if (isset($this->latLongForCities[$label])) { - // get lat/long for city - list($lat, $long) = $this->latLongForCities[$label]; - $lat = round($lat, Piwik_UserCountry_LocationProvider::GEOGRAPHIC_COORD_PRECISION); - $long = round($long, Piwik_UserCountry_LocationProvider::GEOGRAPHIC_COORD_PRECISION); - - // set latitude + longitude metadata - $row->setMetadata('lat', $lat); - $row->setMetadata('long', $long); - } - } - } } diff --git a/plugins/UserCountry/functions.php b/plugins/UserCountry/functions.php index ab1ff7e26a..072c54030b 100644 --- a/plugins/UserCountry/functions.php +++ b/plugins/UserCountry/functions.php @@ -92,7 +92,7 @@ function Piwik_UserCountry_getRegionName($label) return Piwik_Translate('General_Unknown'); } - list($regionCode, $countryCode) = explode(Piwik_UserCountry::LOCATION_SEPARATOR, $label); + list($regionCode, $countryCode) = explode(Piwik_UserCountry_Archiving::LOCATION_SEPARATOR, $label); return Piwik_UserCountry_LocationProvider_GeoIp::getRegionNameFromCodes($countryCode, $regionCode); } @@ -114,7 +114,7 @@ function Piwik_UserCountry_getPrettyRegionName($label) return Piwik_Translate('General_Unknown'); } - list($regionCode, $countryCode) = explode(Piwik_UserCountry::LOCATION_SEPARATOR, $label); + list($regionCode, $countryCode) = explode(Piwik_UserCountry_Archiving::LOCATION_SEPARATOR, $label); $result = Piwik_UserCountry_LocationProvider_GeoIp::getRegionNameFromCodes($countryCode, $regionCode); if ($countryCode != Piwik_Tracker_Visit::UNKNOWN_CODE && $countryCode != '') { @@ -143,7 +143,7 @@ function Piwik_UserCountry_getPrettyCityName($label) } // get city name, region code & country code - $parts = explode(Piwik_UserCountry::LOCATION_SEPARATOR, $label); + $parts = explode(Piwik_UserCountry_Archiving::LOCATION_SEPARATOR, $label); $cityName = $parts[0]; $regionCode = $parts[1]; $countryCode = $parts[2]; -- cgit v1.2.3 From 39f164061ec6345b3f3f50bd3155b077099353ba Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 6 Jun 2013 14:02:33 +1200 Subject: Full refactor of UserSettings plugin, now it's starting to look good --- plugins/Actions/Archiving.php | 5 +- plugins/CustomVariables/Archiving.php | 89 ++++++++++------- plugins/DevicesDetection/Archiving.php | 29 ++---- plugins/Goals/Archiving.php | 84 ++++++++-------- plugins/Provider/Archiving.php | 22 ++--- plugins/Referers/Archiving.php | 17 +--- plugins/UserCountry/Archiving.php | 14 +-- plugins/UserSettings/Archiving.php | 147 ++++++++++++++++++++++++++++ plugins/UserSettings/UserSettings.php | 172 +-------------------------------- plugins/VisitTime/VisitTime.php | 4 +- 10 files changed, 279 insertions(+), 304 deletions(-) create mode 100644 plugins/UserSettings/Archiving.php (limited to 'plugins') diff --git a/plugins/Actions/Archiving.php b/plugins/Actions/Archiving.php index 41399bea72..be9e3b84c0 100644 --- a/plugins/Actions/Archiving.php +++ b/plugins/Actions/Archiving.php @@ -141,8 +141,7 @@ class Piwik_Actions_Archiving $this->archiveDayExitActions($archiveProcessing, $rankingQueryLimit); $this->archiveDayActionsTime($archiveProcessing, $rankingQueryLimit); - // Record the final datasets - $this->archiveDayRecordInDatabase($archiveProcessing); + $this->recordDayReports($archiveProcessing); return true; } @@ -392,7 +391,7 @@ class Piwik_Actions_Archiving * * @param $archiveProcessing */ - protected function archiveDayRecordInDatabase($archiveProcessing) + protected function recordDayReports($archiveProcessing) { Piwik_Actions_ArchivingHelper::clearActionsCache(); diff --git a/plugins/CustomVariables/Archiving.php b/plugins/CustomVariables/Archiving.php index c85d230b3b..e209dd6d2c 100644 --- a/plugins/CustomVariables/Archiving.php +++ b/plugins/CustomVariables/Archiving.php @@ -72,15 +72,7 @@ class Piwik_CustomVariables_Archiving $value = $this->cleanCustomVarValue($value); $key = $row[$keyField]; - if (!isset($this->metricsByKey[$key])) { - $this->metricsByKey[$key] = $archiveProcessing->makeEmptyRow(); - } - if (!isset($this->metricsByKeyAndValue[$key][$value])) { - $this->metricsByKeyAndValue[$key][$value] = $archiveProcessing->makeEmptyRow(); - } - - $archiveProcessing->sumMetrics($row, $this->metricsByKey[$key]); - $archiveProcessing->sumMetrics($row, $this->metricsByKeyAndValue[$key][$value]); + $this->aggregateVisit($archiveProcessing, $key, $value, $row); } } @@ -92,23 +84,35 @@ class Piwik_CustomVariables_Archiving return self::LABEL_CUSTOM_VALUE_NOT_DEFINED; } + protected function aggregateVisit(Piwik_ArchiveProcessing_Day $archiveProcessing, $key, $value, $row) + { + if (!isset($this->metricsByKey[$key])) { + $this->metricsByKey[$key] = $archiveProcessing->makeEmptyRow(); + } + if (!isset($this->metricsByKeyAndValue[$key][$value])) { + $this->metricsByKeyAndValue[$key][$value] = $archiveProcessing->makeEmptyRow(); + } + + $archiveProcessing->sumMetrics($row, $this->metricsByKey[$key]); + $archiveProcessing->sumMetrics($row, $this->metricsByKeyAndValue[$key][$value]); + } + protected function aggregateFromActions(Piwik_ArchiveProcessing_Day $archiveProcessing, $query, $keyField, $valueField) { - $keys = array(); while ($row = $query->fetch()) { $key = $row[$keyField]; $value = $row[$valueField]; $value = $this->cleanCustomVarValue($value); + $this->aggregateAction($archiveProcessing, $key, $value, $row); + } + } - $alreadyAggregated = $this->aggregateEcommerceCategories($archiveProcessing, $key, $value, $row); - if (!$alreadyAggregated) { - $this->aggregateAction($archiveProcessing, $key, $value, $row); - - if (!isset($this->metricsByKey[$key])) { - $this->metricsByKey[$key] = $archiveProcessing->makeEmptyActionRow(); - } - $archiveProcessing->sumMetrics($row, $this->metricsByKey[$key], $onlyMetricsAvailableInActionsTable = true); - } + protected function aggregateAction(Piwik_ArchiveProcessing_Day $archiveProcessing, $key, $value, $row) + { + $alreadyAggregated = $this->aggregateEcommerceCategories($archiveProcessing, $key, $value, $row); + if (!$alreadyAggregated) { + $this->aggregateActionByKeyAndValue($archiveProcessing, $key, $value, $row); + $this->aggregateActionByKey($archiveProcessing, $key, $row); } } @@ -134,7 +138,7 @@ class Piwik_CustomVariables_Archiving ) { continue; } - $this->aggregateAction($archiveProcessing, $key, $category, $row); + $this->aggregateActionByKeyAndValue($archiveProcessing, $key, $category, $row); $ecommerceCategoriesAggregated = true; $count++; } @@ -143,13 +147,7 @@ class Piwik_CustomVariables_Archiving return $ecommerceCategoriesAggregated; } - /** - * @param Piwik_ArchiveProcessing_Day $archiveProcessing - * @param $key - * @param $value - * @param $row - */ - protected function aggregateAction(Piwik_ArchiveProcessing_Day $archiveProcessing, $key, $value, $row) + protected function aggregateActionByKeyAndValue(Piwik_ArchiveProcessing_Day $archiveProcessing, $key, $value, $row) { if (!isset($this->metricsByKeyAndValue[$key][$value])) { $this->metricsByKeyAndValue[$key][$value] = $archiveProcessing->makeEmptyActionRow(); @@ -158,7 +156,7 @@ class Piwik_CustomVariables_Archiving if ($this->isReservedKey($key)) { // Price tracking on Ecommerce product/category pages: - // The the AVG is returned from the SQL query so the price is not summed + // the average is returned from the SQL query so the price is not "summed" like other metrics $index = Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED; if (!empty($row[$index])) { $this->metricsByKeyAndValue[$key][$value][$index] = (float)$row[$index]; @@ -171,6 +169,19 @@ class Piwik_CustomVariables_Archiving return in_array($key, Piwik_CustomVariables_API::getReservedCustomVariableKeys()); } + /** + * @param Piwik_ArchiveProcessing_Day $archiveProcessing + * @param $key + * @param $row + */ + protected function aggregateActionByKey(Piwik_ArchiveProcessing_Day $archiveProcessing, $key, $row) + { + if (!isset($this->metricsByKey[$key])) { + $this->metricsByKey[$key] = $archiveProcessing->makeEmptyActionRow(); + } + $archiveProcessing->sumMetrics($row, $this->metricsByKey[$key], $onlyMetricsAvailableInActionsTable = true); + } + protected function aggregateFromConversions(Piwik_ArchiveProcessing_Day $archiveProcessing, $query, $keyField, $valueField) { if ($query === false) { @@ -180,17 +191,21 @@ class Piwik_CustomVariables_Archiving $key = $row[$keyField]; $value = $this->cleanCustomVarValue($row[$valueField]); $idGoal = $row['idgoal']; + $this->aggregateConversion($archiveProcessing, $key, $value, $idGoal, $row); + } + } - if (!isset($this->metricsByKey[$key][Piwik_Archive::INDEX_GOALS][$idGoal])) { - $this->metricsByKey[$key][Piwik_Archive::INDEX_GOALS][$idGoal] = $archiveProcessing->makeEmptyGoalRow($idGoal); - } - if (!isset($this->metricsByKeyAndValue[$key][$value][Piwik_Archive::INDEX_GOALS][$idGoal])) { - $this->metricsByKeyAndValue[$key][$value][Piwik_Archive::INDEX_GOALS][$idGoal] = $archiveProcessing->makeEmptyGoalRow($idGoal); - } - - $archiveProcessing->sumGoalMetrics($row, $this->metricsByKey[$key][Piwik_Archive::INDEX_GOALS][$idGoal]); - $archiveProcessing->sumGoalMetrics($row, $this->metricsByKeyAndValue[$key][$value][Piwik_Archive::INDEX_GOALS][$idGoal]); + protected function aggregateConversion(Piwik_ArchiveProcessing_Day $archiveProcessing, $key, $value, $idGoal, $row) + { + if (!isset($this->metricsByKey[$key][Piwik_Archive::INDEX_GOALS][$idGoal])) { + $this->metricsByKey[$key][Piwik_Archive::INDEX_GOALS][$idGoal] = $archiveProcessing->makeEmptyGoalRow($idGoal); } + if (!isset($this->metricsByKeyAndValue[$key][$value][Piwik_Archive::INDEX_GOALS][$idGoal])) { + $this->metricsByKeyAndValue[$key][$value][Piwik_Archive::INDEX_GOALS][$idGoal] = $archiveProcessing->makeEmptyGoalRow($idGoal); + } + + $archiveProcessing->sumGoalMetrics($row, $this->metricsByKey[$key][Piwik_Archive::INDEX_GOALS][$idGoal]); + $archiveProcessing->sumGoalMetrics($row, $this->metricsByKeyAndValue[$key][$value][Piwik_Archive::INDEX_GOALS][$idGoal]); } protected function removeVisitsMetricsFromActionsAggregate(Piwik_ArchiveProcessing_Day $archiveProcessing) diff --git a/plugins/DevicesDetection/Archiving.php b/plugins/DevicesDetection/Archiving.php index 2fc88576a7..f5a7b34b4d 100644 --- a/plugins/DevicesDetection/Archiving.php +++ b/plugins/DevicesDetection/Archiving.php @@ -11,12 +11,9 @@ class Piwik_DevicesDetection_Archiving { - /** - * @param $archiveProcessing - */ public function archiveDay($archiveProcessing) { - $this->maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; + $this->__construct(); $this->columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; $this->archiveDayDeviceTypes($archiveProcessing); @@ -28,6 +25,11 @@ class Piwik_DevicesDetection_Archiving $this->archiveDayBrowsersVersions($archiveProcessing); } + public function __construct() + { + return $this->maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; + } + private function archiveDayDeviceTypes($archiveProcessing) { $recordName = 'DevicesDetection_types'; @@ -35,18 +37,12 @@ class Piwik_DevicesDetection_Archiving $this->aggregateByLabel($archiveProcessing, $labelSQL, $recordName); } - /** - * @param $archiveProcessing - * @param $labelSQL - * @param $recordName - */ private function aggregateByLabel($archiveProcessing, $labelSQL, $recordName) { $metricsByLabel = $archiveProcessing->getArrayInterestForLabel($labelSQL); $tableBrand = $archiveProcessing->getDataTableFromArray($metricsByLabel); $archiveProcessing->insertBlobRecord($recordName, $tableBrand->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); - destroy($tableBrand); } private function archiveDayDeviceBrands($archiveProcessing) @@ -68,7 +64,6 @@ class Piwik_DevicesDetection_Archiving $recordName = 'DevicesDetection_os'; $labelSQL = "log_visit.config_os"; $this->aggregateByLabel($archiveProcessing, $labelSQL, $recordName); - } private function archiveDayOsVersions($archiveProcessing) @@ -76,7 +71,6 @@ class Piwik_DevicesDetection_Archiving $recordName = 'DevicesDetection_osVersions'; $labelSQL = "CONCAT(log_visit.config_os, ';', log_visit.config_os_version)"; $this->aggregateByLabel($archiveProcessing, $labelSQL, $recordName); - } private function archiveDayBrowserFamilies($archiveProcessing) @@ -84,24 +78,18 @@ class Piwik_DevicesDetection_Archiving $recordName = 'DevicesDetection_browsers'; $labelSQL = "log_visit.config_browser_name"; $this->aggregateByLabel($archiveProcessing, $labelSQL, $recordName); - } private function archiveDayBrowsersVersions($archiveProcessing) { $recordName = 'DevicesDetection_browserVersions'; $labelSQL = "CONCAT(log_visit.config_browser_name, ';', log_visit.config_browser_version)"; - $this->aggregateByLabel($archiveProcessing, $labelSQL, $recordName); } - /** - * @param $archiveProcessing - */ public function archivePeriod($archiveProcessing) { - $this->maximumRowsInDataTableLevelZero = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; - $this->maximumRowsInSubDataTable = $this->maximumRowsInDataTableLevelZero; + $maximumRowsInSubDataTable = $this->maximumRowsInDataTable; $dataTablesToSum = array( 'DevicesDetection_types', 'DevicesDetection_brands', @@ -113,8 +101,7 @@ class Piwik_DevicesDetection_Archiving ); foreach ($dataTablesToSum as $dt) { $archiveProcessing->archiveDataTable( - $dt, null, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $columnToSort = "nb_visits"); + $dt, null, $this->maximumRowsInDataTable, $maximumRowsInSubDataTable, $columnToSort = "nb_visits"); } } - } \ No newline at end of file diff --git a/plugins/Goals/Archiving.php b/plugins/Goals/Archiving.php index c99ba4d48d..59967ed40f 100644 --- a/plugins/Goals/Archiving.php +++ b/plugins/Goals/Archiving.php @@ -1,8 +1,16 @@ getNumberOfVisits(); - return round(100 * $count / $visits, Piwik_Tracker_GoalManager::REVENUE_PRECISION); - } - /** * @param Piwik_ArchiveProcessing_Day $archiveProcessing */ @@ -271,23 +259,6 @@ class Piwik_Goals_Archiving } } - protected function shouldArchiveEcommerceItems($archiveProcessing) - { - // Per item doesn't support segment - // Also, when querying Goal metrics for visitorType==returning, we wouldnt want to trigger an extra request - // event if it did support segment - // (if this is implented, we should have shouldProcessReportsForPlugin() support partial archiving based on which metric is requested) - if (!$archiveProcessing->getSegment()->isEmpty()) { - return false; - } - return true; - } - - static public function getItemRecordNameAbandonedCart($recordName) - { - return $recordName . '_Cart'; - } - /** * @param $archiveProcessing */ @@ -343,4 +314,41 @@ class Piwik_Goals_Archiving self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME))); } + protected function shouldArchiveEcommerceItems($archiveProcessing) + { + // Per item doesn't support segment + // Also, when querying Goal metrics for visitorType==returning, we wouldnt want to trigger an extra request + // event if it did support segment + // (if this is implented, we should have shouldProcessReportsForPlugin() support partial archiving based on which metric is requested) + if (!$archiveProcessing->getSegment()->isEmpty()) { + return false; + } + return true; + } + + static public function getItemRecordNameAbandonedCart($recordName) + { + return $recordName . '_Cart'; + } + + /** + * @param string $recordName 'nb_conversions' + * @param int|bool $idGoal idGoal to return the metrics for, or false to return overall + * @return string Archive record name + */ + static public function getRecordName($recordName, $idGoal = false) + { + $idGoalStr = ''; + if ($idGoal !== false) { + $idGoalStr = $idGoal . "_"; + } + return 'Goal_' . $idGoalStr . $recordName; + } + + private function getConversionRate($count, $archiveProcessing) + { + $visits = $archiveProcessing->getNumberOfVisits(); + return round(100 * $count / $visits, Piwik_Tracker_GoalManager::REVENUE_PRECISION); + } + } \ No newline at end of file diff --git a/plugins/Provider/Archiving.php b/plugins/Provider/Archiving.php index c0228e788f..bcc45b6a49 100644 --- a/plugins/Provider/Archiving.php +++ b/plugins/Provider/Archiving.php @@ -1,11 +1,15 @@ insertBlobRecord($recordName, $tableProvider->getSerialized($maximumRowsInDataTable, null, $columnToSortByBeforeTruncation)); } - /** - * @param $archiveProcessing - */ public function archivePeriod($archiveProcessing) { $maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; $dataTableToSum = array('Provider_hostnameExt'); $archiveProcessing->archiveDataTable($dataTableToSum, null, $maximumRowsInDataTable); } - } \ No newline at end of file diff --git a/plugins/Referers/Archiving.php b/plugins/Referers/Archiving.php index 0fca433ba3..138c3564e3 100644 --- a/plugins/Referers/Archiving.php +++ b/plugins/Referers/Archiving.php @@ -22,9 +22,6 @@ class Piwik_Referers_Archiving $this->maximumRowsInSubDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_subtable_referers']; } - /** - * @param $archiveProcessing - */ public function archiveDay($archiveProcessing) { $query = $archiveProcessing->queryVisitsByDimension(array("referer_type", "referer_name", "referer_keyword", "referer_url")); @@ -34,14 +31,9 @@ class Piwik_Referers_Archiving $this->aggregateFromConversions($archiveProcessing, $query); Piwik_PostEvent('Referers.archiveDay', $this); - $this->archiveDayRecordInDatabase($archiveProcessing); + $this->recordDayReports($archiveProcessing); } - /** - * @param Piwik_ArchiveProcessing_Day $archiveProcessing - * @param $query - * @throws Exception - */ protected function aggregateFromVisits(Piwik_ArchiveProcessing_Day $archiveProcessing, $query) { $this->metricsBySearchEngine = @@ -58,7 +50,6 @@ class Piwik_Referers_Archiving $this->makeRefererTypeNonEmpty($row); $this->aggregateVisit($archiveProcessing, $row); $this->aggregateVisitByType($archiveProcessing, $row); - } } @@ -259,9 +250,8 @@ class Piwik_Referers_Archiving * Records the daily stats (numeric or datatable blob) into the archive tables. * * @param Piwik_ArchiveProcessing $archiveProcessing - * @return void */ - protected function archiveDayRecordInDatabase($archiveProcessing) + protected function recordDayReports($archiveProcessing) { $numericRecords = array( 'Referers_distinctSearchEngines' => count($this->metricsBySearchEngineAndKeyword), @@ -292,9 +282,6 @@ class Piwik_Referers_Archiving } } - /** - * @param $archiveProcessing - */ public function archivePeriod($archiveProcessing) { $dataTableToSum = array( diff --git a/plugins/UserCountry/Archiving.php b/plugins/UserCountry/Archiving.php index 4c049ff6b9..2a8890da83 100644 --- a/plugins/UserCountry/Archiving.php +++ b/plugins/UserCountry/Archiving.php @@ -28,12 +28,9 @@ class Piwik_UserCountry_Archiving 'location_city' => array()); $this->aggregateFromVisits($archiveProcessing); $this->aggregateFromConversions($archiveProcessing); - $this->archiveDayRecordInDatabase($archiveProcessing); + $this->recordDayReports($archiveProcessing); } - /** - * @param Piwik_ArchiveProcessing_Day $archiveProcessing - */ protected function aggregateFromVisits($archiveProcessing) { $dimensions = array_keys($this->metricsByDimension); @@ -54,7 +51,7 @@ class Piwik_UserCountry_Archiving while ($row = $query->fetch()) { $this->makeRegionCityLabelsUnique($row); $this->rememberCityLatLong($row); - $this->aggregateConversion($archiveProcessing, $row); + $this->aggregateVisit($archiveProcessing, $row); } } @@ -104,7 +101,7 @@ class Piwik_UserCountry_Archiving } } - protected function aggregateConversion($archiveProcessing, $row) + protected function aggregateVisit($archiveProcessing, $row) { foreach ($this->metricsByDimension as $dimension => &$table) { $label = (string)$row[$dimension]; @@ -149,10 +146,7 @@ class Piwik_UserCountry_Archiving } } - /** - * @param Piwik_ArchiveProcessing_Day $archiveProcessing - */ - protected function archiveDayRecordInDatabase($archiveProcessing) + protected function recordDayReports($archiveProcessing) { $maximumRows = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; diff --git a/plugins/UserSettings/Archiving.php b/plugins/UserSettings/Archiving.php new file mode 100644 index 0000000000..7a12f56b4e --- /dev/null +++ b/plugins/UserSettings/Archiving.php @@ -0,0 +1,147 @@ +maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; + $this->columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; + } + + public function archiveDay($archiveProcessing) + { + $this->aggregateByConfiguration($archiveProcessing); + $this->aggregateByOs($archiveProcessing); + $this->aggregateByBrowser($archiveProcessing); + $this->aggregateByResolutionAndScreenType($archiveProcessing); + $this->aggregateByPlugin($archiveProcessing); + $this->aggregateByLanguage($archiveProcessing); + } + + protected function aggregateByConfiguration($archiveProcessing) + { + $labelSQL = "CONCAT(log_visit.config_os, ';', log_visit.config_browser_name, ';', log_visit.config_resolution)"; + $metrics = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $table = $archiveProcessing->getDataTableFromArray($metrics); + $archiveProcessing->insertBlobRecord(self::CONFIGURATION_RECORD_NAME, $table->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + } + + protected function aggregateByOs($archiveProcessing) + { + $metrics = $archiveProcessing->getArrayInterestForLabel("log_visit.config_os"); + $table = $archiveProcessing->getDataTableFromArray($metrics); + $archiveProcessing->insertBlobRecord(self::OS_RECORD_NAME, $table->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + } + + protected function aggregateByBrowser($archiveProcessing) + { + $tableBrowser = $this->aggregateByBrowserVersion($archiveProcessing); + $this->aggregateByBrowserType($archiveProcessing, $tableBrowser); + } + + protected function aggregateByBrowserVersion($archiveProcessing) + { + $labelSQL = "CONCAT(log_visit.config_browser_name, ';', log_visit.config_browser_version)"; + $metrics = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $tableBrowser = $archiveProcessing->getDataTableFromArray($metrics); + + $archiveProcessing->insertBlobRecord(self::BROWSER_RECORD_NAME, $tableBrowser->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + return $tableBrowser; + } + + protected function aggregateByBrowserType($archiveProcessing, $tableBrowser) + { + $tableBrowser->filter('GroupBy', array('label', 'Piwik_getBrowserFamily')); + $archiveProcessing->insertBlobRecord(self::BROWSER_TYPE_RECORD_NAME, $tableBrowser->getSerialized()); + } + + protected function aggregateByResolutionAndScreenType($archiveProcessing) + { + $resolutions = $this->aggregateByResolution($archiveProcessing); + $this->aggregateByScreenType($archiveProcessing, $resolutions); + } + + protected function aggregateByResolution($archiveProcessing) + { + $metrics = $archiveProcessing->getArrayInterestForLabel("log_visit.config_resolution"); + $table = $archiveProcessing->getDataTableFromArray($metrics); + $table->filter('ColumnCallbackDeleteRow', array('label', 'Piwik_UserSettings_keepStrlenGreater')); + $archiveProcessing->insertBlobRecord(self::RESOLUTION_RECORD_NAME, $table->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + return $table; + } + + protected function aggregateByScreenType($archiveProcessing, Piwik_DataTable $resolutions) + { + $resolutions->filter('GroupBy', array('label', 'Piwik_getScreenTypeFromResolution')); + $archiveProcessing->insertBlobRecord(self::SCREEN_TYPES_RECORD_NAME, $resolutions->getSerialized()); + } + + protected function aggregateByPlugin($archiveProcessing) + { + $toSelect = "sum(case log_visit.config_pdf when 1 then 1 else 0 end) as pdf, + sum(case log_visit.config_flash when 1 then 1 else 0 end) as flash, + sum(case log_visit.config_java when 1 then 1 else 0 end) as java, + sum(case log_visit.config_director when 1 then 1 else 0 end) as director, + sum(case log_visit.config_quicktime when 1 then 1 else 0 end) as quicktime, + sum(case log_visit.config_realplayer when 1 then 1 else 0 end) as realplayer, + sum(case log_visit.config_windowsmedia when 1 then 1 else 0 end) as windowsmedia, + sum(case log_visit.config_gears when 1 then 1 else 0 end) as gears, + sum(case log_visit.config_silverlight when 1 then 1 else 0 end) as silverlight, + sum(case log_visit.config_cookie when 1 then 1 else 0 end) as cookie "; + $table = $archiveProcessing->getSimpleDataTableFromSelect($toSelect, Piwik_Archive::INDEX_NB_VISITS); + $archiveProcessing->insertBlobRecord(self::PLUGIN_RECORD_NAME, $table->getSerialized()); + } + + protected function aggregateByLanguage($archiveProcessing) + { + $query = $archiveProcessing->queryVisitsByDimension("log_visit.location_browser_lang"); + $languageCodes = array_keys(Piwik_Common::getLanguagesList()); + $metricsByLanguage = array(); + while ($row = $query->fetch()) { + $code = Piwik_Common::extractLanguageCodeFromBrowserLanguage($row['label'], $languageCodes); + + if (!isset($metricsByLanguage[$code])) { + $metricsByLanguage[$code] = $archiveProcessing->makeEmptyRow(); + } + $archiveProcessing->sumMetrics($row, $metricsByLanguage[$code]); + } + + $tableLanguage = $archiveProcessing->getDataTableFromArray($metricsByLanguage); + $archiveProcessing->insertBlobRecord(self::LANGUAGE_RECORD_NAME, $tableLanguage->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + } + + public function archivePeriod($archiveProcessing) + { + $dataTableToSum = array( + self::CONFIGURATION_RECORD_NAME, + self::OS_RECORD_NAME, + self::BROWSER_RECORD_NAME, + self::BROWSER_TYPE_RECORD_NAME, + self::RESOLUTION_RECORD_NAME, + self::SCREEN_TYPES_RECORD_NAME, + self::PLUGIN_RECORD_NAME, + self::LANGUAGE_RECORD_NAME, + ); + $archiveProcessing->archiveDataTable($dataTableToSum, null, $this->maximumRowsInDataTable); + } +} \ No newline at end of file diff --git a/plugins/UserSettings/UserSettings.php b/plugins/UserSettings/UserSettings.php index 09fb77ff9e..914f0694c4 100644 --- a/plugins/UserSettings/UserSettings.php +++ b/plugins/UserSettings/UserSettings.php @@ -269,70 +269,18 @@ class Piwik_UserSettings extends Piwik_Plugin * are superset of an existing report (eg. Browser family is built from the Browser report) * * @param Piwik_Event_Notification $notification notification object - * @return void */ function archiveDay($notification) { - require_once PIWIK_INCLUDE_PATH . '/plugins/UserSettings/functions.php'; - $maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; - $columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; - $archiveProcessing = $notification->getNotificationObject(); if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $this->archiveProcessing = $archiveProcessing; - - $recordName = 'UserSettings_configuration'; - $labelSQL = "CONCAT(log_visit.config_os, ';', log_visit.config_browser_name, ';', log_visit.config_resolution)"; - $metricsByConfiguration = $archiveProcessing->getArrayInterestForLabel($labelSQL); - - $tableConfiguration = $archiveProcessing->getDataTableFromArray($metricsByConfiguration); - $archiveProcessing->insertBlobRecord($recordName, $tableConfiguration->getSerialized($maximumRowsInDataTable, null, $columnToSortByBeforeTruncation)); - destroy($tableConfiguration); - - $recordName = 'UserSettings_os'; - $labelSQL = "log_visit.config_os"; - $metricsByOs = $archiveProcessing->getArrayInterestForLabel($labelSQL); - $tableOs = $archiveProcessing->getDataTableFromArray($metricsByOs); - $archiveProcessing->insertBlobRecord($recordName, $tableOs->getSerialized($maximumRowsInDataTable, null, $columnToSortByBeforeTruncation)); - destroy($tableOs); - - $recordName = 'UserSettings_browser'; - $labelSQL = "CONCAT(log_visit.config_browser_name, ';', log_visit.config_browser_version)"; - $metricsByBrowser = $archiveProcessing->getArrayInterestForLabel($labelSQL); - $tableBrowser = $archiveProcessing->getDataTableFromArray($metricsByBrowser); - $archiveProcessing->insertBlobRecord($recordName, $tableBrowser->getSerialized($maximumRowsInDataTable, null, $columnToSortByBeforeTruncation)); - - $recordName = 'UserSettings_browserType'; - $tableBrowserType = $this->getTableBrowserByType($tableBrowser); - $archiveProcessing->insertBlobRecord($recordName, $tableBrowserType->getSerialized()); - destroy($tableBrowser); - destroy($tableBrowserType); - - $recordName = 'UserSettings_resolution'; - $labelSQL = "log_visit.config_resolution"; - $metricsByResolution = $archiveProcessing->getArrayInterestForLabel($labelSQL); - $tableResolution = $archiveProcessing->getDataTableFromArray($metricsByResolution); - $tableResolution->filter('ColumnCallbackDeleteRow', array('label', 'Piwik_UserSettings_keepStrlenGreater')); - $archiveProcessing->insertBlobRecord($recordName, $tableResolution->getSerialized($maximumRowsInDataTable, null, $columnToSortByBeforeTruncation)); - - $recordName = 'UserSettings_wideScreen'; - $tableWideScreen = $this->getTableWideScreen($tableResolution); - $archiveProcessing->insertBlobRecord($recordName, $tableWideScreen->getSerialized()); - destroy($tableResolution); - destroy($tableWideScreen); - - $recordName = 'UserSettings_plugin'; - $tablePlugin = $this->getDataTablePlugin(); - $archiveProcessing->insertBlobRecord($recordName, $tablePlugin->getSerialized()); - destroy($tablePlugin); - - $recordName = 'UserSettings_language'; - $tableLanguage = $this->getDataTableLanguages(); - $archiveProcessing->insertBlobRecord($recordName, $tableLanguage->getSerialized($maximumRowsInDataTable, null, $columnToSortByBeforeTruncation)); + $archiving = new Piwik_UserSettings_Archiving(); + $archiving->archiveDay($archiveProcessing); } + /** * Period archiving: simply sums up daily archives * @@ -345,117 +293,7 @@ class Piwik_UserSettings extends Piwik_Plugin if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; - - $dataTableToSum = array( - 'UserSettings_configuration', - 'UserSettings_os', - 'UserSettings_browser', - 'UserSettings_browserType', - 'UserSettings_resolution', - 'UserSettings_wideScreen', - 'UserSettings_plugin', - 'UserSettings_language', - ); - - $archiveProcessing->archiveDataTable($dataTableToSum, null, $maximumRowsInDataTable); - } - - /** - * Returns the report Visits by Screen type given the Resolution table - * - * @param Piwik_DataTable $tableResolution - * @return Piwik_DataTable - */ - protected function getTableWideScreen(Piwik_DataTable $tableResolution) - { - $nameToRow = array(); - foreach ($tableResolution->getRows() as $row) { - $resolution = $row->getColumn('label'); - $name = Piwik_getScreenTypeFromResolution($resolution); - if (!isset($nameToRow[$name])) { - $nameToRow[$name] = new Piwik_DataTable_Row(); - $nameToRow[$name]->addColumn('label', $name); - } - - $nameToRow[$name]->sumRow($row); - } - $tableWideScreen = new Piwik_DataTable(); - $tableWideScreen->addRowsFromArray($nameToRow); - - return $tableWideScreen; - } - - /** - * Returns the report Visits by Browser family given the Browser report - * - * @param Piwik_DataTable $tableBrowser - * @return Piwik_DataTable - */ - protected function getTableBrowserByType(Piwik_DataTable $tableBrowser) - { - $nameToRow = array(); - foreach ($tableBrowser->getRows() as $row) { - $browserLabel = $row->getColumn('label'); - $familyNameToUse = Piwik_getBrowserFamily($browserLabel); - if (!isset($nameToRow[$familyNameToUse])) { - $nameToRow[$familyNameToUse] = new Piwik_DataTable_Row(); - $nameToRow[$familyNameToUse]->addColumn('label', $familyNameToUse); - } - $nameToRow[$familyNameToUse]->sumRow($row); - } - - $tableBrowserType = new Piwik_DataTable(); - $tableBrowserType->addRowsFromArray($nameToRow); - return $tableBrowserType; - } - - /** - * Returns SQL that processes stats for Plugins - * - * @return Piwik_DataTable_Simple - */ - protected function getDataTablePlugin() - { - $toSelect = "sum(case log_visit.config_pdf when 1 then 1 else 0 end) as pdf, - sum(case log_visit.config_flash when 1 then 1 else 0 end) as flash, - sum(case log_visit.config_java when 1 then 1 else 0 end) as java, - sum(case log_visit.config_director when 1 then 1 else 0 end) as director, - sum(case log_visit.config_quicktime when 1 then 1 else 0 end) as quicktime, - sum(case log_visit.config_realplayer when 1 then 1 else 0 end) as realplayer, - sum(case log_visit.config_windowsmedia when 1 then 1 else 0 end) as windowsmedia, - sum(case log_visit.config_gears when 1 then 1 else 0 end) as gears, - sum(case log_visit.config_silverlight when 1 then 1 else 0 end) as silverlight, - sum(case log_visit.config_cookie when 1 then 1 else 0 end) as cookie "; - return $this->archiveProcessing->getSimpleDataTableFromSelect($toSelect, Piwik_Archive::INDEX_NB_VISITS); - } - - protected function getDataTableLanguages() - { - $labelSQL = "log_visit.location_browser_lang"; - $metricsByLanguage = $this->archiveProcessing->getArrayInterestForLabel($labelSQL); - - $languageCodes = array_keys(Piwik_Common::getLanguagesList()); - - foreach ($metricsByLanguage as $lang => $count) { - // get clean language code - $code = Piwik_Common::extractLanguageCodeFromBrowserLanguage($lang, $languageCodes); - if ($code != $lang) { - if (!array_key_exists($code, $metricsByLanguage)) { - $metricsByLanguage[$code] = array(); - } - // Add the values to the primary language - foreach ($count as $key => $value) { - if (array_key_exists($key, $metricsByLanguage[$code])) { - $metricsByLanguage[$code][$key] += $value; - } else { - $metricsByLanguage[$code][$key] = $value; - } - } - unset($metricsByLanguage[$lang]); - } - } - $tableLanguage = $this->archiveProcessing->getDataTableFromArray($metricsByLanguage); - return $tableLanguage; + $archiving = new Piwik_UserSettings_Archiving(); + $archiving->archivePeriod($archiveProcessing); } } diff --git a/plugins/VisitTime/VisitTime.php b/plugins/VisitTime/VisitTime.php index 093267f41c..8116274415 100644 --- a/plugins/VisitTime/VisitTime.php +++ b/plugins/VisitTime/VisitTime.php @@ -159,7 +159,7 @@ class Piwik_VisitTime extends Piwik_Plugin $this->archiveDayAggregateVisits($archiveProcessing); $this->archiveDayAggregateGoals($archiveProcessing); - $this->archiveDayRecordInDatabase($archiveProcessing); + $this->recordDayReports($archiveProcessing); } protected function archiveDayAggregateVisits($archiveProcessing) @@ -198,7 +198,7 @@ class Piwik_VisitTime extends Piwik_Plugin $archiveProcessing->enrichConversionsByLabelArray($this->metricsByServerTime); } - protected function archiveDayRecordInDatabase($archiveProcessing) + protected function recordDayReports($archiveProcessing) { $tableLocalTime = $archiveProcessing->getDataTableFromArray($this->metricsByLocalTime); $this->makeSureAllHoursAreSet($tableLocalTime, $archiveProcessing); -- cgit v1.2.3 From 48c7a1e945d945d6d8bd998a1f355ed4c02f23d3 Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 6 Jun 2013 14:07:11 +1200 Subject: // OMG THIS IS SO WRONG! // use segment instead --- plugins/VisitFrequency/Archiving.php | 66 +++++++++++++++++++++++++++++++ plugins/VisitFrequency/VisitFrequency.php | 63 ++++------------------------- 2 files changed, 73 insertions(+), 56 deletions(-) create mode 100644 plugins/VisitFrequency/Archiving.php (limited to 'plugins') diff --git a/plugins/VisitFrequency/Archiving.php b/plugins/VisitFrequency/Archiving.php new file mode 100644 index 0000000000..f4f38110ea --- /dev/null +++ b/plugins/VisitFrequency/Archiving.php @@ -0,0 +1,66 @@ += ? + AND log_visit.visit_last_action_time <= ? + AND log_visit.idsite = ? + AND log_visit.visitor_returning >= 1"; + + $bind = array($archiveProcessing->getStartDatetimeUTC(), + $archiveProcessing->getEndDatetimeUTC(), $archiveProcessing->idsite); + + $query = $archiveProcessing->getSegment()->getSelectQuery($select, $from, $where, $bind); + + $row = $archiveProcessing->db->fetchRow($query['sql'], $query['bind']); + + if ($row === false || $row === null) { + $row['nb_visits_returning'] = 0; + $row['nb_actions_returning'] = 0; + $row['max_actions_returning'] = 0; + $row['sum_visit_length_returning'] = 0; + $row['bounce_count_returning'] = 0; + $row['nb_visits_converted_returning'] = 0; + } + + foreach ($row as $name => $value) { + $archiveProcessing->insertNumericRecord($name, $value); + } + } + + public function archivePeriod($archiveProcessing) + { + $numericToSum = array( + 'nb_visits_returning', + 'nb_actions_returning', + 'sum_visit_length_returning', + 'bounce_count_returning', + 'nb_visits_converted_returning', + ); + $archiveProcessing->archiveNumericValuesSum($numericToSum); + $archiveProcessing->archiveNumericValuesMax('max_actions_returning'); + } +} \ No newline at end of file diff --git a/plugins/VisitFrequency/VisitFrequency.php b/plugins/VisitFrequency/VisitFrequency.php index 4659feee91..93118af576 100644 --- a/plugins/VisitFrequency/VisitFrequency.php +++ b/plugins/VisitFrequency/VisitFrequency.php @@ -78,72 +78,23 @@ class Piwik_VisitFrequency extends Piwik_Plugin Piwik_AddMenu('General_Visitors', 'VisitFrequency_SubmenuFrequency', array('module' => 'VisitFrequency', 'action' => 'index')); } - /** - * @param Piwik_Event_Notification $notification notification object - * @return mixed - */ - function archivePeriod($notification) + function archiveDay($notification) { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $numericToSum = array( - 'nb_visits_returning', - 'nb_actions_returning', - 'sum_visit_length_returning', - 'bounce_count_returning', - 'nb_visits_converted_returning', - ); - $archiveProcessing->archiveNumericValuesSum($numericToSum); - $archiveProcessing->archiveNumericValuesMax('max_actions_returning'); + $archiving = new Piwik_VisitFrequency_Archiving(); + $archiving->archiveDay($archiveProcessing); } - /** - * @param Piwik_Event_Notification $notification notification object - * @return mixed - */ - function archiveDay($notification) + function archivePeriod($notification) { - /* @var $archiveProcessing Piwik_ArchiveProcessing */ $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $select = "count(distinct log_visit.idvisitor) as nb_uniq_visitors_returning, - count(*) as nb_visits_returning, - sum(log_visit.visit_total_actions) as nb_actions_returning, - max(log_visit.visit_total_actions) as max_actions_returning, - sum(log_visit.visit_total_time) as sum_visit_length_returning, - sum(case log_visit.visit_total_actions when 1 then 1 when 0 then 1 else 0 end) as bounce_count_returning, - sum(case log_visit.visit_goal_converted when 1 then 1 else 0 end) as nb_visits_converted_returning"; - - $from = "log_visit"; - - $where = "log_visit.visit_last_action_time >= ? - AND log_visit.visit_last_action_time <= ? - AND log_visit.idsite = ? - AND log_visit.visitor_returning >= 1"; - - $bind = array($archiveProcessing->getStartDatetimeUTC(), - $archiveProcessing->getEndDatetimeUTC(), $archiveProcessing->idsite); - - $query = $archiveProcessing->getSegment()->getSelectQuery($select, $from, $where, $bind); - - $row = $archiveProcessing->db->fetchRow($query['sql'], $query['bind']); - - if ($row === false || $row === null) { - $row['nb_visits_returning'] = 0; - $row['nb_actions_returning'] = 0; - $row['max_actions_returning'] = 0; - $row['sum_visit_length_returning'] = 0; - $row['bounce_count_returning'] = 0; - $row['nb_visits_converted_returning'] = 0; - } - - foreach ($row as $name => $value) { - $archiveProcessing->insertNumericRecord($name, $value); - } + $archiving = new Piwik_VisitFrequency_Archiving(); + $archiving->archivePeriod($archiveProcessing); } + } -- cgit v1.2.3 From 196d9a052e0e59f55db18caef9318b48353acb7b Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 6 Jun 2013 14:17:45 +1200 Subject: VisitorInterest factor out --- plugins/VisitorInterest/Archiving.php | 182 ++++++++++++++++++++++++++++ plugins/VisitorInterest/VisitorInterest.php | 180 +-------------------------- 2 files changed, 188 insertions(+), 174 deletions(-) create mode 100644 plugins/VisitorInterest/Archiving.php (limited to 'plugins') diff --git a/plugins/VisitorInterest/Archiving.php b/plugins/VisitorInterest/Archiving.php new file mode 100644 index 0000000000..124d3cc3b9 --- /dev/null +++ b/plugins/VisitorInterest/Archiving.php @@ -0,0 +1,182 @@ +queryVisitsSimple(implode(',', $selects)); + + // archive visits by total time report + $recordName = 'VisitorInterest_timeGap'; + $this->archiveRangeStats($archiveProcessing, $recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $timeGapPrefix); + + // archive visits by total actions report + $recordName = 'VisitorInterest_pageGap'; + $this->archiveRangeStats($archiveProcessing, $recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $pageGapPrefix); + + // archive visits by visit number report + $recordName = 'VisitorInterest_visitsByVisitCount'; + $this->archiveRangeStats($archiveProcessing, $recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $visitsByVisitNumPrefix); + + // archive days since last visit report + $recordName = 'VisitorInterest_daysSinceLastVisit'; + $this->archiveRangeStats($archiveProcessing, $recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $daysSinceLastVisitPrefix); + } + + public function archivePeriod(Piwik_ArchiveProcessing $archiveProcessing) + { + $dataTableToSum = array( + 'VisitorInterest_timeGap', + 'VisitorInterest_pageGap', + 'VisitorInterest_visitsByVisitCount', + 'VisitorInterest_daysSinceLastVisit' + ); + $archiveProcessing->archiveDataTable($dataTableToSum); + } + + + /** + * Transforms and returns the set of ranges used to calculate the 'visits by total time' + * report from ranges in minutes to equivalent ranges in seconds. + */ + protected static function getSecondsGap() + { + $secondsGap = array(); + foreach (self::$timeGap as $gap) { + if (count($gap) == 3 && $gap[2] == 's') // if the units are already in seconds, just assign them + { + $secondsGap[] = array($gap[0], $gap[1]); + } else if (count($gap) == 2) { + $secondsGap[] = array($gap[0] * 60, $gap[1] * 60); + } else { + $secondsGap[] = array($gap[0] * 60); + } + } + return $secondsGap; + } + + /** + * Creates and archives a DataTable from some (or all) elements of a supplied database + * row. + * + * @param string $recordName The record name to use when inserting the new archive. + * @param array $row The database row to use. + * @param string $selectAsPrefix The string to look for as the prefix of SELECT as + * expressions. Elements in $row that have a SELECT as + * with this string as a prefix are used in creating + * the DataTable.' + */ + protected function archiveRangeStats($archiveProcessing, $recordName, $row, $index, $selectAsPrefix) + { + $dataTable = $archiveProcessing->getSimpleDataTableFromRow($row, $index, $selectAsPrefix); + + $archiveProcessing->insertBlobRecord($recordName, $dataTable->getSerialized()); + } +} \ No newline at end of file diff --git a/plugins/VisitorInterest/VisitorInterest.php b/plugins/VisitorInterest/VisitorInterest.php index 00689e5c2c..3f5c219871 100644 --- a/plugins/VisitorInterest/VisitorInterest.php +++ b/plugins/VisitorInterest/VisitorInterest.php @@ -123,192 +123,24 @@ class Piwik_VisitorInterest extends Piwik_Plugin Piwik_AddAction('template_footerVisitsFrequency', array('Piwik_VisitorInterest', 'footerVisitsFrequency')); } - // third element is unit (s for seconds, default is munutes) - protected static $timeGap = array( - array(0, 10, 's'), - array(11, 30, 's'), - array(31, 60, 's'), - array(1, 2), - array(2, 4), - array(4, 7), - array(7, 10), - array(10, 15), - array(15, 30), - array(30) - ); - - protected static $pageGap = array( - array(1, 1), - array(2, 2), - array(3, 3), - array(4, 4), - array(5, 5), - array(6, 7), - array(8, 10), - array(11, 14), - array(15, 20), - array(20) - ); - - /** - * The set of ranges used when calculating the 'visitors who visited at least N times' report. - */ - protected static $visitNumberGap = array( - array(1, 1), - array(2, 2), - array(3, 3), - array(4, 4), - array(5, 5), - array(6, 6), - array(7, 7), - array(8, 8), - array(9, 14), - array(15, 25), - array(26, 50), - array(51, 100), - array(101, 200), - array(200) - ); - - /** - * The set of ranges used when calculating the 'days since last visit' report. - */ - protected static $daysSinceLastVisitGap = array( - array(0, 0), - array(1, 1), - array(2, 2), - array(3, 3), - array(4, 4), - array(5, 5), - array(6, 6), - array(7, 7), - array(8, 14), - array(15, 30), - array(31, 60), - array(61, 120), - array(121, 364), - array(364) - ); - - /** - * @param Piwik_Event_Notification $notification notification object - * @return mixed - */ function archivePeriod($notification) { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $dataTableToSum = array( - 'VisitorInterest_timeGap', - 'VisitorInterest_pageGap', - 'VisitorInterest_visitsByVisitCount', - 'VisitorInterest_daysSinceLastVisit' - ); - $archiveProcessing->archiveDataTable($dataTableToSum); + $archiving = new Piwik_VisitorInterest_Archiving(); + $archiving->archivePeriod($archiveProcessing); } - /** - * @param Piwik_Event_Notification $notification notification object - * @return mixed - */ public function archiveDay($notification) { - $this->archiveProcessing = $notification->getNotificationObject(); - - if (!$this->archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - - // these prefixes are prepended to the 'SELECT as' parts of each SELECT expression. detecting - // these prefixes allows us to get all the data in one query. - $timeGapPrefix = 'tg'; - $pageGapPrefix = 'pg'; - $visitsByVisitNumPrefix = 'vbvn'; - $daysSinceLastVisitPrefix = 'dslv'; - - // extra condition for the SQL SELECT that makes sure only returning visits are counted - // when creating the 'days since last visit' report. the SELECT expression below it - // is used to count all new visits. - $daysSinceLastExtraCondition = 'and log_visit.visitor_returning = 1'; - $selectAs = $daysSinceLastVisitPrefix . 'General_NewVisits'; - $newVisitCountSelect = "sum(case when log_visit.visitor_returning = 0 then 1 else 0 end) as `$selectAs`"; - - // create the select expressions to use - $timeGapSelects = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( - 'visit_total_time', self::getSecondsGap(), 'log_visit', $timeGapPrefix); - $pageGapSelects = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( - 'visit_total_actions', self::$pageGap, 'log_visit', $pageGapPrefix); - $visitsByVisitNumSelects = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( - 'visitor_count_visits', self::$visitNumberGap, 'log_visit', $visitsByVisitNumPrefix); - - $daysSinceLastVisitSelects = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( - 'visitor_days_since_last', self::$daysSinceLastVisitGap, 'log_visit', $daysSinceLastVisitPrefix, - $daysSinceLastExtraCondition); - array_unshift($daysSinceLastVisitSelects, $newVisitCountSelect); - - $selects = array_merge( - $timeGapSelects, $pageGapSelects, $visitsByVisitNumSelects, $daysSinceLastVisitSelects); - - // select data for every report - $row = $this->archiveProcessing->queryVisitsSimple(implode(',', $selects)); - - // archive visits by total time report - $recordName = 'VisitorInterest_timeGap'; - $this->archiveRangeStats($recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $timeGapPrefix); - - // archive visits by total actions report - $recordName = 'VisitorInterest_pageGap'; - $this->archiveRangeStats($recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $pageGapPrefix); - - // archive visits by visit number report - $recordName = 'VisitorInterest_visitsByVisitCount'; - $this->archiveRangeStats($recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $visitsByVisitNumPrefix); - - // archive days since last visit report - $recordName = 'VisitorInterest_daysSinceLastVisit'; - $this->archiveRangeStats($recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $daysSinceLastVisitPrefix); - } + $archiveProcessing = $notification->getNotificationObject(); + if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - /** - * Transforms and returns the set of ranges used to calculate the 'visits by total time' - * report from ranges in minutes to equivalent ranges in seconds. - */ - protected static function getSecondsGap() - { - $secondsGap = array(); - foreach (self::$timeGap as $gap) { - if (count($gap) == 3 && $gap[2] == 's') // if the units are already in seconds, just assign them - { - $secondsGap[] = array($gap[0], $gap[1]); - } else if (count($gap) == 2) { - $secondsGap[] = array($gap[0] * 60, $gap[1] * 60); - } else { - $secondsGap[] = array($gap[0] * 60); - } - } - return $secondsGap; + $archiving = new Piwik_VisitorInterest_Archiving(); + $archiving->archiveDay($archiveProcessing); } - /** - * Creates and archives a DataTable from some (or all) elements of a supplied database - * row. - * - * @param string $recordName The record name to use when inserting the new archive. - * @param array $row The database row to use. - * @param string $selectAsPrefix The string to look for as the prefix of SELECT as - * expressions. Elements in $row that have a SELECT as - * with this string as a prefix are used in creating - * the DataTable.' - */ - protected function archiveRangeStats($recordName, $row, $index, $selectAsPrefix) - { - // create the DataTable from parts of the result row - $dataTable = $this->archiveProcessing->getSimpleDataTableFromRow($row, $index, $selectAsPrefix); - - // insert the data table as a blob archive - $this->archiveProcessing->insertBlobRecord($recordName, $dataTable->getSerialized()); - destroy($dataTable); - } /** * @param Piwik_Event_Notification $notification notification object -- cgit v1.2.3 From 7480a87f4507b56f5ab5d9337cb528a86eb4d233 Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 6 Jun 2013 14:41:40 +1200 Subject: Minor --- plugins/DevicesDetection/Archiving.php | 2 +- plugins/Provider/Archiving.php | 2 +- plugins/UserCountry/Archiving.php | 1 - plugins/UserSettings/Archiving.php | 8 ++-- plugins/VisitTime/VisitTime.php | 73 +--------------------------------- 5 files changed, 8 insertions(+), 78 deletions(-) (limited to 'plugins') diff --git a/plugins/DevicesDetection/Archiving.php b/plugins/DevicesDetection/Archiving.php index f5a7b34b4d..6d4a51bb28 100644 --- a/plugins/DevicesDetection/Archiving.php +++ b/plugins/DevicesDetection/Archiving.php @@ -39,7 +39,7 @@ class Piwik_DevicesDetection_Archiving private function aggregateByLabel($archiveProcessing, $labelSQL, $recordName) { - $metricsByLabel = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $metricsByLabel = $archiveProcessing->getMetricsForLabel($labelSQL); $tableBrand = $archiveProcessing->getDataTableFromArray($metricsByLabel); $archiveProcessing->insertBlobRecord($recordName, $tableBrand->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); diff --git a/plugins/Provider/Archiving.php b/plugins/Provider/Archiving.php index bcc45b6a49..38305b035d 100644 --- a/plugins/Provider/Archiving.php +++ b/plugins/Provider/Archiving.php @@ -14,7 +14,7 @@ class Piwik_Provider_Archiving { $recordName = 'Provider_hostnameExt'; $labelSQL = "log_visit.location_provider"; - $metricsByProvider = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $metricsByProvider = $archiveProcessing->getMetricsForLabel($labelSQL); $tableProvider = $archiveProcessing->getDataTableFromArray($metricsByProvider); $columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; $maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; diff --git a/plugins/UserCountry/Archiving.php b/plugins/UserCountry/Archiving.php index 2a8890da83..505b740fa5 100644 --- a/plugins/UserCountry/Archiving.php +++ b/plugins/UserCountry/Archiving.php @@ -136,7 +136,6 @@ class Piwik_UserCountry_Archiving if (!isset($table[$label][Piwik_Archive::INDEX_GOALS][$idGoal])) { $table[$label][Piwik_Archive::INDEX_GOALS][$idGoal] = $archiveProcessing->makeEmptyGoalRow($idGoal); } - $archiveProcessing->sumGoalMetrics($row, $table[$label][Piwik_Archive::INDEX_GOALS][$idGoal]); } } diff --git a/plugins/UserSettings/Archiving.php b/plugins/UserSettings/Archiving.php index 7a12f56b4e..dabc57365d 100644 --- a/plugins/UserSettings/Archiving.php +++ b/plugins/UserSettings/Archiving.php @@ -41,14 +41,14 @@ class Piwik_UserSettings_Archiving protected function aggregateByConfiguration($archiveProcessing) { $labelSQL = "CONCAT(log_visit.config_os, ';', log_visit.config_browser_name, ';', log_visit.config_resolution)"; - $metrics = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $metrics = $archiveProcessing->getMetricsForLabel($labelSQL); $table = $archiveProcessing->getDataTableFromArray($metrics); $archiveProcessing->insertBlobRecord(self::CONFIGURATION_RECORD_NAME, $table->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); } protected function aggregateByOs($archiveProcessing) { - $metrics = $archiveProcessing->getArrayInterestForLabel("log_visit.config_os"); + $metrics = $archiveProcessing->getMetricsForLabel("log_visit.config_os"); $table = $archiveProcessing->getDataTableFromArray($metrics); $archiveProcessing->insertBlobRecord(self::OS_RECORD_NAME, $table->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); } @@ -62,7 +62,7 @@ class Piwik_UserSettings_Archiving protected function aggregateByBrowserVersion($archiveProcessing) { $labelSQL = "CONCAT(log_visit.config_browser_name, ';', log_visit.config_browser_version)"; - $metrics = $archiveProcessing->getArrayInterestForLabel($labelSQL); + $metrics = $archiveProcessing->getMetricsForLabel($labelSQL); $tableBrowser = $archiveProcessing->getDataTableFromArray($metrics); $archiveProcessing->insertBlobRecord(self::BROWSER_RECORD_NAME, $tableBrowser->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); @@ -83,7 +83,7 @@ class Piwik_UserSettings_Archiving protected function aggregateByResolution($archiveProcessing) { - $metrics = $archiveProcessing->getArrayInterestForLabel("log_visit.config_resolution"); + $metrics = $archiveProcessing->getMetricsForLabel("log_visit.config_resolution"); $table = $archiveProcessing->getDataTableFromArray($metrics); $table->filter('ColumnCallbackDeleteRow', array('label', 'Piwik_UserSettings_keepStrlenGreater')); $archiveProcessing->insertBlobRecord(self::RESOLUTION_RECORD_NAME, $table->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); diff --git a/plugins/VisitTime/VisitTime.php b/plugins/VisitTime/VisitTime.php index 8116274415..d74af3162c 100644 --- a/plugins/VisitTime/VisitTime.php +++ b/plugins/VisitTime/VisitTime.php @@ -130,10 +130,6 @@ class Piwik_VisitTime extends Piwik_Plugin ); } - /** - * @param Piwik_Event_Notification $notification notification object - * @return mixed - */ function archivePeriod($notification) { $archiveProcessing = $notification->getNotificationObject(); @@ -147,79 +143,14 @@ class Piwik_VisitTime extends Piwik_Plugin $archiveProcessing->archiveDataTable($dataTableToSum); } - /** - * @param Piwik_Event_Notification $notification notification object - * @return mixed - */ public function archiveDay($notification) { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $this->archiveDayAggregateVisits($archiveProcessing); - $this->archiveDayAggregateGoals($archiveProcessing); - $this->recordDayReports($archiveProcessing); - } - - protected function archiveDayAggregateVisits($archiveProcessing) - { - $labelSQL = "HOUR(log_visit.visitor_localtime)"; - $this->metricsByLocalTime = $archiveProcessing->getArrayInterestForLabel($labelSQL); - - $labelSQL = "HOUR(log_visit.visit_last_action_time)"; - $this->metricsByServerTime = $archiveProcessing->getArrayInterestForLabel($labelSQL); - } - - protected function convertServerTimeToLocalTimezone($metricsByServerTime, $archiveProcessing) - { - $date = Piwik_Date::factory($archiveProcessing->getStartDatetimeUTC())->toString(); - $timezone = $archiveProcessing->site->getTimezone(); - $visitsByHourTz = array(); - foreach ($metricsByServerTime as $hour => $stats) { - $datetime = $date . ' ' . $hour . ':00:00'; - $hourInTz = (int)Piwik_Date::factory($datetime, $timezone)->toString('H'); - $visitsByHourTz[$hourInTz] = $stats; - } - return $visitsByHourTz; - } - - protected function archiveDayAggregateGoals($archiveProcessing) - { - $query = $archiveProcessing->queryConversionsByDimension("HOUR(log_conversion.server_time)"); - - if ($query === false) return; - - while ($row = $query->fetch()) { - if (!isset($this->metricsByServerTime[$row['label']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) $this->metricsByServerTime[$row['label']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); - $archiveProcessing->sumGoalMetrics($row, $this->metricsByServerTime[$row['label']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - } - $goalByServerTime = $this->convertServerTimeToLocalTimezone($this->metricsByServerTime, $archiveProcessing); - $archiveProcessing->enrichConversionsByLabelArray($this->metricsByServerTime); - } - - protected function recordDayReports($archiveProcessing) - { - $tableLocalTime = $archiveProcessing->getDataTableFromArray($this->metricsByLocalTime); - $this->makeSureAllHoursAreSet($tableLocalTime, $archiveProcessing); - $archiveProcessing->insertBlobRecord('VisitTime_localTime', $tableLocalTime->getSerialized()); - destroy($tableLocalTime); - - $this->metricsByServerTime = $this->convertServerTimeToLocalTimezone($this->metricsByServerTime, $archiveProcessing); - $tableServerTime = $archiveProcessing->getDataTableFromArray($this->metricsByServerTime); - $this->makeSureAllHoursAreSet($tableServerTime, $archiveProcessing); - $archiveProcessing->insertBlobRecord('VisitTime_serverTime', $tableServerTime->getSerialized()); - destroy($tableServerTime); + $archiving = new Piwik_VisitTime_Archiving(); + $archiving->archiveDay($archiveProcessing); } - private function makeSureAllHoursAreSet($table, $archiveProcessing) - { - for ($i = 0; $i <= 23; $i++) { - if ($table->getRowFromLabel($i) === false) { - $row = $archiveProcessing->makeEmptyRowLabeled($i); - $table->addRow($row); - } - } - } } -- cgit v1.2.3 From 5aacb1ea5a3954909cea62b797905cccf61a9edf Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 6 Jun 2013 15:35:26 +1200 Subject: Introducing new PluginsArchiver class. Plugins can create an Archiver inheriting this abstract class. --- plugins/Actions/Actions.php | 29 +- plugins/Actions/Archiver.php | 555 ++++++++++++++++++++++++ plugins/Actions/Archiving.php | 589 -------------------------- plugins/Actions/ArchivingHelper.php | 2 +- plugins/CustomVariables/API.php | 2 +- plugins/CustomVariables/Archiver.php | 224 ++++++++++ plugins/CustomVariables/Archiving.php | 233 ---------- plugins/CustomVariables/CustomVariables.php | 8 +- plugins/DevicesDetection/Archiver.php | 105 +++++ plugins/DevicesDetection/Archiving.php | 107 ----- plugins/DevicesDetection/DevicesDetection.php | 8 +- plugins/Goals/API.php | 20 +- plugins/Goals/Archiver.php | 349 +++++++++++++++ plugins/Goals/Archiving.php | 354 ---------------- plugins/Goals/Controller.php | 4 +- plugins/Goals/Goals.php | 8 +- plugins/MultiSites/API.php | 10 +- plugins/PrivacyManager/PrivacyManager.php | 8 +- plugins/Provider/Archiver.php | 30 ++ plugins/Provider/Archiving.php | 30 -- plugins/Provider/Provider.php | 8 +- plugins/Referers/Archiver.php | 334 +++++++++++++++ plugins/Referers/Archiving.php | 333 --------------- plugins/Referers/Referers.php | 8 +- plugins/UserCountry/API.php | 12 +- plugins/UserCountry/Archiver.php | 201 +++++++++ plugins/UserCountry/Archiving.php | 203 --------- plugins/UserCountry/UserCountry.php | 8 +- plugins/UserCountry/functions.php | 6 +- plugins/UserSettings/Archiver.php | 148 +++++++ plugins/UserSettings/Archiving.php | 147 ------- plugins/UserSettings/UserSettings.php | 8 +- plugins/VisitFrequency/Archiver.php | 66 +++ plugins/VisitFrequency/Archiving.php | 66 --- plugins/VisitFrequency/VisitFrequency.php | 8 +- plugins/VisitTime/VisitTime.php | 12 +- plugins/VisitorInterest/Archiver.php | 182 ++++++++ plugins/VisitorInterest/Archiving.php | 182 -------- plugins/VisitorInterest/VisitorInterest.php | 8 +- 39 files changed, 2279 insertions(+), 2336 deletions(-) create mode 100644 plugins/Actions/Archiver.php delete mode 100644 plugins/Actions/Archiving.php create mode 100644 plugins/CustomVariables/Archiver.php delete mode 100644 plugins/CustomVariables/Archiving.php create mode 100644 plugins/DevicesDetection/Archiver.php delete mode 100644 plugins/DevicesDetection/Archiving.php create mode 100644 plugins/Goals/Archiver.php delete mode 100644 plugins/Goals/Archiving.php create mode 100644 plugins/Provider/Archiver.php delete mode 100644 plugins/Provider/Archiving.php create mode 100644 plugins/Referers/Archiver.php delete mode 100644 plugins/Referers/Archiving.php create mode 100644 plugins/UserCountry/Archiver.php delete mode 100644 plugins/UserCountry/Archiving.php create mode 100644 plugins/UserSettings/Archiver.php delete mode 100644 plugins/UserSettings/Archiving.php create mode 100644 plugins/VisitFrequency/Archiver.php delete mode 100644 plugins/VisitFrequency/Archiving.php create mode 100644 plugins/VisitorInterest/Archiver.php delete mode 100644 plugins/VisitorInterest/Archiving.php (limited to 'plugins') diff --git a/plugins/Actions/Actions.php b/plugins/Actions/Actions.php index 686601e2d8..0d1fb2f02d 100644 --- a/plugins/Actions/Actions.php +++ b/plugins/Actions/Actions.php @@ -564,42 +564,37 @@ class Piwik_Actions extends Piwik_Plugin /** + * Compute all the actions along with their hierarchies. + * + * For each action we process the "interest statistics" : + * visits, unique visitors, bounce count, sum visit length. + * * @param Piwik_Event_Notification $notification notification object - * @return mixed */ - function archivePeriod($notification) + public function archiveDay($notification) { + /* @var $archiveProcessing Piwik_ArchiveProcessing_Day */ $archiveProcessing = $notification->getNotificationObject(); if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { return; } - $actionsArchiving = new Piwik_Actions_Archiving($archiveProcessing->idsite); - return $actionsArchiving->archivePeriod($archiveProcessing); + $archiving = new Piwik_Actions_Archiver($archiveProcessing); + $archiving->archiveDay(); } - /** - * Compute all the actions along with their hierarchies. - * - * For each action we process the "interest statistics" : - * visits, unique visitors, bounce count, sum visit length. - * - * @param Piwik_Event_Notification $notification notification object - */ - public function archiveDay($notification) + function archivePeriod($notification) { - /* @var $archiveProcessing Piwik_ArchiveProcessing_Day */ $archiveProcessing = $notification->getNotificationObject(); if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { return; } - $actionsArchiving = new Piwik_Actions_Archiving($archiveProcessing->idsite); - return $actionsArchiving->archiveDay($archiveProcessing); + $actionsArchiving = new Piwik_Actions_Archiver($archiveProcessing); + return $actionsArchiving->archivePeriod(); } - static public function checkCustomVariablesPluginEnabled() { if (!self::isCustomVariablesPluginsEnabled()) { diff --git a/plugins/Actions/Archiver.php b/plugins/Actions/Archiver.php new file mode 100644 index 0000000000..7e04246f83 --- /dev/null +++ b/plugins/Actions/Archiver.php @@ -0,0 +1,555 @@ + Piwik_Archive::INDEX_SUM_DAILY_NB_UNIQ_VISITORS, + Piwik_Archive::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS => Piwik_Archive::INDEX_PAGE_ENTRY_SUM_DAILY_NB_UNIQ_VISITORS, + Piwik_Archive::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS => Piwik_Archive::INDEX_PAGE_EXIT_SUM_DAILY_NB_UNIQ_VISITORS, + ); + static protected $invalidSummedColumnNameToDeleteFromDayArchive = array( + Piwik_Archive::INDEX_NB_UNIQ_VISITORS, + Piwik_Archive::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS, + Piwik_Archive::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS, + ); + private static $actionColumnAggregationOperations = array( + Piwik_Archive::INDEX_PAGE_MAX_TIME_GENERATION => 'max', + Piwik_Archive::INDEX_PAGE_MIN_TIME_GENERATION => 'min' + ); + protected $actionsTablesByType = null; + protected $isSiteSearchEnabled = false; + + function __construct($processor) + { + parent::__construct($processor); + $this->isSiteSearchEnabled = Piwik_Site::isSiteSearchEnabledFor($processor->idsite); + } + + /** + * Archives Actions reports for a Day + * + * @param Piwik_ArchiveProcessing $this->getProcessor() + * @return bool + */ + public function archiveDay() + { + $rankingQueryLimit = self::getRankingQueryLimit(); + + // FIXME: This is a quick fix for #3482. The actual cause of the bug is that + // the site search & performance metrics additions to + // Piwik_Actions_ArchivingHelper::updateActionsTableWithRowQuery expect every + // row to have 'type' data, but not all of the SQL queries that are run w/o + // ranking query join on the log_action table and thus do not select the + // log_action.type column. + // + // NOTES: Archiving logic can be generalized as follows: + // 0) Do SQL query over log_link_visit_action & join on log_action to select + // some metrics (like visits, hits, etc.) + // 1) For each row, cache the action row & metrics. (This is done by + // updateActionsTableWithRowQuery for result set rows that have + // name & type columns.) + // 2) Do other SQL queries for metrics we can't put in the first query (like + // entry visits, exit vists, etc.) w/o joining log_action. + // 3) For each row, find the cached row by idaction & add the new metrics to + // it. (This is done by updateActionsTableWithRowQuery for result set rows + // that DO NOT have name & type columns.) + // + // The site search & performance metrics additions expect a 'type' all the time + // which breaks the original pre-rankingquery logic. Ranking query requires a + // join, so the bug is only seen when ranking query is disabled. + if ($rankingQueryLimit === 0) { + $rankingQueryLimit = 100000; + } + + Piwik_Actions_ArchivingHelper::reloadConfig(); + + $this->initActionsTables(); + $this->archiveDayActions($rankingQueryLimit); + $this->archiveDayEntryActions($rankingQueryLimit); + $this->archiveDayExitActions($rankingQueryLimit); + $this->archiveDayActionsTime($rankingQueryLimit); + + $this->recordDayReports(); + + return true; + } + + /** + * Returns the limit to use with RankingQuery for this plugin. + * + * @return int + */ + private static function getRankingQueryLimit() + { + $configGeneral = Piwik_Config::getInstance()->General; + $configLimit = $configGeneral['archiving_ranking_query_row_limit']; + return $configLimit == 0 ? 0 : max( + $configLimit, + $configGeneral['datatable_archiving_maximum_rows_actions'], + $configGeneral['datatable_archiving_maximum_rows_subtable_actions'] + ); + } + + /* + * Page URLs and Page names, general stats + */ + + /** + * Initializes the DataTables created by the archiveDay function. + */ + private function initActionsTables() + { + $this->actionsTablesByType = array(); + foreach (self::$actionTypes as $type) { + $dataTable = new Piwik_DataTable(); + $dataTable->setMaximumAllowedRows(Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero); + + if ($type == Piwik_Tracker_Action::TYPE_ACTION_URL + || $type == Piwik_Tracker_Action::TYPE_ACTION_NAME + ) { + // for page urls and page titles, performance metrics exist and have to be aggregated correctly + $dataTable->setColumnAggregationOperations(self::$actionColumnAggregationOperations); + } + + $this->actionsTablesByType[$type] = $dataTable; + } + } + + protected function archiveDayActions($rankingQueryLimit) + { + $select = "log_action.name, + log_action.type, + log_action.idaction, + log_action.url_prefix, + count(distinct log_link_visit_action.idvisit) as `" . Piwik_Archive::INDEX_NB_VISITS . "`, + count(distinct log_link_visit_action.idvisitor) as `" . Piwik_Archive::INDEX_NB_UNIQ_VISITORS . "`, + count(*) as `" . Piwik_Archive::INDEX_PAGE_NB_HITS . "`, + sum( + case when " . Piwik_Tracker_Action::DB_COLUMN_TIME_GENERATION . " is null + then 0 + else " . Piwik_Tracker_Action::DB_COLUMN_TIME_GENERATION . " + end + ) / 1000 as `" . Piwik_Archive::INDEX_PAGE_SUM_TIME_GENERATION . "`, + sum( + case when " . Piwik_Tracker_Action::DB_COLUMN_TIME_GENERATION . " is null + then 0 + else 1 + end + ) as `" . Piwik_Archive::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION . "`, + min(" . Piwik_Tracker_Action::DB_COLUMN_TIME_GENERATION . ") / 1000 + as `" . Piwik_Archive::INDEX_PAGE_MIN_TIME_GENERATION . "`, + max(" . Piwik_Tracker_Action::DB_COLUMN_TIME_GENERATION . ") / 1000 + as `" . Piwik_Archive::INDEX_PAGE_MAX_TIME_GENERATION . "` + "; + + $from = array( + "log_link_visit_action", + array( + "table" => "log_action", + "joinOn" => "log_link_visit_action.%s = log_action.idaction" + ) + ); + + $where = "log_link_visit_action.server_time >= ? + AND log_link_visit_action.server_time <= ? + AND log_link_visit_action.idsite = ? + AND log_link_visit_action.%s IS NOT NULL"; + + $groupBy = "log_action.idaction"; + $orderBy = "`" . Piwik_Archive::INDEX_PAGE_NB_HITS . "` DESC, name ASC"; + + $rankingQuery = false; + if ($rankingQueryLimit > 0) { + $rankingQuery = new Piwik_RankingQuery($rankingQueryLimit); + $rankingQuery->setOthersLabel(Piwik_DataTable::LABEL_SUMMARY_ROW); + $rankingQuery->addLabelColumn(array('idaction', 'name')); + $rankingQuery->addColumn(array('url_prefix', Piwik_Archive::INDEX_NB_UNIQ_VISITORS)); + $rankingQuery->addColumn(array(Piwik_Archive::INDEX_PAGE_NB_HITS, Piwik_Archive::INDEX_NB_VISITS), 'sum'); + if ($this->isSiteSearchEnabled()) { + $rankingQuery->addColumn(Piwik_Archive::INDEX_SITE_SEARCH_HAS_NO_RESULT, 'min'); + $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_IS_FOLLOWING_SITE_SEARCH_NB_HITS, 'sum'); + } + $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_SUM_TIME_GENERATION, 'sum'); + $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION, 'sum'); + $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_MIN_TIME_GENERATION, 'min'); + $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_MAX_TIME_GENERATION, 'max'); + $rankingQuery->partitionResultIntoMultipleGroups('type', array_keys($this->actionsTablesByType)); + } + + // Special Magic to get + // 1) No result Keywords + // 2) For each page view, count number of times the referrer page was a Site Search + if ($this->isSiteSearchEnabled()) { + $selectFlagNoResultKeywords = ", + CASE WHEN (MAX(log_link_visit_action.custom_var_v" . Piwik_Tracker_Action::CVAR_INDEX_SEARCH_COUNT . ") = 0 AND log_link_visit_action.custom_var_k" . Piwik_Tracker_Action::CVAR_INDEX_SEARCH_COUNT . " = '" . Piwik_Tracker_Action::CVAR_KEY_SEARCH_COUNT . "') THEN 1 ELSE 0 END AS `" . Piwik_Archive::INDEX_SITE_SEARCH_HAS_NO_RESULT . "`"; + + //we need an extra JOIN to know whether the referrer "idaction_name_ref" was a Site Search request + $from[] = array( + "table" => "log_action", + "tableAlias" => "log_action_name_ref", + "joinOn" => "log_link_visit_action.idaction_name_ref = log_action_name_ref.idaction" + ); + + $selectSiteSearchFollowingPages = ", + SUM(CASE WHEN log_action_name_ref.type = " . Piwik_Tracker_Action::TYPE_SITE_SEARCH . " THEN 1 ELSE 0 END) AS `" . Piwik_Archive::INDEX_PAGE_IS_FOLLOWING_SITE_SEARCH_NB_HITS . "`"; + + $select .= $selectFlagNoResultKeywords + . $selectSiteSearchFollowingPages; + } + + $this->archiveDayQueryProcess($select, $from, $where, $orderBy, $groupBy, "idaction_name", $rankingQuery); + + $this->archiveDayQueryProcess($select, $from, $where, $orderBy, $groupBy, "idaction_url", $rankingQuery); + } + + protected function isSiteSearchEnabled() + { + return $this->isSiteSearchEnabled; + } + + protected function archiveDayQueryProcess($select, $from, $where, $orderBy, $groupBy, $sprintfField, $rankingQuery = false) + { + // idaction field needs to be set in select clause before calling getSelectQuery(). + // if a complex segmentation join is needed, the field needs to be propagated + // to the outer select. therefore, $segment needs to know about it. + $select = sprintf($select, $sprintfField); + + $bind = array(); + + // get query with segmentation + $query = $this->getProcessor()->getSegment()->getSelectQuery( + $select, $from, $where, $bind, $orderBy, $groupBy); + + // extend bindings + $bind = array_merge(array($this->getProcessor()->getStartDatetimeUTC(), + $this->getProcessor()->getEndDatetimeUTC(), + $this->getProcessor()->idsite + ), + $query['bind'] + ); + + // replace the rest of the %s + $querySql = str_replace("%s", $sprintfField, $query['sql']); + + // apply ranking query + if ($rankingQuery) { + $querySql = $rankingQuery->generateQuery($querySql); + } + + // get result + $resultSet = $this->getProcessor()->db->query($querySql, $bind); + $modified = Piwik_Actions_ArchivingHelper::updateActionsTableWithRowQuery($resultSet, $sprintfField, $this->actionsTablesByType); + return $modified; + } + + /** + * Entry actions for Page URLs and Page names + */ + protected function archiveDayEntryActions($rankingQueryLimit) + { + $rankingQuery = false; + if ($rankingQueryLimit > 0) { + $rankingQuery = new Piwik_RankingQuery($rankingQueryLimit); + $rankingQuery->setOthersLabel(Piwik_DataTable::LABEL_SUMMARY_ROW); + $rankingQuery->addLabelColumn('idaction'); + $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS); + $rankingQuery->addColumn(array(Piwik_Archive::INDEX_PAGE_ENTRY_NB_VISITS, + Piwik_Archive::INDEX_PAGE_ENTRY_NB_ACTIONS, + Piwik_Archive::INDEX_PAGE_ENTRY_SUM_VISIT_LENGTH, + Piwik_Archive::INDEX_PAGE_ENTRY_BOUNCE_COUNT), 'sum'); + $rankingQuery->partitionResultIntoMultipleGroups('type', array_keys($this->actionsTablesByType)); + + $extraSelects = 'log_action.type, log_action.name,'; + $from = array( + "log_visit", + array( + "table" => "log_action", + "joinOn" => "log_visit.%s = log_action.idaction" + ) + ); + $orderBy = "`" . Piwik_Archive::INDEX_PAGE_ENTRY_NB_ACTIONS . "` DESC, log_action.name ASC"; + } else { + $extraSelects = false; + $from = "log_visit"; + $orderBy = false; + } + + $select = "log_visit.%s as idaction, $extraSelects + count(distinct log_visit.idvisitor) as `" . Piwik_Archive::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS . "`, + count(*) as `" . Piwik_Archive::INDEX_PAGE_ENTRY_NB_VISITS . "`, + sum(log_visit.visit_total_actions) as `" . Piwik_Archive::INDEX_PAGE_ENTRY_NB_ACTIONS . "`, + sum(log_visit.visit_total_time) as `" . Piwik_Archive::INDEX_PAGE_ENTRY_SUM_VISIT_LENGTH . "`, + sum(case log_visit.visit_total_actions when 1 then 1 when 0 then 1 else 0 end) as `" . Piwik_Archive::INDEX_PAGE_ENTRY_BOUNCE_COUNT . "`"; + + $where = "log_visit.visit_last_action_time >= ? + AND log_visit.visit_last_action_time <= ? + AND log_visit.idsite = ? + AND log_visit.%s > 0"; + + $groupBy = "log_visit.%s, idaction"; + + $this->archiveDayQueryProcess($select, $from, $where, $orderBy, $groupBy, "visit_entry_idaction_url", $rankingQuery); + + $this->archiveDayQueryProcess($select, $from, $where, $orderBy, $groupBy, "visit_entry_idaction_name", $rankingQuery); + } + + /** + * Exit actions + */ + public function archiveDayExitActions($rankingQueryLimit) + { + $rankingQuery = false; + if ($rankingQueryLimit > 0) { + $rankingQuery = new Piwik_RankingQuery($rankingQueryLimit); + $rankingQuery->setOthersLabel(Piwik_DataTable::LABEL_SUMMARY_ROW); + $rankingQuery->addLabelColumn('idaction'); + $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS); + $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_EXIT_NB_VISITS, 'sum'); + $rankingQuery->partitionResultIntoMultipleGroups('type', array_keys($this->actionsTablesByType)); + + $extraSelects = 'log_action.type, log_action.name,'; + $from = array( + "log_visit", + array( + "table" => "log_action", + "joinOn" => "log_visit.%s = log_action.idaction" + ) + ); + $orderBy = "`" . Piwik_Archive::INDEX_PAGE_EXIT_NB_VISITS . "` DESC, log_action.name ASC"; + } else { + $extraSelects = false; + $from = "log_visit"; + $orderBy = false; + } + + $select = "log_visit.%s as idaction, $extraSelects + count(distinct log_visit.idvisitor) as `" . Piwik_Archive::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS . "`, + count(*) as `" . Piwik_Archive::INDEX_PAGE_EXIT_NB_VISITS . "`"; + + $where = "log_visit.visit_last_action_time >= ? + AND log_visit.visit_last_action_time <= ? + AND log_visit.idsite = ? + AND log_visit.%s > 0"; + + $groupBy = "log_visit.%s, idaction"; + + $this->archiveDayQueryProcess($select, $from, $where, $orderBy, $groupBy, "visit_exit_idaction_url", $rankingQuery); + + $this->archiveDayQueryProcess($select, $from, $where, $orderBy, $groupBy, "visit_exit_idaction_name", $rankingQuery); + return array($rankingQuery, $extraSelects, $from, $orderBy, $select, $where, $groupBy); + } + + /** + * Time per action + */ + protected function archiveDayActionsTime($rankingQueryLimit) + { + $rankingQuery = false; + if ($rankingQueryLimit > 0) { + $rankingQuery = new Piwik_RankingQuery($rankingQueryLimit); + $rankingQuery->setOthersLabel(Piwik_DataTable::LABEL_SUMMARY_ROW); + $rankingQuery->addLabelColumn('idaction'); + $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_SUM_TIME_SPENT, 'sum'); + $rankingQuery->partitionResultIntoMultipleGroups('type', array_keys($this->actionsTablesByType)); + + $extraSelects = "log_action.type, log_action.name, count(*) as `" . Piwik_Archive::INDEX_PAGE_NB_HITS . "`,"; + $from = array( + "log_link_visit_action", + array( + "table" => "log_action", + "joinOn" => "log_link_visit_action.%s = log_action.idaction" + ) + ); + $orderBy = "`" . Piwik_Archive::INDEX_PAGE_NB_HITS . "` DESC, log_action.name ASC"; + } else { + $extraSelects = false; + $from = "log_link_visit_action"; + $orderBy = false; + } + + $select = "log_link_visit_action.%s as idaction, $extraSelects + sum(log_link_visit_action.time_spent_ref_action) as `" . Piwik_Archive::INDEX_PAGE_SUM_TIME_SPENT . "`"; + + $where = "log_link_visit_action.server_time >= ? + AND log_link_visit_action.server_time <= ? + AND log_link_visit_action.idsite = ? + AND log_link_visit_action.time_spent_ref_action > 0 + AND log_link_visit_action.%s > 0"; + + $groupBy = "log_link_visit_action.%s, idaction"; + + $this->archiveDayQueryProcess($select, $from, $where, $orderBy, $groupBy, "idaction_url_ref", $rankingQuery); + + $this->archiveDayQueryProcess($select, $from, $where, $orderBy, $groupBy, "idaction_name_ref", $rankingQuery); + } + + /** + * Records in the DB the archived reports for Page views, Downloads, Outlinks, and Page titles + */ + protected function recordDayReports() + { + Piwik_Actions_ArchivingHelper::clearActionsCache(); + + /** @var Piwik_DataTable $dataTable */ + $dataTable = $this->actionsTablesByType[Piwik_Tracker_Action::TYPE_ACTION_URL]; + self::deleteInvalidSummedColumnsFromDataTable($dataTable); + $s = $dataTable->getSerialized(Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation); + $this->getProcessor()->insertBlobRecord('Actions_actions_url', $s); + $this->getProcessor()->insertNumericRecord('Actions_nb_pageviews', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); + $this->getProcessor()->insertNumericRecord('Actions_nb_uniq_pageviews', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); + $this->getProcessor()->insertNumericRecord('Actions_sum_time_generation', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_SUM_TIME_GENERATION))); + $this->getProcessor()->insertNumericRecord('Actions_nb_hits_with_time_generation', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION))); + destroy($dataTable); + + $dataTable = $this->actionsTablesByType[Piwik_Tracker_Action::TYPE_DOWNLOAD]; + self::deleteInvalidSummedColumnsFromDataTable($dataTable); + $s = $dataTable->getSerialized(Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation); + $this->getProcessor()->insertBlobRecord('Actions_downloads', $s); + $this->getProcessor()->insertNumericRecord('Actions_nb_downloads', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); + $this->getProcessor()->insertNumericRecord('Actions_nb_uniq_downloads', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); + destroy($dataTable); + + $dataTable = $this->actionsTablesByType[Piwik_Tracker_Action::TYPE_OUTLINK]; + self::deleteInvalidSummedColumnsFromDataTable($dataTable); + $s = $dataTable->getSerialized(Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation); + $this->getProcessor()->insertBlobRecord('Actions_outlink', $s); + $this->getProcessor()->insertNumericRecord('Actions_nb_outlinks', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); + $this->getProcessor()->insertNumericRecord('Actions_nb_uniq_outlinks', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); + destroy($dataTable); + + $dataTable = $this->actionsTablesByType[Piwik_Tracker_Action::TYPE_ACTION_NAME]; + self::deleteInvalidSummedColumnsFromDataTable($dataTable); + $s = $dataTable->getSerialized(Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation); + $this->getProcessor()->insertBlobRecord('Actions_actions', $s); + destroy($dataTable); + + $dataTable = $this->actionsTablesByType[Piwik_Tracker_Action::TYPE_SITE_SEARCH]; + self::deleteInvalidSummedColumnsFromDataTable($dataTable); + $this->deleteUnusedColumnsFromKeywordsDataTable($dataTable); + $s = $dataTable->getSerialized(Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation); + $this->getProcessor()->insertBlobRecord('Actions_sitesearch', $s); + $this->getProcessor()->insertNumericRecord('Actions_nb_searches', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); + $this->getProcessor()->insertNumericRecord('Actions_nb_keywords', $dataTable->getRowsCount()); + destroy($dataTable); + + destroy($this->actionsTablesByType); + } + + /** + * For rows which have subtables (eg. directories with sub pages), + * deletes columns which don't make sense when all values of sub pages are summed. + * + * @param $dataTable Piwik_DataTable + */ + static public function deleteInvalidSummedColumnsFromDataTable($dataTable) + { + foreach ($dataTable->getRows() as $id => $row) { + if (($idSubtable = $row->getIdSubDataTable()) !== null + || $id === Piwik_DataTable::ID_SUMMARY_ROW + ) { + if ($idSubtable !== null) { + $subtable = Piwik_DataTable_Manager::getInstance()->getTable($idSubtable); + self::deleteInvalidSummedColumnsFromDataTable($subtable); + } + + if ($row instanceof Piwik_DataTable_Row_DataTableSummary) { + $row->recalculate(); + } + + foreach (self::$invalidSummedColumnNameToDeleteFromDayArchive as $name) { + $row->deleteColumn($name); + } + } + } + + // And this as well + self::removeEmptyColumns($dataTable); + } + + static protected function removeEmptyColumns($dataTable) + { + // Delete all columns that have a value of zero + $dataTable->filter('ColumnDelete', array( + $columnsToRemove = array(Piwik_Archive::INDEX_PAGE_IS_FOLLOWING_SITE_SEARCH_NB_HITS), + $columnsToKeep = array(), + $deleteIfZeroOnly = true + )); + } + + protected function deleteUnusedColumnsFromKeywordsDataTable($dataTable) + { + $columnsToDelete = array( + Piwik_Archive::INDEX_NB_UNIQ_VISITORS, + Piwik_Archive::INDEX_PAGE_IS_FOLLOWING_SITE_SEARCH_NB_HITS, + Piwik_Archive::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS, + Piwik_Archive::INDEX_PAGE_ENTRY_NB_ACTIONS, + Piwik_Archive::INDEX_PAGE_ENTRY_SUM_VISIT_LENGTH, + Piwik_Archive::INDEX_PAGE_ENTRY_NB_VISITS, + Piwik_Archive::INDEX_PAGE_ENTRY_BOUNCE_COUNT, + Piwik_Archive::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS, + ); + $dataTable->deleteColumns($columnsToDelete); + } + + public function archivePeriod() + { + Piwik_Actions_ArchivingHelper::reloadConfig(); + $dataTableToSum = array( + 'Actions_actions', + 'Actions_actions_url', + ); + $this->getProcessor()->archiveDataTable($dataTableToSum, + self::$invalidSummedColumnNameToRenamedNameFromPeriodArchive, + Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, + Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, + Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation, + self::$actionColumnAggregationOperations); + + $dataTableToSum = array( + 'Actions_downloads', + 'Actions_outlink', + 'Actions_sitesearch', + ); + $nameToCount = $this->getProcessor()->archiveDataTable($dataTableToSum, + self::$invalidSummedColumnNameToRenamedNameFromPeriodArchive, + Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, + Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, + Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation); + + $this->getProcessor()->archiveNumericValuesSum(array( + 'Actions_nb_pageviews', + 'Actions_nb_uniq_pageviews', + 'Actions_nb_downloads', + 'Actions_nb_uniq_downloads', + 'Actions_nb_outlinks', + 'Actions_nb_uniq_outlinks', + 'Actions_nb_searches', + 'Actions_sum_time_generation', + 'Actions_nb_hits_with_time_generation', + )); + + // Unique Keywords can't be summed, instead we take the RowsCount() of the keyword table + $this->getProcessor()->insertNumericRecord('Actions_nb_keywords', $nameToCount['Actions_sitesearch']['level0']); + } +} diff --git a/plugins/Actions/Archiving.php b/plugins/Actions/Archiving.php deleted file mode 100644 index be9e3b84c0..0000000000 --- a/plugins/Actions/Archiving.php +++ /dev/null @@ -1,589 +0,0 @@ - 'max', - Piwik_Archive::INDEX_PAGE_MIN_TIME_GENERATION => 'min' - ); - - static protected $invalidSummedColumnNameToRenamedNameFromPeriodArchive = array( - Piwik_Archive::INDEX_NB_UNIQ_VISITORS => Piwik_Archive::INDEX_SUM_DAILY_NB_UNIQ_VISITORS, - Piwik_Archive::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS => Piwik_Archive::INDEX_PAGE_ENTRY_SUM_DAILY_NB_UNIQ_VISITORS, - Piwik_Archive::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS => Piwik_Archive::INDEX_PAGE_EXIT_SUM_DAILY_NB_UNIQ_VISITORS, - ); - - static protected $invalidSummedColumnNameToDeleteFromDayArchive = array( - Piwik_Archive::INDEX_NB_UNIQ_VISITORS, - Piwik_Archive::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS, - Piwik_Archive::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS, - ); - - protected $isSiteSearchEnabled = false; - - function __construct($idSite) - { - $this->isSiteSearchEnabled = Piwik_Site::isSiteSearchEnabledFor($idSite); - } - - /** - * Archives Actions reports for a Period - * @param Piwik_ArchiveProcessing_Period $archiveProcessing - * @return bool - */ - public function archivePeriod(Piwik_ArchiveProcessing_Period $archiveProcessing) - { - Piwik_Actions_ArchivingHelper::reloadConfig(); - $dataTableToSum = array( - 'Actions_actions', - 'Actions_actions_url', - ); - $archiveProcessing->archiveDataTable($dataTableToSum, - self::$invalidSummedColumnNameToRenamedNameFromPeriodArchive, - Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, - Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, - Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation, - self::$actionColumnAggregationOperations); - - $dataTableToSum = array( - 'Actions_downloads', - 'Actions_outlink', - 'Actions_sitesearch', - ); - $nameToCount = $archiveProcessing->archiveDataTable($dataTableToSum, - self::$invalidSummedColumnNameToRenamedNameFromPeriodArchive, - Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, - Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, - Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation); - - $archiveProcessing->archiveNumericValuesSum(array( - 'Actions_nb_pageviews', - 'Actions_nb_uniq_pageviews', - 'Actions_nb_downloads', - 'Actions_nb_uniq_downloads', - 'Actions_nb_outlinks', - 'Actions_nb_uniq_outlinks', - 'Actions_nb_searches', - 'Actions_sum_time_generation', - 'Actions_nb_hits_with_time_generation', - )); - - // Unique Keywords can't be summed, instead we take the RowsCount() of the keyword table - $archiveProcessing->insertNumericRecord('Actions_nb_keywords', $nameToCount['Actions_sitesearch']['level0']); - return true; - } - - /** - * Archives Actions reports for a Day - * - * @param Piwik_ArchiveProcessing $archiveProcessing - * @return bool - */ - public function archiveDay(Piwik_ArchiveProcessing $archiveProcessing) - { - $rankingQueryLimit = self::getRankingQueryLimit(); - - // FIXME: This is a quick fix for #3482. The actual cause of the bug is that - // the site search & performance metrics additions to - // Piwik_Actions_ArchivingHelper::updateActionsTableWithRowQuery expect every - // row to have 'type' data, but not all of the SQL queries that are run w/o - // ranking query join on the log_action table and thus do not select the - // log_action.type column. - // - // NOTES: Archiving logic can be generalized as follows: - // 0) Do SQL query over log_link_visit_action & join on log_action to select - // some metrics (like visits, hits, etc.) - // 1) For each row, cache the action row & metrics. (This is done by - // updateActionsTableWithRowQuery for result set rows that have - // name & type columns.) - // 2) Do other SQL queries for metrics we can't put in the first query (like - // entry visits, exit vists, etc.) w/o joining log_action. - // 3) For each row, find the cached row by idaction & add the new metrics to - // it. (This is done by updateActionsTableWithRowQuery for result set rows - // that DO NOT have name & type columns.) - // - // The site search & performance metrics additions expect a 'type' all the time - // which breaks the original pre-rankingquery logic. Ranking query requires a - // join, so the bug is only seen when ranking query is disabled. - if ($rankingQueryLimit === 0) { - $rankingQueryLimit = 100000; - } - - Piwik_Actions_ArchivingHelper::reloadConfig(); - - $this->initActionsTables(); - $this->archiveDayActions($archiveProcessing, $rankingQueryLimit); - $this->archiveDayEntryActions($archiveProcessing, $rankingQueryLimit); - $this->archiveDayExitActions($archiveProcessing, $rankingQueryLimit); - $this->archiveDayActionsTime($archiveProcessing, $rankingQueryLimit); - - $this->recordDayReports($archiveProcessing); - - return true; - } - - /* - * Page URLs and Page names, general stats - */ - protected function archiveDayActions($archiveProcessing, $rankingQueryLimit) - { - $select = "log_action.name, - log_action.type, - log_action.idaction, - log_action.url_prefix, - count(distinct log_link_visit_action.idvisit) as `" . Piwik_Archive::INDEX_NB_VISITS . "`, - count(distinct log_link_visit_action.idvisitor) as `" . Piwik_Archive::INDEX_NB_UNIQ_VISITORS . "`, - count(*) as `" . Piwik_Archive::INDEX_PAGE_NB_HITS . "`, - sum( - case when " . Piwik_Tracker_Action::DB_COLUMN_TIME_GENERATION . " is null - then 0 - else " . Piwik_Tracker_Action::DB_COLUMN_TIME_GENERATION . " - end - ) / 1000 as `" . Piwik_Archive::INDEX_PAGE_SUM_TIME_GENERATION . "`, - sum( - case when " . Piwik_Tracker_Action::DB_COLUMN_TIME_GENERATION . " is null - then 0 - else 1 - end - ) as `" . Piwik_Archive::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION . "`, - min(" . Piwik_Tracker_Action::DB_COLUMN_TIME_GENERATION . ") / 1000 - as `" . Piwik_Archive::INDEX_PAGE_MIN_TIME_GENERATION . "`, - max(" . Piwik_Tracker_Action::DB_COLUMN_TIME_GENERATION . ") / 1000 - as `" . Piwik_Archive::INDEX_PAGE_MAX_TIME_GENERATION . "` - "; - - $from = array( - "log_link_visit_action", - array( - "table" => "log_action", - "joinOn" => "log_link_visit_action.%s = log_action.idaction" - ) - ); - - $where = "log_link_visit_action.server_time >= ? - AND log_link_visit_action.server_time <= ? - AND log_link_visit_action.idsite = ? - AND log_link_visit_action.%s IS NOT NULL"; - - $groupBy = "log_action.idaction"; - $orderBy = "`" . Piwik_Archive::INDEX_PAGE_NB_HITS . "` DESC, name ASC"; - - $rankingQuery = false; - if ($rankingQueryLimit > 0) { - $rankingQuery = new Piwik_RankingQuery($rankingQueryLimit); - $rankingQuery->setOthersLabel(Piwik_DataTable::LABEL_SUMMARY_ROW); - $rankingQuery->addLabelColumn(array('idaction', 'name')); - $rankingQuery->addColumn(array('url_prefix', Piwik_Archive::INDEX_NB_UNIQ_VISITORS)); - $rankingQuery->addColumn(array(Piwik_Archive::INDEX_PAGE_NB_HITS, Piwik_Archive::INDEX_NB_VISITS), 'sum'); - if ($this->isSiteSearchEnabled()) { - $rankingQuery->addColumn(Piwik_Archive::INDEX_SITE_SEARCH_HAS_NO_RESULT, 'min'); - $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_IS_FOLLOWING_SITE_SEARCH_NB_HITS, 'sum'); - } - $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_SUM_TIME_GENERATION, 'sum'); - $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION, 'sum'); - $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_MIN_TIME_GENERATION, 'min'); - $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_MAX_TIME_GENERATION, 'max'); - $rankingQuery->partitionResultIntoMultipleGroups('type', array_keys($this->actionsTablesByType)); - } - - // Special Magic to get - // 1) No result Keywords - // 2) For each page view, count number of times the referrer page was a Site Search - if ($this->isSiteSearchEnabled()) { - $selectFlagNoResultKeywords = ", - CASE WHEN (MAX(log_link_visit_action.custom_var_v" . Piwik_Tracker_Action::CVAR_INDEX_SEARCH_COUNT . ") = 0 AND log_link_visit_action.custom_var_k" . Piwik_Tracker_Action::CVAR_INDEX_SEARCH_COUNT . " = '" . Piwik_Tracker_Action::CVAR_KEY_SEARCH_COUNT . "') THEN 1 ELSE 0 END AS `" . Piwik_Archive::INDEX_SITE_SEARCH_HAS_NO_RESULT . "`"; - - //we need an extra JOIN to know whether the referrer "idaction_name_ref" was a Site Search request - $from[] = array( - "table" => "log_action", - "tableAlias" => "log_action_name_ref", - "joinOn" => "log_link_visit_action.idaction_name_ref = log_action_name_ref.idaction" - ); - - $selectSiteSearchFollowingPages = ", - SUM(CASE WHEN log_action_name_ref.type = " . Piwik_Tracker_Action::TYPE_SITE_SEARCH . " THEN 1 ELSE 0 END) AS `" . Piwik_Archive::INDEX_PAGE_IS_FOLLOWING_SITE_SEARCH_NB_HITS . "`"; - - $select .= $selectFlagNoResultKeywords - . $selectSiteSearchFollowingPages; - } - - $this->archiveDayQueryProcess($select, $from, $where, $orderBy, $groupBy, - "idaction_name", $archiveProcessing, $rankingQuery); - - $this->archiveDayQueryProcess($select, $from, $where, $orderBy, $groupBy, - "idaction_url", $archiveProcessing, $rankingQuery); - } - - /** - * Entry actions for Page URLs and Page names - */ - protected function archiveDayEntryActions($archiveProcessing, $rankingQueryLimit) - { - $rankingQuery = false; - if ($rankingQueryLimit > 0) { - $rankingQuery = new Piwik_RankingQuery($rankingQueryLimit); - $rankingQuery->setOthersLabel(Piwik_DataTable::LABEL_SUMMARY_ROW); - $rankingQuery->addLabelColumn('idaction'); - $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS); - $rankingQuery->addColumn(array(Piwik_Archive::INDEX_PAGE_ENTRY_NB_VISITS, - Piwik_Archive::INDEX_PAGE_ENTRY_NB_ACTIONS, - Piwik_Archive::INDEX_PAGE_ENTRY_SUM_VISIT_LENGTH, - Piwik_Archive::INDEX_PAGE_ENTRY_BOUNCE_COUNT), 'sum'); - $rankingQuery->partitionResultIntoMultipleGroups('type', array_keys($this->actionsTablesByType)); - - $extraSelects = 'log_action.type, log_action.name,'; - $from = array( - "log_visit", - array( - "table" => "log_action", - "joinOn" => "log_visit.%s = log_action.idaction" - ) - ); - $orderBy = "`" . Piwik_Archive::INDEX_PAGE_ENTRY_NB_ACTIONS . "` DESC, log_action.name ASC"; - } else { - $extraSelects = false; - $from = "log_visit"; - $orderBy = false; - } - - $select = "log_visit.%s as idaction, $extraSelects - count(distinct log_visit.idvisitor) as `" . Piwik_Archive::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS . "`, - count(*) as `" . Piwik_Archive::INDEX_PAGE_ENTRY_NB_VISITS . "`, - sum(log_visit.visit_total_actions) as `" . Piwik_Archive::INDEX_PAGE_ENTRY_NB_ACTIONS . "`, - sum(log_visit.visit_total_time) as `" . Piwik_Archive::INDEX_PAGE_ENTRY_SUM_VISIT_LENGTH . "`, - sum(case log_visit.visit_total_actions when 1 then 1 when 0 then 1 else 0 end) as `" . Piwik_Archive::INDEX_PAGE_ENTRY_BOUNCE_COUNT . "`"; - - $where = "log_visit.visit_last_action_time >= ? - AND log_visit.visit_last_action_time <= ? - AND log_visit.idsite = ? - AND log_visit.%s > 0"; - - $groupBy = "log_visit.%s, idaction"; - - $this->archiveDayQueryProcess($select, $from, $where, $orderBy, $groupBy, - "visit_entry_idaction_url", $archiveProcessing, $rankingQuery); - - $this->archiveDayQueryProcess($select, $from, $where, $orderBy, $groupBy, - "visit_entry_idaction_name", $archiveProcessing, $rankingQuery); - } - - /** - * Time per action - */ - protected function archiveDayActionsTime($archiveProcessing, $rankingQueryLimit) - { - $rankingQuery = false; - if ($rankingQueryLimit > 0) { - $rankingQuery = new Piwik_RankingQuery($rankingQueryLimit); - $rankingQuery->setOthersLabel(Piwik_DataTable::LABEL_SUMMARY_ROW); - $rankingQuery->addLabelColumn('idaction'); - $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_SUM_TIME_SPENT, 'sum'); - $rankingQuery->partitionResultIntoMultipleGroups('type', array_keys($this->actionsTablesByType)); - - $extraSelects = "log_action.type, log_action.name, count(*) as `" . Piwik_Archive::INDEX_PAGE_NB_HITS . "`,"; - $from = array( - "log_link_visit_action", - array( - "table" => "log_action", - "joinOn" => "log_link_visit_action.%s = log_action.idaction" - ) - ); - $orderBy = "`" . Piwik_Archive::INDEX_PAGE_NB_HITS . "` DESC, log_action.name ASC"; - } else { - $extraSelects = false; - $from = "log_link_visit_action"; - $orderBy = false; - } - - $select = "log_link_visit_action.%s as idaction, $extraSelects - sum(log_link_visit_action.time_spent_ref_action) as `" . Piwik_Archive::INDEX_PAGE_SUM_TIME_SPENT . "`"; - - $where = "log_link_visit_action.server_time >= ? - AND log_link_visit_action.server_time <= ? - AND log_link_visit_action.idsite = ? - AND log_link_visit_action.time_spent_ref_action > 0 - AND log_link_visit_action.%s > 0"; - - $groupBy = "log_link_visit_action.%s, idaction"; - - $this->archiveDayQueryProcess($select, $from, $where, $orderBy, $groupBy, - "idaction_url_ref", $archiveProcessing, $rankingQuery); - - $this->archiveDayQueryProcess($select, $from, $where, $orderBy, $groupBy, - "idaction_name_ref", $archiveProcessing, $rankingQuery); - } - - /** - * Exit actions - */ - public function archiveDayExitActions($archiveProcessing, $rankingQueryLimit) - { - $rankingQuery = false; - if ($rankingQueryLimit > 0) { - $rankingQuery = new Piwik_RankingQuery($rankingQueryLimit); - $rankingQuery->setOthersLabel(Piwik_DataTable::LABEL_SUMMARY_ROW); - $rankingQuery->addLabelColumn('idaction'); - $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS); - $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_EXIT_NB_VISITS, 'sum'); - $rankingQuery->partitionResultIntoMultipleGroups('type', array_keys($this->actionsTablesByType)); - - $extraSelects = 'log_action.type, log_action.name,'; - $from = array( - "log_visit", - array( - "table" => "log_action", - "joinOn" => "log_visit.%s = log_action.idaction" - ) - ); - $orderBy = "`" . Piwik_Archive::INDEX_PAGE_EXIT_NB_VISITS . "` DESC, log_action.name ASC"; - } else { - $extraSelects = false; - $from = "log_visit"; - $orderBy = false; - } - - $select = "log_visit.%s as idaction, $extraSelects - count(distinct log_visit.idvisitor) as `" . Piwik_Archive::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS . "`, - count(*) as `" . Piwik_Archive::INDEX_PAGE_EXIT_NB_VISITS . "`"; - - $where = "log_visit.visit_last_action_time >= ? - AND log_visit.visit_last_action_time <= ? - AND log_visit.idsite = ? - AND log_visit.%s > 0"; - - $groupBy = "log_visit.%s, idaction"; - - $this->archiveDayQueryProcess($select, $from, $where, $orderBy, $groupBy, - "visit_exit_idaction_url", $archiveProcessing, $rankingQuery); - - $this->archiveDayQueryProcess($select, $from, $where, $orderBy, $groupBy, - "visit_exit_idaction_name", $archiveProcessing, $rankingQuery); - return array($rankingQuery, $extraSelects, $from, $orderBy, $select, $where, $groupBy); - } - - - /** - * Records in the DB the archived reports for Page views, Downloads, Outlinks, and Page titles - * - * @param $archiveProcessing - */ - protected function recordDayReports($archiveProcessing) - { - Piwik_Actions_ArchivingHelper::clearActionsCache(); - - /** @var Piwik_DataTable $dataTable */ - $dataTable = $this->actionsTablesByType[Piwik_Tracker_Action::TYPE_ACTION_URL]; - self::deleteInvalidSummedColumnsFromDataTable($dataTable); - $s = $dataTable->getSerialized(Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation); - $archiveProcessing->insertBlobRecord('Actions_actions_url', $s); - $archiveProcessing->insertNumericRecord('Actions_nb_pageviews', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); - $archiveProcessing->insertNumericRecord('Actions_nb_uniq_pageviews', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); - $archiveProcessing->insertNumericRecord('Actions_sum_time_generation', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_SUM_TIME_GENERATION))); - $archiveProcessing->insertNumericRecord('Actions_nb_hits_with_time_generation', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION))); - destroy($dataTable); - - $dataTable = $this->actionsTablesByType[Piwik_Tracker_Action::TYPE_DOWNLOAD]; - self::deleteInvalidSummedColumnsFromDataTable($dataTable); - $s = $dataTable->getSerialized(Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation); - $archiveProcessing->insertBlobRecord('Actions_downloads', $s); - $archiveProcessing->insertNumericRecord('Actions_nb_downloads', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); - $archiveProcessing->insertNumericRecord('Actions_nb_uniq_downloads', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); - destroy($dataTable); - - $dataTable = $this->actionsTablesByType[Piwik_Tracker_Action::TYPE_OUTLINK]; - self::deleteInvalidSummedColumnsFromDataTable($dataTable); - $s = $dataTable->getSerialized(Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation); - $archiveProcessing->insertBlobRecord('Actions_outlink', $s); - $archiveProcessing->insertNumericRecord('Actions_nb_outlinks', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); - $archiveProcessing->insertNumericRecord('Actions_nb_uniq_outlinks', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); - destroy($dataTable); - - $dataTable = $this->actionsTablesByType[Piwik_Tracker_Action::TYPE_ACTION_NAME]; - self::deleteInvalidSummedColumnsFromDataTable($dataTable); - $s = $dataTable->getSerialized(Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation); - $archiveProcessing->insertBlobRecord('Actions_actions', $s); - destroy($dataTable); - - $dataTable = $this->actionsTablesByType[Piwik_Tracker_Action::TYPE_SITE_SEARCH]; - self::deleteInvalidSummedColumnsFromDataTable($dataTable); - $this->deleteUnusedColumnsFromKeywordsDataTable($dataTable); - $s = $dataTable->getSerialized(Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation); - $archiveProcessing->insertBlobRecord('Actions_sitesearch', $s); - $archiveProcessing->insertNumericRecord('Actions_nb_searches', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); - $archiveProcessing->insertNumericRecord('Actions_nb_keywords', $dataTable->getRowsCount()); - destroy($dataTable); - - destroy($this->actionsTablesByType); - } - - protected function deleteUnusedColumnsFromKeywordsDataTable($dataTable) - { - $columnsToDelete = array( - Piwik_Archive::INDEX_NB_UNIQ_VISITORS, - Piwik_Archive::INDEX_PAGE_IS_FOLLOWING_SITE_SEARCH_NB_HITS, - Piwik_Archive::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS, - Piwik_Archive::INDEX_PAGE_ENTRY_NB_ACTIONS, - Piwik_Archive::INDEX_PAGE_ENTRY_SUM_VISIT_LENGTH, - Piwik_Archive::INDEX_PAGE_ENTRY_NB_VISITS, - Piwik_Archive::INDEX_PAGE_ENTRY_BOUNCE_COUNT, - Piwik_Archive::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS, - ); - $dataTable->deleteColumns($columnsToDelete); - } - - static protected function removeEmptyColumns($dataTable) - { - // Delete all columns that have a value of zero - $dataTable->filter('ColumnDelete', array( - $columnsToRemove = array(Piwik_Archive::INDEX_PAGE_IS_FOLLOWING_SITE_SEARCH_NB_HITS), - $columnsToKeep = array(), - $deleteIfZeroOnly = true - )); - } - - - /** - * Returns the limit to use with RankingQuery for this plugin. - * - * @return int - */ - private static function getRankingQueryLimit() - { - $configGeneral = Piwik_Config::getInstance()->General; - $configLimit = $configGeneral['archiving_ranking_query_row_limit']; - return $configLimit == 0 ? 0 : max( - $configLimit, - $configGeneral['datatable_archiving_maximum_rows_actions'], - $configGeneral['datatable_archiving_maximum_rows_subtable_actions'] - ); - } - - - /** - * @param $select - * @param $from - * @param $where - * @param $orderBy - * @param $groupBy - * @param $sprintfField - * @param Piwik_ArchiveProcessing $archiveProcessing - * @param Piwik_RankingQuery|false $rankingQuery - * @return int - */ - protected function archiveDayQueryProcess($select, $from, $where, $orderBy, $groupBy, - $sprintfField, $archiveProcessing, $rankingQuery = false) - { - // idaction field needs to be set in select clause before calling getSelectQuery(). - // if a complex segmentation join is needed, the field needs to be propagated - // to the outer select. therefore, $segment needs to know about it. - $select = sprintf($select, $sprintfField); - - $bind = array(); - - // get query with segmentation - $query = $archiveProcessing->getSegment()->getSelectQuery( - $select, $from, $where, $bind, $orderBy, $groupBy); - - // extend bindings - $bind = array_merge(array($archiveProcessing->getStartDatetimeUTC(), - $archiveProcessing->getEndDatetimeUTC(), - $archiveProcessing->idsite - ), - $query['bind'] - ); - - // replace the rest of the %s - $querySql = str_replace("%s", $sprintfField, $query['sql']); - - // apply ranking query - if ($rankingQuery) { - $querySql = $rankingQuery->generateQuery($querySql); - } - - // get result - $resultSet = $archiveProcessing->db->query($querySql, $bind); - $modified = Piwik_Actions_ArchivingHelper::updateActionsTableWithRowQuery($resultSet, $sprintfField, $this->actionsTablesByType); - return $modified; - } - - - /** - * For rows which have subtables (eg. directories with sub pages), - * deletes columns which don't make sense when all values of sub pages are summed. - * - * @param $dataTable Piwik_DataTable - */ - static public function deleteInvalidSummedColumnsFromDataTable($dataTable) - { - foreach ($dataTable->getRows() as $id => $row) { - if (($idSubtable = $row->getIdSubDataTable()) !== null - || $id === Piwik_DataTable::ID_SUMMARY_ROW - ) { - if ($idSubtable !== null) { - $subtable = Piwik_DataTable_Manager::getInstance()->getTable($idSubtable); - self::deleteInvalidSummedColumnsFromDataTable($subtable); - } - - if ($row instanceof Piwik_DataTable_Row_DataTableSummary) { - $row->recalculate(); - } - - foreach (self::$invalidSummedColumnNameToDeleteFromDayArchive as $name) { - $row->deleteColumn($name); - } - } - } - - // And this as well - self::removeEmptyColumns($dataTable); - } - - /** - * Initializes the DataTables created by the archiveDay function. - */ - private function initActionsTables() - { - $this->actionsTablesByType = array(); - foreach (self::$actionTypes as $type) { - $dataTable = new Piwik_DataTable(); - $dataTable->setMaximumAllowedRows(Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero); - - if ($type == Piwik_Tracker_Action::TYPE_ACTION_URL - || $type == Piwik_Tracker_Action::TYPE_ACTION_NAME) { - // for page urls and page titles, performance metrics exist and have to be aggregated correctly - $dataTable->setColumnAggregationOperations(self::$actionColumnAggregationOperations); - } - - $this->actionsTablesByType[$type] = $dataTable; - } - } - - protected function isSiteSearchEnabled() - { - return $this->isSiteSearchEnabled; - } -} diff --git a/plugins/Actions/ArchivingHelper.php b/plugins/Actions/ArchivingHelper.php index e5773d96e6..170e7c84f1 100644 --- a/plugins/Actions/ArchivingHelper.php +++ b/plugins/Actions/ArchivingHelper.php @@ -22,7 +22,7 @@ class Piwik_Actions_ArchivingHelper const OTHERS_ROW_KEY = ''; /** - * FIXME See FIXME related to this function at Piwik_Actions_Archiving::archiveDay. + * FIXME See FIXME related to this function at Piwik_Actions_Archiver::archiveDay. * * @param Zend_Db_Statement|PDOStatement $query * @param string|bool $fieldQueried diff --git a/plugins/CustomVariables/API.php b/plugins/CustomVariables/API.php index 282406e679..abdbfb80f1 100644 --- a/plugins/CustomVariables/API.php +++ b/plugins/CustomVariables/API.php @@ -106,7 +106,7 @@ class Piwik_CustomVariables_API $dataTable->renameColumn('price_viewed', 'price'); } $dataTable->queueFilter('ColumnCallbackReplace', array('label', create_function('$label', ' - return $label == Piwik_CustomVariables_Archiving::LABEL_CUSTOM_VALUE_NOT_DEFINED + return $label == Piwik_CustomVariables_Archiver::LABEL_CUSTOM_VALUE_NOT_DEFINED ? "' . Piwik_Translate('General_NotDefined', Piwik_Translate('CustomVariables_ColumnCustomVariableValue')) . '" : $label;'))); return $dataTable; diff --git a/plugins/CustomVariables/Archiver.php b/plugins/CustomVariables/Archiver.php new file mode 100644 index 0000000000..2aab034424 --- /dev/null +++ b/plugins/CustomVariables/Archiver.php @@ -0,0 +1,224 @@ +maximumRowsInDataTableLevelZero = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_custom_variables']; + $this->maximumRowsInSubDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_subtable_custom_variables']; + } + + public function archiveDay() + { + for ($i = 1; $i <= Piwik_Tracker::MAX_CUSTOM_VARIABLES; $i++) { + $this->aggregateCustomVariable($i); + } + + $this->removeVisitsMetricsFromActionsAggregate(); + $this->getProcessor()->enrichConversionsByLabelArray($this->metricsByKey); + $this->getProcessor()->enrichConversionsByLabelArrayHasTwoLevels($this->metricsByKeyAndValue); + + $table = $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByKeyAndValue, $this->metricsByKey); + $blob = $table->getSerialized( + $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, + $columnToSort = Piwik_Archive::INDEX_NB_VISITS + ); + + $this->getProcessor()->insertBlobRecord(self::BLOB_NAME, $blob); + } + + protected function aggregateCustomVariable($slot) + { + $keyField = "custom_var_k" . $slot; + $valueField = "custom_var_v" . $slot; + $where = "%s.$keyField != ''"; + $dimensions = array($keyField, $valueField); + + $query = $this->getProcessor()->queryVisitsByDimension($dimensions, $where); + $this->aggregateFromVisits($query, $keyField, $valueField); + + $query = $this->getProcessor()->queryActionsByDimension($dimensions, $where); + $this->aggregateFromActions($query, $keyField, $valueField); + + $query = $this->getProcessor()->queryConversionsByDimension($dimensions, $where); + $this->aggregateFromConversions($query, $keyField, $valueField); + } + + protected function aggregateFromVisits($query, $keyField, $valueField) + { + while ($row = $query->fetch()) { + $value = $row[$valueField]; + $value = $this->cleanCustomVarValue($value); + + $key = $row[$keyField]; + $this->aggregateVisit($key, $value, $row); + } + } + + protected function cleanCustomVarValue($value) + { + if (strlen($value)) { + return $value; + } + return self::LABEL_CUSTOM_VALUE_NOT_DEFINED; + } + + protected function aggregateVisit($key, $value, $row) + { + if (!isset($this->metricsByKey[$key])) { + $this->metricsByKey[$key] = $this->getProcessor()->makeEmptyRow(); + } + if (!isset($this->metricsByKeyAndValue[$key][$value])) { + $this->metricsByKeyAndValue[$key][$value] = $this->getProcessor()->makeEmptyRow(); + } + + $this->getProcessor()->sumMetrics($row, $this->metricsByKey[$key]); + $this->getProcessor()->sumMetrics($row, $this->metricsByKeyAndValue[$key][$value]); + } + + protected function aggregateFromActions($query, $keyField, $valueField) + { + while ($row = $query->fetch()) { + $key = $row[$keyField]; + $value = $row[$valueField]; + $value = $this->cleanCustomVarValue($value); + $this->aggregateAction($key, $value, $row); + } + } + + protected function aggregateAction($key, $value, $row) + { + $alreadyAggregated = $this->aggregateEcommerceCategories($key, $value, $row); + if (!$alreadyAggregated) { + $this->aggregateActionByKeyAndValue($key, $value, $row); + $this->aggregateActionByKey($key, $row); + } + } + + /** + * @return bool True if the $row metrics were already added to the ->metrics + */ + protected function aggregateEcommerceCategories($key, $value, $row) + { + $ecommerceCategoriesAggregated = false; + if ($key == '_pkc' + && $value[0] == '[' && $value[1] == '"' + ) { + // In case categories were truncated, try closing the array + if (substr($value, -2) != '"]') { + $value .= '"]'; + } + $decoded = @Piwik_Common::json_decode($value); + if (is_array($decoded)) { + $count = 0; + foreach ($decoded as $category) { + if (empty($category) + || $count >= Piwik_Tracker_GoalManager::MAXIMUM_PRODUCT_CATEGORIES + ) { + continue; + } + $this->aggregateActionByKeyAndValue($key, $category, $row); + $ecommerceCategoriesAggregated = true; + $count++; + } + } + } + return $ecommerceCategoriesAggregated; + } + + protected function aggregateActionByKeyAndValue($key, $value, $row) + { + if (!isset($this->metricsByKeyAndValue[$key][$value])) { + $this->metricsByKeyAndValue[$key][$value] = $this->getProcessor()->makeEmptyActionRow(); + } + $this->getProcessor()->sumMetrics($row, $this->metricsByKeyAndValue[$key][$value], $onlyMetricsAvailableInActionsTable = true); + + if ($this->isReservedKey($key)) { + // Price tracking on Ecommerce product/category pages: + // the average is returned from the SQL query so the price is not "summed" like other metrics + $index = Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED; + if (!empty($row[$index])) { + $this->metricsByKeyAndValue[$key][$value][$index] = (float)$row[$index]; + } + } + } + + protected static function isReservedKey($key) + { + return in_array($key, Piwik_CustomVariables_API::getReservedCustomVariableKeys()); + } + + protected function aggregateActionByKey($key, $row) + { + if (!isset($this->metricsByKey[$key])) { + $this->metricsByKey[$key] = $this->getProcessor()->makeEmptyActionRow(); + } + $this->getProcessor()->sumMetrics($row, $this->metricsByKey[$key], $onlyMetricsAvailableInActionsTable = true); + } + + protected function aggregateFromConversions($query, $keyField, $valueField) + { + if ($query === false) { + return; + } + while ($row = $query->fetch()) { + $key = $row[$keyField]; + $value = $this->cleanCustomVarValue($row[$valueField]); + $idGoal = $row['idgoal']; + $this->aggregateConversion($key, $value, $idGoal, $row); + } + } + + protected function aggregateConversion($key, $value, $idGoal, $row) + { + if (!isset($this->metricsByKey[$key][Piwik_Archive::INDEX_GOALS][$idGoal])) { + $this->metricsByKey[$key][Piwik_Archive::INDEX_GOALS][$idGoal] = $this->getProcessor()->makeEmptyGoalRow($idGoal); + } + if (!isset($this->metricsByKeyAndValue[$key][$value][Piwik_Archive::INDEX_GOALS][$idGoal])) { + $this->metricsByKeyAndValue[$key][$value][Piwik_Archive::INDEX_GOALS][$idGoal] = $this->getProcessor()->makeEmptyGoalRow($idGoal); + } + + $this->getProcessor()->sumGoalMetrics($row, $this->metricsByKey[$key][Piwik_Archive::INDEX_GOALS][$idGoal]); + $this->getProcessor()->sumGoalMetrics($row, $this->metricsByKeyAndValue[$key][$value][Piwik_Archive::INDEX_GOALS][$idGoal]); + } + + protected function removeVisitsMetricsFromActionsAggregate() + { + $emptyActionRow = $this->getProcessor()->makeEmptyActionRow(); + + foreach ($this->metricsByKey as $key => &$row) { + $isActionRowAggregate = (count($row) == count($emptyActionRow)); + if (!self::isReservedKey($key) + && $isActionRowAggregate + ) { + unset($row[Piwik_Archive::INDEX_NB_UNIQ_VISITORS]); + unset($row[Piwik_Archive::INDEX_NB_VISITS]); + } + } + } + + public function archivePeriod() + { + $nameToCount = $this->getProcessor()->archiveDataTable( + self::BLOB_NAME, null, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, + $columnToSort = Piwik_Archive::INDEX_NB_VISITS); + } +} \ No newline at end of file diff --git a/plugins/CustomVariables/Archiving.php b/plugins/CustomVariables/Archiving.php deleted file mode 100644 index e209dd6d2c..0000000000 --- a/plugins/CustomVariables/Archiving.php +++ /dev/null @@ -1,233 +0,0 @@ -maximumRowsInDataTableLevelZero = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_custom_variables']; - $this->maximumRowsInSubDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_subtable_custom_variables']; - } - - public function archiveDay(Piwik_ArchiveProcessing_Day $archiveProcessing) - { - for ($i = 1; $i <= Piwik_Tracker::MAX_CUSTOM_VARIABLES; $i++) { - $this->aggregateCustomVariable($archiveProcessing, $i); - } - - $this->removeVisitsMetricsFromActionsAggregate($archiveProcessing); - $archiveProcessing->enrichConversionsByLabelArray($this->metricsByKey); - $archiveProcessing->enrichConversionsByLabelArrayHasTwoLevels($this->metricsByKeyAndValue); - - $table = $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByKeyAndValue, $this->metricsByKey); - $blob = $table->getSerialized( - $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, - $columnToSort = Piwik_Archive::INDEX_NB_VISITS - ); - - $archiveProcessing->insertBlobRecord(self::BLOB_NAME, $blob); - } - - /** - * @param Piwik_ArchiveProcessing_Day $archiveProcessing - * @param $slot - */ - protected function aggregateCustomVariable(Piwik_ArchiveProcessing_Day $archiveProcessing, $slot) - { - $keyField = "custom_var_k" . $slot; - $valueField = "custom_var_v" . $slot; - $where = "%s.$keyField != ''"; - $dimensions = array($keyField, $valueField); - - $query = $archiveProcessing->queryVisitsByDimension($dimensions, $where); - $this->aggregateFromVisits($archiveProcessing, $query, $keyField, $valueField); - - $query = $archiveProcessing->queryActionsByDimension($dimensions, $where); - $this->aggregateFromActions($archiveProcessing, $query, $keyField, $valueField); - - $query = $archiveProcessing->queryConversionsByDimension($dimensions, $where); - $this->aggregateFromConversions($archiveProcessing, $query, $keyField, $valueField); - } - - protected function aggregateFromVisits(Piwik_ArchiveProcessing_Day $archiveProcessing, $query, $keyField, $valueField) - { - while ($row = $query->fetch()) { - $value = $row[$valueField]; - $value = $this->cleanCustomVarValue($value); - - $key = $row[$keyField]; - $this->aggregateVisit($archiveProcessing, $key, $value, $row); - } - } - - protected function cleanCustomVarValue($value) - { - if (strlen($value)) { - return $value; - } - return self::LABEL_CUSTOM_VALUE_NOT_DEFINED; - } - - protected function aggregateVisit(Piwik_ArchiveProcessing_Day $archiveProcessing, $key, $value, $row) - { - if (!isset($this->metricsByKey[$key])) { - $this->metricsByKey[$key] = $archiveProcessing->makeEmptyRow(); - } - if (!isset($this->metricsByKeyAndValue[$key][$value])) { - $this->metricsByKeyAndValue[$key][$value] = $archiveProcessing->makeEmptyRow(); - } - - $archiveProcessing->sumMetrics($row, $this->metricsByKey[$key]); - $archiveProcessing->sumMetrics($row, $this->metricsByKeyAndValue[$key][$value]); - } - - protected function aggregateFromActions(Piwik_ArchiveProcessing_Day $archiveProcessing, $query, $keyField, $valueField) - { - while ($row = $query->fetch()) { - $key = $row[$keyField]; - $value = $row[$valueField]; - $value = $this->cleanCustomVarValue($value); - $this->aggregateAction($archiveProcessing, $key, $value, $row); - } - } - - protected function aggregateAction(Piwik_ArchiveProcessing_Day $archiveProcessing, $key, $value, $row) - { - $alreadyAggregated = $this->aggregateEcommerceCategories($archiveProcessing, $key, $value, $row); - if (!$alreadyAggregated) { - $this->aggregateActionByKeyAndValue($archiveProcessing, $key, $value, $row); - $this->aggregateActionByKey($archiveProcessing, $key, $row); - } - } - - /** - * @return bool True if the $row metrics were already added to the ->metrics - */ - protected function aggregateEcommerceCategories(Piwik_ArchiveProcessing_Day $archiveProcessing, $key, $value, $row) - { - $ecommerceCategoriesAggregated = false; - if ($key == '_pkc' - && $value[0] == '[' && $value[1] == '"' - ) { - // In case categories were truncated, try closing the array - if (substr($value, -2) != '"]') { - $value .= '"]'; - } - $decoded = @Piwik_Common::json_decode($value); - if (is_array($decoded)) { - $count = 0; - foreach ($decoded as $category) { - if (empty($category) - || $count >= Piwik_Tracker_GoalManager::MAXIMUM_PRODUCT_CATEGORIES - ) { - continue; - } - $this->aggregateActionByKeyAndValue($archiveProcessing, $key, $category, $row); - $ecommerceCategoriesAggregated = true; - $count++; - } - } - } - return $ecommerceCategoriesAggregated; - } - - protected function aggregateActionByKeyAndValue(Piwik_ArchiveProcessing_Day $archiveProcessing, $key, $value, $row) - { - if (!isset($this->metricsByKeyAndValue[$key][$value])) { - $this->metricsByKeyAndValue[$key][$value] = $archiveProcessing->makeEmptyActionRow(); - } - $archiveProcessing->sumMetrics($row, $this->metricsByKeyAndValue[$key][$value], $onlyMetricsAvailableInActionsTable = true); - - if ($this->isReservedKey($key)) { - // Price tracking on Ecommerce product/category pages: - // the average is returned from the SQL query so the price is not "summed" like other metrics - $index = Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED; - if (!empty($row[$index])) { - $this->metricsByKeyAndValue[$key][$value][$index] = (float)$row[$index]; - } - } - } - - protected static function isReservedKey($key) - { - return in_array($key, Piwik_CustomVariables_API::getReservedCustomVariableKeys()); - } - - /** - * @param Piwik_ArchiveProcessing_Day $archiveProcessing - * @param $key - * @param $row - */ - protected function aggregateActionByKey(Piwik_ArchiveProcessing_Day $archiveProcessing, $key, $row) - { - if (!isset($this->metricsByKey[$key])) { - $this->metricsByKey[$key] = $archiveProcessing->makeEmptyActionRow(); - } - $archiveProcessing->sumMetrics($row, $this->metricsByKey[$key], $onlyMetricsAvailableInActionsTable = true); - } - - protected function aggregateFromConversions(Piwik_ArchiveProcessing_Day $archiveProcessing, $query, $keyField, $valueField) - { - if ($query === false) { - return; - } - while ($row = $query->fetch()) { - $key = $row[$keyField]; - $value = $this->cleanCustomVarValue($row[$valueField]); - $idGoal = $row['idgoal']; - $this->aggregateConversion($archiveProcessing, $key, $value, $idGoal, $row); - } - } - - protected function aggregateConversion(Piwik_ArchiveProcessing_Day $archiveProcessing, $key, $value, $idGoal, $row) - { - if (!isset($this->metricsByKey[$key][Piwik_Archive::INDEX_GOALS][$idGoal])) { - $this->metricsByKey[$key][Piwik_Archive::INDEX_GOALS][$idGoal] = $archiveProcessing->makeEmptyGoalRow($idGoal); - } - if (!isset($this->metricsByKeyAndValue[$key][$value][Piwik_Archive::INDEX_GOALS][$idGoal])) { - $this->metricsByKeyAndValue[$key][$value][Piwik_Archive::INDEX_GOALS][$idGoal] = $archiveProcessing->makeEmptyGoalRow($idGoal); - } - - $archiveProcessing->sumGoalMetrics($row, $this->metricsByKey[$key][Piwik_Archive::INDEX_GOALS][$idGoal]); - $archiveProcessing->sumGoalMetrics($row, $this->metricsByKeyAndValue[$key][$value][Piwik_Archive::INDEX_GOALS][$idGoal]); - } - - protected function removeVisitsMetricsFromActionsAggregate(Piwik_ArchiveProcessing_Day $archiveProcessing) - { - $emptyActionRow = $archiveProcessing->makeEmptyActionRow(); - - foreach ($this->metricsByKey as $key => &$row) { - $isActionRowAggregate = (count($row) == count($emptyActionRow)); - if (!self::isReservedKey($key) - && $isActionRowAggregate - ) { - unset($row[Piwik_Archive::INDEX_NB_UNIQ_VISITORS]); - unset($row[Piwik_Archive::INDEX_NB_VISITS]); - } - } - } - - public function archivePeriod($archiveProcessing) - { - $nameToCount = $archiveProcessing->archiveDataTable( - self::BLOB_NAME, null, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, - $columnToSort = Piwik_Archive::INDEX_NB_VISITS); - } - -} \ No newline at end of file diff --git a/plugins/CustomVariables/CustomVariables.php b/plugins/CustomVariables/CustomVariables.php index e6b9d14a90..313632e411 100644 --- a/plugins/CustomVariables/CustomVariables.php +++ b/plugins/CustomVariables/CustomVariables.php @@ -155,8 +155,8 @@ class Piwik_CustomVariables extends Piwik_Plugin return; } - $archiving = new Piwik_CustomVariables_Archiving(); - $archiving->archiveDay($archiveProcessing); + $archiving = new Piwik_CustomVariables_Archiver($archiveProcessing); + $archiving->archiveDay(); } /** @@ -170,8 +170,8 @@ class Piwik_CustomVariables extends Piwik_Plugin return; } - $archiving = new Piwik_CustomVariables_Archiving(); - $archiving->archivePeriod($archiveProcessing); + $archiving = new Piwik_CustomVariables_Archiver($archiveProcessing); + $archiving->archivePeriod(); } } diff --git a/plugins/DevicesDetection/Archiver.php b/plugins/DevicesDetection/Archiver.php new file mode 100644 index 0000000000..1fdbe6f8cc --- /dev/null +++ b/plugins/DevicesDetection/Archiver.php @@ -0,0 +1,105 @@ +maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; + } + + public function archiveDay() + { + $this->archiveDayDeviceTypes(); + $this->archiveDayDeviceBrands(); + $this->archiveDayDeviceModels(); + $this->archiveDayOs(); + $this->archiveDayOsVersions(); + $this->archiveDayBrowserFamilies(); + $this->archiveDayBrowsersVersions(); + } + + private function archiveDayDeviceTypes() + { + $recordName = 'DevicesDetection_types'; + $labelSQL = "log_visit.config_device_type"; + $this->aggregateByLabel( $labelSQL, $recordName); + } + + private function aggregateByLabel( $labelSQL, $recordName) + { + $metricsByLabel = $this->getProcessor()->getMetricsForLabel($labelSQL); + $tableBrand = $this->getProcessor()->getDataTableFromArray($metricsByLabel); + + $this->getProcessor()->insertBlobRecord($recordName, $tableBrand->getSerialized($this->maximumRowsInDataTable, null, Piwik_Archive::INDEX_NB_VISITS)); + } + + private function archiveDayDeviceBrands() + { + $recordName = 'DevicesDetection_brands'; + $labelSQL = "log_visit.config_device_brand"; + $this->aggregateByLabel( $labelSQL, $recordName); + } + + private function archiveDayDeviceModels() + { + $recordName = 'DevicesDetection_models'; + $labelSQL = "log_visit.config_device_model"; + $this->aggregateByLabel( $labelSQL, $recordName); + } + + private function archiveDayOs() + { + $recordName = 'DevicesDetection_os'; + $labelSQL = "log_visit.config_os"; + $this->aggregateByLabel( $labelSQL, $recordName); + } + + private function archiveDayOsVersions() + { + $recordName = 'DevicesDetection_osVersions'; + $labelSQL = "CONCAT(log_visit.config_os, ';', log_visit.config_os_version)"; + $this->aggregateByLabel( $labelSQL, $recordName); + } + + private function archiveDayBrowserFamilies() + { + $recordName = 'DevicesDetection_browsers'; + $labelSQL = "log_visit.config_browser_name"; + $this->aggregateByLabel( $labelSQL, $recordName); + } + + private function archiveDayBrowsersVersions() + { + $recordName = 'DevicesDetection_browserVersions'; + $labelSQL = "CONCAT(log_visit.config_browser_name, ';', log_visit.config_browser_version)"; + $this->aggregateByLabel( $labelSQL, $recordName); + } + + public function archivePeriod() + { + $maximumRowsInSubDataTable = $this->maximumRowsInDataTable; + $dataTablesToSum = array( + 'DevicesDetection_types', + 'DevicesDetection_brands', + 'DevicesDetection_models', + 'DevicesDetection_os', + 'DevicesDetection_osVersions', + 'DevicesDetection_browsers', + 'DevicesDetection_browserVersions' + ); + foreach ($dataTablesToSum as $dt) { + $this->getProcessor()->archiveDataTable( + $dt, null, $this->maximumRowsInDataTable, $maximumRowsInSubDataTable, $columnToSort = "nb_visits"); + } + } +} \ No newline at end of file diff --git a/plugins/DevicesDetection/Archiving.php b/plugins/DevicesDetection/Archiving.php deleted file mode 100644 index 6d4a51bb28..0000000000 --- a/plugins/DevicesDetection/Archiving.php +++ /dev/null @@ -1,107 +0,0 @@ -__construct(); - $this->columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; - - $this->archiveDayDeviceTypes($archiveProcessing); - $this->archiveDayDeviceBrands($archiveProcessing); - $this->archiveDayDeviceModels($archiveProcessing); - $this->archiveDayOs($archiveProcessing); - $this->archiveDayOsVersions($archiveProcessing); - $this->archiveDayBrowserFamilies($archiveProcessing); - $this->archiveDayBrowsersVersions($archiveProcessing); - } - - public function __construct() - { - return $this->maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; - } - - private function archiveDayDeviceTypes($archiveProcessing) - { - $recordName = 'DevicesDetection_types'; - $labelSQL = "log_visit.config_device_type"; - $this->aggregateByLabel($archiveProcessing, $labelSQL, $recordName); - } - - private function aggregateByLabel($archiveProcessing, $labelSQL, $recordName) - { - $metricsByLabel = $archiveProcessing->getMetricsForLabel($labelSQL); - $tableBrand = $archiveProcessing->getDataTableFromArray($metricsByLabel); - - $archiveProcessing->insertBlobRecord($recordName, $tableBrand->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); - } - - private function archiveDayDeviceBrands($archiveProcessing) - { - $recordName = 'DevicesDetection_brands'; - $labelSQL = "log_visit.config_device_brand"; - $this->aggregateByLabel($archiveProcessing, $labelSQL, $recordName); - } - - private function archiveDayDeviceModels($archiveProcessing) - { - $recordName = 'DevicesDetection_models'; - $labelSQL = "log_visit.config_device_model"; - $this->aggregateByLabel($archiveProcessing, $labelSQL, $recordName); - } - - private function archiveDayOs($archiveProcessing) - { - $recordName = 'DevicesDetection_os'; - $labelSQL = "log_visit.config_os"; - $this->aggregateByLabel($archiveProcessing, $labelSQL, $recordName); - } - - private function archiveDayOsVersions($archiveProcessing) - { - $recordName = 'DevicesDetection_osVersions'; - $labelSQL = "CONCAT(log_visit.config_os, ';', log_visit.config_os_version)"; - $this->aggregateByLabel($archiveProcessing, $labelSQL, $recordName); - } - - private function archiveDayBrowserFamilies($archiveProcessing) - { - $recordName = 'DevicesDetection_browsers'; - $labelSQL = "log_visit.config_browser_name"; - $this->aggregateByLabel($archiveProcessing, $labelSQL, $recordName); - } - - private function archiveDayBrowsersVersions($archiveProcessing) - { - $recordName = 'DevicesDetection_browserVersions'; - $labelSQL = "CONCAT(log_visit.config_browser_name, ';', log_visit.config_browser_version)"; - $this->aggregateByLabel($archiveProcessing, $labelSQL, $recordName); - } - - public function archivePeriod($archiveProcessing) - { - $maximumRowsInSubDataTable = $this->maximumRowsInDataTable; - $dataTablesToSum = array( - 'DevicesDetection_types', - 'DevicesDetection_brands', - 'DevicesDetection_models', - 'DevicesDetection_os', - 'DevicesDetection_osVersions', - 'DevicesDetection_browsers', - 'DevicesDetection_browserVersions' - ); - foreach ($dataTablesToSum as $dt) { - $archiveProcessing->archiveDataTable( - $dt, null, $this->maximumRowsInDataTable, $maximumRowsInSubDataTable, $columnToSort = "nb_visits"); - } - } -} \ No newline at end of file diff --git a/plugins/DevicesDetection/DevicesDetection.php b/plugins/DevicesDetection/DevicesDetection.php index fd06a7d963..da83595d99 100644 --- a/plugins/DevicesDetection/DevicesDetection.php +++ b/plugins/DevicesDetection/DevicesDetection.php @@ -245,8 +245,8 @@ class Piwik_DevicesDetection extends Piwik_Plugin return; } - $archiving = new Piwik_DevicesDetection_Archiving(); - $archiving->archiveDay($archiveProcessing); + $archiving = new Piwik_DevicesDetection_Archiver($archiveProcessing); + $archiving->archiveDay(); } public function archivePeriod($notification) @@ -257,8 +257,8 @@ class Piwik_DevicesDetection extends Piwik_Plugin return; } - $archiving = new Piwik_DevicesDetection_Archiving(); - $archiving->archivePeriod($archiveProcessing); + $archiving = new Piwik_DevicesDetection_Archiver($archiveProcessing); + $archiving->archivePeriod(); } public function addMenu() diff --git a/plugins/Goals/API.php b/plugins/Goals/API.php index 81ff457d63..18528e4b18 100644 --- a/plugins/Goals/API.php +++ b/plugins/Goals/API.php @@ -206,7 +206,7 @@ class Piwik_Goals_API Piwik::checkUserHasViewAccess($idSite); $recordNameFinal = $recordName; if ($abandonedCarts) { - $recordNameFinal = Piwik_Goals_Archiving::getItemRecordNameAbandonedCart($recordName); + $recordNameFinal = Piwik_Goals_Archiver::getItemRecordNameAbandonedCart($recordName); } $archive = Piwik_Archive::build($idSite, $period, $date); $dataTable = $archive->getDataTable($recordNameFinal); @@ -286,7 +286,7 @@ class Piwik_Goals_API } return; } - $rowNotDefined = $dataTable->getRowFromLabel(Piwik_CustomVariables_Archiving::LABEL_CUSTOM_VALUE_NOT_DEFINED); + $rowNotDefined = $dataTable->getRowFromLabel(Piwik_CustomVariables_Archiver::LABEL_CUSTOM_VALUE_NOT_DEFINED); if ($rowNotDefined) { $rowNotDefined->setColumn('label', $notDefinedStringPretty); } @@ -390,7 +390,7 @@ class Piwik_Goals_API } $columnsToSelect = array(); foreach ($columns as &$columnName) { - $columnsToSelect[] = Piwik_Goals_Archiving::getRecordName($columnName, $idGoal); + $columnsToSelect[] = Piwik_Goals_Archiver::getRecordName($columnName, $idGoal); } $dataTable = $archive->getDataTableFromNumeric($columnsToSelect); @@ -438,7 +438,7 @@ class Piwik_Goals_API */ public function getConversions($idSite, $period, $date, $segment = false, $idGoal = false) { - return $this->getNumeric($idSite, $period, $date, $segment, Piwik_Goals_Archiving::getRecordName('nb_conversions', $idGoal)); + return $this->getNumeric($idSite, $period, $date, $segment, Piwik_Goals_Archiver::getRecordName('nb_conversions', $idGoal)); } /** @@ -446,7 +446,7 @@ class Piwik_Goals_API */ public function getNbVisitsConverted($idSite, $period, $date, $segment = false, $idGoal = false) { - return $this->getNumeric($idSite, $period, $date, $segment, Piwik_Goals_Archiving::getRecordName('nb_visits_converted', $idGoal)); + return $this->getNumeric($idSite, $period, $date, $segment, Piwik_Goals_Archiver::getRecordName('nb_visits_converted', $idGoal)); } /** @@ -454,7 +454,7 @@ class Piwik_Goals_API */ public function getConversionRate($idSite, $period, $date, $segment = false, $idGoal = false) { - return $this->getNumeric($idSite, $period, $date, $segment, Piwik_Goals_Archiving::getRecordName('conversion_rate', $idGoal)); + return $this->getNumeric($idSite, $period, $date, $segment, Piwik_Goals_Archiver::getRecordName('conversion_rate', $idGoal)); } /** @@ -462,7 +462,7 @@ class Piwik_Goals_API */ public function getRevenue($idSite, $period, $date, $segment = false, $idGoal = false) { - return $this->getNumeric($idSite, $period, $date, $segment, Piwik_Goals_Archiving::getRecordName('revenue', $idGoal)); + return $this->getNumeric($idSite, $period, $date, $segment, Piwik_Goals_Archiver::getRecordName('revenue', $idGoal)); } /** @@ -488,7 +488,7 @@ class Piwik_Goals_API $realGoalId = $idGoal != true ? false : self::convertSpecialGoalIds($idGoal); // get the data table - $dataTable = $archive->getDataTable(Piwik_Goals_Archiving::getRecordName($recordName, $realGoalId), $idSubtable = null); + $dataTable = $archive->getDataTable(Piwik_Goals_Archiver::getRecordName($recordName, $realGoalId), $idSubtable = null); $dataTable->queueFilter('ReplaceColumnNames'); return $dataTable; @@ -508,7 +508,7 @@ class Piwik_Goals_API public function getDaysToConversion($idSite, $period, $date, $segment = false, $idGoal = false) { $dataTable = $this->getGoalSpecificDataTable( - Piwik_Goals_Archiving::DAYS_UNTIL_CONV_RECORD_NAME, $idSite, $period, $date, $segment, $idGoal); + Piwik_Goals_Archiver::DAYS_UNTIL_CONV_RECORD_NAME, $idSite, $period, $date, $segment, $idGoal); $dataTable->queueFilter('Sort', array('label', 'asc', true)); $dataTable->queueFilter( @@ -531,7 +531,7 @@ class Piwik_Goals_API public function getVisitsUntilConversion($idSite, $period, $date, $segment = false, $idGoal = false) { $dataTable = $this->getGoalSpecificDataTable( - Piwik_Goals_Archiving::VISITS_UNTIL_RECORD_NAME, $idSite, $period, $date, $segment, $idGoal); + Piwik_Goals_Archiver::VISITS_UNTIL_RECORD_NAME, $idSite, $period, $date, $segment, $idGoal); $dataTable->queueFilter('Sort', array('label', 'asc', true)); $dataTable->queueFilter( diff --git a/plugins/Goals/Archiver.php b/plugins/Goals/Archiver.php new file mode 100644 index 0000000000..191ae96c6a --- /dev/null +++ b/plugins/Goals/Archiver.php @@ -0,0 +1,349 @@ + 'Goals_ItemsSku', + 'idaction_name' => 'Goals_ItemsName', + 'idaction_category' => 'Goals_ItemsCategory' + ); + + public function archiveDay() + { + $this->archiveGeneralGoalMetrics(); + $this->archiveEcommerceItems(); + } + + function archiveGeneralGoalMetrics() + { + // extra aggregate selects for the visits to conversion report + $visitToConvExtraCols = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( + 'visitor_count_visits', self::$visitCountRanges, 'log_conversion', 'vcv'); + + // extra aggregate selects for the days to conversion report + $daysToConvExtraCols = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( + 'visitor_days_since_first', self::$daysToConvRanges, 'log_conversion', 'vdsf'); + + $query = $this->getProcessor()->queryConversionsByDimension( + array(), '', array_merge($visitToConvExtraCols, $daysToConvExtraCols)); + + if ($query === false) { + return; + } + + $goals = array(); + $visitsToConvReport = array(); + $daysToConvReport = array(); + + // Get a standard empty goal row + $overall = $this->getProcessor()->makeEmptyGoalRow($idGoal = 1); + while ($row = $query->fetch()) { + $idgoal = $row['idgoal']; + + if (!isset($goals[$idgoal])) { + $goals[$idgoal] = $this->getProcessor()->makeEmptyGoalRow($idgoal); + + $visitsToConvReport[$idgoal] = new Piwik_DataTable(); + $daysToConvReport[$idgoal] = new Piwik_DataTable(); + } + $this->getProcessor()->sumGoalMetrics($row, $goals[$idgoal]); + + // We don't want to sum Abandoned cart metrics in the overall revenue/conversions/converted visits + // since it is a "negative conversion" + if ($idgoal != Piwik_Tracker_GoalManager::IDGOAL_CART) { + $this->getProcessor()->sumGoalMetrics($row, $overall); + } + + // map the goal + visit number of a visitor with the # of conversions that happened on that visit + $table = $this->getProcessor()->getSimpleDataTableFromRow($row, Piwik_Archive::INDEX_NB_CONVERSIONS, 'vcv'); + $visitsToConvReport[$idgoal]->addDataTable($table); + + // map the goal + day number of a visit with the # of conversion that happened on that day + $table = $this->getProcessor()->getSimpleDataTableFromRow($row, Piwik_Archive::INDEX_NB_CONVERSIONS, 'vdsf'); + $daysToConvReport[$idgoal]->addDataTable($table); + } + + // these data tables hold reports for every goal of a site + $visitsToConvOverview = new Piwik_DataTable(); + $daysToConvOverview = new Piwik_DataTable(); + + // Stats by goal, for all visitors + foreach ($goals as $idgoal => $values) { + foreach ($values as $metricId => $value) { + $metricName = Piwik_Archive::$mappingFromIdToNameGoal[$metricId]; + $recordName = self::getRecordName($metricName, $idgoal); + $this->getProcessor()->insertNumericRecord($recordName, $value); + } + $conversion_rate = $this->getConversionRate($values[Piwik_Archive::INDEX_GOAL_NB_VISITS_CONVERTED]); + $recordName = self::getRecordName('conversion_rate', $idgoal); + $this->getProcessor()->insertNumericRecord($recordName, $conversion_rate); + + // if the goal is not a special goal (like ecommerce) add it to the overview report + if ($idgoal !== Piwik_Tracker_GoalManager::IDGOAL_CART && + $idgoal !== Piwik_Tracker_GoalManager::IDGOAL_ORDER + ) { + $visitsToConvOverview->addDataTable($visitsToConvReport[$idgoal]); + $daysToConvOverview->addDataTable($daysToConvReport[$idgoal]); + } + + // visit count until conversion stats + $this->getProcessor()->insertBlobRecord( + self::getRecordName(self::VISITS_UNTIL_RECORD_NAME, $idgoal), + $visitsToConvReport[$idgoal]->getSerialized()); + + // day count until conversion stats + $this->getProcessor()->insertBlobRecord( + self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME, $idgoal), + $daysToConvReport[$idgoal]->getSerialized()); + } + + // archive overview reports + $this->getProcessor()->insertBlobRecord( + self::getRecordName(self::VISITS_UNTIL_RECORD_NAME), $visitsToConvOverview->getSerialized()); + $this->getProcessor()->insertBlobRecord( + self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME), $daysToConvOverview->getSerialized()); + + // Stats for all goals + $totalAllGoals = array( + self::getRecordName('conversion_rate') => $this->getConversionRate($this->getProcessor()->getNumberOfVisitsConverted()), + self::getRecordName('nb_conversions') => $overall[Piwik_Archive::INDEX_GOAL_NB_CONVERSIONS], + self::getRecordName('nb_visits_converted') => $this->getProcessor()->getNumberOfVisitsConverted(), + self::getRecordName('revenue') => $overall[Piwik_Archive::INDEX_GOAL_REVENUE], + ); + foreach ($totalAllGoals as $recordName => $value) { + $this->getProcessor()->insertNumericRecord($recordName, $value); + } + } + + /** + * @param Piwik_ArchiveProcessing_Day $this->getProcessor() + */ + function archiveEcommerceItems() + { + if (!$this->shouldArchiveEcommerceItems()) { + return false; + } + $items = array(); + + $dimensionsToQuery = $this->dimensions; + $dimensionsToQuery['idaction_category2'] = 'AdditionalCategory'; + $dimensionsToQuery['idaction_category3'] = 'AdditionalCategory'; + $dimensionsToQuery['idaction_category4'] = 'AdditionalCategory'; + $dimensionsToQuery['idaction_category5'] = 'AdditionalCategory'; + + foreach ($dimensionsToQuery as $dimension => $recordName) { + $query = $this->getProcessor()->queryEcommerceItems($dimension); + if ($query == false) { + continue; + } + + while ($row = $query->fetch()) { + $label = $row['label']; + $ecommerceType = $row['ecommerceType']; + + if (empty($label)) { + // idaction==0 case: + // If we are querying any optional category, we do not include idaction=0 + // Otherwise we over-report in the Product Categories report + if ($recordName == 'AdditionalCategory') { + continue; + } + // Product Name/Category not defined" + if (class_exists('Piwik_CustomVariables')) { + $label = Piwik_CustomVariables_Archiver::LABEL_CUSTOM_VALUE_NOT_DEFINED; + } else { + $label = "Value not defined"; + } + } + // For carts, idorder = 0. To count abandoned carts, we must count visits with an abandoned cart + if ($ecommerceType == Piwik_Tracker_GoalManager::IDGOAL_CART) { + $row[Piwik_Archive::INDEX_ECOMMERCE_ORDERS] = $row[Piwik_Archive::INDEX_NB_VISITS]; + } + unset($row[Piwik_Archive::INDEX_NB_VISITS]); + unset($row['label']); + unset($row['ecommerceType']); + + $columnsToRound = array( + Piwik_Archive::INDEX_ECOMMERCE_ITEM_REVENUE, + Piwik_Archive::INDEX_ECOMMERCE_ITEM_QUANTITY, + Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE, + Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED, + ); + foreach ($columnsToRound as $column) { + if (isset($row[$column]) + && $row[$column] == round($row[$column]) + ) { + $row[$column] = round($row[$column]); + } + } + $items[$dimension][$ecommerceType][$label] = $row; + } + } + + foreach ($this->dimensions as $dimension => $recordName) { + foreach (array(Piwik_Tracker_GoalManager::IDGOAL_CART, Piwik_Tracker_GoalManager::IDGOAL_ORDER) as $ecommerceType) { + if (!isset($items[$dimension][$ecommerceType])) { + continue; + } + $recordNameInsert = $recordName; + if ($ecommerceType == Piwik_Tracker_GoalManager::IDGOAL_CART) { + $recordNameInsert = self::getItemRecordNameAbandonedCart($recordName); + } + $table = $this->getProcessor()->getDataTableFromArray($items[$dimension][$ecommerceType]); + + // For "category" report, we aggregate all 5 category queries into one datatable + if ($dimension == 'idaction_category') { + foreach (array('idaction_category2', 'idaction_category3', 'idaction_category4', 'idaction_category5') as $categoryToSum) { + if (!empty($items[$categoryToSum][$ecommerceType])) { + $tableToSum = $this->getProcessor()->getDataTableFromArray($items[$categoryToSum][$ecommerceType]); + $table->addDataTable($tableToSum); + } + } + } + $this->getProcessor()->insertBlobRecord($recordNameInsert, $table->getSerialized()); + } + } + } + + /** + * @param $this->getProcessor() + */ + public function archivePeriod() + { + /* + * Archive Ecommerce Items + */ + if ($this->shouldArchiveEcommerceItems()) { + $dataTableToSum = $this->dimensions; + foreach ($this->dimensions as $recordName) { + $dataTableToSum[] = self::getItemRecordNameAbandonedCart($recordName); + } + $this->getProcessor()->archiveDataTable($dataTableToSum); + } + + /* + * Archive General Goal metrics + */ + $goalIdsToSum = Piwik_Tracker_GoalManager::getGoalIds($this->getProcessor()->idsite); + + //Ecommerce + $goalIdsToSum[] = Piwik_Tracker_GoalManager::IDGOAL_ORDER; + $goalIdsToSum[] = Piwik_Tracker_GoalManager::IDGOAL_CART; //bug here if idgoal=1 + // Overall goal metrics + $goalIdsToSum[] = false; + + $fieldsToSum = array(); + foreach ($goalIdsToSum as $goalId) { + $metricsToSum = Piwik_Goals::getGoalColumns($goalId); + unset($metricsToSum[array_search('conversion_rate', $metricsToSum)]); + foreach ($metricsToSum as $metricName) { + $fieldsToSum[] = self::getRecordName($metricName, $goalId); + } + } + $records = $this->getProcessor()->archiveNumericValuesSum($fieldsToSum); + + // also recording conversion_rate for each goal + foreach ($goalIdsToSum as $goalId) { + $nb_conversions = $records[self::getRecordName('nb_visits_converted', $goalId)]; + $conversion_rate = $this->getConversionRate($nb_conversions); + $this->getProcessor()->insertNumericRecord(self::getRecordName('conversion_rate', $goalId), $conversion_rate); + + // sum up the visits to conversion data table & the days to conversion data table + $this->getProcessor()->archiveDataTable(array( + self::getRecordName(self::VISITS_UNTIL_RECORD_NAME, $goalId), + self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME, $goalId))); + } + + // sum up goal overview reports + $this->getProcessor()->archiveDataTable(array( + self::getRecordName(self::VISITS_UNTIL_RECORD_NAME), + self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME))); + } + + protected function shouldArchiveEcommerceItems() + { + // Per item doesn't support segment + // Also, when querying Goal metrics for visitorType==returning, we wouldnt want to trigger an extra request + // event if it did support segment + // (if this is implented, we should have shouldProcessReportsForPlugin() support partial archiving based on which metric is requested) + if (!$this->getProcessor()->getSegment()->isEmpty()) { + return false; + } + return true; + } + + static public function getItemRecordNameAbandonedCart($recordName) + { + return $recordName . '_Cart'; + } + + /** + * @param string $recordName 'nb_conversions' + * @param int|bool $idGoal idGoal to return the metrics for, or false to return overall + * @return string Archive record name + */ + static public function getRecordName($recordName, $idGoal = false) + { + $idGoalStr = ''; + if ($idGoal !== false) { + $idGoalStr = $idGoal . "_"; + } + return 'Goal_' . $idGoalStr . $recordName; + } + + private function getConversionRate($count) + { + $visits = $this->getProcessor()->getNumberOfVisits(); + return round(100 * $count / $visits, Piwik_Tracker_GoalManager::REVENUE_PRECISION); + } + +} \ No newline at end of file diff --git a/plugins/Goals/Archiving.php b/plugins/Goals/Archiving.php deleted file mode 100644 index 59967ed40f..0000000000 --- a/plugins/Goals/Archiving.php +++ /dev/null @@ -1,354 +0,0 @@ - 'Goals_ItemsSku', - 'idaction_name' => 'Goals_ItemsName', - 'idaction_category' => 'Goals_ItemsCategory' - ); - - /** - * @param $archiveProcessing - */ - public function archiveDay($archiveProcessing) - { - $this->archiveGeneralGoalMetrics($archiveProcessing); - $this->archiveEcommerceItems($archiveProcessing); - } - - /** - * @param Piwik_ArchiveProcessing_Day $archiveProcessing - */ - function archiveGeneralGoalMetrics($archiveProcessing) - { - // extra aggregate selects for the visits to conversion report - $visitToConvExtraCols = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( - 'visitor_count_visits', self::$visitCountRanges, 'log_conversion', 'vcv'); - - // extra aggregate selects for the days to conversion report - $daysToConvExtraCols = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( - 'visitor_days_since_first', self::$daysToConvRanges, 'log_conversion', 'vdsf'); - - $query = $archiveProcessing->queryConversionsByDimension( - array(), '', array_merge($visitToConvExtraCols, $daysToConvExtraCols)); - - if ($query === false) { - return; - } - - $goals = array(); - $visitsToConvReport = array(); - $daysToConvReport = array(); - - // Get a standard empty goal row - $overall = $archiveProcessing->makeEmptyGoalRow($idGoal = 1); - while ($row = $query->fetch()) { - $idgoal = $row['idgoal']; - - if (!isset($goals[$idgoal])) { - $goals[$idgoal] = $archiveProcessing->makeEmptyGoalRow($idgoal); - - $visitsToConvReport[$idgoal] = new Piwik_DataTable(); - $daysToConvReport[$idgoal] = new Piwik_DataTable(); - } - $archiveProcessing->sumGoalMetrics($row, $goals[$idgoal]); - - // We don't want to sum Abandoned cart metrics in the overall revenue/conversions/converted visits - // since it is a "negative conversion" - if ($idgoal != Piwik_Tracker_GoalManager::IDGOAL_CART) { - $archiveProcessing->sumGoalMetrics($row, $overall); - } - - // map the goal + visit number of a visitor with the # of conversions that happened on that visit - $table = $archiveProcessing->getSimpleDataTableFromRow($row, Piwik_Archive::INDEX_NB_CONVERSIONS, 'vcv'); - $visitsToConvReport[$idgoal]->addDataTable($table); - - // map the goal + day number of a visit with the # of conversion that happened on that day - $table = $archiveProcessing->getSimpleDataTableFromRow($row, Piwik_Archive::INDEX_NB_CONVERSIONS, 'vdsf'); - $daysToConvReport[$idgoal]->addDataTable($table); - } - - // these data tables hold reports for every goal of a site - $visitsToConvOverview = new Piwik_DataTable(); - $daysToConvOverview = new Piwik_DataTable(); - - // Stats by goal, for all visitors - foreach ($goals as $idgoal => $values) { - foreach ($values as $metricId => $value) { - $metricName = Piwik_Archive::$mappingFromIdToNameGoal[$metricId]; - $recordName = self::getRecordName($metricName, $idgoal); - $archiveProcessing->insertNumericRecord($recordName, $value); - } - $conversion_rate = $this->getConversionRate($values[Piwik_Archive::INDEX_GOAL_NB_VISITS_CONVERTED], $archiveProcessing); - $recordName = self::getRecordName('conversion_rate', $idgoal); - $archiveProcessing->insertNumericRecord($recordName, $conversion_rate); - - // if the goal is not a special goal (like ecommerce) add it to the overview report - if ($idgoal !== Piwik_Tracker_GoalManager::IDGOAL_CART && - $idgoal !== Piwik_Tracker_GoalManager::IDGOAL_ORDER - ) { - $visitsToConvOverview->addDataTable($visitsToConvReport[$idgoal]); - $daysToConvOverview->addDataTable($daysToConvReport[$idgoal]); - } - - // visit count until conversion stats - $archiveProcessing->insertBlobRecord( - self::getRecordName(self::VISITS_UNTIL_RECORD_NAME, $idgoal), - $visitsToConvReport[$idgoal]->getSerialized()); - - // day count until conversion stats - $archiveProcessing->insertBlobRecord( - self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME, $idgoal), - $daysToConvReport[$idgoal]->getSerialized()); - } - - // archive overview reports - $archiveProcessing->insertBlobRecord( - self::getRecordName(self::VISITS_UNTIL_RECORD_NAME), $visitsToConvOverview->getSerialized()); - $archiveProcessing->insertBlobRecord( - self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME), $daysToConvOverview->getSerialized()); - - // Stats for all goals - $totalAllGoals = array( - self::getRecordName('conversion_rate') => $this->getConversionRate($archiveProcessing->getNumberOfVisitsConverted(), $archiveProcessing), - self::getRecordName('nb_conversions') => $overall[Piwik_Archive::INDEX_GOAL_NB_CONVERSIONS], - self::getRecordName('nb_visits_converted') => $archiveProcessing->getNumberOfVisitsConverted(), - self::getRecordName('revenue') => $overall[Piwik_Archive::INDEX_GOAL_REVENUE], - ); - foreach ($totalAllGoals as $recordName => $value) { - $archiveProcessing->insertNumericRecord($recordName, $value); - } - } - - /** - * @param Piwik_ArchiveProcessing_Day $archiveProcessing - */ - function archiveEcommerceItems($archiveProcessing) - { - if (!$this->shouldArchiveEcommerceItems($archiveProcessing)) { - return false; - } - $items = array(); - - $dimensionsToQuery = $this->dimensions; - $dimensionsToQuery['idaction_category2'] = 'AdditionalCategory'; - $dimensionsToQuery['idaction_category3'] = 'AdditionalCategory'; - $dimensionsToQuery['idaction_category4'] = 'AdditionalCategory'; - $dimensionsToQuery['idaction_category5'] = 'AdditionalCategory'; - - foreach ($dimensionsToQuery as $dimension => $recordName) { - $query = $archiveProcessing->queryEcommerceItems($dimension); - if ($query == false) { - continue; - } - - while ($row = $query->fetch()) { - $label = $row['label']; - $ecommerceType = $row['ecommerceType']; - - if (empty($label)) { - // idaction==0 case: - // If we are querying any optional category, we do not include idaction=0 - // Otherwise we over-report in the Product Categories report - if ($recordName == 'AdditionalCategory') { - continue; - } - // Product Name/Category not defined" - if (class_exists('Piwik_CustomVariables')) { - $label = Piwik_CustomVariables_Archiving::LABEL_CUSTOM_VALUE_NOT_DEFINED; - } else { - $label = "Value not defined"; - } - } - // For carts, idorder = 0. To count abandoned carts, we must count visits with an abandoned cart - if ($ecommerceType == Piwik_Tracker_GoalManager::IDGOAL_CART) { - $row[Piwik_Archive::INDEX_ECOMMERCE_ORDERS] = $row[Piwik_Archive::INDEX_NB_VISITS]; - } - unset($row[Piwik_Archive::INDEX_NB_VISITS]); - unset($row['label']); - unset($row['ecommerceType']); - - $columnsToRound = array( - Piwik_Archive::INDEX_ECOMMERCE_ITEM_REVENUE, - Piwik_Archive::INDEX_ECOMMERCE_ITEM_QUANTITY, - Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE, - Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED, - ); - foreach ($columnsToRound as $column) { - if (isset($row[$column]) - && $row[$column] == round($row[$column]) - ) { - $row[$column] = round($row[$column]); - } - } - $items[$dimension][$ecommerceType][$label] = $row; - } - } - - foreach ($this->dimensions as $dimension => $recordName) { - foreach (array(Piwik_Tracker_GoalManager::IDGOAL_CART, Piwik_Tracker_GoalManager::IDGOAL_ORDER) as $ecommerceType) { - if (!isset($items[$dimension][$ecommerceType])) { - continue; - } - $recordNameInsert = $recordName; - if ($ecommerceType == Piwik_Tracker_GoalManager::IDGOAL_CART) { - $recordNameInsert = self::getItemRecordNameAbandonedCart($recordName); - } - $table = $archiveProcessing->getDataTableFromArray($items[$dimension][$ecommerceType]); - - // For "category" report, we aggregate all 5 category queries into one datatable - if ($dimension == 'idaction_category') { - foreach (array('idaction_category2', 'idaction_category3', 'idaction_category4', 'idaction_category5') as $categoryToSum) { - if (!empty($items[$categoryToSum][$ecommerceType])) { - $tableToSum = $archiveProcessing->getDataTableFromArray($items[$categoryToSum][$ecommerceType]); - $table->addDataTable($tableToSum); - } - } - } - $archiveProcessing->insertBlobRecord($recordNameInsert, $table->getSerialized()); - } - } - } - - /** - * @param $archiveProcessing - */ - public function archivePeriod($archiveProcessing) - { - /* - * Archive Ecommerce Items - */ - if ($this->shouldArchiveEcommerceItems($archiveProcessing)) { - $dataTableToSum = $this->dimensions; - foreach ($this->dimensions as $recordName) { - $dataTableToSum[] = self::getItemRecordNameAbandonedCart($recordName); - } - $archiveProcessing->archiveDataTable($dataTableToSum); - } - - /* - * Archive General Goal metrics - */ - $goalIdsToSum = Piwik_Tracker_GoalManager::getGoalIds($archiveProcessing->idsite); - - //Ecommerce - $goalIdsToSum[] = Piwik_Tracker_GoalManager::IDGOAL_ORDER; - $goalIdsToSum[] = Piwik_Tracker_GoalManager::IDGOAL_CART; //bug here if idgoal=1 - // Overall goal metrics - $goalIdsToSum[] = false; - - $fieldsToSum = array(); - foreach ($goalIdsToSum as $goalId) { - $metricsToSum = Piwik_Goals::getGoalColumns($goalId); - unset($metricsToSum[array_search('conversion_rate', $metricsToSum)]); - foreach ($metricsToSum as $metricName) { - $fieldsToSum[] = self::getRecordName($metricName, $goalId); - } - } - $records = $archiveProcessing->archiveNumericValuesSum($fieldsToSum); - - // also recording conversion_rate for each goal - foreach ($goalIdsToSum as $goalId) { - $nb_conversions = $records[self::getRecordName('nb_visits_converted', $goalId)]; - $conversion_rate = $this->getConversionRate($nb_conversions, $archiveProcessing); - $archiveProcessing->insertNumericRecord(self::getRecordName('conversion_rate', $goalId), $conversion_rate); - - // sum up the visits to conversion data table & the days to conversion data table - $archiveProcessing->archiveDataTable(array( - self::getRecordName(self::VISITS_UNTIL_RECORD_NAME, $goalId), - self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME, $goalId))); - } - - // sum up goal overview reports - $archiveProcessing->archiveDataTable(array( - self::getRecordName(self::VISITS_UNTIL_RECORD_NAME), - self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME))); - } - - protected function shouldArchiveEcommerceItems($archiveProcessing) - { - // Per item doesn't support segment - // Also, when querying Goal metrics for visitorType==returning, we wouldnt want to trigger an extra request - // event if it did support segment - // (if this is implented, we should have shouldProcessReportsForPlugin() support partial archiving based on which metric is requested) - if (!$archiveProcessing->getSegment()->isEmpty()) { - return false; - } - return true; - } - - static public function getItemRecordNameAbandonedCart($recordName) - { - return $recordName . '_Cart'; - } - - /** - * @param string $recordName 'nb_conversions' - * @param int|bool $idGoal idGoal to return the metrics for, or false to return overall - * @return string Archive record name - */ - static public function getRecordName($recordName, $idGoal = false) - { - $idGoalStr = ''; - if ($idGoal !== false) { - $idGoalStr = $idGoal . "_"; - } - return 'Goal_' . $idGoalStr . $recordName; - } - - private function getConversionRate($count, $archiveProcessing) - { - $visits = $archiveProcessing->getNumberOfVisits(); - return round(100 * $count / $visits, Piwik_Tracker_GoalManager::REVENUE_PRECISION); - } - -} \ No newline at end of file diff --git a/plugins/Goals/Controller.php b/plugins/Goals/Controller.php index 7f374e40f3..f6c3238175 100644 --- a/plugins/Goals/Controller.php +++ b/plugins/Goals/Controller.php @@ -458,7 +458,7 @@ class Piwik_Goals_Controller extends Piwik_Controller $view->setSortedColumn('label', 'asc'); $view->setColumnTranslation('label', Piwik_Translate('Goals_VisitsUntilConv')); $view->setColumnTranslation('nb_conversions', Piwik_Translate('Goals_ColumnConversions')); - $view->setLimit(count(Piwik_Goals_Archiving::$visitCountRanges)); + $view->setLimit(count(Piwik_Goals_Archiver::$visitCountRanges)); $view->disableOffsetInformationAndPaginationControls(); $view->disableShowAllViewsIcons(); return $this->renderView($view, $fetch); @@ -480,7 +480,7 @@ class Piwik_Goals_Controller extends Piwik_Controller $view->setColumnTranslation('label', Piwik_Translate('Goals_DaysToConv')); $view->setColumnTranslation('nb_conversions', Piwik_Translate('Goals_ColumnConversions')); $view->disableShowAllViewsIcons(); - $view->setLimit(count(Piwik_Goals_Archiving::$daysToConvRanges)); + $view->setLimit(count(Piwik_Goals_Archiver::$daysToConvRanges)); $view->disableOffsetInformationAndPaginationControls(); return $this->renderView($view, $fetch); } diff --git a/plugins/Goals/Goals.php b/plugins/Goals/Goals.php index 78e41180d5..85a629c4d8 100644 --- a/plugins/Goals/Goals.php +++ b/plugins/Goals/Goals.php @@ -515,8 +515,8 @@ class Piwik_Goals extends Piwik_Plugin if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $archiving = new Piwik_Goals_Archiving(); - $archiving->archiveDay($archiveProcessing); + $archiving = new Piwik_Goals_Archiver($archiveProcessing); + $archiving->archiveDay(); } /** @@ -537,7 +537,7 @@ class Piwik_Goals extends Piwik_Plugin return; } - $archiving = new Piwik_Goals_Archiving(); - $archiving->archivePeriod($archiveProcessing); + $archiving = new Piwik_Goals_Archiver($archiveProcessing); + $archiving->archivePeriod(); } } diff --git a/plugins/MultiSites/API.php b/plugins/MultiSites/API.php index 73db0e5347..1cbcfc39b3 100755 --- a/plugins/MultiSites/API.php +++ b/plugins/MultiSites/API.php @@ -351,7 +351,7 @@ class Piwik_MultiSites_API } else { $revenueMetric = ''; if (Piwik_Common::isGoalPluginEnabled()) { - $revenueMetric = Piwik_Goals_Archiving::getRecordName(self::GOAL_REVENUE_METRIC); + $revenueMetric = Piwik_Goals_Archiver::getRecordName(self::GOAL_REVENUE_METRIC); } $totals = array(); @@ -423,7 +423,7 @@ class Piwik_MultiSites_API $metrics[self::GOAL_REVENUE_METRIC] = array( self::METRIC_TRANSLATION_KEY => 'Goals_ColumnRevenue', self::METRIC_EVOLUTION_COL_NAME_KEY => self::GOAL_REVENUE_METRIC . '_evolution', - self::METRIC_RECORD_NAME_KEY => Piwik_Goals_Archiving::getRecordName(self::GOAL_REVENUE_METRIC), + self::METRIC_RECORD_NAME_KEY => Piwik_Goals_Archiver::getRecordName(self::GOAL_REVENUE_METRIC), self::METRIC_IS_ECOMMERCE_KEY => false, ); @@ -432,7 +432,7 @@ class Piwik_MultiSites_API $metrics[self::GOAL_CONVERSION_METRIC] = array( self::METRIC_TRANSLATION_KEY => 'Goals_ColumnConversions', self::METRIC_EVOLUTION_COL_NAME_KEY => self::GOAL_CONVERSION_METRIC . '_evolution', - self::METRIC_RECORD_NAME_KEY => Piwik_Goals_Archiving::getRecordName(self::GOAL_CONVERSION_METRIC), + self::METRIC_RECORD_NAME_KEY => Piwik_Goals_Archiver::getRecordName(self::GOAL_CONVERSION_METRIC), self::METRIC_IS_ECOMMERCE_KEY => false, ); @@ -440,7 +440,7 @@ class Piwik_MultiSites_API $metrics[self::ECOMMERCE_ORDERS_METRIC] = array( self::METRIC_TRANSLATION_KEY => 'General_EcommerceOrders', self::METRIC_EVOLUTION_COL_NAME_KEY => self::ECOMMERCE_ORDERS_METRIC . '_evolution', - self::METRIC_RECORD_NAME_KEY => Piwik_Goals_Archiving::getRecordName(self::GOAL_CONVERSION_METRIC, 0), + self::METRIC_RECORD_NAME_KEY => Piwik_Goals_Archiver::getRecordName(self::GOAL_CONVERSION_METRIC, 0), self::METRIC_IS_ECOMMERCE_KEY => true, ); @@ -448,7 +448,7 @@ class Piwik_MultiSites_API $metrics[self::ECOMMERCE_REVENUE_METRIC] = array( self::METRIC_TRANSLATION_KEY => 'General_ProductRevenue', self::METRIC_EVOLUTION_COL_NAME_KEY => self::ECOMMERCE_REVENUE_METRIC . '_evolution', - self::METRIC_RECORD_NAME_KEY => Piwik_Goals_Archiving::getRecordName(self::GOAL_REVENUE_METRIC, 0), + self::METRIC_RECORD_NAME_KEY => Piwik_Goals_Archiver::getRecordName(self::GOAL_REVENUE_METRIC, 0), self::METRIC_IS_ECOMMERCE_KEY => true, ); } diff --git a/plugins/PrivacyManager/PrivacyManager.php b/plugins/PrivacyManager/PrivacyManager.php index a055d2c132..d3caa2237f 100644 --- a/plugins/PrivacyManager/PrivacyManager.php +++ b/plugins/PrivacyManager/PrivacyManager.php @@ -354,12 +354,12 @@ class Piwik_PrivacyManager extends Piwik_Plugin foreach ($goalMetricsToKeep as $metric) { for ($i = 1; $i <= $maxGoalId; ++$i) // maxGoalId can be 0 { - $metricsToKeep[] = Piwik_Goals_Archiving::getRecordName($metric, $i); + $metricsToKeep[] = Piwik_Goals_Archiver::getRecordName($metric, $i); } - $metricsToKeep[] = Piwik_Goals_Archiving::getRecordName($metric); - $metricsToKeep[] = Piwik_Goals_Archiving::getRecordName($metric, Piwik_Tracker_GoalManager::IDGOAL_ORDER); - $metricsToKeep[] = Piwik_Goals_Archiving::getRecordName($metric, Piwik_Tracker_GoalManager::IDGOAL_CART); + $metricsToKeep[] = Piwik_Goals_Archiver::getRecordName($metric); + $metricsToKeep[] = Piwik_Goals_Archiver::getRecordName($metric, Piwik_Tracker_GoalManager::IDGOAL_ORDER); + $metricsToKeep[] = Piwik_Goals_Archiver::getRecordName($metric, Piwik_Tracker_GoalManager::IDGOAL_CART); } } diff --git a/plugins/Provider/Archiver.php b/plugins/Provider/Archiver.php new file mode 100644 index 0000000000..a82ff846ce --- /dev/null +++ b/plugins/Provider/Archiver.php @@ -0,0 +1,30 @@ +getProcessor()->getMetricsForLabel($labelSQL); + $tableProvider = $this->getProcessor()->getDataTableFromArray($metricsByProvider); + $columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; + $maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; + $this->getProcessor()->insertBlobRecord($recordName, $tableProvider->getSerialized($maximumRowsInDataTable, null, $columnToSortByBeforeTruncation)); + } + + public function archivePeriod() + { + $maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; + $dataTableToSum = array('Provider_hostnameExt'); + $this->getProcessor()->archiveDataTable($dataTableToSum, null, $maximumRowsInDataTable); + } +} \ No newline at end of file diff --git a/plugins/Provider/Archiving.php b/plugins/Provider/Archiving.php deleted file mode 100644 index 38305b035d..0000000000 --- a/plugins/Provider/Archiving.php +++ /dev/null @@ -1,30 +0,0 @@ -getMetricsForLabel($labelSQL); - $tableProvider = $archiveProcessing->getDataTableFromArray($metricsByProvider); - $columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; - $maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; - $archiveProcessing->insertBlobRecord($recordName, $tableProvider->getSerialized($maximumRowsInDataTable, null, $columnToSortByBeforeTruncation)); - } - - public function archivePeriod($archiveProcessing) - { - $maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; - $dataTableToSum = array('Provider_hostnameExt'); - $archiveProcessing->archiveDataTable($dataTableToSum, null, $maximumRowsInDataTable); - } -} \ No newline at end of file diff --git a/plugins/Provider/Provider.php b/plugins/Provider/Provider.php index 87c7de7efb..3024858ce6 100644 --- a/plugins/Provider/Provider.php +++ b/plugins/Provider/Provider.php @@ -227,8 +227,8 @@ class Piwik_Provider extends Piwik_Plugin return; } - $archiving = new Piwik_Provider_Archiving(); - $archiving->archiveDay($archiveProcessing); + $archiving = new Piwik_Provider_Archiver($archiveProcessing); + $archiving->archiveDay(); } /** @@ -243,8 +243,8 @@ class Piwik_Provider extends Piwik_Plugin return; } - $archiving = new Piwik_Provider_Archiving(); - $archiving->archivePeriod($archiveProcessing); + $archiving = new Piwik_Provider_Archiver($archiveProcessing); + $archiving->archivePeriod(); } diff --git a/plugins/Referers/Archiver.php b/plugins/Referers/Archiver.php new file mode 100644 index 0000000000..9da5998871 --- /dev/null +++ b/plugins/Referers/Archiver.php @@ -0,0 +1,334 @@ +columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; + $this->maximumRowsInDataTableLevelZero = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_referers']; + $this->maximumRowsInSubDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_subtable_referers']; + } + + public function archiveDay() + { + $query = $this->getProcessor()->queryVisitsByDimension(array("referer_type", "referer_name", "referer_keyword", "referer_url")); + $this->aggregateFromVisits($query); + + $query = $this->getProcessor()->queryConversionsByDimension(array("referer_type", "referer_name", "referer_keyword")); + $this->aggregateFromConversions($query); + + Piwik_PostEvent('Referers.archiveDay', $this); + $this->recordDayReports(); + } + + protected function aggregateFromVisits($query) + { + while ($row = $query->fetch()) { + $this->makeRefererTypeNonEmpty($row); + $this->aggregateVisit($row); + $this->aggregateVisitByType($row); + } + } + + protected function makeRefererTypeNonEmpty(&$row) + { + if (empty($row['referer_type'])) { + $row['referer_type'] = Piwik_Common::REFERER_TYPE_DIRECT_ENTRY; + } + } + + protected function aggregateVisit($row) + { + switch ($row['referer_type']) { + case Piwik_Common::REFERER_TYPE_SEARCH_ENGINE: + $this->aggregateVisitBySearchEngine($row); + break; + + case Piwik_Common::REFERER_TYPE_WEBSITE: + $this->aggregateVisitByWebsite($row); + break; + + case Piwik_Common::REFERER_TYPE_CAMPAIGN: + $this->aggregateVisitByCampaign($row); + break; + + case Piwik_Common::REFERER_TYPE_DIRECT_ENTRY: + // direct entry are aggregated below in $this->metricsByType array + break; + + default: + throw new Exception("Non expected referer_type = " . $row['referer_type']); + break; + } + } + + protected function aggregateVisitBySearchEngine($row) + { + if (empty($row['referer_keyword'])) { + $row['referer_keyword'] = Piwik_Referers_API::LABEL_KEYWORD_NOT_DEFINED; + } + if (!isset($this->metricsBySearchEngine[$row['referer_name']])) { + $this->metricsBySearchEngine[$row['referer_name']] = $this->getProcessor()->makeEmptyRow(); + } + if (!isset($this->metricsByKeyword[$row['referer_keyword']])) { + $this->metricsByKeyword[$row['referer_keyword']] = $this->getProcessor()->makeEmptyRow(); + } + if (!isset($this->metricsBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']])) { + $this->metricsBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']] = $this->getProcessor()->makeEmptyRow(); + } + if (!isset($this->metricsByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']])) { + $this->metricsByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']] = $this->getProcessor()->makeEmptyRow(); + } + + $this->getProcessor()->sumMetrics($row, $this->metricsBySearchEngine[$row['referer_name']]); + $this->getProcessor()->sumMetrics($row, $this->metricsByKeyword[$row['referer_keyword']]); + $this->getProcessor()->sumMetrics($row, $this->metricsBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']]); + $this->getProcessor()->sumMetrics($row, $this->metricsByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']]); + } + + protected function aggregateVisitByWebsite($row) + { + if (!isset($this->metricsByWebsite[$row['referer_name']])) { + $this->metricsByWebsite[$row['referer_name']] = $this->getProcessor()->makeEmptyRow(); + } + $this->getProcessor()->sumMetrics($row, $this->metricsByWebsite[$row['referer_name']]); + + if (!isset($this->metricsByWebsiteAndUrl[$row['referer_name']][$row['referer_url']])) { + $this->metricsByWebsiteAndUrl[$row['referer_name']][$row['referer_url']] = $this->getProcessor()->makeEmptyRow(); + } + $this->getProcessor()->sumMetrics($row, $this->metricsByWebsiteAndUrl[$row['referer_name']][$row['referer_url']]); + + $urlHash = substr(md5($row['referer_url']), 0, 10); + if (!isset($this->distinctUrls[$urlHash])) { + $this->distinctUrls[$urlHash] = true; + } + } + + protected function aggregateVisitByCampaign($row) + { + if (!empty($row['referer_keyword'])) { + if (!isset($this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']])) { + $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']] = $this->getProcessor()->makeEmptyRow(); + } + $this->getProcessor()->sumMetrics($row, $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']]); + } + if (!isset($this->metricsByCampaign[$row['referer_name']])) { + $this->metricsByCampaign[$row['referer_name']] = $this->getProcessor()->makeEmptyRow(); + } + $this->getProcessor()->sumMetrics($row, $this->metricsByCampaign[$row['referer_name']]); + } + + protected function aggregateVisitByType($row) + { + if (!isset($this->metricsByType[$row['referer_type']])) { + $this->metricsByType[$row['referer_type']] = $this->getProcessor()->makeEmptyRow(); + } + $this->getProcessor()->sumMetrics($row, $this->metricsByType[$row['referer_type']]); + } + + protected function aggregateFromConversions($query) + { + if ($query === false) { + return; + } + while ($row = $query->fetch()) { + $this->makeRefererTypeNonEmpty($row); + + $skipAggregateByType = $this->aggregateConversion($row); + if (!$skipAggregateByType) { + $this->aggregateConversionByType($row); + } + } + + $this->getProcessor()->enrichConversionsByLabelArray($this->metricsByType); + $this->getProcessor()->enrichConversionsByLabelArray($this->metricsBySearchEngine); + $this->getProcessor()->enrichConversionsByLabelArray($this->metricsByKeyword); + $this->getProcessor()->enrichConversionsByLabelArray($this->metricsByWebsite); + $this->getProcessor()->enrichConversionsByLabelArray($this->metricsByCampaign); + $this->getProcessor()->enrichConversionsByLabelArrayHasTwoLevels($this->metricsByCampaignAndKeyword); + } + + protected function aggregateConversion($row) + { + $skipAggregateByType = false; + switch ($row['referer_type']) { + case Piwik_Common::REFERER_TYPE_SEARCH_ENGINE: + $this->aggregateConversionBySearchEngine($row); + break; + + case Piwik_Common::REFERER_TYPE_WEBSITE: + $this->aggregateConversionByWebsite($row); + break; + + case Piwik_Common::REFERER_TYPE_CAMPAIGN: + $this->aggregateConversionByCampaign($row); + break; + + case Piwik_Common::REFERER_TYPE_DIRECT_ENTRY: + // Direct entry, no sub dimension + break; + + default: + // The referer type is user submitted for goal conversions, we ignore any malformed value + // Continue to the next while iteration + $skipAggregateByType = true; + break; + } + return $skipAggregateByType; + } + + protected function aggregateConversionBySearchEngine($row) + { + if (empty($row['referer_keyword'])) { + $row['referer_keyword'] = Piwik_Referers_API::LABEL_KEYWORD_NOT_DEFINED; + } + if (!isset($this->metricsBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { + $this->metricsBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $this->getProcessor()->makeEmptyGoalRow($row['idgoal']); + } + if (!isset($this->metricsByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { + $this->metricsByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $this->getProcessor()->makeEmptyGoalRow($row['idgoal']); + } + + $this->getProcessor()->sumGoalMetrics($row, $this->metricsBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + $this->getProcessor()->sumGoalMetrics($row, $this->metricsByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + } + + protected function aggregateConversionByWebsite($row) + { + if (!isset($this->metricsByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { + $this->metricsByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $this->getProcessor()->makeEmptyGoalRow($row['idgoal']); + } + $this->getProcessor()->sumGoalMetrics($row, $this->metricsByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + } + + protected function aggregateConversionByCampaign($row) + { + if (!empty($row['referer_keyword'])) { + if (!isset($this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { + $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $this->getProcessor()->makeEmptyGoalRow($row['idgoal']); + } + $this->getProcessor()->sumGoalMetrics($row, $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + } + if (!isset($this->metricsByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { + $this->metricsByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $this->getProcessor()->makeEmptyGoalRow($row['idgoal']); + } + $this->getProcessor()->sumGoalMetrics($row, $this->metricsByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + } + + protected function aggregateConversionByType($row) + { + if (!isset($this->metricsByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { + $this->metricsByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $this->getProcessor()->makeEmptyGoalRow($row['idgoal']); + } + $this->getProcessor()->sumGoalMetrics($row, $this->metricsByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + } + + /** + * Records the daily stats (numeric or datatable blob) into the archive tables. + * + * @param Piwik_ArchiveProcessing $this->getProcessor() + */ + protected function recordDayReports() + { + $numericRecords = array( + 'Referers_distinctSearchEngines' => count($this->metricsBySearchEngineAndKeyword), + 'Referers_distinctKeywords' => count($this->metricsByKeywordAndSearchEngine), + 'Referers_distinctCampaigns' => count($this->metricsByCampaign), + 'Referers_distinctWebsites' => count($this->metricsByWebsite), + 'Referers_distinctWebsitesUrls' => count($this->distinctUrls), + ); + + foreach ($numericRecords as $name => $value) { + $this->getProcessor()->insertNumericRecord($name, $value); + } + + $dataTable = $this->getProcessor()->getDataTableSerialized($this->metricsByType); + $this->getProcessor()->insertBlobRecord('Referers_type', $dataTable); + destroy($dataTable); + + $blobRecords = array( + 'Referers_keywordBySearchEngine' => $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsBySearchEngineAndKeyword, $this->metricsBySearchEngine), + 'Referers_searchEngineByKeyword' => $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByKeywordAndSearchEngine, $this->metricsByKeyword), + 'Referers_keywordByCampaign' => $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByCampaignAndKeyword, $this->metricsByCampaign), + 'Referers_urlByWebsite' => $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByWebsiteAndUrl, $this->metricsByWebsite), + ); + foreach ($blobRecords as $recordName => $table) { + $blob = $table->getSerialized($this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $this->columnToSortByBeforeTruncation); + $this->getProcessor()->insertBlobRecord($recordName, $blob); + destroy($table); + } + } + + public function archivePeriod() + { + $dataTableToSum = array( + 'Referers_type', + 'Referers_keywordBySearchEngine', + 'Referers_searchEngineByKeyword', + 'Referers_keywordByCampaign', + 'Referers_urlByWebsite', + ); + $nameToCount = $this->getProcessor()->archiveDataTable($dataTableToSum, null, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $this->columnToSortByBeforeTruncation); + + $mappingFromArchiveName = array( + 'Referers_distinctSearchEngines' => + array('typeCountToUse' => 'level0', + 'nameTableToUse' => 'Referers_keywordBySearchEngine', + ), + 'Referers_distinctKeywords' => + array('typeCountToUse' => 'level0', + 'nameTableToUse' => 'Referers_searchEngineByKeyword', + ), + 'Referers_distinctCampaigns' => + array('typeCountToUse' => 'level0', + 'nameTableToUse' => 'Referers_keywordByCampaign', + ), + 'Referers_distinctWebsites' => + array('typeCountToUse' => 'level0', + 'nameTableToUse' => 'Referers_urlByWebsite', + ), + 'Referers_distinctWebsitesUrls' => + array('typeCountToUse' => 'recursive', + 'nameTableToUse' => 'Referers_urlByWebsite', + ), + ); + + foreach ($mappingFromArchiveName as $name => $infoMapping) { + $typeCountToUse = $infoMapping['typeCountToUse']; + $nameTableToUse = $infoMapping['nameTableToUse']; + + if ($typeCountToUse == 'recursive') { + + $countValue = $nameToCount[$nameTableToUse]['recursive'] + - $nameToCount[$nameTableToUse]['level0']; + } else { + $countValue = $nameToCount[$nameTableToUse]['level0']; + } + $this->getProcessor()->insertNumericRecord($name, $countValue); + } + } +} \ No newline at end of file diff --git a/plugins/Referers/Archiving.php b/plugins/Referers/Archiving.php deleted file mode 100644 index 138c3564e3..0000000000 --- a/plugins/Referers/Archiving.php +++ /dev/null @@ -1,333 +0,0 @@ -columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; - $this->maximumRowsInDataTableLevelZero = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_referers']; - $this->maximumRowsInSubDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_subtable_referers']; - } - - public function archiveDay($archiveProcessing) - { - $query = $archiveProcessing->queryVisitsByDimension(array("referer_type", "referer_name", "referer_keyword", "referer_url")); - $this->aggregateFromVisits($archiveProcessing, $query); - - $query = $archiveProcessing->queryConversionsByDimension(array("referer_type", "referer_name", "referer_keyword")); - $this->aggregateFromConversions($archiveProcessing, $query); - - Piwik_PostEvent('Referers.archiveDay', $this); - $this->recordDayReports($archiveProcessing); - } - - protected function aggregateFromVisits(Piwik_ArchiveProcessing_Day $archiveProcessing, $query) - { - $this->metricsBySearchEngine = - $this->metricsByKeyword = - $this->metricsBySearchEngineAndKeyword = - $this->metricsByKeywordAndSearchEngine = - $this->metricsByWebsite = - $this->metricsByWebsiteAndUrl = - $this->metricsByCampaignAndKeyword = - $this->metricsByCampaign = - $this->metricsByType = - $this->distinctUrls = array(); - while ($row = $query->fetch()) { - $this->makeRefererTypeNonEmpty($row); - $this->aggregateVisit($archiveProcessing, $row); - $this->aggregateVisitByType($archiveProcessing, $row); - } - } - - protected function makeRefererTypeNonEmpty(&$row) - { - if (empty($row['referer_type'])) { - $row['referer_type'] = Piwik_Common::REFERER_TYPE_DIRECT_ENTRY; - } - } - - protected function aggregateVisit(Piwik_ArchiveProcessing_Day $archiveProcessing, $row) - { - switch ($row['referer_type']) { - case Piwik_Common::REFERER_TYPE_SEARCH_ENGINE: - $this->aggregateVisitBySearchEngine($archiveProcessing, $row); - break; - - case Piwik_Common::REFERER_TYPE_WEBSITE: - $this->aggregateVisitByWebsite($archiveProcessing, $row); - break; - - case Piwik_Common::REFERER_TYPE_CAMPAIGN: - $this->aggregateVisitByCampaign($archiveProcessing, $row); - break; - - case Piwik_Common::REFERER_TYPE_DIRECT_ENTRY: - // direct entry are aggregated below in $this->metricsByType array - break; - - default: - throw new Exception("Non expected referer_type = " . $row['referer_type']); - break; - } - } - - protected function aggregateVisitBySearchEngine(Piwik_ArchiveProcessing_Day $archiveProcessing, $row) - { - if (empty($row['referer_keyword'])) { - $row['referer_keyword'] = Piwik_Referers_API::LABEL_KEYWORD_NOT_DEFINED; - } - if (!isset($this->metricsBySearchEngine[$row['referer_name']])) { - $this->metricsBySearchEngine[$row['referer_name']] = $archiveProcessing->makeEmptyRow(); - } - if (!isset($this->metricsByKeyword[$row['referer_keyword']])) { - $this->metricsByKeyword[$row['referer_keyword']] = $archiveProcessing->makeEmptyRow(); - } - if (!isset($this->metricsBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']])) { - $this->metricsBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']] = $archiveProcessing->makeEmptyRow(); - } - if (!isset($this->metricsByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']])) { - $this->metricsByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']] = $archiveProcessing->makeEmptyRow(); - } - - $archiveProcessing->sumMetrics($row, $this->metricsBySearchEngine[$row['referer_name']]); - $archiveProcessing->sumMetrics($row, $this->metricsByKeyword[$row['referer_keyword']]); - $archiveProcessing->sumMetrics($row, $this->metricsBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']]); - $archiveProcessing->sumMetrics($row, $this->metricsByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']]); - } - - protected function aggregateVisitByWebsite(Piwik_ArchiveProcessing_Day $archiveProcessing, $row) - { - if (!isset($this->metricsByWebsite[$row['referer_name']])) { - $this->metricsByWebsite[$row['referer_name']] = $archiveProcessing->makeEmptyRow(); - } - $archiveProcessing->sumMetrics($row, $this->metricsByWebsite[$row['referer_name']]); - - if (!isset($this->metricsByWebsiteAndUrl[$row['referer_name']][$row['referer_url']])) { - $this->metricsByWebsiteAndUrl[$row['referer_name']][$row['referer_url']] = $archiveProcessing->makeEmptyRow(); - } - $archiveProcessing->sumMetrics($row, $this->metricsByWebsiteAndUrl[$row['referer_name']][$row['referer_url']]); - - $urlHash = substr(md5($row['referer_url']), 0, 10); - if (!isset($this->distinctUrls[$urlHash])) { - $this->distinctUrls[$urlHash] = true; - } - } - - protected function aggregateVisitByCampaign(Piwik_ArchiveProcessing_Day $archiveProcessing, $row) - { - if (!empty($row['referer_keyword'])) { - if (!isset($this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']])) { - $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']] = $archiveProcessing->makeEmptyRow(); - } - $archiveProcessing->sumMetrics($row, $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']]); - } - if (!isset($this->metricsByCampaign[$row['referer_name']])) { - $this->metricsByCampaign[$row['referer_name']] = $archiveProcessing->makeEmptyRow(); - } - $archiveProcessing->sumMetrics($row, $this->metricsByCampaign[$row['referer_name']]); - } - - protected function aggregateVisitByType(Piwik_ArchiveProcessing_Day $archiveProcessing, $row) - { - if (!isset($this->metricsByType[$row['referer_type']])) { - $this->metricsByType[$row['referer_type']] = $archiveProcessing->makeEmptyRow(); - } - $archiveProcessing->sumMetrics($row, $this->metricsByType[$row['referer_type']]); - } - - protected function aggregateFromConversions($archiveProcessing, $query) - { - if ($query === false) { - return; - } - while ($row = $query->fetch()) { - $this->makeRefererTypeNonEmpty($row); - - $skipAggregateByType = $this->aggregateConversion($archiveProcessing, $row); - if (!$skipAggregateByType) { - $this->aggregateConversionByType($archiveProcessing, $row); - } - } - - $archiveProcessing->enrichConversionsByLabelArray($this->metricsByType); - $archiveProcessing->enrichConversionsByLabelArray($this->metricsBySearchEngine); - $archiveProcessing->enrichConversionsByLabelArray($this->metricsByKeyword); - $archiveProcessing->enrichConversionsByLabelArray($this->metricsByWebsite); - $archiveProcessing->enrichConversionsByLabelArray($this->metricsByCampaign); - $archiveProcessing->enrichConversionsByLabelArrayHasTwoLevels($this->metricsByCampaignAndKeyword); - } - - protected function aggregateConversion($archiveProcessing, $row) - { - $skipAggregateByType = false; - switch ($row['referer_type']) { - case Piwik_Common::REFERER_TYPE_SEARCH_ENGINE: - $this->aggregateConversionBySearchEngine($archiveProcessing, $row); - break; - - case Piwik_Common::REFERER_TYPE_WEBSITE: - $this->aggregateConversionByWebsite($archiveProcessing, $row); - break; - - case Piwik_Common::REFERER_TYPE_CAMPAIGN: - $this->aggregateConversionByCampaign($archiveProcessing, $row); - break; - - case Piwik_Common::REFERER_TYPE_DIRECT_ENTRY: - // Direct entry, no sub dimension - break; - - default: - // The referer type is user submitted for goal conversions, we ignore any malformed value - // Continue to the next while iteration - $skipAggregateByType = true; - break; - } - return $skipAggregateByType; - } - - protected function aggregateConversionBySearchEngine($archiveProcessing, $row) - { - if (empty($row['referer_keyword'])) { - $row['referer_keyword'] = Piwik_Referers_API::LABEL_KEYWORD_NOT_DEFINED; - } - if (!isset($this->metricsBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { - $this->metricsBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); - } - if (!isset($this->metricsByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { - $this->metricsByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); - } - - $archiveProcessing->sumGoalMetrics($row, $this->metricsBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - $archiveProcessing->sumGoalMetrics($row, $this->metricsByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - } - - protected function aggregateConversionByWebsite($archiveProcessing, $row) - { - if (!isset($this->metricsByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { - $this->metricsByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); - } - $archiveProcessing->sumGoalMetrics($row, $this->metricsByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - } - - protected function aggregateConversionByCampaign($archiveProcessing, $row) - { - if (!empty($row['referer_keyword'])) { - if (!isset($this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { - $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); - } - $archiveProcessing->sumGoalMetrics($row, $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - } - if (!isset($this->metricsByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { - $this->metricsByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); - } - $archiveProcessing->sumGoalMetrics($row, $this->metricsByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - } - - protected function aggregateConversionByType($archiveProcessing, $row) - { - if (!isset($this->metricsByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { - $this->metricsByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $archiveProcessing->makeEmptyGoalRow($row['idgoal']); - } - $archiveProcessing->sumGoalMetrics($row, $this->metricsByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - } - - /** - * Records the daily stats (numeric or datatable blob) into the archive tables. - * - * @param Piwik_ArchiveProcessing $archiveProcessing - */ - protected function recordDayReports($archiveProcessing) - { - $numericRecords = array( - 'Referers_distinctSearchEngines' => count($this->metricsBySearchEngineAndKeyword), - 'Referers_distinctKeywords' => count($this->metricsByKeywordAndSearchEngine), - 'Referers_distinctCampaigns' => count($this->metricsByCampaign), - 'Referers_distinctWebsites' => count($this->metricsByWebsite), - 'Referers_distinctWebsitesUrls' => count($this->distinctUrls), - ); - - foreach ($numericRecords as $name => $value) { - $archiveProcessing->insertNumericRecord($name, $value); - } - - $dataTable = $archiveProcessing->getDataTableSerialized($this->metricsByType); - $archiveProcessing->insertBlobRecord('Referers_type', $dataTable); - destroy($dataTable); - - $blobRecords = array( - 'Referers_keywordBySearchEngine' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsBySearchEngineAndKeyword, $this->metricsBySearchEngine), - 'Referers_searchEngineByKeyword' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByKeywordAndSearchEngine, $this->metricsByKeyword), - 'Referers_keywordByCampaign' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByCampaignAndKeyword, $this->metricsByCampaign), - 'Referers_urlByWebsite' => $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByWebsiteAndUrl, $this->metricsByWebsite), - ); - foreach ($blobRecords as $recordName => $table) { - $blob = $table->getSerialized($this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $this->columnToSortByBeforeTruncation); - $archiveProcessing->insertBlobRecord($recordName, $blob); - destroy($table); - } - } - - public function archivePeriod($archiveProcessing) - { - $dataTableToSum = array( - 'Referers_type', - 'Referers_keywordBySearchEngine', - 'Referers_searchEngineByKeyword', - 'Referers_keywordByCampaign', - 'Referers_urlByWebsite', - ); - $nameToCount = $archiveProcessing->archiveDataTable($dataTableToSum, null, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $this->columnToSortByBeforeTruncation); - - $mappingFromArchiveName = array( - 'Referers_distinctSearchEngines' => - array('typeCountToUse' => 'level0', - 'nameTableToUse' => 'Referers_keywordBySearchEngine', - ), - 'Referers_distinctKeywords' => - array('typeCountToUse' => 'level0', - 'nameTableToUse' => 'Referers_searchEngineByKeyword', - ), - 'Referers_distinctCampaigns' => - array('typeCountToUse' => 'level0', - 'nameTableToUse' => 'Referers_keywordByCampaign', - ), - 'Referers_distinctWebsites' => - array('typeCountToUse' => 'level0', - 'nameTableToUse' => 'Referers_urlByWebsite', - ), - 'Referers_distinctWebsitesUrls' => - array('typeCountToUse' => 'recursive', - 'nameTableToUse' => 'Referers_urlByWebsite', - ), - ); - - foreach ($mappingFromArchiveName as $name => $infoMapping) { - $typeCountToUse = $infoMapping['typeCountToUse']; - $nameTableToUse = $infoMapping['nameTableToUse']; - - if ($typeCountToUse == 'recursive') { - - $countValue = $nameToCount[$nameTableToUse]['recursive'] - - $nameToCount[$nameTableToUse]['level0']; - } else { - $countValue = $nameToCount[$nameTableToUse]['level0']; - } - $archiveProcessing->insertNumericRecord($name, $countValue); - } - } -} \ No newline at end of file diff --git a/plugins/Referers/Referers.php b/plugins/Referers/Referers.php index 814e78f19b..443c2e50c4 100644 --- a/plugins/Referers/Referers.php +++ b/plugins/Referers/Referers.php @@ -299,8 +299,8 @@ class Piwik_Referers extends Piwik_Plugin return; } - $archiving = new Piwik_Referers_Archiving(); - $archiving->archiveDay($archiveProcessing); + $archiving = new Piwik_Referers_Archiver($archiveProcessing); + $archiving->archiveDay(); } @@ -320,7 +320,7 @@ class Piwik_Referers extends Piwik_Plugin return; } - $archiving = new Piwik_Referers_Archiving(); - $archiving->archivePeriod($archiveProcessing); + $archiving = new Piwik_Referers_Archiver($archiveProcessing); + $archiving->archivePeriod(); } } diff --git a/plugins/UserCountry/API.php b/plugins/UserCountry/API.php index 36dfffe418..ec8c8c1275 100644 --- a/plugins/UserCountry/API.php +++ b/plugins/UserCountry/API.php @@ -32,7 +32,7 @@ class Piwik_UserCountry_API public function getCountry($idSite, $period, $date, $segment = false) { - $recordName = Piwik_UserCountry_Archiving::VISITS_BY_COUNTRY_RECORD_NAME; + $recordName = Piwik_UserCountry_Archiver::VISITS_BY_COUNTRY_RECORD_NAME; $dataTable = $this->getDataTable($recordName, $idSite, $period, $date, $segment); // apply filter on the whole datatable in order the inline search to work (searches @@ -48,7 +48,7 @@ class Piwik_UserCountry_API public function getContinent($idSite, $period, $date, $segment = false) { - $recordName = Piwik_UserCountry_Archiving::VISITS_BY_COUNTRY_RECORD_NAME; + $recordName = Piwik_UserCountry_Archiver::VISITS_BY_COUNTRY_RECORD_NAME; $dataTable = $this->getDataTable($recordName, $idSite, $period, $date, $segment); $getContinent = array('Piwik_Common', 'getContinent'); @@ -71,10 +71,10 @@ class Piwik_UserCountry_API */ public function getRegion($idSite, $period, $date, $segment = false) { - $recordName = Piwik_UserCountry_Archiving::VISITS_BY_REGION_RECORD_NAME; + $recordName = Piwik_UserCountry_Archiver::VISITS_BY_REGION_RECORD_NAME; $dataTable = $this->getDataTable($recordName, $idSite, $period, $date, $segment); - $separator = Piwik_UserCountry_Archiving::LOCATION_SEPARATOR; + $separator = Piwik_UserCountry_Archiver::LOCATION_SEPARATOR; $unk = Piwik_Tracker_Visit::UNKNOWN_CODE; // split the label and put the elements into the 'region' and 'country' metadata fields @@ -114,10 +114,10 @@ class Piwik_UserCountry_API */ public function getCity($idSite, $period, $date, $segment = false) { - $recordName = Piwik_UserCountry_Archiving::VISITS_BY_CITY_RECORD_NAME; + $recordName = Piwik_UserCountry_Archiver::VISITS_BY_CITY_RECORD_NAME; $dataTable = $this->getDataTable($recordName, $idSite, $period, $date, $segment); - $separator = Piwik_UserCountry_Archiving::LOCATION_SEPARATOR; + $separator = Piwik_UserCountry_Archiver::LOCATION_SEPARATOR; $unk = Piwik_Tracker_Visit::UNKNOWN_CODE; // split the label and put the elements into the 'city_name', 'region', 'country', diff --git a/plugins/UserCountry/Archiver.php b/plugins/UserCountry/Archiver.php new file mode 100644 index 0000000000..5f2a30310b --- /dev/null +++ b/plugins/UserCountry/Archiver.php @@ -0,0 +1,201 @@ +metricsByDimension = array('location_country' => array(), + 'location_region' => array(), + 'location_city' => array()); + $this->aggregateFromVisits(); + $this->aggregateFromConversions(); + $this->recordDayReports(); + } + + protected function aggregateFromVisits() + { + $dimensions = array_keys($this->metricsByDimension); + $query = $this->getProcessor()->queryVisitsByDimension( + $dimensions, + $where = '', + $metrics = false, + $orderBy = false, + $rankingQuery = null, + $addSelect = 'MAX(log_visit.location_latitude) as location_latitude, + MAX(log_visit.location_longitude) as location_longitude' + ); + + if ($query === false) { + return; + } + + while ($row = $query->fetch()) { + $this->makeRegionCityLabelsUnique($row); + $this->rememberCityLatLong($row); + $this->aggregateVisit($row); + } + } + + /** + * Makes sure the region and city of a query row are unique. + * + * @param array $row + */ + private function makeRegionCityLabelsUnique(&$row) + { + static $locationColumns = array('location_region', 'location_country', 'location_city'); + + // to be on the safe side, remove the location separator from the region/city/country we + // get from the query + foreach ($locationColumns as $column) { + $row[$column] = str_replace(self::LOCATION_SEPARATOR, '', $row[$column]); + } + + if (!empty($row['location_region'])) // do not differentiate between unknown regions + { + $row['location_region'] = $row['location_region'] . self::LOCATION_SEPARATOR . $row['location_country']; + } + + if (!empty($row['location_city'])) // do not differentiate between unknown cities + { + $row['location_city'] = $row['location_city'] . self::LOCATION_SEPARATOR . $row['location_region']; + } + } + + protected function rememberCityLatLong($row) + { + $lat = $long = false; + if (!empty($row['location_city'])) { + if (!empty($row['location_latitude'])) { + $lat = $row['location_latitude']; + } + if (!empty($row['location_longitude'])) { + $long = $row['location_longitude']; + } + } + + // store latitude/longitude, if we should + if ($lat !== false && $long !== false + && empty($this->latLongForCities[$row['location_city']]) + ) { + $this->latLongForCities[$row['location_city']] = array($lat, $long); + } + } + + protected function aggregateVisit($row) + { + foreach ($this->metricsByDimension as $dimension => &$table) { + $label = (string)$row[$dimension]; + + if (!isset($table[$label])) { + $table[$label] = $this->getProcessor()->makeEmptyRow(); + } + $this->getProcessor()->sumMetrics($row, $table[$label]); + } + } + + protected function aggregateFromConversions() + { + $dimensions = array_keys($this->metricsByDimension); + $query = $this->getProcessor()->queryConversionsByDimension($dimensions); + + if ($query === false) { + return; + } + + while ($row = $query->fetch()) { + $this->makeRegionCityLabelsUnique($row); + + $idGoal = $row['idgoal']; + foreach ($this->metricsByDimension as $dimension => &$table) { + $label = (string)$row[$dimension]; + + if (!isset($table[$label][Piwik_Archive::INDEX_GOALS][$idGoal])) { + $table[$label][Piwik_Archive::INDEX_GOALS][$idGoal] = $this->getProcessor()->makeEmptyGoalRow($idGoal); + } + $this->getProcessor()->sumGoalMetrics($row, $table[$label][Piwik_Archive::INDEX_GOALS][$idGoal]); + } + } + + foreach ($this->metricsByDimension as &$table) { + $this->getProcessor()->enrichConversionsByLabelArray($table); + } + } + + protected function recordDayReports() + { + $maximumRows = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; + + $tableCountry = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->metricsByDimension['location_country']); + $this->getProcessor()->insertBlobRecord(self::VISITS_BY_COUNTRY_RECORD_NAME, $tableCountry->getSerialized()); + $this->getProcessor()->insertNumericRecord(self::DISTINCT_COUNTRIES_METRIC, $tableCountry->getRowsCount()); + destroy($tableCountry); + + $tableRegion = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->metricsByDimension['location_region']); + $serialized = $tableRegion->getSerialized($maximumRows, $maximumRows, Piwik_Archive::INDEX_NB_VISITS); + $this->getProcessor()->insertBlobRecord(self::VISITS_BY_REGION_RECORD_NAME, $serialized); + destroy($tableRegion); + + $tableCity = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->metricsByDimension['location_city']); + $this->setLatitudeLongitude($tableCity); + $serialized = $tableCity->getSerialized($maximumRows, $maximumRows, Piwik_Archive::INDEX_NB_VISITS); + $this->getProcessor()->insertBlobRecord(self::VISITS_BY_CITY_RECORD_NAME, $serialized); + destroy($tableCity); + } + + /** + * Utility method, appends latitude/longitude pairs to city table labels, if that data + * exists for the city. + */ + private function setLatitudeLongitude(Piwik_DataTable $tableCity) + { + foreach ($tableCity->getRows() as $row) { + $label = $row->getColumn('label'); + if (isset($this->latLongForCities[$label])) { + // get lat/long for city + list($lat, $long) = $this->latLongForCities[$label]; + $lat = round($lat, Piwik_UserCountry_LocationProvider::GEOGRAPHIC_COORD_PRECISION); + $long = round($long, Piwik_UserCountry_LocationProvider::GEOGRAPHIC_COORD_PRECISION); + + // set latitude + longitude metadata + $row->setMetadata('lat', $lat); + $row->setMetadata('long', $long); + } + } + } + + public function archivePeriod() + { + $dataTableToSum = array( + self::VISITS_BY_COUNTRY_RECORD_NAME, + self::VISITS_BY_REGION_RECORD_NAME, + self::VISITS_BY_CITY_RECORD_NAME, + ); + + $nameToCount = $this->getProcessor()->archiveDataTable($dataTableToSum); + $this->getProcessor()->insertNumericRecord(self::DISTINCT_COUNTRIES_METRIC, + $nameToCount[self::VISITS_BY_COUNTRY_RECORD_NAME]['level0']); + } + +} \ No newline at end of file diff --git a/plugins/UserCountry/Archiving.php b/plugins/UserCountry/Archiving.php deleted file mode 100644 index 505b740fa5..0000000000 --- a/plugins/UserCountry/Archiving.php +++ /dev/null @@ -1,203 +0,0 @@ -metricsByDimension = array('location_country' => array(), - 'location_region' => array(), - 'location_city' => array()); - $this->aggregateFromVisits($archiveProcessing); - $this->aggregateFromConversions($archiveProcessing); - $this->recordDayReports($archiveProcessing); - } - - protected function aggregateFromVisits($archiveProcessing) - { - $dimensions = array_keys($this->metricsByDimension); - $query = $archiveProcessing->queryVisitsByDimension( - $dimensions, - $where = '', - $metrics = false, - $orderBy = false, - $rankingQuery = null, - $addSelect = 'MAX(log_visit.location_latitude) as location_latitude, - MAX(log_visit.location_longitude) as location_longitude' - ); - - if ($query === false) { - return; - } - - while ($row = $query->fetch()) { - $this->makeRegionCityLabelsUnique($row); - $this->rememberCityLatLong($row); - $this->aggregateVisit($archiveProcessing, $row); - } - } - - /** - * Makes sure the region and city of a query row are unique. - * - * @param array $row - */ - private function makeRegionCityLabelsUnique(&$row) - { - static $locationColumns = array('location_region', 'location_country', 'location_city'); - - // to be on the safe side, remove the location separator from the region/city/country we - // get from the query - foreach ($locationColumns as $column) { - $row[$column] = str_replace(self::LOCATION_SEPARATOR, '', $row[$column]); - } - - if (!empty($row['location_region'])) // do not differentiate between unknown regions - { - $row['location_region'] = $row['location_region'] . self::LOCATION_SEPARATOR . $row['location_country']; - } - - if (!empty($row['location_city'])) // do not differentiate between unknown cities - { - $row['location_city'] = $row['location_city'] . self::LOCATION_SEPARATOR . $row['location_region']; - } - } - - protected function rememberCityLatLong($row) - { - $lat = $long = false; - if (!empty($row['location_city'])) { - if (!empty($row['location_latitude'])) { - $lat = $row['location_latitude']; - } - if (!empty($row['location_longitude'])) { - $long = $row['location_longitude']; - } - } - - // store latitude/longitude, if we should - if ($lat !== false && $long !== false - && empty($this->latLongForCities[$row['location_city']]) - ) { - $this->latLongForCities[$row['location_city']] = array($lat, $long); - } - } - - protected function aggregateVisit($archiveProcessing, $row) - { - foreach ($this->metricsByDimension as $dimension => &$table) { - $label = (string)$row[$dimension]; - - if (!isset($table[$label])) { - $table[$label] = $archiveProcessing->makeEmptyRow(); - } - $archiveProcessing->sumMetrics($row, $table[$label]); - } - return $table; - } - - /** - * @param Piwik_ArchiveProcessing_Day $archiveProcessing - */ - protected function aggregateFromConversions($archiveProcessing) - { - $dimensions = array_keys($this->metricsByDimension); - $query = $archiveProcessing->queryConversionsByDimension($dimensions); - - if ($query === false) { - return; - } - - while ($row = $query->fetch()) { - $this->makeRegionCityLabelsUnique($row); - - $idGoal = $row['idgoal']; - foreach ($this->metricsByDimension as $dimension => &$table) { - $label = (string)$row[$dimension]; - - if (!isset($table[$label][Piwik_Archive::INDEX_GOALS][$idGoal])) { - $table[$label][Piwik_Archive::INDEX_GOALS][$idGoal] = $archiveProcessing->makeEmptyGoalRow($idGoal); - } - $archiveProcessing->sumGoalMetrics($row, $table[$label][Piwik_Archive::INDEX_GOALS][$idGoal]); - } - } - - foreach ($this->metricsByDimension as &$table) { - $archiveProcessing->enrichConversionsByLabelArray($table); - } - } - - protected function recordDayReports($archiveProcessing) - { - $maximumRows = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; - - $tableCountry = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->metricsByDimension['location_country']); - $archiveProcessing->insertBlobRecord(self::VISITS_BY_COUNTRY_RECORD_NAME, $tableCountry->getSerialized()); - $archiveProcessing->insertNumericRecord(self::DISTINCT_COUNTRIES_METRIC, $tableCountry->getRowsCount()); - destroy($tableCountry); - - $tableRegion = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->metricsByDimension['location_region']); - $serialized = $tableRegion->getSerialized($maximumRows, $maximumRows, Piwik_Archive::INDEX_NB_VISITS); - $archiveProcessing->insertBlobRecord(self::VISITS_BY_REGION_RECORD_NAME, $serialized); - destroy($tableRegion); - - $tableCity = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->metricsByDimension['location_city']); - $this->setLatitudeLongitude($tableCity); - $serialized = $tableCity->getSerialized($maximumRows, $maximumRows, Piwik_Archive::INDEX_NB_VISITS); - $archiveProcessing->insertBlobRecord(self::VISITS_BY_CITY_RECORD_NAME, $serialized); - destroy($tableCity); - } - - /** - * Utility method, appends latitude/longitude pairs to city table labels, if that data - * exists for the city. - */ - private function setLatitudeLongitude($tableCity) - { - foreach ($tableCity->getRows() as $row) { - $label = $row->getColumn('label'); - if (isset($this->latLongForCities[$label])) { - // get lat/long for city - list($lat, $long) = $this->latLongForCities[$label]; - $lat = round($lat, Piwik_UserCountry_LocationProvider::GEOGRAPHIC_COORD_PRECISION); - $long = round($long, Piwik_UserCountry_LocationProvider::GEOGRAPHIC_COORD_PRECISION); - - // set latitude + longitude metadata - $row->setMetadata('lat', $lat); - $row->setMetadata('long', $long); - } - } - } - - public function archivePeriod($archiveProcessing) - { - $dataTableToSum = array( - self::VISITS_BY_COUNTRY_RECORD_NAME, - self::VISITS_BY_REGION_RECORD_NAME, - self::VISITS_BY_CITY_RECORD_NAME, - ); - - $nameToCount = $archiveProcessing->archiveDataTable($dataTableToSum); - $archiveProcessing->insertNumericRecord(self::DISTINCT_COUNTRIES_METRIC, - $nameToCount[self::VISITS_BY_COUNTRY_RECORD_NAME]['level0']); - } - -} \ No newline at end of file diff --git a/plugins/UserCountry/UserCountry.php b/plugins/UserCountry/UserCountry.php index fb928ba67b..e282e8a854 100644 --- a/plugins/UserCountry/UserCountry.php +++ b/plugins/UserCountry/UserCountry.php @@ -296,8 +296,8 @@ class Piwik_UserCountry extends Piwik_Plugin return; } - $archiving = new Piwik_UserCountry_Archiving(); - $archiving->archivePeriod($archiveProcessing); + $archiving = new Piwik_UserCountry_Archiver($archiveProcessing); + $archiving->archivePeriod(); } /** @@ -311,8 +311,8 @@ class Piwik_UserCountry extends Piwik_Plugin return; } - $archiving = new Piwik_UserCountry_Archiving(); - $archiving->archiveDay($archiveProcessing); + $archiving = new Piwik_UserCountry_Archiver($archiveProcessing); + $archiving->archiveDay(); } diff --git a/plugins/UserCountry/functions.php b/plugins/UserCountry/functions.php index 072c54030b..d9e467f69c 100644 --- a/plugins/UserCountry/functions.php +++ b/plugins/UserCountry/functions.php @@ -92,7 +92,7 @@ function Piwik_UserCountry_getRegionName($label) return Piwik_Translate('General_Unknown'); } - list($regionCode, $countryCode) = explode(Piwik_UserCountry_Archiving::LOCATION_SEPARATOR, $label); + list($regionCode, $countryCode) = explode(Piwik_UserCountry_Archiver::LOCATION_SEPARATOR, $label); return Piwik_UserCountry_LocationProvider_GeoIp::getRegionNameFromCodes($countryCode, $regionCode); } @@ -114,7 +114,7 @@ function Piwik_UserCountry_getPrettyRegionName($label) return Piwik_Translate('General_Unknown'); } - list($regionCode, $countryCode) = explode(Piwik_UserCountry_Archiving::LOCATION_SEPARATOR, $label); + list($regionCode, $countryCode) = explode(Piwik_UserCountry_Archiver::LOCATION_SEPARATOR, $label); $result = Piwik_UserCountry_LocationProvider_GeoIp::getRegionNameFromCodes($countryCode, $regionCode); if ($countryCode != Piwik_Tracker_Visit::UNKNOWN_CODE && $countryCode != '') { @@ -143,7 +143,7 @@ function Piwik_UserCountry_getPrettyCityName($label) } // get city name, region code & country code - $parts = explode(Piwik_UserCountry_Archiving::LOCATION_SEPARATOR, $label); + $parts = explode(Piwik_UserCountry_Archiver::LOCATION_SEPARATOR, $label); $cityName = $parts[0]; $regionCode = $parts[1]; $countryCode = $parts[2]; diff --git a/plugins/UserSettings/Archiver.php b/plugins/UserSettings/Archiver.php new file mode 100644 index 0000000000..d8039d9fd7 --- /dev/null +++ b/plugins/UserSettings/Archiver.php @@ -0,0 +1,148 @@ +maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; + $this->columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; + } + + public function archiveDay() + { + $this->aggregateByConfiguration(); + $this->aggregateByOs(); + $this->aggregateByBrowser(); + $this->aggregateByResolutionAndScreenType(); + $this->aggregateByPlugin(); + $this->aggregateByLanguage(); + } + + protected function aggregateByConfiguration() + { + $labelSQL = "CONCAT(log_visit.config_os, ';', log_visit.config_browser_name, ';', log_visit.config_resolution)"; + $metrics = $this->getProcessor()->getMetricsForLabel($labelSQL); + $table = $this->getProcessor()->getDataTableFromArray($metrics); + $this->getProcessor()->insertBlobRecord(self::CONFIGURATION_RECORD_NAME, $table->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + } + + protected function aggregateByOs() + { + $metrics = $this->getProcessor()->getMetricsForLabel("log_visit.config_os"); + $table = $this->getProcessor()->getDataTableFromArray($metrics); + $this->getProcessor()->insertBlobRecord(self::OS_RECORD_NAME, $table->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + } + + protected function aggregateByBrowser() + { + $tableBrowser = $this->aggregateByBrowserVersion(); + $this->aggregateByBrowserType($tableBrowser); + } + + protected function aggregateByBrowserVersion() + { + $labelSQL = "CONCAT(log_visit.config_browser_name, ';', log_visit.config_browser_version)"; + $metrics = $this->getProcessor()->getMetricsForLabel($labelSQL); + $tableBrowser = $this->getProcessor()->getDataTableFromArray($metrics); + + $this->getProcessor()->insertBlobRecord(self::BROWSER_RECORD_NAME, $tableBrowser->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + return $tableBrowser; + } + + protected function aggregateByBrowserType(Piwik_DataTable $tableBrowser) + { + $tableBrowser->filter('GroupBy', array('label', 'Piwik_getBrowserFamily')); + $this->getProcessor()->insertBlobRecord(self::BROWSER_TYPE_RECORD_NAME, $tableBrowser->getSerialized()); + } + + protected function aggregateByResolutionAndScreenType() + { + $resolutions = $this->aggregateByResolution(); + $this->aggregateByScreenType($resolutions); + } + + protected function aggregateByResolution() + { + $metrics = $this->getProcessor()->getMetricsForLabel("log_visit.config_resolution"); + $table = $this->getProcessor()->getDataTableFromArray($metrics); + $table->filter('ColumnCallbackDeleteRow', array('label', 'Piwik_UserSettings_keepStrlenGreater')); + $this->getProcessor()->insertBlobRecord(self::RESOLUTION_RECORD_NAME, $table->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + return $table; + } + + protected function aggregateByScreenType(Piwik_DataTable $resolutions) + { + $resolutions->filter('GroupBy', array('label', 'Piwik_getScreenTypeFromResolution')); + $this->getProcessor()->insertBlobRecord(self::SCREEN_TYPES_RECORD_NAME, $resolutions->getSerialized()); + } + + protected function aggregateByPlugin() + { + $toSelect = "sum(case log_visit.config_pdf when 1 then 1 else 0 end) as pdf, + sum(case log_visit.config_flash when 1 then 1 else 0 end) as flash, + sum(case log_visit.config_java when 1 then 1 else 0 end) as java, + sum(case log_visit.config_director when 1 then 1 else 0 end) as director, + sum(case log_visit.config_quicktime when 1 then 1 else 0 end) as quicktime, + sum(case log_visit.config_realplayer when 1 then 1 else 0 end) as realplayer, + sum(case log_visit.config_windowsmedia when 1 then 1 else 0 end) as windowsmedia, + sum(case log_visit.config_gears when 1 then 1 else 0 end) as gears, + sum(case log_visit.config_silverlight when 1 then 1 else 0 end) as silverlight, + sum(case log_visit.config_cookie when 1 then 1 else 0 end) as cookie "; + $table = $this->getProcessor()->getSimpleDataTableFromSelect($toSelect, Piwik_Archive::INDEX_NB_VISITS); + $this->getProcessor()->insertBlobRecord(self::PLUGIN_RECORD_NAME, $table->getSerialized()); + } + + protected function aggregateByLanguage() + { + $query = $this->getProcessor()->queryVisitsByDimension("log_visit.location_browser_lang"); + $languageCodes = array_keys(Piwik_Common::getLanguagesList()); + $metricsByLanguage = array(); + while ($row = $query->fetch()) { + $code = Piwik_Common::extractLanguageCodeFromBrowserLanguage($row['label'], $languageCodes); + + if (!isset($metricsByLanguage[$code])) { + $metricsByLanguage[$code] = $this->getProcessor()->makeEmptyRow(); + } + $this->getProcessor()->sumMetrics($row, $metricsByLanguage[$code]); + } + + $tableLanguage = $this->getProcessor()->getDataTableFromArray($metricsByLanguage); + $this->getProcessor()->insertBlobRecord(self::LANGUAGE_RECORD_NAME, $tableLanguage->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + } + + public function archivePeriod() + { + $dataTableToSum = array( + self::CONFIGURATION_RECORD_NAME, + self::OS_RECORD_NAME, + self::BROWSER_RECORD_NAME, + self::BROWSER_TYPE_RECORD_NAME, + self::RESOLUTION_RECORD_NAME, + self::SCREEN_TYPES_RECORD_NAME, + self::PLUGIN_RECORD_NAME, + self::LANGUAGE_RECORD_NAME, + ); + $this->getProcessor()->archiveDataTable($dataTableToSum, null, $this->maximumRowsInDataTable); + } +} \ No newline at end of file diff --git a/plugins/UserSettings/Archiving.php b/plugins/UserSettings/Archiving.php deleted file mode 100644 index dabc57365d..0000000000 --- a/plugins/UserSettings/Archiving.php +++ /dev/null @@ -1,147 +0,0 @@ -maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; - $this->columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; - } - - public function archiveDay($archiveProcessing) - { - $this->aggregateByConfiguration($archiveProcessing); - $this->aggregateByOs($archiveProcessing); - $this->aggregateByBrowser($archiveProcessing); - $this->aggregateByResolutionAndScreenType($archiveProcessing); - $this->aggregateByPlugin($archiveProcessing); - $this->aggregateByLanguage($archiveProcessing); - } - - protected function aggregateByConfiguration($archiveProcessing) - { - $labelSQL = "CONCAT(log_visit.config_os, ';', log_visit.config_browser_name, ';', log_visit.config_resolution)"; - $metrics = $archiveProcessing->getMetricsForLabel($labelSQL); - $table = $archiveProcessing->getDataTableFromArray($metrics); - $archiveProcessing->insertBlobRecord(self::CONFIGURATION_RECORD_NAME, $table->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); - } - - protected function aggregateByOs($archiveProcessing) - { - $metrics = $archiveProcessing->getMetricsForLabel("log_visit.config_os"); - $table = $archiveProcessing->getDataTableFromArray($metrics); - $archiveProcessing->insertBlobRecord(self::OS_RECORD_NAME, $table->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); - } - - protected function aggregateByBrowser($archiveProcessing) - { - $tableBrowser = $this->aggregateByBrowserVersion($archiveProcessing); - $this->aggregateByBrowserType($archiveProcessing, $tableBrowser); - } - - protected function aggregateByBrowserVersion($archiveProcessing) - { - $labelSQL = "CONCAT(log_visit.config_browser_name, ';', log_visit.config_browser_version)"; - $metrics = $archiveProcessing->getMetricsForLabel($labelSQL); - $tableBrowser = $archiveProcessing->getDataTableFromArray($metrics); - - $archiveProcessing->insertBlobRecord(self::BROWSER_RECORD_NAME, $tableBrowser->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); - return $tableBrowser; - } - - protected function aggregateByBrowserType($archiveProcessing, $tableBrowser) - { - $tableBrowser->filter('GroupBy', array('label', 'Piwik_getBrowserFamily')); - $archiveProcessing->insertBlobRecord(self::BROWSER_TYPE_RECORD_NAME, $tableBrowser->getSerialized()); - } - - protected function aggregateByResolutionAndScreenType($archiveProcessing) - { - $resolutions = $this->aggregateByResolution($archiveProcessing); - $this->aggregateByScreenType($archiveProcessing, $resolutions); - } - - protected function aggregateByResolution($archiveProcessing) - { - $metrics = $archiveProcessing->getMetricsForLabel("log_visit.config_resolution"); - $table = $archiveProcessing->getDataTableFromArray($metrics); - $table->filter('ColumnCallbackDeleteRow', array('label', 'Piwik_UserSettings_keepStrlenGreater')); - $archiveProcessing->insertBlobRecord(self::RESOLUTION_RECORD_NAME, $table->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); - return $table; - } - - protected function aggregateByScreenType($archiveProcessing, Piwik_DataTable $resolutions) - { - $resolutions->filter('GroupBy', array('label', 'Piwik_getScreenTypeFromResolution')); - $archiveProcessing->insertBlobRecord(self::SCREEN_TYPES_RECORD_NAME, $resolutions->getSerialized()); - } - - protected function aggregateByPlugin($archiveProcessing) - { - $toSelect = "sum(case log_visit.config_pdf when 1 then 1 else 0 end) as pdf, - sum(case log_visit.config_flash when 1 then 1 else 0 end) as flash, - sum(case log_visit.config_java when 1 then 1 else 0 end) as java, - sum(case log_visit.config_director when 1 then 1 else 0 end) as director, - sum(case log_visit.config_quicktime when 1 then 1 else 0 end) as quicktime, - sum(case log_visit.config_realplayer when 1 then 1 else 0 end) as realplayer, - sum(case log_visit.config_windowsmedia when 1 then 1 else 0 end) as windowsmedia, - sum(case log_visit.config_gears when 1 then 1 else 0 end) as gears, - sum(case log_visit.config_silverlight when 1 then 1 else 0 end) as silverlight, - sum(case log_visit.config_cookie when 1 then 1 else 0 end) as cookie "; - $table = $archiveProcessing->getSimpleDataTableFromSelect($toSelect, Piwik_Archive::INDEX_NB_VISITS); - $archiveProcessing->insertBlobRecord(self::PLUGIN_RECORD_NAME, $table->getSerialized()); - } - - protected function aggregateByLanguage($archiveProcessing) - { - $query = $archiveProcessing->queryVisitsByDimension("log_visit.location_browser_lang"); - $languageCodes = array_keys(Piwik_Common::getLanguagesList()); - $metricsByLanguage = array(); - while ($row = $query->fetch()) { - $code = Piwik_Common::extractLanguageCodeFromBrowserLanguage($row['label'], $languageCodes); - - if (!isset($metricsByLanguage[$code])) { - $metricsByLanguage[$code] = $archiveProcessing->makeEmptyRow(); - } - $archiveProcessing->sumMetrics($row, $metricsByLanguage[$code]); - } - - $tableLanguage = $archiveProcessing->getDataTableFromArray($metricsByLanguage); - $archiveProcessing->insertBlobRecord(self::LANGUAGE_RECORD_NAME, $tableLanguage->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); - } - - public function archivePeriod($archiveProcessing) - { - $dataTableToSum = array( - self::CONFIGURATION_RECORD_NAME, - self::OS_RECORD_NAME, - self::BROWSER_RECORD_NAME, - self::BROWSER_TYPE_RECORD_NAME, - self::RESOLUTION_RECORD_NAME, - self::SCREEN_TYPES_RECORD_NAME, - self::PLUGIN_RECORD_NAME, - self::LANGUAGE_RECORD_NAME, - ); - $archiveProcessing->archiveDataTable($dataTableToSum, null, $this->maximumRowsInDataTable); - } -} \ No newline at end of file diff --git a/plugins/UserSettings/UserSettings.php b/plugins/UserSettings/UserSettings.php index 914f0694c4..be9bbc0341 100644 --- a/plugins/UserSettings/UserSettings.php +++ b/plugins/UserSettings/UserSettings.php @@ -276,8 +276,8 @@ class Piwik_UserSettings extends Piwik_Plugin if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $archiving = new Piwik_UserSettings_Archiving(); - $archiving->archiveDay($archiveProcessing); + $archiving = new Piwik_UserSettings_Archiver($archiveProcessing); + $archiving->archiveDay(); } @@ -293,7 +293,7 @@ class Piwik_UserSettings extends Piwik_Plugin if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $archiving = new Piwik_UserSettings_Archiving(); - $archiving->archivePeriod($archiveProcessing); + $archiving = new Piwik_UserSettings_Archiver($archiveProcessing); + $archiving->archivePeriod(); } } diff --git a/plugins/VisitFrequency/Archiver.php b/plugins/VisitFrequency/Archiver.php new file mode 100644 index 0000000000..2ebb4dc5c4 --- /dev/null +++ b/plugins/VisitFrequency/Archiver.php @@ -0,0 +1,66 @@ += ? + AND log_visit.visit_last_action_time <= ? + AND log_visit.idsite = ? + AND log_visit.visitor_returning >= 1"; + + $bind = array($this->getProcessor()->getStartDatetimeUTC(), + $this->getProcessor()->getEndDatetimeUTC(), $this->getProcessor()->idsite); + + $query = $this->getProcessor()->getSegment()->getSelectQuery($select, $from, $where, $bind); + + $row = $this->getProcessor()->db->fetchRow($query['sql'], $query['bind']); + + if ($row === false || $row === null) { + $row['nb_visits_returning'] = 0; + $row['nb_actions_returning'] = 0; + $row['max_actions_returning'] = 0; + $row['sum_visit_length_returning'] = 0; + $row['bounce_count_returning'] = 0; + $row['nb_visits_converted_returning'] = 0; + } + + foreach ($row as $name => $value) { + $this->getProcessor()->insertNumericRecord($name, $value); + } + } + + public function archivePeriod() + { + $numericToSum = array( + 'nb_visits_returning', + 'nb_actions_returning', + 'sum_visit_length_returning', + 'bounce_count_returning', + 'nb_visits_converted_returning', + ); + $this->getProcessor()->archiveNumericValuesSum($numericToSum); + $this->getProcessor()->archiveNumericValuesMax('max_actions_returning'); + } +} \ No newline at end of file diff --git a/plugins/VisitFrequency/Archiving.php b/plugins/VisitFrequency/Archiving.php deleted file mode 100644 index f4f38110ea..0000000000 --- a/plugins/VisitFrequency/Archiving.php +++ /dev/null @@ -1,66 +0,0 @@ -= ? - AND log_visit.visit_last_action_time <= ? - AND log_visit.idsite = ? - AND log_visit.visitor_returning >= 1"; - - $bind = array($archiveProcessing->getStartDatetimeUTC(), - $archiveProcessing->getEndDatetimeUTC(), $archiveProcessing->idsite); - - $query = $archiveProcessing->getSegment()->getSelectQuery($select, $from, $where, $bind); - - $row = $archiveProcessing->db->fetchRow($query['sql'], $query['bind']); - - if ($row === false || $row === null) { - $row['nb_visits_returning'] = 0; - $row['nb_actions_returning'] = 0; - $row['max_actions_returning'] = 0; - $row['sum_visit_length_returning'] = 0; - $row['bounce_count_returning'] = 0; - $row['nb_visits_converted_returning'] = 0; - } - - foreach ($row as $name => $value) { - $archiveProcessing->insertNumericRecord($name, $value); - } - } - - public function archivePeriod($archiveProcessing) - { - $numericToSum = array( - 'nb_visits_returning', - 'nb_actions_returning', - 'sum_visit_length_returning', - 'bounce_count_returning', - 'nb_visits_converted_returning', - ); - $archiveProcessing->archiveNumericValuesSum($numericToSum); - $archiveProcessing->archiveNumericValuesMax('max_actions_returning'); - } -} \ No newline at end of file diff --git a/plugins/VisitFrequency/VisitFrequency.php b/plugins/VisitFrequency/VisitFrequency.php index 93118af576..62ef2b967f 100644 --- a/plugins/VisitFrequency/VisitFrequency.php +++ b/plugins/VisitFrequency/VisitFrequency.php @@ -83,8 +83,8 @@ class Piwik_VisitFrequency extends Piwik_Plugin $archiveProcessing = $notification->getNotificationObject(); if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $archiving = new Piwik_VisitFrequency_Archiving(); - $archiving->archiveDay($archiveProcessing); + $archiving = new Piwik_VisitFrequency_Archiver($archiveProcessing); + $archiving->archiveDay(); } function archivePeriod($notification) @@ -92,8 +92,8 @@ class Piwik_VisitFrequency extends Piwik_Plugin $archiveProcessing = $notification->getNotificationObject(); if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $archiving = new Piwik_VisitFrequency_Archiving(); - $archiving->archivePeriod($archiveProcessing); + $archiving = new Piwik_VisitFrequency_Archiver($archiveProcessing); + $archiving->archivePeriod(); } } diff --git a/plugins/VisitTime/VisitTime.php b/plugins/VisitTime/VisitTime.php index d74af3162c..ad60091430 100644 --- a/plugins/VisitTime/VisitTime.php +++ b/plugins/VisitTime/VisitTime.php @@ -136,20 +136,18 @@ class Piwik_VisitTime extends Piwik_Plugin if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $dataTableToSum = array( - 'VisitTime_localTime', - 'VisitTime_serverTime', - ); - $archiveProcessing->archiveDataTable($dataTableToSum); + $archiving = new Piwik_VisitTime_Archiver($archiveProcessing); + $archiving->archivePeriod(); } + public function archiveDay($notification) { $archiveProcessing = $notification->getNotificationObject(); if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $archiving = new Piwik_VisitTime_Archiving(); - $archiving->archiveDay($archiveProcessing); + $archiving = new Piwik_VisitTime_Archiver($archiveProcessing); + $archiving->archiveDay(); } } diff --git a/plugins/VisitorInterest/Archiver.php b/plugins/VisitorInterest/Archiver.php new file mode 100644 index 0000000000..8008671d9b --- /dev/null +++ b/plugins/VisitorInterest/Archiver.php @@ -0,0 +1,182 @@ +getProcessor()->queryVisitsSimple(implode(',', $selects)); + + // archive visits by total time report + $recordName = 'VisitorInterest_timeGap'; + $this->archiveRangeStats($recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $timeGapPrefix); + + // archive visits by total actions report + $recordName = 'VisitorInterest_pageGap'; + $this->archiveRangeStats($recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $pageGapPrefix); + + // archive visits by visit number report + $recordName = 'VisitorInterest_visitsByVisitCount'; + $this->archiveRangeStats($recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $visitsByVisitNumPrefix); + + // archive days since last visit report + $recordName = 'VisitorInterest_daysSinceLastVisit'; + $this->archiveRangeStats($recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $daysSinceLastVisitPrefix); + } + + public function archivePeriod() + { + $dataTableToSum = array( + 'VisitorInterest_timeGap', + 'VisitorInterest_pageGap', + 'VisitorInterest_visitsByVisitCount', + 'VisitorInterest_daysSinceLastVisit' + ); + $this->getProcessor()->archiveDataTable($dataTableToSum); + } + + + /** + * Transforms and returns the set of ranges used to calculate the 'visits by total time' + * report from ranges in minutes to equivalent ranges in seconds. + */ + protected static function getSecondsGap() + { + $secondsGap = array(); + foreach (self::$timeGap as $gap) { + if (count($gap) == 3 && $gap[2] == 's') // if the units are already in seconds, just assign them + { + $secondsGap[] = array($gap[0], $gap[1]); + } else if (count($gap) == 2) { + $secondsGap[] = array($gap[0] * 60, $gap[1] * 60); + } else { + $secondsGap[] = array($gap[0] * 60); + } + } + return $secondsGap; + } + + /** + * Creates and archives a DataTable from some (or all) elements of a supplied database + * row. + * + * @param string $recordName The record name to use when inserting the new archive. + * @param array $row The database row to use. + * @param string $selectAsPrefix The string to look for as the prefix of SELECT as + * expressions. Elements in $row that have a SELECT as + * with this string as a prefix are used in creating + * the DataTable.' + */ + protected function archiveRangeStats($recordName, $row, $index, $selectAsPrefix) + { + $dataTable = $this->getProcessor()->getSimpleDataTableFromRow($row, $index, $selectAsPrefix); + + $this->getProcessor()->insertBlobRecord($recordName, $dataTable->getSerialized()); + } +} \ No newline at end of file diff --git a/plugins/VisitorInterest/Archiving.php b/plugins/VisitorInterest/Archiving.php deleted file mode 100644 index 124d3cc3b9..0000000000 --- a/plugins/VisitorInterest/Archiving.php +++ /dev/null @@ -1,182 +0,0 @@ -queryVisitsSimple(implode(',', $selects)); - - // archive visits by total time report - $recordName = 'VisitorInterest_timeGap'; - $this->archiveRangeStats($archiveProcessing, $recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $timeGapPrefix); - - // archive visits by total actions report - $recordName = 'VisitorInterest_pageGap'; - $this->archiveRangeStats($archiveProcessing, $recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $pageGapPrefix); - - // archive visits by visit number report - $recordName = 'VisitorInterest_visitsByVisitCount'; - $this->archiveRangeStats($archiveProcessing, $recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $visitsByVisitNumPrefix); - - // archive days since last visit report - $recordName = 'VisitorInterest_daysSinceLastVisit'; - $this->archiveRangeStats($archiveProcessing, $recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $daysSinceLastVisitPrefix); - } - - public function archivePeriod(Piwik_ArchiveProcessing $archiveProcessing) - { - $dataTableToSum = array( - 'VisitorInterest_timeGap', - 'VisitorInterest_pageGap', - 'VisitorInterest_visitsByVisitCount', - 'VisitorInterest_daysSinceLastVisit' - ); - $archiveProcessing->archiveDataTable($dataTableToSum); - } - - - /** - * Transforms and returns the set of ranges used to calculate the 'visits by total time' - * report from ranges in minutes to equivalent ranges in seconds. - */ - protected static function getSecondsGap() - { - $secondsGap = array(); - foreach (self::$timeGap as $gap) { - if (count($gap) == 3 && $gap[2] == 's') // if the units are already in seconds, just assign them - { - $secondsGap[] = array($gap[0], $gap[1]); - } else if (count($gap) == 2) { - $secondsGap[] = array($gap[0] * 60, $gap[1] * 60); - } else { - $secondsGap[] = array($gap[0] * 60); - } - } - return $secondsGap; - } - - /** - * Creates and archives a DataTable from some (or all) elements of a supplied database - * row. - * - * @param string $recordName The record name to use when inserting the new archive. - * @param array $row The database row to use. - * @param string $selectAsPrefix The string to look for as the prefix of SELECT as - * expressions. Elements in $row that have a SELECT as - * with this string as a prefix are used in creating - * the DataTable.' - */ - protected function archiveRangeStats($archiveProcessing, $recordName, $row, $index, $selectAsPrefix) - { - $dataTable = $archiveProcessing->getSimpleDataTableFromRow($row, $index, $selectAsPrefix); - - $archiveProcessing->insertBlobRecord($recordName, $dataTable->getSerialized()); - } -} \ No newline at end of file diff --git a/plugins/VisitorInterest/VisitorInterest.php b/plugins/VisitorInterest/VisitorInterest.php index 3f5c219871..b3f948d93e 100644 --- a/plugins/VisitorInterest/VisitorInterest.php +++ b/plugins/VisitorInterest/VisitorInterest.php @@ -128,8 +128,8 @@ class Piwik_VisitorInterest extends Piwik_Plugin $archiveProcessing = $notification->getNotificationObject(); if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $archiving = new Piwik_VisitorInterest_Archiving(); - $archiving->archivePeriod($archiveProcessing); + $archiving = new Piwik_VisitorInterest_Archiver($archiveProcessing); + $archiving->archivePeriod(); } public function archiveDay($notification) @@ -137,8 +137,8 @@ class Piwik_VisitorInterest extends Piwik_Plugin $archiveProcessing = $notification->getNotificationObject(); if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $archiving = new Piwik_VisitorInterest_Archiving(); - $archiving->archiveDay($archiveProcessing); + $archiving = new Piwik_VisitorInterest_Archiver($archiveProcessing); + $archiving->archiveDay(); } -- cgit v1.2.3 From 83a116879ff29b784721ee1109cbc2c358ed1ec2 Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 6 Jun 2013 15:52:35 +1200 Subject: factoring out the shouldArchive logic --- plugins/Actions/Actions.php | 17 +++++++---------- plugins/CustomVariables/CustomVariables.php | 18 ++++++------------ plugins/DevicesDetection/DevicesDetection.php | 17 ++++++----------- plugins/Goals/Archiver.php | 2 +- plugins/Goals/Goals.php | 17 ++++++----------- plugins/Provider/Provider.php | 16 ++++++---------- plugins/Referers/Referers.php | 24 ++++++------------------ plugins/UserCountry/UserCountry.php | 14 ++++++-------- plugins/UserSettings/UserSettings.php | 12 ++++++------ plugins/VisitFrequency/VisitFrequency.php | 10 ++++++---- plugins/VisitTime/VisitTime.php | 12 ++++++------ plugins/VisitorInterest/VisitorInterest.php | 10 ++++++---- 12 files changed, 68 insertions(+), 101 deletions(-) (limited to 'plugins') diff --git a/plugins/Actions/Actions.php b/plugins/Actions/Actions.php index 0d1fb2f02d..d54a11c65d 100644 --- a/plugins/Actions/Actions.php +++ b/plugins/Actions/Actions.php @@ -576,25 +576,22 @@ class Piwik_Actions extends Piwik_Plugin /* @var $archiveProcessing Piwik_ArchiveProcessing_Day */ $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { - return; - } - $archiving = new Piwik_Actions_Archiver($archiveProcessing); - $archiving->archiveDay(); + if($archiving->shouldArchive()) { + $archiving->archiveDay(); + } } function archivePeriod($notification) { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { - return; + $archiving = new Piwik_Actions_Archiver($archiveProcessing); + if($archiving->shouldArchive()) { + $archiving->archivePeriod(); } - - $actionsArchiving = new Piwik_Actions_Archiver($archiveProcessing); - return $actionsArchiving->archivePeriod(); } + static public function checkCustomVariablesPluginEnabled() { if (!self::isCustomVariablesPluginsEnabled()) { diff --git a/plugins/CustomVariables/CustomVariables.php b/plugins/CustomVariables/CustomVariables.php index 313632e411..d0c0b9d759 100644 --- a/plugins/CustomVariables/CustomVariables.php +++ b/plugins/CustomVariables/CustomVariables.php @@ -148,15 +148,12 @@ class Piwik_CustomVariables extends Piwik_Plugin */ public function archiveDay($notification) { - /** @var Piwik_ArchiveProcessing_Day $archiveProcessing */ $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { - return; - } - $archiving = new Piwik_CustomVariables_Archiver($archiveProcessing); - $archiving->archiveDay(); + if($archiving->shouldArchive()) { + $archiving->archiveDay(); + } } /** @@ -165,13 +162,10 @@ class Piwik_CustomVariables extends Piwik_Plugin function archivePeriod($notification) { $archiveProcessing = $notification->getNotificationObject(); - - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { - return; - } - $archiving = new Piwik_CustomVariables_Archiver($archiveProcessing); - $archiving->archivePeriod(); + if($archiving->shouldArchive()) { + $archiving->archivePeriod(); + } } } diff --git a/plugins/DevicesDetection/DevicesDetection.php b/plugins/DevicesDetection/DevicesDetection.php index da83595d99..37ef364ebe 100644 --- a/plugins/DevicesDetection/DevicesDetection.php +++ b/plugins/DevicesDetection/DevicesDetection.php @@ -241,24 +241,19 @@ class Piwik_DevicesDetection extends Piwik_Plugin { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { - return; - } - $archiving = new Piwik_DevicesDetection_Archiver($archiveProcessing); - $archiving->archiveDay(); + if($archiving->shouldArchive()) { + $archiving->archiveDay(); + } } public function archivePeriod($notification) { - $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { - return; - } - $archiving = new Piwik_DevicesDetection_Archiver($archiveProcessing); - $archiving->archivePeriod(); + if($archiving->shouldArchive()) { + $archiving->archivePeriod(); + } } public function addMenu() diff --git a/plugins/Goals/Archiver.php b/plugins/Goals/Archiver.php index 191ae96c6a..7effc4e4f7 100644 --- a/plugins/Goals/Archiver.php +++ b/plugins/Goals/Archiver.php @@ -314,7 +314,7 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver // Per item doesn't support segment // Also, when querying Goal metrics for visitorType==returning, we wouldnt want to trigger an extra request // event if it did support segment - // (if this is implented, we should have shouldProcessReportsForPlugin() support partial archiving based on which metric is requested) + // (when this is implemented, we should have shouldProcessReportsForPlugin() support partial archiving based on which metric is requested) if (!$this->getProcessor()->getSegment()->isEmpty()) { return false; } diff --git a/plugins/Goals/Goals.php b/plugins/Goals/Goals.php index 85a629c4d8..14a2054646 100644 --- a/plugins/Goals/Goals.php +++ b/plugins/Goals/Goals.php @@ -513,10 +513,10 @@ class Piwik_Goals extends Piwik_Plugin */ $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $archiving = new Piwik_Goals_Archiver($archiveProcessing); - $archiving->archiveDay(); + if($archiving->shouldArchive()) { + $archiving->archiveDay(); + } } /** @@ -528,16 +528,11 @@ class Piwik_Goals extends Piwik_Plugin */ function archivePeriod($notification) { - /** - * @var Piwik_ArchiveProcessing - */ $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { - return; - } - $archiving = new Piwik_Goals_Archiver($archiveProcessing); - $archiving->archivePeriod(); + if$archiving->shouldArchive()) { + $archiving->archivePeriod(); + } } } diff --git a/plugins/Provider/Provider.php b/plugins/Provider/Provider.php index 3024858ce6..a93f48be77 100644 --- a/plugins/Provider/Provider.php +++ b/plugins/Provider/Provider.php @@ -223,12 +223,10 @@ class Piwik_Provider extends Piwik_Plugin { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { - return; - } - $archiving = new Piwik_Provider_Archiver($archiveProcessing); - $archiving->archiveDay(); + if($archiving->shouldArchive()) { + $archiving->archiveDay(); + } } /** @@ -239,12 +237,10 @@ class Piwik_Provider extends Piwik_Plugin { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { - return; - } - $archiving = new Piwik_Provider_Archiver($archiveProcessing); - $archiving->archivePeriod(); + if($archiving->shouldArchive()) { + $archiving->archivePeriod(); + } } diff --git a/plugins/Referers/Referers.php b/plugins/Referers/Referers.php index 443c2e50c4..c00f580a03 100644 --- a/plugins/Referers/Referers.php +++ b/plugins/Referers/Referers.php @@ -282,45 +282,33 @@ class Piwik_Referers extends Piwik_Plugin )); } - /** * Hooks on daily archive to trigger various log processing * * @param Piwik_Event_Notification $notification notification object - * @return void */ public function archiveDay($notification) { - /** - * @var Piwik_ArchiveProcessing_Day - */ $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { - return; - } $archiving = new Piwik_Referers_Archiver($archiveProcessing); - $archiving->archiveDay(); + if ($archiving->shouldArchive()) { + $archiving->archiveDay(); + } } - - /** * Period archiving: sums up daily stats and sums report tables, * making sure that tables are still truncated. * * @param Piwik_Event_Notification $notification notification object - * @return void */ function archivePeriod($notification) { $archiveProcessing = $notification->getNotificationObject(); - - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { - return; - } - $archiving = new Piwik_Referers_Archiver($archiveProcessing); - $archiving->archivePeriod(); + if($archiving->shouldArchive()) { + $archiving->archivePeriod(); + } } } diff --git a/plugins/UserCountry/UserCountry.php b/plugins/UserCountry/UserCountry.php index e282e8a854..b6df074492 100644 --- a/plugins/UserCountry/UserCountry.php +++ b/plugins/UserCountry/UserCountry.php @@ -292,12 +292,11 @@ class Piwik_UserCountry extends Piwik_Plugin function archivePeriod($notification) { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { - return; - } $archiving = new Piwik_UserCountry_Archiver($archiveProcessing); - $archiving->archivePeriod(); + if($archiving->shouldArchive()) { + $archiving->archivePeriod(); + } } /** @@ -307,12 +306,11 @@ class Piwik_UserCountry extends Piwik_Plugin function archiveDay($notification) { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) { - return; - } $archiving = new Piwik_UserCountry_Archiver($archiveProcessing); - $archiving->archiveDay(); + if($archiving->shouldArchive()) { + $archiving->archiveDay(); + } } diff --git a/plugins/UserSettings/UserSettings.php b/plugins/UserSettings/UserSettings.php index be9bbc0341..e97518c840 100644 --- a/plugins/UserSettings/UserSettings.php +++ b/plugins/UserSettings/UserSettings.php @@ -274,10 +274,10 @@ class Piwik_UserSettings extends Piwik_Plugin { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $archiving = new Piwik_UserSettings_Archiver($archiveProcessing); - $archiving->archiveDay(); + if($archiving->shouldArchive()) { + $archiving->archiveDay(); + } } @@ -291,9 +291,9 @@ class Piwik_UserSettings extends Piwik_Plugin { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $archiving = new Piwik_UserSettings_Archiver($archiveProcessing); - $archiving->archivePeriod(); + if($archiving->shouldArchive()) { + $archiving->archivePeriod(); + } } } diff --git a/plugins/VisitFrequency/VisitFrequency.php b/plugins/VisitFrequency/VisitFrequency.php index 62ef2b967f..d2df343de0 100644 --- a/plugins/VisitFrequency/VisitFrequency.php +++ b/plugins/VisitFrequency/VisitFrequency.php @@ -81,19 +81,21 @@ class Piwik_VisitFrequency extends Piwik_Plugin function archiveDay($notification) { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; $archiving = new Piwik_VisitFrequency_Archiver($archiveProcessing); - $archiving->archiveDay(); + if($archiving->shouldArchive()) { + $archiving->archiveDay(); + } } function archivePeriod($notification) { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; $archiving = new Piwik_VisitFrequency_Archiver($archiveProcessing); - $archiving->archivePeriod(); + if($archiving->shouldArchive()) { + $archiving->archivePeriod(); + } } } diff --git a/plugins/VisitTime/VisitTime.php b/plugins/VisitTime/VisitTime.php index ad60091430..6208da6c64 100644 --- a/plugins/VisitTime/VisitTime.php +++ b/plugins/VisitTime/VisitTime.php @@ -134,20 +134,20 @@ class Piwik_VisitTime extends Piwik_Plugin { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $archiving = new Piwik_VisitTime_Archiver($archiveProcessing); - $archiving->archivePeriod(); + if($archiving->shouldArchive()) { + $archiving->archivePeriod(); + } } public function archiveDay($notification) { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; - $archiving = new Piwik_VisitTime_Archiver($archiveProcessing); - $archiving->archiveDay(); + if($archiving->shouldArchive()) { + $archiving->archiveDay(); + } } } diff --git a/plugins/VisitorInterest/VisitorInterest.php b/plugins/VisitorInterest/VisitorInterest.php index b3f948d93e..583e8c31da 100644 --- a/plugins/VisitorInterest/VisitorInterest.php +++ b/plugins/VisitorInterest/VisitorInterest.php @@ -126,19 +126,21 @@ class Piwik_VisitorInterest extends Piwik_Plugin function archivePeriod($notification) { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; $archiving = new Piwik_VisitorInterest_Archiver($archiveProcessing); - $archiving->archivePeriod(); + if($archiving->shouldArchive()) { + $archiving->archivePeriod(); + } } public function archiveDay($notification) { $archiveProcessing = $notification->getNotificationObject(); - if (!$archiveProcessing->shouldProcessReportsForPlugin($this->getPluginName())) return; $archiving = new Piwik_VisitorInterest_Archiver($archiveProcessing); - $archiving->archiveDay(); + if($archiving->shouldArchive()) { + $archiving->archiveDay(); + } } -- cgit v1.2.3 From 911bdef9646e69ece5792d47c7b93569e1fc0155 Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 6 Jun 2013 16:23:11 +1200 Subject: fix --- plugins/Goals/Goals.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'plugins') diff --git a/plugins/Goals/Goals.php b/plugins/Goals/Goals.php index 14a2054646..024cd562f1 100644 --- a/plugins/Goals/Goals.php +++ b/plugins/Goals/Goals.php @@ -531,7 +531,7 @@ class Piwik_Goals extends Piwik_Plugin $archiveProcessing = $notification->getNotificationObject(); $archiving = new Piwik_Goals_Archiver($archiveProcessing); - if$archiving->shouldArchive()) { + if($archiving->shouldArchive()) { $archiving->archivePeriod(); } } -- cgit v1.2.3 From 23b825db3025eecfe5f0979eb1d255d51ce2e5e2 Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 6 Jun 2013 16:58:04 +1200 Subject: missed these earlier, factoring out --- plugins/VisitTime/Archiver.php | 81 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 plugins/VisitTime/Archiver.php (limited to 'plugins') diff --git a/plugins/VisitTime/Archiver.php b/plugins/VisitTime/Archiver.php new file mode 100644 index 0000000000..36b3c94aeb --- /dev/null +++ b/plugins/VisitTime/Archiver.php @@ -0,0 +1,81 @@ +aggregateByLocalTime(); + $this->aggregateByServerTime(); + } + + protected function aggregateByServerTime() + { + $metricsByServerTime = $this->getProcessor()->getMetricsForLabel("HOUR(log_visit.visit_last_action_time)"); + $query = $this->getProcessor()->queryConversionsByDimension("HOUR(log_conversion.server_time)"); + + if ($query === false) return; + + while ($row = $query->fetch()) { + if (!isset($metricsByServerTime[$row['label']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { + $metricsByServerTime[$row['label']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $this->getProcessor()->makeEmptyGoalRow($row['idgoal']); + } + $this->getProcessor()->sumGoalMetrics($row, $metricsByServerTime[$row['label']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + } + $this->getProcessor()->enrichConversionsByLabelArray($metricsByServerTime); + + $metricsByServerTime = $this->convertServerTimeToLocalTimezone($metricsByServerTime); + $tableServerTime = $this->getProcessor()->getDataTableFromArray($metricsByServerTime); + $this->makeSureAllHoursAreSet($tableServerTime); + $this->getProcessor()->insertBlobRecord('VisitTime_serverTime', $tableServerTime->getSerialized()); + } + + protected function aggregateByLocalTime() + { + $metricsByLocalTime = $this->getProcessor()->getMetricsForLabel("HOUR(log_visit.visitor_localtime)"); + $tableLocalTime = $this->getProcessor()->getDataTableFromArray($metricsByLocalTime); + $this->makeSureAllHoursAreSet($tableLocalTime); + $this->getProcessor()->insertBlobRecord('VisitTime_localTime', $tableLocalTime->getSerialized()); + } + + protected function convertServerTimeToLocalTimezone($metricsByServerTime) + { + $date = Piwik_Date::factory($this->getProcessor()->getStartDatetimeUTC())->toString(); + $timezone = $this->getProcessor()->site->getTimezone(); + $visitsByHourTz = array(); + foreach ($metricsByServerTime as $hour => $stats) { + $datetime = $date . ' ' . $hour . ':00:00'; + $hourInTz = (int)Piwik_Date::factory($datetime, $timezone)->toString('H'); + $visitsByHourTz[$hourInTz] = $stats; + } + return $visitsByHourTz; + } + + + private function makeSureAllHoursAreSet($table) + { + for ($i = 0; $i <= 23; $i++) { + if ($table->getRowFromLabel($i) === false) { + $row = $this->getProcessor()->makeEmptyRowLabeled($i); + $table->addRow($row); + } + } + } + + public function archivePeriod() + { + $dataTableToSum = array( + 'VisitTime_localTime', + 'VisitTime_serverTime', + ); + $this->getProcessor()->archiveDataTable($dataTableToSum); + } +} \ No newline at end of file -- cgit v1.2.3 From 3fe760eaf2c811978f1ca6ba8056c50983a40f99 Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 6 Jun 2013 19:26:36 +1200 Subject: Removing what seems to be unused code? @sgiehl you added it but I cant find any code calling generateDatatable. --- plugins/CustomVariables/Archiver.php | 4 +-- plugins/Referers/Archiver.php | 50 +++++++++++++++++++++--------------- plugins/UserCountry/Archiver.php | 2 +- plugins/UserSettings/Archiver.php | 7 +++-- plugins/VisitTime/Archiver.php | 2 +- 5 files changed, 38 insertions(+), 27 deletions(-) (limited to 'plugins') diff --git a/plugins/CustomVariables/Archiver.php b/plugins/CustomVariables/Archiver.php index 2aab034424..896b5335bc 100644 --- a/plugins/CustomVariables/Archiver.php +++ b/plugins/CustomVariables/Archiver.php @@ -33,8 +33,8 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver } $this->removeVisitsMetricsFromActionsAggregate(); - $this->getProcessor()->enrichConversionsByLabelArray($this->metricsByKey); - $this->getProcessor()->enrichConversionsByLabelArrayHasTwoLevels($this->metricsByKeyAndValue); + $this->getProcessor()->enrichMetricsWithConversions($this->metricsByKey); + $this->getProcessor()->enrichPivotMetricsWithConversions($this->metricsByKeyAndValue); $table = $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByKeyAndValue, $this->metricsByKey); $blob = $table->getSerialized( diff --git a/plugins/Referers/Archiver.php b/plugins/Referers/Archiver.php index 9da5998871..f540d1c2a2 100644 --- a/plugins/Referers/Archiver.php +++ b/plugins/Referers/Archiver.php @@ -164,12 +164,12 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver } } - $this->getProcessor()->enrichConversionsByLabelArray($this->metricsByType); - $this->getProcessor()->enrichConversionsByLabelArray($this->metricsBySearchEngine); - $this->getProcessor()->enrichConversionsByLabelArray($this->metricsByKeyword); - $this->getProcessor()->enrichConversionsByLabelArray($this->metricsByWebsite); - $this->getProcessor()->enrichConversionsByLabelArray($this->metricsByCampaign); - $this->getProcessor()->enrichConversionsByLabelArrayHasTwoLevels($this->metricsByCampaignAndKeyword); + $this->getProcessor()->enrichMetricsWithConversions($this->metricsByType); + $this->getProcessor()->enrichMetricsWithConversions($this->metricsBySearchEngine); + $this->getProcessor()->enrichMetricsWithConversions($this->metricsByKeyword); + $this->getProcessor()->enrichMetricsWithConversions($this->metricsByWebsite); + $this->getProcessor()->enrichMetricsWithConversions($this->metricsByCampaign); + $this->getProcessor()->enrichPivotMetricsWithConversions($this->metricsByCampaignAndKeyword); } protected function aggregateConversion($row) @@ -254,21 +254,15 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver */ protected function recordDayReports() { - $numericRecords = array( - 'Referers_distinctSearchEngines' => count($this->metricsBySearchEngineAndKeyword), - 'Referers_distinctKeywords' => count($this->metricsByKeywordAndSearchEngine), - 'Referers_distinctCampaigns' => count($this->metricsByCampaign), - 'Referers_distinctWebsites' => count($this->metricsByWebsite), - 'Referers_distinctWebsitesUrls' => count($this->distinctUrls), - ); - - foreach ($numericRecords as $name => $value) { - $this->getProcessor()->insertNumericRecord($name, $value); - } + $this->recordDayNumeric(); + $this->recordDayBlobs(); + } - $dataTable = $this->getProcessor()->getDataTableSerialized($this->metricsByType); - $this->getProcessor()->insertBlobRecord('Referers_type', $dataTable); - destroy($dataTable); + protected function recordDayBlobs() + { + $table = new Piwik_DataTable(); + $table->addRowsFromArrayWithIndexLabel($this->metricsByType); + $this->getProcessor()->insertBlobRecord('Referers_type', $table->getSerialized()); $blobRecords = array( 'Referers_keywordBySearchEngine' => $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsBySearchEngineAndKeyword, $this->metricsBySearchEngine), @@ -279,7 +273,21 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver foreach ($blobRecords as $recordName => $table) { $blob = $table->getSerialized($this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $this->columnToSortByBeforeTruncation); $this->getProcessor()->insertBlobRecord($recordName, $blob); - destroy($table); + } + } + + protected function recordDayNumeric() + { + $numericRecords = array( + 'Referers_distinctSearchEngines' => count($this->metricsBySearchEngineAndKeyword), + 'Referers_distinctKeywords' => count($this->metricsByKeywordAndSearchEngine), + 'Referers_distinctCampaigns' => count($this->metricsByCampaign), + 'Referers_distinctWebsites' => count($this->metricsByWebsite), + 'Referers_distinctWebsitesUrls' => count($this->distinctUrls), + ); + + foreach ($numericRecords as $name => $value) { + $this->getProcessor()->insertNumericRecord($name, $value); } } diff --git a/plugins/UserCountry/Archiver.php b/plugins/UserCountry/Archiver.php index 5f2a30310b..bdd7c10f02 100644 --- a/plugins/UserCountry/Archiver.php +++ b/plugins/UserCountry/Archiver.php @@ -139,7 +139,7 @@ class Piwik_UserCountry_Archiver extends Piwik_PluginsArchiver } foreach ($this->metricsByDimension as &$table) { - $this->getProcessor()->enrichConversionsByLabelArray($table); + $this->getProcessor()->enrichMetricsWithConversions($table); } } diff --git a/plugins/UserSettings/Archiver.php b/plugins/UserSettings/Archiver.php index d8039d9fd7..fa8721c6e7 100644 --- a/plugins/UserSettings/Archiver.php +++ b/plugins/UserSettings/Archiver.php @@ -109,8 +109,11 @@ class Piwik_UserSettings_Archiver extends Piwik_PluginsArchiver sum(case log_visit.config_gears when 1 then 1 else 0 end) as gears, sum(case log_visit.config_silverlight when 1 then 1 else 0 end) as silverlight, sum(case log_visit.config_cookie when 1 then 1 else 0 end) as cookie "; - $table = $this->getProcessor()->getSimpleDataTableFromSelect($toSelect, Piwik_Archive::INDEX_NB_VISITS); - $this->getProcessor()->insertBlobRecord(self::PLUGIN_RECORD_NAME, $table->getSerialized()); + + $processor = $this->getProcessor(); + $data = $processor->queryVisitsSimple($toSelect); + $table = $processor->getSimpleDataTableFromRow($data, Piwik_Archive::INDEX_NB_VISITS); + $processor->insertBlobRecord(self::PLUGIN_RECORD_NAME, $table->getSerialized()); } protected function aggregateByLanguage() diff --git a/plugins/VisitTime/Archiver.php b/plugins/VisitTime/Archiver.php index 36b3c94aeb..52d3bdbc7f 100644 --- a/plugins/VisitTime/Archiver.php +++ b/plugins/VisitTime/Archiver.php @@ -30,7 +30,7 @@ class Piwik_VisitTime_Archiver extends Piwik_PluginsArchiver } $this->getProcessor()->sumGoalMetrics($row, $metricsByServerTime[$row['label']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); } - $this->getProcessor()->enrichConversionsByLabelArray($metricsByServerTime); + $this->getProcessor()->enrichMetricsWithConversions($metricsByServerTime); $metricsByServerTime = $this->convertServerTimeToLocalTimezone($metricsByServerTime); $tableServerTime = $this->getProcessor()->getDataTableFromArray($metricsByServerTime); -- cgit v1.2.3 From a701d4a43a7185b9d9422de0d1d97c9b2e0fcc5d Mon Sep 17 00:00:00 2001 From: mattab Date: Fri, 7 Jun 2013 12:20:34 +1200 Subject: Killing the Archiver from VisitFrequency. Nice! using VisitsSummary.get API instead, with a visitorType==returning segment Fixing a 4 year old bug which I'm happy about! Also removing an old hack in Archive.php --- plugins/VisitFrequency/API.php | 137 ++++++++---------------------- plugins/VisitFrequency/Archiver.php | 66 -------------- plugins/VisitFrequency/VisitFrequency.php | 23 ----- plugins/VisitorInterest/Archiver.php | 69 ++++++--------- plugins/VisitsSummary/API.php | 41 ++++++--- 5 files changed, 89 insertions(+), 247 deletions(-) delete mode 100644 plugins/VisitFrequency/Archiver.php (limited to 'plugins') diff --git a/plugins/VisitFrequency/API.php b/plugins/VisitFrequency/API.php index d712b67831..986489f8eb 100644 --- a/plugins/VisitFrequency/API.php +++ b/plugins/VisitFrequency/API.php @@ -15,8 +15,10 @@ */ class Piwik_VisitFrequency_API { - static private $instance = null; + const RETURNING_VISITOR_SEGMENT = "visitorType==returning"; + const COLUMN_SUFFIX = "_returning"; + static private $instance = null; static public function getInstance() { if (self::$instance == null) { @@ -27,113 +29,48 @@ class Piwik_VisitFrequency_API public function get($idSite, $period, $date, $segment = false, $columns = false) { - Piwik::checkUserHasViewAccess($idSite); - $archive = Piwik_Archive::build($idSite, $period, $date, $segment); - - // array values are comma separated - $columns = Piwik::getArrayFromApiParameter($columns); - $tempColumns = array(); - - $bounceRateReturningRequested = $averageVisitDurationReturningRequested = $actionsPerVisitReturningRequested = false; - if (!empty($columns)) { - // make sure base metrics are there for processed metrics - if (false !== ($bounceRateReturningRequested = array_search('bounce_rate_returning', $columns))) { - if (!in_array('nb_visits_returning', $columns)) $tempColumns[] = 'nb_visits_returning'; - if (!in_array('bounce_count_returning', $columns)) $tempColumns[] = 'bounce_count_returning'; - unset($columns[$bounceRateReturningRequested]); - } - if (false !== ($actionsPerVisitReturningRequested = array_search('nb_actions_per_visit_returning', $columns))) { - if (!in_array('nb_actions_returning', $columns)) $tempColumns[] = 'nb_actions_returning'; - if (!in_array('nb_visits_returning', $columns)) $tempColumns[] = 'nb_visits_returning'; - unset($columns[$actionsPerVisitReturningRequested]); - } - if (false !== ($averageVisitDurationReturningRequested = array_search('avg_time_on_site_returning', $columns))) { - if (!in_array('sum_visit_length_returning', $columns)) $tempColumns[] = 'sum_visit_length_returning'; - if (!in_array('nb_visits_returning', $columns)) $tempColumns[] = 'nb_visits_returning'; - unset($columns[$averageVisitDurationReturningRequested]); - } - - $tempColumns = array_unique($tempColumns); - $columns = array_merge($columns, $tempColumns); - } else { - $bounceRateReturningRequested = $averageVisitDurationReturningRequested = $actionsPerVisitReturningRequested = true; - $columns = array( - 'nb_visits_returning', - 'nb_actions_returning', - 'max_actions_returning', - 'sum_visit_length_returning', - 'bounce_count_returning', - 'nb_visits_converted_returning', - ); - - if ($period == 'day') { - $columns = array_merge(array('nb_uniq_visitors_returning'), $columns); - } - } - $dataTable = $archive->getDataTableFromNumeric($columns); - - // Process ratio metrics - if ($bounceRateReturningRequested !== false) { - $dataTable->filter('ColumnCallbackAddColumnPercentage', array('bounce_rate_returning', 'bounce_count_returning', 'nb_visits_returning', 0)); - } - if ($actionsPerVisitReturningRequested !== false) { - $dataTable->filter('ColumnCallbackAddColumnQuotient', array('nb_actions_per_visit_returning', 'nb_actions_returning', 'nb_visits_returning', 1)); - } - if ($averageVisitDurationReturningRequested !== false) { - $dataTable->filter('ColumnCallbackAddColumnQuotient', array('avg_time_on_site_returning', 'sum_visit_length_returning', 'nb_visits_returning', 0)); - } - - // remove temporary metrics that were used to compute processed metrics - $dataTable->deleteColumns($tempColumns); - - return $dataTable; + $segment = $this->appendReturningVisitorSegment($segment); + + $this->unprefixColumns($columns); + $params = array( + 'idSite' => $idSite, + 'period' => $period, + 'date' => $date, + 'segment' => $segment, + 'columns' => implode(',', $columns), + 'format' => 'original', + 'serialize' => 0 // tests set this to 1 + ); + $table = Piwik_API_Request::processRequest('VisitsSummary.get', $params); + $this->prefixColumns($table, $period); + return $table; } - protected function getNumeric($idSite, $period, $date, $toFetch) + protected function appendReturningVisitorSegment($segment) { - Piwik::checkUserHasViewAccess($idSite); - $archive = Piwik_Archive::build($idSite, $period, $date); - $dataTable = $archive->getNumeric($toFetch); - return $dataTable; - } - - /** - * @ignore - */ - public function getVisitsReturning($idSite, $period, $date) - { - return $this->getNumeric($idSite, $period, $date, 'nb_visits_returning'); - } - - /** - * @ignore - */ - public function getActionsReturning($idSite, $period, $date) - { - return $this->getNumeric($idSite, $period, $date, 'nb_actions_returning'); - } - - /** - * @ignore - */ - public function getSumVisitsLengthReturning($idSite, $period, $date) - { - return $this->getNumeric($idSite, $period, $date, 'sum_visit_length_returning'); + if (empty($segment)) { + $segment = ''; + } else { + $segment .= Piwik_SegmentExpression::AND_DELIMITER; + } + $segment .= self::RETURNING_VISITOR_SEGMENT; + return $segment; } - /** - * @ignore - */ - public function getBounceCountReturning($idSite, $period, $date) + protected function unprefixColumns(&$columns) { - return $this->getNumeric($idSite, $period, $date, 'bounce_count_returning'); + $columns = Piwik::getArrayFromApiParameter($columns); + foreach ($columns as &$column) { + $column = str_replace(self::COLUMN_SUFFIX, "", $column); + } } - /** - * @ignore - */ - public function getConvertedVisitsReturning($idSite, $period, $date) + protected function prefixColumns($table, $period) { - return $this->getNumeric($idSite, $period, $date, 'nb_visits_converted_returning'); + $rename = array(); + foreach (Piwik_VisitsSummary_API::getInstance()->getColumns($period) as $oldColumn) { + $rename[$oldColumn] = $oldColumn . self::COLUMN_SUFFIX; + } + $table->filter('ReplaceColumnNames', array($rename)); } } diff --git a/plugins/VisitFrequency/Archiver.php b/plugins/VisitFrequency/Archiver.php deleted file mode 100644 index 2ebb4dc5c4..0000000000 --- a/plugins/VisitFrequency/Archiver.php +++ /dev/null @@ -1,66 +0,0 @@ -= ? - AND log_visit.visit_last_action_time <= ? - AND log_visit.idsite = ? - AND log_visit.visitor_returning >= 1"; - - $bind = array($this->getProcessor()->getStartDatetimeUTC(), - $this->getProcessor()->getEndDatetimeUTC(), $this->getProcessor()->idsite); - - $query = $this->getProcessor()->getSegment()->getSelectQuery($select, $from, $where, $bind); - - $row = $this->getProcessor()->db->fetchRow($query['sql'], $query['bind']); - - if ($row === false || $row === null) { - $row['nb_visits_returning'] = 0; - $row['nb_actions_returning'] = 0; - $row['max_actions_returning'] = 0; - $row['sum_visit_length_returning'] = 0; - $row['bounce_count_returning'] = 0; - $row['nb_visits_converted_returning'] = 0; - } - - foreach ($row as $name => $value) { - $this->getProcessor()->insertNumericRecord($name, $value); - } - } - - public function archivePeriod() - { - $numericToSum = array( - 'nb_visits_returning', - 'nb_actions_returning', - 'sum_visit_length_returning', - 'bounce_count_returning', - 'nb_visits_converted_returning', - ); - $this->getProcessor()->archiveNumericValuesSum($numericToSum); - $this->getProcessor()->archiveNumericValuesMax('max_actions_returning'); - } -} \ No newline at end of file diff --git a/plugins/VisitFrequency/VisitFrequency.php b/plugins/VisitFrequency/VisitFrequency.php index d2df343de0..717e3f8eae 100644 --- a/plugins/VisitFrequency/VisitFrequency.php +++ b/plugins/VisitFrequency/VisitFrequency.php @@ -29,8 +29,6 @@ class Piwik_VisitFrequency extends Piwik_Plugin function getListHooksRegistered() { $hooks = array( - 'ArchiveProcessing_Day.compute' => 'archiveDay', - 'ArchiveProcessing_Period.compute' => 'archivePeriod', 'WidgetsList.add' => 'addWidgets', 'Menu.add' => 'addMenu', 'API.getReportMetadata' => 'getReportMetadata', @@ -77,26 +75,5 @@ class Piwik_VisitFrequency extends Piwik_Plugin { Piwik_AddMenu('General_Visitors', 'VisitFrequency_SubmenuFrequency', array('module' => 'VisitFrequency', 'action' => 'index')); } - - function archiveDay($notification) - { - $archiveProcessing = $notification->getNotificationObject(); - - $archiving = new Piwik_VisitFrequency_Archiver($archiveProcessing); - if($archiving->shouldArchive()) { - $archiving->archiveDay(); - } - } - - function archivePeriod($notification) - { - $archiveProcessing = $notification->getNotificationObject(); - - $archiving = new Piwik_VisitFrequency_Archiver($archiveProcessing); - if($archiving->shouldArchive()) { - $archiving->archivePeriod(); - } - } - } diff --git a/plugins/VisitorInterest/Archiver.php b/plugins/VisitorInterest/Archiver.php index 8008671d9b..59e7e348c1 100644 --- a/plugins/VisitorInterest/Archiver.php +++ b/plugins/VisitorInterest/Archiver.php @@ -12,6 +12,10 @@ class Piwik_VisitorInterest_Archiver extends Piwik_PluginsArchiver { // third element is unit (s for seconds, default is munutes) + const TIME_SPENT_RECORD_NAME = 'VisitorInterest_timeGap'; + const PAGES_VIEWED_RECORD_NAME = 'VisitorInterest_pageGap'; + const BY_VISIT_COUNT_RECORD_NAME = 'VisitorInterest_visitsByVisitCount'; + const DAYS_SINCE_LAST_RECORD_NAME = 'VisitorInterest_daysSinceLastVisit'; protected static $timeGap = array( array(0, 10, 's'), array(11, 30, 's'), @@ -24,7 +28,6 @@ class Piwik_VisitorInterest_Archiver extends Piwik_PluginsArchiver array(15, 30), array(30) ); - protected static $pageGap = array( array(1, 1), array(2, 2), @@ -37,7 +40,6 @@ class Piwik_VisitorInterest_Archiver extends Piwik_PluginsArchiver array(15, 20), array(20) ); - /** * The set of ranges used when calculating the 'visitors who visited at least N times' report. */ @@ -57,7 +59,6 @@ class Piwik_VisitorInterest_Archiver extends Piwik_PluginsArchiver array(101, 200), array(200) ); - /** * The set of ranges used when calculating the 'days since last visit' report. */ @@ -80,7 +81,7 @@ class Piwik_VisitorInterest_Archiver extends Piwik_PluginsArchiver public function archiveDay() { -// these prefixes are prepended to the 'SELECT as' parts of each SELECT expression. detecting + // these prefixes are prepended to the 'SELECT as' parts of each SELECT expression. detecting // these prefixes allows us to get all the data in one query. $timeGapPrefix = 'tg'; $pageGapPrefix = 'pg'; @@ -113,34 +114,19 @@ class Piwik_VisitorInterest_Archiver extends Piwik_PluginsArchiver // select data for every report $row = $this->getProcessor()->queryVisitsSimple(implode(',', $selects)); - // archive visits by total time report - $recordName = 'VisitorInterest_timeGap'; - $this->archiveRangeStats($recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $timeGapPrefix); - - // archive visits by total actions report - $recordName = 'VisitorInterest_pageGap'; - $this->archiveRangeStats($recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $pageGapPrefix); - - // archive visits by visit number report - $recordName = 'VisitorInterest_visitsByVisitCount'; - $this->archiveRangeStats($recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $visitsByVisitNumPrefix); - - // archive days since last visit report - $recordName = 'VisitorInterest_daysSinceLastVisit'; - $this->archiveRangeStats($recordName, $row, Piwik_Archive::INDEX_NB_VISITS, $daysSinceLastVisitPrefix); - } - - public function archivePeriod() - { - $dataTableToSum = array( - 'VisitorInterest_timeGap', - 'VisitorInterest_pageGap', - 'VisitorInterest_visitsByVisitCount', - 'VisitorInterest_daysSinceLastVisit' + $prefixes = array( + self::TIME_SPENT_RECORD_NAME => $timeGapPrefix, + self::PAGES_VIEWED_RECORD_NAME => $pageGapPrefix, + self::BY_VISIT_COUNT_RECORD_NAME => $visitsByVisitNumPrefix, + self::DAYS_SINCE_LAST_RECORD_NAME => $daysSinceLastVisitPrefix, ); - $this->getProcessor()->archiveDataTable($dataTableToSum); - } + foreach($prefixes as $recordName => $selectAsPrefix) { + $processor = $this->getProcessor(); + $dataTable = $processor->getSimpleDataTableFromRow($row, Piwik_Archive::INDEX_NB_VISITS, $selectAsPrefix); + $processor->insertBlobRecord($recordName, $dataTable->getSerialized()); + } + } /** * Transforms and returns the set of ranges used to calculate the 'visits by total time' @@ -162,21 +148,14 @@ class Piwik_VisitorInterest_Archiver extends Piwik_PluginsArchiver return $secondsGap; } - /** - * Creates and archives a DataTable from some (or all) elements of a supplied database - * row. - * - * @param string $recordName The record name to use when inserting the new archive. - * @param array $row The database row to use. - * @param string $selectAsPrefix The string to look for as the prefix of SELECT as - * expressions. Elements in $row that have a SELECT as - * with this string as a prefix are used in creating - * the DataTable.' - */ - protected function archiveRangeStats($recordName, $row, $index, $selectAsPrefix) + public function archivePeriod() { - $dataTable = $this->getProcessor()->getSimpleDataTableFromRow($row, $index, $selectAsPrefix); - - $this->getProcessor()->insertBlobRecord($recordName, $dataTable->getSerialized()); + $dataTableToSum = array( + self::TIME_SPENT_RECORD_NAME, + self::PAGES_VIEWED_RECORD_NAME, + self::BY_VISIT_COUNT_RECORD_NAME, + self::DAYS_SINCE_LAST_RECORD_NAME + ); + $this->getProcessor()->archiveDataTable($dataTableToSum); } } \ No newline at end of file diff --git a/plugins/VisitsSummary/API.php b/plugins/VisitsSummary/API.php index 9221d941bd..3205edaf61 100644 --- a/plugins/VisitsSummary/API.php +++ b/plugins/VisitsSummary/API.php @@ -62,19 +62,7 @@ class Piwik_VisitsSummary_API $columns = array_merge($columns, $tempColumns); } else { $bounceRateRequested = $actionsPerVisitRequested = $averageVisitDurationRequested = true; - $columns = array( - 'nb_visits', - 'nb_actions', - 'nb_visits_converted', - 'bounce_count', - 'sum_visit_length', - 'max_actions' - ); - if (Piwik::isUniqueVisitorsEnabled($period)) { - $columns = array_merge(array('nb_uniq_visitors'), $columns); - } - // Force reindex from 0 to N otherwise the SQL bind will fail - $columns = array_values($columns); + $columns = $this->getCoreColumns($period); } $dataTable = $archive->getDataTableFromNumeric($columns); @@ -96,6 +84,33 @@ class Piwik_VisitsSummary_API return $dataTable; } + /** + * @ignore + */ + public function getColumns($period) + { + $columns = $this->getCoreColumns($period); + $columns = array_merge($columns, array('bounce_rate', 'nb_actions_per_visit', 'avg_time_on_site')); + return $columns; + } + + protected function getCoreColumns($period) + { + $columns = array( + 'nb_visits', + 'nb_actions', + 'nb_visits_converted', + 'bounce_count', + 'sum_visit_length', + 'max_actions' + ); + if (Piwik::isUniqueVisitorsEnabled($period)) { + $columns = array_merge(array('nb_uniq_visitors'), $columns); + } + $columns = array_values($columns); + return $columns; + } + protected function getNumeric($idSite, $period, $date, $segment, $toFetch) { Piwik::checkUserHasViewAccess($idSite); -- cgit v1.2.3 From b53839f7e40f584066c13f60e5b37542b3c10cad Mon Sep 17 00:00:00 2001 From: mattab Date: Fri, 7 Jun 2013 12:55:46 +1200 Subject: removing destroy() calls --- plugins/Actions/Archiver.php | 92 +++++++++++++++++++++++++--------------- plugins/UserCountry/Archiver.php | 10 ++--- 2 files changed, 61 insertions(+), 41 deletions(-) (limited to 'plugins') diff --git a/plugins/Actions/Archiver.php b/plugins/Actions/Archiver.php index 7e04246f83..e8a4855463 100644 --- a/plugins/Actions/Archiver.php +++ b/plugins/Actions/Archiver.php @@ -411,49 +411,37 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver { Piwik_Actions_ArchivingHelper::clearActionsCache(); - /** @var Piwik_DataTable $dataTable */ - $dataTable = $this->actionsTablesByType[Piwik_Tracker_Action::TYPE_ACTION_URL]; - self::deleteInvalidSummedColumnsFromDataTable($dataTable); - $s = $dataTable->getSerialized(Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation); - $this->getProcessor()->insertBlobRecord('Actions_actions_url', $s); + $this->recordPageUrlsReports(); + $this->recordDownloadsReports(); + $this->recordOutlinksReports(); + $this->recordPageTitlesReports(); + $this->recordSiteSearchReports(); + } + + protected function recordPageUrlsReports() + { + $dataTable = $this->getDataTable(Piwik_Tracker_Action::TYPE_ACTION_URL); + $this->recordDataTable($dataTable, 'Actions_actions_url'); $this->getProcessor()->insertNumericRecord('Actions_nb_pageviews', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); $this->getProcessor()->insertNumericRecord('Actions_nb_uniq_pageviews', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); $this->getProcessor()->insertNumericRecord('Actions_sum_time_generation', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_SUM_TIME_GENERATION))); $this->getProcessor()->insertNumericRecord('Actions_nb_hits_with_time_generation', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION))); - destroy($dataTable); - - $dataTable = $this->actionsTablesByType[Piwik_Tracker_Action::TYPE_DOWNLOAD]; - self::deleteInvalidSummedColumnsFromDataTable($dataTable); - $s = $dataTable->getSerialized(Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation); - $this->getProcessor()->insertBlobRecord('Actions_downloads', $s); - $this->getProcessor()->insertNumericRecord('Actions_nb_downloads', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); - $this->getProcessor()->insertNumericRecord('Actions_nb_uniq_downloads', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); - destroy($dataTable); - - $dataTable = $this->actionsTablesByType[Piwik_Tracker_Action::TYPE_OUTLINK]; - self::deleteInvalidSummedColumnsFromDataTable($dataTable); - $s = $dataTable->getSerialized(Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation); - $this->getProcessor()->insertBlobRecord('Actions_outlink', $s); - $this->getProcessor()->insertNumericRecord('Actions_nb_outlinks', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); - $this->getProcessor()->insertNumericRecord('Actions_nb_uniq_outlinks', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); - destroy($dataTable); + } - $dataTable = $this->actionsTablesByType[Piwik_Tracker_Action::TYPE_ACTION_NAME]; - self::deleteInvalidSummedColumnsFromDataTable($dataTable); - $s = $dataTable->getSerialized(Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation); - $this->getProcessor()->insertBlobRecord('Actions_actions', $s); - destroy($dataTable); + /** + * @param $typeId + * @return Piwik_DataTable + */ + protected function getDataTable($typeId) + { + return $this->actionsTablesByType[$typeId]; + } - $dataTable = $this->actionsTablesByType[Piwik_Tracker_Action::TYPE_SITE_SEARCH]; + protected function recordDataTable($dataTable, $recordName) + { self::deleteInvalidSummedColumnsFromDataTable($dataTable); - $this->deleteUnusedColumnsFromKeywordsDataTable($dataTable); $s = $dataTable->getSerialized(Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation); - $this->getProcessor()->insertBlobRecord('Actions_sitesearch', $s); - $this->getProcessor()->insertNumericRecord('Actions_nb_searches', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); - $this->getProcessor()->insertNumericRecord('Actions_nb_keywords', $dataTable->getRowsCount()); - destroy($dataTable); - - destroy($this->actionsTablesByType); + $this->getProcessor()->insertBlobRecord($recordName, $s); } /** @@ -497,6 +485,40 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver )); } + protected function recordDownloadsReports() + { + $dataTable = $this->getDataTable(Piwik_Tracker_Action::TYPE_DOWNLOAD); + $this->recordDataTable($dataTable, 'Actions_downloads'); + + $this->getProcessor()->insertNumericRecord('Actions_nb_downloads', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); + $this->getProcessor()->insertNumericRecord('Actions_nb_uniq_downloads', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); + } + + protected function recordOutlinksReports() + { + $dataTable = $this->getDataTable(Piwik_Tracker_Action::TYPE_OUTLINK); + $this->recordDataTable($dataTable, 'Actions_outlink'); + + $this->getProcessor()->insertNumericRecord('Actions_nb_outlinks', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); + $this->getProcessor()->insertNumericRecord('Actions_nb_uniq_outlinks', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); + } + + protected function recordPageTitlesReports() + { + $dataTable = $this->getDataTable(Piwik_Tracker_Action::TYPE_ACTION_NAME); + $this->recordDataTable($dataTable, 'Actions_actions'); + } + + protected function recordSiteSearchReports() + { + $dataTable = $this->getDataTable(Piwik_Tracker_Action::TYPE_SITE_SEARCH); + $this->deleteUnusedColumnsFromKeywordsDataTable($dataTable); + $this->recordDataTable($dataTable, 'Actions_sitesearch'); + + $this->getProcessor()->insertNumericRecord('Actions_nb_searches', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); + $this->getProcessor()->insertNumericRecord('Actions_nb_keywords', $dataTable->getRowsCount()); + } + protected function deleteUnusedColumnsFromKeywordsDataTable($dataTable) { $columnsToDelete = array( diff --git a/plugins/UserCountry/Archiver.php b/plugins/UserCountry/Archiver.php index bdd7c10f02..99bd1e40a1 100644 --- a/plugins/UserCountry/Archiver.php +++ b/plugins/UserCountry/Archiver.php @@ -23,6 +23,8 @@ class Piwik_UserCountry_Archiver extends Piwik_PluginsArchiver private $metricsByDimension = array(); + protected $maximumRows; + public function archiveDay() { $this->metricsByDimension = array('location_country' => array(), @@ -145,23 +147,19 @@ class Piwik_UserCountry_Archiver extends Piwik_PluginsArchiver protected function recordDayReports() { - $maximumRows = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; - $tableCountry = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->metricsByDimension['location_country']); $this->getProcessor()->insertBlobRecord(self::VISITS_BY_COUNTRY_RECORD_NAME, $tableCountry->getSerialized()); $this->getProcessor()->insertNumericRecord(self::DISTINCT_COUNTRIES_METRIC, $tableCountry->getRowsCount()); destroy($tableCountry); $tableRegion = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->metricsByDimension['location_region']); - $serialized = $tableRegion->getSerialized($maximumRows, $maximumRows, Piwik_Archive::INDEX_NB_VISITS); + $serialized = $tableRegion->getSerialized($this->maximumRows, $this->maximumRows, Piwik_Archive::INDEX_NB_VISITS); $this->getProcessor()->insertBlobRecord(self::VISITS_BY_REGION_RECORD_NAME, $serialized); - destroy($tableRegion); $tableCity = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->metricsByDimension['location_city']); $this->setLatitudeLongitude($tableCity); - $serialized = $tableCity->getSerialized($maximumRows, $maximumRows, Piwik_Archive::INDEX_NB_VISITS); + $serialized = $tableCity->getSerialized($this->maximumRows, $this->maximumRows, Piwik_Archive::INDEX_NB_VISITS); $this->getProcessor()->insertBlobRecord(self::VISITS_BY_CITY_RECORD_NAME, $serialized); - destroy($tableCity); } /** -- cgit v1.2.3 From e7267041b56679f3f95d0a1d35836eec37d0d85c Mon Sep 17 00:00:00 2001 From: mattab Date: Fri, 7 Jun 2013 14:37:20 +1200 Subject: factoring out record names as const --- plugins/Actions/Archiver.php | 77 ++++++++++++++++++----------- plugins/CustomVariables/API.php | 2 +- plugins/CustomVariables/Archiver.php | 6 +-- plugins/DBStats/MySQLMetadataProvider.php | 1 - plugins/DevicesDetection/Archiver.php | 49 +++++++++--------- plugins/Goals/Archiver.php | 22 +++++---- plugins/Provider/API.php | 2 +- plugins/Provider/Archiver.php | 18 ++++--- plugins/Referers/API.php | 37 +++++++------- plugins/Referers/Archiver.php | 82 ++++++++++++++++++------------- plugins/UserCountry/API.php | 17 +++---- plugins/UserCountry/Archiver.php | 1 - plugins/UserSettings/API.php | 63 +++++++++++++----------- plugins/UserSettings/Archiver.php | 9 ++-- plugins/VisitTime/API.php | 4 +- plugins/VisitTime/Archiver.php | 11 +++-- plugins/VisitorInterest/API.php | 9 ++-- plugins/VisitorInterest/Archiver.php | 52 +++++++++++--------- 18 files changed, 247 insertions(+), 215 deletions(-) (limited to 'plugins') diff --git a/plugins/Actions/Archiver.php b/plugins/Actions/Archiver.php index e8a4855463..d34fb147dc 100644 --- a/plugins/Actions/Archiver.php +++ b/plugins/Actions/Archiver.php @@ -16,6 +16,23 @@ */ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver { + const DOWNLOADS_RECORD_NAME = 'Actions_downloads'; + const OUTLINKS_RECORD_NAME = 'Actions_outlink'; + const PAGE_TITLES_RECORD_NAME = 'Actions_actions'; + const SITE_SEARCH_RECORD_NAME = 'Actions_sitesearch'; + const PAGE_URLS_RECORD_NAME = 'Actions_actions_url'; + + const METRIC_PAGEVIEWS_RECORD_NAME = 'Actions_nb_pageviews'; + const METRIC_UNIQ_PAGEVIEWS_RECORD_NAME = 'Actions_nb_uniq_pageviews'; + const METRIC_SUM_TIME_RECORD_NAME = 'Actions_sum_time_generation'; + const METRIC_HITS_TIMED_RECORD_NAME = 'Actions_nb_hits_with_time_generation'; + const METRIC_DOWNLOADS_RECORD_NAME = 'Actions_nb_downloads'; + const METRIC_UNIQ_DOWNLOADS_RECORD_NAME = 'Actions_nb_uniq_downloads'; + const METRIC_OUTLINKS_RECORD_NAME = 'Actions_nb_outlinks'; + const METRIC_UNIQ_OUTLINKS_RECORD_NAME = 'Actions_nb_uniq_outlinks'; + const METRIC_SEARCHES_RECORD_NAME = 'Actions_nb_searches'; + const METRIC_KEYWORDS_RECORD_NAME = 'Actions_nb_keywords'; + public static $actionTypes = array( Piwik_Tracker_Action::TYPE_ACTION_URL, Piwik_Tracker_Action::TYPE_OUTLINK, @@ -421,11 +438,11 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver protected function recordPageUrlsReports() { $dataTable = $this->getDataTable(Piwik_Tracker_Action::TYPE_ACTION_URL); - $this->recordDataTable($dataTable, 'Actions_actions_url'); - $this->getProcessor()->insertNumericRecord('Actions_nb_pageviews', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); - $this->getProcessor()->insertNumericRecord('Actions_nb_uniq_pageviews', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); - $this->getProcessor()->insertNumericRecord('Actions_sum_time_generation', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_SUM_TIME_GENERATION))); - $this->getProcessor()->insertNumericRecord('Actions_nb_hits_with_time_generation', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION))); + $this->recordDataTable($dataTable, self::PAGE_URLS_RECORD_NAME); + $this->getProcessor()->insertNumericRecord(self::METRIC_PAGEVIEWS_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); + $this->getProcessor()->insertNumericRecord(self::METRIC_UNIQ_PAGEVIEWS_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); + $this->getProcessor()->insertNumericRecord(self::METRIC_SUM_TIME_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_SUM_TIME_GENERATION))); + $this->getProcessor()->insertNumericRecord(self::METRIC_HITS_TIMED_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION))); } /** @@ -488,35 +505,35 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver protected function recordDownloadsReports() { $dataTable = $this->getDataTable(Piwik_Tracker_Action::TYPE_DOWNLOAD); - $this->recordDataTable($dataTable, 'Actions_downloads'); + $this->recordDataTable($dataTable, self::DOWNLOADS_RECORD_NAME); - $this->getProcessor()->insertNumericRecord('Actions_nb_downloads', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); - $this->getProcessor()->insertNumericRecord('Actions_nb_uniq_downloads', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); + $this->getProcessor()->insertNumericRecord(self::METRIC_DOWNLOADS_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); + $this->getProcessor()->insertNumericRecord(self::METRIC_UNIQ_DOWNLOADS_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); } protected function recordOutlinksReports() { $dataTable = $this->getDataTable(Piwik_Tracker_Action::TYPE_OUTLINK); - $this->recordDataTable($dataTable, 'Actions_outlink'); + $this->recordDataTable($dataTable, self::OUTLINKS_RECORD_NAME); - $this->getProcessor()->insertNumericRecord('Actions_nb_outlinks', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); - $this->getProcessor()->insertNumericRecord('Actions_nb_uniq_outlinks', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); + $this->getProcessor()->insertNumericRecord(self::METRIC_OUTLINKS_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); + $this->getProcessor()->insertNumericRecord(self::METRIC_UNIQ_OUTLINKS_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); } protected function recordPageTitlesReports() { $dataTable = $this->getDataTable(Piwik_Tracker_Action::TYPE_ACTION_NAME); - $this->recordDataTable($dataTable, 'Actions_actions'); + $this->recordDataTable($dataTable, self::PAGE_TITLES_RECORD_NAME); } protected function recordSiteSearchReports() { $dataTable = $this->getDataTable(Piwik_Tracker_Action::TYPE_SITE_SEARCH); $this->deleteUnusedColumnsFromKeywordsDataTable($dataTable); - $this->recordDataTable($dataTable, 'Actions_sitesearch'); + $this->recordDataTable($dataTable, self::SITE_SEARCH_RECORD_NAME); - $this->getProcessor()->insertNumericRecord('Actions_nb_searches', array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); - $this->getProcessor()->insertNumericRecord('Actions_nb_keywords', $dataTable->getRowsCount()); + $this->getProcessor()->insertNumericRecord(self::METRIC_SEARCHES_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); + $this->getProcessor()->insertNumericRecord(self::METRIC_KEYWORDS_RECORD_NAME, $dataTable->getRowsCount()); } protected function deleteUnusedColumnsFromKeywordsDataTable($dataTable) @@ -538,8 +555,8 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver { Piwik_Actions_ArchivingHelper::reloadConfig(); $dataTableToSum = array( - 'Actions_actions', - 'Actions_actions_url', + self::PAGE_TITLES_RECORD_NAME, + self::PAGE_URLS_RECORD_NAME, ); $this->getProcessor()->archiveDataTable($dataTableToSum, self::$invalidSummedColumnNameToRenamedNameFromPeriodArchive, @@ -549,9 +566,9 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver self::$actionColumnAggregationOperations); $dataTableToSum = array( - 'Actions_downloads', - 'Actions_outlink', - 'Actions_sitesearch', + self::DOWNLOADS_RECORD_NAME, + self::OUTLINKS_RECORD_NAME, + self::SITE_SEARCH_RECORD_NAME, ); $nameToCount = $this->getProcessor()->archiveDataTable($dataTableToSum, self::$invalidSummedColumnNameToRenamedNameFromPeriodArchive, @@ -560,18 +577,18 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation); $this->getProcessor()->archiveNumericValuesSum(array( - 'Actions_nb_pageviews', - 'Actions_nb_uniq_pageviews', - 'Actions_nb_downloads', - 'Actions_nb_uniq_downloads', - 'Actions_nb_outlinks', - 'Actions_nb_uniq_outlinks', - 'Actions_nb_searches', - 'Actions_sum_time_generation', - 'Actions_nb_hits_with_time_generation', + self::METRIC_PAGEVIEWS_RECORD_NAME, + self::METRIC_UNIQ_PAGEVIEWS_RECORD_NAME, + self::METRIC_DOWNLOADS_RECORD_NAME, + self::METRIC_UNIQ_DOWNLOADS_RECORD_NAME, + self::METRIC_OUTLINKS_RECORD_NAME, + self::METRIC_UNIQ_OUTLINKS_RECORD_NAME, + self::METRIC_SEARCHES_RECORD_NAME, + self::METRIC_SUM_TIME_RECORD_NAME, + self::METRIC_HITS_TIMED_RECORD_NAME, )); // Unique Keywords can't be summed, instead we take the RowsCount() of the keyword table - $this->getProcessor()->insertNumericRecord('Actions_nb_keywords', $nameToCount['Actions_sitesearch']['level0']); + $this->getProcessor()->insertNumericRecord(self::METRIC_KEYWORDS_RECORD_NAME, $nameToCount[self::SITE_SEARCH_RECORD_NAME]['level0']); } } diff --git a/plugins/CustomVariables/API.php b/plugins/CustomVariables/API.php index abdbfb80f1..96d05c4c30 100644 --- a/plugins/CustomVariables/API.php +++ b/plugins/CustomVariables/API.php @@ -41,7 +41,7 @@ class Piwik_CustomVariables_API */ protected function getDataTable($idSite, $period, $date, $segment, $expanded, $idSubtable) { - $dataTable = Piwik_Archive::getDataTableFromArchive('CustomVariables_valueByName', $idSite, $period, $date, $segment, $expanded, $idSubtable); + $dataTable = Piwik_Archive::getDataTableFromArchive(Piwik_CustomVariables_Archiver::CUSTOM_VARIABLE_RECORD_NAME, $idSite, $period, $date, $segment, $expanded, $idSubtable); $dataTable->filter('Sort', array(Piwik_Archive::INDEX_NB_ACTIONS, 'desc', $naturalSort = false, $expanded)); $dataTable->queueFilter('ReplaceColumnNames'); $dataTable->queueFilter('ColumnDelete', 'nb_uniq_visitors'); diff --git a/plugins/CustomVariables/Archiver.php b/plugins/CustomVariables/Archiver.php index 896b5335bc..f5df35ba38 100644 --- a/plugins/CustomVariables/Archiver.php +++ b/plugins/CustomVariables/Archiver.php @@ -12,7 +12,7 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver { const LABEL_CUSTOM_VALUE_NOT_DEFINED = "Value not defined"; - const BLOB_NAME = 'CustomVariables_valueByName'; + const CUSTOM_VARIABLE_RECORD_NAME = 'CustomVariables_valueByName'; protected $metricsByKey = array(); protected $metricsByKeyAndValue = array(); protected $maximumRowsInDataTableLevelZero; @@ -42,7 +42,7 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver $columnToSort = Piwik_Archive::INDEX_NB_VISITS ); - $this->getProcessor()->insertBlobRecord(self::BLOB_NAME, $blob); + $this->getProcessor()->insertBlobRecord(self::CUSTOM_VARIABLE_RECORD_NAME, $blob); } protected function aggregateCustomVariable($slot) @@ -218,7 +218,7 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver public function archivePeriod() { $nameToCount = $this->getProcessor()->archiveDataTable( - self::BLOB_NAME, null, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, + self::CUSTOM_VARIABLE_RECORD_NAME, null, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $columnToSort = Piwik_Archive::INDEX_NB_VISITS); } } \ No newline at end of file diff --git a/plugins/DBStats/MySQLMetadataProvider.php b/plugins/DBStats/MySQLMetadataProvider.php index 6240a24b19..be487346cb 100755 --- a/plugins/DBStats/MySQLMetadataProvider.php +++ b/plugins/DBStats/MySQLMetadataProvider.php @@ -243,7 +243,6 @@ class Piwik_DBStats_MySQLMetadataProvider array($cols, 'estimated_size', $getEstimatedSize, array($status))); $dataTable->addDataTable($table); - destroy($table); } return $dataTable; } diff --git a/plugins/DevicesDetection/Archiver.php b/plugins/DevicesDetection/Archiver.php index 1fdbe6f8cc..5ff05d3f3a 100644 --- a/plugins/DevicesDetection/Archiver.php +++ b/plugins/DevicesDetection/Archiver.php @@ -11,6 +11,14 @@ class Piwik_DevicesDetection_Archiver extends Piwik_PluginsArchiver { + const TYPE_RECORD_NAME = 'DevicesDetection_types'; + const BRAND_RECORD_NAME = 'DevicesDetection_brands'; + const MODEL_RECORD_NAME = 'DevicesDetection_models'; + const OS_RECORD_NAME = 'DevicesDetection_os'; + const OS_VERSION_RECORD_NAME = 'DevicesDetection_osVersions'; + const BROWSER_RECORD_NAME = 'DevicesDetection_browsers'; + const BROWSER_VERSION_RECORD_NAME = 'DevicesDetection_browserVersions'; + public function __construct($processor) { parent::__construct($processor); @@ -30,9 +38,8 @@ class Piwik_DevicesDetection_Archiver extends Piwik_PluginsArchiver private function archiveDayDeviceTypes() { - $recordName = 'DevicesDetection_types'; $labelSQL = "log_visit.config_device_type"; - $this->aggregateByLabel( $labelSQL, $recordName); + $this->aggregateByLabel( $labelSQL, self::TYPE_RECORD_NAME); } private function aggregateByLabel( $labelSQL, $recordName) @@ -45,57 +52,45 @@ class Piwik_DevicesDetection_Archiver extends Piwik_PluginsArchiver private function archiveDayDeviceBrands() { - $recordName = 'DevicesDetection_brands'; - $labelSQL = "log_visit.config_device_brand"; - $this->aggregateByLabel( $labelSQL, $recordName); + $this->aggregateByLabel( "log_visit.config_device_brand", self::BRAND_RECORD_NAME); } private function archiveDayDeviceModels() { - $recordName = 'DevicesDetection_models'; - $labelSQL = "log_visit.config_device_model"; - $this->aggregateByLabel( $labelSQL, $recordName); + $this->aggregateByLabel( "log_visit.config_device_model", self::MODEL_RECORD_NAME); } private function archiveDayOs() { - $recordName = 'DevicesDetection_os'; - $labelSQL = "log_visit.config_os"; - $this->aggregateByLabel( $labelSQL, $recordName); + $this->aggregateByLabel( "log_visit.config_os", self::OS_RECORD_NAME); } private function archiveDayOsVersions() { - $recordName = 'DevicesDetection_osVersions'; - $labelSQL = "CONCAT(log_visit.config_os, ';', log_visit.config_os_version)"; - $this->aggregateByLabel( $labelSQL, $recordName); + $this->aggregateByLabel( "CONCAT(log_visit.config_os, ';', log_visit.config_os_version)", self::OS_VERSION_RECORD_NAME); } private function archiveDayBrowserFamilies() { - $recordName = 'DevicesDetection_browsers'; - $labelSQL = "log_visit.config_browser_name"; - $this->aggregateByLabel( $labelSQL, $recordName); + $this->aggregateByLabel( "log_visit.config_browser_name", self::BROWSER_RECORD_NAME); } private function archiveDayBrowsersVersions() { - $recordName = 'DevicesDetection_browserVersions'; - $labelSQL = "CONCAT(log_visit.config_browser_name, ';', log_visit.config_browser_version)"; - $this->aggregateByLabel( $labelSQL, $recordName); + $this->aggregateByLabel( "CONCAT(log_visit.config_browser_name, ';', log_visit.config_browser_version)", self::BROWSER_VERSION_RECORD_NAME); } public function archivePeriod() { $maximumRowsInSubDataTable = $this->maximumRowsInDataTable; $dataTablesToSum = array( - 'DevicesDetection_types', - 'DevicesDetection_brands', - 'DevicesDetection_models', - 'DevicesDetection_os', - 'DevicesDetection_osVersions', - 'DevicesDetection_browsers', - 'DevicesDetection_browserVersions' + self::TYPE_RECORD_NAME, + self::BRAND_RECORD_NAME, + self::MODEL_RECORD_NAME, + self::OS_RECORD_NAME, + self::OS_VERSION_RECORD_NAME, + self::BROWSER_RECORD_NAME, + self::BROWSER_VERSION_RECORD_NAME ); foreach ($dataTablesToSum as $dt) { $this->getProcessor()->archiveDataTable( diff --git a/plugins/Goals/Archiver.php b/plugins/Goals/Archiver.php index 7effc4e4f7..403e320fa3 100644 --- a/plugins/Goals/Archiver.php +++ b/plugins/Goals/Archiver.php @@ -13,6 +13,9 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver { const VISITS_UNTIL_RECORD_NAME = 'visits_until_conv'; const DAYS_UNTIL_CONV_RECORD_NAME = 'days_until_conv'; + const ITEMS_SKU_RECORD_NAME = 'Goals_ItemsSku'; + const ITEMS_NAME_RECORD_NAME = 'Goals_ItemsName'; + const ITEMS_CATEGORY_RECORD_NAME = 'Goals_ItemsCategory'; /** * This array stores the ranges to use when displaying the 'visits to conversion' report */ @@ -52,9 +55,9 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver ); protected $dimensions = array( - 'idaction_sku' => 'Goals_ItemsSku', - 'idaction_name' => 'Goals_ItemsName', - 'idaction_category' => 'Goals_ItemsCategory' + 'idaction_sku' => self::ITEMS_SKU_RECORD_NAME, + 'idaction_name' => self::ITEMS_NAME_RECORD_NAME, + 'idaction_category' => self::ITEMS_CATEGORY_RECORD_NAME ); public function archiveDay() @@ -65,16 +68,17 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver function archiveGeneralGoalMetrics() { + $selectAsVisitCount = 'vcv'; + $selectAsDaysSince = 'vdsf'; // extra aggregate selects for the visits to conversion report $visitToConvExtraCols = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( - 'visitor_count_visits', self::$visitCountRanges, 'log_conversion', 'vcv'); + 'visitor_count_visits', self::$visitCountRanges, 'log_conversion', $selectAsVisitCount); // extra aggregate selects for the days to conversion report $daysToConvExtraCols = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( - 'visitor_days_since_first', self::$daysToConvRanges, 'log_conversion', 'vdsf'); + 'visitor_days_since_first', self::$daysToConvRanges, 'log_conversion', $selectAsDaysSince); - $query = $this->getProcessor()->queryConversionsByDimension( - array(), '', array_merge($visitToConvExtraCols, $daysToConvExtraCols)); + $query = $this->getProcessor()->queryConversionsByDimension(array(), '', array_merge($visitToConvExtraCols, $daysToConvExtraCols)); if ($query === false) { return; @@ -104,11 +108,11 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver } // map the goal + visit number of a visitor with the # of conversions that happened on that visit - $table = $this->getProcessor()->getSimpleDataTableFromRow($row, Piwik_Archive::INDEX_NB_CONVERSIONS, 'vcv'); + $table = $this->getProcessor()->getSimpleDataTableFromRow($row, Piwik_Archive::INDEX_NB_CONVERSIONS, $selectAsVisitCount); $visitsToConvReport[$idgoal]->addDataTable($table); // map the goal + day number of a visit with the # of conversion that happened on that day - $table = $this->getProcessor()->getSimpleDataTableFromRow($row, Piwik_Archive::INDEX_NB_CONVERSIONS, 'vdsf'); + $table = $this->getProcessor()->getSimpleDataTableFromRow($row, Piwik_Archive::INDEX_NB_CONVERSIONS, $selectAsDaysSince); $daysToConvReport[$idgoal]->addDataTable($table); } diff --git a/plugins/Provider/API.php b/plugins/Provider/API.php index 603a8dfc94..851b1b74f2 100644 --- a/plugins/Provider/API.php +++ b/plugins/Provider/API.php @@ -35,7 +35,7 @@ class Piwik_Provider_API { Piwik::checkUserHasViewAccess($idSite); $archive = Piwik_Archive::build($idSite, $period, $date, $segment); - $dataTable = $archive->getDataTable('Provider_hostnameExt'); + $dataTable = $archive->getDataTable(Piwik_Provider_Archiver::PROVIDER_RECORD_NAME); $dataTable->filter('Sort', array(Piwik_Archive::INDEX_NB_VISITS)); $dataTable->queueFilter('ColumnCallbackAddMetadata', array('label', 'url', 'Piwik_getHostnameUrl')); $dataTable->queueFilter('ColumnCallbackReplace', array('label', 'Piwik_Provider_getPrettyProviderName')); diff --git a/plugins/Provider/Archiver.php b/plugins/Provider/Archiver.php index a82ff846ce..3cc703a0e2 100644 --- a/plugins/Provider/Archiver.php +++ b/plugins/Provider/Archiver.php @@ -10,21 +10,25 @@ */ class Piwik_Provider_Archiver extends Piwik_PluginsArchiver { + const PROVIDER_RECORD_NAME = 'Provider_hostnameExt'; + protected $maximumRows; + + public function __construct($processor) + { + parent::__construct($processor); + $this->maximumRows = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; + } + public function archiveDay() { - $recordName = 'Provider_hostnameExt'; $labelSQL = "log_visit.location_provider"; $metricsByProvider = $this->getProcessor()->getMetricsForLabel($labelSQL); $tableProvider = $this->getProcessor()->getDataTableFromArray($metricsByProvider); - $columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; - $maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; - $this->getProcessor()->insertBlobRecord($recordName, $tableProvider->getSerialized($maximumRowsInDataTable, null, $columnToSortByBeforeTruncation)); + $this->getProcessor()->insertBlobRecord(self::PROVIDER_RECORD_NAME, $tableProvider->getSerialized($this->maximumRows, null, Piwik_Archive::INDEX_NB_VISITS)); } public function archivePeriod() { - $maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; - $dataTableToSum = array('Provider_hostnameExt'); - $this->getProcessor()->archiveDataTable($dataTableToSum, null, $maximumRowsInDataTable); + $this->getProcessor()->archiveDataTable(array(self::PROVIDER_RECORD_NAME), null, $this->maximumRows); } } \ No newline at end of file diff --git a/plugins/Referers/API.php b/plugins/Referers/API.php index 327fa59c2c..abec869e56 100644 --- a/plugins/Referers/API.php +++ b/plugins/Referers/API.php @@ -88,7 +88,7 @@ class Piwik_Referers_API } // get visits by referrer type - $dataTable = $this->getDataTable('Referers_type', $idSite, $period, $date, $segment); + $dataTable = $this->getDataTable(Piwik_Referers_Archiver::REFERER_TYPE_RECORD_NAME, $idSite, $period, $date, $segment); if ($typeReferer !== false) // filter for a specific referrer type { @@ -112,8 +112,7 @@ class Piwik_Referers_API */ public function getAll($idSite, $period, $date, $segment = false) { - $dataTable = $this->getRefererType($idSite, $period, $date, $segment, $typeReferer = false, - $idSubtable = false, $expanded = true); + $dataTable = $this->getRefererType($idSite, $period, $date, $segment, $typeReferer = false, $idSubtable = false, $expanded = true); if ($dataTable instanceof Piwik_DataTable_Array) { throw new Exception("Referrers.getAll with multiple sites or dates is not supported (yet)."); @@ -121,7 +120,6 @@ class Piwik_Referers_API $dataTable = $dataTable->mergeSubtables($labelColumn = 'referrer_type', $useMetadataColumn = true); - // presentation filters $dataTable->filter('Sort', array(Piwik_Archive::INDEX_NB_VISITS, 'desc')); $dataTable->queueFilter('ReplaceColumnNames'); $dataTable->queueFilter('ReplaceSummaryRowLabel'); @@ -131,7 +129,7 @@ class Piwik_Referers_API public function getKeywords($idSite, $period, $date, $segment = false, $expanded = false) { - $dataTable = $this->getDataTable('Referers_searchEngineByKeyword', $idSite, $period, $date, $segment, $expanded); + $dataTable = $this->getDataTable(Piwik_Referers_Archiver::SEARCH_ENGINE_BY_KEYWORD_RECORD_NAME, $idSite, $period, $date, $segment, $expanded); $dataTable = $this->handleKeywordNotDefined($dataTable); return $dataTable; } @@ -214,7 +212,7 @@ class Piwik_Referers_API public function getSearchEnginesFromKeywordId($idSite, $period, $date, $idSubtable, $segment = false) { - $dataTable = $this->getDataTable('Referers_searchEngineByKeyword', $idSite, $period, $date, $segment, $expanded = false, $idSubtable); + $dataTable = $this->getDataTable(Piwik_Referers_Archiver::SEARCH_ENGINE_BY_KEYWORD_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = false, $idSubtable); $dataTable->queueFilter('ColumnCallbackAddMetadata', array('label', 'url', 'Piwik_getSearchEngineUrlFromName')); $dataTable->queueFilter('MetadataCallbackAddMetadata', array('url', 'logo', 'Piwik_getSearchEngineLogoFromUrl')); @@ -230,7 +228,7 @@ class Piwik_Referers_API public function getSearchEngines($idSite, $period, $date, $segment = false, $expanded = false) { - $dataTable = $this->getDataTable('Referers_keywordBySearchEngine', $idSite, $period, $date, $segment, $expanded); + $dataTable = $this->getDataTable(Piwik_Referers_Archiver::KEYWORDS_BY_SEARCH_ENGINE_RECORD_NAME, $idSite, $period, $date, $segment, $expanded); $dataTable->queueFilter('ColumnCallbackAddMetadata', array('label', 'url', 'Piwik_getSearchEngineUrlFromName')); $dataTable->queueFilter('MetadataCallbackAddMetadata', array('url', 'logo', 'Piwik_getSearchEngineLogoFromUrl')); return $dataTable; @@ -238,7 +236,7 @@ class Piwik_Referers_API public function getKeywordsFromSearchEngineId($idSite, $period, $date, $idSubtable, $segment = false) { - $dataTable = $this->getDataTable('Referers_keywordBySearchEngine', $idSite, $period, $date, $segment, $expanded = false, $idSubtable); + $dataTable = $this->getDataTable(Piwik_Referers_Archiver::KEYWORDS_BY_SEARCH_ENGINE_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = false, $idSubtable); // get the search engine and create the URL to the search result page $searchEngines = $this->getSearchEngines($idSite, $period, $date, $segment); @@ -269,25 +267,25 @@ class Piwik_Referers_API public function getCampaigns($idSite, $period, $date, $segment = false, $expanded = false) { - $dataTable = $this->getDataTable('Referers_keywordByCampaign', $idSite, $period, $date, $segment, $expanded); + $dataTable = $this->getDataTable(Piwik_Referers_Archiver::KEYWORD_BY_CAMPAIGN_RECORD_NAME, $idSite, $period, $date, $segment, $expanded); return $dataTable; } public function getKeywordsFromCampaignId($idSite, $period, $date, $idSubtable, $segment = false) { - $dataTable = $this->getDataTable('Referers_keywordByCampaign', $idSite, $period, $date, $segment, $expanded = false, $idSubtable); + $dataTable = $this->getDataTable(Piwik_Referers_Archiver::KEYWORD_BY_CAMPAIGN_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = false, $idSubtable); return $dataTable; } public function getWebsites($idSite, $period, $date, $segment = false, $expanded = false) { - $dataTable = $this->getDataTable('Referers_urlByWebsite', $idSite, $period, $date, $segment, $expanded); + $dataTable = $this->getDataTable(Piwik_Referers_Archiver::URL_BY_WEBSITE_RECORD_NAME, $idSite, $period, $date, $segment, $expanded); return $dataTable; } public function getUrlsFromWebsiteId($idSite, $period, $date, $idSubtable, $segment = false) { - $dataTable = $this->getDataTable('Referers_urlByWebsite', $idSite, $period, $date, $segment, $expanded = false, $idSubtable); + $dataTable = $this->getDataTable(Piwik_Referers_Archiver::URL_BY_WEBSITE_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = false, $idSubtable); // the htmlspecialchars_decode call is for BC for before 1.1 // as the Referer URL was previously encoded in the log tables, but is now recorded raw $dataTable->queueFilter('ColumnCallbackAddMetadata', array('label', 'url', create_function('$label', 'return htmlspecialchars_decode($label);'))); @@ -310,7 +308,7 @@ class Piwik_Referers_API { require PIWIK_INCLUDE_PATH . '/core/DataFiles/Socials.php'; - $dataTable = $this->getDataTable('Referers_urlByWebsite', $idSite, $period, $date, $segment, $expanded); + $dataTable = $this->getDataTable( Piwik_Referers_Archiver::URL_BY_WEBSITE_RECORD_NAME, $idSite, $period, $date, $segment, $expanded); $dataTable->filter('ColumnCallbackDeleteRow', array('label', 'Piwik_Referrers_isSocialUrl')); @@ -343,8 +341,7 @@ class Piwik_Referers_API { require PIWIK_INCLUDE_PATH . '/core/DataFiles/Socials.php'; - $dataTable = $this->getDataTable( - 'Referers_urlByWebsite', $idSite, $period, $date, $segment, $expanded = true); + $dataTable = $this->getDataTable( Piwik_Referers_Archiver::URL_BY_WEBSITE_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = true); // get the social network domain referred to by $idSubtable $social = false; @@ -378,27 +375,27 @@ class Piwik_Referers_API public function getNumberOfDistinctSearchEngines($idSite, $period, $date, $segment = false) { - return $this->getNumeric('Referers_distinctSearchEngines', $idSite, $period, $date, $segment); + return $this->getNumeric(Piwik_Referers_Archiver::METRIC_DISTINCT_SEARCH_ENGINE_RECORD_NAME, $idSite, $period, $date, $segment); } public function getNumberOfDistinctKeywords($idSite, $period, $date, $segment = false) { - return $this->getNumeric('Referers_distinctKeywords', $idSite, $period, $date, $segment); + return $this->getNumeric(Piwik_Referers_Archiver::METRIC_DISTINCT_KEYWORD_RECORD_NAME, $idSite, $period, $date, $segment); } public function getNumberOfDistinctCampaigns($idSite, $period, $date, $segment = false) { - return $this->getNumeric('Referers_distinctCampaigns', $idSite, $period, $date, $segment); + return $this->getNumeric(Piwik_Referers_Archiver::METRIC_DISTINCT_CAMPAIGN_RECORD_NAME, $idSite, $period, $date, $segment); } public function getNumberOfDistinctWebsites($idSite, $period, $date, $segment = false) { - return $this->getNumeric('Referers_distinctWebsites', $idSite, $period, $date, $segment); + return $this->getNumeric(Piwik_Referers_Archiver::METRIC_DISTINCT_WEBSITE_RECORD_NAME, $idSite, $period, $date, $segment); } public function getNumberOfDistinctWebsitesUrls($idSite, $period, $date, $segment = false) { - return $this->getNumeric('Referers_distinctWebsitesUrls', $idSite, $period, $date, $segment); + return $this->getNumeric(Piwik_Referers_Archiver::METRIC_DISTINCT_URLS_RECORD_NAME, $idSite, $period, $date, $segment); } private function getNumeric($name, $idSite, $period, $date, $segment) diff --git a/plugins/Referers/Archiver.php b/plugins/Referers/Archiver.php index f540d1c2a2..58907702ad 100644 --- a/plugins/Referers/Archiver.php +++ b/plugins/Referers/Archiver.php @@ -11,6 +11,18 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver { + const KEYWORDS_BY_SEARCH_ENGINE_RECORD_NAME = 'Referers_keywordBySearchEngine'; + const SEARCH_ENGINE_BY_KEYWORD_RECORD_NAME = 'Referers_searchEngineByKeyword'; + const KEYWORD_BY_CAMPAIGN_RECORD_NAME = 'Referers_keywordByCampaign'; + const URL_BY_WEBSITE_RECORD_NAME = 'Referers_urlByWebsite'; + const REFERER_TYPE_RECORD_NAME = 'Referers_type'; + + const METRIC_DISTINCT_SEARCH_ENGINE_RECORD_NAME = 'Referers_distinctSearchEngines'; + const METRIC_DISTINCT_KEYWORD_RECORD_NAME = 'Referers_distinctKeywords'; + const METRIC_DISTINCT_CAMPAIGN_RECORD_NAME = 'Referers_distinctCampaigns'; + const METRIC_DISTINCT_WEBSITE_RECORD_NAME = 'Referers_distinctWebsites'; + const METRIC_DISTINCT_URLS_RECORD_NAME = 'Referers_distinctWebsitesUrls'; + protected $columnToSortByBeforeTruncation; protected $maximumRowsInDataTableLevelZero; protected $maximumRowsInSubDataTable; @@ -258,17 +270,32 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver $this->recordDayBlobs(); } + protected function recordDayNumeric() + { + $numericRecords = array( + self::METRIC_DISTINCT_SEARCH_ENGINE_RECORD_NAME => count($this->metricsBySearchEngineAndKeyword), + self::METRIC_DISTINCT_KEYWORD_RECORD_NAME => count($this->metricsByKeywordAndSearchEngine), + self::METRIC_DISTINCT_CAMPAIGN_RECORD_NAME => count($this->metricsByCampaign), + self::METRIC_DISTINCT_WEBSITE_RECORD_NAME => count($this->metricsByWebsite), + self::METRIC_DISTINCT_URLS_RECORD_NAME => count($this->distinctUrls), + ); + + foreach ($numericRecords as $name => $value) { + $this->getProcessor()->insertNumericRecord($name, $value); + } + } + protected function recordDayBlobs() { $table = new Piwik_DataTable(); $table->addRowsFromArrayWithIndexLabel($this->metricsByType); - $this->getProcessor()->insertBlobRecord('Referers_type', $table->getSerialized()); + $this->getProcessor()->insertBlobRecord(self::REFERER_TYPE_RECORD_NAME, $table->getSerialized()); $blobRecords = array( - 'Referers_keywordBySearchEngine' => $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsBySearchEngineAndKeyword, $this->metricsBySearchEngine), - 'Referers_searchEngineByKeyword' => $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByKeywordAndSearchEngine, $this->metricsByKeyword), - 'Referers_keywordByCampaign' => $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByCampaignAndKeyword, $this->metricsByCampaign), - 'Referers_urlByWebsite' => $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByWebsiteAndUrl, $this->metricsByWebsite), + self::KEYWORDS_BY_SEARCH_ENGINE_RECORD_NAME => $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsBySearchEngineAndKeyword, $this->metricsBySearchEngine), + self::SEARCH_ENGINE_BY_KEYWORD_RECORD_NAME => $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByKeywordAndSearchEngine, $this->metricsByKeyword), + self::KEYWORD_BY_CAMPAIGN_RECORD_NAME => $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByCampaignAndKeyword, $this->metricsByCampaign), + self::URL_BY_WEBSITE_RECORD_NAME => $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByWebsiteAndUrl, $this->metricsByWebsite), ); foreach ($blobRecords as $recordName => $table) { $blob = $table->getSerialized($this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $this->columnToSortByBeforeTruncation); @@ -276,52 +303,37 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver } } - protected function recordDayNumeric() - { - $numericRecords = array( - 'Referers_distinctSearchEngines' => count($this->metricsBySearchEngineAndKeyword), - 'Referers_distinctKeywords' => count($this->metricsByKeywordAndSearchEngine), - 'Referers_distinctCampaigns' => count($this->metricsByCampaign), - 'Referers_distinctWebsites' => count($this->metricsByWebsite), - 'Referers_distinctWebsitesUrls' => count($this->distinctUrls), - ); - - foreach ($numericRecords as $name => $value) { - $this->getProcessor()->insertNumericRecord($name, $value); - } - } - public function archivePeriod() { $dataTableToSum = array( - 'Referers_type', - 'Referers_keywordBySearchEngine', - 'Referers_searchEngineByKeyword', - 'Referers_keywordByCampaign', - 'Referers_urlByWebsite', + self::REFERER_TYPE_RECORD_NAME, + self::KEYWORDS_BY_SEARCH_ENGINE_RECORD_NAME, + self::SEARCH_ENGINE_BY_KEYWORD_RECORD_NAME, + self::KEYWORD_BY_CAMPAIGN_RECORD_NAME, + self::URL_BY_WEBSITE_RECORD_NAME, ); $nameToCount = $this->getProcessor()->archiveDataTable($dataTableToSum, null, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $this->columnToSortByBeforeTruncation); $mappingFromArchiveName = array( - 'Referers_distinctSearchEngines' => + self::METRIC_DISTINCT_SEARCH_ENGINE_RECORD_NAME => array('typeCountToUse' => 'level0', - 'nameTableToUse' => 'Referers_keywordBySearchEngine', + 'nameTableToUse' => self::KEYWORDS_BY_SEARCH_ENGINE_RECORD_NAME, ), - 'Referers_distinctKeywords' => + self::METRIC_DISTINCT_KEYWORD_RECORD_NAME => array('typeCountToUse' => 'level0', - 'nameTableToUse' => 'Referers_searchEngineByKeyword', + 'nameTableToUse' => self::SEARCH_ENGINE_BY_KEYWORD_RECORD_NAME, ), - 'Referers_distinctCampaigns' => + self::METRIC_DISTINCT_CAMPAIGN_RECORD_NAME => array('typeCountToUse' => 'level0', - 'nameTableToUse' => 'Referers_keywordByCampaign', + 'nameTableToUse' => self::KEYWORD_BY_CAMPAIGN_RECORD_NAME, ), - 'Referers_distinctWebsites' => + self::METRIC_DISTINCT_WEBSITE_RECORD_NAME => array('typeCountToUse' => 'level0', - 'nameTableToUse' => 'Referers_urlByWebsite', + 'nameTableToUse' => self::URL_BY_WEBSITE_RECORD_NAME, ), - 'Referers_distinctWebsitesUrls' => + self::METRIC_DISTINCT_URLS_RECORD_NAME => array('typeCountToUse' => 'recursive', - 'nameTableToUse' => 'Referers_urlByWebsite', + 'nameTableToUse' => self::URL_BY_WEBSITE_RECORD_NAME, ), ); diff --git a/plugins/UserCountry/API.php b/plugins/UserCountry/API.php index ec8c8c1275..15f5f69ecf 100644 --- a/plugins/UserCountry/API.php +++ b/plugins/UserCountry/API.php @@ -32,11 +32,9 @@ class Piwik_UserCountry_API public function getCountry($idSite, $period, $date, $segment = false) { - $recordName = Piwik_UserCountry_Archiver::VISITS_BY_COUNTRY_RECORD_NAME; - $dataTable = $this->getDataTable($recordName, $idSite, $period, $date, $segment); + $dataTable = $this->getDataTable(Piwik_UserCountry_Archiver::VISITS_BY_COUNTRY_RECORD_NAME, $idSite, $period, $date, $segment); - // apply filter on the whole datatable in order the inline search to work (searches - // are done on "beautiful" label) + // apply filter on the whole datatable in order the inline search to work (searches are done on "beautiful" label) $dataTable->filter('ColumnCallbackAddMetadata', array('label', 'code')); $dataTable->filter('ColumnCallbackAddMetadata', array('label', 'logo', 'Piwik_getFlagFromCode')); $dataTable->filter('ColumnCallbackReplace', array('label', 'Piwik_CountryTranslate')); @@ -48,8 +46,7 @@ class Piwik_UserCountry_API public function getContinent($idSite, $period, $date, $segment = false) { - $recordName = Piwik_UserCountry_Archiver::VISITS_BY_COUNTRY_RECORD_NAME; - $dataTable = $this->getDataTable($recordName, $idSite, $period, $date, $segment); + $dataTable = $this->getDataTable(Piwik_UserCountry_Archiver::VISITS_BY_COUNTRY_RECORD_NAME, $idSite, $period, $date, $segment); $getContinent = array('Piwik_Common', 'getContinent'); $dataTable->filter('GroupBy', array('label', $getContinent)); @@ -71,8 +68,7 @@ class Piwik_UserCountry_API */ public function getRegion($idSite, $period, $date, $segment = false) { - $recordName = Piwik_UserCountry_Archiver::VISITS_BY_REGION_RECORD_NAME; - $dataTable = $this->getDataTable($recordName, $idSite, $period, $date, $segment); + $dataTable = $this->getDataTable(Piwik_UserCountry_Archiver::VISITS_BY_REGION_RECORD_NAME, $idSite, $period, $date, $segment); $separator = Piwik_UserCountry_Archiver::LOCATION_SEPARATOR; $unk = Piwik_Tracker_Visit::UNKNOWN_CODE; @@ -114,8 +110,7 @@ class Piwik_UserCountry_API */ public function getCity($idSite, $period, $date, $segment = false) { - $recordName = Piwik_UserCountry_Archiver::VISITS_BY_CITY_RECORD_NAME; - $dataTable = $this->getDataTable($recordName, $idSite, $period, $date, $segment); + $dataTable = $this->getDataTable(Piwik_UserCountry_Archiver::VISITS_BY_CITY_RECORD_NAME, $idSite, $period, $date, $segment); $separator = Piwik_UserCountry_Archiver::LOCATION_SEPARATOR; $unk = Piwik_Tracker_Visit::UNKNOWN_CODE; @@ -204,6 +199,6 @@ class Piwik_UserCountry_API { Piwik::checkUserHasViewAccess($idSite); $archive = Piwik_Archive::build($idSite, $period, $date, $segment); - return $archive->getDataTableFromNumeric('UserCountry_distinctCountries'); + return $archive->getDataTableFromNumeric(Piwik_UserCountry_Archiver::DISTINCT_COUNTRIES_METRIC); } } diff --git a/plugins/UserCountry/Archiver.php b/plugins/UserCountry/Archiver.php index 99bd1e40a1..ecd124d67f 100644 --- a/plugins/UserCountry/Archiver.php +++ b/plugins/UserCountry/Archiver.php @@ -150,7 +150,6 @@ class Piwik_UserCountry_Archiver extends Piwik_PluginsArchiver $tableCountry = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->metricsByDimension['location_country']); $this->getProcessor()->insertBlobRecord(self::VISITS_BY_COUNTRY_RECORD_NAME, $tableCountry->getSerialized()); $this->getProcessor()->insertNumericRecord(self::DISTINCT_COUNTRIES_METRIC, $tableCountry->getRowsCount()); - destroy($tableCountry); $tableRegion = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->metricsByDimension['location_region']); $serialized = $tableRegion->getSerialized($this->maximumRows, $this->maximumRows, Piwik_Archive::INDEX_NB_VISITS); diff --git a/plugins/UserSettings/API.php b/plugins/UserSettings/API.php index dd3820fff7..4369d397b9 100644 --- a/plugins/UserSettings/API.php +++ b/plugins/UserSettings/API.php @@ -45,20 +45,20 @@ class Piwik_UserSettings_API public function getResolution($idSite, $period, $date, $segment = false) { - $dataTable = $this->getDataTable('UserSettings_resolution', $idSite, $period, $date, $segment); + $dataTable = $this->getDataTable(Piwik_UserSettings_Archiver::RESOLUTION_RECORD_NAME, $idSite, $period, $date, $segment); return $dataTable; } public function getConfiguration($idSite, $period, $date, $segment = false) { - $dataTable = $this->getDataTable('UserSettings_configuration', $idSite, $period, $date, $segment); + $dataTable = $this->getDataTable(Piwik_UserSettings_Archiver::CONFIGURATION_RECORD_NAME, $idSite, $period, $date, $segment); $dataTable->queueFilter('ColumnCallbackReplace', array('label', 'Piwik_getConfigurationLabel')); return $dataTable; } public function getOS($idSite, $period, $date, $segment = false, $addShortLabel = true) { - $dataTable = $this->getDataTable('UserSettings_os', $idSite, $period, $date, $segment); + $dataTable = $this->getDataTable(Piwik_UserSettings_Archiver::OS_RECORD_NAME, $idSite, $period, $date, $segment); // these filters are applied directly so other API methods can use GroupBy on the result of this method $dataTable->filter('ColumnCallbackAddMetadata', array('label', 'logo', 'Piwik_getOSLogo')); if ($addShortLabel) { @@ -88,18 +88,29 @@ class Piwik_UserSettings_API { $dataTable = $this->getOS($idSite, $period, $date, $segment, $addShortLabel = false); $dataTable->filter('GroupBy', array('label', 'Piwik_UserSettings_getDeviceTypeFromOS')); + $this->ensureDefaultRowsInTable($dataTable); - // make sure the datatable has a row for mobile & desktop (if it has rows) - $dataTables = array($dataTable); - if ($dataTable instanceof Piwik_DataTable_Array) { - $dataTables = $dataTable->getArray(); - } + // set the logo metadata + $dataTable->queueFilter('MetadataCallbackReplace', + array('logo', 'Piwik_UserSettings_getDeviceTypeImg', null, array('label'))); + + // translate the labels + $dataTable->queueFilter('ColumnCallbackReplace', array('label', 'Piwik_Translate')); + return $dataTable; + } + + protected function ensureDefaultRowsInTable($dataTable) + { $requiredRows = array( 'General_Desktop' => Piwik_Archive::INDEX_NB_VISITS, 'General_Mobile' => Piwik_Archive::INDEX_NB_VISITS ); + $dataTables = array($dataTable); + if ($dataTable instanceof Piwik_DataTable_Array) { + $dataTables = $dataTable->getArray(); + } foreach ($dataTables AS $table) { if ($table->getRowsCount() == 0) { continue; @@ -113,22 +124,19 @@ class Piwik_UserSettings_API } } } + } - // set the logo metadata - $dataTable->queueFilter('MetadataCallbackReplace', - array('logo', 'Piwik_UserSettings_getDeviceTypeImg', null, array('label'))); - - // translate the labels - $dataTable->queueFilter('ColumnCallbackReplace', array('label', 'Piwik_Translate')); - + public function getBrowserVersion($idSite, $period, $date, $segment = false) + { + $dataTable = $this->getBrowserTable($idSite, $period, $date, $segment); + $dataTable->filter('ColumnCallbackAddMetadata', array('label', 'shortLabel', 'Piwik_getBrowserShortLabel')); return $dataTable; } - public function getBrowserVersion($idSite, $period, $date, $segment = false) + protected function getBrowserTable($idSite, $period, $date, $segment) { - $dataTable = $this->getDataTable('UserSettings_browser', $idSite, $period, $date, $segment); + $dataTable = $this->getDataTable(Piwik_UserSettings_Archiver::BROWSER_RECORD_NAME, $idSite, $period, $date, $segment); $dataTable->filter('ColumnCallbackAddMetadata', array('label', 'logo', 'Piwik_getBrowsersLogo')); - $dataTable->filter('ColumnCallbackAddMetadata', array('label', 'shortLabel', 'Piwik_getBrowserShortLabel')); $dataTable->filter('ColumnCallbackReplace', array('label', 'Piwik_getBrowserLabel')); return $dataTable; } @@ -139,19 +147,14 @@ class Piwik_UserSettings_API */ public function getBrowser($idSite, $period, $date, $segment = false) { - $dataTable = $this->getDataTable('UserSettings_browser', $idSite, $period, $date, $segment); - $dataTable->filter('ColumnCallbackAddMetadata', array('label', 'logo', 'Piwik_getBrowsersLogo')); - $dataTable->filter('ColumnCallbackReplace', array('label', 'Piwik_getBrowserLabel')); - - $getBrowserFromBrowserVersion = 'Piwik_UserSettings_getBrowserFromBrowserVersion'; - $dataTable->filter('GroupBy', array('label', $getBrowserFromBrowserVersion)); - + $dataTable = $this->getBrowserTable($idSite, $period, $date, $segment); + $dataTable->filter('GroupBy', array('label', 'Piwik_UserSettings_getBrowserFromBrowserVersion')); return $dataTable; } public function getBrowserType($idSite, $period, $date, $segment = false) { - $dataTable = $this->getDataTable('UserSettings_browserType', $idSite, $period, $date, $segment); + $dataTable = $this->getDataTable(Piwik_UserSettings_Archiver::BROWSER_TYPE_RECORD_NAME, $idSite, $period, $date, $segment); $dataTable->queueFilter('ColumnCallbackAddMetadata', array('label', 'shortLabel', 'ucfirst')); $dataTable->queueFilter('ColumnCallbackReplace', array('label', 'Piwik_getBrowserTypeLabel')); return $dataTable; @@ -159,7 +162,7 @@ class Piwik_UserSettings_API public function getWideScreen($idSite, $period, $date, $segment = false) { - $dataTable = $this->getDataTable('UserSettings_wideScreen', $idSite, $period, $date, $segment); + $dataTable = $this->getDataTable(Piwik_UserSettings_Archiver::SCREEN_TYPE_RECORD_NAME, $idSite, $period, $date, $segment); $dataTable->queueFilter('ColumnCallbackAddMetadata', array('label', 'logo', 'Piwik_getScreensLogo')); $dataTable->queueFilter('ColumnCallbackReplace', array('label', 'ucfirst')); return $dataTable; @@ -168,8 +171,8 @@ class Piwik_UserSettings_API public function getPlugin($idSite, $period, $date, $segment = false) { // fetch all archive data required - $dataTable = $this->getDataTable('UserSettings_plugin', $idSite, $period, $date, $segment); - $browserTypes = $this->getDataTable('UserSettings_browserType', $idSite, $period, $date, $segment); + $dataTable = $this->getDataTable(Piwik_UserSettings_Archiver::PLUGIN_RECORD_NAME, $idSite, $period, $date, $segment); + $browserTypes = $this->getDataTable(Piwik_UserSettings_Archiver::BROWSER_TYPE_RECORD_NAME, $idSite, $period, $date, $segment); $archive = Piwik_Archive::build($idSite, $period, $date, $segment); $visitsSums = $archive->getDataTableFromNumeric('nb_visits'); @@ -238,7 +241,7 @@ class Piwik_UserSettings_API public function getLanguage($idSite, $period, $date, $segment = false) { - $dataTable = $this->getDataTable('UserSettings_language', $idSite, $period, $date, $segment); + $dataTable = $this->getDataTable(Piwik_UserSettings_Archiver::LANGUAGE_RECORD_NAME, $idSite, $period, $date, $segment); $dataTable->filter('ColumnCallbackReplace', array('label', 'Piwik_LanguageTranslate')); $dataTable->filter('ReplaceColumnNames'); return $dataTable; diff --git a/plugins/UserSettings/Archiver.php b/plugins/UserSettings/Archiver.php index fa8721c6e7..0e545350b7 100644 --- a/plugins/UserSettings/Archiver.php +++ b/plugins/UserSettings/Archiver.php @@ -15,7 +15,7 @@ class Piwik_UserSettings_Archiver extends Piwik_PluginsArchiver { const LANGUAGE_RECORD_NAME = 'UserSettings_language'; const PLUGIN_RECORD_NAME = 'UserSettings_plugin'; - const SCREEN_TYPES_RECORD_NAME = 'UserSettings_wideScreen'; + const SCREEN_TYPE_RECORD_NAME = 'UserSettings_wideScreen'; const RESOLUTION_RECORD_NAME = 'UserSettings_resolution'; const BROWSER_RECORD_NAME = 'UserSettings_browser'; const BROWSER_TYPE_RECORD_NAME = 'UserSettings_browserType'; @@ -94,7 +94,7 @@ class Piwik_UserSettings_Archiver extends Piwik_PluginsArchiver protected function aggregateByScreenType(Piwik_DataTable $resolutions) { $resolutions->filter('GroupBy', array('label', 'Piwik_getScreenTypeFromResolution')); - $this->getProcessor()->insertBlobRecord(self::SCREEN_TYPES_RECORD_NAME, $resolutions->getSerialized()); + $this->getProcessor()->insertBlobRecord(self::SCREEN_TYPE_RECORD_NAME, $resolutions->getSerialized()); } protected function aggregateByPlugin() @@ -142,10 +142,11 @@ class Piwik_UserSettings_Archiver extends Piwik_PluginsArchiver self::BROWSER_RECORD_NAME, self::BROWSER_TYPE_RECORD_NAME, self::RESOLUTION_RECORD_NAME, - self::SCREEN_TYPES_RECORD_NAME, + self::SCREEN_TYPE_RECORD_NAME, self::PLUGIN_RECORD_NAME, self::LANGUAGE_RECORD_NAME, ); $this->getProcessor()->archiveDataTable($dataTableToSum, null, $this->maximumRowsInDataTable); } -} \ No newline at end of file +} + diff --git a/plugins/VisitTime/API.php b/plugins/VisitTime/API.php index 973a8d3dd8..50d7f61491 100644 --- a/plugins/VisitTime/API.php +++ b/plugins/VisitTime/API.php @@ -39,12 +39,12 @@ class Piwik_VisitTime_API public function getVisitInformationPerLocalTime($idSite, $period, $date, $segment = false) { - return $this->getDataTable('VisitTime_localTime', $idSite, $period, $date, $segment); + return $this->getDataTable(Piwik_VisitTime_Archiver::LOCAL_TIME_RECORD_NAME, $idSite, $period, $date, $segment); } public function getVisitInformationPerServerTime($idSite, $period, $date, $segment = false, $hideFutureHoursWhenToday = false) { - $table = $this->getDataTable('VisitTime_serverTime', $idSite, $period, $date, $segment); + $table = $this->getDataTable(Piwik_VisitTime_Archiver::SERVER_TIME_RECORD_NAME, $idSite, $period, $date, $segment); if ($hideFutureHoursWhenToday) { $table = $this->removeHoursInFuture($table, $idSite, $period, $date); } diff --git a/plugins/VisitTime/Archiver.php b/plugins/VisitTime/Archiver.php index 52d3bdbc7f..6aafc3dcbc 100644 --- a/plugins/VisitTime/Archiver.php +++ b/plugins/VisitTime/Archiver.php @@ -11,6 +11,9 @@ class Piwik_VisitTime_Archiver extends Piwik_PluginsArchiver { + const SERVER_TIME_RECORD_NAME = 'VisitTime_serverTime'; + const LOCAL_TIME_RECORD_NAME = 'VisitTime_localTime'; + public function archiveDay() { $this->aggregateByLocalTime(); @@ -35,7 +38,7 @@ class Piwik_VisitTime_Archiver extends Piwik_PluginsArchiver $metricsByServerTime = $this->convertServerTimeToLocalTimezone($metricsByServerTime); $tableServerTime = $this->getProcessor()->getDataTableFromArray($metricsByServerTime); $this->makeSureAllHoursAreSet($tableServerTime); - $this->getProcessor()->insertBlobRecord('VisitTime_serverTime', $tableServerTime->getSerialized()); + $this->getProcessor()->insertBlobRecord(self::SERVER_TIME_RECORD_NAME, $tableServerTime->getSerialized()); } protected function aggregateByLocalTime() @@ -43,7 +46,7 @@ class Piwik_VisitTime_Archiver extends Piwik_PluginsArchiver $metricsByLocalTime = $this->getProcessor()->getMetricsForLabel("HOUR(log_visit.visitor_localtime)"); $tableLocalTime = $this->getProcessor()->getDataTableFromArray($metricsByLocalTime); $this->makeSureAllHoursAreSet($tableLocalTime); - $this->getProcessor()->insertBlobRecord('VisitTime_localTime', $tableLocalTime->getSerialized()); + $this->getProcessor()->insertBlobRecord(self::LOCAL_TIME_RECORD_NAME, $tableLocalTime->getSerialized()); } protected function convertServerTimeToLocalTimezone($metricsByServerTime) @@ -73,8 +76,8 @@ class Piwik_VisitTime_Archiver extends Piwik_PluginsArchiver public function archivePeriod() { $dataTableToSum = array( - 'VisitTime_localTime', - 'VisitTime_serverTime', + self::LOCAL_TIME_RECORD_NAME, + self::SERVER_TIME_RECORD_NAME, ); $this->getProcessor()->archiveDataTable($dataTableToSum); } diff --git a/plugins/VisitorInterest/API.php b/plugins/VisitorInterest/API.php index 7adfd7ca4e..d3fcd13382 100644 --- a/plugins/VisitorInterest/API.php +++ b/plugins/VisitorInterest/API.php @@ -38,7 +38,7 @@ class Piwik_VisitorInterest_API public function getNumberOfVisitsPerVisitDuration($idSite, $period, $date, $segment = false) { - $dataTable = $this->getDataTable('VisitorInterest_timeGap', $idSite, $period, $date, $segment); + $dataTable = $this->getDataTable(Piwik_VisitorInterest_Archiver::TIME_SPENT_RECORD_NAME, $idSite, $period, $date, $segment); $dataTable->queueFilter('Sort', array('label', 'asc', true)); $dataTable->queueFilter('BeautifyTimeRangeLabels', array( Piwik_Translate('VisitorInterest_BetweenXYSeconds'), @@ -49,7 +49,7 @@ class Piwik_VisitorInterest_API public function getNumberOfVisitsPerPage($idSite, $period, $date, $segment = false) { - $dataTable = $this->getDataTable('VisitorInterest_pageGap', $idSite, $period, $date, $segment); + $dataTable = $this->getDataTable(Piwik_VisitorInterest_Archiver::PAGES_VIEWED_RECORD_NAME, $idSite, $period, $date, $segment); $dataTable->queueFilter('Sort', array('label', 'asc', true)); $dataTable->queueFilter('BeautifyRangeLabels', array( Piwik_Translate('VisitorInterest_OnePage'), @@ -69,9 +69,8 @@ class Piwik_VisitorInterest_API */ public function getNumberOfVisitsByDaysSinceLast($idSite, $period, $date, $segment = false) { - $recordName = 'VisitorInterest_daysSinceLastVisit'; $dataTable = $this->getDataTable( - $recordName, $idSite, $period, $date, $segment, Piwik_Archive::INDEX_NB_VISITS); + Piwik_VisitorInterest_Archiver::DAYS_SINCE_LAST_RECORD_NAME, $idSite, $period, $date, $segment, Piwik_Archive::INDEX_NB_VISITS); $dataTable->queueFilter('BeautifyRangeLabels', array( Piwik_Translate('General_OneDay'), Piwik_Translate('General_NDays'))); @@ -92,7 +91,7 @@ class Piwik_VisitorInterest_API public function getNumberOfVisitsByVisitCount($idSite, $period, $date, $segment = false) { $dataTable = $this->getDataTable( - 'VisitorInterest_visitsByVisitCount', $idSite, $period, $date, $segment, Piwik_Archive::INDEX_NB_VISITS); + Piwik_VisitorInterest_Archiver::VISITS_COUNT_RECORD_NAME, $idSite, $period, $date, $segment, Piwik_Archive::INDEX_NB_VISITS); $dataTable->queueFilter('BeautifyRangeLabels', array( Piwik_Translate('General_OneVisit'), Piwik_Translate('General_NVisits'))); diff --git a/plugins/VisitorInterest/Archiver.php b/plugins/VisitorInterest/Archiver.php index 59e7e348c1..fc797e44f3 100644 --- a/plugins/VisitorInterest/Archiver.php +++ b/plugins/VisitorInterest/Archiver.php @@ -14,8 +14,9 @@ class Piwik_VisitorInterest_Archiver extends Piwik_PluginsArchiver // third element is unit (s for seconds, default is munutes) const TIME_SPENT_RECORD_NAME = 'VisitorInterest_timeGap'; const PAGES_VIEWED_RECORD_NAME = 'VisitorInterest_pageGap'; - const BY_VISIT_COUNT_RECORD_NAME = 'VisitorInterest_visitsByVisitCount'; + const VISITS_COUNT_RECORD_NAME = 'VisitorInterest_visitsByVisitCount'; const DAYS_SINCE_LAST_RECORD_NAME = 'VisitorInterest_daysSinceLastVisit'; + protected static $timeGap = array( array(0, 10, 's'), array(11, 30, 's'), @@ -83,29 +84,44 @@ class Piwik_VisitorInterest_Archiver extends Piwik_PluginsArchiver { // these prefixes are prepended to the 'SELECT as' parts of each SELECT expression. detecting // these prefixes allows us to get all the data in one query. - $timeGapPrefix = 'tg'; - $pageGapPrefix = 'pg'; - $visitsByVisitNumPrefix = 'vbvn'; - $daysSinceLastVisitPrefix = 'dslv'; + $prefixes = array( + self::TIME_SPENT_RECORD_NAME => 'tg', + self::PAGES_VIEWED_RECORD_NAME => 'pg', + self::VISITS_COUNT_RECORD_NAME => 'vbvn', + self::DAYS_SINCE_LAST_RECORD_NAME => 'dslv', + ); + $row = $this->aggregateFromVisits($prefixes); + + foreach($prefixes as $recordName => $selectAsPrefix) { + $processor = $this->getProcessor(); + $dataTable = $processor->getSimpleDataTableFromRow($row, Piwik_Archive::INDEX_NB_VISITS, $selectAsPrefix); + $processor->insertBlobRecord($recordName, $dataTable->getSerialized()); + } + } + protected function aggregateFromVisits($prefixes) + { // extra condition for the SQL SELECT that makes sure only returning visits are counted // when creating the 'days since last visit' report. the SELECT expression below it // is used to count all new visits. $daysSinceLastExtraCondition = 'and log_visit.visitor_returning = 1'; - $selectAs = $daysSinceLastVisitPrefix . 'General_NewVisits'; + $selectAs = $prefixes[self::DAYS_SINCE_LAST_RECORD_NAME] . 'General_NewVisits'; $newVisitCountSelect = "sum(case when log_visit.visitor_returning = 0 then 1 else 0 end) as `$selectAs`"; // create the select expressions to use $timeGapSelects = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( - 'visit_total_time', self::getSecondsGap(), 'log_visit', $timeGapPrefix); + 'visit_total_time', self::getSecondsGap(), 'log_visit', $prefixes[self::TIME_SPENT_RECORD_NAME]); + $pageGapSelects = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( - 'visit_total_actions', self::$pageGap, 'log_visit', $pageGapPrefix); + 'visit_total_actions', self::$pageGap, 'log_visit', $prefixes[self::PAGES_VIEWED_RECORD_NAME]); + $visitsByVisitNumSelects = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( - 'visitor_count_visits', self::$visitNumberGap, 'log_visit', $visitsByVisitNumPrefix); + 'visitor_count_visits', self::$visitNumberGap, 'log_visit', $prefixes[self::VISITS_COUNT_RECORD_NAME]); $daysSinceLastVisitSelects = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( - 'visitor_days_since_last', self::$daysSinceLastVisitGap, 'log_visit', $daysSinceLastVisitPrefix, + 'visitor_days_since_last', self::$daysSinceLastVisitGap, 'log_visit', $prefixes[self::DAYS_SINCE_LAST_RECORD_NAME], $daysSinceLastExtraCondition); + array_unshift($daysSinceLastVisitSelects, $newVisitCountSelect); $selects = array_merge( @@ -113,19 +129,7 @@ class Piwik_VisitorInterest_Archiver extends Piwik_PluginsArchiver // select data for every report $row = $this->getProcessor()->queryVisitsSimple(implode(',', $selects)); - - $prefixes = array( - self::TIME_SPENT_RECORD_NAME => $timeGapPrefix, - self::PAGES_VIEWED_RECORD_NAME => $pageGapPrefix, - self::BY_VISIT_COUNT_RECORD_NAME => $visitsByVisitNumPrefix, - self::DAYS_SINCE_LAST_RECORD_NAME => $daysSinceLastVisitPrefix, - ); - - foreach($prefixes as $recordName => $selectAsPrefix) { - $processor = $this->getProcessor(); - $dataTable = $processor->getSimpleDataTableFromRow($row, Piwik_Archive::INDEX_NB_VISITS, $selectAsPrefix); - $processor->insertBlobRecord($recordName, $dataTable->getSerialized()); - } + return $row; } /** @@ -153,7 +157,7 @@ class Piwik_VisitorInterest_Archiver extends Piwik_PluginsArchiver $dataTableToSum = array( self::TIME_SPENT_RECORD_NAME, self::PAGES_VIEWED_RECORD_NAME, - self::BY_VISIT_COUNT_RECORD_NAME, + self::VISITS_COUNT_RECORD_NAME, self::DAYS_SINCE_LAST_RECORD_NAME ); $this->getProcessor()->archiveDataTable($dataTableToSum); -- cgit v1.2.3 From 517860fa7b3e7cb7422053fe864a27e4017ea686 Mon Sep 17 00:00:00 2001 From: Benaka Moorthi Date: Fri, 7 Jun 2013 19:45:16 -0700 Subject: Fix regression introduced in Archive.php refactor. --- plugins/Goals/Controller.php | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) (limited to 'plugins') diff --git a/plugins/Goals/Controller.php b/plugins/Goals/Controller.php index f6c3238175..82f50a427e 100644 --- a/plugins/Goals/Controller.php +++ b/plugins/Goals/Controller.php @@ -33,6 +33,14 @@ class Piwik_Goals_Controller extends Piwik_Controller private function formatConversionRate($conversionRate) { + if ($conversionRate instanceof Piwik_DataTable) { + if ($conversionRate->getRowsCount() == 0) { + $conversionRate = 0; + } else { + $columns = $conversionRate->getFirstRow()->getColumns(); + $conversionRate = (float)reset($columns); + } + } return sprintf('%.' . self::CONVERSION_RATE_PRECISION . 'f%%', $conversionRate); } @@ -185,14 +193,20 @@ class Piwik_Goals_Controller extends Piwik_Controller $view->graphEvolution = $this->getEvolutionGraph(true, array('nb_conversions'), $idGoal); $view->nameGraphEvolution = 'GoalsgetEvolutionGraph' . $idGoal; $view->topDimensions = $this->getTopDimensions($idGoal); + + $goalsApi = Piwik_Goals_API::getInstance(); + $period = Piwik_Common::getRequestVar('period'); + $date = Piwik_Common::getRequestVar('date'); // conversion rate for new and returning visitors $segment = 'visitorType==returning,visitorType==returningCustomer'; - $conversionRateReturning = Piwik_Goals_API::getInstance()->getConversionRate($this->idSite, Piwik_Common::getRequestVar('period'), Piwik_Common::getRequestVar('date'), $segment, $idGoal); + $conversionRateReturning = $goalsApi->getConversionRate($this->idSite, $period, $date, $segment, $idGoal); $view->conversion_rate_returning = $this->formatConversionRate($conversionRateReturning); + $segment = 'visitorType==new'; - $conversionRateNew = Piwik_Goals_API::getInstance()->getConversionRate($this->idSite, Piwik_Common::getRequestVar('period'), Piwik_Common::getRequestVar('date'), $segment, $idGoal); + $conversionRateNew = $goalsApi->getConversionRate($this->idSite, $period, $date, $segment, $idGoal); $view->conversion_rate_new = $this->formatConversionRate($conversionRateNew); + $view->goalReportsByDimension = $this->getGoalReportsByDimensionTable( $view->nb_conversions, isset($ecommerce), !empty($view->cart_nb_conversions)); return $view; -- cgit v1.2.3 From a3f7a5758e13dd0abc563a605f92d3228d00135a Mon Sep 17 00:00:00 2001 From: Benaka Moorthi Date: Sat, 8 Jun 2013 20:40:17 -0700 Subject: Fixing build. --- .../images/searchEngines/www.trusted--search.com.png | Bin 736 -> 0 bytes .../images/searchEngines/www.trusted-search.com.png | Bin 0 -> 736 bytes 2 files changed, 0 insertions(+), 0 deletions(-) delete mode 100644 plugins/Referers/images/searchEngines/www.trusted--search.com.png create mode 100644 plugins/Referers/images/searchEngines/www.trusted-search.com.png (limited to 'plugins') diff --git a/plugins/Referers/images/searchEngines/www.trusted--search.com.png b/plugins/Referers/images/searchEngines/www.trusted--search.com.png deleted file mode 100644 index 0740cef1a7..0000000000 Binary files a/plugins/Referers/images/searchEngines/www.trusted--search.com.png and /dev/null differ diff --git a/plugins/Referers/images/searchEngines/www.trusted-search.com.png b/plugins/Referers/images/searchEngines/www.trusted-search.com.png new file mode 100644 index 0000000000..0740cef1a7 Binary files /dev/null and b/plugins/Referers/images/searchEngines/www.trusted-search.com.png differ -- cgit v1.2.3 From 6f36ed421cbf52b348932219fa4dedea7d4ef7bc Mon Sep 17 00:00:00 2001 From: Benaka Moorthi Date: Tue, 11 Jun 2013 13:49:22 -0700 Subject: Fix bug in SegmentEditor plugin, make sure getKnownSegmentsToArchiveAllSites adds segment definitions to output segment array and not whole stored segment data. --- plugins/SegmentEditor/SegmentEditor.php | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'plugins') diff --git a/plugins/SegmentEditor/SegmentEditor.php b/plugins/SegmentEditor/SegmentEditor.php index 7c587c4a18..3ac66afb1e 100644 --- a/plugins/SegmentEditor/SegmentEditor.php +++ b/plugins/SegmentEditor/SegmentEditor.php @@ -45,9 +45,11 @@ class Piwik_SegmentEditor extends Piwik_Plugin public function getKnownSegmentsToArchiveAllSites($notification) { $segments =& $notification->getNotificationObject(); - $segmentToAutoArchive = Piwik_SegmentEditor_API::getInstance()->getAll($idSite = false, $returnAutoArchived = true); - if (!empty($segmentToAutoArchive)) { - $segments = array_merge($segments, $segmentToAutoArchive); + $segmentsToAutoArchive = Piwik_SegmentEditor_API::getInstance()->getAll( + $idSite = false, $returnAutoArchived = true); + + foreach ($segmentsToAutoArchive as $segment) { + $segments[] = $segment['definition']; } } -- cgit v1.2.3 From 16fb8c92cc1e0edf78799bcd412b0ef9c4b5a3df Mon Sep 17 00:00:00 2001 From: sgiehl Date: Sat, 15 Jun 2013 22:51:15 +0200 Subject: refs #4007 sparklines can't handle columns parameter --- plugins/VisitsSummary/Controller.php | 2 ++ 1 file changed, 2 insertions(+) (limited to 'plugins') diff --git a/plugins/VisitsSummary/Controller.php b/plugins/VisitsSummary/Controller.php index fd62d14e38..4580fdced3 100644 --- a/plugins/VisitsSummary/Controller.php +++ b/plugins/VisitsSummary/Controller.php @@ -20,6 +20,8 @@ class Piwik_VisitsSummary_Controller extends Piwik_Controller $view = Piwik_View::factory('index'); $this->setPeriodVariablesView($view); $view->graphEvolutionVisitsSummary = $this->getEvolutionGraph(true, array('nb_visits')); + // do not use columns paramter for sparklines + unset($_GET['columns']); $this->setSparklinesAndNumbers($view); echo $view->render(); } -- cgit v1.2.3 From ea4498a9ce68d621861fa7d8732e922b838ed12d Mon Sep 17 00:00:00 2001 From: mattab Date: Fri, 7 Jun 2013 22:51:29 +1200 Subject: going deeper into the rabbit hole --- plugins/Actions/Archiver.php | 6 +++--- plugins/Goals/Archiver.php | 6 +++--- plugins/Transitions/API.php | 1 - plugins/UserSettings/Archiver.php | 7 +++---- plugins/VisitTime/API.php | 3 +-- plugins/VisitTime/Archiver.php | 2 +- plugins/VisitTime/Controller.php | 18 +++++++++++------- plugins/VisitorInterest/Archiver.php | 13 +++++++------ 8 files changed, 29 insertions(+), 27 deletions(-) (limited to 'plugins') diff --git a/plugins/Actions/Archiver.php b/plugins/Actions/Archiver.php index d34fb147dc..84dc0b7da3 100644 --- a/plugins/Actions/Archiver.php +++ b/plugins/Actions/Archiver.php @@ -60,7 +60,7 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver function __construct($processor) { parent::__construct($processor); - $this->isSiteSearchEnabled = Piwik_Site::isSiteSearchEnabledFor($processor->idsite); + $this->isSiteSearchEnabled = $processor->getSite()->isSiteSearchEnabled(); } /** @@ -261,7 +261,7 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver // extend bindings $bind = array_merge(array($this->getProcessor()->getStartDatetimeUTC(), $this->getProcessor()->getEndDatetimeUTC(), - $this->getProcessor()->idsite + $this->getProcessor()->getSite()->getId() ), $query['bind'] ); @@ -275,7 +275,7 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver } // get result - $resultSet = $this->getProcessor()->db->query($querySql, $bind); + $resultSet = $this->getProcessor()->getDb()->query($querySql, $bind); $modified = Piwik_Actions_ArchivingHelper::updateActionsTableWithRowQuery($resultSet, $sprintfField, $this->actionsTablesByType); return $modified; } diff --git a/plugins/Goals/Archiver.php b/plugins/Goals/Archiver.php index 403e320fa3..45d915e1ab 100644 --- a/plugins/Goals/Archiver.php +++ b/plugins/Goals/Archiver.php @@ -71,11 +71,11 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver $selectAsVisitCount = 'vcv'; $selectAsDaysSince = 'vdsf'; // extra aggregate selects for the visits to conversion report - $visitToConvExtraCols = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( + $visitToConvExtraCols = Piwik_DataAccess_LogAggregator::buildReduceByRangeSelect( 'visitor_count_visits', self::$visitCountRanges, 'log_conversion', $selectAsVisitCount); // extra aggregate selects for the days to conversion report - $daysToConvExtraCols = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( + $daysToConvExtraCols = Piwik_DataAccess_LogAggregator::buildReduceByRangeSelect( 'visitor_days_since_first', self::$daysToConvRanges, 'log_conversion', $selectAsDaysSince); $query = $this->getProcessor()->queryConversionsByDimension(array(), '', array_merge($visitToConvExtraCols, $daysToConvExtraCols)); @@ -277,7 +277,7 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver /* * Archive General Goal metrics */ - $goalIdsToSum = Piwik_Tracker_GoalManager::getGoalIds($this->getProcessor()->idsite); + $goalIdsToSum = Piwik_Tracker_GoalManager::getGoalIds($this->getProcessor()->getSite()->getId()); //Ecommerce $goalIdsToSum[] = Piwik_Tracker_GoalManager::IDGOAL_ORDER; diff --git a/plugins/Transitions/API.php b/plugins/Transitions/API.php index 6712045238..897b14923a 100644 --- a/plugins/Transitions/API.php +++ b/plugins/Transitions/API.php @@ -66,7 +66,6 @@ class Piwik_Transitions_API $archiveProcessing->setSite(new Piwik_Site($idSite)); $archiveProcessing->setPeriod(Piwik_Period::advancedFactory($period, $date)); $archiveProcessing->setSegment(new Piwik_Segment($segment, $idSite)); - $archiveProcessing->initForLiveUsage(); // prepare the report $report = array( diff --git a/plugins/UserSettings/Archiver.php b/plugins/UserSettings/Archiver.php index 0e545350b7..7b43657eeb 100644 --- a/plugins/UserSettings/Archiver.php +++ b/plugins/UserSettings/Archiver.php @@ -110,10 +110,9 @@ class Piwik_UserSettings_Archiver extends Piwik_PluginsArchiver sum(case log_visit.config_silverlight when 1 then 1 else 0 end) as silverlight, sum(case log_visit.config_cookie when 1 then 1 else 0 end) as cookie "; - $processor = $this->getProcessor(); - $data = $processor->queryVisitsSimple($toSelect); - $table = $processor->getSimpleDataTableFromRow($data, Piwik_Archive::INDEX_NB_VISITS); - $processor->insertBlobRecord(self::PLUGIN_RECORD_NAME, $table->getSerialized()); + $data = $this->getProcessor()->queryVisitsSimple($toSelect); + $table = $this->getProcessor()->getSimpleDataTableFromRow($data, Piwik_Archive::INDEX_NB_VISITS); + $this->getProcessor()->insertBlobRecord(self::PLUGIN_RECORD_NAME, $table->getSerialized()); } protected function aggregateByLanguage() diff --git a/plugins/VisitTime/API.php b/plugins/VisitTime/API.php index 50d7f61491..637aa97cbc 100644 --- a/plugins/VisitTime/API.php +++ b/plugins/VisitTime/API.php @@ -77,8 +77,7 @@ class Piwik_VisitTime_API $metrics = Piwik_ArchiveProcessing::getCoreMetrics(); // get metric data for every day within the supplied period - $oSite = new Piwik_Site($idSite); - $oPeriod = Piwik_Archive::makePeriodFromQueryParams($oSite, $period, $date); + $oPeriod = Piwik_Archive::makePeriodFromQueryParams(Piwik_Site::getTimezoneFor($idSite), $period, $date); $dateRange = $oPeriod->getDateStart()->toString() . ',' . $oPeriod->getDateEnd()->toString(); $archive = Piwik_Archive::build($idSite, 'day', $dateRange, $segment); diff --git a/plugins/VisitTime/Archiver.php b/plugins/VisitTime/Archiver.php index 6aafc3dcbc..cd19d99c00 100644 --- a/plugins/VisitTime/Archiver.php +++ b/plugins/VisitTime/Archiver.php @@ -52,7 +52,7 @@ class Piwik_VisitTime_Archiver extends Piwik_PluginsArchiver protected function convertServerTimeToLocalTimezone($metricsByServerTime) { $date = Piwik_Date::factory($this->getProcessor()->getStartDatetimeUTC())->toString(); - $timezone = $this->getProcessor()->site->getTimezone(); + $timezone = $this->getProcessor()->getSite()->getTimezone(); $visitsByHourTz = array(); foreach ($metricsByServerTime as $hour => $stats) { $datetime = $date . ' ' . $hour . ':00:00'; diff --git a/plugins/VisitTime/Controller.php b/plugins/VisitTime/Controller.php index 95e5d97f4d..9c2fce1087 100644 --- a/plugins/VisitTime/Controller.php +++ b/plugins/VisitTime/Controller.php @@ -58,15 +58,22 @@ class Piwik_VisitTime_Controller extends Piwik_Controller if ($view instanceof Piwik_ViewDataTable_GenerateGraphHTML) { $view->showAllTicks(); } + $dateRange = $this->getRangeDate(); + $view->setFooterMessage(Piwik_Translate('General_ReportGeneratedFrom', $dateRange)); + + return $this->renderView($view, $fetch); + } + + protected function getRangeDate() + { // get query params - $idsite = Piwik_Common::getRequestVar('idSite'); + $idSite = Piwik_Common::getRequestVar('idSite'); $date = Piwik_Common::getRequestVar('date'); $period = Piwik_Common::getRequestVar('period'); // create a period instance - $oSite = new Piwik_Site($idsite); - $oPeriod = Piwik_Archive::makePeriodFromQueryParams($oSite, $period, $date); + $oPeriod = Piwik_Archive::makePeriodFromQueryParams(Piwik_Site::getTimezoneFor($idSite), $period, $date); // set the footer message using the period start & end date $start = $oPeriod->getDateStart()->toString(); @@ -76,10 +83,7 @@ class Piwik_VisitTime_Controller extends Piwik_Controller } else { $dateRange = $start . " – " . $end; } - - $view->setFooterMessage(Piwik_Translate('General_ReportGeneratedFrom', $dateRange)); - - return $this->renderView($view, $fetch); + return $dateRange; } private function getGraph($controllerMethod, $apiMethod, $labelTranslation, $limit = 24) diff --git a/plugins/VisitorInterest/Archiver.php b/plugins/VisitorInterest/Archiver.php index fc797e44f3..f90ea3d2a0 100644 --- a/plugins/VisitorInterest/Archiver.php +++ b/plugins/VisitorInterest/Archiver.php @@ -108,19 +108,20 @@ class Piwik_VisitorInterest_Archiver extends Piwik_PluginsArchiver $selectAs = $prefixes[self::DAYS_SINCE_LAST_RECORD_NAME] . 'General_NewVisits'; $newVisitCountSelect = "sum(case when log_visit.visitor_returning = 0 then 1 else 0 end) as `$selectAs`"; + $daysSinceLastVisitSelects = Piwik_DataAccess_LogAggregator::buildReduceByRangeSelect( + 'visitor_days_since_last', self::$daysSinceLastVisitGap, 'log_visit', $prefixes[self::DAYS_SINCE_LAST_RECORD_NAME], + $daysSinceLastExtraCondition); + // create the select expressions to use - $timeGapSelects = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( + $timeGapSelects = Piwik_DataAccess_LogAggregator::buildReduceByRangeSelect( 'visit_total_time', self::getSecondsGap(), 'log_visit', $prefixes[self::TIME_SPENT_RECORD_NAME]); - $pageGapSelects = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( + $pageGapSelects = Piwik_DataAccess_LogAggregator::buildReduceByRangeSelect( 'visit_total_actions', self::$pageGap, 'log_visit', $prefixes[self::PAGES_VIEWED_RECORD_NAME]); - $visitsByVisitNumSelects = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( + $visitsByVisitNumSelects = Piwik_DataAccess_LogAggregator::buildReduceByRangeSelect( 'visitor_count_visits', self::$visitNumberGap, 'log_visit', $prefixes[self::VISITS_COUNT_RECORD_NAME]); - $daysSinceLastVisitSelects = Piwik_ArchiveProcessing_Day::buildReduceByRangeSelect( - 'visitor_days_since_last', self::$daysSinceLastVisitGap, 'log_visit', $prefixes[self::DAYS_SINCE_LAST_RECORD_NAME], - $daysSinceLastExtraCondition); array_unshift($daysSinceLastVisitSelects, $newVisitCountSelect); -- cgit v1.2.3 From c17139710a43b55b5f48377e6281db6ae602957c Mon Sep 17 00:00:00 2001 From: mattab Date: Mon, 10 Jun 2013 21:00:42 +1200 Subject: refactoring / improvements of Archiveprocessing (in progress) such as removing duplicate code and a lot of refactoring, the code is now much more readable! --- plugins/Actions/Archiver.php | 12 +- plugins/CustomVariables/Archiver.php | 106 +++----- plugins/DBStats/API.php | 4 +- plugins/DevicesDetection/Archiver.php | 84 ++----- plugins/ExampleUI/API.php | 15 +- plugins/Goals/Archiver.php | 459 ++++++++++++++++++++-------------- plugins/Provider/Archiver.php | 13 +- plugins/Referers/API.php | 20 +- plugins/Referers/Archiver.php | 243 ++++++------------ plugins/SEO/API.php | 4 +- plugins/Transitions/Transitions.php | 62 +++-- plugins/UserCountry/API.php | 8 +- plugins/UserCountry/Archiver.php | 135 +++++----- plugins/UserSettings/API.php | 1 - plugins/UserSettings/Archiver.php | 95 +++---- plugins/VisitTime/Archiver.php | 50 ++-- plugins/VisitorInterest/Archiver.php | 56 ++--- 17 files changed, 609 insertions(+), 758 deletions(-) (limited to 'plugins') diff --git a/plugins/Actions/Archiver.php b/plugins/Actions/Archiver.php index 84dc0b7da3..1a8e902f16 100644 --- a/plugins/Actions/Archiver.php +++ b/plugins/Actions/Archiver.php @@ -439,10 +439,14 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver { $dataTable = $this->getDataTable(Piwik_Tracker_Action::TYPE_ACTION_URL); $this->recordDataTable($dataTable, self::PAGE_URLS_RECORD_NAME); - $this->getProcessor()->insertNumericRecord(self::METRIC_PAGEVIEWS_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); - $this->getProcessor()->insertNumericRecord(self::METRIC_UNIQ_PAGEVIEWS_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); - $this->getProcessor()->insertNumericRecord(self::METRIC_SUM_TIME_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_SUM_TIME_GENERATION))); - $this->getProcessor()->insertNumericRecord(self::METRIC_HITS_TIMED_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION))); + + $records = array( + self::METRIC_PAGEVIEWS_RECORD_NAME => array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS)), + self::METRIC_UNIQ_PAGEVIEWS_RECORD_NAME => array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS)), + self::METRIC_SUM_TIME_RECORD_NAME => array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_SUM_TIME_GENERATION)), + self::METRIC_HITS_TIMED_RECORD_NAME => array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION)) + ); + $this->getProcessor()->insertNumericRecords( $records ); } /** diff --git a/plugins/CustomVariables/Archiver.php b/plugins/CustomVariables/Archiver.php index f5df35ba38..15cc2fdf23 100644 --- a/plugins/CustomVariables/Archiver.php +++ b/plugins/CustomVariables/Archiver.php @@ -13,8 +13,11 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver { const LABEL_CUSTOM_VALUE_NOT_DEFINED = "Value not defined"; const CUSTOM_VARIABLE_RECORD_NAME = 'CustomVariables_valueByName'; - protected $metricsByKey = array(); - protected $metricsByKeyAndValue = array(); + + /** + * @var Piwik_DataArray + */ + protected $dataArray; protected $maximumRowsInDataTableLevelZero; protected $maximumRowsInSubDataTable; protected $newEmptyRow; @@ -28,15 +31,15 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver public function archiveDay() { + $this->dataArray = new Piwik_DataArray(); + for ($i = 1; $i <= Piwik_Tracker::MAX_CUSTOM_VARIABLES; $i++) { $this->aggregateCustomVariable($i); } $this->removeVisitsMetricsFromActionsAggregate(); - $this->getProcessor()->enrichMetricsWithConversions($this->metricsByKey); - $this->getProcessor()->enrichPivotMetricsWithConversions($this->metricsByKeyAndValue); - - $table = $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByKeyAndValue, $this->metricsByKey); + $this->dataArray->enrichMetricsWithConversions(); + $table = $this->getProcessor()->getDataTableFromDataArray($this->dataArray); $blob = $table->getSerialized( $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $columnToSort = Piwik_Archive::INDEX_NB_VISITS @@ -55,21 +58,34 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver $query = $this->getProcessor()->queryVisitsByDimension($dimensions, $where); $this->aggregateFromVisits($query, $keyField, $valueField); - $query = $this->getProcessor()->queryActionsByDimension($dimensions, $where); + // IF we query Custom Variables scope "page" either: Product SKU, Product Name, + // then we also query the "Product page view" price which was possibly recorded. + $additionalSelects = false; + // FIXMEA + if (in_array($slot, array(3,4,5))) { + $additionalSelects = array( $this->getSelectAveragePrice() ); + } + $query = $this->getProcessor()->queryActionsByDimension($dimensions, $where, $additionalSelects); $this->aggregateFromActions($query, $keyField, $valueField); $query = $this->getProcessor()->queryConversionsByDimension($dimensions, $where); $this->aggregateFromConversions($query, $keyField, $valueField); } + protected function getSelectAveragePrice() + { + return Piwik_ArchiveProcessing_Day::getSqlRevenue("AVG(log_link_visit_action.custom_var_v2)") + . " as `" . Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED . "`"; + } + protected function aggregateFromVisits($query, $keyField, $valueField) { while ($row = $query->fetch()) { - $value = $row[$valueField]; - $value = $this->cleanCustomVarValue($value); - $key = $row[$keyField]; - $this->aggregateVisit($key, $value, $row); + $value = $this->cleanCustomVarValue($row[$valueField]); + + $this->dataArray->sumMetricsVisits($key, $row); + $this->dataArray->sumMetricsVisitsPivot($key, $value, $row); } } @@ -81,35 +97,18 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver return self::LABEL_CUSTOM_VALUE_NOT_DEFINED; } - protected function aggregateVisit($key, $value, $row) - { - if (!isset($this->metricsByKey[$key])) { - $this->metricsByKey[$key] = $this->getProcessor()->makeEmptyRow(); - } - if (!isset($this->metricsByKeyAndValue[$key][$value])) { - $this->metricsByKeyAndValue[$key][$value] = $this->getProcessor()->makeEmptyRow(); - } - - $this->getProcessor()->sumMetrics($row, $this->metricsByKey[$key]); - $this->getProcessor()->sumMetrics($row, $this->metricsByKeyAndValue[$key][$value]); - } protected function aggregateFromActions($query, $keyField, $valueField) { while ($row = $query->fetch()) { $key = $row[$keyField]; - $value = $row[$valueField]; - $value = $this->cleanCustomVarValue($value); - $this->aggregateAction($key, $value, $row); - } - } + $value = $this->cleanCustomVarValue($row[$valueField]); - protected function aggregateAction($key, $value, $row) - { - $alreadyAggregated = $this->aggregateEcommerceCategories($key, $value, $row); - if (!$alreadyAggregated) { - $this->aggregateActionByKeyAndValue($key, $value, $row); - $this->aggregateActionByKey($key, $row); + $alreadyAggregated = $this->aggregateEcommerceCategories($key, $value, $row); + if (!$alreadyAggregated) { + $this->aggregateActionByKeyAndValue($key, $value, $row); + $this->dataArray->sumMetricsActions($key, $row); + } } } @@ -146,17 +145,14 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver protected function aggregateActionByKeyAndValue($key, $value, $row) { - if (!isset($this->metricsByKeyAndValue[$key][$value])) { - $this->metricsByKeyAndValue[$key][$value] = $this->getProcessor()->makeEmptyActionRow(); - } - $this->getProcessor()->sumMetrics($row, $this->metricsByKeyAndValue[$key][$value], $onlyMetricsAvailableInActionsTable = true); + $this->dataArray->sumMetricsActionsPivot($key, $value, $row); if ($this->isReservedKey($key)) { // Price tracking on Ecommerce product/category pages: // the average is returned from the SQL query so the price is not "summed" like other metrics $index = Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED; if (!empty($row[$index])) { - $this->metricsByKeyAndValue[$key][$value][$index] = (float)$row[$index]; + $this->dataArray->setRowColumnPivot($key, $value, $index, (float)$row[$index]); } } } @@ -166,13 +162,6 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver return in_array($key, Piwik_CustomVariables_API::getReservedCustomVariableKeys()); } - protected function aggregateActionByKey($key, $row) - { - if (!isset($this->metricsByKey[$key])) { - $this->metricsByKey[$key] = $this->getProcessor()->makeEmptyActionRow(); - } - $this->getProcessor()->sumMetrics($row, $this->metricsByKey[$key], $onlyMetricsAvailableInActionsTable = true); - } protected function aggregateFromConversions($query, $keyField, $valueField) { @@ -182,32 +171,17 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver while ($row = $query->fetch()) { $key = $row[$keyField]; $value = $this->cleanCustomVarValue($row[$valueField]); - $idGoal = $row['idgoal']; - $this->aggregateConversion($key, $value, $idGoal, $row); - } - } - - protected function aggregateConversion($key, $value, $idGoal, $row) - { - if (!isset($this->metricsByKey[$key][Piwik_Archive::INDEX_GOALS][$idGoal])) { - $this->metricsByKey[$key][Piwik_Archive::INDEX_GOALS][$idGoal] = $this->getProcessor()->makeEmptyGoalRow($idGoal); - } - if (!isset($this->metricsByKeyAndValue[$key][$value][Piwik_Archive::INDEX_GOALS][$idGoal])) { - $this->metricsByKeyAndValue[$key][$value][Piwik_Archive::INDEX_GOALS][$idGoal] = $this->getProcessor()->makeEmptyGoalRow($idGoal); + $this->dataArray->sumMetricsGoals($key, $row); + $this->dataArray->sumMetricsGoalsPivot($key, $value, $row); } - - $this->getProcessor()->sumGoalMetrics($row, $this->metricsByKey[$key][Piwik_Archive::INDEX_GOALS][$idGoal]); - $this->getProcessor()->sumGoalMetrics($row, $this->metricsByKeyAndValue[$key][$value][Piwik_Archive::INDEX_GOALS][$idGoal]); } protected function removeVisitsMetricsFromActionsAggregate() { - $emptyActionRow = $this->getProcessor()->makeEmptyActionRow(); - - foreach ($this->metricsByKey as $key => &$row) { - $isActionRowAggregate = (count($row) == count($emptyActionRow)); + $dataArray = &$this->dataArray->getDataArray(); + foreach ($dataArray as $key => &$row) { if (!self::isReservedKey($key) - && $isActionRowAggregate + && Piwik_DataArray::isRowActions($row) ) { unset($row[Piwik_Archive::INDEX_NB_UNIQ_VISITORS]); unset($row[Piwik_Archive::INDEX_NB_VISITS]); diff --git a/plugins/DBStats/API.php b/plugins/DBStats/API.php index fec0e0fe71..693c7f2e1e 100644 --- a/plugins/DBStats/API.php +++ b/plugins/DBStats/API.php @@ -128,9 +128,7 @@ class Piwik_DBStats_API $rowToAddTo['row_count'] += $status['Rows']; } - $result = new Piwik_DataTable(); - $result->addRowsFromArrayWithIndexLabel($rows); - return $result; + return Piwik_DataTable::makeFromIndexedArray($rows); } /** diff --git a/plugins/DevicesDetection/Archiver.php b/plugins/DevicesDetection/Archiver.php index 5ff05d3f3a..8bedcc9d39 100644 --- a/plugins/DevicesDetection/Archiver.php +++ b/plugins/DevicesDetection/Archiver.php @@ -11,82 +11,46 @@ class Piwik_DevicesDetection_Archiver extends Piwik_PluginsArchiver { - const TYPE_RECORD_NAME = 'DevicesDetection_types'; - const BRAND_RECORD_NAME = 'DevicesDetection_brands'; - const MODEL_RECORD_NAME = 'DevicesDetection_models'; + const DEVICE_TYPE_RECORD_NAME = 'DevicesDetection_types'; + const DEVICE_BRAND_RECORD_NAME = 'DevicesDetection_brands'; + const DEVICE_MODEL_RECORD_NAME = 'DevicesDetection_models'; const OS_RECORD_NAME = 'DevicesDetection_os'; const OS_VERSION_RECORD_NAME = 'DevicesDetection_osVersions'; const BROWSER_RECORD_NAME = 'DevicesDetection_browsers'; const BROWSER_VERSION_RECORD_NAME = 'DevicesDetection_browserVersions'; - public function __construct($processor) - { - parent::__construct($processor); - $this->maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; - } + const DEVICE_TYPE_FIELD = "config_device_type"; + const DEVICE_BRAND_FIELD = "config_device_brand"; + const DEVICE_MODEL_FIELD = "config_device_model"; + const OS_FIELD = "config_os"; + const OS_VERSION_FIELD = "CONCAT(log_visit.config_os, ';', log_visit.config_os_version)"; + const BROWSER_FIELD = "config_browser_name"; + const BROWSER_VERSION_DIMENSION = "CONCAT(log_visit.config_browser_name, ';', log_visit.config_browser_version)"; public function archiveDay() { - $this->archiveDayDeviceTypes(); - $this->archiveDayDeviceBrands(); - $this->archiveDayDeviceModels(); - $this->archiveDayOs(); - $this->archiveDayOsVersions(); - $this->archiveDayBrowserFamilies(); - $this->archiveDayBrowsersVersions(); - } - - private function archiveDayDeviceTypes() - { - $labelSQL = "log_visit.config_device_type"; - $this->aggregateByLabel( $labelSQL, self::TYPE_RECORD_NAME); + $this->aggregateByLabel( self::DEVICE_TYPE_FIELD, self::DEVICE_TYPE_RECORD_NAME); + $this->aggregateByLabel( self::DEVICE_BRAND_FIELD, self::DEVICE_BRAND_RECORD_NAME); + $this->aggregateByLabel( self::DEVICE_MODEL_FIELD, self::DEVICE_MODEL_RECORD_NAME); + $this->aggregateByLabel( self::OS_FIELD, self::OS_RECORD_NAME); + $this->aggregateByLabel( self::OS_VERSION_FIELD, self::OS_VERSION_RECORD_NAME); + $this->aggregateByLabel( self::BROWSER_FIELD, self::BROWSER_RECORD_NAME); + $this->aggregateByLabel( self::BROWSER_VERSION_DIMENSION, self::BROWSER_VERSION_RECORD_NAME); } private function aggregateByLabel( $labelSQL, $recordName) { - $metricsByLabel = $this->getProcessor()->getMetricsForLabel($labelSQL); - $tableBrand = $this->getProcessor()->getDataTableFromArray($metricsByLabel); - - $this->getProcessor()->insertBlobRecord($recordName, $tableBrand->getSerialized($this->maximumRowsInDataTable, null, Piwik_Archive::INDEX_NB_VISITS)); - } - - private function archiveDayDeviceBrands() - { - $this->aggregateByLabel( "log_visit.config_device_brand", self::BRAND_RECORD_NAME); - } - - private function archiveDayDeviceModels() - { - $this->aggregateByLabel( "log_visit.config_device_model", self::MODEL_RECORD_NAME); - } - - private function archiveDayOs() - { - $this->aggregateByLabel( "log_visit.config_os", self::OS_RECORD_NAME); - } - - private function archiveDayOsVersions() - { - $this->aggregateByLabel( "CONCAT(log_visit.config_os, ';', log_visit.config_os_version)", self::OS_VERSION_RECORD_NAME); - } - - private function archiveDayBrowserFamilies() - { - $this->aggregateByLabel( "log_visit.config_browser_name", self::BROWSER_RECORD_NAME); - } - - private function archiveDayBrowsersVersions() - { - $this->aggregateByLabel( "CONCAT(log_visit.config_browser_name, ';', log_visit.config_browser_version)", self::BROWSER_VERSION_RECORD_NAME); + $metrics = $this->getProcessor()->getMetricsForDimension($labelSQL); + $table = $this->getProcessor()->getDataTableFromDataArray($metrics); + $this->getProcessor()->insertBlobRecord($recordName, $table->getSerialized($this->maximumRows, null, Piwik_Archive::INDEX_NB_VISITS)); } public function archivePeriod() { - $maximumRowsInSubDataTable = $this->maximumRowsInDataTable; $dataTablesToSum = array( - self::TYPE_RECORD_NAME, - self::BRAND_RECORD_NAME, - self::MODEL_RECORD_NAME, + self::DEVICE_TYPE_RECORD_NAME, + self::DEVICE_BRAND_RECORD_NAME, + self::DEVICE_MODEL_RECORD_NAME, self::OS_RECORD_NAME, self::OS_VERSION_RECORD_NAME, self::BROWSER_RECORD_NAME, @@ -94,7 +58,7 @@ class Piwik_DevicesDetection_Archiver extends Piwik_PluginsArchiver ); foreach ($dataTablesToSum as $dt) { $this->getProcessor()->archiveDataTable( - $dt, null, $this->maximumRowsInDataTable, $maximumRowsInSubDataTable, $columnToSort = "nb_visits"); + $dt, null, $this->maximumRows, $this->maximumRows, $columnToSort = "nb_visits"); } } } \ No newline at end of file diff --git a/plugins/ExampleUI/API.php b/plugins/ExampleUI/API.php index 91e29806be..697844a589 100644 --- a/plugins/ExampleUI/API.php +++ b/plugins/ExampleUI/API.php @@ -50,11 +50,7 @@ class Piwik_ExampleUI_API $value = array('server1' => $server1, 'server2' => $server2); $temperatures[$subPeriod->getLocalizedShortString()] = $value; } - - // convert this array to a DataTable object - $dataTable = new Piwik_DataTable(); - $dataTable->addRowsFromArrayWithIndexLabel($temperatures); - return $dataTable; + return Piwik_DataTable::makeFromIndexedArray($temperatures); } // we generate an array of random server temperatures @@ -71,10 +67,7 @@ class Piwik_ExampleUI_API $temperatures[$xAxisLabel] = $temperatureValues[$i]; } - // convert this array to a DataTable object - $dataTable = new Piwik_DataTable(); - $dataTable->addRowsFromArrayWithIndexLabel($temperatures); - return $dataTable; + return Piwik_DataTable::makeFromIndexedArray($temperatures); } public function getPlanetRatios() @@ -90,9 +83,7 @@ class Piwik_ExampleUI_API 'Neptune' => 3.883, ); // convert this array to a DataTable object - $dataTable = new Piwik_DataTable(); - $dataTable->addRowsFromArrayWithIndexLabel($planetRatios); - return $dataTable; + return Piwik_DataTable::makeFromIndexedArray($planetRatios); } public function getPlanetRatiosWithLogos() diff --git a/plugins/Goals/Archiver.php b/plugins/Goals/Archiver.php index 45d915e1ab..0a5a154f3b 100644 --- a/plugins/Goals/Archiver.php +++ b/plugins/Goals/Archiver.php @@ -16,6 +16,17 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver const ITEMS_SKU_RECORD_NAME = 'Goals_ItemsSku'; const ITEMS_NAME_RECORD_NAME = 'Goals_ItemsName'; const ITEMS_CATEGORY_RECORD_NAME = 'Goals_ItemsCategory'; + const SKU_FIELD = 'idaction_sku'; + const NAME_FIELD = 'idaction_name'; + const CATEGORY_FIELD = 'idaction_category'; + const CATEGORY2_FIELD = 'idaction_category2'; + const CATEGORY3_FIELD = 'idaction_category3'; + const CATEGORY4_FIELD = 'idaction_category4'; + const CATEGORY5_FIELD = 'idaction_category5'; + const NO_LABEL = ':'; + const LOG_CONVERSION_TABLE = 'log_conversion'; + const VISITS_COUNT_FIELD = 'visitor_count_visits'; + const DAYS_SINCE_FIRST_VISIT_FIELD = 'visitor_days_since_first'; /** * This array stores the ranges to use when displaying the 'visits to conversion' report */ @@ -53,209 +64,307 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver array(121, 364), array(364) ); - - protected $dimensions = array( - 'idaction_sku' => self::ITEMS_SKU_RECORD_NAME, - 'idaction_name' => self::ITEMS_NAME_RECORD_NAME, - 'idaction_category' => self::ITEMS_CATEGORY_RECORD_NAME + protected $dimensionRecord = array( + self::SKU_FIELD => self::ITEMS_SKU_RECORD_NAME, + self::NAME_FIELD => self::ITEMS_NAME_RECORD_NAME, + self::CATEGORY_FIELD => self::ITEMS_CATEGORY_RECORD_NAME ); + /** + * Array containing one DataArray for each Ecommerce items dimension (name/sku/category abandoned carts and orders) + * @var array + */ + protected $itemReports = array(); + public function archiveDay() { $this->archiveGeneralGoalMetrics(); $this->archiveEcommerceItems(); } - function archiveGeneralGoalMetrics() + protected function archiveGeneralGoalMetrics() { - $selectAsVisitCount = 'vcv'; - $selectAsDaysSince = 'vdsf'; - // extra aggregate selects for the visits to conversion report - $visitToConvExtraCols = Piwik_DataAccess_LogAggregator::buildReduceByRangeSelect( - 'visitor_count_visits', self::$visitCountRanges, 'log_conversion', $selectAsVisitCount); - - // extra aggregate selects for the days to conversion report - $daysToConvExtraCols = Piwik_DataAccess_LogAggregator::buildReduceByRangeSelect( - 'visitor_days_since_first', self::$daysToConvRanges, 'log_conversion', $selectAsDaysSince); - - $query = $this->getProcessor()->queryConversionsByDimension(array(), '', array_merge($visitToConvExtraCols, $daysToConvExtraCols)); + $prefixes = array( + self::VISITS_UNTIL_RECORD_NAME => 'vcv', + self::DAYS_UNTIL_CONV_RECORD_NAME => 'vdsf', + ); + $aggregatesMetadata = array( + array(self::VISITS_COUNT_FIELD, self::$visitCountRanges, self::LOG_CONVERSION_TABLE, $prefixes[self::VISITS_UNTIL_RECORD_NAME]), + array(self::DAYS_SINCE_FIRST_VISIT_FIELD, self::$daysToConvRanges, self::LOG_CONVERSION_TABLE, $prefixes[self::DAYS_UNTIL_CONV_RECORD_NAME]), + ); + $selects = array(); + foreach ($aggregatesMetadata as $aggregateMetadata) { + $selects = array_merge($selects, Piwik_DataAccess_LogAggregator::getSelectsFromRangedColumn($aggregateMetadata)); + } + $query = $this->getProcessor()->queryConversionsByDimension(array(), false, $selects); if ($query === false) { return; } - $goals = array(); - $visitsToConvReport = array(); - $daysToConvReport = array(); + $totalConversions = $totalRevenue = 0; + $goals = new Piwik_DataArray(); + $visitsToConversions = $daysToConversions = array(); - // Get a standard empty goal row - $overall = $this->getProcessor()->makeEmptyGoalRow($idGoal = 1); + $conversionMetrics = $this->getProcessor()->getConversionsMetricFields(); while ($row = $query->fetch()) { - $idgoal = $row['idgoal']; + $idGoal = $row['idgoal']; + unset($row['idgoal']); + unset($row['label']); - if (!isset($goals[$idgoal])) { - $goals[$idgoal] = $this->getProcessor()->makeEmptyGoalRow($idgoal); + $values = array(); + foreach($conversionMetrics as $field => $statement) { + $values[$field] = $row[$field]; + } + $goals->sumMetrics($idGoal, $values); - $visitsToConvReport[$idgoal] = new Piwik_DataTable(); - $daysToConvReport[$idgoal] = new Piwik_DataTable(); + if (empty($visitsToConversions[$idGoal])) { + $visitsToConversions[$idGoal] = new Piwik_DataTable(); } - $this->getProcessor()->sumGoalMetrics($row, $goals[$idgoal]); + $array = Piwik_DataAccess_LogAggregator::makeArrayOneColumn($row, Piwik_Archive::INDEX_NB_CONVERSIONS, $prefixes[self::VISITS_UNTIL_RECORD_NAME]); + $visitsToConversions[$idGoal]->addDataTable(Piwik_DataTable::makeFromIndexedArray($array)); + + if (empty($daysToConversions[$idGoal])) { + $daysToConversions[$idGoal] = new Piwik_DataTable(); + } + $array = Piwik_DataAccess_LogAggregator::makeArrayOneColumn($row, Piwik_Archive::INDEX_NB_CONVERSIONS, $prefixes[self::DAYS_UNTIL_CONV_RECORD_NAME]); + $daysToConversions[$idGoal]->addDataTable(Piwik_DataTable::makeFromIndexedArray($array)); // We don't want to sum Abandoned cart metrics in the overall revenue/conversions/converted visits // since it is a "negative conversion" - if ($idgoal != Piwik_Tracker_GoalManager::IDGOAL_CART) { - $this->getProcessor()->sumGoalMetrics($row, $overall); + if ($idGoal != Piwik_Tracker_GoalManager::IDGOAL_CART) { + $totalConversions += $row[Piwik_Archive::INDEX_GOAL_NB_CONVERSIONS]; + $totalRevenue += $row[Piwik_Archive::INDEX_GOAL_REVENUE]; } - - // map the goal + visit number of a visitor with the # of conversions that happened on that visit - $table = $this->getProcessor()->getSimpleDataTableFromRow($row, Piwik_Archive::INDEX_NB_CONVERSIONS, $selectAsVisitCount); - $visitsToConvReport[$idgoal]->addDataTable($table); - - // map the goal + day number of a visit with the # of conversion that happened on that day - $table = $this->getProcessor()->getSimpleDataTableFromRow($row, Piwik_Archive::INDEX_NB_CONVERSIONS, $selectAsDaysSince); - $daysToConvReport[$idgoal]->addDataTable($table); } - // these data tables hold reports for every goal of a site - $visitsToConvOverview = new Piwik_DataTable(); - $daysToConvOverview = new Piwik_DataTable(); - // Stats by goal, for all visitors - foreach ($goals as $idgoal => $values) { - foreach ($values as $metricId => $value) { - $metricName = Piwik_Archive::$mappingFromIdToNameGoal[$metricId]; - $recordName = self::getRecordName($metricName, $idgoal); - $this->getProcessor()->insertNumericRecord($recordName, $value); - } - $conversion_rate = $this->getConversionRate($values[Piwik_Archive::INDEX_GOAL_NB_VISITS_CONVERTED]); - $recordName = self::getRecordName('conversion_rate', $idgoal); - $this->getProcessor()->insertNumericRecord($recordName, $conversion_rate); - - // if the goal is not a special goal (like ecommerce) add it to the overview report - if ($idgoal !== Piwik_Tracker_GoalManager::IDGOAL_CART && - $idgoal !== Piwik_Tracker_GoalManager::IDGOAL_ORDER - ) { - $visitsToConvOverview->addDataTable($visitsToConvReport[$idgoal]); - $daysToConvOverview->addDataTable($daysToConvReport[$idgoal]); - } - - // visit count until conversion stats - $this->getProcessor()->insertBlobRecord( - self::getRecordName(self::VISITS_UNTIL_RECORD_NAME, $idgoal), - $visitsToConvReport[$idgoal]->getSerialized()); + $numericRecords = $this->getConversionsNumericMetrics($goals); + $this->getProcessor()->insertNumericRecords($numericRecords); - // day count until conversion stats - $this->getProcessor()->insertBlobRecord( - self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME, $idgoal), - $daysToConvReport[$idgoal]->getSerialized()); - } - - // archive overview reports - $this->getProcessor()->insertBlobRecord( - self::getRecordName(self::VISITS_UNTIL_RECORD_NAME), $visitsToConvOverview->getSerialized()); - $this->getProcessor()->insertBlobRecord( - self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME), $daysToConvOverview->getSerialized()); + $this->insertReports(self::VISITS_UNTIL_RECORD_NAME, $visitsToConversions); + $this->insertReports(self::DAYS_UNTIL_CONV_RECORD_NAME, $daysToConversions); // Stats for all goals - $totalAllGoals = array( + $metrics = array( self::getRecordName('conversion_rate') => $this->getConversionRate($this->getProcessor()->getNumberOfVisitsConverted()), - self::getRecordName('nb_conversions') => $overall[Piwik_Archive::INDEX_GOAL_NB_CONVERSIONS], + self::getRecordName('nb_conversions') => $totalConversions, self::getRecordName('nb_visits_converted') => $this->getProcessor()->getNumberOfVisitsConverted(), - self::getRecordName('revenue') => $overall[Piwik_Archive::INDEX_GOAL_REVENUE], + self::getRecordName('revenue') => $totalRevenue, ); - foreach ($totalAllGoals as $recordName => $value) { - $this->getProcessor()->insertNumericRecord($recordName, $value); + $this->getProcessor()->insertNumericRecords($metrics); + } + + protected function getConversionsNumericMetrics(Piwik_DataArray $goals) + { + $numericRecords = array(); + $goals = $goals->getDataArray(); + foreach ($goals as $idGoal => $array) { + foreach ($array as $metricId => $value) { + $metricName = Piwik_Archive::$mappingFromIdToNameGoal[$metricId]; + $recordName = self::getRecordName($metricName, $idGoal); + $numericRecords[$recordName] = $value; + } + if(!empty($array[Piwik_Archive::INDEX_GOAL_NB_VISITS_CONVERTED])) { + $conversion_rate = $this->getConversionRate($array[Piwik_Archive::INDEX_GOAL_NB_VISITS_CONVERTED]); + $recordName = self::getRecordName('conversion_rate', $idGoal); + $numericRecords[$recordName] = $conversion_rate; + } } + return $numericRecords; } /** - * @param Piwik_ArchiveProcessing_Day $this->getProcessor() + * @param string $recordName 'nb_conversions' + * @param int|bool $idGoal idGoal to return the metrics for, or false to return overall + * @return string Archive record name */ - function archiveEcommerceItems() + static public function getRecordName($recordName, $idGoal = false) { - if (!$this->shouldArchiveEcommerceItems()) { - return false; + $idGoalStr = ''; + if ($idGoal !== false) { + $idGoalStr = $idGoal . "_"; } - $items = array(); + return 'Goal_' . $idGoalStr . $recordName; + } - $dimensionsToQuery = $this->dimensions; - $dimensionsToQuery['idaction_category2'] = 'AdditionalCategory'; - $dimensionsToQuery['idaction_category3'] = 'AdditionalCategory'; - $dimensionsToQuery['idaction_category4'] = 'AdditionalCategory'; - $dimensionsToQuery['idaction_category5'] = 'AdditionalCategory'; + protected function getConversionRate($count) + { + $visits = $this->getProcessor()->getNumberOfVisits(); + return round(100 * $count / $visits, Piwik_Tracker_GoalManager::REVENUE_PRECISION); + } + + protected function insertReports($recordName, $visitsToConversions) + { + foreach ($visitsToConversions as $idGoal => $table) { + $record = self::getRecordName($recordName, $idGoal); + $this->getProcessor()->insertBlobRecord($record, $table->getSerialized()); + } + $overviewTable = $this->getOverviewFromGoalTables($visitsToConversions); + $this->getProcessor()->insertBlobRecord(self::getRecordName($recordName), $overviewTable->getSerialized()); + } + + protected function getOverviewFromGoalTables($tableByGoal) + { + $overview = new Piwik_DataTable(); + foreach ($tableByGoal as $idGoal => $table) { + if ($this->isStandardGoal($idGoal)) { + $overview->addDataTable($table); + } + } + return $overview; + } - foreach ($dimensionsToQuery as $dimension => $recordName) { + protected function isStandardGoal($idGoal) + { + return !in_array($idGoal, $this->getEcommerceIdGoals()); + } + + protected function archiveEcommerceItems() + { + if (!$this->shouldArchiveEcommerceItems()) { + return false; + } + $this->initItemReports(); + foreach ($this->getItemsDimensions() as $dimension) { $query = $this->getProcessor()->queryEcommerceItems($dimension); if ($query == false) { continue; } + $this->aggregateFromEcommerceItems($query, $dimension); + } + $this->recordItemReports(); + } - while ($row = $query->fetch()) { - $label = $row['label']; - $ecommerceType = $row['ecommerceType']; - - if (empty($label)) { - // idaction==0 case: - // If we are querying any optional category, we do not include idaction=0 - // Otherwise we over-report in the Product Categories report - if ($recordName == 'AdditionalCategory') { - continue; - } - // Product Name/Category not defined" - if (class_exists('Piwik_CustomVariables')) { - $label = Piwik_CustomVariables_Archiver::LABEL_CUSTOM_VALUE_NOT_DEFINED; - } else { - $label = "Value not defined"; - } - } - // For carts, idorder = 0. To count abandoned carts, we must count visits with an abandoned cart - if ($ecommerceType == Piwik_Tracker_GoalManager::IDGOAL_CART) { - $row[Piwik_Archive::INDEX_ECOMMERCE_ORDERS] = $row[Piwik_Archive::INDEX_NB_VISITS]; - } - unset($row[Piwik_Archive::INDEX_NB_VISITS]); - unset($row['label']); - unset($row['ecommerceType']); - - $columnsToRound = array( - Piwik_Archive::INDEX_ECOMMERCE_ITEM_REVENUE, - Piwik_Archive::INDEX_ECOMMERCE_ITEM_QUANTITY, - Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE, - Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED, - ); - foreach ($columnsToRound as $column) { - if (isset($row[$column]) - && $row[$column] == round($row[$column]) - ) { - $row[$column] = round($row[$column]); - } - } - $items[$dimension][$ecommerceType][$label] = $row; + protected function initItemReports() + { + foreach ($this->getEcommerceIdGoals() as $ecommerceType) { + foreach ($this->dimensionRecord as $dimension => $record) { + $this->itemReports[$dimension][$ecommerceType] = new Piwik_DataArray(); } } + } - foreach ($this->dimensions as $dimension => $recordName) { - foreach (array(Piwik_Tracker_GoalManager::IDGOAL_CART, Piwik_Tracker_GoalManager::IDGOAL_ORDER) as $ecommerceType) { - if (!isset($items[$dimension][$ecommerceType])) { - continue; - } - $recordNameInsert = $recordName; + protected function recordItemReports() + { + /** @var Piwik_DataArray $array */ + foreach ($this->itemReports as $dimension => $itemAggregatesByType) { + foreach ($itemAggregatesByType as $ecommerceType => $itemAggregate) { + $recordName = $this->dimensionRecord[$dimension]; if ($ecommerceType == Piwik_Tracker_GoalManager::IDGOAL_CART) { - $recordNameInsert = self::getItemRecordNameAbandonedCart($recordName); - } - $table = $this->getProcessor()->getDataTableFromArray($items[$dimension][$ecommerceType]); - - // For "category" report, we aggregate all 5 category queries into one datatable - if ($dimension == 'idaction_category') { - foreach (array('idaction_category2', 'idaction_category3', 'idaction_category4', 'idaction_category5') as $categoryToSum) { - if (!empty($items[$categoryToSum][$ecommerceType])) { - $tableToSum = $this->getProcessor()->getDataTableFromArray($items[$categoryToSum][$ecommerceType]); - $table->addDataTable($tableToSum); - } - } + $recordName = self::getItemRecordNameAbandonedCart($recordName); } - $this->getProcessor()->insertBlobRecord($recordNameInsert, $table->getSerialized()); + $table = $this->getProcessor()->getDataTableFromDataArray($itemAggregate); + $this->getProcessor()->insertBlobRecord($recordName, $table->getSerialized()); + } + } + } + + protected function shouldArchiveEcommerceItems() + { + // Per item doesn't support segment + // Also, when querying Goal metrics for visitorType==returning, we wouldnt want to trigger an extra request + // event if it did support segment + // (when this is implemented, we should have shouldProcessReportsForPlugin() support partial archiving based on which metric is requested) + if (!$this->getProcessor()->getSegment()->isEmpty()) { + return false; + } + return true; + } + + protected function getItemsDimensions() + { + $dimensions = array_keys($this->dimensionRecord); + foreach ($this->getItemExtraCategories() as $category) { + $dimensions[] = $category; + } + return $dimensions; + } + + protected function getItemExtraCategories() + { + return array(self::CATEGORY2_FIELD, self::CATEGORY3_FIELD, self::CATEGORY4_FIELD, self::CATEGORY5_FIELD); + } + + protected function isItemExtraCategory($field) + { + return in_array($field, $this->getItemExtraCategories()); + } + + protected function aggregateFromEcommerceItems($query, $dimension) + { + while ($row = $query->fetch()) { + $ecommerceType = $row['ecommerceType']; + + $label = $this->cleanupRowGetLabel($row, $dimension); + if ($label === false) { + continue; + } + + // Aggregate extra categories in the Item categories array + if ($this->isItemExtraCategory($dimension)) { + $array = $this->itemReports[self::CATEGORY_FIELD][$ecommerceType]; + } else { + $array = $this->itemReports[$dimension][$ecommerceType]; + } + + $this->roundColumnValues($row); + $array->sumMetrics($label, $row); + } + } + + protected function cleanupRowGetLabel(&$row, $currentField) + { + $label = $row['label']; + if (empty($label)) { + // An empty additional category -> skip this iteration + if ($this->isItemExtraCategory($currentField)) { + return false; + } + $label = "Value not defined"; + // Product Name/Category not defined" + if (class_exists('Piwik_CustomVariables')) { + $label = Piwik_CustomVariables_Archiver::LABEL_CUSTOM_VALUE_NOT_DEFINED; } } + + if ($row['ecommerceType'] == Piwik_Tracker_GoalManager::IDGOAL_CART) { + // abandoned carts are the numner of visits with an abandoned cart + $row[Piwik_Archive::INDEX_ECOMMERCE_ORDERS] = $row[Piwik_Archive::INDEX_NB_VISITS]; + } + + unset($row[Piwik_Archive::INDEX_NB_VISITS]); + unset($row['label']); + unset($row['ecommerceType']); + + return $label; + } + + protected function roundColumnValues(&$row) + { + $columnsToRound = array( + Piwik_Archive::INDEX_ECOMMERCE_ITEM_REVENUE, + Piwik_Archive::INDEX_ECOMMERCE_ITEM_QUANTITY, + Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE, + Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED, + ); + foreach ($columnsToRound as $column) { + if (isset($row[$column]) + && $row[$column] == round($row[$column]) + ) { + $row[$column] = round($row[$column]); + } + } + } + + protected function getEcommerceIdGoals() + { + return array(Piwik_Tracker_GoalManager::IDGOAL_CART, Piwik_Tracker_GoalManager::IDGOAL_ORDER); + } + + static public function getItemRecordNameAbandonedCart($recordName) + { + return $recordName . '_Cart'; } /** @@ -267,8 +376,8 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver * Archive Ecommerce Items */ if ($this->shouldArchiveEcommerceItems()) { - $dataTableToSum = $this->dimensions; - foreach ($this->dimensions as $recordName) { + $dataTableToSum = $this->dimensionRecord; + foreach ($this->dimensionRecord as $recordName) { $dataTableToSum[] = self::getItemRecordNameAbandonedCart($recordName); } $this->getProcessor()->archiveDataTable($dataTableToSum); @@ -303,51 +412,13 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver // sum up the visits to conversion data table & the days to conversion data table $this->getProcessor()->archiveDataTable(array( - self::getRecordName(self::VISITS_UNTIL_RECORD_NAME, $goalId), - self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME, $goalId))); + self::getRecordName(self::VISITS_UNTIL_RECORD_NAME, $goalId), + self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME, $goalId))); } // sum up goal overview reports $this->getProcessor()->archiveDataTable(array( - self::getRecordName(self::VISITS_UNTIL_RECORD_NAME), - self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME))); - } - - protected function shouldArchiveEcommerceItems() - { - // Per item doesn't support segment - // Also, when querying Goal metrics for visitorType==returning, we wouldnt want to trigger an extra request - // event if it did support segment - // (when this is implemented, we should have shouldProcessReportsForPlugin() support partial archiving based on which metric is requested) - if (!$this->getProcessor()->getSegment()->isEmpty()) { - return false; - } - return true; - } - - static public function getItemRecordNameAbandonedCart($recordName) - { - return $recordName . '_Cart'; + self::getRecordName(self::VISITS_UNTIL_RECORD_NAME), + self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME))); } - - /** - * @param string $recordName 'nb_conversions' - * @param int|bool $idGoal idGoal to return the metrics for, or false to return overall - * @return string Archive record name - */ - static public function getRecordName($recordName, $idGoal = false) - { - $idGoalStr = ''; - if ($idGoal !== false) { - $idGoalStr = $idGoal . "_"; - } - return 'Goal_' . $idGoalStr . $recordName; - } - - private function getConversionRate($count) - { - $visits = $this->getProcessor()->getNumberOfVisits(); - return round(100 * $count / $visits, Piwik_Tracker_GoalManager::REVENUE_PRECISION); - } - } \ No newline at end of file diff --git a/plugins/Provider/Archiver.php b/plugins/Provider/Archiver.php index 3cc703a0e2..692c3a72d2 100644 --- a/plugins/Provider/Archiver.php +++ b/plugins/Provider/Archiver.php @@ -11,19 +11,12 @@ class Piwik_Provider_Archiver extends Piwik_PluginsArchiver { const PROVIDER_RECORD_NAME = 'Provider_hostnameExt'; - protected $maximumRows; - - public function __construct($processor) - { - parent::__construct($processor); - $this->maximumRows = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; - } + const PROVIDER_FIELD = "location_provider"; public function archiveDay() { - $labelSQL = "log_visit.location_provider"; - $metricsByProvider = $this->getProcessor()->getMetricsForLabel($labelSQL); - $tableProvider = $this->getProcessor()->getDataTableFromArray($metricsByProvider); + $metrics = $this->getProcessor()->getMetricsForDimension(self::PROVIDER_FIELD); + $tableProvider = $this->getProcessor()->getDataTableFromDataArray($metrics); $this->getProcessor()->insertBlobRecord(self::PROVIDER_RECORD_NAME, $tableProvider->getSerialized($this->maximumRows, null, Piwik_Archive::INDEX_NB_VISITS)); } diff --git a/plugins/Referers/API.php b/plugins/Referers/API.php index abec869e56..e194b67df2 100644 --- a/plugins/Referers/API.php +++ b/plugins/Referers/API.php @@ -129,7 +129,7 @@ class Piwik_Referers_API public function getKeywords($idSite, $period, $date, $segment = false, $expanded = false) { - $dataTable = $this->getDataTable(Piwik_Referers_Archiver::SEARCH_ENGINE_BY_KEYWORD_RECORD_NAME, $idSite, $period, $date, $segment, $expanded); + $dataTable = $this->getDataTable(Piwik_Referers_Archiver::KEYWORDS_RECORD_NAME, $idSite, $period, $date, $segment, $expanded); $dataTable = $this->handleKeywordNotDefined($dataTable); return $dataTable; } @@ -212,7 +212,7 @@ class Piwik_Referers_API public function getSearchEnginesFromKeywordId($idSite, $period, $date, $idSubtable, $segment = false) { - $dataTable = $this->getDataTable(Piwik_Referers_Archiver::SEARCH_ENGINE_BY_KEYWORD_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = false, $idSubtable); + $dataTable = $this->getDataTable(Piwik_Referers_Archiver::KEYWORDS_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = false, $idSubtable); $dataTable->queueFilter('ColumnCallbackAddMetadata', array('label', 'url', 'Piwik_getSearchEngineUrlFromName')); $dataTable->queueFilter('MetadataCallbackAddMetadata', array('url', 'logo', 'Piwik_getSearchEngineLogoFromUrl')); @@ -228,7 +228,7 @@ class Piwik_Referers_API public function getSearchEngines($idSite, $period, $date, $segment = false, $expanded = false) { - $dataTable = $this->getDataTable(Piwik_Referers_Archiver::KEYWORDS_BY_SEARCH_ENGINE_RECORD_NAME, $idSite, $period, $date, $segment, $expanded); + $dataTable = $this->getDataTable(Piwik_Referers_Archiver::SEARCH_ENGINES_RECORD_NAME, $idSite, $period, $date, $segment, $expanded); $dataTable->queueFilter('ColumnCallbackAddMetadata', array('label', 'url', 'Piwik_getSearchEngineUrlFromName')); $dataTable->queueFilter('MetadataCallbackAddMetadata', array('url', 'logo', 'Piwik_getSearchEngineLogoFromUrl')); return $dataTable; @@ -236,7 +236,7 @@ class Piwik_Referers_API public function getKeywordsFromSearchEngineId($idSite, $period, $date, $idSubtable, $segment = false) { - $dataTable = $this->getDataTable(Piwik_Referers_Archiver::KEYWORDS_BY_SEARCH_ENGINE_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = false, $idSubtable); + $dataTable = $this->getDataTable(Piwik_Referers_Archiver::SEARCH_ENGINES_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = false, $idSubtable); // get the search engine and create the URL to the search result page $searchEngines = $this->getSearchEngines($idSite, $period, $date, $segment); @@ -267,25 +267,25 @@ class Piwik_Referers_API public function getCampaigns($idSite, $period, $date, $segment = false, $expanded = false) { - $dataTable = $this->getDataTable(Piwik_Referers_Archiver::KEYWORD_BY_CAMPAIGN_RECORD_NAME, $idSite, $period, $date, $segment, $expanded); + $dataTable = $this->getDataTable(Piwik_Referers_Archiver::CAMPAIGNS_RECORD_NAME, $idSite, $period, $date, $segment, $expanded); return $dataTable; } public function getKeywordsFromCampaignId($idSite, $period, $date, $idSubtable, $segment = false) { - $dataTable = $this->getDataTable(Piwik_Referers_Archiver::KEYWORD_BY_CAMPAIGN_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = false, $idSubtable); + $dataTable = $this->getDataTable(Piwik_Referers_Archiver::CAMPAIGNS_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = false, $idSubtable); return $dataTable; } public function getWebsites($idSite, $period, $date, $segment = false, $expanded = false) { - $dataTable = $this->getDataTable(Piwik_Referers_Archiver::URL_BY_WEBSITE_RECORD_NAME, $idSite, $period, $date, $segment, $expanded); + $dataTable = $this->getDataTable(Piwik_Referers_Archiver::WEBSITES_RECORD_NAME, $idSite, $period, $date, $segment, $expanded); return $dataTable; } public function getUrlsFromWebsiteId($idSite, $period, $date, $idSubtable, $segment = false) { - $dataTable = $this->getDataTable(Piwik_Referers_Archiver::URL_BY_WEBSITE_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = false, $idSubtable); + $dataTable = $this->getDataTable(Piwik_Referers_Archiver::WEBSITES_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = false, $idSubtable); // the htmlspecialchars_decode call is for BC for before 1.1 // as the Referer URL was previously encoded in the log tables, but is now recorded raw $dataTable->queueFilter('ColumnCallbackAddMetadata', array('label', 'url', create_function('$label', 'return htmlspecialchars_decode($label);'))); @@ -308,7 +308,7 @@ class Piwik_Referers_API { require PIWIK_INCLUDE_PATH . '/core/DataFiles/Socials.php'; - $dataTable = $this->getDataTable( Piwik_Referers_Archiver::URL_BY_WEBSITE_RECORD_NAME, $idSite, $period, $date, $segment, $expanded); + $dataTable = $this->getDataTable( Piwik_Referers_Archiver::WEBSITES_RECORD_NAME, $idSite, $period, $date, $segment, $expanded); $dataTable->filter('ColumnCallbackDeleteRow', array('label', 'Piwik_Referrers_isSocialUrl')); @@ -341,7 +341,7 @@ class Piwik_Referers_API { require PIWIK_INCLUDE_PATH . '/core/DataFiles/Socials.php'; - $dataTable = $this->getDataTable( Piwik_Referers_Archiver::URL_BY_WEBSITE_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = true); + $dataTable = $this->getDataTable( Piwik_Referers_Archiver::WEBSITES_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = true); // get the social network domain referred to by $idSubtable $social = false; diff --git a/plugins/Referers/Archiver.php b/plugins/Referers/Archiver.php index 58907702ad..ddae742131 100644 --- a/plugins/Referers/Archiver.php +++ b/plugins/Referers/Archiver.php @@ -11,30 +11,21 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver { - const KEYWORDS_BY_SEARCH_ENGINE_RECORD_NAME = 'Referers_keywordBySearchEngine'; - const SEARCH_ENGINE_BY_KEYWORD_RECORD_NAME = 'Referers_searchEngineByKeyword'; - const KEYWORD_BY_CAMPAIGN_RECORD_NAME = 'Referers_keywordByCampaign'; - const URL_BY_WEBSITE_RECORD_NAME = 'Referers_urlByWebsite'; + const SEARCH_ENGINES_RECORD_NAME = 'Referers_keywordBySearchEngine'; + const KEYWORDS_RECORD_NAME = 'Referers_searchEngineByKeyword'; + const CAMPAIGNS_RECORD_NAME = 'Referers_keywordByCampaign'; + const WEBSITES_RECORD_NAME = 'Referers_urlByWebsite'; const REFERER_TYPE_RECORD_NAME = 'Referers_type'; - const METRIC_DISTINCT_SEARCH_ENGINE_RECORD_NAME = 'Referers_distinctSearchEngines'; const METRIC_DISTINCT_KEYWORD_RECORD_NAME = 'Referers_distinctKeywords'; const METRIC_DISTINCT_CAMPAIGN_RECORD_NAME = 'Referers_distinctCampaigns'; const METRIC_DISTINCT_WEBSITE_RECORD_NAME = 'Referers_distinctWebsites'; const METRIC_DISTINCT_URLS_RECORD_NAME = 'Referers_distinctWebsitesUrls'; - protected $columnToSortByBeforeTruncation; protected $maximumRowsInDataTableLevelZero; protected $maximumRowsInSubDataTable; - protected $metricsBySearchEngine = array(); - protected $metricsByKeyword = array(); - protected $metricsBySearchEngineAndKeyword = array(); - protected $metricsByKeywordAndSearchEngine = array(); - protected $metricsByWebsite = array(); - protected $metricsByWebsiteAndUrl = array(); - protected $metricsByCampaignAndKeyword = array(); - protected $metricsByCampaign = array(); - protected $metricsByType = array(); + /* @var array[Piwik_DataArray] $arrays */ + protected $arrays = array(); protected $distinctUrls = array(); function __construct($processor) @@ -47,6 +38,9 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver public function archiveDay() { + foreach ($this->getRecordNames() as $record) { + $this->arrays[$record] = new Piwik_DataArray(); + } $query = $this->getProcessor()->queryVisitsByDimension(array("referer_type", "referer_name", "referer_keyword", "referer_url")); $this->aggregateFromVisits($query); @@ -57,12 +51,22 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver $this->recordDayReports(); } + protected function getRecordNames() + { + return array( + self::REFERER_TYPE_RECORD_NAME, + self::KEYWORDS_RECORD_NAME, + self::SEARCH_ENGINES_RECORD_NAME, + self::WEBSITES_RECORD_NAME, + self::CAMPAIGNS_RECORD_NAME, + ); + } + protected function aggregateFromVisits($query) { while ($row = $query->fetch()) { $this->makeRefererTypeNonEmpty($row); $this->aggregateVisit($row); - $this->aggregateVisitByType($row); } } @@ -77,15 +81,32 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver { switch ($row['referer_type']) { case Piwik_Common::REFERER_TYPE_SEARCH_ENGINE: - $this->aggregateVisitBySearchEngine($row); + if (empty($row['referer_keyword'])) { + $row['referer_keyword'] = Piwik_Referers_API::LABEL_KEYWORD_NOT_DEFINED; + } + $searchEnginesArray = $this->getDataArray(self::SEARCH_ENGINES_RECORD_NAME); + $searchEnginesArray->sumMetricsVisits($row['referer_name'], $row); + $searchEnginesArray->sumMetricsVisitsPivot($row['referer_name'], $row['referer_keyword'], $row); + $keywordsDataArray = $this->getDataArray(self::KEYWORDS_RECORD_NAME); + $keywordsDataArray->sumMetricsVisits($row['referer_keyword'], $row); + $keywordsDataArray->sumMetricsVisitsPivot($row['referer_keyword'], $row['referer_name'], $row); break; case Piwik_Common::REFERER_TYPE_WEBSITE: - $this->aggregateVisitByWebsite($row); + $this->getDataArray(self::WEBSITES_RECORD_NAME)->sumMetricsVisits($row['referer_name'], $row); + $this->getDataArray(self::WEBSITES_RECORD_NAME)->sumMetricsVisitsPivot($row['referer_name'], $row['referer_url'], $row); + + $urlHash = substr(md5($row['referer_url']), 0, 10); + if (!isset($this->distinctUrls[$urlHash])) { + $this->distinctUrls[$urlHash] = true; + } break; case Piwik_Common::REFERER_TYPE_CAMPAIGN: - $this->aggregateVisitByCampaign($row); + if (!empty($row['referer_keyword'])) { + $this->getDataArray(self::CAMPAIGNS_RECORD_NAME)->sumMetricsVisitsPivot($row['referer_name'], $row['referer_keyword'], $row); + } + $this->getDataArray(self::CAMPAIGNS_RECORD_NAME)->sumMetricsVisits($row['referer_name'], $row); break; case Piwik_Common::REFERER_TYPE_DIRECT_ENTRY: @@ -96,70 +117,16 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver throw new Exception("Non expected referer_type = " . $row['referer_type']); break; } + $this->getDataArray(self::REFERER_TYPE_RECORD_NAME)->sumMetricsVisits($row['referer_type'], $row); } - protected function aggregateVisitBySearchEngine($row) - { - if (empty($row['referer_keyword'])) { - $row['referer_keyword'] = Piwik_Referers_API::LABEL_KEYWORD_NOT_DEFINED; - } - if (!isset($this->metricsBySearchEngine[$row['referer_name']])) { - $this->metricsBySearchEngine[$row['referer_name']] = $this->getProcessor()->makeEmptyRow(); - } - if (!isset($this->metricsByKeyword[$row['referer_keyword']])) { - $this->metricsByKeyword[$row['referer_keyword']] = $this->getProcessor()->makeEmptyRow(); - } - if (!isset($this->metricsBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']])) { - $this->metricsBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']] = $this->getProcessor()->makeEmptyRow(); - } - if (!isset($this->metricsByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']])) { - $this->metricsByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']] = $this->getProcessor()->makeEmptyRow(); - } - - $this->getProcessor()->sumMetrics($row, $this->metricsBySearchEngine[$row['referer_name']]); - $this->getProcessor()->sumMetrics($row, $this->metricsByKeyword[$row['referer_keyword']]); - $this->getProcessor()->sumMetrics($row, $this->metricsBySearchEngineAndKeyword[$row['referer_name']][$row['referer_keyword']]); - $this->getProcessor()->sumMetrics($row, $this->metricsByKeywordAndSearchEngine[$row['referer_keyword']][$row['referer_name']]); - } - - protected function aggregateVisitByWebsite($row) - { - if (!isset($this->metricsByWebsite[$row['referer_name']])) { - $this->metricsByWebsite[$row['referer_name']] = $this->getProcessor()->makeEmptyRow(); - } - $this->getProcessor()->sumMetrics($row, $this->metricsByWebsite[$row['referer_name']]); - - if (!isset($this->metricsByWebsiteAndUrl[$row['referer_name']][$row['referer_url']])) { - $this->metricsByWebsiteAndUrl[$row['referer_name']][$row['referer_url']] = $this->getProcessor()->makeEmptyRow(); - } - $this->getProcessor()->sumMetrics($row, $this->metricsByWebsiteAndUrl[$row['referer_name']][$row['referer_url']]); - - $urlHash = substr(md5($row['referer_url']), 0, 10); - if (!isset($this->distinctUrls[$urlHash])) { - $this->distinctUrls[$urlHash] = true; - } - } - - protected function aggregateVisitByCampaign($row) - { - if (!empty($row['referer_keyword'])) { - if (!isset($this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']])) { - $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']] = $this->getProcessor()->makeEmptyRow(); - } - $this->getProcessor()->sumMetrics($row, $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']]); - } - if (!isset($this->metricsByCampaign[$row['referer_name']])) { - $this->metricsByCampaign[$row['referer_name']] = $this->getProcessor()->makeEmptyRow(); - } - $this->getProcessor()->sumMetrics($row, $this->metricsByCampaign[$row['referer_name']]); - } - - protected function aggregateVisitByType($row) + /** + * @param $name + * @return Piwik_DataArray + */ + protected function getDataArray($name) { - if (!isset($this->metricsByType[$row['referer_type']])) { - $this->metricsByType[$row['referer_type']] = $this->getProcessor()->makeEmptyRow(); - } - $this->getProcessor()->sumMetrics($row, $this->metricsByType[$row['referer_type']]); + return $this->arrays[$name]; } protected function aggregateFromConversions($query) @@ -172,16 +139,14 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver $skipAggregateByType = $this->aggregateConversion($row); if (!$skipAggregateByType) { - $this->aggregateConversionByType($row); + $this->getDataArray(self::REFERER_TYPE_RECORD_NAME)->sumMetricsGoals($row['referer_type'], $row); } } - $this->getProcessor()->enrichMetricsWithConversions($this->metricsByType); - $this->getProcessor()->enrichMetricsWithConversions($this->metricsBySearchEngine); - $this->getProcessor()->enrichMetricsWithConversions($this->metricsByKeyword); - $this->getProcessor()->enrichMetricsWithConversions($this->metricsByWebsite); - $this->getProcessor()->enrichMetricsWithConversions($this->metricsByCampaign); - $this->getProcessor()->enrichPivotMetricsWithConversions($this->metricsByCampaignAndKeyword); + foreach ($this->arrays as $dataArray) { + /* @var Piwik_DataArray $dataArray */ + $dataArray->enrichMetricsWithConversions(); + } } protected function aggregateConversion($row) @@ -189,15 +154,23 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver $skipAggregateByType = false; switch ($row['referer_type']) { case Piwik_Common::REFERER_TYPE_SEARCH_ENGINE: - $this->aggregateConversionBySearchEngine($row); + if (empty($row['referer_keyword'])) { + $row['referer_keyword'] = Piwik_Referers_API::LABEL_KEYWORD_NOT_DEFINED; + } + + $this->getDataArray(self::SEARCH_ENGINES_RECORD_NAME)->sumMetricsGoals($row['referer_name'], $row); + $this->getDataArray(self::KEYWORDS_RECORD_NAME)->sumMetricsGoals($row['referer_keyword'], $row); break; case Piwik_Common::REFERER_TYPE_WEBSITE: - $this->aggregateConversionByWebsite($row); + $this->getDataArray(self::WEBSITES_RECORD_NAME)->sumMetricsGoals($row['referer_name'], $row); break; case Piwik_Common::REFERER_TYPE_CAMPAIGN: - $this->aggregateConversionByCampaign($row); + if (!empty($row['referer_keyword'])) { + $this->getDataArray(self::CAMPAIGNS_RECORD_NAME)->sumMetricsGoalsPivot($row['referer_name'], $row['referer_keyword'], $row); + } + $this->getDataArray(self::CAMPAIGNS_RECORD_NAME)->sumMetricsGoals($row['referer_name'], $row); break; case Piwik_Common::REFERER_TYPE_DIRECT_ENTRY: @@ -213,52 +186,6 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver return $skipAggregateByType; } - protected function aggregateConversionBySearchEngine($row) - { - if (empty($row['referer_keyword'])) { - $row['referer_keyword'] = Piwik_Referers_API::LABEL_KEYWORD_NOT_DEFINED; - } - if (!isset($this->metricsBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { - $this->metricsBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $this->getProcessor()->makeEmptyGoalRow($row['idgoal']); - } - if (!isset($this->metricsByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { - $this->metricsByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $this->getProcessor()->makeEmptyGoalRow($row['idgoal']); - } - - $this->getProcessor()->sumGoalMetrics($row, $this->metricsBySearchEngine[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - $this->getProcessor()->sumGoalMetrics($row, $this->metricsByKeyword[$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - } - - protected function aggregateConversionByWebsite($row) - { - if (!isset($this->metricsByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { - $this->metricsByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $this->getProcessor()->makeEmptyGoalRow($row['idgoal']); - } - $this->getProcessor()->sumGoalMetrics($row, $this->metricsByWebsite[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - } - - protected function aggregateConversionByCampaign($row) - { - if (!empty($row['referer_keyword'])) { - if (!isset($this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { - $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $this->getProcessor()->makeEmptyGoalRow($row['idgoal']); - } - $this->getProcessor()->sumGoalMetrics($row, $this->metricsByCampaignAndKeyword[$row['referer_name']][$row['referer_keyword']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - } - if (!isset($this->metricsByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { - $this->metricsByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $this->getProcessor()->makeEmptyGoalRow($row['idgoal']); - } - $this->getProcessor()->sumGoalMetrics($row, $this->metricsByCampaign[$row['referer_name']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - } - - protected function aggregateConversionByType($row) - { - if (!isset($this->metricsByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { - $this->metricsByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $this->getProcessor()->makeEmptyGoalRow($row['idgoal']); - } - $this->getProcessor()->sumGoalMetrics($row, $this->metricsByType[$row['referer_type']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); - } - /** * Records the daily stats (numeric or datatable blob) into the archive tables. * @@ -273,31 +200,21 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver protected function recordDayNumeric() { $numericRecords = array( - self::METRIC_DISTINCT_SEARCH_ENGINE_RECORD_NAME => count($this->metricsBySearchEngineAndKeyword), - self::METRIC_DISTINCT_KEYWORD_RECORD_NAME => count($this->metricsByKeywordAndSearchEngine), - self::METRIC_DISTINCT_CAMPAIGN_RECORD_NAME => count($this->metricsByCampaign), - self::METRIC_DISTINCT_WEBSITE_RECORD_NAME => count($this->metricsByWebsite), + self::METRIC_DISTINCT_SEARCH_ENGINE_RECORD_NAME => count($this->getDataArray(self::SEARCH_ENGINES_RECORD_NAME)), + self::METRIC_DISTINCT_KEYWORD_RECORD_NAME => count($this->getDataArray(self::KEYWORDS_RECORD_NAME)), + self::METRIC_DISTINCT_CAMPAIGN_RECORD_NAME => count($this->getDataArray(self::CAMPAIGNS_RECORD_NAME)), + self::METRIC_DISTINCT_WEBSITE_RECORD_NAME => count($this->getDataArray(self::WEBSITES_RECORD_NAME)), self::METRIC_DISTINCT_URLS_RECORD_NAME => count($this->distinctUrls), ); - foreach ($numericRecords as $name => $value) { - $this->getProcessor()->insertNumericRecord($name, $value); - } + $this->getProcessor()->insertNumericRecords($numericRecords); } protected function recordDayBlobs() { - $table = new Piwik_DataTable(); - $table->addRowsFromArrayWithIndexLabel($this->metricsByType); - $this->getProcessor()->insertBlobRecord(self::REFERER_TYPE_RECORD_NAME, $table->getSerialized()); - - $blobRecords = array( - self::KEYWORDS_BY_SEARCH_ENGINE_RECORD_NAME => $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsBySearchEngineAndKeyword, $this->metricsBySearchEngine), - self::SEARCH_ENGINE_BY_KEYWORD_RECORD_NAME => $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByKeywordAndSearchEngine, $this->metricsByKeyword), - self::KEYWORD_BY_CAMPAIGN_RECORD_NAME => $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByCampaignAndKeyword, $this->metricsByCampaign), - self::URL_BY_WEBSITE_RECORD_NAME => $this->getProcessor()->getDataTableWithSubtablesFromArraysIndexedByLabel($this->metricsByWebsiteAndUrl, $this->metricsByWebsite), - ); - foreach ($blobRecords as $recordName => $table) { + foreach ($this->getRecordNames() as $recordName) { + $dataArray = $this->getDataArray($recordName); + $table = $this->getProcessor()->getDataTableFromDataArray($dataArray); $blob = $table->getSerialized($this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $this->columnToSortByBeforeTruncation); $this->getProcessor()->insertBlobRecord($recordName, $blob); } @@ -305,35 +222,29 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver public function archivePeriod() { - $dataTableToSum = array( - self::REFERER_TYPE_RECORD_NAME, - self::KEYWORDS_BY_SEARCH_ENGINE_RECORD_NAME, - self::SEARCH_ENGINE_BY_KEYWORD_RECORD_NAME, - self::KEYWORD_BY_CAMPAIGN_RECORD_NAME, - self::URL_BY_WEBSITE_RECORD_NAME, - ); + $dataTableToSum = $this->getRecordNames(); $nameToCount = $this->getProcessor()->archiveDataTable($dataTableToSum, null, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $this->columnToSortByBeforeTruncation); $mappingFromArchiveName = array( self::METRIC_DISTINCT_SEARCH_ENGINE_RECORD_NAME => array('typeCountToUse' => 'level0', - 'nameTableToUse' => self::KEYWORDS_BY_SEARCH_ENGINE_RECORD_NAME, + 'nameTableToUse' => self::SEARCH_ENGINES_RECORD_NAME, ), self::METRIC_DISTINCT_KEYWORD_RECORD_NAME => array('typeCountToUse' => 'level0', - 'nameTableToUse' => self::SEARCH_ENGINE_BY_KEYWORD_RECORD_NAME, + 'nameTableToUse' => self::KEYWORDS_RECORD_NAME, ), self::METRIC_DISTINCT_CAMPAIGN_RECORD_NAME => array('typeCountToUse' => 'level0', - 'nameTableToUse' => self::KEYWORD_BY_CAMPAIGN_RECORD_NAME, + 'nameTableToUse' => self::CAMPAIGNS_RECORD_NAME, ), self::METRIC_DISTINCT_WEBSITE_RECORD_NAME => array('typeCountToUse' => 'level0', - 'nameTableToUse' => self::URL_BY_WEBSITE_RECORD_NAME, + 'nameTableToUse' => self::WEBSITES_RECORD_NAME, ), self::METRIC_DISTINCT_URLS_RECORD_NAME => array('typeCountToUse' => 'recursive', - 'nameTableToUse' => self::URL_BY_WEBSITE_RECORD_NAME, + 'nameTableToUse' => self::WEBSITES_RECORD_NAME, ), ); diff --git a/plugins/SEO/API.php b/plugins/SEO/API.php index 26ac00c5bd..bc94a2663d 100644 --- a/plugins/SEO/API.php +++ b/plugins/SEO/API.php @@ -100,8 +100,6 @@ class Piwik_SEO_API $data[Piwik_Translate('SEO_Dmoz')] = $dmozRank; } - $dataTable = new Piwik_DataTable(); - $dataTable->addRowsFromArrayWithIndexLabel($data); - return $dataTable; + return Piwik_DataTable::makeFromIndexedArray($data); } } diff --git a/plugins/Transitions/Transitions.php b/plugins/Transitions/Transitions.php index 765854bff7..b92ef87b8c 100644 --- a/plugins/Transitions/Transitions.php +++ b/plugins/Transitions/Transitions.php @@ -79,16 +79,15 @@ class Piwik_Transitions extends Piwik_Plugin // group by. when we group by both, we don't get a single column for the keyword but instead // one column per keyword + search engine url. this way, we could not get the top keywords using // the ranking query. - $dimension = 'referrer_data'; + $dimensions = array('referrer_data', 'referer_type'); $rankingQuery->addLabelColumn('referrer_data'); - $select = ' - CASE referer_type + $selects = array( + 'CASE referer_type WHEN ' . Piwik_Common::REFERER_TYPE_DIRECT_ENTRY . ' THEN \'\' WHEN ' . Piwik_Common::REFERER_TYPE_SEARCH_ENGINE . ' THEN referer_keyword WHEN ' . Piwik_Common::REFERER_TYPE_WEBSITE . ' THEN referer_url WHEN ' . Piwik_Common::REFERER_TYPE_CAMPAIGN . ' THEN CONCAT(referer_name, \' \', referer_keyword) - END AS referrer_data, - referer_type'; + END AS referrer_data'); // get one limited group per referrer type $rankingQuery->partitionResultIntoMultipleGroups('referer_type', array( @@ -98,14 +97,11 @@ class Piwik_Transitions extends Piwik_Plugin Piwik_Common::REFERER_TYPE_CAMPAIGN )); - $orderBy = '`' . Piwik_Archive::INDEX_NB_VISITS . '` DESC'; - $type = $this->getColumnTypeSuffix($actionType); $where = 'visit_entry_idaction_' . $type . ' = ' . intval($idaction); $metrics = array(Piwik_Archive::INDEX_NB_VISITS); - $data = $archiveProcessing->queryVisitsByDimension($dimension, $where, $metrics, $orderBy, - $rankingQuery, $select, $selectGeneratesLabelColumn = true); + $data = $archiveProcessing->queryVisitsByDimension($dimensions, $where, $selects, $metrics, $rankingQuery); $referrerData = array(); $referrerSubData = array(); @@ -132,7 +128,9 @@ class Piwik_Transitions extends Piwik_Plugin } } - return $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($referrerSubData, $referrerData); + //FIXMEA refactor after integration tests written + $array = new Piwik_DataArray($referrerData, $referrerSubData); + return Piwik_ArchiveProcessing_Day::getDataTableFromDataArray($array); } /** @@ -161,14 +159,16 @@ class Piwik_Transitions extends Piwik_Plugin $dimension = 'idaction_name_ref'; } - $addSelect = ' - log_action.name, log_action.url_prefix, - CASE WHEN log_link_visit_action.idaction_' . $type . '_ref = ' . intval($idaction) . ' THEN 1 ELSE 0 END AS is_self, - CASE - WHEN log_action.type = ' . $mainActionType . ' THEN 1 - WHEN log_action.type = ' . Piwik_Tracker_Action::TYPE_SITE_SEARCH . ' THEN 2 - ELSE 0 - END AS action_partition'; + $selects = array( + 'log_action.name', + 'log_action.url_prefix', + 'CASE WHEN log_link_visit_action.idaction_' . $type . '_ref = ' . intval($idaction) . ' THEN 1 ELSE 0 END AS is_self', + 'CASE + WHEN log_action.type = ' . $mainActionType . ' THEN 1 + WHEN log_action.type = ' . Piwik_Tracker_Action::TYPE_SITE_SEARCH . ' THEN 2 + ELSE 0 + END AS action_partition' + ); $where = ' log_link_visit_action.idaction_' . $type . ' = ' . intval($idaction); @@ -183,11 +183,8 @@ class Piwik_Transitions extends Piwik_Plugin $dimension = array($dimension); } - $orderBy = '`' . Piwik_Archive::INDEX_NB_ACTIONS . '` DESC'; - $metrics = array(Piwik_Archive::INDEX_NB_ACTIONS); - $data = $archiveProcessing->queryActionsByDimension($dimension, $where, $metrics, $orderBy, - $rankingQuery, $joinLogActionOn, $addSelect); + $data = $archiveProcessing->queryActionsByDimension($dimension, $where, $selects, $metrics, $rankingQuery, $joinLogActionOn); $loops = 0; $nbPageviews = 0; @@ -278,7 +275,7 @@ class Piwik_Transitions extends Piwik_Plugin // site search referrers are logged with url=NULL // when we find one, we have to join on name $joinLogActionColumn = $dimension; - $addSelect = 'log_action.name, log_action.url_prefix, log_action.type'; + $selects = array('log_action.name', 'log_action.url_prefix', 'log_action.type'); } else { // specific setup for page titles: $types[Piwik_Tracker_Action::TYPE_ACTION_NAME] = 'followingPages'; @@ -295,25 +292,25 @@ class Piwik_Transitions extends Piwik_Plugin ELSE log_action1.idaction END '; - $addSelect = ' - CASE + $selects = array( + 'CASE ' /* following site search */ . ' WHEN log_link_visit_action.idaction_url IS NULL THEN log_action2.name ' /* following page view: use page title */ . ' WHEN log_action1.type = ' . Piwik_Tracker_Action::TYPE_ACTION_URL . ' THEN log_action2.name ' /* following download or outlink: use url */ . ' ELSE log_action1.name - END AS name, - CASE + END AS name', + 'CASE ' /* following site search */ . ' WHEN log_link_visit_action.idaction_url IS NULL THEN log_action2.type ' /* following page view: use page title */ . ' WHEN log_action1.type = ' . Piwik_Tracker_Action::TYPE_ACTION_URL . ' THEN log_action2.type ' /* following download or outlink: use url */ . ' ELSE log_action1.type - END AS type, - NULL AS url_prefix - '; + END AS type', + 'NULL AS url_prefix' + ); } // these types are available for both titles and urls @@ -332,11 +329,8 @@ class Piwik_Transitions extends Piwik_Plugin . 'log_link_visit_action.idaction_' . $type . ' != ' . intval($idaction) . ')'; } - $orderBy = '`' . Piwik_Archive::INDEX_NB_ACTIONS . '` DESC'; - $metrics = array(Piwik_Archive::INDEX_NB_ACTIONS); - $data = $archiveProcessing->queryActionsByDimension($dimension, $where, $metrics, $orderBy, - $rankingQuery, $joinLogActionColumn, $addSelect); + $data = $archiveProcessing->queryActionsByDimension($dimension, $where, $selects, $metrics, $rankingQuery, $joinLogActionColumn); $this->totalTransitionsToFollowingActions = 0; $dataTables = array(); diff --git a/plugins/UserCountry/API.php b/plugins/UserCountry/API.php index 15f5f69ecf..40432969e9 100644 --- a/plugins/UserCountry/API.php +++ b/plugins/UserCountry/API.php @@ -32,7 +32,7 @@ class Piwik_UserCountry_API public function getCountry($idSite, $period, $date, $segment = false) { - $dataTable = $this->getDataTable(Piwik_UserCountry_Archiver::VISITS_BY_COUNTRY_RECORD_NAME, $idSite, $period, $date, $segment); + $dataTable = $this->getDataTable(Piwik_UserCountry_Archiver::COUNTRY_RECORD_NAME, $idSite, $period, $date, $segment); // apply filter on the whole datatable in order the inline search to work (searches are done on "beautiful" label) $dataTable->filter('ColumnCallbackAddMetadata', array('label', 'code')); @@ -46,7 +46,7 @@ class Piwik_UserCountry_API public function getContinent($idSite, $period, $date, $segment = false) { - $dataTable = $this->getDataTable(Piwik_UserCountry_Archiver::VISITS_BY_COUNTRY_RECORD_NAME, $idSite, $period, $date, $segment); + $dataTable = $this->getDataTable(Piwik_UserCountry_Archiver::COUNTRY_RECORD_NAME, $idSite, $period, $date, $segment); $getContinent = array('Piwik_Common', 'getContinent'); $dataTable->filter('GroupBy', array('label', $getContinent)); @@ -68,7 +68,7 @@ class Piwik_UserCountry_API */ public function getRegion($idSite, $period, $date, $segment = false) { - $dataTable = $this->getDataTable(Piwik_UserCountry_Archiver::VISITS_BY_REGION_RECORD_NAME, $idSite, $period, $date, $segment); + $dataTable = $this->getDataTable(Piwik_UserCountry_Archiver::REGION_RECORD_NAME, $idSite, $period, $date, $segment); $separator = Piwik_UserCountry_Archiver::LOCATION_SEPARATOR; $unk = Piwik_Tracker_Visit::UNKNOWN_CODE; @@ -110,7 +110,7 @@ class Piwik_UserCountry_API */ public function getCity($idSite, $period, $date, $segment = false) { - $dataTable = $this->getDataTable(Piwik_UserCountry_Archiver::VISITS_BY_CITY_RECORD_NAME, $idSite, $period, $date, $segment); + $dataTable = $this->getDataTable(Piwik_UserCountry_Archiver::CITY_RECORD_NAME, $idSite, $period, $date, $segment); $separator = Piwik_UserCountry_Archiver::LOCATION_SEPARATOR; $unk = Piwik_Tracker_Visit::UNKNOWN_CODE; diff --git a/plugins/UserCountry/Archiver.php b/plugins/UserCountry/Archiver.php index ecd124d67f..fb69e89ff8 100644 --- a/plugins/UserCountry/Archiver.php +++ b/plugins/UserCountry/Archiver.php @@ -11,9 +11,9 @@ class Piwik_UserCountry_Archiver extends Piwik_PluginsArchiver { - const VISITS_BY_COUNTRY_RECORD_NAME = 'UserCountry_country'; - const VISITS_BY_REGION_RECORD_NAME = 'UserCountry_region'; - const VISITS_BY_CITY_RECORD_NAME = 'UserCountry_city'; + const COUNTRY_RECORD_NAME = 'UserCountry_country'; + const REGION_RECORD_NAME = 'UserCountry_region'; + const CITY_RECORD_NAME = 'UserCountry_city'; const DISTINCT_COUNTRIES_METRIC = 'UserCountry_distinctCountries'; // separate region, city & country info in stored report labels @@ -21,15 +21,28 @@ class Piwik_UserCountry_Archiver extends Piwik_PluginsArchiver private $latLongForCities = array(); - private $metricsByDimension = array(); + private $dataArrays = array(); protected $maximumRows; + const COUNTRY_FIELD = 'location_country'; + + const REGION_FIELD = 'location_region'; + + const CITY_FIELD = 'location_city'; + + protected $dimensions = array( self::COUNTRY_FIELD, self::REGION_FIELD, self::CITY_FIELD ); + + protected $arrays; + const LATITUDE_FIELD = 'location_latitude'; + const LONGITUDE_FIELD = 'location_longitude'; + + public function archiveDay() { - $this->metricsByDimension = array('location_country' => array(), - 'location_region' => array(), - 'location_city' => array()); + foreach($this->dimensions as $dimension) { + $this->arrays[$dimension] = new Piwik_DataArray(); + } $this->aggregateFromVisits(); $this->aggregateFromConversions(); $this->recordDayReports(); @@ -37,17 +50,9 @@ class Piwik_UserCountry_Archiver extends Piwik_PluginsArchiver protected function aggregateFromVisits() { - $dimensions = array_keys($this->metricsByDimension); - $query = $this->getProcessor()->queryVisitsByDimension( - $dimensions, - $where = '', - $metrics = false, - $orderBy = false, - $rankingQuery = null, - $addSelect = 'MAX(log_visit.location_latitude) as location_latitude, - MAX(log_visit.location_longitude) as location_longitude' - ); - + $additionalSelects = array('MAX(log_visit.location_latitude) as location_latitude', + 'MAX(log_visit.location_longitude) as location_longitude'); + $query = $this->getProcessor()->queryVisitsByDimension($this->dimensions, $where = false, $additionalSelects); if ($query === false) { return; } @@ -55,7 +60,11 @@ class Piwik_UserCountry_Archiver extends Piwik_PluginsArchiver while ($row = $query->fetch()) { $this->makeRegionCityLabelsUnique($row); $this->rememberCityLatLong($row); - $this->aggregateVisit($row); + + /* @var $dataArray Piwik_DataArray */ + foreach ($this->arrays as $dimension => $dataArray) { + $dataArray->sumMetricsVisits($row[$dimension], $row); + } } } @@ -66,61 +75,33 @@ class Piwik_UserCountry_Archiver extends Piwik_PluginsArchiver */ private function makeRegionCityLabelsUnique(&$row) { - static $locationColumns = array('location_region', 'location_country', 'location_city'); - - // to be on the safe side, remove the location separator from the region/city/country we - // get from the query - foreach ($locationColumns as $column) { + // remove the location separator from the region/city/country we get from the query + foreach ($this->dimensions as $column) { $row[$column] = str_replace(self::LOCATION_SEPARATOR, '', $row[$column]); } - if (!empty($row['location_region'])) // do not differentiate between unknown regions - { - $row['location_region'] = $row['location_region'] . self::LOCATION_SEPARATOR . $row['location_country']; + if (!empty($row[self::REGION_FIELD])) { + $row[self::REGION_FIELD] = $row[self::REGION_FIELD] . self::LOCATION_SEPARATOR . $row[self::COUNTRY_FIELD]; } - if (!empty($row['location_city'])) // do not differentiate between unknown cities - { - $row['location_city'] = $row['location_city'] . self::LOCATION_SEPARATOR . $row['location_region']; + if (!empty($row[self::CITY_FIELD])) { + $row[self::CITY_FIELD] = $row[self::CITY_FIELD] . self::LOCATION_SEPARATOR . $row[self::REGION_FIELD]; } } protected function rememberCityLatLong($row) { - $lat = $long = false; - if (!empty($row['location_city'])) { - if (!empty($row['location_latitude'])) { - $lat = $row['location_latitude']; - } - if (!empty($row['location_longitude'])) { - $long = $row['location_longitude']; - } - } - - // store latitude/longitude, if we should - if ($lat !== false && $long !== false - && empty($this->latLongForCities[$row['location_city']]) - ) { - $this->latLongForCities[$row['location_city']] = array($lat, $long); - } - } - - protected function aggregateVisit($row) - { - foreach ($this->metricsByDimension as $dimension => &$table) { - $label = (string)$row[$dimension]; - - if (!isset($table[$label])) { - $table[$label] = $this->getProcessor()->makeEmptyRow(); - } - $this->getProcessor()->sumMetrics($row, $table[$label]); + if ( !empty($row[self::CITY_FIELD]) + && !empty($row[self::LATITUDE_FIELD]) + && !empty($row[self::LONGITUDE_FIELD]) + && empty($this->latLongForCities[$row[self::CITY_FIELD]])) { + $this->latLongForCities[$row[self::CITY_FIELD]] = array($row[self::LATITUDE_FIELD], $row[self::LONGITUDE_FIELD]); } } protected function aggregateFromConversions() { - $dimensions = array_keys($this->metricsByDimension); - $query = $this->getProcessor()->queryConversionsByDimension($dimensions); + $query = $this->getProcessor()->queryConversionsByDimension($this->dimensions); if ($query === false) { return; @@ -129,36 +110,32 @@ class Piwik_UserCountry_Archiver extends Piwik_PluginsArchiver while ($row = $query->fetch()) { $this->makeRegionCityLabelsUnique($row); - $idGoal = $row['idgoal']; - foreach ($this->metricsByDimension as $dimension => &$table) { - $label = (string)$row[$dimension]; - - if (!isset($table[$label][Piwik_Archive::INDEX_GOALS][$idGoal])) { - $table[$label][Piwik_Archive::INDEX_GOALS][$idGoal] = $this->getProcessor()->makeEmptyGoalRow($idGoal); - } - $this->getProcessor()->sumGoalMetrics($row, $table[$label][Piwik_Archive::INDEX_GOALS][$idGoal]); + /* @var $dataArray Piwik_DataArray */ + foreach ($this->arrays as $dimension => $dataArray) { + $dataArray->sumMetricsGoals($row[$dimension], $row); } } - foreach ($this->metricsByDimension as &$table) { - $this->getProcessor()->enrichMetricsWithConversions($table); + /* @var $dataArray Piwik_DataArray */ + foreach ($this->arrays as $dataArray) { + $dataArray->enrichMetricsWithConversions(); } } protected function recordDayReports() { - $tableCountry = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->metricsByDimension['location_country']); - $this->getProcessor()->insertBlobRecord(self::VISITS_BY_COUNTRY_RECORD_NAME, $tableCountry->getSerialized()); + $tableCountry = Piwik_ArchiveProcessing_Day::getDataTableFromDataArray($this->arrays[self::COUNTRY_FIELD]); + $this->getProcessor()->insertBlobRecord(self::COUNTRY_RECORD_NAME, $tableCountry->getSerialized()); $this->getProcessor()->insertNumericRecord(self::DISTINCT_COUNTRIES_METRIC, $tableCountry->getRowsCount()); - $tableRegion = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->metricsByDimension['location_region']); + $tableRegion = Piwik_ArchiveProcessing_Day::getDataTableFromDataArray($this->arrays[self::REGION_FIELD]); $serialized = $tableRegion->getSerialized($this->maximumRows, $this->maximumRows, Piwik_Archive::INDEX_NB_VISITS); - $this->getProcessor()->insertBlobRecord(self::VISITS_BY_REGION_RECORD_NAME, $serialized); + $this->getProcessor()->insertBlobRecord(self::REGION_RECORD_NAME, $serialized); - $tableCity = Piwik_ArchiveProcessing_Day::getDataTableFromArray($this->metricsByDimension['location_city']); + $tableCity = Piwik_ArchiveProcessing_Day::getDataTableFromDataArray($this->arrays[self::CITY_FIELD]); $this->setLatitudeLongitude($tableCity); $serialized = $tableCity->getSerialized($this->maximumRows, $this->maximumRows, Piwik_Archive::INDEX_NB_VISITS); - $this->getProcessor()->insertBlobRecord(self::VISITS_BY_CITY_RECORD_NAME, $serialized); + $this->getProcessor()->insertBlobRecord(self::CITY_RECORD_NAME, $serialized); } /** @@ -185,14 +162,14 @@ class Piwik_UserCountry_Archiver extends Piwik_PluginsArchiver public function archivePeriod() { $dataTableToSum = array( - self::VISITS_BY_COUNTRY_RECORD_NAME, - self::VISITS_BY_REGION_RECORD_NAME, - self::VISITS_BY_CITY_RECORD_NAME, + self::COUNTRY_RECORD_NAME, + self::REGION_RECORD_NAME, + self::CITY_RECORD_NAME, ); $nameToCount = $this->getProcessor()->archiveDataTable($dataTableToSum); $this->getProcessor()->insertNumericRecord(self::DISTINCT_COUNTRIES_METRIC, - $nameToCount[self::VISITS_BY_COUNTRY_RECORD_NAME]['level0']); + $nameToCount[self::COUNTRY_RECORD_NAME]['level0']); } } \ No newline at end of file diff --git a/plugins/UserSettings/API.php b/plugins/UserSettings/API.php index 4369d397b9..03ea9ac61d 100644 --- a/plugins/UserSettings/API.php +++ b/plugins/UserSettings/API.php @@ -189,7 +189,6 @@ class Piwik_UserSettings_API // walk through the results and calculate the percentage foreach ($tableArray as $key => $table) { - // get according browserType table foreach ($browserTypesArray AS $k => $browsers) { if ($k == $key) { diff --git a/plugins/UserSettings/Archiver.php b/plugins/UserSettings/Archiver.php index 7b43657eeb..a27db178ca 100644 --- a/plugins/UserSettings/Archiver.php +++ b/plugins/UserSettings/Archiver.php @@ -22,12 +22,11 @@ class Piwik_UserSettings_Archiver extends Piwik_PluginsArchiver const OS_RECORD_NAME = 'UserSettings_os'; const CONFIGURATION_RECORD_NAME = 'UserSettings_configuration'; - public function __construct($processor) - { - parent::__construct($processor); - $this->maximumRowsInDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_standard']; - $this->columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; - } + const LANGUAGE_DIMENSION = "log_visit.location_browser_lang"; + const RESOLUTION_DIMENSION = "log_visit.config_resolution"; + const BROWSER_VERSION_DIMENSION = "CONCAT(log_visit.config_browser_name, ';', log_visit.config_browser_version)"; + const OS_DIMENSION = "log_visit.config_os"; + const CONFIGURATION_DIMENSION = "CONCAT(log_visit.config_os, ';', log_visit.config_browser_name, ';', log_visit.config_resolution)"; public function archiveDay() { @@ -41,17 +40,16 @@ class Piwik_UserSettings_Archiver extends Piwik_PluginsArchiver protected function aggregateByConfiguration() { - $labelSQL = "CONCAT(log_visit.config_os, ';', log_visit.config_browser_name, ';', log_visit.config_resolution)"; - $metrics = $this->getProcessor()->getMetricsForLabel($labelSQL); - $table = $this->getProcessor()->getDataTableFromArray($metrics); - $this->getProcessor()->insertBlobRecord(self::CONFIGURATION_RECORD_NAME, $table->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + $metrics = $this->getProcessor()->getMetricsForDimension(self::CONFIGURATION_DIMENSION); + $table = $this->getProcessor()->getDataTableFromDataArray($metrics); + $this->insertTable(self::CONFIGURATION_RECORD_NAME, $table); } protected function aggregateByOs() { - $metrics = $this->getProcessor()->getMetricsForLabel("log_visit.config_os"); - $table = $this->getProcessor()->getDataTableFromArray($metrics); - $this->getProcessor()->insertBlobRecord(self::OS_RECORD_NAME, $table->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + $metrics = $this->getProcessor()->getMetricsForDimension(self::OS_DIMENSION); + $table = $this->getProcessor()->getDataTableFromDataArray($metrics); + $this->insertTable(self::OS_RECORD_NAME, $table); } protected function aggregateByBrowser() @@ -62,18 +60,16 @@ class Piwik_UserSettings_Archiver extends Piwik_PluginsArchiver protected function aggregateByBrowserVersion() { - $labelSQL = "CONCAT(log_visit.config_browser_name, ';', log_visit.config_browser_version)"; - $metrics = $this->getProcessor()->getMetricsForLabel($labelSQL); - $tableBrowser = $this->getProcessor()->getDataTableFromArray($metrics); - - $this->getProcessor()->insertBlobRecord(self::BROWSER_RECORD_NAME, $tableBrowser->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + $metrics = $this->getProcessor()->getMetricsForDimension(self::BROWSER_VERSION_DIMENSION); + $tableBrowser = $this->getProcessor()->getDataTableFromDataArray($metrics); + $this->insertTable(self::BROWSER_RECORD_NAME, $tableBrowser); return $tableBrowser; } protected function aggregateByBrowserType(Piwik_DataTable $tableBrowser) { $tableBrowser->filter('GroupBy', array('label', 'Piwik_getBrowserFamily')); - $this->getProcessor()->insertBlobRecord(self::BROWSER_TYPE_RECORD_NAME, $tableBrowser->getSerialized()); + $this->insertTable(self::BROWSER_TYPE_RECORD_NAME, $tableBrowser); } protected function aggregateByResolutionAndScreenType() @@ -84,53 +80,58 @@ class Piwik_UserSettings_Archiver extends Piwik_PluginsArchiver protected function aggregateByResolution() { - $metrics = $this->getProcessor()->getMetricsForLabel("log_visit.config_resolution"); - $table = $this->getProcessor()->getDataTableFromArray($metrics); + $metrics = $this->getProcessor()->getMetricsForDimension(self::RESOLUTION_DIMENSION); + $table = $this->getProcessor()->getDataTableFromDataArray($metrics); $table->filter('ColumnCallbackDeleteRow', array('label', 'Piwik_UserSettings_keepStrlenGreater')); - $this->getProcessor()->insertBlobRecord(self::RESOLUTION_RECORD_NAME, $table->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + $this->insertTable(self::RESOLUTION_RECORD_NAME, $table); return $table; } protected function aggregateByScreenType(Piwik_DataTable $resolutions) { $resolutions->filter('GroupBy', array('label', 'Piwik_getScreenTypeFromResolution')); - $this->getProcessor()->insertBlobRecord(self::SCREEN_TYPE_RECORD_NAME, $resolutions->getSerialized()); + $this->insertTable(self::SCREEN_TYPE_RECORD_NAME, $resolutions); } protected function aggregateByPlugin() { - $toSelect = "sum(case log_visit.config_pdf when 1 then 1 else 0 end) as pdf, - sum(case log_visit.config_flash when 1 then 1 else 0 end) as flash, - sum(case log_visit.config_java when 1 then 1 else 0 end) as java, - sum(case log_visit.config_director when 1 then 1 else 0 end) as director, - sum(case log_visit.config_quicktime when 1 then 1 else 0 end) as quicktime, - sum(case log_visit.config_realplayer when 1 then 1 else 0 end) as realplayer, - sum(case log_visit.config_windowsmedia when 1 then 1 else 0 end) as windowsmedia, - sum(case log_visit.config_gears when 1 then 1 else 0 end) as gears, - sum(case log_visit.config_silverlight when 1 then 1 else 0 end) as silverlight, - sum(case log_visit.config_cookie when 1 then 1 else 0 end) as cookie "; - - $data = $this->getProcessor()->queryVisitsSimple($toSelect); - $table = $this->getProcessor()->getSimpleDataTableFromRow($data, Piwik_Archive::INDEX_NB_VISITS); - $this->getProcessor()->insertBlobRecord(self::PLUGIN_RECORD_NAME, $table->getSerialized()); + $selects = array( + "sum(case log_visit.config_pdf when 1 then 1 else 0 end) as pdf", + "sum(case log_visit.config_flash when 1 then 1 else 0 end) as flash", + "sum(case log_visit.config_java when 1 then 1 else 0 end) as java", + "sum(case log_visit.config_director when 1 then 1 else 0 end) as director", + "sum(case log_visit.config_quicktime when 1 then 1 else 0 end) as quicktime", + "sum(case log_visit.config_realplayer when 1 then 1 else 0 end) as realplayer", + "sum(case log_visit.config_windowsmedia when 1 then 1 else 0 end) as windowsmedia", + "sum(case log_visit.config_gears when 1 then 1 else 0 end) as gears", + "sum(case log_visit.config_silverlight when 1 then 1 else 0 end) as silverlight", + "sum(case log_visit.config_cookie when 1 then 1 else 0 end) as cookie" + ); + + $query = $this->getProcessor()->queryVisitsByDimension(array(), false, $selects, $metrics = array()); + $data = $query->fetch(); + $cleanRow = Piwik_DataAccess_LogAggregator::makeArrayOneColumn($data, Piwik_Archive::INDEX_NB_VISITS); + $table = Piwik_DataTable::makeFromIndexedArray($cleanRow); + $this->insertTable(self::PLUGIN_RECORD_NAME, $table); } protected function aggregateByLanguage() { - $query = $this->getProcessor()->queryVisitsByDimension("log_visit.location_browser_lang"); + $query = $this->getProcessor()->queryVisitsByDimension( array("label" => self::LANGUAGE_DIMENSION) ); $languageCodes = array_keys(Piwik_Common::getLanguagesList()); - $metricsByLanguage = array(); + $metricsByLanguage = new Piwik_DataArray(); while ($row = $query->fetch()) { $code = Piwik_Common::extractLanguageCodeFromBrowserLanguage($row['label'], $languageCodes); - - if (!isset($metricsByLanguage[$code])) { - $metricsByLanguage[$code] = $this->getProcessor()->makeEmptyRow(); - } - $this->getProcessor()->sumMetrics($row, $metricsByLanguage[$code]); + $metricsByLanguage->sumMetricsVisits($code, $row); } - $tableLanguage = $this->getProcessor()->getDataTableFromArray($metricsByLanguage); - $this->getProcessor()->insertBlobRecord(self::LANGUAGE_RECORD_NAME, $tableLanguage->getSerialized($this->maximumRowsInDataTable, null, $this->columnToSortByBeforeTruncation)); + $tableLanguage = $this->getProcessor()->getDataTableFromDataArray($metricsByLanguage); + $this->insertTable(self::LANGUAGE_RECORD_NAME, $tableLanguage); + } + + protected function insertTable($recordName, Piwik_DataTable $table) + { + return $this->getProcessor()->insertBlobRecord($recordName, $table->getSerialized($this->maximumRows, null, Piwik_Archive::INDEX_NB_VISITS)); } public function archivePeriod() @@ -145,7 +146,7 @@ class Piwik_UserSettings_Archiver extends Piwik_PluginsArchiver self::PLUGIN_RECORD_NAME, self::LANGUAGE_RECORD_NAME, ); - $this->getProcessor()->archiveDataTable($dataTableToSum, null, $this->maximumRowsInDataTable); + $this->getProcessor()->archiveDataTable($dataTableToSum, null, $this->maximumRows); } } diff --git a/plugins/VisitTime/Archiver.php b/plugins/VisitTime/Archiver.php index cd19d99c00..af811e0d2f 100644 --- a/plugins/VisitTime/Archiver.php +++ b/plugins/VisitTime/Archiver.php @@ -22,53 +22,49 @@ class Piwik_VisitTime_Archiver extends Piwik_PluginsArchiver protected function aggregateByServerTime() { - $metricsByServerTime = $this->getProcessor()->getMetricsForLabel("HOUR(log_visit.visit_last_action_time)"); - $query = $this->getProcessor()->queryConversionsByDimension("HOUR(log_conversion.server_time)"); - - if ($query === false) return; + $array = $this->getProcessor()->getMetricsForDimension( array("label" => "HOUR(log_visit.visit_last_action_time)" )) ; + $query = $this->getProcessor()->queryConversionsByDimension( array("label" => "HOUR(log_conversion.server_time)") ); + if ($query === false) { + return; + } while ($row = $query->fetch()) { - if (!isset($metricsByServerTime[$row['label']][Piwik_Archive::INDEX_GOALS][$row['idgoal']])) { - $metricsByServerTime[$row['label']][Piwik_Archive::INDEX_GOALS][$row['idgoal']] = $this->getProcessor()->makeEmptyGoalRow($row['idgoal']); - } - $this->getProcessor()->sumGoalMetrics($row, $metricsByServerTime[$row['label']][Piwik_Archive::INDEX_GOALS][$row['idgoal']]); + $array->sumMetricsGoals($row['label'], $row); } - $this->getProcessor()->enrichMetricsWithConversions($metricsByServerTime); - - $metricsByServerTime = $this->convertServerTimeToLocalTimezone($metricsByServerTime); - $tableServerTime = $this->getProcessor()->getDataTableFromArray($metricsByServerTime); - $this->makeSureAllHoursAreSet($tableServerTime); - $this->getProcessor()->insertBlobRecord(self::SERVER_TIME_RECORD_NAME, $tableServerTime->getSerialized()); + $array->enrichMetricsWithConversions(); + $array = $this->convertTimeToLocalTimezone($array); + $this->ensureAllHoursAreSet($array); + $this->getProcessor()->insertBlobRecord(self::SERVER_TIME_RECORD_NAME, $this->getProcessor()->getDataTableFromDataArray($array)->getSerialized()); } protected function aggregateByLocalTime() { - $metricsByLocalTime = $this->getProcessor()->getMetricsForLabel("HOUR(log_visit.visitor_localtime)"); - $tableLocalTime = $this->getProcessor()->getDataTableFromArray($metricsByLocalTime); - $this->makeSureAllHoursAreSet($tableLocalTime); - $this->getProcessor()->insertBlobRecord(self::LOCAL_TIME_RECORD_NAME, $tableLocalTime->getSerialized()); + $array = $this->getProcessor()->getMetricsForDimension("HOUR(log_visit.visitor_localtime)"); + $this->ensureAllHoursAreSet($array); + $this->getProcessor()->insertBlobRecord(self::LOCAL_TIME_RECORD_NAME, $this->getProcessor()->getDataTableFromDataArray($array)->getSerialized()); } - protected function convertServerTimeToLocalTimezone($metricsByServerTime) + protected function convertTimeToLocalTimezone(Piwik_DataArray &$array) { $date = Piwik_Date::factory($this->getProcessor()->getStartDatetimeUTC())->toString(); $timezone = $this->getProcessor()->getSite()->getTimezone(); - $visitsByHourTz = array(); - foreach ($metricsByServerTime as $hour => $stats) { + + $converted = array(); + foreach ($array->getDataArray() as $hour => $stats) { $datetime = $date . ' ' . $hour . ':00:00'; $hourInTz = (int)Piwik_Date::factory($datetime, $timezone)->toString('H'); - $visitsByHourTz[$hourInTz] = $stats; + $converted[$hourInTz] = $stats; } - return $visitsByHourTz; + return new Piwik_DataArray($converted); } - private function makeSureAllHoursAreSet($table) + private function ensureAllHoursAreSet( Piwik_DataArray &$array) { + $data = $array->getDataArray(); for ($i = 0; $i <= 23; $i++) { - if ($table->getRowFromLabel($i) === false) { - $row = $this->getProcessor()->makeEmptyRowLabeled($i); - $table->addRow($row); + if (empty($data[$i])) { + $array->sumMetricsVisits( $i, Piwik_DataArray::makeEmptyRow()); } } } diff --git a/plugins/VisitorInterest/Archiver.php b/plugins/VisitorInterest/Archiver.php index f90ea3d2a0..5f0a15d3d0 100644 --- a/plugins/VisitorInterest/Archiver.php +++ b/plugins/VisitorInterest/Archiver.php @@ -90,49 +90,29 @@ class Piwik_VisitorInterest_Archiver extends Piwik_PluginsArchiver self::VISITS_COUNT_RECORD_NAME => 'vbvn', self::DAYS_SINCE_LAST_RECORD_NAME => 'dslv', ); - $row = $this->aggregateFromVisits($prefixes); + $aggregatesMetadata = array( + array('visit_total_time', self::getSecondsGap(), 'log_visit', $prefixes[self::TIME_SPENT_RECORD_NAME]), + array('visit_total_actions', self::$pageGap, 'log_visit', $prefixes[self::PAGES_VIEWED_RECORD_NAME]), + array('visitor_count_visits', self::$visitNumberGap, 'log_visit', $prefixes[self::VISITS_COUNT_RECORD_NAME]), + array('visitor_days_since_last', self::$daysSinceLastVisitGap, 'log_visit', $prefixes[self::DAYS_SINCE_LAST_RECORD_NAME], + $i_am_your_nightmare_DELETE_ME = true + ), + ); + $selects = array(); + foreach($aggregatesMetadata as $aggregateMetadata) { + $selectsFromRangedColumn = Piwik_DataAccess_LogAggregator::getSelectsFromRangedColumn($aggregateMetadata); + $selects = array_merge( $selects, $selectsFromRangedColumn); + } + $query = $this->getProcessor()->queryVisitsByDimension(array(), $where = false, $selects, array()); + $row = $query->fetch(); foreach($prefixes as $recordName => $selectAsPrefix) { - $processor = $this->getProcessor(); - $dataTable = $processor->getSimpleDataTableFromRow($row, Piwik_Archive::INDEX_NB_VISITS, $selectAsPrefix); - $processor->insertBlobRecord($recordName, $dataTable->getSerialized()); + $cleanRow = Piwik_DataAccess_LogAggregator::makeArrayOneColumn($row, Piwik_Archive::INDEX_NB_VISITS, $selectAsPrefix); + $dataTable = Piwik_DataTable::makeFromIndexedArray($cleanRow); + $this->getProcessor()->insertBlobRecord($recordName, $dataTable->getSerialized()); } } - protected function aggregateFromVisits($prefixes) - { - // extra condition for the SQL SELECT that makes sure only returning visits are counted - // when creating the 'days since last visit' report. the SELECT expression below it - // is used to count all new visits. - $daysSinceLastExtraCondition = 'and log_visit.visitor_returning = 1'; - $selectAs = $prefixes[self::DAYS_SINCE_LAST_RECORD_NAME] . 'General_NewVisits'; - $newVisitCountSelect = "sum(case when log_visit.visitor_returning = 0 then 1 else 0 end) as `$selectAs`"; - - $daysSinceLastVisitSelects = Piwik_DataAccess_LogAggregator::buildReduceByRangeSelect( - 'visitor_days_since_last', self::$daysSinceLastVisitGap, 'log_visit', $prefixes[self::DAYS_SINCE_LAST_RECORD_NAME], - $daysSinceLastExtraCondition); - - // create the select expressions to use - $timeGapSelects = Piwik_DataAccess_LogAggregator::buildReduceByRangeSelect( - 'visit_total_time', self::getSecondsGap(), 'log_visit', $prefixes[self::TIME_SPENT_RECORD_NAME]); - - $pageGapSelects = Piwik_DataAccess_LogAggregator::buildReduceByRangeSelect( - 'visit_total_actions', self::$pageGap, 'log_visit', $prefixes[self::PAGES_VIEWED_RECORD_NAME]); - - $visitsByVisitNumSelects = Piwik_DataAccess_LogAggregator::buildReduceByRangeSelect( - 'visitor_count_visits', self::$visitNumberGap, 'log_visit', $prefixes[self::VISITS_COUNT_RECORD_NAME]); - - - array_unshift($daysSinceLastVisitSelects, $newVisitCountSelect); - - $selects = array_merge( - $timeGapSelects, $pageGapSelects, $visitsByVisitNumSelects, $daysSinceLastVisitSelects); - - // select data for every report - $row = $this->getProcessor()->queryVisitsSimple(implode(',', $selects)); - return $row; - } - /** * Transforms and returns the set of ranges used to calculate the 'visits by total time' * report from ranges in minutes to equivalent ranges in seconds. -- cgit v1.2.3 From d8f110aca03ff8c73811a141631f12a7a1ddc16f Mon Sep 17 00:00:00 2001 From: mattab Date: Wed, 12 Jun 2013 16:23:51 +1200 Subject: More refactoring, moving SQL to classes and cleaning up logic so I can understand it (nearly there) --- plugins/Actions/Actions.php | 2 +- plugins/Actions/Archiver.php | 31 +++++++++++------------- plugins/CoreAdminHome/Controller.php | 8 +++---- plugins/CoreAdminHome/CoreAdminHome.php | 2 +- plugins/CoreUpdater/Controller.php | 2 +- plugins/CustomVariables/Archiver.php | 6 ++--- plugins/DevicesDetection/Archiver.php | 4 ++-- plugins/Goals/Archiver.php | 13 +++++----- plugins/Goals/Goals.php | 2 +- plugins/Live/API.php | 12 +++++----- plugins/MultiSites/API.php | 12 ++++++---- plugins/MultiSites/Controller.php | 42 ++++++++++++++++++++------------- plugins/Provider/Archiver.php | 2 +- plugins/Referers/Archiver.php | 4 ++-- plugins/SegmentEditor/SegmentEditor.php | 4 +--- plugins/Transitions/API.php | 8 +++---- plugins/Transitions/Transitions.php | 10 ++++---- plugins/UserCountry/Archiver.php | 8 +++---- plugins/UserSettings/Archiver.php | 2 +- plugins/VisitTime/API.php | 5 ++-- plugins/VisitTime/Archiver.php | 4 ++-- plugins/VisitorGenerator/Controller.php | 2 +- plugins/VisitorInterest/Archiver.php | 2 +- plugins/VisitsSummary/VisitsSummary.php | 2 +- 24 files changed, 100 insertions(+), 89 deletions(-) (limited to 'plugins') diff --git a/plugins/Actions/Actions.php b/plugins/Actions/Actions.php index d54a11c65d..7d401b3c59 100644 --- a/plugins/Actions/Actions.php +++ b/plugins/Actions/Actions.php @@ -573,7 +573,7 @@ class Piwik_Actions extends Piwik_Plugin */ public function archiveDay($notification) { - /* @var $archiveProcessing Piwik_ArchiveProcessing_Day */ + /* @var $archiveProcessing Piwik_ArchiveProcessor_Day */ $archiveProcessing = $notification->getNotificationObject(); $archiving = new Piwik_Actions_Archiver($archiveProcessing); diff --git a/plugins/Actions/Archiver.php b/plugins/Actions/Archiver.php index 1a8e902f16..d7e8e93b23 100644 --- a/plugins/Actions/Archiver.php +++ b/plugins/Actions/Archiver.php @@ -66,7 +66,7 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver /** * Archives Actions reports for a Day * - * @param Piwik_ArchiveProcessing $this->getProcessor() + * @param Piwik_ArchiveProcessor $this->getProcessor() * @return bool */ public function archiveDay() @@ -252,20 +252,15 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver // to the outer select. therefore, $segment needs to know about it. $select = sprintf($select, $sprintfField); - $bind = array(); + $bind = array($this->getProcessor()->getDateStart()->getDateStartUTC(), + $this->getProcessor()->getDateEnd()->getDateEndUTC(), + $this->getProcessor()->getSite()->getId() + ); // get query with segmentation $query = $this->getProcessor()->getSegment()->getSelectQuery( $select, $from, $where, $bind, $orderBy, $groupBy); - // extend bindings - $bind = array_merge(array($this->getProcessor()->getStartDatetimeUTC(), - $this->getProcessor()->getEndDatetimeUTC(), - $this->getProcessor()->getSite()->getId() - ), - $query['bind'] - ); - // replace the rest of the %s $querySql = str_replace("%s", $sprintfField, $query['sql']); @@ -562,25 +557,27 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver self::PAGE_TITLES_RECORD_NAME, self::PAGE_URLS_RECORD_NAME, ); - $this->getProcessor()->archiveDataTable($dataTableToSum, - self::$invalidSummedColumnNameToRenamedNameFromPeriodArchive, + $this->getProcessor()->aggregateDataTableReports($dataTableToSum, Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation, - self::$actionColumnAggregationOperations); + self::$actionColumnAggregationOperations, + self::$invalidSummedColumnNameToRenamedNameFromPeriodArchive + ); $dataTableToSum = array( self::DOWNLOADS_RECORD_NAME, self::OUTLINKS_RECORD_NAME, self::SITE_SEARCH_RECORD_NAME, ); - $nameToCount = $this->getProcessor()->archiveDataTable($dataTableToSum, - self::$invalidSummedColumnNameToRenamedNameFromPeriodArchive, + $nameToCount = $this->getProcessor()->aggregateDataTableReports($dataTableToSum, Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, - Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation); + Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation, + $aggregation = null, + self::$invalidSummedColumnNameToRenamedNameFromPeriodArchive); - $this->getProcessor()->archiveNumericValuesSum(array( + $this->getProcessor()->archiveNumericValuesGeneral(array( self::METRIC_PAGEVIEWS_RECORD_NAME, self::METRIC_UNIQ_PAGEVIEWS_RECORD_NAME, self::METRIC_DOWNLOADS_RECORD_NAME, diff --git a/plugins/CoreAdminHome/Controller.php b/plugins/CoreAdminHome/Controller.php index c915205bc2..e002157276 100644 --- a/plugins/CoreAdminHome/Controller.php +++ b/plugins/CoreAdminHome/Controller.php @@ -29,8 +29,8 @@ class Piwik_CoreAdminHome_Controller extends Piwik_Controller_Admin $view = Piwik_View::factory('generalSettings'); if (Piwik::isUserIsSuperUser()) { - $enableBrowserTriggerArchiving = Piwik_ArchiveProcessing::isBrowserTriggerArchivingEnabled(); - $todayArchiveTimeToLive = Piwik_ArchiveProcessing::getTodayArchiveTimeToLive(); + $enableBrowserTriggerArchiving = Piwik_ArchiveProcessor_Rules::isBrowserTriggerEnabled(); + $todayArchiveTimeToLive = Piwik_ArchiveProcessor_Rules::getTodayArchiveTimeToLive(); $showWarningCron = false; if (!$enableBrowserTriggerArchiving && $todayArchiveTimeToLive < 3600 @@ -81,8 +81,8 @@ class Piwik_CoreAdminHome_Controller extends Piwik_Controller_Admin $enableBrowserTriggerArchiving = Piwik_Common::getRequestVar('enableBrowserTriggerArchiving'); $todayArchiveTimeToLive = Piwik_Common::getRequestVar('todayArchiveTimeToLive'); - Piwik_ArchiveProcessing::setBrowserTriggerArchiving((bool)$enableBrowserTriggerArchiving); - Piwik_ArchiveProcessing::setTodayArchiveTimeToLive($todayArchiveTimeToLive); + Piwik_ArchiveProcessor_Rules::setBrowserTriggerArchiving((bool)$enableBrowserTriggerArchiving); + Piwik_ArchiveProcessor_Rules::setTodayArchiveTimeToLive($todayArchiveTimeToLive); // Update email settings $mail = array(); diff --git a/plugins/CoreAdminHome/CoreAdminHome.php b/plugins/CoreAdminHome/CoreAdminHome.php index c77f509e9f..4f75d274c0 100644 --- a/plugins/CoreAdminHome/CoreAdminHome.php +++ b/plugins/CoreAdminHome/CoreAdminHome.php @@ -114,7 +114,7 @@ class Piwik_CoreAdminHome extends Piwik_Plugin $archiveTables = Piwik::getTablesArchivesInstalled(); foreach ($archiveTables as $table) { if (strpos($table, 'numeric') !== false) { - Piwik_ArchiveProcessing_Period::doPurgeOutdatedArchives($table); + Piwik_ArchiveProcessor_Rules::doPurgeOutdatedArchives($table); } } } diff --git a/plugins/CoreUpdater/Controller.php b/plugins/CoreUpdater/Controller.php index 8e20f9c82a..76ab9bf71d 100644 --- a/plugins/CoreUpdater/Controller.php +++ b/plugins/CoreUpdater/Controller.php @@ -163,7 +163,7 @@ class Piwik_CoreUpdater_Controller extends Piwik_Controller /* * Make sure the execute bit is set for this shell script */ - if (!Piwik_ArchiveProcessing::isBrowserTriggerArchivingEnabled()) { + if (!Piwik_ArchiveProcessor_Rules::isBrowserTriggerEnabled()) { @chmod($this->pathRootExtractedPiwik . '/misc/cron/archive.sh', 0755); } diff --git a/plugins/CustomVariables/Archiver.php b/plugins/CustomVariables/Archiver.php index 15cc2fdf23..e456178ea8 100644 --- a/plugins/CustomVariables/Archiver.php +++ b/plugins/CustomVariables/Archiver.php @@ -74,7 +74,7 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver protected function getSelectAveragePrice() { - return Piwik_ArchiveProcessing_Day::getSqlRevenue("AVG(log_link_visit_action.custom_var_v2)") + return Piwik_ArchiveProcessor_Day::getSqlRevenue("AVG(log_link_visit_action.custom_var_v2)") . " as `" . Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED . "`"; } @@ -191,8 +191,8 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver public function archivePeriod() { - $nameToCount = $this->getProcessor()->archiveDataTable( - self::CUSTOM_VARIABLE_RECORD_NAME, null, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, + $nameToCount = $this->getProcessor()->aggregateDataTableReports( + self::CUSTOM_VARIABLE_RECORD_NAME, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $columnToSort = Piwik_Archive::INDEX_NB_VISITS); } } \ No newline at end of file diff --git a/plugins/DevicesDetection/Archiver.php b/plugins/DevicesDetection/Archiver.php index 8bedcc9d39..4d74e28ca2 100644 --- a/plugins/DevicesDetection/Archiver.php +++ b/plugins/DevicesDetection/Archiver.php @@ -57,8 +57,8 @@ class Piwik_DevicesDetection_Archiver extends Piwik_PluginsArchiver self::BROWSER_VERSION_RECORD_NAME ); foreach ($dataTablesToSum as $dt) { - $this->getProcessor()->archiveDataTable( - $dt, null, $this->maximumRows, $this->maximumRows, $columnToSort = "nb_visits"); + $this->getProcessor()->aggregateDataTableReports( + $dt, $this->maximumRows, $this->maximumRows, $columnToSort = "nb_visits"); } } } \ No newline at end of file diff --git a/plugins/Goals/Archiver.php b/plugins/Goals/Archiver.php index 0a5a154f3b..1946594122 100644 --- a/plugins/Goals/Archiver.php +++ b/plugins/Goals/Archiver.php @@ -146,10 +146,11 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver $this->insertReports(self::DAYS_UNTIL_CONV_RECORD_NAME, $daysToConversions); // Stats for all goals + $nbConvertedVisits = $this->getProcessor()->getNumberOfVisitsConverted(); $metrics = array( - self::getRecordName('conversion_rate') => $this->getConversionRate($this->getProcessor()->getNumberOfVisitsConverted()), + self::getRecordName('conversion_rate') => $this->getConversionRate($nbConvertedVisits), self::getRecordName('nb_conversions') => $totalConversions, - self::getRecordName('nb_visits_converted') => $this->getProcessor()->getNumberOfVisitsConverted(), + self::getRecordName('nb_visits_converted') => $nbConvertedVisits, self::getRecordName('revenue') => $totalRevenue, ); $this->getProcessor()->insertNumericRecords($metrics); @@ -380,7 +381,7 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver foreach ($this->dimensionRecord as $recordName) { $dataTableToSum[] = self::getItemRecordNameAbandonedCart($recordName); } - $this->getProcessor()->archiveDataTable($dataTableToSum); + $this->getProcessor()->aggregateDataTableReports($dataTableToSum); } /* @@ -402,7 +403,7 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver $fieldsToSum[] = self::getRecordName($metricName, $goalId); } } - $records = $this->getProcessor()->archiveNumericValuesSum($fieldsToSum); + $records = $this->getProcessor()->archiveNumericValuesGeneral($fieldsToSum); // also recording conversion_rate for each goal foreach ($goalIdsToSum as $goalId) { @@ -411,13 +412,13 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver $this->getProcessor()->insertNumericRecord(self::getRecordName('conversion_rate', $goalId), $conversion_rate); // sum up the visits to conversion data table & the days to conversion data table - $this->getProcessor()->archiveDataTable(array( + $this->getProcessor()->aggregateDataTableReports(array( self::getRecordName(self::VISITS_UNTIL_RECORD_NAME, $goalId), self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME, $goalId))); } // sum up goal overview reports - $this->getProcessor()->archiveDataTable(array( + $this->getProcessor()->aggregateDataTableReports(array( self::getRecordName(self::VISITS_UNTIL_RECORD_NAME), self::getRecordName(self::DAYS_UNTIL_CONV_RECORD_NAME))); } diff --git a/plugins/Goals/Goals.php b/plugins/Goals/Goals.php index 024cd562f1..ecda104804 100644 --- a/plugins/Goals/Goals.php +++ b/plugins/Goals/Goals.php @@ -509,7 +509,7 @@ class Piwik_Goals extends Piwik_Plugin function archiveDay($notification) { /** - * @var Piwik_ArchiveProcessing_Day + * @var Piwik_ArchiveProcessor_Day */ $archiveProcessing = $notification->getNotificationObject(); diff --git a/plugins/Live/API.php b/plugins/Live/API.php index d2d74a74bf..0f3b70b5e2 100644 --- a/plugins/Live/API.php +++ b/plugins/Live/API.php @@ -537,11 +537,11 @@ class Piwik_Live_API $sql = "SELECT case idgoal when " . Piwik_Tracker_GoalManager::IDGOAL_CART . " then '" . Piwik_Archive::LABEL_ECOMMERCE_CART . "' else '" . Piwik_Archive::LABEL_ECOMMERCE_ORDER . "' end as type, idorder as orderId, - " . Piwik_ArchiveProcessing_Day::getSqlRevenue('revenue') . " as revenue, - " . Piwik_ArchiveProcessing_Day::getSqlRevenue('revenue_subtotal') . " as revenueSubTotal, - " . Piwik_ArchiveProcessing_Day::getSqlRevenue('revenue_tax') . " as revenueTax, - " . Piwik_ArchiveProcessing_Day::getSqlRevenue('revenue_shipping') . " as revenueShipping, - " . Piwik_ArchiveProcessing_Day::getSqlRevenue('revenue_discount') . " as revenueDiscount, + " . Piwik_ArchiveProcessor_Day::getSqlRevenue('revenue') . " as revenue, + " . Piwik_ArchiveProcessor_Day::getSqlRevenue('revenue_subtotal') . " as revenueSubTotal, + " . Piwik_ArchiveProcessor_Day::getSqlRevenue('revenue_tax') . " as revenueTax, + " . Piwik_ArchiveProcessor_Day::getSqlRevenue('revenue_shipping') . " as revenueShipping, + " . Piwik_ArchiveProcessor_Day::getSqlRevenue('revenue_discount') . " as revenueDiscount, items as items, log_conversion.server_time as serverTimePretty @@ -578,7 +578,7 @@ class Piwik_Live_API log_action_sku.name as itemSKU, log_action_name.name as itemName, log_action_category.name as itemCategory, - " . Piwik_ArchiveProcessing_Day::getSqlRevenue('price') . " as price, + " . Piwik_ArchiveProcessor_Day::getSqlRevenue('price') . " as price, quantity as quantity FROM " . Piwik_Common::prefixTable('log_conversion_item') . " INNER JOIN " . Piwik_Common::prefixTable('log_action') . " AS log_action_sku diff --git a/plugins/MultiSites/API.php b/plugins/MultiSites/API.php index 1cbcfc39b3..bf4250ff0e 100755 --- a/plugins/MultiSites/API.php +++ b/plugins/MultiSites/API.php @@ -232,18 +232,22 @@ class Piwik_MultiSites_API // if the period isn't a range & a lastN/previousN date isn't used, we get the same // data for the last period to show the evolution of visits/actions/revenue list($strLastDate, $lastPeriod) = Piwik_Period_Range::getLastDate($date, $period); - if ($strLastDate !== false) { + if ( + false && + + $strLastDate !== false) { if ($lastPeriod !== false) { // NOTE: no easy way to set last period date metadata when range of dates is requested. // will be easier if DataTable_Array::metadata is removed, and metadata that is // put there is put directly in Piwik_DataTable::metadata. $dataTable->setMetadata(self::getLastPeriodMetadataName('date'), $lastPeriod); } - $pastArchive = Piwik_Archive::build('all', $period, $strLastDate, $segment, $_restrictSitesToLogin); $pastData = $pastArchive->getDataTableFromNumeric($fieldsToGet); - $pastData = $pastData->mergeChildren(); + if(!($dataTable instanceof Piwik_DataTable_Simple)) { + $pastData = $pastData->mergeChildren(); + } // use past data to calculate evolution percentages $this->calculateEvolutionPercentages($dataTable, $pastData, $apiMetrics); @@ -315,7 +319,7 @@ class Piwik_MultiSites_API private function calculateEvolutionPercentages($currentData, $pastData, $apiMetrics) { if ($currentData instanceof Piwik_DataTable_Array) { - $pastArray = $pastData->getArray(); + $pastArray = $pastData->getRows(); foreach ($currentData->getArray() as $subTable) { $this->calculateEvolutionPercentages($subTable, current($pastArray), $apiMetrics); next($pastArray); diff --git a/plugins/MultiSites/Controller.php b/plugins/MultiSites/Controller.php index cb63dc5746..a4e5a98eab 100644 --- a/plugins/MultiSites/Controller.php +++ b/plugins/MultiSites/Controller.php @@ -68,50 +68,60 @@ class Piwik_MultiSites_Controller extends Piwik_Controller foreach ($siteIds as $idSite) { $isEcommerceEnabled = Piwik_Site::isEcommerceEnabledFor($idSite); - $digestableData[$idSite] = array( - 'idsite' => $idSite, - 'main_url' => Piwik_Site::getMainUrlFor($idSite), - 'name' => Piwik_Site::getNameFor($idSite), - 'visits' => 0, - 'pageviews' => 0 +// allSites[{$i}] = new setRowData( +// 0 {$site.idsite}, +// 1 {$site.visits}, +// 2 {$site.pageviews}, +// 3 {if empty($site.revenue)}0{else}{$site.revenue}{/if}, +// 4 '{$site.name|escape:"javascript"}', +// 5 '{$site.main_url|escape:"javascript"}', +// 6 '{if isset($site.visits_evolution)}{$site.visits_evolution|replace:",":"."}{/if}', +// 7 '{if isset($site.pageviews_evolution)}{$site.pageviews_evolution|replace:",":"."}{/if}', +// 8 '{if isset($site.revenue_evolution)}{$site.revenue_evolution|replace:",":"."}{/if}'); + + $siteData = array($idSite,0,0.0, + Piwik_Site::getMainUrlFor($idSite), + Piwik_Site::getNameFor($idSite), ); if ($period != 'range') { - $digestableData[$idSite]['visits_evolution'] = 0; - $digestableData[$idSite]['pageviews_evolution'] = 0; + $siteData[6] = 0; + $siteData[7] = 0; } if ($displayRevenueColumn) { $revenueDefault = $isEcommerceEnabled ? 0 : "'-'"; if ($period != 'range') { - $digestableData[$idSite]['revenue_evolution'] = $revenueDefault; + $siteData[8] = $revenueDefault; } } + $digestableData[$idSite] = $siteData; } foreach ($dataTable->getRows() as $row) { $idsite = (int)$row->getMetadata('idsite'); - $site = & $digestableData[$idsite]; + $siteData = array(); - $site['visits'] = (int)$row->getColumn('nb_visits'); - $site['pageviews'] = (int)$row->getColumn('nb_pageviews'); + $siteData[1] = (int)$row->getColumn('nb_visits');http://pastebin.com/raw.php?i=1dvHmEUA + $siteData[2] = (int)$row->getColumn('nb_pageviews'); if ($displayRevenueColumn) { if ($row->getColumn('revenue') !== false) { - $site['revenue'] = $row->getColumn('revenue'); + $siteData[3] = $row->getColumn('revenue'); } } if ($period != 'range') { - $site['visits_evolution'] = $row->getColumn('visits_evolution'); - $site['pageviews_evolution'] = $row->getColumn('pageviews_evolution'); + $siteData[6] = $row->getColumn('visits_evolution'); + $siteData[7] = $row->getColumn('pageviews_evolution'); if ($displayRevenueColumn) { - $site['revenue_evolution'] = $row->getColumn('revenue_evolution'); + $siteData[8] = $row->getColumn('revenue_evolution'); } } + $digestableData[$idsite] = array_merge($digestableData[$idsite], $siteData); } $this->applyPrettyMoney($digestableData); diff --git a/plugins/Provider/Archiver.php b/plugins/Provider/Archiver.php index 692c3a72d2..e90489f51a 100644 --- a/plugins/Provider/Archiver.php +++ b/plugins/Provider/Archiver.php @@ -22,6 +22,6 @@ class Piwik_Provider_Archiver extends Piwik_PluginsArchiver public function archivePeriod() { - $this->getProcessor()->archiveDataTable(array(self::PROVIDER_RECORD_NAME), null, $this->maximumRows); + $this->getProcessor()->aggregateDataTableReports(array(self::PROVIDER_RECORD_NAME), $this->maximumRows); } } \ No newline at end of file diff --git a/plugins/Referers/Archiver.php b/plugins/Referers/Archiver.php index ddae742131..47ce247550 100644 --- a/plugins/Referers/Archiver.php +++ b/plugins/Referers/Archiver.php @@ -189,7 +189,7 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver /** * Records the daily stats (numeric or datatable blob) into the archive tables. * - * @param Piwik_ArchiveProcessing $this->getProcessor() + * @param Piwik_ArchiveProcessor $this->getProcessor() */ protected function recordDayReports() { @@ -223,7 +223,7 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver public function archivePeriod() { $dataTableToSum = $this->getRecordNames(); - $nameToCount = $this->getProcessor()->archiveDataTable($dataTableToSum, null, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $this->columnToSortByBeforeTruncation); + $nameToCount = $this->getProcessor()->aggregateDataTableReports($dataTableToSum, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $this->columnToSortByBeforeTruncation); $mappingFromArchiveName = array( self::METRIC_DISTINCT_SEARCH_ENGINE_RECORD_NAME => diff --git a/plugins/SegmentEditor/SegmentEditor.php b/plugins/SegmentEditor/SegmentEditor.php index 3ac66afb1e..5af09785ae 100644 --- a/plugins/SegmentEditor/SegmentEditor.php +++ b/plugins/SegmentEditor/SegmentEditor.php @@ -45,9 +45,7 @@ class Piwik_SegmentEditor extends Piwik_Plugin public function getKnownSegmentsToArchiveAllSites($notification) { $segments =& $notification->getNotificationObject(); - $segmentsToAutoArchive = Piwik_SegmentEditor_API::getInstance()->getAll( - $idSite = false, $returnAutoArchived = true); - + $segmentsToAutoArchive = Piwik_SegmentEditor_API::getInstance()->getAll($idSite = false, $returnAutoArchived = true); foreach ($segmentsToAutoArchive as $segment) { $segments[] = $segment['definition']; } diff --git a/plugins/Transitions/API.php b/plugins/Transitions/API.php index 897b14923a..7e17fa2996 100644 --- a/plugins/Transitions/API.php +++ b/plugins/Transitions/API.php @@ -62,10 +62,10 @@ class Piwik_Transitions_API } // prepare archive processing that can be used by the archiving code - $archiveProcessing = new Piwik_ArchiveProcessing_Day(); - $archiveProcessing->setSite(new Piwik_Site($idSite)); - $archiveProcessing->setPeriod(Piwik_Period::advancedFactory($period, $date)); - $archiveProcessing->setSegment(new Piwik_Segment($segment, $idSite)); + $segment = new Piwik_Segment($segment, $idSite); + $site = new Piwik_Site($idSite); + $period = Piwik_Period::advancedFactory($period, $date); + $archiveProcessing = Piwik_ArchiveProcessor::factory($period, $site, $segment); // prepare the report $report = array( diff --git a/plugins/Transitions/Transitions.php b/plugins/Transitions/Transitions.php index b92ef87b8c..b887669a70 100644 --- a/plugins/Transitions/Transitions.php +++ b/plugins/Transitions/Transitions.php @@ -64,7 +64,7 @@ class Piwik_Transitions extends Piwik_Plugin * * @param $idaction * @param $actionType - * @param Piwik_ArchiveProcessing_Day $archiveProcessing + * @param Piwik_ArchiveProcessor_Day $archiveProcessing * @param $limitBeforeGrouping * @return Piwik_DataTable */ @@ -130,7 +130,7 @@ class Piwik_Transitions extends Piwik_Plugin //FIXMEA refactor after integration tests written $array = new Piwik_DataArray($referrerData, $referrerSubData); - return Piwik_ArchiveProcessing_Day::getDataTableFromDataArray($array); + return Piwik_ArchiveProcessor_Day::getDataTableFromDataArray($array); } /** @@ -138,7 +138,7 @@ class Piwik_Transitions extends Piwik_Plugin * * @param $idaction * @param $actionType - * @param Piwik_ArchiveProcessing_Day $archiveProcessing + * @param Piwik_ArchiveProcessor_Day $archiveProcessing * @param $limitBeforeGrouping * @return array(previousPages:Piwik_DataTable, loops:integer) */ @@ -257,12 +257,12 @@ class Piwik_Transitions extends Piwik_Plugin * * @param $idaction * @param $actionType - * @param Piwik_ArchiveProcessing_Day $archiveProcessing + * @param Piwik_ArchiveProcessor_Day $archiveProcessing * @param $limitBeforeGrouping * @param $includeLoops * @return array(followingPages:Piwik_DataTable, outlinks:Piwik_DataTable, downloads:Piwik_DataTable) */ - public function queryFollowingActions($idaction, $actionType, Piwik_ArchiveProcessing_Day $archiveProcessing, + public function queryFollowingActions($idaction, $actionType, Piwik_ArchiveProcessor_Day $archiveProcessing, $limitBeforeGrouping = false, $includeLoops = false) { $types = array(); diff --git a/plugins/UserCountry/Archiver.php b/plugins/UserCountry/Archiver.php index fb69e89ff8..33f7d28e90 100644 --- a/plugins/UserCountry/Archiver.php +++ b/plugins/UserCountry/Archiver.php @@ -124,15 +124,15 @@ class Piwik_UserCountry_Archiver extends Piwik_PluginsArchiver protected function recordDayReports() { - $tableCountry = Piwik_ArchiveProcessing_Day::getDataTableFromDataArray($this->arrays[self::COUNTRY_FIELD]); + $tableCountry = Piwik_ArchiveProcessor_Day::getDataTableFromDataArray($this->arrays[self::COUNTRY_FIELD]); $this->getProcessor()->insertBlobRecord(self::COUNTRY_RECORD_NAME, $tableCountry->getSerialized()); $this->getProcessor()->insertNumericRecord(self::DISTINCT_COUNTRIES_METRIC, $tableCountry->getRowsCount()); - $tableRegion = Piwik_ArchiveProcessing_Day::getDataTableFromDataArray($this->arrays[self::REGION_FIELD]); + $tableRegion = Piwik_ArchiveProcessor_Day::getDataTableFromDataArray($this->arrays[self::REGION_FIELD]); $serialized = $tableRegion->getSerialized($this->maximumRows, $this->maximumRows, Piwik_Archive::INDEX_NB_VISITS); $this->getProcessor()->insertBlobRecord(self::REGION_RECORD_NAME, $serialized); - $tableCity = Piwik_ArchiveProcessing_Day::getDataTableFromDataArray($this->arrays[self::CITY_FIELD]); + $tableCity = Piwik_ArchiveProcessor_Day::getDataTableFromDataArray($this->arrays[self::CITY_FIELD]); $this->setLatitudeLongitude($tableCity); $serialized = $tableCity->getSerialized($this->maximumRows, $this->maximumRows, Piwik_Archive::INDEX_NB_VISITS); $this->getProcessor()->insertBlobRecord(self::CITY_RECORD_NAME, $serialized); @@ -167,7 +167,7 @@ class Piwik_UserCountry_Archiver extends Piwik_PluginsArchiver self::CITY_RECORD_NAME, ); - $nameToCount = $this->getProcessor()->archiveDataTable($dataTableToSum); + $nameToCount = $this->getProcessor()->aggregateDataTableReports($dataTableToSum); $this->getProcessor()->insertNumericRecord(self::DISTINCT_COUNTRIES_METRIC, $nameToCount[self::COUNTRY_RECORD_NAME]['level0']); } diff --git a/plugins/UserSettings/Archiver.php b/plugins/UserSettings/Archiver.php index a27db178ca..91df3d2c0c 100644 --- a/plugins/UserSettings/Archiver.php +++ b/plugins/UserSettings/Archiver.php @@ -146,7 +146,7 @@ class Piwik_UserSettings_Archiver extends Piwik_PluginsArchiver self::PLUGIN_RECORD_NAME, self::LANGUAGE_RECORD_NAME, ); - $this->getProcessor()->archiveDataTable($dataTableToSum, null, $this->maximumRows); + $this->getProcessor()->aggregateDataTableReports($dataTableToSum, $this->maximumRows); } } diff --git a/plugins/VisitTime/API.php b/plugins/VisitTime/API.php index 637aa97cbc..65952ba24d 100644 --- a/plugins/VisitTime/API.php +++ b/plugins/VisitTime/API.php @@ -74,14 +74,15 @@ class Piwik_VisitTime_API } // metrics to query - $metrics = Piwik_ArchiveProcessing::getCoreMetrics(); + $metrics = Piwik_Archive::getVisitsMetricNames(); + unset($metrics[Piwik_Archive::INDEX_MAX_ACTIONS]); // get metric data for every day within the supplied period $oPeriod = Piwik_Archive::makePeriodFromQueryParams(Piwik_Site::getTimezoneFor($idSite), $period, $date); $dateRange = $oPeriod->getDateStart()->toString() . ',' . $oPeriod->getDateEnd()->toString(); $archive = Piwik_Archive::build($idSite, 'day', $dateRange, $segment); - $dataTable = $archive->getDataTableFromNumeric($metrics)->mergeChildren(); + $dataTable = $archive->getDataTableFromNumeric($metrics); // if there's no data for this report, don't bother w/ anything else // TODO: with changes to getDataTableFromNumeric, this code would have to check if every row has 0 column values. is it really necessary? (assuming no for now) diff --git a/plugins/VisitTime/Archiver.php b/plugins/VisitTime/Archiver.php index af811e0d2f..2f11c61d2a 100644 --- a/plugins/VisitTime/Archiver.php +++ b/plugins/VisitTime/Archiver.php @@ -46,7 +46,7 @@ class Piwik_VisitTime_Archiver extends Piwik_PluginsArchiver protected function convertTimeToLocalTimezone(Piwik_DataArray &$array) { - $date = Piwik_Date::factory($this->getProcessor()->getStartDatetimeUTC())->toString(); + $date = Piwik_Date::factory($this->getProcessor()->getDateStart()->getDateStartUTC())->toString(); $timezone = $this->getProcessor()->getSite()->getTimezone(); $converted = array(); @@ -75,6 +75,6 @@ class Piwik_VisitTime_Archiver extends Piwik_PluginsArchiver self::LOCAL_TIME_RECORD_NAME, self::SERVER_TIME_RECORD_NAME, ); - $this->getProcessor()->archiveDataTable($dataTableToSum); + $this->getProcessor()->aggregateDataTableReports($dataTableToSum); } } \ No newline at end of file diff --git a/plugins/VisitorGenerator/Controller.php b/plugins/VisitorGenerator/Controller.php index 54ebc3aea0..acebd0a2fc 100644 --- a/plugins/VisitorGenerator/Controller.php +++ b/plugins/VisitorGenerator/Controller.php @@ -76,7 +76,7 @@ class Piwik_VisitorGenerator_Controller extends Piwik_Controller_Admin $api = Piwik_CoreAdminHome_API::getInstance(); $api->invalidateArchivedReports($idSite, implode($dates, ",")); - $browserArchiving = Piwik_ArchiveProcessing::isBrowserTriggerArchivingEnabled(); + $browserArchiving = Piwik_ArchiveProcessor_Rules::isBrowserTriggerEnabled(); // Init view $view = Piwik_View::factory('generate'); diff --git a/plugins/VisitorInterest/Archiver.php b/plugins/VisitorInterest/Archiver.php index 5f0a15d3d0..6cbeb82317 100644 --- a/plugins/VisitorInterest/Archiver.php +++ b/plugins/VisitorInterest/Archiver.php @@ -141,6 +141,6 @@ class Piwik_VisitorInterest_Archiver extends Piwik_PluginsArchiver self::VISITS_COUNT_RECORD_NAME, self::DAYS_SINCE_LAST_RECORD_NAME ); - $this->getProcessor()->archiveDataTable($dataTableToSum); + $this->getProcessor()->aggregateDataTableReports($dataTableToSum); } } \ No newline at end of file diff --git a/plugins/VisitsSummary/VisitsSummary.php b/plugins/VisitsSummary/VisitsSummary.php index 87b320c947..0744b0424a 100644 --- a/plugins/VisitsSummary/VisitsSummary.php +++ b/plugins/VisitsSummary/VisitsSummary.php @@ -12,7 +12,7 @@ /** * Note: This plugin does not hook on Daily and Period Archiving like other Plugins because it reports the * very core metrics (visits, actions, visit duration, etc.) which are processed in the Core - * Piwik_ArchiveProcessing_Day class directly. + * Piwik_ArchiveProcessor_Day class directly. * These metrics can be used by other Plugins so they need to be processed up front. * * @package Piwik_VisitsSummary -- cgit v1.2.3 From 6be9fb2002a0a7da79af55e3263f23c5addfa79c Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 13 Jun 2013 11:52:49 +1200 Subject: Continuing the great cleanup. It looks like archiveProcessor will have to go (and merge with Archive) Moving Transitions logic from plugin class to API Cleaning up some separation of concerns NOTE: I'm breaking the Multisites API here, removing the _evolution. we should re-fix it... --- plugins/API/API.php | 2 +- plugins/Actions/Archiver.php | 12 +- plugins/Goals/Archiver.php | 1 - plugins/ImageGraph/API.php | 2 +- plugins/ImageGraph/ImageGraph.php | 2 +- plugins/MultiSites/API.php | 6 +- plugins/Transitions/API.php | 337 +++++++++++++++++++++++++++++++++++- plugins/Transitions/Transitions.php | 325 ---------------------------------- plugins/VisitTime/API.php | 21 +-- plugins/VisitTime/Controller.php | 2 +- 10 files changed, 355 insertions(+), 355 deletions(-) (limited to 'plugins') diff --git a/plugins/API/API.php b/plugins/API/API.php index 0fcb1a54b9..e2721119f4 100644 --- a/plugins/API/API.php +++ b/plugins/API/API.php @@ -1158,7 +1158,7 @@ class Piwik_API_API $period = 'day'; } - if (!Piwik_Archive::isMultiplePeriod($date, $period)) { + if (!Piwik_Period::isMultiplePeriod($date, $period)) { throw new Exception("Row evolutions can not be processed with this combination of \'date\' and \'period\' parameters."); } diff --git a/plugins/Actions/Archiver.php b/plugins/Actions/Archiver.php index d7e8e93b23..d7e69c4eff 100644 --- a/plugins/Actions/Archiver.php +++ b/plugins/Actions/Archiver.php @@ -252,14 +252,9 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver // to the outer select. therefore, $segment needs to know about it. $select = sprintf($select, $sprintfField); - $bind = array($this->getProcessor()->getDateStart()->getDateStartUTC(), - $this->getProcessor()->getDateEnd()->getDateEndUTC(), - $this->getProcessor()->getSite()->getId() - ); // get query with segmentation - $query = $this->getProcessor()->getSegment()->getSelectQuery( - $select, $from, $where, $bind, $orderBy, $groupBy); + $query = $this->getProcessor()->generateQuery($select, $from, $where, $groupBy, $orderBy); // replace the rest of the %s $querySql = str_replace("%s", $sprintfField, $query['sql']); @@ -270,7 +265,7 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver } // get result - $resultSet = $this->getProcessor()->getDb()->query($querySql, $bind); + $resultSet = $this->getProcessor()->getDb()->query($querySql, $query['bind']); $modified = Piwik_Actions_ArchivingHelper::updateActionsTableWithRowQuery($resultSet, $sprintfField, $this->actionsTablesByType); return $modified; } @@ -570,11 +565,12 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver self::OUTLINKS_RECORD_NAME, self::SITE_SEARCH_RECORD_NAME, ); + $aggregation = null; $nameToCount = $this->getProcessor()->aggregateDataTableReports($dataTableToSum, Piwik_Actions_ArchivingHelper::$maximumRowsInDataTableLevelZero, Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation, - $aggregation = null, + $aggregation, self::$invalidSummedColumnNameToRenamedNameFromPeriodArchive); $this->getProcessor()->archiveNumericValuesGeneral(array( diff --git a/plugins/Goals/Archiver.php b/plugins/Goals/Archiver.php index 1946594122..009953f322 100644 --- a/plugins/Goals/Archiver.php +++ b/plugins/Goals/Archiver.php @@ -266,7 +266,6 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver // Per item doesn't support segment // Also, when querying Goal metrics for visitorType==returning, we wouldnt want to trigger an extra request // event if it did support segment - // (when this is implemented, we should have shouldProcessReportsForPlugin() support partial archiving based on which metric is requested) if (!$this->getProcessor()->getSegment()->isEmpty()) { return false; } diff --git a/plugins/ImageGraph/API.php b/plugins/ImageGraph/API.php index d80572bec0..ddc31e56b3 100644 --- a/plugins/ImageGraph/API.php +++ b/plugins/ImageGraph/API.php @@ -169,7 +169,7 @@ class Piwik_ImageGraph_API $reportHasDimension = !empty($metadata['dimension']); $constantRowsCount = !empty($metadata['constantRowsCount']); - $isMultiplePeriod = Piwik_Archive::isMultiplePeriod($date, $period); + $isMultiplePeriod = Piwik_Period::isMultiplePeriod($date, $period); if (!$reportHasDimension && !$isMultiplePeriod) { throw new Exception('The graph cannot be drawn for this combination of \'date\' and \'period\' parameters.'); } diff --git a/plugins/ImageGraph/ImageGraph.php b/plugins/ImageGraph/ImageGraph.php index 4e48e93d1d..06e973f462 100644 --- a/plugins/ImageGraph/ImageGraph.php +++ b/plugins/ImageGraph/ImageGraph.php @@ -69,7 +69,7 @@ class Piwik_ImageGraph extends Piwik_Plugin } // need two sets of period & date, one for single period graphs, one for multiple periods graphs - if (Piwik_Archive::isMultiplePeriod($info['date'], $info['period'])) { + if (Piwik_Period::isMultiplePeriod($info['date'], $info['period'])) { $periodForMultiplePeriodGraph = $info['period']; $dateForMultiplePeriodGraph = $info['date']; diff --git a/plugins/MultiSites/API.php b/plugins/MultiSites/API.php index bf4250ff0e..e9984b99aa 100755 --- a/plugins/MultiSites/API.php +++ b/plugins/MultiSites/API.php @@ -233,9 +233,9 @@ class Piwik_MultiSites_API // data for the last period to show the evolution of visits/actions/revenue list($strLastDate, $lastPeriod) = Piwik_Period_Range::getLastDate($date, $period); if ( - false && - - $strLastDate !== false) { + // FIXMEA broken without this false + false + && $strLastDate !== false) { if ($lastPeriod !== false) { // NOTE: no easy way to set last period date metadata when range of dates is requested. // will be easier if DataTable_Array::metadata is removed, and metadata that is diff --git a/plugins/Transitions/API.php b/plugins/Transitions/API.php index 7e17fa2996..7294a78560 100644 --- a/plugins/Transitions/API.php +++ b/plugins/Transitions/API.php @@ -65,11 +65,11 @@ class Piwik_Transitions_API $segment = new Piwik_Segment($segment, $idSite); $site = new Piwik_Site($idSite); $period = Piwik_Period::advancedFactory($period, $date); - $archiveProcessing = Piwik_ArchiveProcessor::factory($period, $site, $segment); + $archiveProcessing = new Piwik_ArchiveProcessor_Day($period, $site, $segment); // prepare the report $report = array( - 'date' => Piwik_Period_Day::advancedFactory($period, $date)->getLocalizedShortString() + 'date' => Piwik_Period_Day::advancedFactory($period->getLabel(), $date)->getLocalizedShortString() ); // add data to the report @@ -178,7 +178,7 @@ class Piwik_Transitions_API $idaction, $actionType, $limitBeforeGrouping) { - $data = $transitionsArchiving->queryInternalReferrers( + $data = $this->queryInternalReferrers( $idaction, $actionType, $archiveProcessing, $limitBeforeGrouping); if ($data['pageviews'] == 0) { @@ -207,7 +207,7 @@ class Piwik_Transitions_API $idaction, $actionType, $limitBeforeGrouping, $includeLoops = false) { - $data = $transitionsArchiving->queryFollowingActions( + $data = $this->queryFollowingActions( $idaction, $actionType, $archiveProcessing, $limitBeforeGrouping, $includeLoops); foreach ($data as $tableName => $table) { @@ -215,6 +215,335 @@ class Piwik_Transitions_API } } + + + /** + * Get information about the following actions (following pages, site searches, outlinks, downloads) + * + * @param $idaction + * @param $actionType + * @param Piwik_ArchiveProcessor_Day $archiveProcessing + * @param $limitBeforeGrouping + * @param $includeLoops + * @return array(followingPages:Piwik_DataTable, outlinks:Piwik_DataTable, downloads:Piwik_DataTable) + */ + public function queryFollowingActions($idaction, $actionType, Piwik_ArchiveProcessor_Day $archiveProcessing, + $limitBeforeGrouping = false, $includeLoops = false) + { + $types = array(); + + $isTitle = ($actionType == 'title'); + if (!$isTitle) { + // specific setup for page urls + $types[Piwik_Tracker_Action::TYPE_ACTION_URL] = 'followingPages'; + $dimension = 'IF( idaction_url IS NULL, idaction_name, idaction_url )'; + // site search referrers are logged with url=NULL + // when we find one, we have to join on name + $joinLogActionColumn = $dimension; + $selects = array('log_action.name', 'log_action.url_prefix', 'log_action.type'); + } else { + // specific setup for page titles: + $types[Piwik_Tracker_Action::TYPE_ACTION_NAME] = 'followingPages'; + // join log_action on name and url and pick depending on url type + // the table joined on url is log_action1 + $joinLogActionColumn = array('idaction_url', 'idaction_name'); + $dimension = ' + CASE + ' /* following site search */ . ' + WHEN log_link_visit_action.idaction_url IS NULL THEN log_action2.idaction + ' /* following page view: use page title */ . ' + WHEN log_action1.type = ' . Piwik_Tracker_Action::TYPE_ACTION_URL . ' THEN log_action2.idaction + ' /* following download or outlink: use url */ . ' + ELSE log_action1.idaction + END + '; + $selects = array( + 'CASE + ' /* following site search */ . ' + WHEN log_link_visit_action.idaction_url IS NULL THEN log_action2.name + ' /* following page view: use page title */ . ' + WHEN log_action1.type = ' . Piwik_Tracker_Action::TYPE_ACTION_URL . ' THEN log_action2.name + ' /* following download or outlink: use url */ . ' + ELSE log_action1.name + END AS name', + 'CASE + ' /* following site search */ . ' + WHEN log_link_visit_action.idaction_url IS NULL THEN log_action2.type + ' /* following page view: use page title */ . ' + WHEN log_action1.type = ' . Piwik_Tracker_Action::TYPE_ACTION_URL . ' THEN log_action2.type + ' /* following download or outlink: use url */ . ' + ELSE log_action1.type + END AS type', + 'NULL AS url_prefix' + ); + } + + // these types are available for both titles and urls + $types[Piwik_Tracker_Action::TYPE_SITE_SEARCH] = 'followingSiteSearches'; + $types[Piwik_Tracker_Action::TYPE_OUTLINK] = 'outlinks'; + $types[Piwik_Tracker_Action::TYPE_DOWNLOAD] = 'downloads'; + + $rankingQuery = new Piwik_RankingQuery($limitBeforeGrouping ? $limitBeforeGrouping : $this->limitBeforeGrouping); + $rankingQuery->addLabelColumn(array('name', 'url_prefix')); + $rankingQuery->partitionResultIntoMultipleGroups('type', array_keys($types)); + + $type = $this->getColumnTypeSuffix($actionType); + $where = 'log_link_visit_action.idaction_' . $type . '_ref = ' . intval($idaction); + if (!$includeLoops) { + $where .= ' AND (log_link_visit_action.idaction_' . $type . ' IS NULL OR ' + . 'log_link_visit_action.idaction_' . $type . ' != ' . intval($idaction) . ')'; + } + + $metrics = array(Piwik_Archive::INDEX_NB_ACTIONS); + $data = $archiveProcessing->queryActionsByDimension(array($dimension), $where, $selects, $metrics, $rankingQuery, $joinLogActionColumn); + + $this->totalTransitionsToFollowingActions = 0; + $dataTables = array(); + foreach ($types as $type => $recordName) { + $dataTable = new Piwik_DataTable; + if (isset($data[$type])) { + foreach ($data[$type] as &$record) { + $actions = intval($record[Piwik_Archive::INDEX_NB_ACTIONS]); + $dataTable->addRow(new Piwik_DataTable_Row(array( + Piwik_DataTable_Row::COLUMNS => array( + 'label' => $this->getPageLabel($record, $isTitle), + Piwik_Archive::INDEX_NB_ACTIONS => $actions + ) + ))); + $this->totalTransitionsToFollowingActions += $actions; + } + } + $dataTables[$recordName] = $dataTable; + } + + return $dataTables; + } + + + /** + * After calling this method, the query*()-Methods will return urls in their + * normalized form (without the prefix reconstructed) + */ + public function returnNormalizedUrls() + { + $this->returnNormalizedUrls = true; + } + + /** + * Get information about external referrers (i.e. search engines, websites & campaigns) + * + * @param $idaction + * @param $actionType + * @param Piwik_ArchiveProcessor_Day $archiveProcessing + * @param $limitBeforeGrouping + * @return Piwik_DataTable + */ + public function queryExternalReferrers($idaction, $actionType, $archiveProcessing, + $limitBeforeGrouping = false) + { + $rankingQuery = new Piwik_RankingQuery($limitBeforeGrouping ? $limitBeforeGrouping : $this->limitBeforeGrouping); + + // we generate a single column that contains the interesting data for each referrer. + // the reason we cannot group by referer_* becomes clear when we look at search engine keywords. + // referer_url contains the url from the search engine, referer_keyword the keyword we want to + // group by. when we group by both, we don't get a single column for the keyword but instead + // one column per keyword + search engine url. this way, we could not get the top keywords using + // the ranking query. + $dimensions = array('referrer_data', 'referer_type'); + $rankingQuery->addLabelColumn('referrer_data'); + $selects = array( + 'CASE referer_type + WHEN ' . Piwik_Common::REFERER_TYPE_DIRECT_ENTRY . ' THEN \'\' + WHEN ' . Piwik_Common::REFERER_TYPE_SEARCH_ENGINE . ' THEN referer_keyword + WHEN ' . Piwik_Common::REFERER_TYPE_WEBSITE . ' THEN referer_url + WHEN ' . Piwik_Common::REFERER_TYPE_CAMPAIGN . ' THEN CONCAT(referer_name, \' \', referer_keyword) + END AS referrer_data'); + + // get one limited group per referrer type + $rankingQuery->partitionResultIntoMultipleGroups('referer_type', array( + Piwik_Common::REFERER_TYPE_DIRECT_ENTRY, + Piwik_Common::REFERER_TYPE_SEARCH_ENGINE, + Piwik_Common::REFERER_TYPE_WEBSITE, + Piwik_Common::REFERER_TYPE_CAMPAIGN + )); + + $type = $this->getColumnTypeSuffix($actionType); + $where = 'visit_entry_idaction_' . $type . ' = ' . intval($idaction); + + $metrics = array(Piwik_Archive::INDEX_NB_VISITS); + $data = $archiveProcessing->queryVisitsByDimension($dimensions, $where, $selects, $metrics, $rankingQuery); + + $referrerData = array(); + $referrerSubData = array(); + + foreach ($data as $referrerType => &$subData) { + $referrerData[$referrerType] = array(Piwik_Archive::INDEX_NB_VISITS => 0); + if ($referrerType != Piwik_Common::REFERER_TYPE_DIRECT_ENTRY) { + $referrerSubData[$referrerType] = array(); + } + + foreach ($subData as &$row) { + if ($referrerType == Piwik_Common::REFERER_TYPE_SEARCH_ENGINE && empty($row['referrer_data'])) { + $row['referrer_data'] = Piwik_Referers_API::LABEL_KEYWORD_NOT_DEFINED; + } + + $referrerData[$referrerType][Piwik_Archive::INDEX_NB_VISITS] += $row[Piwik_Archive::INDEX_NB_VISITS]; + + $label = $row['referrer_data']; + if ($label) { + $referrerSubData[$referrerType][$label] = array( + Piwik_Archive::INDEX_NB_VISITS => $row[Piwik_Archive::INDEX_NB_VISITS] + ); + } + } + } + + //FIXMEA refactor after integration tests written + $array = new Piwik_DataArray($referrerData, $referrerSubData); + return Piwik_ArchiveProcessor_Day::getDataTableFromDataArray($array); + } + + /** + * Get information about internal referrers (previous pages & loops, i.e. page refreshes) + * + * @param $idaction + * @param $actionType + * @param Piwik_ArchiveProcessor_Day $archiveProcessing + * @param $limitBeforeGrouping + * @return array(previousPages:Piwik_DataTable, loops:integer) + */ + protected function queryInternalReferrers($idaction, $actionType, $archiveProcessing, + $limitBeforeGrouping = false) + { + $rankingQuery = new Piwik_RankingQuery($limitBeforeGrouping ? $limitBeforeGrouping : $this->limitBeforeGrouping); + $rankingQuery->addLabelColumn(array('name', 'url_prefix')); + $rankingQuery->setColumnToMarkExcludedRows('is_self'); + $rankingQuery->partitionResultIntoMultipleGroups('action_partition', array(0, 1, 2)); + + $type = $this->getColumnTypeSuffix($actionType); + $mainActionType = Piwik_Tracker_Action::TYPE_ACTION_URL; + $dimension = 'idaction_url_ref'; + $isTitle = $actionType == 'title'; + + if ($isTitle) { + $mainActionType = Piwik_Tracker_Action::TYPE_ACTION_NAME; + $dimension = 'idaction_name_ref'; + } + + $selects = array( + 'log_action.name', + 'log_action.url_prefix', + 'CASE WHEN log_link_visit_action.idaction_' . $type . '_ref = ' . intval($idaction) . ' THEN 1 ELSE 0 END AS is_self', + 'CASE + WHEN log_action.type = ' . $mainActionType . ' THEN 1 + WHEN log_action.type = ' . Piwik_Tracker_Action::TYPE_SITE_SEARCH . ' THEN 2 + ELSE 0 + END AS action_partition' + ); + + $where = ' + log_link_visit_action.idaction_' . $type . ' = ' . intval($idaction); + + if ($dimension == 'idaction_url_ref') { + // site search referrers are logged with url_ref=NULL + // when we find one, we have to join on name_ref + $dimension = 'IF( idaction_url_ref IS NULL, idaction_name_ref, idaction_url_ref )'; + $joinLogActionOn = $dimension; + } else { + $joinLogActionOn = $dimension; + } + $metrics = array(Piwik_Archive::INDEX_NB_ACTIONS); + $data = $archiveProcessing->queryActionsByDimension(array($dimension), $where, $selects, $metrics, $rankingQuery, $joinLogActionOn); + + $loops = 0; + $nbPageviews = 0; + $previousPagesDataTable = new Piwik_DataTable; + if (isset($data['result'][1])) { + foreach ($data['result'][1] as &$page) { + $nbActions = intval($page[Piwik_Archive::INDEX_NB_ACTIONS]); + $previousPagesDataTable->addRow(new Piwik_DataTable_Row(array( + Piwik_DataTable_Row::COLUMNS => array( + 'label' => $this->getPageLabel($page, $isTitle), + Piwik_Archive::INDEX_NB_ACTIONS => $nbActions + ) + ))); + $nbPageviews += $nbActions; + } + } + + $previousSearchesDataTable = new Piwik_DataTable; + if (isset($data['result'][2])) { + foreach ($data['result'][2] as &$search) { + $nbActions = intval($search[Piwik_Archive::INDEX_NB_ACTIONS]); + $previousSearchesDataTable->addRow(new Piwik_DataTable_Row(array( + Piwik_DataTable_Row::COLUMNS => array( + 'label' => $search['name'], + Piwik_Archive::INDEX_NB_ACTIONS => $nbActions + ) + ))); + $nbPageviews += $nbActions; + } + } + + if (isset($data['result'][0])) { + foreach ($data['result'][0] as &$referrer) { + $nbPageviews += intval($referrer[Piwik_Archive::INDEX_NB_ACTIONS]); + } + } + + if (count($data['excludedFromLimit'])) { + $loops += intval($data['excludedFromLimit'][0][Piwik_Archive::INDEX_NB_ACTIONS]); + $nbPageviews += $loops; + } + + return array( + 'pageviews' => $nbPageviews, + 'previousPages' => $previousPagesDataTable, + 'previousSiteSearches' => $previousSearchesDataTable, + 'loops' => $loops + ); + } + + private function getPageLabel(&$pageRecord, $isTitle) + { + if ($isTitle) { + $label = $pageRecord['name']; + if (empty($label)) { + $label = Piwik_Actions_ArchivingHelper::getUnknownActionName( + Piwik_Tracker_Action::TYPE_ACTION_NAME); + } + return $label; + } else if ($this->returnNormalizedUrls) { + return $pageRecord['name']; + } else { + return Piwik_Tracker_Action::reconstructNormalizedUrl( + $pageRecord['name'], $pageRecord['url_prefix']); + } + } + + private function getColumnTypeSuffix($actionType) + { + if ($actionType == 'title') { + return 'name'; + } + return 'url'; + } + + private $limitBeforeGrouping = 5; + private $totalTransitionsToFollowingActions = 0; + + private $returnNormalizedUrls = false; + + + /** + * Get the sum of all transitions to following actions (pages, outlinks, downloads). + * Only works if queryFollowingActions() has been used directly before. + */ + protected function getTotalTransitionsToFollowingActions() + { + return $this->totalTransitionsToFollowingActions; + } + /** * Add the external referrers to the report: * direct entries, websites, campaigns, search engines diff --git a/plugins/Transitions/Transitions.php b/plugins/Transitions/Transitions.php index b887669a70..2c51da023e 100644 --- a/plugins/Transitions/Transitions.php +++ b/plugins/Transitions/Transitions.php @@ -15,11 +15,6 @@ class Piwik_Transitions extends Piwik_Plugin { - private $limitBeforeGrouping = 5; - private $totalTransitionsToFollowingActions = 0; - - private $returnNormalizedUrls = false; - public function getInformation() { return array( @@ -50,325 +45,5 @@ class Piwik_Transitions extends Piwik_Plugin $jsFiles[] = 'plugins/Transitions/templates/transitions.js'; } - /** - * After calling this method, the query*()-Methods will return urls in their - * normalized form (without the prefix reconstructed) - */ - public function returnNormalizedUrls() - { - $this->returnNormalizedUrls = true; - } - - /** - * Get information about external referrers (i.e. search engines, websites & campaigns) - * - * @param $idaction - * @param $actionType - * @param Piwik_ArchiveProcessor_Day $archiveProcessing - * @param $limitBeforeGrouping - * @return Piwik_DataTable - */ - public function queryExternalReferrers($idaction, $actionType, $archiveProcessing, - $limitBeforeGrouping = false) - { - $rankingQuery = new Piwik_RankingQuery($limitBeforeGrouping ? $limitBeforeGrouping : $this->limitBeforeGrouping); - - // we generate a single column that contains the interesting data for each referrer. - // the reason we cannot group by referer_* becomes clear when we look at search engine keywords. - // referer_url contains the url from the search engine, referer_keyword the keyword we want to - // group by. when we group by both, we don't get a single column for the keyword but instead - // one column per keyword + search engine url. this way, we could not get the top keywords using - // the ranking query. - $dimensions = array('referrer_data', 'referer_type'); - $rankingQuery->addLabelColumn('referrer_data'); - $selects = array( - 'CASE referer_type - WHEN ' . Piwik_Common::REFERER_TYPE_DIRECT_ENTRY . ' THEN \'\' - WHEN ' . Piwik_Common::REFERER_TYPE_SEARCH_ENGINE . ' THEN referer_keyword - WHEN ' . Piwik_Common::REFERER_TYPE_WEBSITE . ' THEN referer_url - WHEN ' . Piwik_Common::REFERER_TYPE_CAMPAIGN . ' THEN CONCAT(referer_name, \' \', referer_keyword) - END AS referrer_data'); - - // get one limited group per referrer type - $rankingQuery->partitionResultIntoMultipleGroups('referer_type', array( - Piwik_Common::REFERER_TYPE_DIRECT_ENTRY, - Piwik_Common::REFERER_TYPE_SEARCH_ENGINE, - Piwik_Common::REFERER_TYPE_WEBSITE, - Piwik_Common::REFERER_TYPE_CAMPAIGN - )); - - $type = $this->getColumnTypeSuffix($actionType); - $where = 'visit_entry_idaction_' . $type . ' = ' . intval($idaction); - - $metrics = array(Piwik_Archive::INDEX_NB_VISITS); - $data = $archiveProcessing->queryVisitsByDimension($dimensions, $where, $selects, $metrics, $rankingQuery); - - $referrerData = array(); - $referrerSubData = array(); - - foreach ($data as $referrerType => &$subData) { - $referrerData[$referrerType] = array(Piwik_Archive::INDEX_NB_VISITS => 0); - if ($referrerType != Piwik_Common::REFERER_TYPE_DIRECT_ENTRY) { - $referrerSubData[$referrerType] = array(); - } - - foreach ($subData as &$row) { - if ($referrerType == Piwik_Common::REFERER_TYPE_SEARCH_ENGINE && empty($row['referrer_data'])) { - $row['referrer_data'] = Piwik_Referers_API::LABEL_KEYWORD_NOT_DEFINED; - } - - $referrerData[$referrerType][Piwik_Archive::INDEX_NB_VISITS] += $row[Piwik_Archive::INDEX_NB_VISITS]; - - $label = $row['referrer_data']; - if ($label) { - $referrerSubData[$referrerType][$label] = array( - Piwik_Archive::INDEX_NB_VISITS => $row[Piwik_Archive::INDEX_NB_VISITS] - ); - } - } - } - - //FIXMEA refactor after integration tests written - $array = new Piwik_DataArray($referrerData, $referrerSubData); - return Piwik_ArchiveProcessor_Day::getDataTableFromDataArray($array); - } - - /** - * Get information about internal referrers (previous pages & loops, i.e. page refreshes) - * - * @param $idaction - * @param $actionType - * @param Piwik_ArchiveProcessor_Day $archiveProcessing - * @param $limitBeforeGrouping - * @return array(previousPages:Piwik_DataTable, loops:integer) - */ - public function queryInternalReferrers($idaction, $actionType, $archiveProcessing, - $limitBeforeGrouping = false) - { - $rankingQuery = new Piwik_RankingQuery($limitBeforeGrouping ? $limitBeforeGrouping : $this->limitBeforeGrouping); - $rankingQuery->addLabelColumn(array('name', 'url_prefix')); - $rankingQuery->setColumnToMarkExcludedRows('is_self'); - $rankingQuery->partitionResultIntoMultipleGroups('action_partition', array(0, 1, 2)); - - $type = $this->getColumnTypeSuffix($actionType); - $mainActionType = Piwik_Tracker_Action::TYPE_ACTION_URL; - $dimension = 'idaction_url_ref'; - $isTitle = $actionType == 'title'; - if ($isTitle) { - $mainActionType = Piwik_Tracker_Action::TYPE_ACTION_NAME; - $dimension = 'idaction_name_ref'; - } - - $selects = array( - 'log_action.name', - 'log_action.url_prefix', - 'CASE WHEN log_link_visit_action.idaction_' . $type . '_ref = ' . intval($idaction) . ' THEN 1 ELSE 0 END AS is_self', - 'CASE - WHEN log_action.type = ' . $mainActionType . ' THEN 1 - WHEN log_action.type = ' . Piwik_Tracker_Action::TYPE_SITE_SEARCH . ' THEN 2 - ELSE 0 - END AS action_partition' - ); - - $where = ' - log_link_visit_action.idaction_' . $type . ' = ' . intval($idaction); - - if ($dimension == 'idaction_url_ref') { - // site search referrers are logged with url_ref=NULL - // when we find one, we have to join on name_ref - $dimension = 'IF( idaction_url_ref IS NULL, idaction_name_ref, idaction_url_ref )'; - $joinLogActionOn = $dimension; - } else { - $joinLogActionOn = $dimension; - $dimension = array($dimension); - } - - $metrics = array(Piwik_Archive::INDEX_NB_ACTIONS); - $data = $archiveProcessing->queryActionsByDimension($dimension, $where, $selects, $metrics, $rankingQuery, $joinLogActionOn); - - $loops = 0; - $nbPageviews = 0; - $previousPagesDataTable = new Piwik_DataTable; - if (isset($data['result'][1])) { - foreach ($data['result'][1] as &$page) { - $nbActions = intval($page[Piwik_Archive::INDEX_NB_ACTIONS]); - $previousPagesDataTable->addRow(new Piwik_DataTable_Row(array( - Piwik_DataTable_Row::COLUMNS => array( - 'label' => $this->getPageLabel($page, $isTitle), - Piwik_Archive::INDEX_NB_ACTIONS => $nbActions - ) - ))); - $nbPageviews += $nbActions; - } - } - - $previousSearchesDataTable = new Piwik_DataTable; - if (isset($data['result'][2])) { - foreach ($data['result'][2] as &$search) { - $nbActions = intval($search[Piwik_Archive::INDEX_NB_ACTIONS]); - $previousSearchesDataTable->addRow(new Piwik_DataTable_Row(array( - Piwik_DataTable_Row::COLUMNS => array( - 'label' => $search['name'], - Piwik_Archive::INDEX_NB_ACTIONS => $nbActions - ) - ))); - $nbPageviews += $nbActions; - } - } - - if (isset($data['result'][0])) { - foreach ($data['result'][0] as &$referrer) { - $nbPageviews += intval($referrer[Piwik_Archive::INDEX_NB_ACTIONS]); - } - } - - if (count($data['excludedFromLimit'])) { - $loops += intval($data['excludedFromLimit'][0][Piwik_Archive::INDEX_NB_ACTIONS]); - $nbPageviews += $loops; - } - - return array( - 'pageviews' => $nbPageviews, - 'previousPages' => $previousPagesDataTable, - 'previousSiteSearches' => $previousSearchesDataTable, - 'loops' => $loops - ); - } - - private function getPageLabel(&$pageRecord, $isTitle) - { - if ($isTitle) { - $label = $pageRecord['name']; - if (empty($label)) { - $label = Piwik_Actions_ArchivingHelper::getUnknownActionName( - Piwik_Tracker_Action::TYPE_ACTION_NAME); - } - return $label; - } else if ($this->returnNormalizedUrls) { - return $pageRecord['name']; - } else { - return Piwik_Tracker_Action::reconstructNormalizedUrl( - $pageRecord['name'], $pageRecord['url_prefix']); - } - } - - /** - * Get information about the following actions (following pages, site searches, outlinks, downloads) - * - * @param $idaction - * @param $actionType - * @param Piwik_ArchiveProcessor_Day $archiveProcessing - * @param $limitBeforeGrouping - * @param $includeLoops - * @return array(followingPages:Piwik_DataTable, outlinks:Piwik_DataTable, downloads:Piwik_DataTable) - */ - public function queryFollowingActions($idaction, $actionType, Piwik_ArchiveProcessor_Day $archiveProcessing, - $limitBeforeGrouping = false, $includeLoops = false) - { - $types = array(); - - $isTitle = ($actionType == 'title'); - if (!$isTitle) { - // specific setup for page urls - $types[Piwik_Tracker_Action::TYPE_ACTION_URL] = 'followingPages'; - $dimension = 'IF( idaction_url IS NULL, idaction_name, idaction_url )'; - // site search referrers are logged with url=NULL - // when we find one, we have to join on name - $joinLogActionColumn = $dimension; - $selects = array('log_action.name', 'log_action.url_prefix', 'log_action.type'); - } else { - // specific setup for page titles: - $types[Piwik_Tracker_Action::TYPE_ACTION_NAME] = 'followingPages'; - // join log_action on name and url and pick depending on url type - // the table joined on url is log_action1 - $joinLogActionColumn = array('idaction_url', 'idaction_name'); - $dimension = ' - CASE - ' /* following site search */ . ' - WHEN log_link_visit_action.idaction_url IS NULL THEN log_action2.idaction - ' /* following page view: use page title */ . ' - WHEN log_action1.type = ' . Piwik_Tracker_Action::TYPE_ACTION_URL . ' THEN log_action2.idaction - ' /* following download or outlink: use url */ . ' - ELSE log_action1.idaction - END - '; - $selects = array( - 'CASE - ' /* following site search */ . ' - WHEN log_link_visit_action.idaction_url IS NULL THEN log_action2.name - ' /* following page view: use page title */ . ' - WHEN log_action1.type = ' . Piwik_Tracker_Action::TYPE_ACTION_URL . ' THEN log_action2.name - ' /* following download or outlink: use url */ . ' - ELSE log_action1.name - END AS name', - 'CASE - ' /* following site search */ . ' - WHEN log_link_visit_action.idaction_url IS NULL THEN log_action2.type - ' /* following page view: use page title */ . ' - WHEN log_action1.type = ' . Piwik_Tracker_Action::TYPE_ACTION_URL . ' THEN log_action2.type - ' /* following download or outlink: use url */ . ' - ELSE log_action1.type - END AS type', - 'NULL AS url_prefix' - ); - } - - // these types are available for both titles and urls - $types[Piwik_Tracker_Action::TYPE_SITE_SEARCH] = 'followingSiteSearches'; - $types[Piwik_Tracker_Action::TYPE_OUTLINK] = 'outlinks'; - $types[Piwik_Tracker_Action::TYPE_DOWNLOAD] = 'downloads'; - - $rankingQuery = new Piwik_RankingQuery($limitBeforeGrouping ? $limitBeforeGrouping : $this->limitBeforeGrouping); - $rankingQuery->addLabelColumn(array('name', 'url_prefix')); - $rankingQuery->partitionResultIntoMultipleGroups('type', array_keys($types)); - - $type = $this->getColumnTypeSuffix($actionType); - $where = 'log_link_visit_action.idaction_' . $type . '_ref = ' . intval($idaction); - if (!$includeLoops) { - $where .= ' AND (log_link_visit_action.idaction_' . $type . ' IS NULL OR ' - . 'log_link_visit_action.idaction_' . $type . ' != ' . intval($idaction) . ')'; - } - - $metrics = array(Piwik_Archive::INDEX_NB_ACTIONS); - $data = $archiveProcessing->queryActionsByDimension($dimension, $where, $selects, $metrics, $rankingQuery, $joinLogActionColumn); - - $this->totalTransitionsToFollowingActions = 0; - $dataTables = array(); - foreach ($types as $type => $recordName) { - $dataTable = new Piwik_DataTable; - if (isset($data[$type])) { - foreach ($data[$type] as &$record) { - $actions = intval($record[Piwik_Archive::INDEX_NB_ACTIONS]); - $dataTable->addRow(new Piwik_DataTable_Row(array( - Piwik_DataTable_Row::COLUMNS => array( - 'label' => $this->getPageLabel($record, $isTitle), - Piwik_Archive::INDEX_NB_ACTIONS => $actions - ) - ))); - $this->totalTransitionsToFollowingActions += $actions; - } - } - $dataTables[$recordName] = $dataTable; - } - - return $dataTables; - } - - /** - * Get the sum of all transitions to following actions (pages, outlinks, downloads). - * Only works if queryFollowingActions() has been used directly before. - */ - public function getTotalTransitionsToFollowingActions() - { - return $this->totalTransitionsToFollowingActions; - } - - private function getColumnTypeSuffix($actionType) - { - if ($actionType == 'title') { - return 'name'; - } - return 'url'; - } } \ No newline at end of file diff --git a/plugins/VisitTime/API.php b/plugins/VisitTime/API.php index 65952ba24d..807b399869 100644 --- a/plugins/VisitTime/API.php +++ b/plugins/VisitTime/API.php @@ -64,24 +64,25 @@ class Piwik_VisitTime_API { Piwik::checkUserHasViewAccess($idSite); - // disabled for multiple sites/dates - if (Piwik_Archive::isMultipleSites($idSite)) { - throw new Exception("VisitTime.getByDayOfWeek does not support multiple sites."); - } - - if (Piwik_Archive::isMultiplePeriod($date, $period)) { - throw new Exception("VisitTime.getByDayOfWeek does not support multiple dates."); - } - // metrics to query $metrics = Piwik_Archive::getVisitsMetricNames(); unset($metrics[Piwik_Archive::INDEX_MAX_ACTIONS]); // get metric data for every day within the supplied period - $oPeriod = Piwik_Archive::makePeriodFromQueryParams(Piwik_Site::getTimezoneFor($idSite), $period, $date); + $oPeriod = Piwik_Period::makePeriodFromQueryParams(Piwik_Site::getTimezoneFor($idSite), $period, $date); $dateRange = $oPeriod->getDateStart()->toString() . ',' . $oPeriod->getDateEnd()->toString(); $archive = Piwik_Archive::build($idSite, 'day', $dateRange, $segment); + + // disabled for multiple sites/dates + if ( count( $archive->getParams()->getIdSites() ) > 1) { + throw new Exception("VisitTime.getByDayOfWeek does not support multiple sites."); + } + + if ( count ($archive->getParams()->getPeriods() ) > 1) { + throw new Exception("VisitTime.getByDayOfWeek does not support multiple dates."); + } + $dataTable = $archive->getDataTableFromNumeric($metrics); // if there's no data for this report, don't bother w/ anything else diff --git a/plugins/VisitTime/Controller.php b/plugins/VisitTime/Controller.php index 9c2fce1087..778f3a6f0e 100644 --- a/plugins/VisitTime/Controller.php +++ b/plugins/VisitTime/Controller.php @@ -73,7 +73,7 @@ class Piwik_VisitTime_Controller extends Piwik_Controller $period = Piwik_Common::getRequestVar('period'); // create a period instance - $oPeriod = Piwik_Archive::makePeriodFromQueryParams(Piwik_Site::getTimezoneFor($idSite), $period, $date); + $oPeriod = Piwik_Period::makePeriodFromQueryParams(Piwik_Site::getTimezoneFor($idSite), $period, $date); // set the footer message using the period start & end date $start = $oPeriod->getDateStart()->toString(); -- cgit v1.2.3 From dd2140c8c3faf2cfca30fd6fea0350ca953695da Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 13 Jun 2013 17:23:46 +1200 Subject: Adding new classes Disabling VisitTime.getByDayOfWeek since I dont understand how to make it work / why it's changed yet --- plugins/VisitTime/API.php | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'plugins') diff --git a/plugins/VisitTime/API.php b/plugins/VisitTime/API.php index 807b399869..dddd2431e0 100644 --- a/plugins/VisitTime/API.php +++ b/plugins/VisitTime/API.php @@ -71,7 +71,6 @@ class Piwik_VisitTime_API // get metric data for every day within the supplied period $oPeriod = Piwik_Period::makePeriodFromQueryParams(Piwik_Site::getTimezoneFor($idSite), $period, $date); $dateRange = $oPeriod->getDateStart()->toString() . ',' . $oPeriod->getDateEnd()->toString(); - $archive = Piwik_Archive::build($idSite, 'day', $dateRange, $segment); // disabled for multiple sites/dates @@ -79,14 +78,18 @@ class Piwik_VisitTime_API throw new Exception("VisitTime.getByDayOfWeek does not support multiple sites."); } - if ( count ($archive->getParams()->getPeriods() ) > 1) { + $periods = $archive->getParams()->getPeriods(); + if ( count ($periods) > 1 + && !($periods[0] instanceof Piwik_Period_Day)) { throw new Exception("VisitTime.getByDayOfWeek does not support multiple dates."); } + //FIXMEA + throw new exception("Temporarily broken - stay tuned"); + $dataTable = $archive->getDataTableFromNumeric($metrics); // if there's no data for this report, don't bother w/ anything else - // TODO: with changes to getDataTableFromNumeric, this code would have to check if every row has 0 column values. is it really necessary? (assuming no for now) if ($dataTable->getRowsCount() == 0) { return $dataTable; } -- cgit v1.2.3 From e2b74053c61b0f3d6d44e11472f037a853f5e98a Mon Sep 17 00:00:00 2001 From: mattab Date: Thu, 13 Jun 2013 17:31:17 +1200 Subject: Renaming ArchiveProcessing in comments as well, adding missing header --- plugins/API/API.php | 2 +- plugins/Actions/Actions.php | 10 +++--- plugins/CustomVariables/CustomVariables.php | 8 ++--- plugins/DevicesDetection/DevicesDetection.php | 8 ++--- plugins/Goals/Goals.php | 8 ++--- plugins/Provider/Provider.php | 8 ++--- plugins/Referers/Referers.php | 8 ++--- plugins/Transitions/API.php | 44 +++++++++++++-------------- plugins/UserCountry/UserCountry.php | 8 ++--- plugins/UserSettings/UserSettings.php | 8 ++--- plugins/VisitTime/VisitTime.php | 8 ++--- plugins/VisitorInterest/VisitorInterest.php | 8 ++--- 12 files changed, 64 insertions(+), 64 deletions(-) (limited to 'plugins') diff --git a/plugins/API/API.php b/plugins/API/API.php index e2721119f4..3e0431c124 100644 --- a/plugins/API/API.php +++ b/plugins/API/API.php @@ -527,7 +527,7 @@ class Piwik_API_API $reportsMetadata = $this->getReportMetadata($idSite, $period, $date, $hideMetricsDoc, $showSubtableReports); foreach ($reportsMetadata as $report) { - // See ArchiveProcessing/Period.php - unique visitors are not processed for period != day + // See ArchiveProcessor/Period.php - unique visitors are not processed for period != day if (($period && $period != 'day') && !($apiModule == 'VisitsSummary' && $apiAction == 'get')) { unset($report['metrics']['nb_uniq_visitors']); } diff --git a/plugins/Actions/Actions.php b/plugins/Actions/Actions.php index 7d401b3c59..d00ed25905 100644 --- a/plugins/Actions/Actions.php +++ b/plugins/Actions/Actions.php @@ -573,10 +573,10 @@ class Piwik_Actions extends Piwik_Plugin */ public function archiveDay($notification) { - /* @var $archiveProcessing Piwik_ArchiveProcessor_Day */ - $archiveProcessing = $notification->getNotificationObject(); + /* @var $archiveProcessor Piwik_ArchiveProcessor_Day */ + $archiveProcessor = $notification->getNotificationObject(); - $archiving = new Piwik_Actions_Archiver($archiveProcessing); + $archiving = new Piwik_Actions_Archiver($archiveProcessor); if($archiving->shouldArchive()) { $archiving->archiveDay(); } @@ -584,9 +584,9 @@ class Piwik_Actions extends Piwik_Plugin function archivePeriod($notification) { - $archiveProcessing = $notification->getNotificationObject(); + $archiveProcessor = $notification->getNotificationObject(); - $archiving = new Piwik_Actions_Archiver($archiveProcessing); + $archiving = new Piwik_Actions_Archiver($archiveProcessor); if($archiving->shouldArchive()) { $archiving->archivePeriod(); } diff --git a/plugins/CustomVariables/CustomVariables.php b/plugins/CustomVariables/CustomVariables.php index d0c0b9d759..3f3421fe41 100644 --- a/plugins/CustomVariables/CustomVariables.php +++ b/plugins/CustomVariables/CustomVariables.php @@ -148,9 +148,9 @@ class Piwik_CustomVariables extends Piwik_Plugin */ public function archiveDay($notification) { - $archiveProcessing = $notification->getNotificationObject(); + $archiveProcessor = $notification->getNotificationObject(); - $archiving = new Piwik_CustomVariables_Archiver($archiveProcessing); + $archiving = new Piwik_CustomVariables_Archiver($archiveProcessor); if($archiving->shouldArchive()) { $archiving->archiveDay(); } @@ -161,8 +161,8 @@ class Piwik_CustomVariables extends Piwik_Plugin */ function archivePeriod($notification) { - $archiveProcessing = $notification->getNotificationObject(); - $archiving = new Piwik_CustomVariables_Archiver($archiveProcessing); + $archiveProcessor = $notification->getNotificationObject(); + $archiving = new Piwik_CustomVariables_Archiver($archiveProcessor); if($archiving->shouldArchive()) { $archiving->archivePeriod(); } diff --git a/plugins/DevicesDetection/DevicesDetection.php b/plugins/DevicesDetection/DevicesDetection.php index 37ef364ebe..30c55ffe37 100644 --- a/plugins/DevicesDetection/DevicesDetection.php +++ b/plugins/DevicesDetection/DevicesDetection.php @@ -239,9 +239,9 @@ class Piwik_DevicesDetection extends Piwik_Plugin public function archiveDay($notification) { - $archiveProcessing = $notification->getNotificationObject(); + $archiveProcessor = $notification->getNotificationObject(); - $archiving = new Piwik_DevicesDetection_Archiver($archiveProcessing); + $archiving = new Piwik_DevicesDetection_Archiver($archiveProcessor); if($archiving->shouldArchive()) { $archiving->archiveDay(); } @@ -249,8 +249,8 @@ class Piwik_DevicesDetection extends Piwik_Plugin public function archivePeriod($notification) { - $archiveProcessing = $notification->getNotificationObject(); - $archiving = new Piwik_DevicesDetection_Archiver($archiveProcessing); + $archiveProcessor = $notification->getNotificationObject(); + $archiving = new Piwik_DevicesDetection_Archiver($archiveProcessor); if($archiving->shouldArchive()) { $archiving->archivePeriod(); } diff --git a/plugins/Goals/Goals.php b/plugins/Goals/Goals.php index ecda104804..a813b8f010 100644 --- a/plugins/Goals/Goals.php +++ b/plugins/Goals/Goals.php @@ -511,9 +511,9 @@ class Piwik_Goals extends Piwik_Plugin /** * @var Piwik_ArchiveProcessor_Day */ - $archiveProcessing = $notification->getNotificationObject(); + $archiveProcessor = $notification->getNotificationObject(); - $archiving = new Piwik_Goals_Archiver($archiveProcessing); + $archiving = new Piwik_Goals_Archiver($archiveProcessor); if($archiving->shouldArchive()) { $archiving->archiveDay(); } @@ -528,9 +528,9 @@ class Piwik_Goals extends Piwik_Plugin */ function archivePeriod($notification) { - $archiveProcessing = $notification->getNotificationObject(); + $archiveProcessor = $notification->getNotificationObject(); - $archiving = new Piwik_Goals_Archiver($archiveProcessing); + $archiving = new Piwik_Goals_Archiver($archiveProcessor); if($archiving->shouldArchive()) { $archiving->archivePeriod(); } diff --git a/plugins/Provider/Provider.php b/plugins/Provider/Provider.php index a93f48be77..f6d1ff1b68 100644 --- a/plugins/Provider/Provider.php +++ b/plugins/Provider/Provider.php @@ -221,9 +221,9 @@ class Piwik_Provider extends Piwik_Plugin */ function archiveDay($notification) { - $archiveProcessing = $notification->getNotificationObject(); + $archiveProcessor = $notification->getNotificationObject(); - $archiving = new Piwik_Provider_Archiver($archiveProcessing); + $archiving = new Piwik_Provider_Archiver($archiveProcessor); if($archiving->shouldArchive()) { $archiving->archiveDay(); } @@ -235,9 +235,9 @@ class Piwik_Provider extends Piwik_Plugin */ function archivePeriod($notification) { - $archiveProcessing = $notification->getNotificationObject(); + $archiveProcessor = $notification->getNotificationObject(); - $archiving = new Piwik_Provider_Archiver($archiveProcessing); + $archiving = new Piwik_Provider_Archiver($archiveProcessor); if($archiving->shouldArchive()) { $archiving->archivePeriod(); } diff --git a/plugins/Referers/Referers.php b/plugins/Referers/Referers.php index c00f580a03..d0b05335e6 100644 --- a/plugins/Referers/Referers.php +++ b/plugins/Referers/Referers.php @@ -289,9 +289,9 @@ class Piwik_Referers extends Piwik_Plugin */ public function archiveDay($notification) { - $archiveProcessing = $notification->getNotificationObject(); + $archiveProcessor = $notification->getNotificationObject(); - $archiving = new Piwik_Referers_Archiver($archiveProcessing); + $archiving = new Piwik_Referers_Archiver($archiveProcessor); if ($archiving->shouldArchive()) { $archiving->archiveDay(); } @@ -305,8 +305,8 @@ class Piwik_Referers extends Piwik_Plugin */ function archivePeriod($notification) { - $archiveProcessing = $notification->getNotificationObject(); - $archiving = new Piwik_Referers_Archiver($archiveProcessing); + $archiveProcessor = $notification->getNotificationObject(); + $archiving = new Piwik_Referers_Archiver($archiveProcessor); if($archiving->shouldArchive()) { $archiving->archivePeriod(); } diff --git a/plugins/Transitions/API.php b/plugins/Transitions/API.php index 7294a78560..bdc79b6e4f 100644 --- a/plugins/Transitions/API.php +++ b/plugins/Transitions/API.php @@ -65,7 +65,7 @@ class Piwik_Transitions_API $segment = new Piwik_Segment($segment, $idSite); $site = new Piwik_Site($idSite); $period = Piwik_Period::advancedFactory($period, $date); - $archiveProcessing = new Piwik_ArchiveProcessor_Day($period, $site, $segment); + $archiveProcessor = new Piwik_ArchiveProcessor_Day($period, $site, $segment); // prepare the report $report = array( @@ -81,16 +81,16 @@ class Piwik_Transitions_API $partsArray = explode(',', $parts); if ($parts == 'all' || in_array('internalReferrers', $partsArray)) { - $this->addInternalReferrers($transitionsArchiving, $archiveProcessing, $report, $idaction, + $this->addInternalReferrers($transitionsArchiving, $archiveProcessor, $report, $idaction, $actionType, $limitBeforeGrouping); } if ($parts == 'all' || in_array('followingActions', $partsArray)) { $includeLoops = $parts != 'all' && !in_array('internalReferrers', $partsArray); - $this->addFollowingActions($transitionsArchiving, $archiveProcessing, $report, $idaction, + $this->addFollowingActions($transitionsArchiving, $archiveProcessor, $report, $idaction, $actionType, $limitBeforeGrouping, $includeLoops); } if ($parts == 'all' || in_array('externalReferrers', $partsArray)) { - $this->addExternalReferrers($transitionsArchiving, $archiveProcessing, $report, $idaction, + $this->addExternalReferrers($transitionsArchiving, $archiveProcessor, $report, $idaction, $actionType, $limitBeforeGrouping); } @@ -167,19 +167,19 @@ class Piwik_Transitions_API * previous pages and previous site searches * * @param Piwik_Transitions $transitionsArchiving - * @param $archiveProcessing + * @param $archiveProcessor * @param $report * @param $idaction * @param string $actionType * @param $limitBeforeGrouping * @throws Exception */ - private function addInternalReferrers($transitionsArchiving, $archiveProcessing, &$report, + private function addInternalReferrers($transitionsArchiving, $archiveProcessor, &$report, $idaction, $actionType, $limitBeforeGrouping) { $data = $this->queryInternalReferrers( - $idaction, $actionType, $archiveProcessing, $limitBeforeGrouping); + $idaction, $actionType, $archiveProcessor, $limitBeforeGrouping); if ($data['pageviews'] == 0) { throw new Exception('NoDataForAction'); @@ -196,19 +196,19 @@ class Piwik_Transitions_API * following pages, downloads, outlinks * * @param Piwik_Transitions $transitionsArchiving - * @param $archiveProcessing + * @param $archiveProcessor * @param $report * @param $idaction * @param string $actionType * @param $limitBeforeGrouping * @param boolean $includeLoops */ - private function addFollowingActions($transitionsArchiving, $archiveProcessing, &$report, + private function addFollowingActions($transitionsArchiving, $archiveProcessor, &$report, $idaction, $actionType, $limitBeforeGrouping, $includeLoops = false) { $data = $this->queryFollowingActions( - $idaction, $actionType, $archiveProcessing, $limitBeforeGrouping, $includeLoops); + $idaction, $actionType, $archiveProcessor, $limitBeforeGrouping, $includeLoops); foreach ($data as $tableName => $table) { $report[$tableName] = $table; @@ -222,12 +222,12 @@ class Piwik_Transitions_API * * @param $idaction * @param $actionType - * @param Piwik_ArchiveProcessor_Day $archiveProcessing + * @param Piwik_ArchiveProcessor_Day $archiveProcessor * @param $limitBeforeGrouping * @param $includeLoops * @return array(followingPages:Piwik_DataTable, outlinks:Piwik_DataTable, downloads:Piwik_DataTable) */ - public function queryFollowingActions($idaction, $actionType, Piwik_ArchiveProcessor_Day $archiveProcessing, + public function queryFollowingActions($idaction, $actionType, Piwik_ArchiveProcessor_Day $archiveProcessor, $limitBeforeGrouping = false, $includeLoops = false) { $types = array(); @@ -295,7 +295,7 @@ class Piwik_Transitions_API } $metrics = array(Piwik_Archive::INDEX_NB_ACTIONS); - $data = $archiveProcessing->queryActionsByDimension(array($dimension), $where, $selects, $metrics, $rankingQuery, $joinLogActionColumn); + $data = $archiveProcessor->queryActionsByDimension(array($dimension), $where, $selects, $metrics, $rankingQuery, $joinLogActionColumn); $this->totalTransitionsToFollowingActions = 0; $dataTables = array(); @@ -334,11 +334,11 @@ class Piwik_Transitions_API * * @param $idaction * @param $actionType - * @param Piwik_ArchiveProcessor_Day $archiveProcessing + * @param Piwik_ArchiveProcessor_Day $archiveProcessor * @param $limitBeforeGrouping * @return Piwik_DataTable */ - public function queryExternalReferrers($idaction, $actionType, $archiveProcessing, + public function queryExternalReferrers($idaction, $actionType, $archiveProcessor, $limitBeforeGrouping = false) { $rankingQuery = new Piwik_RankingQuery($limitBeforeGrouping ? $limitBeforeGrouping : $this->limitBeforeGrouping); @@ -371,7 +371,7 @@ class Piwik_Transitions_API $where = 'visit_entry_idaction_' . $type . ' = ' . intval($idaction); $metrics = array(Piwik_Archive::INDEX_NB_VISITS); - $data = $archiveProcessing->queryVisitsByDimension($dimensions, $where, $selects, $metrics, $rankingQuery); + $data = $archiveProcessor->queryVisitsByDimension($dimensions, $where, $selects, $metrics, $rankingQuery); $referrerData = array(); $referrerSubData = array(); @@ -408,11 +408,11 @@ class Piwik_Transitions_API * * @param $idaction * @param $actionType - * @param Piwik_ArchiveProcessor_Day $archiveProcessing + * @param Piwik_ArchiveProcessor_Day $archiveProcessor * @param $limitBeforeGrouping * @return array(previousPages:Piwik_DataTable, loops:integer) */ - protected function queryInternalReferrers($idaction, $actionType, $archiveProcessing, + protected function queryInternalReferrers($idaction, $actionType, $archiveProcessor, $limitBeforeGrouping = false) { $rankingQuery = new Piwik_RankingQuery($limitBeforeGrouping ? $limitBeforeGrouping : $this->limitBeforeGrouping); @@ -453,7 +453,7 @@ class Piwik_Transitions_API $joinLogActionOn = $dimension; } $metrics = array(Piwik_Archive::INDEX_NB_ACTIONS); - $data = $archiveProcessing->queryActionsByDimension(array($dimension), $where, $selects, $metrics, $rankingQuery, $joinLogActionOn); + $data = $archiveProcessor->queryActionsByDimension(array($dimension), $where, $selects, $metrics, $rankingQuery, $joinLogActionOn); $loops = 0; $nbPageviews = 0; @@ -549,18 +549,18 @@ class Piwik_Transitions_API * direct entries, websites, campaigns, search engines * * @param Piwik_Transitions $transitionsArchiving - * @param $archiveProcessing + * @param $archiveProcessor * @param $report * @param $idaction * @param string $actionType * @param $limitBeforeGrouping */ - private function addExternalReferrers($transitionsArchiving, $archiveProcessing, &$report, + private function addExternalReferrers($transitionsArchiving, $archiveProcessor, &$report, $idaction, $actionType, $limitBeforeGrouping) { $data = $transitionsArchiving->queryExternalReferrers( - $idaction, $actionType, $archiveProcessing, $limitBeforeGrouping); + $idaction, $actionType, $archiveProcessor, $limitBeforeGrouping); $report['pageMetrics']['entries'] = 0; $report['referrers'] = array(); diff --git a/plugins/UserCountry/UserCountry.php b/plugins/UserCountry/UserCountry.php index b6df074492..92c465ee76 100644 --- a/plugins/UserCountry/UserCountry.php +++ b/plugins/UserCountry/UserCountry.php @@ -291,9 +291,9 @@ class Piwik_UserCountry extends Piwik_Plugin */ function archivePeriod($notification) { - $archiveProcessing = $notification->getNotificationObject(); + $archiveProcessor = $notification->getNotificationObject(); - $archiving = new Piwik_UserCountry_Archiver($archiveProcessing); + $archiving = new Piwik_UserCountry_Archiver($archiveProcessor); if($archiving->shouldArchive()) { $archiving->archivePeriod(); } @@ -305,9 +305,9 @@ class Piwik_UserCountry extends Piwik_Plugin */ function archiveDay($notification) { - $archiveProcessing = $notification->getNotificationObject(); + $archiveProcessor = $notification->getNotificationObject(); - $archiving = new Piwik_UserCountry_Archiver($archiveProcessing); + $archiving = new Piwik_UserCountry_Archiver($archiveProcessor); if($archiving->shouldArchive()) { $archiving->archiveDay(); } diff --git a/plugins/UserSettings/UserSettings.php b/plugins/UserSettings/UserSettings.php index e97518c840..19b5252360 100644 --- a/plugins/UserSettings/UserSettings.php +++ b/plugins/UserSettings/UserSettings.php @@ -272,9 +272,9 @@ class Piwik_UserSettings extends Piwik_Plugin */ function archiveDay($notification) { - $archiveProcessing = $notification->getNotificationObject(); + $archiveProcessor = $notification->getNotificationObject(); - $archiving = new Piwik_UserSettings_Archiver($archiveProcessing); + $archiving = new Piwik_UserSettings_Archiver($archiveProcessor); if($archiving->shouldArchive()) { $archiving->archiveDay(); } @@ -289,9 +289,9 @@ class Piwik_UserSettings extends Piwik_Plugin */ function archivePeriod($notification) { - $archiveProcessing = $notification->getNotificationObject(); + $archiveProcessor = $notification->getNotificationObject(); - $archiving = new Piwik_UserSettings_Archiver($archiveProcessing); + $archiving = new Piwik_UserSettings_Archiver($archiveProcessor); if($archiving->shouldArchive()) { $archiving->archivePeriod(); } diff --git a/plugins/VisitTime/VisitTime.php b/plugins/VisitTime/VisitTime.php index 6208da6c64..b74a48f59e 100644 --- a/plugins/VisitTime/VisitTime.php +++ b/plugins/VisitTime/VisitTime.php @@ -132,9 +132,9 @@ class Piwik_VisitTime extends Piwik_Plugin function archivePeriod($notification) { - $archiveProcessing = $notification->getNotificationObject(); + $archiveProcessor = $notification->getNotificationObject(); - $archiving = new Piwik_VisitTime_Archiver($archiveProcessing); + $archiving = new Piwik_VisitTime_Archiver($archiveProcessor); if($archiving->shouldArchive()) { $archiving->archivePeriod(); } @@ -143,8 +143,8 @@ class Piwik_VisitTime extends Piwik_Plugin public function archiveDay($notification) { - $archiveProcessing = $notification->getNotificationObject(); - $archiving = new Piwik_VisitTime_Archiver($archiveProcessing); + $archiveProcessor = $notification->getNotificationObject(); + $archiving = new Piwik_VisitTime_Archiver($archiveProcessor); if($archiving->shouldArchive()) { $archiving->archiveDay(); } diff --git a/plugins/VisitorInterest/VisitorInterest.php b/plugins/VisitorInterest/VisitorInterest.php index 583e8c31da..c2a46f1f9e 100644 --- a/plugins/VisitorInterest/VisitorInterest.php +++ b/plugins/VisitorInterest/VisitorInterest.php @@ -125,9 +125,9 @@ class Piwik_VisitorInterest extends Piwik_Plugin function archivePeriod($notification) { - $archiveProcessing = $notification->getNotificationObject(); + $archiveProcessor = $notification->getNotificationObject(); - $archiving = new Piwik_VisitorInterest_Archiver($archiveProcessing); + $archiving = new Piwik_VisitorInterest_Archiver($archiveProcessor); if($archiving->shouldArchive()) { $archiving->archivePeriod(); } @@ -135,9 +135,9 @@ class Piwik_VisitorInterest extends Piwik_Plugin public function archiveDay($notification) { - $archiveProcessing = $notification->getNotificationObject(); + $archiveProcessor = $notification->getNotificationObject(); - $archiving = new Piwik_VisitorInterest_Archiver($archiveProcessing); + $archiving = new Piwik_VisitorInterest_Archiver($archiveProcessor); if($archiving->shouldArchive()) { $archiving->archiveDay(); } -- cgit v1.2.3 From e1e29012f17c02ee130083105c4fafada2fc36ac Mon Sep 17 00:00:00 2001 From: mattab Date: Sat, 15 Jun 2013 15:42:48 +1200 Subject: Fixing transitions and few other things. Still one failing test. --- plugins/Transitions/API.php | 19 +++++++++---------- plugins/VisitTime/API.php | 20 ++++++++++++-------- 2 files changed, 21 insertions(+), 18 deletions(-) (limited to 'plugins') diff --git a/plugins/Transitions/API.php b/plugins/Transitions/API.php index bdc79b6e4f..a18b1d6324 100644 --- a/plugins/Transitions/API.php +++ b/plugins/Transitions/API.php @@ -97,7 +97,7 @@ class Piwik_Transitions_API // derive the number of exits from the other metrics if ($parts == 'all') { $report['pageMetrics']['exits'] = $report['pageMetrics']['pageviews'] - - $transitionsArchiving->getTotalTransitionsToFollowingActions() + - $this->getTotalTransitionsToFollowingActions() - $report['pageMetrics']['loops']; } @@ -178,8 +178,7 @@ class Piwik_Transitions_API $idaction, $actionType, $limitBeforeGrouping) { - $data = $this->queryInternalReferrers( - $idaction, $actionType, $archiveProcessor, $limitBeforeGrouping); + $data = $this->queryInternalReferrers($idaction, $actionType, $archiveProcessor, $limitBeforeGrouping); if ($data['pageviews'] == 0) { throw new Exception('NoDataForAction'); @@ -265,7 +264,7 @@ class Piwik_Transitions_API WHEN log_action1.type = ' . Piwik_Tracker_Action::TYPE_ACTION_URL . ' THEN log_action2.name ' /* following download or outlink: use url */ . ' ELSE log_action1.name - END AS name', + END AS `name`', 'CASE ' /* following site search */ . ' WHEN log_link_visit_action.idaction_url IS NULL THEN log_action2.type @@ -273,8 +272,8 @@ class Piwik_Transitions_API WHEN log_action1.type = ' . Piwik_Tracker_Action::TYPE_ACTION_URL . ' THEN log_action2.type ' /* following download or outlink: use url */ . ' ELSE log_action1.type - END AS type', - 'NULL AS url_prefix' + END AS `type`', + 'NULL AS `url_prefix`' ); } @@ -357,7 +356,7 @@ class Piwik_Transitions_API WHEN ' . Piwik_Common::REFERER_TYPE_SEARCH_ENGINE . ' THEN referer_keyword WHEN ' . Piwik_Common::REFERER_TYPE_WEBSITE . ' THEN referer_url WHEN ' . Piwik_Common::REFERER_TYPE_CAMPAIGN . ' THEN CONCAT(referer_name, \' \', referer_keyword) - END AS referrer_data'); + END AS `referrer_data`'); // get one limited group per referrer type $rankingQuery->partitionResultIntoMultipleGroups('referer_type', array( @@ -433,12 +432,12 @@ class Piwik_Transitions_API $selects = array( 'log_action.name', 'log_action.url_prefix', - 'CASE WHEN log_link_visit_action.idaction_' . $type . '_ref = ' . intval($idaction) . ' THEN 1 ELSE 0 END AS is_self', + 'CASE WHEN log_link_visit_action.idaction_' . $type . '_ref = ' . intval($idaction) . ' THEN 1 ELSE 0 END AS `is_self`', 'CASE WHEN log_action.type = ' . $mainActionType . ' THEN 1 WHEN log_action.type = ' . Piwik_Tracker_Action::TYPE_SITE_SEARCH . ' THEN 2 ELSE 0 - END AS action_partition' + END AS `action_partition`' ); $where = ' @@ -559,7 +558,7 @@ class Piwik_Transitions_API $idaction, $actionType, $limitBeforeGrouping) { - $data = $transitionsArchiving->queryExternalReferrers( + $data = $this->queryExternalReferrers( $idaction, $actionType, $archiveProcessor, $limitBeforeGrouping); $report['pageMetrics']['entries'] = 0; diff --git a/plugins/VisitTime/API.php b/plugins/VisitTime/API.php index dddd2431e0..29bc890664 100644 --- a/plugins/VisitTime/API.php +++ b/plugins/VisitTime/API.php @@ -62,16 +62,21 @@ class Piwik_VisitTime_API */ public function getByDayOfWeek($idSite, $period, $date, $segment = false) { + Piwik::checkUserHasViewAccess($idSite); // metrics to query $metrics = Piwik_Archive::getVisitsMetricNames(); unset($metrics[Piwik_Archive::INDEX_MAX_ACTIONS]); - // get metric data for every day within the supplied period - $oPeriod = Piwik_Period::makePeriodFromQueryParams(Piwik_Site::getTimezoneFor($idSite), $period, $date); - $dateRange = $oPeriod->getDateStart()->toString() . ',' . $oPeriod->getDateEnd()->toString(); - $archive = Piwik_Archive::build($idSite, 'day', $dateRange, $segment); + try { + // get metric data for every day within the supplied period + $oPeriod = Piwik_Period::makePeriodFromQueryParams(Piwik_Site::getTimezoneFor($idSite), $period, $date); + $dateRange = $oPeriod->getDateStart()->toString() . ',' . $oPeriod->getDateEnd()->toString(); + $archive = Piwik_Archive::build($idSite, 'day', $dateRange, $segment); + } catch(Exception $e) { + throw new Exception("getByDayOfWeek not working yet"); + } // disabled for multiple sites/dates if ( count( $archive->getParams()->getIdSites() ) > 1) { @@ -84,11 +89,11 @@ class Piwik_VisitTime_API throw new Exception("VisitTime.getByDayOfWeek does not support multiple dates."); } - //FIXMEA - throw new exception("Temporarily broken - stay tuned"); - $dataTable = $archive->getDataTableFromNumeric($metrics); + if(!($dataTable instanceof Piwik_DataTable)) { + return new Piwik_DataTable(); + } // if there's no data for this report, don't bother w/ anything else if ($dataTable->getRowsCount() == 0) { return $dataTable; @@ -102,7 +107,6 @@ class Piwik_VisitTime_API foreach (array(1, 2, 3, 4, 5, 6, 7) as $day) { $rows[] = array('label' => $day, 'nb_visits' => 0); } - $result = new Piwik_DataTable(); $result->addRowsFromSimpleArray($rows); $result->addDataTable($dataTable); -- cgit v1.2.3 From 5213ebc4b8a3987a580d7df81d27ac1fff34a740 Mon Sep 17 00:00:00 2001 From: mattab Date: Sun, 16 Jun 2013 15:03:50 +1200 Subject: Fixing build + getting the logic right in ArchiveProcessor.preProcessReport --- plugins/API/API.php | 2 +- plugins/Actions/Archiver.php | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) (limited to 'plugins') diff --git a/plugins/API/API.php b/plugins/API/API.php index 3e0431c124..2f61a80d6d 100644 --- a/plugins/API/API.php +++ b/plugins/API/API.php @@ -740,7 +740,7 @@ class Piwik_API_API /** @var Piwik_DataTable */ $dataTable = $request->process(); } catch (Exception $e) { - throw new Exception("API returned an error: " . $e->getMessage() . "\n"); + throw new Exception("API returned an error: " . $e->getMessage() . " at " . basename($e->getFile()). ":" . $e->getLine() . "\n"); } list($newReport, $columns, $rowsMetadata) = $this->handleTableReport($idSite, $dataTable, $reportMetadata, isset($reportMetadata['dimension']), $showRawMetrics); diff --git a/plugins/Actions/Archiver.php b/plugins/Actions/Archiver.php index d7e69c4eff..8ff5c5644e 100644 --- a/plugins/Actions/Archiver.php +++ b/plugins/Actions/Archiver.php @@ -571,7 +571,8 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver Piwik_Actions_ArchivingHelper::$maximumRowsInSubDataTable, Piwik_Actions_ArchivingHelper::$columnToSortByBeforeTruncation, $aggregation, - self::$invalidSummedColumnNameToRenamedNameFromPeriodArchive); + self::$invalidSummedColumnNameToRenamedNameFromPeriodArchive + ); $this->getProcessor()->archiveNumericValuesGeneral(array( self::METRIC_PAGEVIEWS_RECORD_NAME, -- cgit v1.2.3 From c1576a5e6cf303f8136e690e063c5974a526b1e0 Mon Sep 17 00:00:00 2001 From: mattab Date: Sun, 16 Jun 2013 16:17:18 +1200 Subject: Moving Log Aggregation logic to new LogAggregator object --- plugins/Actions/Archiver.php | 2 +- plugins/CustomVariables/Archiver.php | 8 +++--- plugins/Goals/Archiver.php | 6 ++--- plugins/Live/API.php | 12 ++++----- plugins/Referers/Archiver.php | 4 +-- plugins/Transitions/API.php | 52 +++++++++++++++--------------------- plugins/UserCountry/Archiver.php | 4 +-- plugins/UserSettings/Archiver.php | 4 +-- plugins/VisitTime/Archiver.php | 2 +- plugins/VisitorInterest/Archiver.php | 2 +- 10 files changed, 44 insertions(+), 52 deletions(-) (limited to 'plugins') diff --git a/plugins/Actions/Archiver.php b/plugins/Actions/Archiver.php index 8ff5c5644e..74d19c1b44 100644 --- a/plugins/Actions/Archiver.php +++ b/plugins/Actions/Archiver.php @@ -254,7 +254,7 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver // get query with segmentation - $query = $this->getProcessor()->generateQuery($select, $from, $where, $groupBy, $orderBy); + $query = $this->getLogAggregator()->generateQuery($select, $from, $where, $groupBy, $orderBy); // replace the rest of the %s $querySql = str_replace("%s", $sprintfField, $query['sql']); diff --git a/plugins/CustomVariables/Archiver.php b/plugins/CustomVariables/Archiver.php index e456178ea8..4da4af9e29 100644 --- a/plugins/CustomVariables/Archiver.php +++ b/plugins/CustomVariables/Archiver.php @@ -55,7 +55,7 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver $where = "%s.$keyField != ''"; $dimensions = array($keyField, $valueField); - $query = $this->getProcessor()->queryVisitsByDimension($dimensions, $where); + $query = $this->getLogAggregator()->queryVisitsByDimension($dimensions, $where); $this->aggregateFromVisits($query, $keyField, $valueField); // IF we query Custom Variables scope "page" either: Product SKU, Product Name, @@ -65,16 +65,16 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver if (in_array($slot, array(3,4,5))) { $additionalSelects = array( $this->getSelectAveragePrice() ); } - $query = $this->getProcessor()->queryActionsByDimension($dimensions, $where, $additionalSelects); + $query = $this->getLogAggregator()->queryActionsByDimension($dimensions, $where, $additionalSelects); $this->aggregateFromActions($query, $keyField, $valueField); - $query = $this->getProcessor()->queryConversionsByDimension($dimensions, $where); + $query = $this->getLogAggregator()->queryConversionsByDimension($dimensions, $where); $this->aggregateFromConversions($query, $keyField, $valueField); } protected function getSelectAveragePrice() { - return Piwik_ArchiveProcessor_Day::getSqlRevenue("AVG(log_link_visit_action.custom_var_v2)") + return Piwik_DataAccess_LogAggregator::getSqlRevenue("AVG(log_link_visit_action.custom_var_v2)") . " as `" . Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED . "`"; } diff --git a/plugins/Goals/Archiver.php b/plugins/Goals/Archiver.php index 009953f322..2a9660c0a8 100644 --- a/plugins/Goals/Archiver.php +++ b/plugins/Goals/Archiver.php @@ -97,7 +97,7 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver $selects = array_merge($selects, Piwik_DataAccess_LogAggregator::getSelectsFromRangedColumn($aggregateMetadata)); } - $query = $this->getProcessor()->queryConversionsByDimension(array(), false, $selects); + $query = $this->getLogAggregator()->queryConversionsByDimension(array(), false, $selects); if ($query === false) { return; } @@ -106,7 +106,7 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver $goals = new Piwik_DataArray(); $visitsToConversions = $daysToConversions = array(); - $conversionMetrics = $this->getProcessor()->getConversionsMetricFields(); + $conversionMetrics = $this->getLogAggregator()->getConversionsMetricFields(); while ($row = $query->fetch()) { $idGoal = $row['idgoal']; unset($row['idgoal']); @@ -228,7 +228,7 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver } $this->initItemReports(); foreach ($this->getItemsDimensions() as $dimension) { - $query = $this->getProcessor()->queryEcommerceItems($dimension); + $query = $this->getLogAggregator()->queryEcommerceItems($dimension); if ($query == false) { continue; } diff --git a/plugins/Live/API.php b/plugins/Live/API.php index 0f3b70b5e2..23fadd5c76 100644 --- a/plugins/Live/API.php +++ b/plugins/Live/API.php @@ -537,11 +537,11 @@ class Piwik_Live_API $sql = "SELECT case idgoal when " . Piwik_Tracker_GoalManager::IDGOAL_CART . " then '" . Piwik_Archive::LABEL_ECOMMERCE_CART . "' else '" . Piwik_Archive::LABEL_ECOMMERCE_ORDER . "' end as type, idorder as orderId, - " . Piwik_ArchiveProcessor_Day::getSqlRevenue('revenue') . " as revenue, - " . Piwik_ArchiveProcessor_Day::getSqlRevenue('revenue_subtotal') . " as revenueSubTotal, - " . Piwik_ArchiveProcessor_Day::getSqlRevenue('revenue_tax') . " as revenueTax, - " . Piwik_ArchiveProcessor_Day::getSqlRevenue('revenue_shipping') . " as revenueShipping, - " . Piwik_ArchiveProcessor_Day::getSqlRevenue('revenue_discount') . " as revenueDiscount, + " . Piwik_DataAccess_LogAggregator::getSqlRevenue('revenue') . " as revenue, + " . Piwik_DataAccess_LogAggregator::getSqlRevenue('revenue_subtotal') . " as revenueSubTotal, + " . Piwik_DataAccess_LogAggregator::getSqlRevenue('revenue_tax') . " as revenueTax, + " . Piwik_DataAccess_LogAggregator::getSqlRevenue('revenue_shipping') . " as revenueShipping, + " . Piwik_DataAccess_LogAggregator::getSqlRevenue('revenue_discount') . " as revenueDiscount, items as items, log_conversion.server_time as serverTimePretty @@ -578,7 +578,7 @@ class Piwik_Live_API log_action_sku.name as itemSKU, log_action_name.name as itemName, log_action_category.name as itemCategory, - " . Piwik_ArchiveProcessor_Day::getSqlRevenue('price') . " as price, + " . Piwik_DataAccess_LogAggregator::getSqlRevenue('price') . " as price, quantity as quantity FROM " . Piwik_Common::prefixTable('log_conversion_item') . " INNER JOIN " . Piwik_Common::prefixTable('log_action') . " AS log_action_sku diff --git a/plugins/Referers/Archiver.php b/plugins/Referers/Archiver.php index 47ce247550..914b20df81 100644 --- a/plugins/Referers/Archiver.php +++ b/plugins/Referers/Archiver.php @@ -41,10 +41,10 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver foreach ($this->getRecordNames() as $record) { $this->arrays[$record] = new Piwik_DataArray(); } - $query = $this->getProcessor()->queryVisitsByDimension(array("referer_type", "referer_name", "referer_keyword", "referer_url")); + $query = $this->getLogAggregator()->queryVisitsByDimension(array("referer_type", "referer_name", "referer_keyword", "referer_url")); $this->aggregateFromVisits($query); - $query = $this->getProcessor()->queryConversionsByDimension(array("referer_type", "referer_name", "referer_keyword")); + $query = $this->getLogAggregator()->queryConversionsByDimension(array("referer_type", "referer_name", "referer_keyword")); $this->aggregateFromConversions($query); Piwik_PostEvent('Referers.archiveDay', $this); diff --git a/plugins/Transitions/API.php b/plugins/Transitions/API.php index a18b1d6324..6d8890039b 100644 --- a/plugins/Transitions/API.php +++ b/plugins/Transitions/API.php @@ -66,7 +66,7 @@ class Piwik_Transitions_API $site = new Piwik_Site($idSite); $period = Piwik_Period::advancedFactory($period, $date); $archiveProcessor = new Piwik_ArchiveProcessor_Day($period, $site, $segment); - + $logAggregator = $archiveProcessor->getLogAggregator(); // prepare the report $report = array( 'date' => Piwik_Period_Day::advancedFactory($period->getLabel(), $date)->getLocalizedShortString() @@ -81,17 +81,14 @@ class Piwik_Transitions_API $partsArray = explode(',', $parts); if ($parts == 'all' || in_array('internalReferrers', $partsArray)) { - $this->addInternalReferrers($transitionsArchiving, $archiveProcessor, $report, $idaction, - $actionType, $limitBeforeGrouping); + $this->addInternalReferrers($logAggregator, $report, $idaction, $actionType, $limitBeforeGrouping); } if ($parts == 'all' || in_array('followingActions', $partsArray)) { $includeLoops = $parts != 'all' && !in_array('internalReferrers', $partsArray); - $this->addFollowingActions($transitionsArchiving, $archiveProcessor, $report, $idaction, - $actionType, $limitBeforeGrouping, $includeLoops); + $this->addFollowingActions($logAggregator, $report, $idaction, $actionType, $limitBeforeGrouping, $includeLoops); } if ($parts == 'all' || in_array('externalReferrers', $partsArray)) { - $this->addExternalReferrers($transitionsArchiving, $archiveProcessor, $report, $idaction, - $actionType, $limitBeforeGrouping); + $this->addExternalReferrers($logAggregator, $report, $idaction, $actionType, $limitBeforeGrouping); } // derive the number of exits from the other metrics @@ -166,19 +163,17 @@ class Piwik_Transitions_API * Add the internal referrers to the report: * previous pages and previous site searches * - * @param Piwik_Transitions $transitionsArchiving - * @param $archiveProcessor + * @param Piwik_DataAccess_LogAggregator $logAggregator * @param $report * @param $idaction * @param string $actionType * @param $limitBeforeGrouping * @throws Exception */ - private function addInternalReferrers($transitionsArchiving, $archiveProcessor, &$report, - $idaction, $actionType, $limitBeforeGrouping) + private function addInternalReferrers($logAggregator, &$report, $idaction, $actionType, $limitBeforeGrouping) { - $data = $this->queryInternalReferrers($idaction, $actionType, $archiveProcessor, $limitBeforeGrouping); + $data = $this->queryInternalReferrers($idaction, $actionType, $logAggregator, $limitBeforeGrouping); if ($data['pageviews'] == 0) { throw new Exception('NoDataForAction'); @@ -194,20 +189,18 @@ class Piwik_Transitions_API * Add the following actions to the report: * following pages, downloads, outlinks * - * @param Piwik_Transitions $transitionsArchiving - * @param $archiveProcessor + * @param Piwik_DataAccess_LogAggregator $logAggregator * @param $report * @param $idaction * @param string $actionType * @param $limitBeforeGrouping * @param boolean $includeLoops */ - private function addFollowingActions($transitionsArchiving, $archiveProcessor, &$report, - $idaction, $actionType, $limitBeforeGrouping, $includeLoops = false) + private function addFollowingActions($logAggregator, &$report, $idaction, $actionType, $limitBeforeGrouping, $includeLoops = false) { $data = $this->queryFollowingActions( - $idaction, $actionType, $archiveProcessor, $limitBeforeGrouping, $includeLoops); + $idaction, $actionType, $logAggregator, $limitBeforeGrouping, $includeLoops); foreach ($data as $tableName => $table) { $report[$tableName] = $table; @@ -221,12 +214,12 @@ class Piwik_Transitions_API * * @param $idaction * @param $actionType - * @param Piwik_ArchiveProcessor_Day $archiveProcessor + * @param Piwik_DataAccess_LogAggregator $logAggregator * @param $limitBeforeGrouping * @param $includeLoops * @return array(followingPages:Piwik_DataTable, outlinks:Piwik_DataTable, downloads:Piwik_DataTable) */ - public function queryFollowingActions($idaction, $actionType, Piwik_ArchiveProcessor_Day $archiveProcessor, + public function queryFollowingActions($idaction, $actionType, Piwik_DataAccess_LogAggregator $logAggregator, $limitBeforeGrouping = false, $includeLoops = false) { $types = array(); @@ -294,7 +287,7 @@ class Piwik_Transitions_API } $metrics = array(Piwik_Archive::INDEX_NB_ACTIONS); - $data = $archiveProcessor->queryActionsByDimension(array($dimension), $where, $selects, $metrics, $rankingQuery, $joinLogActionColumn); + $data = $logAggregator->queryActionsByDimension(array($dimension), $where, $selects, $metrics, $rankingQuery, $joinLogActionColumn); $this->totalTransitionsToFollowingActions = 0; $dataTables = array(); @@ -333,11 +326,11 @@ class Piwik_Transitions_API * * @param $idaction * @param $actionType - * @param Piwik_ArchiveProcessor_Day $archiveProcessor + * @param Piwik_ArchiveProcessor_Day $logAggregator * @param $limitBeforeGrouping * @return Piwik_DataTable */ - public function queryExternalReferrers($idaction, $actionType, $archiveProcessor, + public function queryExternalReferrers($idaction, $actionType, $logAggregator, $limitBeforeGrouping = false) { $rankingQuery = new Piwik_RankingQuery($limitBeforeGrouping ? $limitBeforeGrouping : $this->limitBeforeGrouping); @@ -370,7 +363,7 @@ class Piwik_Transitions_API $where = 'visit_entry_idaction_' . $type . ' = ' . intval($idaction); $metrics = array(Piwik_Archive::INDEX_NB_VISITS); - $data = $archiveProcessor->queryVisitsByDimension($dimensions, $where, $selects, $metrics, $rankingQuery); + $data = $logAggregator->queryVisitsByDimension($dimensions, $where, $selects, $metrics, $rankingQuery); $referrerData = array(); $referrerSubData = array(); @@ -407,11 +400,11 @@ class Piwik_Transitions_API * * @param $idaction * @param $actionType - * @param Piwik_ArchiveProcessor_Day $archiveProcessor + * @param Piwik_ArchiveProcessor_Day $logAggregator * @param $limitBeforeGrouping * @return array(previousPages:Piwik_DataTable, loops:integer) */ - protected function queryInternalReferrers($idaction, $actionType, $archiveProcessor, + protected function queryInternalReferrers($idaction, $actionType, $logAggregator, $limitBeforeGrouping = false) { $rankingQuery = new Piwik_RankingQuery($limitBeforeGrouping ? $limitBeforeGrouping : $this->limitBeforeGrouping); @@ -452,7 +445,7 @@ class Piwik_Transitions_API $joinLogActionOn = $dimension; } $metrics = array(Piwik_Archive::INDEX_NB_ACTIONS); - $data = $archiveProcessor->queryActionsByDimension(array($dimension), $where, $selects, $metrics, $rankingQuery, $joinLogActionOn); + $data = $logAggregator->queryActionsByDimension(array($dimension), $where, $selects, $metrics, $rankingQuery, $joinLogActionOn); $loops = 0; $nbPageviews = 0; @@ -547,19 +540,18 @@ class Piwik_Transitions_API * Add the external referrers to the report: * direct entries, websites, campaigns, search engines * - * @param Piwik_Transitions $transitionsArchiving - * @param $archiveProcessor + * @param Piwik_DataAccess_LogAggregator $logAggregator * @param $report * @param $idaction * @param string $actionType * @param $limitBeforeGrouping */ - private function addExternalReferrers($transitionsArchiving, $archiveProcessor, &$report, + private function addExternalReferrers($logAggregator, &$report, $idaction, $actionType, $limitBeforeGrouping) { $data = $this->queryExternalReferrers( - $idaction, $actionType, $archiveProcessor, $limitBeforeGrouping); + $idaction, $actionType, $logAggregator, $limitBeforeGrouping); $report['pageMetrics']['entries'] = 0; $report['referrers'] = array(); diff --git a/plugins/UserCountry/Archiver.php b/plugins/UserCountry/Archiver.php index 33f7d28e90..ba135474b4 100644 --- a/plugins/UserCountry/Archiver.php +++ b/plugins/UserCountry/Archiver.php @@ -52,7 +52,7 @@ class Piwik_UserCountry_Archiver extends Piwik_PluginsArchiver { $additionalSelects = array('MAX(log_visit.location_latitude) as location_latitude', 'MAX(log_visit.location_longitude) as location_longitude'); - $query = $this->getProcessor()->queryVisitsByDimension($this->dimensions, $where = false, $additionalSelects); + $query = $this->getLogAggregator()->queryVisitsByDimension($this->dimensions, $where = false, $additionalSelects); if ($query === false) { return; } @@ -101,7 +101,7 @@ class Piwik_UserCountry_Archiver extends Piwik_PluginsArchiver protected function aggregateFromConversions() { - $query = $this->getProcessor()->queryConversionsByDimension($this->dimensions); + $query = $this->getLogAggregator()->queryConversionsByDimension($this->dimensions); if ($query === false) { return; diff --git a/plugins/UserSettings/Archiver.php b/plugins/UserSettings/Archiver.php index 91df3d2c0c..5d3319f19d 100644 --- a/plugins/UserSettings/Archiver.php +++ b/plugins/UserSettings/Archiver.php @@ -108,7 +108,7 @@ class Piwik_UserSettings_Archiver extends Piwik_PluginsArchiver "sum(case log_visit.config_cookie when 1 then 1 else 0 end) as cookie" ); - $query = $this->getProcessor()->queryVisitsByDimension(array(), false, $selects, $metrics = array()); + $query = $this->getLogAggregator()->queryVisitsByDimension(array(), false, $selects, $metrics = array()); $data = $query->fetch(); $cleanRow = Piwik_DataAccess_LogAggregator::makeArrayOneColumn($data, Piwik_Archive::INDEX_NB_VISITS); $table = Piwik_DataTable::makeFromIndexedArray($cleanRow); @@ -117,7 +117,7 @@ class Piwik_UserSettings_Archiver extends Piwik_PluginsArchiver protected function aggregateByLanguage() { - $query = $this->getProcessor()->queryVisitsByDimension( array("label" => self::LANGUAGE_DIMENSION) ); + $query = $this->getLogAggregator()->queryVisitsByDimension( array("label" => self::LANGUAGE_DIMENSION) ); $languageCodes = array_keys(Piwik_Common::getLanguagesList()); $metricsByLanguage = new Piwik_DataArray(); while ($row = $query->fetch()) { diff --git a/plugins/VisitTime/Archiver.php b/plugins/VisitTime/Archiver.php index 2f11c61d2a..b695ba4558 100644 --- a/plugins/VisitTime/Archiver.php +++ b/plugins/VisitTime/Archiver.php @@ -23,7 +23,7 @@ class Piwik_VisitTime_Archiver extends Piwik_PluginsArchiver protected function aggregateByServerTime() { $array = $this->getProcessor()->getMetricsForDimension( array("label" => "HOUR(log_visit.visit_last_action_time)" )) ; - $query = $this->getProcessor()->queryConversionsByDimension( array("label" => "HOUR(log_conversion.server_time)") ); + $query = $this->getLogAggregator()->queryConversionsByDimension( array("label" => "HOUR(log_conversion.server_time)") ); if ($query === false) { return; } diff --git a/plugins/VisitorInterest/Archiver.php b/plugins/VisitorInterest/Archiver.php index 6cbeb82317..8d66c949f5 100644 --- a/plugins/VisitorInterest/Archiver.php +++ b/plugins/VisitorInterest/Archiver.php @@ -104,7 +104,7 @@ class Piwik_VisitorInterest_Archiver extends Piwik_PluginsArchiver $selectsFromRangedColumn = Piwik_DataAccess_LogAggregator::getSelectsFromRangedColumn($aggregateMetadata); $selects = array_merge( $selects, $selectsFromRangedColumn); } - $query = $this->getProcessor()->queryVisitsByDimension(array(), $where = false, $selects, array()); + $query = $this->getLogAggregator()->queryVisitsByDimension(array(), $where = false, $selects, array()); $row = $query->fetch(); foreach($prefixes as $recordName => $selectAsPrefix) { $cleanRow = Piwik_DataAccess_LogAggregator::makeArrayOneColumn($row, Piwik_Archive::INDEX_NB_VISITS, $selectAsPrefix); -- cgit v1.2.3 From 9eabefaa694c1b004b5044769a269f08f4362c7f Mon Sep 17 00:00:00 2001 From: mattab Date: Sun, 16 Jun 2013 16:31:27 +1200 Subject: LogAggregator in parent object so we can refactor the Unique Visitors "Period" query --- plugins/Actions/Archiver.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'plugins') diff --git a/plugins/Actions/Archiver.php b/plugins/Actions/Archiver.php index 74d19c1b44..def2012c15 100644 --- a/plugins/Actions/Archiver.php +++ b/plugins/Actions/Archiver.php @@ -265,7 +265,7 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver } // get result - $resultSet = $this->getProcessor()->getDb()->query($querySql, $query['bind']); + $resultSet = $this->getLogAggregator()->getDb()->query($querySql, $query['bind']); $modified = Piwik_Actions_ArchivingHelper::updateActionsTableWithRowQuery($resultSet, $sprintfField, $this->actionsTablesByType); return $modified; } -- cgit v1.2.3 From 6c7c61a77a953859b56fd1b89e36b4ccb0558587 Mon Sep 17 00:00:00 2001 From: mattab Date: Sun, 16 Jun 2013 19:57:27 +1200 Subject: Fixing test --- plugins/Goals/Controller.php | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) (limited to 'plugins') diff --git a/plugins/Goals/Controller.php b/plugins/Goals/Controller.php index 82f50a427e..687b4104f8 100644 --- a/plugins/Goals/Controller.php +++ b/plugins/Goals/Controller.php @@ -193,20 +193,14 @@ class Piwik_Goals_Controller extends Piwik_Controller $view->graphEvolution = $this->getEvolutionGraph(true, array('nb_conversions'), $idGoal); $view->nameGraphEvolution = 'GoalsgetEvolutionGraph' . $idGoal; $view->topDimensions = $this->getTopDimensions($idGoal); - - $goalsApi = Piwik_Goals_API::getInstance(); - $period = Piwik_Common::getRequestVar('period'); - $date = Piwik_Common::getRequestVar('date'); // conversion rate for new and returning visitors $segment = 'visitorType==returning,visitorType==returningCustomer'; - $conversionRateReturning = $goalsApi->getConversionRate($this->idSite, $period, $date, $segment, $idGoal); + $conversionRateReturning = Piwik_Goals_API::getInstance()->getConversionRate($this->idSite, Piwik_Common::getRequestVar('period'), Piwik_Common::getRequestVar('date'), $segment, $idGoal); $view->conversion_rate_returning = $this->formatConversionRate($conversionRateReturning); - $segment = 'visitorType==new'; - $conversionRateNew = $goalsApi->getConversionRate($this->idSite, $period, $date, $segment, $idGoal); + $conversionRateNew = Piwik_Goals_API::getInstance()->getConversionRate($this->idSite, Piwik_Common::getRequestVar('period'), Piwik_Common::getRequestVar('date'), $segment, $idGoal); $view->conversion_rate_new = $this->formatConversionRate($conversionRateNew); - $view->goalReportsByDimension = $this->getGoalReportsByDimensionTable( $view->nb_conversions, isset($ecommerce), !empty($view->cart_nb_conversions)); return $view; -- cgit v1.2.3 From 08230d28170fd9fed099954afef679df176c2683 Mon Sep 17 00:00:00 2001 From: mattab Date: Mon, 17 Jun 2013 09:23:10 +1200 Subject: Fixes #4011 --- plugins/API/API.php | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'plugins') diff --git a/plugins/API/API.php b/plugins/API/API.php index 2f61a80d6d..a0ebd31b38 100644 --- a/plugins/API/API.php +++ b/plugins/API/API.php @@ -269,6 +269,8 @@ class Piwik_API_API $segments = array(); Piwik_PostEvent('API.getSegmentsMetadata', $segments, $idSites); + $isAuthenticatedWithViewAccess = Piwik::isUserHasViewAccess($idSites) && !Piwik::isUserIsAnonymous(); + $segments[] = array( 'type' => 'dimension', 'category' => Piwik_Translate('General_Visit'), @@ -277,7 +279,7 @@ class Piwik_API_API 'acceptedValues' => '13.54.122.1, etc.', 'sqlSegment' => 'log_visit.location_ip', 'sqlFilter' => array('Piwik_IP', 'P2N'), - 'permission' => Piwik::isUserHasAdminAccess($idSites), + 'permission' => $isAuthenticatedWithViewAccess, ); $segments[] = array( 'type' => 'dimension', @@ -287,6 +289,7 @@ class Piwik_API_API 'acceptedValues' => '34c31e04394bdc63 - any 16 Hexadecimal chars ID, which can be fetched using the Tracking API function getVisitorId()', 'sqlSegment' => 'log_visit.idvisitor', 'sqlFilter' => array('Piwik_Common', 'convertVisitorIdToBin'), + 'permission' => $isAuthenticatedWithViewAccess, ); $segments[] = array( 'type' => 'metric', -- cgit v1.2.3 From 9f7b1646a9b34612d31b2058c43dca7aa9dd6a02 Mon Sep 17 00:00:00 2001 From: Timo Besenreuther Date: Mon, 17 Jun 2013 11:58:33 +0200 Subject: refs #4007 in branch 1.X, an alternative fix for this issue has been committed. revert this one in order avoid merge confusion. --- plugins/VisitsSummary/Controller.php | 2 -- 1 file changed, 2 deletions(-) (limited to 'plugins') diff --git a/plugins/VisitsSummary/Controller.php b/plugins/VisitsSummary/Controller.php index 4580fdced3..fd62d14e38 100644 --- a/plugins/VisitsSummary/Controller.php +++ b/plugins/VisitsSummary/Controller.php @@ -20,8 +20,6 @@ class Piwik_VisitsSummary_Controller extends Piwik_Controller $view = Piwik_View::factory('index'); $this->setPeriodVariablesView($view); $view->graphEvolutionVisitsSummary = $this->getEvolutionGraph(true, array('nb_visits')); - // do not use columns paramter for sparklines - unset($_GET['columns']); $this->setSparklinesAndNumbers($view); echo $view->render(); } -- cgit v1.2.3 From 1668b467375522eb83f9790e114b1a37d2a599f3 Mon Sep 17 00:00:00 2001 From: mattab Date: Tue, 18 Jun 2013 13:20:35 +1200 Subject: Commenting/cleanup new classes --- plugins/Actions/Archiver.php | 2 +- plugins/CoreAdminHome/CoreAdminHome.php | 2 +- plugins/Dashboard/Dashboard.php | 1 - plugins/Goals/Archiver.php | 2 +- 4 files changed, 3 insertions(+), 4 deletions(-) (limited to 'plugins') diff --git a/plugins/Actions/Archiver.php b/plugins/Actions/Archiver.php index def2012c15..8ac433d67a 100644 --- a/plugins/Actions/Archiver.php +++ b/plugins/Actions/Archiver.php @@ -574,7 +574,7 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver self::$invalidSummedColumnNameToRenamedNameFromPeriodArchive ); - $this->getProcessor()->archiveNumericValuesGeneral(array( + $this->getProcessor()->aggregateNumericMetrics(array( self::METRIC_PAGEVIEWS_RECORD_NAME, self::METRIC_UNIQ_PAGEVIEWS_RECORD_NAME, self::METRIC_DOWNLOADS_RECORD_NAME, diff --git a/plugins/CoreAdminHome/CoreAdminHome.php b/plugins/CoreAdminHome/CoreAdminHome.php index 4f75d274c0..ee80acceba 100644 --- a/plugins/CoreAdminHome/CoreAdminHome.php +++ b/plugins/CoreAdminHome/CoreAdminHome.php @@ -114,7 +114,7 @@ class Piwik_CoreAdminHome extends Piwik_Plugin $archiveTables = Piwik::getTablesArchivesInstalled(); foreach ($archiveTables as $table) { if (strpos($table, 'numeric') !== false) { - Piwik_ArchiveProcessor_Rules::doPurgeOutdatedArchives($table); + Piwik_ArchiveProcessor_Rules::shouldPurgeOutdatedArchives($table); } } } diff --git a/plugins/Dashboard/Dashboard.php b/plugins/Dashboard/Dashboard.php index f3db9fba6b..6d9acc8e33 100644 --- a/plugins/Dashboard/Dashboard.php +++ b/plugins/Dashboard/Dashboard.php @@ -209,7 +209,6 @@ class Piwik_Dashboard extends Piwik_Plugin $pos++; } } - } } diff --git a/plugins/Goals/Archiver.php b/plugins/Goals/Archiver.php index 2a9660c0a8..8a6b9b4582 100644 --- a/plugins/Goals/Archiver.php +++ b/plugins/Goals/Archiver.php @@ -402,7 +402,7 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver $fieldsToSum[] = self::getRecordName($metricName, $goalId); } } - $records = $this->getProcessor()->archiveNumericValuesGeneral($fieldsToSum); + $records = $this->getProcessor()->aggregateNumericMetrics($fieldsToSum); // also recording conversion_rate for each goal foreach ($goalIdsToSum as $goalId) { -- cgit v1.2.3 From 621db6a16a37374aed623f75ea8cdabdf2b8e8d0 Mon Sep 17 00:00:00 2001 From: mattab Date: Tue, 18 Jun 2013 16:14:49 +1200 Subject: Adding new Metrics class that knows about all metrics. Moving from Piwik_Archive class. Also moved some other const to Piwik class. --- plugins/API/API.php | 2 +- plugins/Actions/API.php | 47 ++++------ plugins/Actions/Archiver.php | 140 ++++++++++++++++-------------- plugins/Actions/ArchivingHelper.php | 48 +++++----- plugins/CustomVariables/API.php | 2 +- plugins/CustomVariables/Archiver.php | 12 +-- plugins/DevicesDetection/API.php | 2 +- plugins/DevicesDetection/Archiver.php | 2 +- plugins/Goals/API.php | 26 +++--- plugins/Goals/Archiver.php | 26 +++--- plugins/Goals/Controller.php | 18 ++-- plugins/Goals/Goals.php | 22 ++--- plugins/Live/API.php | 8 +- plugins/PrivacyManager/PrivacyManager.php | 2 +- plugins/Provider/API.php | 2 +- plugins/Provider/Archiver.php | 2 +- plugins/Referers/API.php | 6 +- plugins/Referers/Archiver.php | 2 +- plugins/Referers/Controller.php | 2 +- plugins/Referers/Referers.php | 2 +- plugins/Transitions/API.php | 36 ++++---- plugins/UserCountry/API.php | 2 +- plugins/UserCountry/Archiver.php | 4 +- plugins/UserSettings/API.php | 10 +-- plugins/UserSettings/Archiver.php | 4 +- plugins/VisitTime/API.php | 4 +- plugins/VisitorInterest/API.php | 8 +- plugins/VisitorInterest/Archiver.php | 2 +- 28 files changed, 222 insertions(+), 221 deletions(-) (limited to 'plugins') diff --git a/plugins/API/API.php b/plugins/API/API.php index a0ebd31b38..8bd22aa9bb 100644 --- a/plugins/API/API.php +++ b/plugins/API/API.php @@ -1353,7 +1353,7 @@ class Piwik_API_API // add "processed metrics" like actions per visit or bounce rate // note: some reports should not be filtered with AddColumnProcessedMetrics - // specifically, reports without the Piwik_Archive::INDEX_NB_VISITS metric such as Goals.getVisitsUntilConversion & Goal.getDaysToConversion + // specifically, reports without the Piwik_Metrics::INDEX_NB_VISITS metric such as Goals.getVisitsUntilConversion & Goal.getDaysToConversion // this is because the AddColumnProcessedMetrics filter removes all datable rows lacking this metric if ( diff --git a/plugins/Actions/API.php b/plugins/Actions/API.php index 1904b3b72a..56f63bdc9b 100644 --- a/plugins/Actions/API.php +++ b/plugins/Actions/API.php @@ -72,17 +72,7 @@ class Piwik_Actions_API Piwik::checkUserHasViewAccess($idSite); $archive = Piwik_Archive::build($idSite, $period, $date, $segment); - $metrics = array( - 'Actions_nb_pageviews' => 'nb_pageviews', - 'Actions_nb_uniq_pageviews' => 'nb_uniq_pageviews', - 'Actions_nb_downloads' => 'nb_downloads', - 'Actions_nb_uniq_downloads' => 'nb_uniq_downloads', - 'Actions_nb_outlinks' => 'nb_outlinks', - 'Actions_nb_uniq_outlinks' => 'nb_uniq_outlinks', - 'Actions_nb_searches' => 'nb_searches', - 'Actions_nb_keywords' => 'nb_keywords', - 'Actions_avg_time_generation' => 'avg_time_generation' - ); + $metrics = Piwik_Actions_Archiver::$actionsAggregateMetrics; // get requested columns $columns = Piwik::getArrayFromApiParameter($columns); @@ -97,26 +87,25 @@ class Piwik_Actions_API $nameReplace[$fullColumn] = $column; } - if (false !== ($avgGenerationTimeRequested = array_search('Actions_avg_time_generation', $columns))) { - unset($columns[$avgGenerationTimeRequested]); + if (false !== ($avgGenerationTimeRequested = array_search('avg_time_generation', $columns))) { $avgGenerationTimeRequested = true; } } else { // get all columns - unset($metrics['Actions_avg_time_generation']); $columns = array_keys($metrics); $nameReplace = & $metrics; $avgGenerationTimeRequested = true; } if ($avgGenerationTimeRequested) { - $tempColumns[] = 'Actions_sum_time_generation'; - $tempColumns[] = 'Actions_nb_hits_with_time_generation'; - $nameReplace['Actions_sum_time_generation'] = 'sum_time_generation'; - $nameReplace['Actions_nb_hits_with_time_generation'] = 'nb_hits_with_time_generation'; - $columns = array_merge($columns, $tempColumns); - $columns = array_unique($columns); - } + $tempColumns[] = Piwik_Actions_Archiver::METRIC_SUM_TIME_RECORD_NAME; + $tempColumns[] = Piwik_Actions_Archiver::METRIC_HITS_TIMED_RECORD_NAME; + $columns = array_merge($columns, $tempColumns); + $columns = array_unique($columns); + + $nameReplace[Piwik_Actions_Archiver::METRIC_SUM_TIME_RECORD_NAME] = 'sum_time_generation'; + $nameReplace[Piwik_Actions_Archiver::METRIC_HITS_TIMED_RECORD_NAME] = 'nb_hits_with_time_generation'; + } $table = $archive->getDataTableFromNumeric($columns); @@ -301,7 +290,7 @@ class Piwik_Actions_API public function getSiteSearchKeywords($idSite, $period, $date, $segment = false) { $dataTable = $this->getSiteSearchKeywordsRaw($idSite, $period, $date, $segment); - $dataTable->deleteColumn(Piwik_Archive::INDEX_SITE_SEARCH_HAS_NO_RESULT); + $dataTable->deleteColumn(Piwik_Metrics::INDEX_SITE_SEARCH_HAS_NO_RESULT); $this->filterPageDatatable($dataTable); $this->filterActionsDataTable($dataTable); $this->addPagesPerSearchColumn($dataTable); @@ -326,11 +315,11 @@ class Piwik_Actions_API // Delete all rows that have some results $dataTable->filter('ColumnCallbackDeleteRow', array( - Piwik_Archive::INDEX_SITE_SEARCH_HAS_NO_RESULT, + Piwik_Metrics::INDEX_SITE_SEARCH_HAS_NO_RESULT, create_function('$value', 'return $value >= 1;') )); $dataTable->deleteRow(Piwik_DataTable::ID_SUMMARY_ROW); - $dataTable->deleteColumn(Piwik_Archive::INDEX_SITE_SEARCH_HAS_NO_RESULT); + $dataTable->deleteColumn(Piwik_Metrics::INDEX_SITE_SEARCH_HAS_NO_RESULT); $this->filterPageDatatable($dataTable); $this->filterActionsDataTable($dataTable); $this->addPagesPerSearchColumn($dataTable); @@ -496,7 +485,7 @@ class Piwik_Actions_API $dataTable->queueFilter('ColumnCallbackAddColumnPercentage', array('exit_rate', 'exit_nb_visits', 'nb_visits', 0)); // Handle performance analytics - $hasTimeGeneration = (array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_SUM_TIME_GENERATION)) > 0); + $hasTimeGeneration = (array_sum($dataTable->getColumn(Piwik_Metrics::INDEX_PAGE_SUM_TIME_GENERATION)) > 0); if ($hasTimeGeneration) { // Average generation time = total generation time / number of pageviews $precisionAvgTimeGeneration = 3; @@ -506,10 +495,10 @@ class Piwik_Actions_API // No generation time: remove it from the API output and add it to empty_columns metadata, so that // the columns can also be removed from the view $dataTable->filter('ColumnDelete', array(array( - Piwik_Archive::INDEX_PAGE_SUM_TIME_GENERATION, - Piwik_Archive::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION, - Piwik_Archive::INDEX_PAGE_MIN_TIME_GENERATION, - Piwik_Archive::INDEX_PAGE_MAX_TIME_GENERATION + Piwik_Metrics::INDEX_PAGE_SUM_TIME_GENERATION, + Piwik_Metrics::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION, + Piwik_Metrics::INDEX_PAGE_MIN_TIME_GENERATION, + Piwik_Metrics::INDEX_PAGE_MAX_TIME_GENERATION ))); if ($dataTable instanceof Piwik_DataTable) { diff --git a/plugins/Actions/Archiver.php b/plugins/Actions/Archiver.php index 8ac433d67a..b677e29eec 100644 --- a/plugins/Actions/Archiver.php +++ b/plugins/Actions/Archiver.php @@ -33,6 +33,18 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver const METRIC_SEARCHES_RECORD_NAME = 'Actions_nb_searches'; const METRIC_KEYWORDS_RECORD_NAME = 'Actions_nb_keywords'; + /* Metrics in use by the API Actions.get */ + public static $actionsAggregateMetrics = array( + self::METRIC_PAGEVIEWS_RECORD_NAME => 'nb_pageviews', + self::METRIC_UNIQ_PAGEVIEWS_RECORD_NAME => 'nb_uniq_pageviews', + self::METRIC_DOWNLOADS_RECORD_NAME => 'nb_downloads', + self::METRIC_UNIQ_DOWNLOADS_RECORD_NAME => 'nb_uniq_downloads', + self::METRIC_OUTLINKS_RECORD_NAME => 'nb_outlinks', + self::METRIC_UNIQ_OUTLINKS_RECORD_NAME => 'nb_uniq_outlinks', + self::METRIC_SEARCHES_RECORD_NAME => 'nb_searches', + self::METRIC_KEYWORDS_RECORD_NAME => 'nb_keywords', + ); + public static $actionTypes = array( Piwik_Tracker_Action::TYPE_ACTION_URL, Piwik_Tracker_Action::TYPE_OUTLINK, @@ -41,18 +53,18 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver Piwik_Tracker_Action::TYPE_SITE_SEARCH, ); static protected $invalidSummedColumnNameToRenamedNameFromPeriodArchive = array( - Piwik_Archive::INDEX_NB_UNIQ_VISITORS => Piwik_Archive::INDEX_SUM_DAILY_NB_UNIQ_VISITORS, - Piwik_Archive::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS => Piwik_Archive::INDEX_PAGE_ENTRY_SUM_DAILY_NB_UNIQ_VISITORS, - Piwik_Archive::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS => Piwik_Archive::INDEX_PAGE_EXIT_SUM_DAILY_NB_UNIQ_VISITORS, + Piwik_Metrics::INDEX_NB_UNIQ_VISITORS => Piwik_Metrics::INDEX_SUM_DAILY_NB_UNIQ_VISITORS, + Piwik_Metrics::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS => Piwik_Metrics::INDEX_PAGE_ENTRY_SUM_DAILY_NB_UNIQ_VISITORS, + Piwik_Metrics::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS => Piwik_Metrics::INDEX_PAGE_EXIT_SUM_DAILY_NB_UNIQ_VISITORS, ); static protected $invalidSummedColumnNameToDeleteFromDayArchive = array( - Piwik_Archive::INDEX_NB_UNIQ_VISITORS, - Piwik_Archive::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS, - Piwik_Archive::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS, + Piwik_Metrics::INDEX_NB_UNIQ_VISITORS, + Piwik_Metrics::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS, + Piwik_Metrics::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS, ); private static $actionColumnAggregationOperations = array( - Piwik_Archive::INDEX_PAGE_MAX_TIME_GENERATION => 'max', - Piwik_Archive::INDEX_PAGE_MIN_TIME_GENERATION => 'min' + Piwik_Metrics::INDEX_PAGE_MAX_TIME_GENERATION => 'max', + Piwik_Metrics::INDEX_PAGE_MIN_TIME_GENERATION => 'min' ); protected $actionsTablesByType = null; protected $isSiteSearchEnabled = false; @@ -159,25 +171,25 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver log_action.type, log_action.idaction, log_action.url_prefix, - count(distinct log_link_visit_action.idvisit) as `" . Piwik_Archive::INDEX_NB_VISITS . "`, - count(distinct log_link_visit_action.idvisitor) as `" . Piwik_Archive::INDEX_NB_UNIQ_VISITORS . "`, - count(*) as `" . Piwik_Archive::INDEX_PAGE_NB_HITS . "`, + count(distinct log_link_visit_action.idvisit) as `" . Piwik_Metrics::INDEX_NB_VISITS . "`, + count(distinct log_link_visit_action.idvisitor) as `" . Piwik_Metrics::INDEX_NB_UNIQ_VISITORS . "`, + count(*) as `" . Piwik_Metrics::INDEX_PAGE_NB_HITS . "`, sum( case when " . Piwik_Tracker_Action::DB_COLUMN_TIME_GENERATION . " is null then 0 else " . Piwik_Tracker_Action::DB_COLUMN_TIME_GENERATION . " end - ) / 1000 as `" . Piwik_Archive::INDEX_PAGE_SUM_TIME_GENERATION . "`, + ) / 1000 as `" . Piwik_Metrics::INDEX_PAGE_SUM_TIME_GENERATION . "`, sum( case when " . Piwik_Tracker_Action::DB_COLUMN_TIME_GENERATION . " is null then 0 else 1 end - ) as `" . Piwik_Archive::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION . "`, + ) as `" . Piwik_Metrics::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION . "`, min(" . Piwik_Tracker_Action::DB_COLUMN_TIME_GENERATION . ") / 1000 - as `" . Piwik_Archive::INDEX_PAGE_MIN_TIME_GENERATION . "`, + as `" . Piwik_Metrics::INDEX_PAGE_MIN_TIME_GENERATION . "`, max(" . Piwik_Tracker_Action::DB_COLUMN_TIME_GENERATION . ") / 1000 - as `" . Piwik_Archive::INDEX_PAGE_MAX_TIME_GENERATION . "` + as `" . Piwik_Metrics::INDEX_PAGE_MAX_TIME_GENERATION . "` "; $from = array( @@ -194,23 +206,23 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver AND log_link_visit_action.%s IS NOT NULL"; $groupBy = "log_action.idaction"; - $orderBy = "`" . Piwik_Archive::INDEX_PAGE_NB_HITS . "` DESC, name ASC"; + $orderBy = "`" . Piwik_Metrics::INDEX_PAGE_NB_HITS . "` DESC, name ASC"; $rankingQuery = false; if ($rankingQueryLimit > 0) { $rankingQuery = new Piwik_RankingQuery($rankingQueryLimit); $rankingQuery->setOthersLabel(Piwik_DataTable::LABEL_SUMMARY_ROW); $rankingQuery->addLabelColumn(array('idaction', 'name')); - $rankingQuery->addColumn(array('url_prefix', Piwik_Archive::INDEX_NB_UNIQ_VISITORS)); - $rankingQuery->addColumn(array(Piwik_Archive::INDEX_PAGE_NB_HITS, Piwik_Archive::INDEX_NB_VISITS), 'sum'); + $rankingQuery->addColumn(array('url_prefix', Piwik_Metrics::INDEX_NB_UNIQ_VISITORS)); + $rankingQuery->addColumn(array(Piwik_Metrics::INDEX_PAGE_NB_HITS, Piwik_Metrics::INDEX_NB_VISITS), 'sum'); if ($this->isSiteSearchEnabled()) { - $rankingQuery->addColumn(Piwik_Archive::INDEX_SITE_SEARCH_HAS_NO_RESULT, 'min'); - $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_IS_FOLLOWING_SITE_SEARCH_NB_HITS, 'sum'); + $rankingQuery->addColumn(Piwik_Metrics::INDEX_SITE_SEARCH_HAS_NO_RESULT, 'min'); + $rankingQuery->addColumn(Piwik_Metrics::INDEX_PAGE_IS_FOLLOWING_SITE_SEARCH_NB_HITS, 'sum'); } - $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_SUM_TIME_GENERATION, 'sum'); - $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION, 'sum'); - $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_MIN_TIME_GENERATION, 'min'); - $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_MAX_TIME_GENERATION, 'max'); + $rankingQuery->addColumn(Piwik_Metrics::INDEX_PAGE_SUM_TIME_GENERATION, 'sum'); + $rankingQuery->addColumn(Piwik_Metrics::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION, 'sum'); + $rankingQuery->addColumn(Piwik_Metrics::INDEX_PAGE_MIN_TIME_GENERATION, 'min'); + $rankingQuery->addColumn(Piwik_Metrics::INDEX_PAGE_MAX_TIME_GENERATION, 'max'); $rankingQuery->partitionResultIntoMultipleGroups('type', array_keys($this->actionsTablesByType)); } @@ -219,7 +231,7 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver // 2) For each page view, count number of times the referrer page was a Site Search if ($this->isSiteSearchEnabled()) { $selectFlagNoResultKeywords = ", - CASE WHEN (MAX(log_link_visit_action.custom_var_v" . Piwik_Tracker_Action::CVAR_INDEX_SEARCH_COUNT . ") = 0 AND log_link_visit_action.custom_var_k" . Piwik_Tracker_Action::CVAR_INDEX_SEARCH_COUNT . " = '" . Piwik_Tracker_Action::CVAR_KEY_SEARCH_COUNT . "') THEN 1 ELSE 0 END AS `" . Piwik_Archive::INDEX_SITE_SEARCH_HAS_NO_RESULT . "`"; + CASE WHEN (MAX(log_link_visit_action.custom_var_v" . Piwik_Tracker_Action::CVAR_INDEX_SEARCH_COUNT . ") = 0 AND log_link_visit_action.custom_var_k" . Piwik_Tracker_Action::CVAR_INDEX_SEARCH_COUNT . " = '" . Piwik_Tracker_Action::CVAR_KEY_SEARCH_COUNT . "') THEN 1 ELSE 0 END AS `" . Piwik_Metrics::INDEX_SITE_SEARCH_HAS_NO_RESULT . "`"; //we need an extra JOIN to know whether the referrer "idaction_name_ref" was a Site Search request $from[] = array( @@ -229,7 +241,7 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver ); $selectSiteSearchFollowingPages = ", - SUM(CASE WHEN log_action_name_ref.type = " . Piwik_Tracker_Action::TYPE_SITE_SEARCH . " THEN 1 ELSE 0 END) AS `" . Piwik_Archive::INDEX_PAGE_IS_FOLLOWING_SITE_SEARCH_NB_HITS . "`"; + SUM(CASE WHEN log_action_name_ref.type = " . Piwik_Tracker_Action::TYPE_SITE_SEARCH . " THEN 1 ELSE 0 END) AS `" . Piwik_Metrics::INDEX_PAGE_IS_FOLLOWING_SITE_SEARCH_NB_HITS . "`"; $select .= $selectFlagNoResultKeywords . $selectSiteSearchFollowingPages; @@ -280,11 +292,11 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver $rankingQuery = new Piwik_RankingQuery($rankingQueryLimit); $rankingQuery->setOthersLabel(Piwik_DataTable::LABEL_SUMMARY_ROW); $rankingQuery->addLabelColumn('idaction'); - $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS); - $rankingQuery->addColumn(array(Piwik_Archive::INDEX_PAGE_ENTRY_NB_VISITS, - Piwik_Archive::INDEX_PAGE_ENTRY_NB_ACTIONS, - Piwik_Archive::INDEX_PAGE_ENTRY_SUM_VISIT_LENGTH, - Piwik_Archive::INDEX_PAGE_ENTRY_BOUNCE_COUNT), 'sum'); + $rankingQuery->addColumn(Piwik_Metrics::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS); + $rankingQuery->addColumn(array(Piwik_Metrics::INDEX_PAGE_ENTRY_NB_VISITS, + Piwik_Metrics::INDEX_PAGE_ENTRY_NB_ACTIONS, + Piwik_Metrics::INDEX_PAGE_ENTRY_SUM_VISIT_LENGTH, + Piwik_Metrics::INDEX_PAGE_ENTRY_BOUNCE_COUNT), 'sum'); $rankingQuery->partitionResultIntoMultipleGroups('type', array_keys($this->actionsTablesByType)); $extraSelects = 'log_action.type, log_action.name,'; @@ -295,7 +307,7 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver "joinOn" => "log_visit.%s = log_action.idaction" ) ); - $orderBy = "`" . Piwik_Archive::INDEX_PAGE_ENTRY_NB_ACTIONS . "` DESC, log_action.name ASC"; + $orderBy = "`" . Piwik_Metrics::INDEX_PAGE_ENTRY_NB_ACTIONS . "` DESC, log_action.name ASC"; } else { $extraSelects = false; $from = "log_visit"; @@ -303,11 +315,11 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver } $select = "log_visit.%s as idaction, $extraSelects - count(distinct log_visit.idvisitor) as `" . Piwik_Archive::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS . "`, - count(*) as `" . Piwik_Archive::INDEX_PAGE_ENTRY_NB_VISITS . "`, - sum(log_visit.visit_total_actions) as `" . Piwik_Archive::INDEX_PAGE_ENTRY_NB_ACTIONS . "`, - sum(log_visit.visit_total_time) as `" . Piwik_Archive::INDEX_PAGE_ENTRY_SUM_VISIT_LENGTH . "`, - sum(case log_visit.visit_total_actions when 1 then 1 when 0 then 1 else 0 end) as `" . Piwik_Archive::INDEX_PAGE_ENTRY_BOUNCE_COUNT . "`"; + count(distinct log_visit.idvisitor) as `" . Piwik_Metrics::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS . "`, + count(*) as `" . Piwik_Metrics::INDEX_PAGE_ENTRY_NB_VISITS . "`, + sum(log_visit.visit_total_actions) as `" . Piwik_Metrics::INDEX_PAGE_ENTRY_NB_ACTIONS . "`, + sum(log_visit.visit_total_time) as `" . Piwik_Metrics::INDEX_PAGE_ENTRY_SUM_VISIT_LENGTH . "`, + sum(case log_visit.visit_total_actions when 1 then 1 when 0 then 1 else 0 end) as `" . Piwik_Metrics::INDEX_PAGE_ENTRY_BOUNCE_COUNT . "`"; $where = "log_visit.visit_last_action_time >= ? AND log_visit.visit_last_action_time <= ? @@ -331,8 +343,8 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver $rankingQuery = new Piwik_RankingQuery($rankingQueryLimit); $rankingQuery->setOthersLabel(Piwik_DataTable::LABEL_SUMMARY_ROW); $rankingQuery->addLabelColumn('idaction'); - $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS); - $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_EXIT_NB_VISITS, 'sum'); + $rankingQuery->addColumn(Piwik_Metrics::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS); + $rankingQuery->addColumn(Piwik_Metrics::INDEX_PAGE_EXIT_NB_VISITS, 'sum'); $rankingQuery->partitionResultIntoMultipleGroups('type', array_keys($this->actionsTablesByType)); $extraSelects = 'log_action.type, log_action.name,'; @@ -343,7 +355,7 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver "joinOn" => "log_visit.%s = log_action.idaction" ) ); - $orderBy = "`" . Piwik_Archive::INDEX_PAGE_EXIT_NB_VISITS . "` DESC, log_action.name ASC"; + $orderBy = "`" . Piwik_Metrics::INDEX_PAGE_EXIT_NB_VISITS . "` DESC, log_action.name ASC"; } else { $extraSelects = false; $from = "log_visit"; @@ -351,8 +363,8 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver } $select = "log_visit.%s as idaction, $extraSelects - count(distinct log_visit.idvisitor) as `" . Piwik_Archive::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS . "`, - count(*) as `" . Piwik_Archive::INDEX_PAGE_EXIT_NB_VISITS . "`"; + count(distinct log_visit.idvisitor) as `" . Piwik_Metrics::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS . "`, + count(*) as `" . Piwik_Metrics::INDEX_PAGE_EXIT_NB_VISITS . "`"; $where = "log_visit.visit_last_action_time >= ? AND log_visit.visit_last_action_time <= ? @@ -377,10 +389,10 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver $rankingQuery = new Piwik_RankingQuery($rankingQueryLimit); $rankingQuery->setOthersLabel(Piwik_DataTable::LABEL_SUMMARY_ROW); $rankingQuery->addLabelColumn('idaction'); - $rankingQuery->addColumn(Piwik_Archive::INDEX_PAGE_SUM_TIME_SPENT, 'sum'); + $rankingQuery->addColumn(Piwik_Metrics::INDEX_PAGE_SUM_TIME_SPENT, 'sum'); $rankingQuery->partitionResultIntoMultipleGroups('type', array_keys($this->actionsTablesByType)); - $extraSelects = "log_action.type, log_action.name, count(*) as `" . Piwik_Archive::INDEX_PAGE_NB_HITS . "`,"; + $extraSelects = "log_action.type, log_action.name, count(*) as `" . Piwik_Metrics::INDEX_PAGE_NB_HITS . "`,"; $from = array( "log_link_visit_action", array( @@ -388,7 +400,7 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver "joinOn" => "log_link_visit_action.%s = log_action.idaction" ) ); - $orderBy = "`" . Piwik_Archive::INDEX_PAGE_NB_HITS . "` DESC, log_action.name ASC"; + $orderBy = "`" . Piwik_Metrics::INDEX_PAGE_NB_HITS . "` DESC, log_action.name ASC"; } else { $extraSelects = false; $from = "log_link_visit_action"; @@ -396,7 +408,7 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver } $select = "log_link_visit_action.%s as idaction, $extraSelects - sum(log_link_visit_action.time_spent_ref_action) as `" . Piwik_Archive::INDEX_PAGE_SUM_TIME_SPENT . "`"; + sum(log_link_visit_action.time_spent_ref_action) as `" . Piwik_Metrics::INDEX_PAGE_SUM_TIME_SPENT . "`"; $where = "log_link_visit_action.server_time >= ? AND log_link_visit_action.server_time <= ? @@ -431,10 +443,10 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver $this->recordDataTable($dataTable, self::PAGE_URLS_RECORD_NAME); $records = array( - self::METRIC_PAGEVIEWS_RECORD_NAME => array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS)), - self::METRIC_UNIQ_PAGEVIEWS_RECORD_NAME => array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS)), - self::METRIC_SUM_TIME_RECORD_NAME => array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_SUM_TIME_GENERATION)), - self::METRIC_HITS_TIMED_RECORD_NAME => array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION)) + self::METRIC_PAGEVIEWS_RECORD_NAME => array_sum($dataTable->getColumn(Piwik_Metrics::INDEX_PAGE_NB_HITS)), + self::METRIC_UNIQ_PAGEVIEWS_RECORD_NAME => array_sum($dataTable->getColumn(Piwik_Metrics::INDEX_NB_VISITS)), + self::METRIC_SUM_TIME_RECORD_NAME => array_sum($dataTable->getColumn(Piwik_Metrics::INDEX_PAGE_SUM_TIME_GENERATION)), + self::METRIC_HITS_TIMED_RECORD_NAME => array_sum($dataTable->getColumn(Piwik_Metrics::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION)) ); $this->getProcessor()->insertNumericRecords( $records ); } @@ -490,7 +502,7 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver { // Delete all columns that have a value of zero $dataTable->filter('ColumnDelete', array( - $columnsToRemove = array(Piwik_Archive::INDEX_PAGE_IS_FOLLOWING_SITE_SEARCH_NB_HITS), + $columnsToRemove = array(Piwik_Metrics::INDEX_PAGE_IS_FOLLOWING_SITE_SEARCH_NB_HITS), $columnsToKeep = array(), $deleteIfZeroOnly = true )); @@ -501,8 +513,8 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver $dataTable = $this->getDataTable(Piwik_Tracker_Action::TYPE_DOWNLOAD); $this->recordDataTable($dataTable, self::DOWNLOADS_RECORD_NAME); - $this->getProcessor()->insertNumericRecord(self::METRIC_DOWNLOADS_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); - $this->getProcessor()->insertNumericRecord(self::METRIC_UNIQ_DOWNLOADS_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); + $this->getProcessor()->insertNumericRecord(self::METRIC_DOWNLOADS_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Metrics::INDEX_PAGE_NB_HITS))); + $this->getProcessor()->insertNumericRecord(self::METRIC_UNIQ_DOWNLOADS_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Metrics::INDEX_NB_VISITS))); } protected function recordOutlinksReports() @@ -510,8 +522,8 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver $dataTable = $this->getDataTable(Piwik_Tracker_Action::TYPE_OUTLINK); $this->recordDataTable($dataTable, self::OUTLINKS_RECORD_NAME); - $this->getProcessor()->insertNumericRecord(self::METRIC_OUTLINKS_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS))); - $this->getProcessor()->insertNumericRecord(self::METRIC_UNIQ_OUTLINKS_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); + $this->getProcessor()->insertNumericRecord(self::METRIC_OUTLINKS_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Metrics::INDEX_PAGE_NB_HITS))); + $this->getProcessor()->insertNumericRecord(self::METRIC_UNIQ_OUTLINKS_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Metrics::INDEX_NB_VISITS))); } protected function recordPageTitlesReports() @@ -526,21 +538,21 @@ class Piwik_Actions_Archiver extends Piwik_PluginsArchiver $this->deleteUnusedColumnsFromKeywordsDataTable($dataTable); $this->recordDataTable($dataTable, self::SITE_SEARCH_RECORD_NAME); - $this->getProcessor()->insertNumericRecord(self::METRIC_SEARCHES_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS))); + $this->getProcessor()->insertNumericRecord(self::METRIC_SEARCHES_RECORD_NAME, array_sum($dataTable->getColumn(Piwik_Metrics::INDEX_NB_VISITS))); $this->getProcessor()->insertNumericRecord(self::METRIC_KEYWORDS_RECORD_NAME, $dataTable->getRowsCount()); } protected function deleteUnusedColumnsFromKeywordsDataTable($dataTable) { $columnsToDelete = array( - Piwik_Archive::INDEX_NB_UNIQ_VISITORS, - Piwik_Archive::INDEX_PAGE_IS_FOLLOWING_SITE_SEARCH_NB_HITS, - Piwik_Archive::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS, - Piwik_Archive::INDEX_PAGE_ENTRY_NB_ACTIONS, - Piwik_Archive::INDEX_PAGE_ENTRY_SUM_VISIT_LENGTH, - Piwik_Archive::INDEX_PAGE_ENTRY_NB_VISITS, - Piwik_Archive::INDEX_PAGE_ENTRY_BOUNCE_COUNT, - Piwik_Archive::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS, + Piwik_Metrics::INDEX_NB_UNIQ_VISITORS, + Piwik_Metrics::INDEX_PAGE_IS_FOLLOWING_SITE_SEARCH_NB_HITS, + Piwik_Metrics::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS, + Piwik_Metrics::INDEX_PAGE_ENTRY_NB_ACTIONS, + Piwik_Metrics::INDEX_PAGE_ENTRY_SUM_VISIT_LENGTH, + Piwik_Metrics::INDEX_PAGE_ENTRY_NB_VISITS, + Piwik_Metrics::INDEX_PAGE_ENTRY_BOUNCE_COUNT, + Piwik_Metrics::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS, ); $dataTable->deleteColumns($columnsToDelete); } diff --git a/plugins/Actions/ArchivingHelper.php b/plugins/Actions/ArchivingHelper.php index 170e7c84f1..0f7744522c 100644 --- a/plugins/Actions/ArchivingHelper.php +++ b/plugins/Actions/ArchivingHelper.php @@ -42,7 +42,7 @@ class Piwik_Actions_ArchivingHelper } if ($row['type'] != Piwik_Tracker_Action::TYPE_SITE_SEARCH) { - unset($row[Piwik_Archive::INDEX_SITE_SEARCH_HAS_NO_RESULT]); + unset($row[Piwik_Metrics::INDEX_SITE_SEARCH_HAS_NO_RESULT]); } // This will appear as in the API, which is actually very important to keep @@ -100,15 +100,15 @@ class Piwik_Actions_ArchivingHelper && !$actionRow->isSummaryRow() ) { if (($existingUrl = $actionRow->getMetadata('url')) !== false) { - if (!empty($row[Piwik_Archive::INDEX_PAGE_NB_HITS]) - && $row[Piwik_Archive::INDEX_PAGE_NB_HITS] > $actionRow->maxVisitsSummed + if (!empty($row[Piwik_Metrics::INDEX_PAGE_NB_HITS]) + && $row[Piwik_Metrics::INDEX_PAGE_NB_HITS] > $actionRow->maxVisitsSummed ) { $actionRow->setMetadata('url', $url); - $actionRow->maxVisitsSummed = $row[Piwik_Archive::INDEX_PAGE_NB_HITS]; + $actionRow->maxVisitsSummed = $row[Piwik_Metrics::INDEX_PAGE_NB_HITS]; } } else { $actionRow->setMetadata('url', $url); - $actionRow->maxVisitsSummed = !empty($row[Piwik_Archive::INDEX_PAGE_NB_HITS]) ? $row[Piwik_Archive::INDEX_PAGE_NB_HITS] : 0; + $actionRow->maxVisitsSummed = !empty($row[Piwik_Metrics::INDEX_PAGE_NB_HITS]) ? $row[Piwik_Metrics::INDEX_PAGE_NB_HITS] : 0; } } @@ -116,17 +116,17 @@ class Piwik_Actions_ArchivingHelper && $row['type'] != Piwik_Tracker_Action::TYPE_ACTION_NAME ) { // only keep performance metrics when they're used (i.e. for URLs and page titles) - if (array_key_exists(Piwik_Archive::INDEX_PAGE_SUM_TIME_GENERATION, $row)) { - unset($row[Piwik_Archive::INDEX_PAGE_SUM_TIME_GENERATION]); + if (array_key_exists(Piwik_Metrics::INDEX_PAGE_SUM_TIME_GENERATION, $row)) { + unset($row[Piwik_Metrics::INDEX_PAGE_SUM_TIME_GENERATION]); } - if (array_key_exists(Piwik_Archive::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION, $row)) { - unset($row[Piwik_Archive::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION]); + if (array_key_exists(Piwik_Metrics::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION, $row)) { + unset($row[Piwik_Metrics::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION]); } - if (array_key_exists(Piwik_Archive::INDEX_PAGE_MIN_TIME_GENERATION, $row)) { - unset($row[Piwik_Archive::INDEX_PAGE_MIN_TIME_GENERATION]); + if (array_key_exists(Piwik_Metrics::INDEX_PAGE_MIN_TIME_GENERATION, $row)) { + unset($row[Piwik_Metrics::INDEX_PAGE_MIN_TIME_GENERATION]); } - if (array_key_exists(Piwik_Archive::INDEX_PAGE_MAX_TIME_GENERATION, $row)) { - unset($row[Piwik_Archive::INDEX_PAGE_MAX_TIME_GENERATION]); + if (array_key_exists(Piwik_Metrics::INDEX_PAGE_MAX_TIME_GENERATION, $row)) { + unset($row[Piwik_Metrics::INDEX_PAGE_MAX_TIME_GENERATION]); } } @@ -150,7 +150,7 @@ class Piwik_Actions_ArchivingHelper // if the exit_action was not recorded properly in the log_link_visit_action // there would be an error message when getting the nb_hits column // we must fake the record and add the columns - if ($actionRow->getColumn(Piwik_Archive::INDEX_PAGE_NB_HITS) === false) { + if ($actionRow->getColumn(Piwik_Metrics::INDEX_PAGE_NB_HITS) === false) { // to test this code: delete the entries in log_link_action_visit for // a given exit_idaction_url foreach (self::getDefaultRow()->getColumns() as $name => $value) { @@ -173,7 +173,7 @@ class Piwik_Actions_ArchivingHelper */ private static function getColumnValuesMerged($columnName, $alreadyValue, $value) { - if ($columnName == Piwik_Archive::INDEX_PAGE_MIN_TIME_GENERATION) { + if ($columnName == Piwik_Metrics::INDEX_PAGE_MIN_TIME_GENERATION) { if (empty($alreadyValue)) { $newValue = $value; } else if (empty($value)) { @@ -183,7 +183,7 @@ class Piwik_Actions_ArchivingHelper } return $newValue; } - if ($columnName == Piwik_Archive::INDEX_PAGE_MAX_TIME_GENERATION) { + if ($columnName == Piwik_Metrics::INDEX_PAGE_MAX_TIME_GENERATION) { $newValue = max($alreadyValue, $value); return $newValue; } @@ -214,7 +214,7 @@ class Piwik_Actions_ArchivingHelper } self::$defaultActionName = Piwik_Config::getInstance()->General['action_default_name']; - self::$columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; + self::$columnToSortByBeforeTruncation = Piwik_Metrics::INDEX_NB_VISITS; self::$maximumRowsInDataTableLevelZero = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_actions']; self::$maximumRowsInSubDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_subtable_actions']; @@ -238,9 +238,9 @@ class Piwik_Actions_ArchivingHelper // so we add this fake row information to make sure there is a nb_hits, etc. column for every action $row = new Piwik_DataTable_Row(array( Piwik_DataTable_Row::COLUMNS => array( - Piwik_Archive::INDEX_NB_VISITS => 1, - Piwik_Archive::INDEX_NB_UNIQ_VISITORS => 1, - Piwik_Archive::INDEX_PAGE_NB_HITS => 1, + Piwik_Metrics::INDEX_NB_VISITS => 1, + Piwik_Metrics::INDEX_NB_UNIQ_VISITORS => 1, + Piwik_Metrics::INDEX_PAGE_NB_HITS => 1, ))); } return $row; @@ -485,10 +485,10 @@ class Piwik_Actions_ArchivingHelper */ private static function getDefaultRowColumns() { - return array(Piwik_Archive::INDEX_NB_VISITS => 0, - Piwik_Archive::INDEX_NB_UNIQ_VISITORS => 0, - Piwik_Archive::INDEX_PAGE_NB_HITS => 0, - Piwik_Archive::INDEX_PAGE_SUM_TIME_SPENT => 0); + return array(Piwik_Metrics::INDEX_NB_VISITS => 0, + Piwik_Metrics::INDEX_NB_UNIQ_VISITORS => 0, + Piwik_Metrics::INDEX_PAGE_NB_HITS => 0, + Piwik_Metrics::INDEX_PAGE_SUM_TIME_SPENT => 0); } /** diff --git a/plugins/CustomVariables/API.php b/plugins/CustomVariables/API.php index 96d05c4c30..338eb6d74a 100644 --- a/plugins/CustomVariables/API.php +++ b/plugins/CustomVariables/API.php @@ -42,7 +42,7 @@ class Piwik_CustomVariables_API protected function getDataTable($idSite, $period, $date, $segment, $expanded, $idSubtable) { $dataTable = Piwik_Archive::getDataTableFromArchive(Piwik_CustomVariables_Archiver::CUSTOM_VARIABLE_RECORD_NAME, $idSite, $period, $date, $segment, $expanded, $idSubtable); - $dataTable->filter('Sort', array(Piwik_Archive::INDEX_NB_ACTIONS, 'desc', $naturalSort = false, $expanded)); + $dataTable->filter('Sort', array(Piwik_Metrics::INDEX_NB_ACTIONS, 'desc', $naturalSort = false, $expanded)); $dataTable->queueFilter('ReplaceColumnNames'); $dataTable->queueFilter('ColumnDelete', 'nb_uniq_visitors'); return $dataTable; diff --git a/plugins/CustomVariables/Archiver.php b/plugins/CustomVariables/Archiver.php index 4da4af9e29..4b63845215 100644 --- a/plugins/CustomVariables/Archiver.php +++ b/plugins/CustomVariables/Archiver.php @@ -42,7 +42,7 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver $table = $this->getProcessor()->getDataTableFromDataArray($this->dataArray); $blob = $table->getSerialized( $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, - $columnToSort = Piwik_Archive::INDEX_NB_VISITS + $columnToSort = Piwik_Metrics::INDEX_NB_VISITS ); $this->getProcessor()->insertBlobRecord(self::CUSTOM_VARIABLE_RECORD_NAME, $blob); @@ -75,7 +75,7 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver protected function getSelectAveragePrice() { return Piwik_DataAccess_LogAggregator::getSqlRevenue("AVG(log_link_visit_action.custom_var_v2)") - . " as `" . Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED . "`"; + . " as `" . Piwik_Metrics::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED . "`"; } protected function aggregateFromVisits($query, $keyField, $valueField) @@ -150,7 +150,7 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver if ($this->isReservedKey($key)) { // Price tracking on Ecommerce product/category pages: // the average is returned from the SQL query so the price is not "summed" like other metrics - $index = Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED; + $index = Piwik_Metrics::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED; if (!empty($row[$index])) { $this->dataArray->setRowColumnPivot($key, $value, $index, (float)$row[$index]); } @@ -183,8 +183,8 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver if (!self::isReservedKey($key) && Piwik_DataArray::isRowActions($row) ) { - unset($row[Piwik_Archive::INDEX_NB_UNIQ_VISITORS]); - unset($row[Piwik_Archive::INDEX_NB_VISITS]); + unset($row[Piwik_Metrics::INDEX_NB_UNIQ_VISITORS]); + unset($row[Piwik_Metrics::INDEX_NB_VISITS]); } } } @@ -193,6 +193,6 @@ class Piwik_CustomVariables_Archiver extends Piwik_PluginsArchiver { $nameToCount = $this->getProcessor()->aggregateDataTableReports( self::CUSTOM_VARIABLE_RECORD_NAME, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, - $columnToSort = Piwik_Archive::INDEX_NB_VISITS); + $columnToSort = Piwik_Metrics::INDEX_NB_VISITS); } } \ No newline at end of file diff --git a/plugins/DevicesDetection/API.php b/plugins/DevicesDetection/API.php index c6572f28ad..e3e7100328 100644 --- a/plugins/DevicesDetection/API.php +++ b/plugins/DevicesDetection/API.php @@ -39,7 +39,7 @@ class Piwik_DevicesDetection_API Piwik::checkUserHasViewAccess($idSite); $archive = Piwik_Archive::build($idSite, $period, $date, $segment); $dataTable = $archive->getDataTable($name); - $dataTable->filter('Sort', array(Piwik_Archive::INDEX_NB_VISITS)); + $dataTable->filter('Sort', array(Piwik_Metrics::INDEX_NB_VISITS)); $dataTable->queueFilter('ReplaceColumnNames'); $dataTable->queueFilter('ReplaceSummaryRowLabel'); return $dataTable; diff --git a/plugins/DevicesDetection/Archiver.php b/plugins/DevicesDetection/Archiver.php index 4d74e28ca2..5b8114e412 100644 --- a/plugins/DevicesDetection/Archiver.php +++ b/plugins/DevicesDetection/Archiver.php @@ -42,7 +42,7 @@ class Piwik_DevicesDetection_Archiver extends Piwik_PluginsArchiver { $metrics = $this->getProcessor()->getMetricsForDimension($labelSQL); $table = $this->getProcessor()->getDataTableFromDataArray($metrics); - $this->getProcessor()->insertBlobRecord($recordName, $table->getSerialized($this->maximumRows, null, Piwik_Archive::INDEX_NB_VISITS)); + $this->getProcessor()->insertBlobRecord($recordName, $table->getSerialized($this->maximumRows, null, Piwik_Metrics::INDEX_NB_VISITS)); } public function archivePeriod() diff --git a/plugins/Goals/API.php b/plugins/Goals/API.php index 18528e4b18..35563a7ed5 100644 --- a/plugins/Goals/API.php +++ b/plugins/Goals/API.php @@ -211,14 +211,14 @@ class Piwik_Goals_API $archive = Piwik_Archive::build($idSite, $period, $date); $dataTable = $archive->getDataTable($recordNameFinal); - $dataTable->filter('Sort', array(Piwik_Archive::INDEX_ECOMMERCE_ITEM_REVENUE)); + $dataTable->filter('Sort', array(Piwik_Metrics::INDEX_ECOMMERCE_ITEM_REVENUE)); $dataTable->queueFilter('ReplaceColumnNames'); $dataTable->queueFilter('ReplaceSummaryRowLabel'); $ordersColumn = 'orders'; if ($abandonedCarts) { $ordersColumn = 'abandoned_carts'; - $dataTable->renameColumn(Piwik_Archive::INDEX_ECOMMERCE_ORDERS, $ordersColumn); + $dataTable->renameColumn(Piwik_Metrics::INDEX_ECOMMERCE_ORDERS, $ordersColumn); } // Average price = sum product revenue / quantity @@ -304,15 +304,15 @@ class Piwik_Goals_API // If there is not already a 'sum price' for this product $rowFound = $dataTable->getRowFromLabel($rowView->getColumn('label')); $price = $rowFound - ? $rowFound->getColumn(Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE) + ? $rowFound->getColumn(Piwik_Metrics::INDEX_ECOMMERCE_ITEM_PRICE) : false; if (empty($price)) { // If a price was tracked on the product page - if ($rowView->getColumn(Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED)) { - $rowView->renameColumn(Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED, 'avg_price'); + if ($rowView->getColumn(Piwik_Metrics::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED)) { + $rowView->renameColumn(Piwik_Metrics::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED, 'avg_price'); } } - $rowView->deleteColumn(Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED); + $rowView->deleteColumn(Piwik_Metrics::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED); } $dataTable->addDataTable($ecommerceViews); @@ -338,17 +338,17 @@ class Piwik_Goals_API * their integer equivalents. * * Checks for the following values: - * Piwik_Archive::LABEL_ECOMMERCE_ORDER - * Piwik_Archive::LABEL_ECOMMERCE_CART + * Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER + * Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_CART * * @param string|int $idGoal The goal id as an integer or a special string. * @return int The numeric goal id. */ protected static function convertSpecialGoalIds($idGoal) { - if ($idGoal == Piwik_Archive::LABEL_ECOMMERCE_ORDER) { + if ($idGoal == Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER) { return Piwik_Tracker_GoalManager::IDGOAL_ORDER; - } else if ($idGoal == Piwik_Archive::LABEL_ECOMMERCE_CART) { + } else if ($idGoal == Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_CART) { return Piwik_Tracker_GoalManager::IDGOAL_CART; } else { return $idGoal; @@ -377,12 +377,12 @@ class Piwik_Goals_API if (empty($columns)) { $columns = Piwik_Goals::getGoalColumns($idGoal); - if ($idGoal == Piwik_Archive::LABEL_ECOMMERCE_ORDER) { + if ($idGoal == Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER) { $columns[] = 'avg_order_revenue'; } } if (in_array('avg_order_revenue', $columns) - && $idGoal == Piwik_Archive::LABEL_ECOMMERCE_ORDER + && $idGoal == Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER ) { $columns[] = 'nb_conversions'; $columns[] = 'revenue'; @@ -398,7 +398,7 @@ class Piwik_Goals_API foreach ($columnsToSelect as $id => $oldName) { $dataTable->renameColumn($oldName, $columns[$id]); } - if ($idGoal == Piwik_Archive::LABEL_ECOMMERCE_ORDER) { + if ($idGoal == Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER) { if ($dataTable instanceof Piwik_DataTable_Array) { foreach ($dataTable->getArray() as $row) { $this->enrichTable($row); diff --git a/plugins/Goals/Archiver.php b/plugins/Goals/Archiver.php index 8a6b9b4582..425a7050b9 100644 --- a/plugins/Goals/Archiver.php +++ b/plugins/Goals/Archiver.php @@ -121,20 +121,20 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver if (empty($visitsToConversions[$idGoal])) { $visitsToConversions[$idGoal] = new Piwik_DataTable(); } - $array = Piwik_DataAccess_LogAggregator::makeArrayOneColumn($row, Piwik_Archive::INDEX_NB_CONVERSIONS, $prefixes[self::VISITS_UNTIL_RECORD_NAME]); + $array = Piwik_DataAccess_LogAggregator::makeArrayOneColumn($row, Piwik_Metrics::INDEX_NB_CONVERSIONS, $prefixes[self::VISITS_UNTIL_RECORD_NAME]); $visitsToConversions[$idGoal]->addDataTable(Piwik_DataTable::makeFromIndexedArray($array)); if (empty($daysToConversions[$idGoal])) { $daysToConversions[$idGoal] = new Piwik_DataTable(); } - $array = Piwik_DataAccess_LogAggregator::makeArrayOneColumn($row, Piwik_Archive::INDEX_NB_CONVERSIONS, $prefixes[self::DAYS_UNTIL_CONV_RECORD_NAME]); + $array = Piwik_DataAccess_LogAggregator::makeArrayOneColumn($row, Piwik_Metrics::INDEX_NB_CONVERSIONS, $prefixes[self::DAYS_UNTIL_CONV_RECORD_NAME]); $daysToConversions[$idGoal]->addDataTable(Piwik_DataTable::makeFromIndexedArray($array)); // We don't want to sum Abandoned cart metrics in the overall revenue/conversions/converted visits // since it is a "negative conversion" if ($idGoal != Piwik_Tracker_GoalManager::IDGOAL_CART) { - $totalConversions += $row[Piwik_Archive::INDEX_GOAL_NB_CONVERSIONS]; - $totalRevenue += $row[Piwik_Archive::INDEX_GOAL_REVENUE]; + $totalConversions += $row[Piwik_Metrics::INDEX_GOAL_NB_CONVERSIONS]; + $totalRevenue += $row[Piwik_Metrics::INDEX_GOAL_REVENUE]; } } @@ -162,12 +162,12 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver $goals = $goals->getDataArray(); foreach ($goals as $idGoal => $array) { foreach ($array as $metricId => $value) { - $metricName = Piwik_Archive::$mappingFromIdToNameGoal[$metricId]; + $metricName = Piwik_Metrics::$mappingFromIdToNameGoal[$metricId]; $recordName = self::getRecordName($metricName, $idGoal); $numericRecords[$recordName] = $value; } - if(!empty($array[Piwik_Archive::INDEX_GOAL_NB_VISITS_CONVERTED])) { - $conversion_rate = $this->getConversionRate($array[Piwik_Archive::INDEX_GOAL_NB_VISITS_CONVERTED]); + if(!empty($array[Piwik_Metrics::INDEX_GOAL_NB_VISITS_CONVERTED])) { + $conversion_rate = $this->getConversionRate($array[Piwik_Metrics::INDEX_GOAL_NB_VISITS_CONVERTED]); $recordName = self::getRecordName('conversion_rate', $idGoal); $numericRecords[$recordName] = $conversion_rate; } @@ -330,10 +330,10 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver if ($row['ecommerceType'] == Piwik_Tracker_GoalManager::IDGOAL_CART) { // abandoned carts are the numner of visits with an abandoned cart - $row[Piwik_Archive::INDEX_ECOMMERCE_ORDERS] = $row[Piwik_Archive::INDEX_NB_VISITS]; + $row[Piwik_Metrics::INDEX_ECOMMERCE_ORDERS] = $row[Piwik_Metrics::INDEX_NB_VISITS]; } - unset($row[Piwik_Archive::INDEX_NB_VISITS]); + unset($row[Piwik_Metrics::INDEX_NB_VISITS]); unset($row['label']); unset($row['ecommerceType']); @@ -343,10 +343,10 @@ class Piwik_Goals_Archiver extends Piwik_PluginsArchiver protected function roundColumnValues(&$row) { $columnsToRound = array( - Piwik_Archive::INDEX_ECOMMERCE_ITEM_REVENUE, - Piwik_Archive::INDEX_ECOMMERCE_ITEM_QUANTITY, - Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE, - Piwik_Archive::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED, + Piwik_Metrics::INDEX_ECOMMERCE_ITEM_REVENUE, + Piwik_Metrics::INDEX_ECOMMERCE_ITEM_QUANTITY, + Piwik_Metrics::INDEX_ECOMMERCE_ITEM_PRICE, + Piwik_Metrics::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED, ); foreach ($columnsToRound as $column) { if (isset($row[$column]) diff --git a/plugins/Goals/Controller.php b/plugins/Goals/Controller.php index 687b4104f8..ce4f9a1725 100644 --- a/plugins/Goals/Controller.php +++ b/plugins/Goals/Controller.php @@ -77,7 +77,7 @@ class Piwik_Goals_Controller extends Piwik_Controller throw new Exception("Ecommerce Tracking requires that the plugin Custom Variables is enabled. Please enable the plugin CustomVariables (or ask your admin)."); } - $view = $this->getGoalReportView($idGoal = Piwik_Archive::LABEL_ECOMMERCE_ORDER); + $view = $this->getGoalReportView($idGoal = Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER); $view->displayFullReport = true; echo $view->render(); } @@ -165,7 +165,7 @@ class Piwik_Goals_Controller extends Piwik_Controller protected function getGoalReportView($idGoal = false) { $view = Piwik_View::factory('single_goal'); - if ($idGoal == Piwik_Archive::LABEL_ECOMMERCE_ORDER) { + if ($idGoal == Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER) { $goalDefinition['name'] = Piwik_Translate('Goals_Ecommerce'); $goalDefinition['allow_multiple'] = true; $ecommerce = $view->ecommerce = true; @@ -180,8 +180,8 @@ class Piwik_Goals_Controller extends Piwik_Controller foreach ($goal as $name => $value) { $view->$name = $value; } - if ($idGoal == Piwik_Archive::LABEL_ECOMMERCE_ORDER) { - $goal = $this->getMetricsForGoal(Piwik_Archive::LABEL_ECOMMERCE_CART); + if ($idGoal == Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER) { + $goal = $this->getMetricsForGoal(Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_CART); foreach ($goal as $name => $value) { $name = 'cart_' . $name; $view->$name = $value; @@ -313,9 +313,9 @@ class Piwik_Goals_Controller extends Piwik_Controller $view->setParametersToModify(array('idGoal' => $idGoal)); $nameToLabel = $this->goalColumnNameToLabel; - if ($idGoal == Piwik_Archive::LABEL_ECOMMERCE_ORDER) { + if ($idGoal == Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER) { $nameToLabel['nb_conversions'] = 'General_EcommerceOrders'; - } elseif ($idGoal == Piwik_Archive::LABEL_ECOMMERCE_CART) { + } elseif ($idGoal == Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_CART) { $nameToLabel['nb_conversions'] = Piwik_Translate('General_VisitsWith', Piwik_Translate('Goals_AbandonedCart')); $nameToLabel['conversion_rate'] = $nameToLabel['nb_conversions']; $nameToLabel['revenue'] = Piwik_Translate('Goals_LeftInCart', Piwik_Translate('Goals_ColumnRevenue')); @@ -433,7 +433,7 @@ class Piwik_Goals_Controller extends Piwik_Controller 'urlSparklineConversionRate' => $this->getUrlSparkline('getEvolutionGraph', array('columns' => array('conversion_rate'), 'idGoal' => $idGoal)), 'urlSparklineRevenue' => $this->getUrlSparkline('getEvolutionGraph', array('columns' => array('revenue'), 'idGoal' => $idGoal)), ); - if ($idGoal == Piwik_Archive::LABEL_ECOMMERCE_ORDER) { + if ($idGoal == Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER) { $items = $dataRow->getColumn('items'); $aov = $dataRow->getColumn('avg_order_revenue'); $return = array_merge($return, array( @@ -561,7 +561,7 @@ class Piwik_ViewDataTable_HtmlTable_EcommerceOrder extends Piwik_ViewDataTable_H { protected function getViewDataTableId() { - return Piwik_Archive::LABEL_ECOMMERCE_ORDER; + return Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER; } } @@ -569,6 +569,6 @@ class Piwik_ViewDataTable_HtmlTable_EcommerceAbandonedCart extends Piwik_ViewDat { protected function getViewDataTableId() { - return Piwik_Archive::LABEL_ECOMMERCE_CART; + return Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_CART; } } diff --git a/plugins/Goals/Goals.php b/plugins/Goals/Goals.php index a813b8f010..44ce98e440 100644 --- a/plugins/Goals/Goals.php +++ b/plugins/Goals/Goals.php @@ -239,7 +239,7 @@ class Piwik_Goals extends Piwik_Plugin 'name' => Piwik_Translate('General_EcommerceOrders'), 'module' => 'Goals', 'action' => 'get', - 'parameters' => array('idGoal' => Piwik_Archive::LABEL_ECOMMERCE_ORDER), + 'parameters' => array('idGoal' => Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER), 'metrics' => $ecommerceMetrics, 'processedMetrics' => false, 'order' => 10 @@ -252,7 +252,7 @@ class Piwik_Goals extends Piwik_Plugin 'dimension' => Piwik_Translate('Goals_VisitsUntilConv'), 'constantRowsCount' => true, 'metrics' => $conversionReportMetrics, - 'parameters' => array('idGoal' => Piwik_Archive::LABEL_ECOMMERCE_ORDER), + 'parameters' => array('idGoal' => Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER), 'order' => 11 ); $reports[] = array( @@ -263,7 +263,7 @@ class Piwik_Goals extends Piwik_Plugin 'dimension' => Piwik_Translate('Goals_DaysToConv'), 'constantRowsCount' => true, 'metrics' => $conversionReportMetrics, - 'parameters' => array('idGoal' => Piwik_Archive::LABEL_ECOMMERCE_ORDER), + 'parameters' => array('idGoal' => Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER), 'order' => 12 ); @@ -280,7 +280,7 @@ class Piwik_Goals extends Piwik_Plugin 'name' => Piwik_Translate('General_AbandonedCarts'), 'module' => 'Goals', 'action' => 'get', - 'parameters' => array('idGoal' => Piwik_Archive::LABEL_ECOMMERCE_CART), + 'parameters' => array('idGoal' => Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_CART), 'metrics' => $abandonedCartMetrics, 'processedMetrics' => false, 'order' => 15 @@ -294,7 +294,7 @@ class Piwik_Goals extends Piwik_Plugin 'dimension' => Piwik_Translate('Goals_VisitsUntilConv'), 'constantRowsCount' => true, 'metrics' => $conversionReportMetrics, - 'parameters' => array('idGoal' => Piwik_Archive::LABEL_ECOMMERCE_CART), + 'parameters' => array('idGoal' => Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_CART), 'order' => 20 ); $reports[] = array( @@ -305,7 +305,7 @@ class Piwik_Goals extends Piwik_Plugin 'dimension' => Piwik_Translate('Goals_DaysToConv'), 'constantRowsCount' => true, 'metrics' => $conversionReportMetrics, - 'parameters' => array('idGoal' => Piwik_Archive::LABEL_ECOMMERCE_CART), + 'parameters' => array('idGoal' => Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_CART), 'order' => 25 ); @@ -440,7 +440,7 @@ class Piwik_Goals extends Piwik_Plugin // Ecommerce widgets $site = new Piwik_Site($idSite); if ($site->isEcommerceEnabled()) { - Piwik_AddWidget('Goals_Ecommerce', 'Goals_EcommerceOverview', 'Goals', 'widgetGoalReport', array('idGoal' => Piwik_Archive::LABEL_ECOMMERCE_ORDER)); + Piwik_AddWidget('Goals_Ecommerce', 'Goals_EcommerceOverview', 'Goals', 'widgetGoalReport', array('idGoal' => Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER)); Piwik_AddWidget('Goals_Ecommerce', 'Goals_EcommerceLog', 'Goals', 'getEcommerceLog'); foreach ($this->ecommerceReports as $widget) { Piwik_AddWidget('Goals_Ecommerce', $widget[0], $widget[1], $widget[2]); @@ -467,23 +467,23 @@ class Piwik_Goals extends Piwik_Plugin Piwik_AddMenu($mainGoalMenu, '', array( 'module' => 'Goals', 'action' => ($site->isEcommerceEnabled() ? 'ecommerceReport' : 'addNewGoal'), - 'idGoal' => ($site->isEcommerceEnabled() ? Piwik_Archive::LABEL_ECOMMERCE_ORDER : null)), + 'idGoal' => ($site->isEcommerceEnabled() ? Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER : null)), true, 25); if ($site->isEcommerceEnabled()) { - Piwik_AddMenu($mainGoalMenu, 'Goals_Ecommerce', array('module' => 'Goals', 'action' => 'ecommerceReport', 'idGoal' => Piwik_Archive::LABEL_ECOMMERCE_ORDER), true, 1); + Piwik_AddMenu($mainGoalMenu, 'Goals_Ecommerce', array('module' => 'Goals', 'action' => 'ecommerceReport', 'idGoal' => Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER), true, 1); } Piwik_AddMenu($mainGoalMenu, 'Goals_AddNewGoal', array('module' => 'Goals', 'action' => 'addNewGoal')); } else { Piwik_AddMenu($mainGoalMenu, '', array( 'module' => 'Goals', 'action' => ($site->isEcommerceEnabled() ? 'ecommerceReport' : 'index'), - 'idGoal' => ($site->isEcommerceEnabled() ? Piwik_Archive::LABEL_ECOMMERCE_ORDER : null)), + 'idGoal' => ($site->isEcommerceEnabled() ? Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER : null)), true, 25); if ($site->isEcommerceEnabled()) { - Piwik_AddMenu($mainGoalMenu, 'Goals_Ecommerce', array('module' => 'Goals', 'action' => 'ecommerceReport', 'idGoal' => Piwik_Archive::LABEL_ECOMMERCE_ORDER), true, 1); + Piwik_AddMenu($mainGoalMenu, 'Goals_Ecommerce', array('module' => 'Goals', 'action' => 'ecommerceReport', 'idGoal' => Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER), true, 1); } Piwik_AddMenu($mainGoalMenu, 'Goals_GoalsOverview', array('module' => 'Goals', 'action' => 'index'), true, 2); foreach ($goals as $goal) { diff --git a/plugins/Live/API.php b/plugins/Live/API.php index 23fadd5c76..369feb281e 100644 --- a/plugins/Live/API.php +++ b/plugins/Live/API.php @@ -535,7 +535,7 @@ class Piwik_Live_API $goalDetails = Piwik_FetchAll($sql, array($idVisit)); $sql = "SELECT - case idgoal when " . Piwik_Tracker_GoalManager::IDGOAL_CART . " then '" . Piwik_Archive::LABEL_ECOMMERCE_CART . "' else '" . Piwik_Archive::LABEL_ECOMMERCE_ORDER . "' end as type, + case idgoal when " . Piwik_Tracker_GoalManager::IDGOAL_CART . " then '" . Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_CART . "' else '" . Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER . "' end as type, idorder as orderId, " . Piwik_DataAccess_LogAggregator::getSqlRevenue('revenue') . " as revenue, " . Piwik_DataAccess_LogAggregator::getSqlRevenue('revenue_subtotal') . " as revenueSubTotal, @@ -553,7 +553,7 @@ class Piwik_Live_API $ecommerceDetails = Piwik_FetchAll($sql, array($idVisit)); foreach ($ecommerceDetails as &$ecommerceDetail) { - if ($ecommerceDetail['type'] == Piwik_Archive::LABEL_ECOMMERCE_CART) { + if ($ecommerceDetail['type'] == Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_CART) { unset($ecommerceDetail['orderId']); unset($ecommerceDetail['revenueSubTotal']); unset($ecommerceDetail['revenueTax']); @@ -616,8 +616,8 @@ class Piwik_Live_API case 'goal': $details['icon'] = 'themes/default/images/goal.png'; break; - case Piwik_Archive::LABEL_ECOMMERCE_ORDER: - case Piwik_Archive::LABEL_ECOMMERCE_CART: + case Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER: + case Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_CART: $details['icon'] = 'themes/default/images/' . $details['type'] . '.gif'; break; case Piwik_Tracker_Action_Interface::TYPE_DOWNLOAD: diff --git a/plugins/PrivacyManager/PrivacyManager.php b/plugins/PrivacyManager/PrivacyManager.php index d3caa2237f..a505b54e57 100644 --- a/plugins/PrivacyManager/PrivacyManager.php +++ b/plugins/PrivacyManager/PrivacyManager.php @@ -332,7 +332,7 @@ class Piwik_PrivacyManager extends Piwik_Plugin private static function getGoalMetricsToKeep() { // keep all goal metrics - return array_values(Piwik_Archive::$mappingFromIdToNameGoal); + return array_values(Piwik_Metrics::$mappingFromIdToNameGoal); } /** diff --git a/plugins/Provider/API.php b/plugins/Provider/API.php index 851b1b74f2..79e8fdaefb 100644 --- a/plugins/Provider/API.php +++ b/plugins/Provider/API.php @@ -36,7 +36,7 @@ class Piwik_Provider_API Piwik::checkUserHasViewAccess($idSite); $archive = Piwik_Archive::build($idSite, $period, $date, $segment); $dataTable = $archive->getDataTable(Piwik_Provider_Archiver::PROVIDER_RECORD_NAME); - $dataTable->filter('Sort', array(Piwik_Archive::INDEX_NB_VISITS)); + $dataTable->filter('Sort', array(Piwik_Metrics::INDEX_NB_VISITS)); $dataTable->queueFilter('ColumnCallbackAddMetadata', array('label', 'url', 'Piwik_getHostnameUrl')); $dataTable->queueFilter('ColumnCallbackReplace', array('label', 'Piwik_Provider_getPrettyProviderName')); $dataTable->queueFilter('ReplaceColumnNames'); diff --git a/plugins/Provider/Archiver.php b/plugins/Provider/Archiver.php index e90489f51a..d515c5cefc 100644 --- a/plugins/Provider/Archiver.php +++ b/plugins/Provider/Archiver.php @@ -17,7 +17,7 @@ class Piwik_Provider_Archiver extends Piwik_PluginsArchiver { $metrics = $this->getProcessor()->getMetricsForDimension(self::PROVIDER_FIELD); $tableProvider = $this->getProcessor()->getDataTableFromDataArray($metrics); - $this->getProcessor()->insertBlobRecord(self::PROVIDER_RECORD_NAME, $tableProvider->getSerialized($this->maximumRows, null, Piwik_Archive::INDEX_NB_VISITS)); + $this->getProcessor()->insertBlobRecord(self::PROVIDER_RECORD_NAME, $tableProvider->getSerialized($this->maximumRows, null, Piwik_Metrics::INDEX_NB_VISITS)); } public function archivePeriod() diff --git a/plugins/Referers/API.php b/plugins/Referers/API.php index e194b67df2..b87f7d0e8e 100644 --- a/plugins/Referers/API.php +++ b/plugins/Referers/API.php @@ -37,7 +37,7 @@ class Piwik_Referers_API protected function getDataTable($name, $idSite, $period, $date, $segment, $expanded = false, $idSubtable = null) { $dataTable = Piwik_Archive::getDataTableFromArchive($name, $idSite, $period, $date, $segment, $expanded, $idSubtable); - $dataTable->filter('Sort', array(Piwik_Archive::INDEX_NB_VISITS, 'desc', $naturalSort = false, $expanded)); + $dataTable->filter('Sort', array(Piwik_Metrics::INDEX_NB_VISITS, 'desc', $naturalSort = false, $expanded)); $dataTable->queueFilter('ReplaceColumnNames'); return $dataTable; } @@ -120,7 +120,7 @@ class Piwik_Referers_API $dataTable = $dataTable->mergeSubtables($labelColumn = 'referrer_type', $useMetadataColumn = true); - $dataTable->filter('Sort', array(Piwik_Archive::INDEX_NB_VISITS, 'desc')); + $dataTable->filter('Sort', array(Piwik_Metrics::INDEX_NB_VISITS, 'desc')); $dataTable->queueFilter('ReplaceColumnNames'); $dataTable->queueFilter('ReplaceSummaryRowLabel'); @@ -367,7 +367,7 @@ class Piwik_Referers_API // prettify the DataTable $dataTable->filter('ColumnCallbackReplace', array('label', 'Piwik_Referrers_removeUrlProtocol')); - $dataTable->filter('Sort', array(Piwik_Archive::INDEX_NB_VISITS, 'desc', $naturalSort = false, $expanded)); + $dataTable->filter('Sort', array(Piwik_Metrics::INDEX_NB_VISITS, 'desc', $naturalSort = false, $expanded)); $dataTable->queueFilter('ReplaceColumnNames'); return $dataTable; diff --git a/plugins/Referers/Archiver.php b/plugins/Referers/Archiver.php index 914b20df81..6e8152ed5e 100644 --- a/plugins/Referers/Archiver.php +++ b/plugins/Referers/Archiver.php @@ -31,7 +31,7 @@ class Piwik_Referers_Archiver extends Piwik_PluginsArchiver function __construct($processor) { parent::__construct($processor); - $this->columnToSortByBeforeTruncation = Piwik_Archive::INDEX_NB_VISITS; + $this->columnToSortByBeforeTruncation = Piwik_Metrics::INDEX_NB_VISITS; $this->maximumRowsInDataTableLevelZero = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_referers']; $this->maximumRowsInSubDataTable = Piwik_Config::getInstance()->General['datatable_archiving_maximum_rows_subtable_referers']; } diff --git a/plugins/Referers/Controller.php b/plugins/Referers/Controller.php index bc3cc00131..e43f2b39f3 100644 --- a/plugins/Referers/Controller.php +++ b/plugins/Referers/Controller.php @@ -437,7 +437,7 @@ class Piwik_Referers_Controller extends Piwik_Controller $value = 0; $row = $dataTableReferersType->getRowFromLabel($columnId); if ($row !== false) { - $value = $row->getColumn(Piwik_Archive::INDEX_NB_VISITS); + $value = $row->getColumn(Piwik_Metrics::INDEX_NB_VISITS); } $return[$nameVar] = $value; } diff --git a/plugins/Referers/Referers.php b/plugins/Referers/Referers.php index d0b05335e6..2c45b57592 100644 --- a/plugins/Referers/Referers.php +++ b/plugins/Referers/Referers.php @@ -227,7 +227,7 @@ class Piwik_Referers extends Piwik_Plugin Piwik_AddWidget('Referers_Referers', 'Referers_WidgetCampaigns', 'Referers', 'getCampaigns'); Piwik_AddWidget('Referers_Referers', 'Referers_WidgetOverview', 'Referers', 'getRefererType'); Piwik_AddWidget('Referers_Referers', 'Referers_WidgetGetAll', 'Referers', 'getAll'); - if (Piwik_Archive::isSegmentationEnabled()) { + if (Piwik::isSegmentationEnabled()) { Piwik_AddWidget('SEO', 'Referers_WidgetTopKeywordsForPages', 'Referers', 'getKeywordsForPage'); } } diff --git a/plugins/Transitions/API.php b/plugins/Transitions/API.php index 6d8890039b..1c2934ca74 100644 --- a/plugins/Transitions/API.php +++ b/plugins/Transitions/API.php @@ -109,9 +109,9 @@ class Piwik_Transitions_API ); foreach ($reportNames as $reportName => $replaceLabel) { if (isset($report[$reportName])) { - $columnNames = array(Piwik_Archive::INDEX_NB_ACTIONS => 'referrals'); + $columnNames = array(Piwik_Metrics::INDEX_NB_ACTIONS => 'referrals'); if ($replaceLabel) { - $columnNames[Piwik_Archive::INDEX_NB_ACTIONS] = 'referrals'; + $columnNames[Piwik_Metrics::INDEX_NB_ACTIONS] = 'referrals'; } $report[$reportName]->filter('ReplaceColumnNames', array($columnNames)); } @@ -286,7 +286,7 @@ class Piwik_Transitions_API . 'log_link_visit_action.idaction_' . $type . ' != ' . intval($idaction) . ')'; } - $metrics = array(Piwik_Archive::INDEX_NB_ACTIONS); + $metrics = array(Piwik_Metrics::INDEX_NB_ACTIONS); $data = $logAggregator->queryActionsByDimension(array($dimension), $where, $selects, $metrics, $rankingQuery, $joinLogActionColumn); $this->totalTransitionsToFollowingActions = 0; @@ -295,11 +295,11 @@ class Piwik_Transitions_API $dataTable = new Piwik_DataTable; if (isset($data[$type])) { foreach ($data[$type] as &$record) { - $actions = intval($record[Piwik_Archive::INDEX_NB_ACTIONS]); + $actions = intval($record[Piwik_Metrics::INDEX_NB_ACTIONS]); $dataTable->addRow(new Piwik_DataTable_Row(array( Piwik_DataTable_Row::COLUMNS => array( 'label' => $this->getPageLabel($record, $isTitle), - Piwik_Archive::INDEX_NB_ACTIONS => $actions + Piwik_Metrics::INDEX_NB_ACTIONS => $actions ) ))); $this->totalTransitionsToFollowingActions += $actions; @@ -362,14 +362,14 @@ class Piwik_Transitions_API $type = $this->getColumnTypeSuffix($actionType); $where = 'visit_entry_idaction_' . $type . ' = ' . intval($idaction); - $metrics = array(Piwik_Archive::INDEX_NB_VISITS); + $metrics = array(Piwik_Metrics::INDEX_NB_VISITS); $data = $logAggregator->queryVisitsByDimension($dimensions, $where, $selects, $metrics, $rankingQuery); $referrerData = array(); $referrerSubData = array(); foreach ($data as $referrerType => &$subData) { - $referrerData[$referrerType] = array(Piwik_Archive::INDEX_NB_VISITS => 0); + $referrerData[$referrerType] = array(Piwik_Metrics::INDEX_NB_VISITS => 0); if ($referrerType != Piwik_Common::REFERER_TYPE_DIRECT_ENTRY) { $referrerSubData[$referrerType] = array(); } @@ -379,12 +379,12 @@ class Piwik_Transitions_API $row['referrer_data'] = Piwik_Referers_API::LABEL_KEYWORD_NOT_DEFINED; } - $referrerData[$referrerType][Piwik_Archive::INDEX_NB_VISITS] += $row[Piwik_Archive::INDEX_NB_VISITS]; + $referrerData[$referrerType][Piwik_Metrics::INDEX_NB_VISITS] += $row[Piwik_Metrics::INDEX_NB_VISITS]; $label = $row['referrer_data']; if ($label) { $referrerSubData[$referrerType][$label] = array( - Piwik_Archive::INDEX_NB_VISITS => $row[Piwik_Archive::INDEX_NB_VISITS] + Piwik_Metrics::INDEX_NB_VISITS => $row[Piwik_Metrics::INDEX_NB_VISITS] ); } } @@ -444,7 +444,7 @@ class Piwik_Transitions_API } else { $joinLogActionOn = $dimension; } - $metrics = array(Piwik_Archive::INDEX_NB_ACTIONS); + $metrics = array(Piwik_Metrics::INDEX_NB_ACTIONS); $data = $logAggregator->queryActionsByDimension(array($dimension), $where, $selects, $metrics, $rankingQuery, $joinLogActionOn); $loops = 0; @@ -452,11 +452,11 @@ class Piwik_Transitions_API $previousPagesDataTable = new Piwik_DataTable; if (isset($data['result'][1])) { foreach ($data['result'][1] as &$page) { - $nbActions = intval($page[Piwik_Archive::INDEX_NB_ACTIONS]); + $nbActions = intval($page[Piwik_Metrics::INDEX_NB_ACTIONS]); $previousPagesDataTable->addRow(new Piwik_DataTable_Row(array( Piwik_DataTable_Row::COLUMNS => array( 'label' => $this->getPageLabel($page, $isTitle), - Piwik_Archive::INDEX_NB_ACTIONS => $nbActions + Piwik_Metrics::INDEX_NB_ACTIONS => $nbActions ) ))); $nbPageviews += $nbActions; @@ -466,11 +466,11 @@ class Piwik_Transitions_API $previousSearchesDataTable = new Piwik_DataTable; if (isset($data['result'][2])) { foreach ($data['result'][2] as &$search) { - $nbActions = intval($search[Piwik_Archive::INDEX_NB_ACTIONS]); + $nbActions = intval($search[Piwik_Metrics::INDEX_NB_ACTIONS]); $previousSearchesDataTable->addRow(new Piwik_DataTable_Row(array( Piwik_DataTable_Row::COLUMNS => array( 'label' => $search['name'], - Piwik_Archive::INDEX_NB_ACTIONS => $nbActions + Piwik_Metrics::INDEX_NB_ACTIONS => $nbActions ) ))); $nbPageviews += $nbActions; @@ -479,12 +479,12 @@ class Piwik_Transitions_API if (isset($data['result'][0])) { foreach ($data['result'][0] as &$referrer) { - $nbPageviews += intval($referrer[Piwik_Archive::INDEX_NB_ACTIONS]); + $nbPageviews += intval($referrer[Piwik_Metrics::INDEX_NB_ACTIONS]); } } if (count($data['excludedFromLimit'])) { - $loops += intval($data['excludedFromLimit'][0][Piwik_Archive::INDEX_NB_ACTIONS]); + $loops += intval($data['excludedFromLimit'][0][Piwik_Metrics::INDEX_NB_ACTIONS]); $nbPageviews += $loops; } @@ -557,7 +557,7 @@ class Piwik_Transitions_API $report['referrers'] = array(); foreach ($data->getRows() as $row) { $referrerId = $row->getColumn('label'); - $visits = $row->getColumn(Piwik_Archive::INDEX_NB_VISITS); + $visits = $row->getColumn(Piwik_Metrics::INDEX_NB_VISITS); if ($visits) { // load details (i.e. subtables) $details = array(); @@ -566,7 +566,7 @@ class Piwik_Transitions_API foreach ($subTable->getRows() as $subRow) { $details[] = array( 'label' => $subRow->getColumn('label'), - 'referrals' => $subRow->getColumn(Piwik_Archive::INDEX_NB_VISITS) + 'referrals' => $subRow->getColumn(Piwik_Metrics::INDEX_NB_VISITS) ); } } diff --git a/plugins/UserCountry/API.php b/plugins/UserCountry/API.php index 40432969e9..261fda8f06 100644 --- a/plugins/UserCountry/API.php +++ b/plugins/UserCountry/API.php @@ -190,7 +190,7 @@ class Piwik_UserCountry_API Piwik::checkUserHasViewAccess($idSite); $archive = Piwik_Archive::build($idSite, $period, $date, $segment); $dataTable = $archive->getDataTable($name); - $dataTable->filter('Sort', array(Piwik_Archive::INDEX_NB_VISITS)); + $dataTable->filter('Sort', array(Piwik_Metrics::INDEX_NB_VISITS)); $dataTable->queueFilter('ReplaceColumnNames'); return $dataTable; } diff --git a/plugins/UserCountry/Archiver.php b/plugins/UserCountry/Archiver.php index ba135474b4..2fa2573d55 100644 --- a/plugins/UserCountry/Archiver.php +++ b/plugins/UserCountry/Archiver.php @@ -129,12 +129,12 @@ class Piwik_UserCountry_Archiver extends Piwik_PluginsArchiver $this->getProcessor()->insertNumericRecord(self::DISTINCT_COUNTRIES_METRIC, $tableCountry->getRowsCount()); $tableRegion = Piwik_ArchiveProcessor_Day::getDataTableFromDataArray($this->arrays[self::REGION_FIELD]); - $serialized = $tableRegion->getSerialized($this->maximumRows, $this->maximumRows, Piwik_Archive::INDEX_NB_VISITS); + $serialized = $tableRegion->getSerialized($this->maximumRows, $this->maximumRows, Piwik_Metrics::INDEX_NB_VISITS); $this->getProcessor()->insertBlobRecord(self::REGION_RECORD_NAME, $serialized); $tableCity = Piwik_ArchiveProcessor_Day::getDataTableFromDataArray($this->arrays[self::CITY_FIELD]); $this->setLatitudeLongitude($tableCity); - $serialized = $tableCity->getSerialized($this->maximumRows, $this->maximumRows, Piwik_Archive::INDEX_NB_VISITS); + $serialized = $tableCity->getSerialized($this->maximumRows, $this->maximumRows, Piwik_Metrics::INDEX_NB_VISITS); $this->getProcessor()->insertBlobRecord(self::CITY_RECORD_NAME, $serialized); } diff --git a/plugins/UserSettings/API.php b/plugins/UserSettings/API.php index 03ea9ac61d..1aa80230f9 100644 --- a/plugins/UserSettings/API.php +++ b/plugins/UserSettings/API.php @@ -37,7 +37,7 @@ class Piwik_UserSettings_API Piwik::checkUserHasViewAccess($idSite); $archive = Piwik_Archive::build($idSite, $period, $date, $segment); $dataTable = $archive->getDataTable($name); - $dataTable->filter('Sort', array(Piwik_Archive::INDEX_NB_VISITS)); + $dataTable->filter('Sort', array(Piwik_Metrics::INDEX_NB_VISITS)); $dataTable->queueFilter('ReplaceColumnNames'); $dataTable->queueFilter('ReplaceSummaryRowLabel'); return $dataTable; @@ -103,8 +103,8 @@ class Piwik_UserSettings_API protected function ensureDefaultRowsInTable($dataTable) { $requiredRows = array( - 'General_Desktop' => Piwik_Archive::INDEX_NB_VISITS, - 'General_Mobile' => Piwik_Archive::INDEX_NB_VISITS + 'General_Desktop' => Piwik_Metrics::INDEX_NB_VISITS, + 'General_Mobile' => Piwik_Metrics::INDEX_NB_VISITS ); $dataTables = array($dataTable); @@ -216,7 +216,7 @@ class Piwik_UserSettings_API $ieStats = $browserType->getRowFromLabel('ie'); if ($ieStats !== false) { - $ieVisits = $ieStats->getColumn(Piwik_Archive::INDEX_NB_VISITS); + $ieVisits = $ieStats->getColumn(Piwik_Metrics::INDEX_NB_VISITS); } $visitsSum = $visitsSumTotal - $ieVisits; @@ -228,7 +228,7 @@ class Piwik_UserSettings_API // The filter must be applied now so that the new column can // be sorted by the generic filters (applied right after this loop exits) - $table->filter('ColumnCallbackAddColumnPercentage', array('nb_visits_percentage', Piwik_Archive::INDEX_NB_VISITS, $visitsSum, 1)); + $table->filter('ColumnCallbackAddColumnPercentage', array('nb_visits_percentage', Piwik_Metrics::INDEX_NB_VISITS, $visitsSum, 1)); $table->filter('RangeCheck', array('nb_visits_percentage')); } diff --git a/plugins/UserSettings/Archiver.php b/plugins/UserSettings/Archiver.php index 5d3319f19d..d6ba9e32b2 100644 --- a/plugins/UserSettings/Archiver.php +++ b/plugins/UserSettings/Archiver.php @@ -110,7 +110,7 @@ class Piwik_UserSettings_Archiver extends Piwik_PluginsArchiver $query = $this->getLogAggregator()->queryVisitsByDimension(array(), false, $selects, $metrics = array()); $data = $query->fetch(); - $cleanRow = Piwik_DataAccess_LogAggregator::makeArrayOneColumn($data, Piwik_Archive::INDEX_NB_VISITS); + $cleanRow = Piwik_DataAccess_LogAggregator::makeArrayOneColumn($data, Piwik_Metrics::INDEX_NB_VISITS); $table = Piwik_DataTable::makeFromIndexedArray($cleanRow); $this->insertTable(self::PLUGIN_RECORD_NAME, $table); } @@ -131,7 +131,7 @@ class Piwik_UserSettings_Archiver extends Piwik_PluginsArchiver protected function insertTable($recordName, Piwik_DataTable $table) { - return $this->getProcessor()->insertBlobRecord($recordName, $table->getSerialized($this->maximumRows, null, Piwik_Archive::INDEX_NB_VISITS)); + return $this->getProcessor()->insertBlobRecord($recordName, $table->getSerialized($this->maximumRows, null, Piwik_Metrics::INDEX_NB_VISITS)); } public function archivePeriod() diff --git a/plugins/VisitTime/API.php b/plugins/VisitTime/API.php index 29bc890664..7f794bce82 100644 --- a/plugins/VisitTime/API.php +++ b/plugins/VisitTime/API.php @@ -66,8 +66,8 @@ class Piwik_VisitTime_API Piwik::checkUserHasViewAccess($idSite); // metrics to query - $metrics = Piwik_Archive::getVisitsMetricNames(); - unset($metrics[Piwik_Archive::INDEX_MAX_ACTIONS]); + $metrics = Piwik_Metrics::getVisitsMetricNames(); + unset($metrics[Piwik_Metrics::INDEX_MAX_ACTIONS]); try { // get metric data for every day within the supplied period diff --git a/plugins/VisitorInterest/API.php b/plugins/VisitorInterest/API.php index d3fcd13382..deaec5a68e 100644 --- a/plugins/VisitorInterest/API.php +++ b/plugins/VisitorInterest/API.php @@ -27,7 +27,7 @@ class Piwik_VisitorInterest_API return self::$instance; } - protected function getDataTable($name, $idSite, $period, $date, $segment, $column = Piwik_Archive::INDEX_NB_VISITS) + protected function getDataTable($name, $idSite, $period, $date, $segment, $column = Piwik_Metrics::INDEX_NB_VISITS) { Piwik::checkUserHasViewAccess($idSite); $archive = Piwik_Archive::build($idSite, $period, $date, $segment); @@ -70,7 +70,7 @@ class Piwik_VisitorInterest_API public function getNumberOfVisitsByDaysSinceLast($idSite, $period, $date, $segment = false) { $dataTable = $this->getDataTable( - Piwik_VisitorInterest_Archiver::DAYS_SINCE_LAST_RECORD_NAME, $idSite, $period, $date, $segment, Piwik_Archive::INDEX_NB_VISITS); + Piwik_VisitorInterest_Archiver::DAYS_SINCE_LAST_RECORD_NAME, $idSite, $period, $date, $segment, Piwik_Metrics::INDEX_NB_VISITS); $dataTable->queueFilter('BeautifyRangeLabels', array( Piwik_Translate('General_OneDay'), Piwik_Translate('General_NDays'))); @@ -91,7 +91,7 @@ class Piwik_VisitorInterest_API public function getNumberOfVisitsByVisitCount($idSite, $period, $date, $segment = false) { $dataTable = $this->getDataTable( - Piwik_VisitorInterest_Archiver::VISITS_COUNT_RECORD_NAME, $idSite, $period, $date, $segment, Piwik_Archive::INDEX_NB_VISITS); + Piwik_VisitorInterest_Archiver::VISITS_COUNT_RECORD_NAME, $idSite, $period, $date, $segment, Piwik_Metrics::INDEX_NB_VISITS); $dataTable->queueFilter('BeautifyRangeLabels', array( Piwik_Translate('General_OneVisit'), Piwik_Translate('General_NVisits'))); @@ -116,7 +116,7 @@ class Piwik_VisitorInterest_API self::addVisitsPercentColumn($table); } } else { - $totalVisits = array_sum($dataTable->getColumn(Piwik_Archive::INDEX_NB_VISITS)); + $totalVisits = array_sum($dataTable->getColumn(Piwik_Metrics::INDEX_NB_VISITS)); $dataTable->queueFilter('ColumnCallbackAddColumnPercentage', array( 'nb_visits_percentage', 'nb_visits', $totalVisits)); } diff --git a/plugins/VisitorInterest/Archiver.php b/plugins/VisitorInterest/Archiver.php index 8d66c949f5..1720589a7f 100644 --- a/plugins/VisitorInterest/Archiver.php +++ b/plugins/VisitorInterest/Archiver.php @@ -107,7 +107,7 @@ class Piwik_VisitorInterest_Archiver extends Piwik_PluginsArchiver $query = $this->getLogAggregator()->queryVisitsByDimension(array(), $where = false, $selects, array()); $row = $query->fetch(); foreach($prefixes as $recordName => $selectAsPrefix) { - $cleanRow = Piwik_DataAccess_LogAggregator::makeArrayOneColumn($row, Piwik_Archive::INDEX_NB_VISITS, $selectAsPrefix); + $cleanRow = Piwik_DataAccess_LogAggregator::makeArrayOneColumn($row, Piwik_Metrics::INDEX_NB_VISITS, $selectAsPrefix); $dataTable = Piwik_DataTable::makeFromIndexedArray($cleanRow); $this->getProcessor()->insertBlobRecord($recordName, $dataTable->getSerialized()); } -- cgit v1.2.3 From 5a59fd9f50c3abeb7c67acf3745a1f0549a82878 Mon Sep 17 00:00:00 2001 From: mattab Date: Tue, 18 Jun 2013 16:45:21 +1200 Subject: Fixing build --- plugins/Actions/API.php | 43 +++++++++++++++++++++++-------------------- 1 file changed, 23 insertions(+), 20 deletions(-) (limited to 'plugins') diff --git a/plugins/Actions/API.php b/plugins/Actions/API.php index 56f63bdc9b..4815f05cce 100644 --- a/plugins/Actions/API.php +++ b/plugins/Actions/API.php @@ -73,6 +73,7 @@ class Piwik_Actions_API $archive = Piwik_Archive::build($idSite, $period, $date, $segment); $metrics = Piwik_Actions_Archiver::$actionsAggregateMetrics; + $metrics['Actions_avg_time_generation'] = 'avg_time_generation'; // get requested columns $columns = Piwik::getArrayFromApiParameter($columns); @@ -86,18 +87,20 @@ class Piwik_Actions_API $columns[$i] = $fullColumn; $nameReplace[$fullColumn] = $column; } - - if (false !== ($avgGenerationTimeRequested = array_search('avg_time_generation', $columns))) { - $avgGenerationTimeRequested = true; - } + + if (false !== ($avgGenerationTimeRequested = array_search('Actions_avg_time_generation', $columns))) { + unset($columns[$avgGenerationTimeRequested]); + $avgGenerationTimeRequested = true; + } } else { // get all columns + unset($metrics['Actions_avg_time_generation']); $columns = array_keys($metrics); $nameReplace = & $metrics; - $avgGenerationTimeRequested = true; + $avgGenerationTimeRequested = true; } - - if ($avgGenerationTimeRequested) { + + if ($avgGenerationTimeRequested) { $tempColumns[] = Piwik_Actions_Archiver::METRIC_SUM_TIME_RECORD_NAME; $tempColumns[] = Piwik_Actions_Archiver::METRIC_HITS_TIMED_RECORD_NAME; $columns = array_merge($columns, $tempColumns); @@ -106,17 +109,17 @@ class Piwik_Actions_API $nameReplace[Piwik_Actions_Archiver::METRIC_SUM_TIME_RECORD_NAME] = 'sum_time_generation'; $nameReplace[Piwik_Actions_Archiver::METRIC_HITS_TIMED_RECORD_NAME] = 'nb_hits_with_time_generation'; } - + $table = $archive->getDataTableFromNumeric($columns); // replace labels (remove Actions_) $table->filter('ReplaceColumnNames', array($nameReplace)); - - // compute avg generation time - if ($avgGenerationTimeRequested) { - $table->filter('ColumnCallbackAddColumnQuotient', array('avg_time_generation', 'sum_time_generation', 'nb_hits_with_time_generation', 3)); - $table->deleteColumns(array('sum_time_generation', 'nb_hits_with_time_generation')); - } + + // compute avg generation time + if ($avgGenerationTimeRequested) { + $table->filter('ColumnCallbackAddColumnQuotient', array('avg_time_generation', 'sum_time_generation', 'nb_hits_with_time_generation', 3)); + $table->deleteColumns(array('sum_time_generation', 'nb_hits_with_time_generation')); + } return $table; } @@ -495,12 +498,12 @@ class Piwik_Actions_API // No generation time: remove it from the API output and add it to empty_columns metadata, so that // the columns can also be removed from the view $dataTable->filter('ColumnDelete', array(array( - Piwik_Metrics::INDEX_PAGE_SUM_TIME_GENERATION, - Piwik_Metrics::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION, - Piwik_Metrics::INDEX_PAGE_MIN_TIME_GENERATION, - Piwik_Metrics::INDEX_PAGE_MAX_TIME_GENERATION - ))); - + Piwik_Metrics::INDEX_PAGE_SUM_TIME_GENERATION, + Piwik_Metrics::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION, + Piwik_Metrics::INDEX_PAGE_MIN_TIME_GENERATION, + Piwik_Metrics::INDEX_PAGE_MAX_TIME_GENERATION + ))); + if ($dataTable instanceof Piwik_DataTable) { $emptyColumns = $dataTable->getMetadata(Piwik_DataTable::EMPTY_COLUMNS_METADATA_NAME); if (!is_array($emptyColumns)) { -- cgit v1.2.3 From e61b8958733ede26a524bc228b85a07bacec21c0 Mon Sep 17 00:00:00 2001 From: mattab Date: Tue, 18 Jun 2013 17:24:06 +1200 Subject: Removing TablePartitioning from codebase, since it was rather ugly. Introducing ArchiveTableCreator --- plugins/Actions/API.php | 2 +- plugins/DevicesDetection/Controller.php | 2 +- .../UserAgentParserEnhanced/UserAgentParserEnhanced.php | 2 +- plugins/PrivacyManager/PrivacyManager.php | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) (limited to 'plugins') diff --git a/plugins/Actions/API.php b/plugins/Actions/API.php index 4815f05cce..8eec6d2d1b 100644 --- a/plugins/Actions/API.php +++ b/plugins/Actions/API.php @@ -346,7 +346,7 @@ class Piwik_Actions_API $dataTable = new Piwik_DataTable(); // Handle case where date=last30&period=day - // TODO: this logic should really be refactored somewhere, this is ugly! + // FIXMEA: this logic should really be refactored somewhere, this is ugly! if ($customVariables instanceof Piwik_DataTable_Array) { $dataTable = $customVariables->getEmptyClone(); diff --git a/plugins/DevicesDetection/Controller.php b/plugins/DevicesDetection/Controller.php index 4ac0644f5b..22681f1a6c 100644 --- a/plugins/DevicesDetection/Controller.php +++ b/plugins/DevicesDetection/Controller.php @@ -140,7 +140,7 @@ class Piwik_DevicesDetection_Controller extends Piwik_Controller echo "Processing idvisit = " . $rec['idvisit'] . "
    "; echo "UserAgent string: " . $rec['config_debug_ua'] . "
    Decoded values:"; $uaDetails = $this->getArray($UAParser); - var_dump($uaDetails); + var_export($uaDetails); echo "
    "; $this->updateVisit($rec['idvisit'], $uaDetails); unset($UAParser); diff --git a/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php b/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php index 5691033bf5..911c751221 100644 --- a/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php +++ b/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php @@ -362,7 +362,7 @@ class UserAgentParserEnhanced $this->device = array_search('desktop', self::$deviceTypes); } if ($this->debug) { - var_dump($this->brand, $this->model, $this->device); + var_export($this->brand, $this->model, $this->device); } } diff --git a/plugins/PrivacyManager/PrivacyManager.php b/plugins/PrivacyManager/PrivacyManager.php index a505b54e57..9065c4678d 100644 --- a/plugins/PrivacyManager/PrivacyManager.php +++ b/plugins/PrivacyManager/PrivacyManager.php @@ -385,7 +385,7 @@ class Piwik_PrivacyManager extends Piwik_Plugin $deleteIntervalSeconds = $this->getDeleteIntervalInSeconds($deleteIntervalDays); if ($lastDelete === false || - ($lastDelete !== false && ((int)$lastDelete + $deleteIntervalSeconds) <= time()) + ((int)$lastDelete + $deleteIntervalSeconds) <= time() ) { return true; } else // not time to run data purge -- cgit v1.2.3 From 4ab35bb24ca01bccb7d0bfd68c737bb0fcd1b4e8 Mon Sep 17 00:00:00 2001 From: mattab Date: Tue, 18 Jun 2013 17:58:32 +1200 Subject: Moving some logic to Piwik_DataAccess_ArchiveTableCreator --- plugins/CoreAdminHome/API.php | 7 ++----- plugins/CoreAdminHome/CoreAdminHome.php | 4 ++-- plugins/Installation/Controller.php | 7 ++++--- plugins/PrivacyManager/ReportsPurger.php | 35 +++++++++++++------------------- 4 files changed, 22 insertions(+), 31 deletions(-) (limited to 'plugins') diff --git a/plugins/CoreAdminHome/API.php b/plugins/CoreAdminHome/API.php index eded6d451f..e17fb28467 100644 --- a/plugins/CoreAdminHome/API.php +++ b/plugins/CoreAdminHome/API.php @@ -92,9 +92,6 @@ class Piwik_CoreAdminHome_API } } - // Lookup archive tables - $tables = Piwik::getTablesInstalled(); - $archiveTables = Piwik::getTablesArchivesInstalled(); // If using the feature "Delete logs older than N days"... $logsAreDeletedBeforeThisDate = Piwik_Config::getInstance()->Deletelogs['delete_logs_schedule_lowest_interval']; @@ -144,10 +141,10 @@ class Piwik_CoreAdminHome_API // In each table, invalidate day/week/month/year containing this date $sqlIdSites = implode(",", $idSites); + $archiveTables = Piwik_DataAccess_ArchiveTableCreator::getTablesArchivesInstalled(); foreach ($archiveTables as $table) { // Extract Y_m from table name - $suffix = str_replace(array('archive_numeric_', 'archive_blob_'), '', Piwik_Common::unprefixTable($table)); - + $suffix = Piwik_DataAccess_ArchiveTableCreator::getDateFromTableName($table); if (!isset($datesByMonth[$suffix])) { continue; } diff --git a/plugins/CoreAdminHome/CoreAdminHome.php b/plugins/CoreAdminHome/CoreAdminHome.php index ee80acceba..1711a02fc7 100644 --- a/plugins/CoreAdminHome/CoreAdminHome.php +++ b/plugins/CoreAdminHome/CoreAdminHome.php @@ -111,7 +111,7 @@ class Piwik_CoreAdminHome extends Piwik_Plugin function purgeOutdatedArchives() { - $archiveTables = Piwik::getTablesArchivesInstalled(); + $archiveTables = Piwik_DataAccess_ArchiveTableCreator::getTablesArchivesInstalled(); foreach ($archiveTables as $table) { if (strpos($table, 'numeric') !== false) { Piwik_ArchiveProcessor_Rules::shouldPurgeOutdatedArchives($table); @@ -121,7 +121,7 @@ class Piwik_CoreAdminHome extends Piwik_Plugin function optimizeArchiveTable() { - $archiveTables = Piwik::getTablesArchivesInstalled(); + $archiveTables = Piwik_DataAccess_ArchiveTableCreator::getTablesArchivesInstalled(); Piwik_OptimizeTables($archiveTables); } } diff --git a/plugins/Installation/Controller.php b/plugins/Installation/Controller.php index 153991a5d3..253d62dda2 100644 --- a/plugins/Installation/Controller.php +++ b/plugins/Installation/Controller.php @@ -253,19 +253,20 @@ class Piwik_Installation_Controller extends Piwik_Controller_Admin } $tablesInstalled = Piwik::getTablesInstalled(); - $tablesToInstall = Piwik::getTablesNames(); $view->tablesInstalled = ''; if (count($tablesInstalled) > 0) { // we have existing tables $view->tablesInstalled = implode(', ', $tablesInstalled); $view->someTablesInstalled = true; + // remove monthly archive tables + $archiveTables = Piwik_DataAccess_ArchiveTableCreator::getTablesArchivesInstalled(); + $baseTablesInstalled = count($tablesInstalled) - count($archiveTables); $minimumCountPiwikTables = 17; - $baseTablesInstalled = preg_grep('/archive_numeric|archive_blob/', $tablesInstalled, PREG_GREP_INVERT); Piwik::createAccessObject(); Piwik::setUserIsSuperUser(); - if (count($baseTablesInstalled) >= $minimumCountPiwikTables && + if ($baseTablesInstalled >= $minimumCountPiwikTables && count(Piwik_SitesManager_API::getInstance()->getAllSitesId()) > 0 && count(Piwik_UsersManager_API::getInstance()->getUsers()) > 0 ) { diff --git a/plugins/PrivacyManager/ReportsPurger.php b/plugins/PrivacyManager/ReportsPurger.php index 61c650a613..4234b6b8c9 100755 --- a/plugins/PrivacyManager/ReportsPurger.php +++ b/plugins/PrivacyManager/ReportsPurger.php @@ -203,24 +203,23 @@ class Piwik_PrivacyManager_ReportsPurger // reports whose creation date <= this month will be deleted // (NOTE: we ignore how far we are in the current month) $toRemoveDate = Piwik_Date::factory('today')->subMonth(1 + $this->deleteReportsOlderThan); - $toRemoveYear = (int)$toRemoveDate->toString('Y'); - $toRemoveMonth = (int)$toRemoveDate->toString('m'); // find all archive tables that are older than N months $oldNumericTables = array(); $oldBlobTables = array(); foreach (Piwik::getTablesInstalled() as $table) { - if (preg_match("/archive_(numeric|blob)_([0-9]+)_([0-9]+)/", $table, $matches)) { - $type = $matches[1]; - $year = (int)$matches[2]; - $month = (int)$matches[3]; - - if (self::shouldReportBePurged($year, $month, $toRemoveDate)) { - if ($type == "numeric") { - $oldNumericTables[] = $table; - } else { - $oldBlobTables[] = $table; - } + $type = Piwik_DataAccess_ArchiveTableCreator::getTypeFromTableName($table); + if($type === false) { + continue; + } + $date = Piwik_DataAccess_ArchiveTableCreator::getDateFromTableName($table); + list($month, $year) = explode('_', $date); + + if (self::shouldReportBePurged($year, $month, $toRemoveDate)) { + if ($type == Piwik_DataAccess_ArchiveTableCreator::NUMERIC_TABLE) { + $oldNumericTables[] = $table; + } else { + $oldBlobTables[] = $table; } } } @@ -285,7 +284,7 @@ class Piwik_PrivacyManager_ReportsPurger // if not keeping segments make sure segments w/ kept periods are also deleted if (!$this->keepSegmentReports) { $this->findSegmentArchives($oldNumericTables); - $archiveIds = $this->segmentArchiveIds[$this->getArchiveTableDate($table)]; + $archiveIds = $this->segmentArchiveIds[Piwik_DataAccess_ArchiveTableCreator::getDateFromTableName($table)]; if (!empty($archiveIds)) { $where .= " OR idarchive IN (" . implode(',', $archiveIds) . ")"; @@ -308,7 +307,7 @@ class Piwik_PrivacyManager_ReportsPurger } foreach ($numericTables as $table) { - $tableDate = $this->getArchiveTableDate($table); + $tableDate = Piwik_DataAccess_ArchiveTableCreator::getDateFromTableName($table); $maxIdArchive = Piwik_FetchOne("SELECT MAX(idarchive) FROM $table"); @@ -326,12 +325,6 @@ class Piwik_PrivacyManager_ReportsPurger } } - private function getArchiveTableDate($table) - { - preg_match("/[a-zA-Z_]+([0-9]+_[0-9]+)/", $table, $matches); - return $matches[1]; - } - /** * Utility function. Creates a new instance of ReportsPurger with the supplied array * of settings. -- cgit v1.2.3 From 045b0885dd1476bfadcf91446c3cf41885b3308e Mon Sep 17 00:00:00 2001 From: mattab Date: Tue, 18 Jun 2013 19:22:34 +1200 Subject: I can't figure out why PrivacyManagerTest now regresses... --- plugins/CoreAdminHome/CoreAdminHome.php | 6 +++--- plugins/PrivacyManager/PrivacyManager.php | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'plugins') diff --git a/plugins/CoreAdminHome/CoreAdminHome.php b/plugins/CoreAdminHome/CoreAdminHome.php index 1711a02fc7..f48c0a760e 100644 --- a/plugins/CoreAdminHome/CoreAdminHome.php +++ b/plugins/CoreAdminHome/CoreAdminHome.php @@ -113,9 +113,9 @@ class Piwik_CoreAdminHome extends Piwik_Plugin { $archiveTables = Piwik_DataAccess_ArchiveTableCreator::getTablesArchivesInstalled(); foreach ($archiveTables as $table) { - if (strpos($table, 'numeric') !== false) { - Piwik_ArchiveProcessor_Rules::shouldPurgeOutdatedArchives($table); - } + $date = Piwik_DataAccess_ArchiveTableCreator::getDateFromTableName($table); + list($month, $year) = explode('_', $date); + Piwik_DataAccess_ArchiveSelector::purgeOutdatedArchives(Piwik_Date::factory("01-$month-$year")); } } diff --git a/plugins/PrivacyManager/PrivacyManager.php b/plugins/PrivacyManager/PrivacyManager.php index 9065c4678d..a505b54e57 100644 --- a/plugins/PrivacyManager/PrivacyManager.php +++ b/plugins/PrivacyManager/PrivacyManager.php @@ -385,7 +385,7 @@ class Piwik_PrivacyManager extends Piwik_Plugin $deleteIntervalSeconds = $this->getDeleteIntervalInSeconds($deleteIntervalDays); if ($lastDelete === false || - ((int)$lastDelete + $deleteIntervalSeconds) <= time() + ($lastDelete !== false && ((int)$lastDelete + $deleteIntervalSeconds) <= time()) ) { return true; } else // not time to run data purge -- cgit v1.2.3 From eca878e7ac193c8a580f1ebee59eabddf9661b3e Mon Sep 17 00:00:00 2001 From: mattab Date: Wed, 19 Jun 2013 09:26:25 +1200 Subject: Fixing bug when generating custom reports, return a numeric value only if a single column was requested (otherwise return array) --- plugins/CoreAdminHome/CoreAdminHome.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'plugins') diff --git a/plugins/CoreAdminHome/CoreAdminHome.php b/plugins/CoreAdminHome/CoreAdminHome.php index f48c0a760e..ad50e17713 100644 --- a/plugins/CoreAdminHome/CoreAdminHome.php +++ b/plugins/CoreAdminHome/CoreAdminHome.php @@ -115,7 +115,7 @@ class Piwik_CoreAdminHome extends Piwik_Plugin foreach ($archiveTables as $table) { $date = Piwik_DataAccess_ArchiveTableCreator::getDateFromTableName($table); list($month, $year) = explode('_', $date); - Piwik_DataAccess_ArchiveSelector::purgeOutdatedArchives(Piwik_Date::factory("01-$month-$year")); + Piwik_DataAccess_ArchiveSelector::purgeOutdatedArchives(Piwik_Date::factory("$year-$month-15")); } } -- cgit v1.2.3 From 2a28755ea66ef1355839bc2bee050db13b53648f Mon Sep 17 00:00:00 2001 From: mattab Date: Wed, 19 Jun 2013 09:32:39 +1200 Subject: Fixes #3884 #4014 --- plugins/PDFReports/templates/list.tpl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'plugins') diff --git a/plugins/PDFReports/templates/list.tpl b/plugins/PDFReports/templates/list.tpl index fc7a2ad173..9ab73460f3 100644 --- a/plugins/PDFReports/templates/list.tpl +++ b/plugins/PDFReports/templates/list.tpl @@ -71,7 +71,7 @@
    		{*download link*} - {'General_Download'|translate} -- cgit v1.2.3 From 8575c02aa74577c3674c367dc32c87f0865df00d Mon Sep 17 00:00:00 2001 From: mattab Date: Wed, 19 Jun 2013 09:37:55 +1200 Subject: Fixed remaining notice refs #4014 --- plugins/PDFReports/PDFReports.php | 1 + 1 file changed, 1 insertion(+) (limited to 'plugins') diff --git a/plugins/PDFReports/PDFReports.php b/plugins/PDFReports/PDFReports.php index fc718235f4..6b7a0ef98c 100644 --- a/plugins/PDFReports/PDFReports.php +++ b/plugins/PDFReports/PDFReports.php @@ -672,6 +672,7 @@ class Piwik_PDFReports extends Piwik_Plugin Piwik_ScheduledTime::PERIOD_WEEK => Piwik_Translate('General_WeeklyReport'), Piwik_ScheduledTime::PERIOD_MONTH => Piwik_Translate('General_MonthlyReport'), Piwik_ScheduledTime::PERIOD_YEAR => Piwik_Translate('General_YearlyReport'), + Piwik_ScheduledTime::PERIOD_RANGE => Piwik_Translate('General_RangeReports'), ); } } -- cgit v1.2.3 From f9af4b22914721e71f9f430ffa00be8a2d156158 Mon Sep 17 00:00:00 2001 From: Benaka Moorthi Date: Tue, 18 Jun 2013 22:45:55 -0700 Subject: Fixing regressions in recent refactorings, fixing regression in Archive.php refactoring and fixing bug in integration testing code which sets 'date' query param. --- plugins/MultiSites/API.php | 26 ++++++++++++++++---------- plugins/VisitTime/API.php | 32 ++++++++++++-------------------- 2 files changed, 28 insertions(+), 30 deletions(-) (limited to 'plugins') diff --git a/plugins/MultiSites/API.php b/plugins/MultiSites/API.php index e9984b99aa..e3d398c259 100755 --- a/plugins/MultiSites/API.php +++ b/plugins/MultiSites/API.php @@ -218,11 +218,13 @@ class Piwik_MultiSites_API ) { $dataTable = $dataTable->mergeChildren(); } else { - if (!$dataTable instanceof Piwik_DataTable_Array + if (!($dataTable instanceof Piwik_DataTable_Array) && $dataTable->getRowsCount() > 0 ) { + $firstSite = is_array($sites) ? reset($sites) : $sites; + $firstDataTableRow = $dataTable->getFirstRow(); - $firstDataTableRow->setColumn('label', $sites); + $firstDataTableRow->setColumn('label', $firstSite); } } @@ -232,20 +234,19 @@ class Piwik_MultiSites_API // if the period isn't a range & a lastN/previousN date isn't used, we get the same // data for the last period to show the evolution of visits/actions/revenue list($strLastDate, $lastPeriod) = Piwik_Period_Range::getLastDate($date, $period); - if ( - // FIXMEA broken without this false - false - && $strLastDate !== false) { + if ($strLastDate !== false) { if ($lastPeriod !== false) { // NOTE: no easy way to set last period date metadata when range of dates is requested. // will be easier if DataTable_Array::metadata is removed, and metadata that is // put there is put directly in Piwik_DataTable::metadata. $dataTable->setMetadata(self::getLastPeriodMetadataName('date'), $lastPeriod); } - $pastArchive = Piwik_Archive::build('all', $period, $strLastDate, $segment, $_restrictSitesToLogin); + $pastArchive = Piwik_Archive::build($sites, $period, $strLastDate, $segment, $_restrictSitesToLogin); $pastData = $pastArchive->getDataTableFromNumeric($fieldsToGet); - - if(!($dataTable instanceof Piwik_DataTable_Simple)) { + + if ($pastData instanceof Piwik_DataTable_Array + && $multipleWebsitesRequested + ) { $pastData = $pastData->mergeChildren(); } @@ -318,8 +319,13 @@ class Piwik_MultiSites_API */ private function calculateEvolutionPercentages($currentData, $pastData, $apiMetrics) { + if (get_class($currentData) != get_class($pastData)) { // sanity check for regressions + throw new Exception("Expected \$pastData to be of type ".get_class($currentData)." - got " + . get_class($pastData)."."); + } + if ($currentData instanceof Piwik_DataTable_Array) { - $pastArray = $pastData->getRows(); + $pastArray = $pastData->getArray(); foreach ($currentData->getArray() as $subTable) { $this->calculateEvolutionPercentages($subTable, current($pastArray), $apiMetrics); next($pastArray); diff --git a/plugins/VisitTime/API.php b/plugins/VisitTime/API.php index 7f794bce82..2f4aaee06b 100644 --- a/plugins/VisitTime/API.php +++ b/plugins/VisitTime/API.php @@ -68,32 +68,24 @@ class Piwik_VisitTime_API // metrics to query $metrics = Piwik_Metrics::getVisitsMetricNames(); unset($metrics[Piwik_Metrics::INDEX_MAX_ACTIONS]); - - try { - // get metric data for every day within the supplied period - $oPeriod = Piwik_Period::makePeriodFromQueryParams(Piwik_Site::getTimezoneFor($idSite), $period, $date); - $dateRange = $oPeriod->getDateStart()->toString() . ',' . $oPeriod->getDateEnd()->toString(); - $archive = Piwik_Archive::build($idSite, 'day', $dateRange, $segment); - } catch(Exception $e) { - throw new Exception("getByDayOfWeek not working yet"); + + // disabled for multiple dates + if (Piwik_Period::isMultiplePeriod($date, $period)) { + throw new Exception("VisitTime.getByDayOfWeek does not support multiple dates."); } - // disabled for multiple sites/dates - if ( count( $archive->getParams()->getIdSites() ) > 1) { - throw new Exception("VisitTime.getByDayOfWeek does not support multiple sites."); - } + // get metric data for every day within the supplied period + $oPeriod = Piwik_Period::makePeriodFromQueryParams(Piwik_Site::getTimezoneFor($idSite), $period, $date); + $dateRange = $oPeriod->getDateStart()->toString() . ',' . $oPeriod->getDateEnd()->toString(); + $archive = Piwik_Archive::build($idSite, 'day', $dateRange, $segment); - $periods = $archive->getParams()->getPeriods(); - if ( count ($periods) > 1 - && !($periods[0] instanceof Piwik_Period_Day)) { - throw new Exception("VisitTime.getByDayOfWeek does not support multiple dates."); + // disabled for multiple sites + if (count($archive->getParams()->getIdSites()) > 1) { + throw new Exception("VisitTime.getByDayOfWeek does not support multiple sites."); } - $dataTable = $archive->getDataTableFromNumeric($metrics); + $dataTable = $archive->getDataTableFromNumeric($metrics)->mergeChildren(); - if(!($dataTable instanceof Piwik_DataTable)) { - return new Piwik_DataTable(); - } // if there's no data for this report, don't bother w/ anything else if ($dataTable->getRowsCount() == 0) { return $dataTable; -- cgit v1.2.3 From e8ec08565cf6975c57323fa3eb2535b664f6b8b7 Mon Sep 17 00:00:00 2001 From: Benaka Moorthi Date: Tue, 18 Jun 2013 23:40:05 -0700 Subject: Make sure 'Content-Type: application/json' is sent w/ default result of Dashboard.getAllDashboards controller action and use $.text for untrusted content in three places in dashboard.js. --- plugins/Dashboard/Controller.php | 3 +++ plugins/Dashboard/templates/dashboard.js | 6 +++--- 2 files changed, 6 insertions(+), 3 deletions(-) (limited to 'plugins') diff --git a/plugins/Dashboard/Controller.php b/plugins/Dashboard/Controller.php index 0fdbba275f..b9e84b891b 100644 --- a/plugins/Dashboard/Controller.php +++ b/plugins/Dashboard/Controller.php @@ -153,8 +153,11 @@ class Piwik_Dashboard_Controller extends Piwik_Controller public function getAllDashboards() { $this->checkTokenInUrl(); + if (Piwik::isUserIsAnonymous()) { + Piwik_DataTable_Renderer_Json::sendHeaderJSON(); echo '[]'; + return; } diff --git a/plugins/Dashboard/templates/dashboard.js b/plugins/Dashboard/templates/dashboard.js index 40a3cb04fd..ee9ec8867b 100644 --- a/plugins/Dashboard/templates/dashboard.js +++ b/plugins/Dashboard/templates/dashboard.js @@ -122,7 +122,7 @@ function renameDashboard() { } function removeDashboard() { - $('#removeDashboardConfirm').find('h2 span').html($('#dashboardWidgetsArea').dashboard('getDashboardName')); + $('#removeDashboardConfirm').find('h2 span').text($('#dashboardWidgetsArea').dashboard('getDashboardName')); piwikHelper.modalConfirm('#removeDashboardConfirm', {yes: function () { $('#dashboardWidgetsArea').dashboard('removeDashboard'); }}); } @@ -159,12 +159,12 @@ function copyDashboardToUser() { function (availableUsers) { $('#copyDashboardUser').empty(); $('#copyDashboardUser').append( - $('').val(piwik.userLogin).html(piwik.userLogin) + $('').val(piwik.userLogin).text(piwik.userLogin) ); $.each(availableUsers, function (index, user) { if (user.login != 'anonymous' && user.login != piwik.userLogin) { $('#copyDashboardUser').append( - $('').val(user.login).html(user.login + ' (' + user.alias + ')') + $('').val(user.login).text(user.login + ' (' + user.alias + ')') ); } }); -- cgit v1.2.3 From 782ceed6f2b4d932c281f8726cf9974f90ba242b Mon Sep 17 00:00:00 2001 From: Benaka Moorthi Date: Wed, 19 Jun 2013 19:44:56 -0700 Subject: Fixing PrivacyManager regression. --- plugins/PrivacyManager/ReportsPurger.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'plugins') diff --git a/plugins/PrivacyManager/ReportsPurger.php b/plugins/PrivacyManager/ReportsPurger.php index 4234b6b8c9..2fbc3fb6b6 100755 --- a/plugins/PrivacyManager/ReportsPurger.php +++ b/plugins/PrivacyManager/ReportsPurger.php @@ -213,7 +213,7 @@ class Piwik_PrivacyManager_ReportsPurger continue; } $date = Piwik_DataAccess_ArchiveTableCreator::getDateFromTableName($table); - list($month, $year) = explode('_', $date); + list($year, $month) = explode('_', $date); if (self::shouldReportBePurged($year, $month, $toRemoveDate)) { if ($type == Piwik_DataAccess_ArchiveTableCreator::NUMERIC_TABLE) { -- cgit v1.2.3