From d42f2f2abcb40db34013c5bf2218626d75261ba9 Mon Sep 17 00:00:00 2001
From: Benaka Moorthi <benaka.moorthi@gmail.com>
Date: Sat, 10 Aug 2013 14:50:25 -0400
Subject: [PATCH] Refs #3089, fix namespace bug in PluginsArchiver.php, i18n &
tweak visitor profile popup, and only display ecommerce info on visitor
profile if ecommerce is enabled for the site.
---
core/PluginsArchiver.php | 4 +-
lang/en.php | 10 ++++
plugins/Live/API.php | 37 +++++++-----
plugins/Live/Controller.php | 20 ++-----
plugins/Live/stylesheets/visitor_profile.less | 29 +++++----
.../templates/getVisitorProfilePopup.twig | 59 +++++++++++--------
plugins/UserCountryMap/Controller.php | 29 +++++----
7 files changed, 108 insertions(+), 80 deletions(-)
diff --git a/core/PluginsArchiver.php b/core/PluginsArchiver.php
index 1fa0be8ed0..981c6fbce5 100644
--- a/core/PluginsArchiver.php
+++ b/core/PluginsArchiver.php
@@ -13,8 +13,6 @@ namespace Piwik;
use Piwik\Config;
use Piwik\Common;
use Piwik\ArchiveProcessor;
-use Piwik\ArchiveProcessor\Day;
-use Piwik\ArchiveProcessor\Period;
use Piwik\DataAccess\LogAggregator;
/**
@@ -47,7 +45,7 @@ abstract class PluginsArchiver
}
/**
- * @return Day|Period
+ * @return \Piwik\ArchiveProcessor\Day|\Piwik\ArchiveProcessor\Period
*/
protected function getProcessor()
{
diff --git a/lang/en.php b/lang/en.php
index 745b5b0471..1c780d52f8 100644
--- a/lang/en.php
+++ b/lang/en.php
@@ -23,6 +23,7 @@ $translations = array(
'General_NotValid' => '%s is not valid',
'General_NotDefined' => '%s not defined',
'General_Id' => 'Id',
+ 'General_IP' => 'IP',
'General_Error' => 'Error',
'General_Warning' => 'Warning',
'General_BackToHomepage' => 'Back to Piwik homepage',
@@ -390,6 +391,8 @@ $translations = array(
'General_DefaultAppended' => '(default)',
'General_SearchNoResults' => 'No results',
'General_ReadThisToLearnMore' => '%1$sRead this to learn more.%2$s',
+ 'General_Summary' => 'Summary',
+ 'General_SeeAll' => 'see all',
'Actions_PluginDescription' => 'Reports about the page views, the outlinks and downloads. Outlinks and Downloads tracking is automatic! You can also track your internal website\'s Search Engine.',
'Actions_Actions' => 'Actions',
'Actions_SubmenuPages' => 'Pages',
@@ -1120,6 +1123,13 @@ Piwik will let you track visitors to your website for free. You should definitel
'Live_RealTimeVisitorCount' => 'Real Time Visitor Count',
'Live_SimpleRealTimeWidget_Message' => '%s and %s in the last %s',
'Live_VisitorProfile' => 'Visitor profile',
+ 'Live_FirstVisit' => 'First visit',
+ 'Live_LastVisit' => 'Last visit',
+ 'Live_VisitSummary' => 'Spent a total of %1$s%2$s on the website%3$s, and %4$sviewed %5$s pages in %6$s visits.%7$s',
+ 'Live_ConvertedNGoals' => 'Converted %s Goals',
+ 'Live_EcommerceSummary' => 'Ecommerce: %1$s%2$s orders for a total of %3$s%4$s, purchased %5$s items.',
+ 'Live_VisitedPages' => 'Visited pages',
+ 'Live_ViewMoreVisitInfo' => 'View more visitor information',
'Login_PluginDescription' => 'Login Authentication plugin, reading the credentials from the config/config.inc.php file for the Super User, and from the Database for the other users. Can be easily replaced to introduce a new Authentication mechanism (OpenID, htaccess, custom Auth, etc.).',
'Login_LoginPasswordNotCorrect' => 'Wrong Username and password combination.',
'Login_Password' => 'Password',
diff --git a/plugins/Live/API.php b/plugins/Live/API.php
index 1815450673..8f43f26563 100644
--- a/plugins/Live/API.php
+++ b/plugins/Live/API.php
@@ -168,7 +168,7 @@ class Piwik_Live_API
public function getVisitorProfile($idSite, $period, $date, $idVisitor, $segment = false)
{
if ($segment !== false) {
- $segment .= '&';
+ $segment .= ';';
}
$segment .= 'visitorId==' . $idVisitor; // TODO what happens when visitorId is in the segment?
@@ -177,10 +177,25 @@ class Piwik_Live_API
return array();
}
+ $isEcommerceEnabled = Site::isEcommerceEnabledFor($idSite);
+
$result = array();
+ $result['totalVisits'] = 0;
+ $result['totalVisitDuration'] = 0;
+ $result['totalActionCount'] = 0;
+ $result['totalGoalConversions'] = 0;
+ $result['totalConversionsByGoal'] = array();
+
+ if ($isEcommerceEnabled) {
+ $result['totalEcommerceConversions'] = 0;
+ $result['totalEcommerceRevenue'] = 0;
+ $result['totalEcommerceItems'] = 0;
+ $result['totalAbandonedCarts'] = 0;
+ $result['totalAbandonedCartsRevenue'] = 0;
+ $result['totalAbandonedCartsItems'] = 0;
+ }
// use the most recent visit for IP/browser/OS/etc. info
- // TODO: could just do all of this in twig/JS... really need to do it here?
$mostRecentVisit = $visits->getFirstRow();
$result['latestVisitIp'] = $mostRecentVisit->getColumn('visitIp');
$result['visitorId'] = $mostRecentVisit->getColumn('visitorId');
@@ -194,16 +209,6 @@ class Piwik_Live_API
$result['customVariables'] = $mostRecentVisit->getColumn('customVariables');
// aggregate all requested visits info for total_* info
- $result['totalVisits'] = 0;
- $result['totalVisitDuration'] = 0;
- $result['totalActionCount'] = 0;
- $result['totalGoalConversions'] = 0;
- $result['totalEcommerceConversions'] = 0;
- $result['totalEcommerceRevenue'] = 0;
- $result['totalEcommerceItems'] = 0;
- $result['totalAbandonedCarts'] = 0;
- $result['totalAbandonedCartsRevenue'] = 0;
- $result['totalAbandonedCartsItems'] = 0;
foreach ($visits->getRows() as $visit) {
++$result['totalVisits'];
@@ -227,11 +232,15 @@ class Piwik_Live_API
}
$result['totalRevenueByGoal'][$idGoal] += $action['revenue'];
}
- } else if ($action['type'] == Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER) { // handle ecommerce order
+ } else if ($action['type'] == Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER // handle ecommerce order
+ && $isEcommerceEnabled
+ ) {
++$result['totalEcommerceConversions'];
$result['totalEcommerceRevenue'] += $action['revenue'];
$result['totalEcommerceItems'] += $action['items'];
- } else if ($action['type'] == Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_CART) { // handler abandoned cart
+ } else if ($action['type'] == Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_CART // handler abandoned cart
+ && $isEcommerceEnabled
+ ) {
++$result['totalAbandonedCarts'];
$result['totalAbandonedCartsRevenue'] += $action['revenue'];
$result['totalAbandonedCartsItems'] += $action['items'];
diff --git a/plugins/Live/Controller.php b/plugins/Live/Controller.php
index b9a7962815..23ae378074 100644
--- a/plugins/Live/Controller.php
+++ b/plugins/Live/Controller.php
@@ -100,7 +100,6 @@ class Piwik_Live_Controller extends Controller
*/
public function getVisitorLog($fetch = false)
{
- $test = array(); $str = (string)$test;
return $this->getLastVisitsDetails($fetch);
}
@@ -134,7 +133,7 @@ class Piwik_Live_Controller extends Controller
}
/**
- * TODO
+ * Echo's HTML for visitor profile popup.
*/
public function getVisitorProfilePopup()
{
@@ -150,19 +149,12 @@ class Piwik_Live_Controller extends Controller
private function getUserCountryMapForVisitorProfile()
{
- if (empty($_GET['segment'])) {
- $_GET['segment'] = '';
- $originalSegment = '';
- } else {
- $_GET['segment'] .= '&';
- $originalSegment = $_GET['segment'];
+ $segment = Request::getRawSegmentFromRequest();
+ if (!empty($segment)) {
+ $segment .= ';';
}
- $_GET['segment'] .= 'visitorId==' . Common::getRequestVar('idVisitor');
-
- $result = FrontController::getInstance()->fetchDispatch('UserCountryMap', 'visitorMap', array('fetch' => true)); // TODO: check if plugin is enabled?
-
- $_GET['segment'] = $originalSegment;
- return $result;
+ $params = array('fetch' => true, 'segment' => $segment . 'visitorId==' . Common::getRequestVar('idVisitor'));
+ return FrontController::getInstance()->fetchDispatch('UserCountryMap', 'visitorMap', $params); // TODO: check if plugin is enabled?
}
}
\ No newline at end of file
diff --git a/plugins/Live/stylesheets/visitor_profile.less b/plugins/Live/stylesheets/visitor_profile.less
index 6b94c5ce8a..7b43319886 100644
--- a/plugins/Live/stylesheets/visitor_profile.less
+++ b/plugins/Live/stylesheets/visitor_profile.less
@@ -152,6 +152,7 @@
}
.visitor-profile-browser {
+ margin-left: 5px;
width:75px;
display:inline-block;
}
@@ -206,6 +207,10 @@
margin-top:6px;
}
+.visitor-profile-summary strong {
+ padding-left:0;
+}
+
.visitor-profile-important-visits {
> div {
@@ -244,7 +249,7 @@
}
}
-.visitor-profile-actions {
+.visitor-profile-visits-container {
height:550px;
overflow-y:auto;
position:relative;
@@ -253,9 +258,6 @@
padding:0 18px 0 13px;
ol {
- counter-reset:item;
- list-style-type:none;
-
> li {
display:block;
font-size:12px;
@@ -270,6 +272,15 @@
padding-left:0;
}
}
+ }
+
+ ol.visitor-profile-visits > li {
+ margin-left:0;
+ }
+
+ ol.visitor-profile-actions {
+ counter-reset:item;
+ list-style-type:none;
> li:before {
content:counter(item) " ";
@@ -278,19 +289,15 @@
}
// TODO: unordered lists no longer used, remove
- ol li ul,ol li ol {
+ ol li ol {
border-top:1px solid #d1cec8;
}
- ol li ul {
- padding-left:15px;
- }
-
ol > li > ol > li {
margin-left:-12px;
}
- ol li ul li,ol li ol li {
+ ol li ol li {
display:block;
color:#5e5e5c;
font-size:13px;
@@ -303,7 +310,7 @@
padding-bottom:4px;
}
- ol li ul li a,ol li ol li a {
+ ol li ol li a {
display:inline-block;
}
diff --git a/plugins/Live/templates/getVisitorProfilePopup.twig b/plugins/Live/templates/getVisitorProfilePopup.twig
index c351ecf570..b53389d179 100644
--- a/plugins/Live/templates/getVisitorProfilePopup.twig
+++ b/plugins/Live/templates/getVisitorProfilePopup.twig
@@ -4,18 +4,18 @@
<div>
<div class="visitor-profile-avatar">
<div>
- <div class="visitor-profile-image-frame"><!-- TODO translate -->
+ <div class="visitor-profile-image-frame">
<img src="plugins/Live/images/REMOVE_ME_avatar.jpg" alt=""/>
</div>
<img src="plugins/Live/images/paperclip.png" alt=""/>
</div>
<div>
- <h1>Visitor profile</h1>
+ <h1>{{ 'Live_VisitorProfile'|translate }}</h1>
<div>
<div class="visitor-profile-latest-visit-column">
<ul>
- <li><span>IP</span><strong>{{ visitorData.latestVisitIp }}</strong></li>
- <li><span>ID</span><strong>{{ visitorData.visitorId }}</strong></li>
+ <li><span>{{ 'General_IP'|translate }}</span><strong>{{ visitorData.latestVisitIp }}</strong></li>
+ <li><span>{{ 'General_Id'|translate|upper }}</span><strong>{{ visitorData.visitorId }}</strong></li>
<li>
<div class="visitor-profile-browser">
<img src="{{ visitorData.browserLogo }}"/><span>{{ visitorData.browserName }}</span>
@@ -24,7 +24,7 @@
<img src="{{ visitorData.operatingSystemLogo }}"/><span>{{ visitorData.operatingSystemShortName }}</span>
</div>
</li>
- <li><span>Resolution</span><strong>{{ visitorData.resolution }}</strong></li>
+ <li><span>{{ 'UserSettings_ColumnResolution'|translate }}</span><strong>{{ visitorData.resolution }}</strong></li>
</ul>
</div>
<div class="visitor-profile-latest-visit-column">
@@ -49,48 +49,51 @@
</div>
<div class="visitor-profile-important-visits">
<div>
- <h1>First visit</h1>
+ <h1>{{ 'Live_FirstVisit'|translate }}</h1>
<div>
- <p><strong>{{ visitorData.firstVisit.prettyDate }}</strong><span> - {{ visitorData.firstVisit.daysAgo }} days ago</span></p>
- <p><span>from:</span>
+ <p><strong>{{ visitorData.firstVisit.prettyDate }}</strong><span> - {{ 'UserCountryMap_DaysAgo'|translate(visitorData.firstVisit.daysAgo) }}</span></p>
+ <p><span>{{ 'General_FromReferrer'|translate }}:</span>
<strong>{{ visitorData.firstVisit.referralSummary }}</strong></p>
</div>
</div>
<div>
- <h1>Last visit</h1>
+ <h1>{{ 'Live_LastVisit'|translate }}</h1>
<div>
- <p><strong>{{ visitorData.lastVisit.prettyDate }}</strong><span> - {{ visitorData.lastVisit.daysAgo }} days ago</span></p>
- <p><span>from:</span>
+ <p><strong>{{ visitorData.lastVisit.prettyDate }}</strong><span> - {{ 'UserCountryMap_DaysAgo'|translate(visitorData.lastVisit.daysAgo) }}</span></p>
+ <p><span>{{ 'General_FromReferrer'|translate }}:</span>
<strong>{{ visitorData.lastVisit.referralSummary }}</strong></p>
</div>
</div>
</div>
<div class="visitor-profile-summary">
- <h1>Summary</h1>
+ <h1>{{ 'General_Summary'|translate }}</h1>
<div>
- <p>Spent a total of <strong>{{ visitorData.totalVisitDurationPretty|raw }} on the website</strong>, and <strong>viewed {{ visitorData.totalActionCount }} pages in {{ visitorData.totalVisits }} visits.</strong></p>
- <p><strong>Converted {{ visitorData.totalGoalConversions }} Goals</strong> (
+ <p>{{ 'Live_VisitSummary'|translate('<strong>', visitorData.totalVisitDurationPretty, '</strong>', '<strong>', visitorData.totalActionCount, visitorData.totalVisits, '</strong>')|raw }}</p>
+ <p><strong>{{ 'Live_ConvertedNGoals'|translate(visitorData.totalGoalConversions) }}</strong>
+ {%- if visitorData.totalGoalConversions %} (
{%- for idGoal, totalConversions in visitorData.totalConversionsByGoal -%}
{%- if not loop.first %}, {% endif -%}{{- totalConversions }} <span class="visitor-profile-goal-name">{{ goals[idGoal]['name'] -}}</span>
{%- endfor -%}
- ).</p>
- <p>Ecommerce: <strong>{{ visitorData.totalEcommerceConversions }} orders for a total of {{ visitorData.totalEcommerceRevenue|money(idSite)|raw }}</strong>, purchased {{ visitorData.totalEcommerceItems }} items.</p>
+ ){% endif %}.</p>
+ {% if visitorData.totalEcommerceConversions is defined %}
+ <p>{{ 'Live_EcommerceSummary'|translate('<strong>', visitorData.totalEcommerceConversions, visitorData.totalEcommerceRevenue|money(idSite), '</strong>', visitorData.totalEcommerceItems)|raw }}</p>
+ {% endif %}
</div>
</div>
</div>
<div>
<div class="visitor-profile-location">
- <h1>Location</h1>
- <img src="plugins/Live/images/REMOVE_ME_chart.png" alt=""/> {# TODO: country & bar graph #}
+ <h1>{{ 'UserCountry_Location'|translate }}</h1>
+ <img src="plugins/Live/images/REMOVE_ME_chart.png" alt=""/> {# TODO: bar graph #}
</div>
<div class="visitor-profile-pages-visited">
- <h1>Visited pages<a href>see all</a></h1>
+ <h1>{{ 'Live_VisitedPages'|translate }}<a href>{{ 'General_SeeAll'|translate }}</a></h1>
</div>
- <div class="visitor-profile-actions">
- <ol>
+ <div class="visitor-profile-visits-container">
+ <ol class="visitor-profile-visits">
{% for visitInfo in visitorData.lastVisits.getRows() %}
- <li><h2>Visit</h2><span class="visitor-profile-date">{{ visitInfo.getColumn('serverDatePrettyFirstAction') }}</span>
- <ol>
+ <li><h2>{{ 'General_Visit'|translate }} #{{ loop.index }}</h2><span> - ({{ visitInfo.getColumn('visitDurationPretty')|raw }})</span><span class="visitor-profile-date">{{ visitInfo.getColumn('serverDatePrettyFirstAction') }}</span>
+ <ol class="visitor-profile-actions">
{% include "@Live/_actionsList.twig" with {'actionDetails': visitInfo.getColumn('actionDetails'),
'javascriptVariablesToSet': {
'filterEcommerce': false,
@@ -107,12 +110,12 @@
</div>
</div>
<div class="visitor-profile-more-info">
- <a href="#">View more visitor information</a>
+ <a href="#">{{ 'Live_ViewMoreVisitInfo'|translate }}</a>
</div>
</div>
<script type="text/javascript">
$(function() {
- $('.visitor-profile-actions').jScrollPane({
+ $('.visitor-profile-visits-container').jScrollPane({
showArrows: true,
verticalArrowPositions: 'os',
horizontalArrowPositions: 'os'
@@ -123,5 +126,11 @@ $(function() {
Piwik_Popover.close();
return false;
});
+
+ $('.visitor-profile-pages-visited,.visitor-profile-more-info').click(function (e) {
+ e.preventDefault();
+ alert('STUB');
+ return false;
+ })
});
</script>
\ No newline at end of file
diff --git a/plugins/UserCountryMap/Controller.php b/plugins/UserCountryMap/Controller.php
index f795958f84..d057c728c7 100644
--- a/plugins/UserCountryMap/Controller.php
+++ b/plugins/UserCountryMap/Controller.php
@@ -27,7 +27,7 @@ class Piwik_UserCountryMap_Controller extends Controller
// By default plot up to the last 30 days of visitors on the map, for low traffic sites
const REAL_TIME_WINDOW = 'last30';
- public function visitorMap($fetch = false)
+ public function visitorMap($fetch = false, $segmentOverride = false)
{
$this->checkUserCountryPluginEnabled();
@@ -36,7 +36,7 @@ class Piwik_UserCountryMap_Controller extends Controller
$period = Common::getRequestVar('period');
$date = Common::getRequestVar('date');
- $segment = Common::getRequestVar('segment', '', 'string');
+ $segment = $segmentOverride ?: Request::getRawSegmentFromRequest() ?: '';
$token_auth = Piwik::getCurrentUserTokenAuth();
$view = new View('@UserCountryMap/visitorMap');
@@ -47,19 +47,20 @@ class Piwik_UserCountryMap_Controller extends Controller
. '&idSite=' . $idSite
. '&period=' . $period
. '&date=' . $date
+ . '&segment=' . $segment
. '&token_auth=' . $token_auth
. '&filter_limit=-1'
);
$config = array();
$config['visitsSummary'] = unserialize($request->process());
$config['countryDataUrl'] = $this->_report('UserCountry', 'getCountry',
- $idSite, $period, $date, $token_auth);
+ $idSite, $period, $date, $token_auth, false, $segment);
$config['regionDataUrl'] = $this->_report('UserCountry', 'getRegion',
- $idSite, $period, $date, $token_auth, true);
+ $idSite, $period, $date, $token_auth, true, $segment);
$config['cityDataUrl'] = $this->_report('UserCountry', 'getCity',
- $idSite, $period, $date, $token_auth, true);
+ $idSite, $period, $date, $token_auth, true, $segment);
$config['countrySummaryUrl'] = $this->getApiRequestUrl('VisitsSummary', 'get',
- $idSite, $period, $date, $token_auth, true);
+ $idSite, $period, $date, $token_auth, true, $segment);
$view->defaultMetric = 'nb_visits';
// some translations
@@ -164,7 +165,9 @@ class Piwik_UserCountryMap_Controller extends Controller
$params['format'] = 'json';
$params['showRawMetrics'] = 1;
$segment = \Piwik\API\Request::getRawSegmentFromRequest();
- if(!empty($segment)) {
+ if (!empty($segment)
+ && !empty($params['segment'])
+ ) {
$params['segment'] = $segment;
}
@@ -204,7 +207,7 @@ class Piwik_UserCountryMap_Controller extends Controller
return $metrics;
}
- private function getApiRequestUrl($module, $action, $idSite, $period, $date, $token_auth, $filter_by_country = false)
+ private function getApiRequestUrl($module, $action, $idSite, $period, $date, $token_auth, $filter_by_country = false, $segmentOverride = false)
{
// use processed reports
$url = "?module=" . $module
@@ -213,7 +216,7 @@ class Piwik_UserCountryMap_Controller extends Controller
. "&period=" . $period
. "&date=" . $date
. "&token_auth=" . $token_auth
- . "&segment=" . Common::getRequestVar('segment', '', 'string')
+ . "&segment=" . ($segmentOverride ?: Request::getRawSegmentFromRequest())
. "&enable_filter_excludelowpop=1"
. "&showRawMetrics=1";
@@ -228,9 +231,9 @@ class Piwik_UserCountryMap_Controller extends Controller
return $url;
}
- private function _report($module, $action, $idSite, $period, $date, $token_auth, $filter_by_country = false)
+ private function _report($module, $action, $idSite, $period, $date, $token_auth, $filter_by_country = false, $segmentOverride = false)
{
- return $this->getApiRequestUrl('API', 'getProcessedReport&apiModule=' . $module . '&apiAction=' . $action, $idSite, $period, $date, $token_auth, $filter_by_country);
+ return $this->getApiRequestUrl('API', 'getProcessedReport&apiModule=' . $module . '&apiAction=' . $action,
+ $idSite, $period, $date, $token_auth, $filter_by_country, $segmentOverride);
}
-
-}
+}
\ No newline at end of file
--
GitLab