add icons for Character groups

www/analytics/plugins/VisitsSummary/API.php

@@ -0,0 +1,158 @@
+<?php
+/**
+ * Piwik - Open source web analytics
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ *
+ */
+namespace Piwik\Plugins\VisitsSummary;
+
+use Piwik\Archive;
+use Piwik\MetricsFormatter;
+use Piwik\Piwik;
+use Piwik\SettingsPiwik;
+
+/**
+ * VisitsSummary API lets you access the core web analytics metrics (visits, unique visitors,
+ * count of actions (page views & downloads & clicks on outlinks), time on site, bounces and converted visits.
+ *
+ * @method static \Piwik\Plugins\VisitsSummary\API getInstance()
+ */
+class API extends \Piwik\Plugin\API
+{
+    public function get($idSite, $period, $date, $segment = false, $columns = false)
+    {
+        Piwik::checkUserHasViewAccess($idSite);
+        $archive = Archive::build($idSite, $period, $date, $segment);
+
+        // array values are comma separated
+        $columns = Piwik::getArrayFromApiParameter($columns);
+        $tempColumns = array();
+
+        $bounceRateRequested = $actionsPerVisitRequested = $averageVisitDurationRequested = false;
+        if (!empty($columns)) {
+            // make sure base metrics are there for processed metrics
+            if (false !== ($bounceRateRequested = array_search('bounce_rate', $columns))) {
+                if (!in_array('nb_visits', $columns)) $tempColumns[] = 'nb_visits';
+                if (!in_array('bounce_count', $columns)) $tempColumns[] = 'bounce_count';
+                unset($columns[$bounceRateRequested]);
+            }
+            if (false !== ($actionsPerVisitRequested = array_search('nb_actions_per_visit', $columns))) {
+                if (!in_array('nb_visits', $columns)) $tempColumns[] = 'nb_visits';
+                if (!in_array('nb_actions', $columns)) $tempColumns[] = 'nb_actions';
+                unset($columns[$actionsPerVisitRequested]);
+            }
+            if (false !== ($averageVisitDurationRequested = array_search('avg_time_on_site', $columns))) {
+                if (!in_array('nb_visits', $columns)) $tempColumns[] = 'nb_visits';
+                if (!in_array('sum_visit_length', $columns)) $tempColumns[] = 'sum_visit_length';
+                unset($columns[$averageVisitDurationRequested]);
+            }
+            $tempColumns = array_unique($tempColumns);
+            rsort($tempColumns);
+            $columns = array_merge($columns, $tempColumns);
+        } else {
+            $bounceRateRequested = $actionsPerVisitRequested = $averageVisitDurationRequested = true;
+            $columns = $this->getCoreColumns($period);
+        }
+
+        $dataTable = $archive->getDataTableFromNumeric($columns);
+
+        // Process ratio metrics from base metrics, when requested
+        if ($bounceRateRequested !== false) {
+            $dataTable->filter('ColumnCallbackAddColumnPercentage', array('bounce_rate', 'bounce_count', 'nb_visits', 0));
+        }
+        if ($actionsPerVisitRequested !== false) {
+            $dataTable->filter('ColumnCallbackAddColumnQuotient', array('nb_actions_per_visit', 'nb_actions', 'nb_visits', 1));
+        }
+        if ($averageVisitDurationRequested !== false) {
+            $dataTable->filter('ColumnCallbackAddColumnQuotient', array('avg_time_on_site', 'sum_visit_length', 'nb_visits', 0));
+        }
+
+        // remove temp metrics that were used to compute processed metrics
+        $dataTable->deleteColumns($tempColumns);
+        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 (SettingsPiwik::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);
+        $archive = Archive::build($idSite, $period, $date, $segment);
+        $dataTable = $archive->getDataTableFromNumeric($toFetch);
+        return $dataTable;
+    }
+
+    public function getVisits($idSite, $period, $date, $segment = false)
+    {
+        return $this->getNumeric($idSite, $period, $date, $segment, 'nb_visits');
+    }
+
+    public function getUniqueVisitors($idSite, $period, $date, $segment = false)
+    {
+        return $this->getNumeric($idSite, $period, $date, $segment, 'nb_uniq_visitors');
+    }
+
+    public function getActions($idSite, $period, $date, $segment = false)
+    {
+        return $this->getNumeric($idSite, $period, $date, $segment, 'nb_actions');
+    }
+
+    public function getMaxActions($idSite, $period, $date, $segment = false)
+    {
+        return $this->getNumeric($idSite, $period, $date, $segment, 'max_actions');
+    }
+
+    public function getBounceCount($idSite, $period, $date, $segment = false)
+    {
+        return $this->getNumeric($idSite, $period, $date, $segment, 'bounce_count');
+    }
+
+    public function getVisitsConverted($idSite, $period, $date, $segment = false)
+    {
+        return $this->getNumeric($idSite, $period, $date, $segment, 'nb_visits_converted');
+    }
+
+    public function getSumVisitsLength($idSite, $period, $date, $segment = false)
+    {
+        return $this->getNumeric($idSite, $period, $date, $segment, 'sum_visit_length');
+    }
+
+    public function getSumVisitsLengthPretty($idSite, $period, $date, $segment = false)
+    {
+        $table = $this->getSumVisitsLength($idSite, $period, $date, $segment);
+        if (is_object($table)) {
+            $table->filter('ColumnCallbackReplace',
+                array('sum_visit_length', '\Piwik\MetricsFormatter::getPrettyTimeFromSeconds'));
+        } else {
+            $table = MetricsFormatter::getPrettyTimeFromSeconds($table);
+        }
+        return $table;
+    }
+}

www/analytics/plugins/VisitsSummary/Controller.php

@@ -0,0 +1,187 @@
+<?php
+/**
+ * Piwik - Open source web analytics
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ *
+ */
+namespace Piwik\Plugins\VisitsSummary;
+
+use Piwik\API\Request;
+use Piwik\Common;
+use Piwik\DataTable\Row;
+use Piwik\DataTable;
+use Piwik\Piwik;
+use Piwik\Plugins\Actions\API as APIActions;
+use Piwik\Site;
+use Piwik\View;
+
+/**
+ *
+ */
+class Controller extends \Piwik\Plugin\Controller
+{
+    public function index()
+    {
+        $view = new View('@VisitsSummary/index');
+        $this->setPeriodVariablesView($view);
+        $view->graphEvolutionVisitsSummary = $this->getEvolutionGraph(array('nb_visits'));
+        $this->setSparklinesAndNumbers($view);
+        return $view->render();
+    }
+
+    public function getSparklines()
+    {
+        $view = new View('@VisitsSummary/getSparklines');
+        $this->setPeriodVariablesView($view);
+        $this->setSparklinesAndNumbers($view);
+        return $view->render();
+    }
+
+    public function getEvolutionGraph(array $columns = array())
+    {
+        if (empty($columns)) {
+            $columns = Common::getRequestVar('columns');
+            $columns = Piwik::getArrayFromApiParameter($columns);
+        }
+
+        $documentation = Piwik::translate('VisitsSummary_VisitsSummaryDocumentation') . '<br />'
+            . Piwik::translate('General_BrokenDownReportDocumentation') . '<br /><br />'
+
+            . '<b>' . Piwik::translate('General_ColumnNbVisits') . ':</b> '
+            . Piwik::translate('General_ColumnNbVisitsDocumentation') . '<br />'
+
+            . '<b>' . Piwik::translate('General_ColumnNbUniqVisitors') . ':</b> '
+            . Piwik::translate('General_ColumnNbUniqVisitorsDocumentation') . '<br />'
+
+            . '<b>' . Piwik::translate('General_ColumnNbActions') . ':</b> '
+            . Piwik::translate('General_ColumnNbActionsDocumentation') . '<br />'
+
+            . '<b>' . Piwik::translate('General_ColumnActionsPerVisit') . ':</b> '
+            . Piwik::translate('General_ColumnActionsPerVisitDocumentation');
+
+        $selectableColumns = array(
+            // columns from VisitsSummary.get
+            'nb_visits',
+            'nb_uniq_visitors',
+            'avg_time_on_site',
+            'bounce_rate',
+            'nb_actions_per_visit',
+            'max_actions',
+            'nb_visits_converted',
+            // columns from Actions.get
+            'nb_pageviews',
+            'nb_uniq_pageviews',
+            'nb_downloads',
+            'nb_uniq_downloads',
+            'nb_outlinks',
+            'nb_uniq_outlinks',
+            'avg_time_generation'
+        );
+
+        $idSite = Common::getRequestVar('idSite');
+        $displaySiteSearch = Site::isSiteSearchEnabledFor($idSite);
+
+        if ($displaySiteSearch) {
+            $selectableColumns[] = 'nb_searches';
+            $selectableColumns[] = 'nb_keywords';
+        }
+
+        $view = $this->getLastUnitGraphAcrossPlugins($this->pluginName, __FUNCTION__, $columns,
+            $selectableColumns, $documentation);
+
+        return $this->renderView($view);
+    }
+
+    static public function getVisitsSummary()
+    {
+        $requestString = "method=VisitsSummary.get" .
+            "&format=original" .
+            // we disable filters for example "search for pattern", in the case this method is called
+            // by a method that already calls the API with some generic filters applied
+            "&disable_generic_filters=1";
+        $request = new Request($requestString);
+        $result = $request->process();
+        return empty($result) ? new DataTable() : $result;
+    }
+
+    static public function getVisits()
+    {
+        $requestString = "method=VisitsSummary.getVisits" .
+            "&format=original" .
+            "&disable_generic_filters=1";
+        $request = new Request($requestString);
+        return $request->process();
+    }
+
+    protected function setSparklinesAndNumbers($view)
+    {
+        $view->urlSparklineNbVisits = $this->getUrlSparkline('getEvolutionGraph', array('columns' => $view->displayUniqueVisitors ? array('nb_visits', 'nb_uniq_visitors') : array('nb_visits')));
+        $view->urlSparklineNbPageviews = $this->getUrlSparkline('getEvolutionGraph', array('columns' => array('nb_pageviews', 'nb_uniq_pageviews')));
+        $view->urlSparklineNbDownloads = $this->getUrlSparkline('getEvolutionGraph', array('columns' => array('nb_downloads', 'nb_uniq_downloads')));
+        $view->urlSparklineNbOutlinks = $this->getUrlSparkline('getEvolutionGraph', array('columns' => array('nb_outlinks', 'nb_uniq_outlinks')));
+        $view->urlSparklineAvgVisitDuration = $this->getUrlSparkline('getEvolutionGraph', array('columns' => array('avg_time_on_site')));
+        $view->urlSparklineMaxActions = $this->getUrlSparkline('getEvolutionGraph', array('columns' => array('max_actions')));
+        $view->urlSparklineActionsPerVisit = $this->getUrlSparkline('getEvolutionGraph', array('columns' => array('nb_actions_per_visit')));
+        $view->urlSparklineBounceRate = $this->getUrlSparkline('getEvolutionGraph', array('columns' => array('bounce_rate')));
+        $view->urlSparklineAvgGenerationTime = $this->getUrlSparkline('getEvolutionGraph', array('columns' => array('avg_time_generation')));
+
+        $idSite = Common::getRequestVar('idSite');
+        $displaySiteSearch = Site::isSiteSearchEnabledFor($idSite);
+        if ($displaySiteSearch) {
+            $view->urlSparklineNbSearches = $this->getUrlSparkline('getEvolutionGraph', array('columns' => array('nb_searches', 'nb_keywords')));
+        }
+        $view->displaySiteSearch = $displaySiteSearch;
+
+        $dataTableVisit = self::getVisitsSummary();
+        $dataRow = $dataTableVisit->getRowsCount() == 0 ? new Row() : $dataTableVisit->getFirstRow();
+
+
+        $view->nbUniqVisitors = (int)$dataRow->getColumn('nb_uniq_visitors');
+        $nbVisits = (int)$dataRow->getColumn('nb_visits');
+        $view->nbVisits = $nbVisits;
+
+        $view->averageVisitDuration = $dataRow->getColumn('avg_time_on_site');
+        $nbBouncedVisits = $dataRow->getColumn('bounce_count');
+        $view->bounceRate = Piwik::getPercentageSafe($nbBouncedVisits, $nbVisits);
+        $view->maxActions = (int)$dataRow->getColumn('max_actions');
+        $view->nbActionsPerVisit = $dataRow->getColumn('nb_actions_per_visit');
+
+        if(Common::isActionsPluginEnabled()) {
+            $view->showActionsPluginReports = true;
+            $dataTableActions = APIActions::getInstance()->get($idSite, Common::getRequestVar('period'), Common::getRequestVar('date'),
+                \Piwik\API\Request::getRawSegmentFromRequest());
+            $dataActionsRow =
+                $dataTableActions->getRowsCount() == 0 ? new Row() : $dataTableActions->getFirstRow();
+
+            $view->nbPageviews = (int)$dataActionsRow->getColumn('nb_pageviews');
+            $view->nbUniquePageviews = (int)$dataActionsRow->getColumn('nb_uniq_pageviews');
+            $view->nbDownloads = (int)$dataActionsRow->getColumn('nb_downloads');
+            $view->nbUniqueDownloads = (int)$dataActionsRow->getColumn('nb_uniq_downloads');
+            $view->nbOutlinks = (int)$dataActionsRow->getColumn('nb_outlinks');
+            $view->nbUniqueOutlinks = (int)$dataActionsRow->getColumn('nb_uniq_outlinks');
+            $view->averageGenerationTime = $dataActionsRow->getColumn('avg_time_generation');
+
+
+            if ($displaySiteSearch) {
+                $view->nbSearches = (int)$dataActionsRow->getColumn('nb_searches');
+                $view->nbKeywords = (int)$dataActionsRow->getColumn('nb_keywords');
+            }
+
+            // backward compatibility:
+            // show actions if the finer metrics are not archived
+            $view->showOnlyActions = false;
+            if ($dataActionsRow->getColumn('nb_pageviews')
+                + $dataActionsRow->getColumn('nb_downloads')
+                + $dataActionsRow->getColumn('nb_outlinks') == 0
+                && $dataRow->getColumn('nb_actions') > 0
+            ) {
+                $view->showOnlyActions = true;
+                $view->nbActions = $dataRow->getColumn('nb_actions');
+                $view->urlSparklineNbActions = $this->getUrlSparkline('getEvolutionGraph', array('columns' => array('nb_actions')));
+            }
+        }
+
+    }
+}

www/analytics/plugins/VisitsSummary/VisitsSummary.php

@@ -0,0 +1,80 @@
+<?php
+/**
+ * Piwik - Open source web analytics
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ *
+ */
+namespace Piwik\Plugins\VisitsSummary;
+
+use Piwik\Menu\MenuMain;
+use Piwik\Piwik;
+use Piwik\WidgetsList;
+
+/**
+ * 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
+ * Day class directly.
+ * These metrics can be used by other Plugins so they need to be processed up front.
+ *
+ */
+class VisitsSummary extends \Piwik\Plugin
+{
+    /**
+     * @see Piwik\Plugin::getListHooksRegistered
+     */
+    public function getListHooksRegistered()
+    {
+        return array(
+            'API.getReportMetadata'   => 'getReportMetadata',
+            'WidgetsList.addWidgets'  => 'addWidgets',
+            'Menu.Reporting.addItems' => 'addMenu',
+            'AssetManager.getStylesheetFiles' => 'getStylesheetFiles',
+        );
+    }
+
+    public function getReportMetadata(&$reports)
+    {
+        $reports[] = array(
+            'category'         => Piwik::translate('VisitsSummary_VisitsSummary'),
+            'name'             => Piwik::translate('VisitsSummary_VisitsSummary'),
+            'module'           => 'VisitsSummary',
+            'action'           => 'get',
+            'metrics'          => array(
+                'nb_uniq_visitors',
+                'nb_visits',
+                'nb_actions',
+                'nb_actions_per_visit',
+                'bounce_rate',
+                'avg_time_on_site' => Piwik::translate('General_VisitDuration'),
+                'max_actions'      => Piwik::translate('General_ColumnMaxActions'),
+// Used to process metrics, not displayed/used directly
+//								'sum_visit_length',
+//								'nb_visits_converted',
+            ),
+            'processedMetrics' => false,
+            'order'            => 1
+        );
+    }
+
+    public function getStylesheetFiles(&$stylesheets)
+    {
+        $stylesheets[] = "plugins/VisitsSummary/stylesheets/datatable.less";
+    }
+
+    function addWidgets()
+    {
+        WidgetsList::add('VisitsSummary_VisitsSummary', 'VisitsSummary_WidgetLastVisits', 'VisitsSummary', 'getEvolutionGraph', array('columns' => array('nb_visits')));
+        WidgetsList::add('VisitsSummary_VisitsSummary', 'VisitsSummary_WidgetVisits', 'VisitsSummary', 'getSparklines');
+        WidgetsList::add('VisitsSummary_VisitsSummary', 'VisitsSummary_WidgetOverviewGraph', 'VisitsSummary', 'index');
+    }
+
+    function addMenu()
+    {
+        MenuMain::getInstance()->add('General_Visitors', '', array('module' => 'VisitsSummary', 'action' => 'index'), true, 10);
+        MenuMain::getInstance()->add('General_Visitors', 'General_Overview', array('module' => 'VisitsSummary', 'action' => 'index'), true, 1);
+    }
+}
+
+

www/analytics/plugins/VisitsSummary/stylesheets/datatable.less

@@ -0,0 +1,6 @@
+
+#dashboard .visitsSummaryReportTitle {
+  margin-left: 0px;
+  padding-left: 10px;
+  border-top: 1px solid #ccc
+}

www/analytics/plugins/VisitsSummary/templates/_sparklines.twig

@@ -0,0 +1,69 @@
+<div id='leftcolumn'>
+    <div class="sparkline">
+        {{ sparkline(urlSparklineNbVisits)|raw }}
+        {{ 'General_NVisits'|translate("<strong>"~nbVisits~"</strong>")|raw }}{% if displayUniqueVisitors %},
+            {{ 'VisitsSummary_NbUniqueVisitors'|translate("<strong>"~nbUniqVisitors~"</strong>")|raw }}{% endif %}
+    </div>
+    <div class="sparkline">
+        {{ sparkline(urlSparklineAvgVisitDuration)|raw }}
+        {% set averageVisitDuration=averageVisitDuration|sumtime %}
+        {{ 'VisitsSummary_AverageVisitDuration'|translate("<strong>"~averageVisitDuration~"</strong>")|raw }}
+    </div>
+    <div class="sparkline">
+        {{ sparkline(urlSparklineBounceRate)|raw }}
+        {{ 'VisitsSummary_NbVisitsBounced'|translate("<strong>"~bounceRate~"%</strong>")|raw }}
+    </div>
+    <div class="sparkline">
+        {{ sparkline(urlSparklineActionsPerVisit)|raw }}
+        {{ 'VisitsSummary_NbActionsPerVisit'|translate("<strong>"~nbActionsPerVisit~"</strong>")|raw }}
+    </div>
+    {% if showActionsPluginReports|default(false) %}
+	<div class="sparkline">
+        {{ sparkline(urlSparklineAvgGenerationTime)|raw }}
+		{% set averageGenerationTime=averageGenerationTime|sumtime %}
+		{{ 'VisitsSummary_AverageGenerationTime'|translate("<strong>"~averageGenerationTime~"</strong>")|raw }}
+	</div>
+    {% endif %}
+</div>
+
+<div id='rightcolumn'>
+    {% if showActionsPluginReports|default(false) %}
+        {% if showOnlyActions %}
+            <div class="sparkline">
+                {{ sparkline(urlSparklineNbActions)|raw }}
+                {{ 'VisitsSummary_NbActionsDescription'|translate("<strong>"~nbActions~"</strong>")|raw }}
+            </div>
+        {% else %}
+            <div class="sparkline">
+                {{ sparkline(urlSparklineNbPageviews)|raw }}
+                {{ 'VisitsSummary_NbPageviewsDescription'|translate("<strong>"~nbPageviews~"</strong>")|trim|raw }},
+                {{ 'VisitsSummary_NbUniquePageviewsDescription'|translate("<strong>"~nbUniquePageviews~"</strong>")|raw }}
+            </div>
+            {% if displaySiteSearch %}
+                <div class="sparkline">
+                    {{ sparkline(urlSparklineNbSearches)|raw }}
+                    {{ 'VisitsSummary_NbSearchesDescription'|translate("<strong>"~nbSearches~"</strong>")|trim|raw }},
+                    {{ 'VisitsSummary_NbKeywordsDescription'|translate("<strong>"~nbKeywords~"</strong>")|raw }}
+                </div>
+            {% endif %}
+            <div class="sparkline">
+                    {{ sparkline(urlSparklineNbDownloads)|raw }}
+                    {{ 'VisitsSummary_NbDownloadsDescription'|translate("<strong>"~nbDownloads~"</strong>")|trim|raw }},
+                    {{ 'VisitsSummary_NbUniqueDownloadsDescription'|translate("<strong>"~nbUniqueDownloads~"</strong>")|raw }}
+            </div>
+            <div class="sparkline">
+                    {{ sparkline(urlSparklineNbOutlinks)|raw }}
+                    {{ 'VisitsSummary_NbOutlinksDescription'|translate("<strong>"~nbOutlinks~"</strong>")|trim|raw }},
+                    {{ 'VisitsSummary_NbUniqueOutlinksDescription'|translate("<strong>"~nbUniqueOutlinks~"</strong>")|raw }}
+            </div>
+            {% endif %}
+    {% endif %}
+    <div class="sparkline">
+            {{ sparkline(urlSparklineMaxActions)|raw }}
+            {{ 'VisitsSummary_MaxNbActions'|translate("<strong>"~maxActions~"</strong>")|raw }}
+    </div>
+</div>
+<div style="clear:both;"></div>
+
+{% include "_sparklineFooter.twig" %}
+

www/analytics/plugins/VisitsSummary/templates/getSparklines.twig

@@ -0,0 +1 @@
+{% include "@VisitsSummary/_sparklines.twig" %}

www/analytics/plugins/VisitsSummary/templates/index.twig

@@ -0,0 +1,16 @@
+{# This graphId must be unique for this report #}
+<h2 piwik-enriched-headline
+    data-graph-id="VisitsSummary.getEvolutionGraph"
+        >{{ 'General_EvolutionOverPeriod'|translate }}</h2>
+
+{{ graphEvolutionVisitsSummary|raw }}
+
+<h2 class="visitsSummaryReportTitle">{{ 'General_Report'|translate }}</h2>
+{% include "@VisitsSummary/_sparklines.twig" %}
+{#
+Time page generation
+	<p style='color:lightgrey; size:0.8em;'>
+	{{ 'VisitsSummary_GenerateTime'|translate(totalTimeGeneration,totalNumberOfQueries) }}
+	{% if totalNumberOfQueries != 0 %}, {{ 'VisitsSummary_GenerateQueries'|translate(totalNumberOfQueries) }}{% endif %}
+	</p>
+#}