Skip to content
This repository
tag: 0.5.5
Fetching contributors…

Cannot retrieve contributors at this time

file 371 lines (330 sloc) 11.388 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
*
* @category Piwik
* @package Piwik
*/

/**
* Parent class of all plugins Controllers (located in /plugins/PluginName/Controller.php
* It defines some helper functions controllers can use.
*
* @package Piwik
*/
abstract class Piwik_Controller
{
/**
* Plugin name, eg. Referers
* @var string
*/
protected $pluginName;

/**
* Date string
*
* @var string
*/
protected $strDate;

/**
* Piwik_Date object or null if the requested date is a range
*
* @var Piwik_Date|null
*/
protected $date;

/**
* Builds the controller object, reads the date from the request, extracts plugin name from
*/
function __construct()
{
$aPluginName = explode('_', get_class($this));
$this->pluginName = $aPluginName[1];
$this->strDate = Piwik_Common::getRequestVar('date', 'yesterday', 'string');
try{
// the date looks like YYYY-MM-DD we can build it
$this->date = Piwik_Date::factory($this->strDate);
$this->strDate = $this->date->toString();
} catch(Exception $e){
// the date looks like YYYY-MM-DD,YYYY-MM-DD or other format
$this->date = null;
}
}

/**
* Returns the name of the default method that will be called
* when visiting: index.php?module=PluginName without the action parameter
*
* @return string
*/
function getDefaultAction()
{
return 'index';
}

protected $standardColumnNameToTranslation = array(
'label' => 'General_ColumnLabel',
'nb_visits' => 'General_ColumnNbVisits',
'nb_actions' => 'General_ColumnNbActions',
'max_actions' => 'General_ColumnMaxActions',
'sum_visit_length' => 'General_ColumnSumVisitLength',
'nb_uniq_visitors' => 'General_ColumnNbUniqVisitors',
'nb_actions_per_visit' => 'General_ColumnActionsPerVisit',
'avg_time_on_site' => 'General_ColumnAvgTimeOnSite',
'bounce_rate' => 'General_ColumnBounceRate',

'revenue_per_visit' => 'General_ColumnValuePerVisit',
'goals_conversion_rate' => 'General_ColumnVisitsWithConversions',
);

/**
* Given an Object implementing Piwik_iView interface, we either:
* - echo the output of the rendering if fetch = false
* - returns the output of the rendering if fetch = true
*
* @param Piwik_ViewDataTable $view
* @param bool $fetch
* @return string|void
*/
protected function renderView( Piwik_ViewDataTable $view, $fetch = false)
{
Piwik_PostEvent( 'Controller.renderView',
$this,
array( 'view' => $view,
'controllerName' => $view->getCurrentControllerName(),
'controllerAction' => $view->getCurrentControllerAction(),
'apiMethodToRequestDataTable' => $view->getApiMethodToRequestDataTable(),
'controllerActionCalledWhenRequestSubTable' => $view->getControllerActionCalledWhenRequestSubTable(),
)
);

$standardColumnNameToTranslation = array_map('Piwik_Translate', $this->standardColumnNameToTranslation);
$view->setColumnsTranslations($standardColumnNameToTranslation);
$view->main();
$rendered = $view->getView()->render();
if($fetch)
{
return $rendered;
}
echo $rendered;
}

/**
* Returns a ViewDataTable object of an Evolution graph
* for the last30 days/weeks/etc. of the current period, relative to the current date.
*
* @param string $currentModuleName
* @param string $currentControllerAction
* @param string $apiMethod
* @return Piwik_ViewDataTable_GenerateGraphHTML_ChartEvolution
*/
protected function getLastUnitGraph($currentModuleName, $currentControllerAction, $apiMethod)
{
$view = Piwik_ViewDataTable::factory('graphEvolution');
$view->init( $currentModuleName, $currentControllerAction, $apiMethod );

// if the date is not yet a nicely formatted date range ie. YYYY-MM-DD,YYYY-MM-DD we build it
// otherwise the current controller action is being called with the good date format already so it's fine
// see constructor
if( !is_null($this->date))
{
$view->setParametersToModify(
$this->getGraphParamsModified( array('date' => $this->strDate))
);
}

return $view;
}

/**
* Returns the array of new processed parameters once the parameters are applied.
* For example: if you set range=last30 and date=2008-03-10,
* the date element of the returned array will be "2008-02-10,2008-03-10"
*
* Parameters you can set:
* - range: last30, previous10, etc.
* - date: YYYY-MM-DD, today, yesterday
* - period: day, week, month, year
*
* @param array paramsToSet = array( 'date' => 'last50', 'viewDataTable' =>'sparkline' )
*/
protected function getGraphParamsModified($paramsToSet = array())
{
if(!isset($paramsToSet['range']))
{
$range = 'last30';
}
else
{
$range = $paramsToSet['range'];
}

if(!isset($paramsToSet['date']))
{
$endDate = $this->strDate;
}
else
{
$endDate = $paramsToSet['date'];
}

if(!isset($paramsToSet['period']))
{
$period = Piwik_Common::getRequestVar('period');
}
else
{
$period = $paramsToSet['period'];
}
$last30Relative = new Piwik_Period_Range($period, $range );

$last30Relative->setDefaultEndDate(Piwik_Date::factory($endDate));

$paramDate = $last30Relative->getDateStart()->toString() . "," . $last30Relative->getDateEnd()->toString();

$params = array_merge($paramsToSet , array( 'date' => $paramDate ) );

return $params;
}

/**
* Returns a numeric value from the API.
* Works only for API methods that originally returns numeric values (there is no cast here)
*
* @param string $methodToCall, eg. Referers.getNumberOfDistinctSearchEngines
* @return int|float
*/
protected function getNumericValue( $methodToCall )
{
$requestString = 'method='.$methodToCall.'&format=original';
$request = new Piwik_API_Request($requestString);
return $request->process();
}

/**
* Returns the current URL to use in a img src=X to display a sparkline.
* $action must be the name of a Controller method that requests data using the Piwik_ViewDataTable::factory
* It will automatically build a sparkline by setting the viewDataTable=sparkline parameter in the URL.
* It will also computes automatically the 'date' for the 'last30' days/weeks/etc.
*
* @param string $action, eg. method name of the controller to call in the img src
* @param array array of name => value of parameters to set in the generated GET url
* @return string the generated URL
*/
protected function getUrlSparkline( $action, $customParameters = array() )
{
$params = $this->getGraphParamsModified(
array( 'viewDataTable' => 'sparkline',
'action' => $action,
'module' => $this->pluginName)
+ $customParameters
);
$url = Piwik_Url::getCurrentQueryStringWithParametersModified($params);
return $url;
}

protected function setMinDateView(Piwik_Date $minDate, $view)
{
$view->minDateYear = $minDate->toString('Y');
$view->minDateMonth = $minDate->toString('m');
$view->minDateDay = $minDate->toString('d');
}

protected function setGeneralVariablesView($view)
{
$view->date = $this->strDate;

try {
$this->setPeriodVariablesView($view);
$period = Piwik_Period::factory(Piwik_Common::getRequestVar('period'), Piwik_Date::factory($this->strDate));
$view->prettyDate = $period->getLocalizedLongString();
$idSite = Piwik_Common::getRequestVar('idSite');
$view->idSite = $idSite;
$site = new Piwik_Site($idSite);
$view->siteName = $site->getName();
$view->siteMainUrl = $site->getMainUrl();

$minDate = $site->getCreationDate();
$this->setMinDateView($minDate, $view);

$maxDate = Piwik_Date::factory('today');
$view->maxDateYear = $maxDate->toString('Y');
$view->maxDateMonth = $maxDate->toString('m');
$view->maxDateDay = $maxDate->toString('d');

$view->debugTrackVisitsInsidePiwikUI = Zend_Registry::get('config')->Debug->track_visits_inside_piwik_ui;

$view->isSuperUser = Zend_Registry::get('access')->isSuperUser();
} catch(Exception $e) {
self::redirectToIndex(Piwik::getModule(), Piwik::getAction());
}
}

public static function setPeriodVariablesView($view)
{
if(isset($view->period))
{
return;
}
$currentPeriod = Piwik_Common::getRequestVar('period');
$availablePeriods = array('day', 'week', 'month', 'year');
if(!in_array($currentPeriod,$availablePeriods))
{
throw new Exception("Period must be one of: ".implode(",",$availablePeriods));
}
$periodNames = array(
'day' => array('singular' => Piwik_Translate('CoreHome_PeriodDay'), 'plural' => Piwik_Translate('CoreHome_PeriodDays')),
'week' => array('singular' => Piwik_Translate('CoreHome_PeriodWeek'), 'plural' => Piwik_Translate('CoreHome_PeriodWeeks')),
'month' => array('singular' => Piwik_Translate('CoreHome_PeriodMonth'), 'plural' => Piwik_Translate('CoreHome_PeriodMonths')),
'year' => array('singular' => Piwik_Translate('CoreHome_PeriodYear'), 'plural' => Piwik_Translate('CoreHome_PeriodYears')),
);

$found = array_search($currentPeriod,$availablePeriods);
if($found !== false)
{
unset($availablePeriods[$found]);
}
$view->period = $currentPeriod;
$view->otherPeriods = $availablePeriods;
$view->periodsNames = $periodNames;
}

function redirectToIndex($moduleToRedirect, $actionToRedirect)
{
$websiteId = $this->getDefaultWebsiteId();
$defaultDate = $this->getDefaultDate();
$defaultPeriod = $this->getDefaultPeriod();

if($websiteId) {
header("Location:index.php?module=".$moduleToRedirect
."&action=".$actionToRedirect
."&idSite=".$websiteId
."&period=".$defaultPeriod
."&date=".$defaultDate);
exit;
}

if(Piwik::isUserIsSuperUser())
{
Piwik_ExitWithMessage("Error: no website were found in this Piwik installation.
<br>Check the table '". Piwik::prefixTable('site') ."' that should contain your Piwik websites.", false, true);
}

$currentLogin = Piwik::getCurrentUserLogin();
if(!empty($currentLogin)
&& $currentLogin != 'anonymous')
{
$errorMessage = sprintf(Piwik_Translate('CoreHome_NoPrivileges'),$currentLogin);
$errorMessage .= "<br /><br />&nbsp;&nbsp;&nbsp;<b><a href='index.php?module=". Zend_Registry::get('auth')->getName() ."&amp;action=logout'>&rsaquo; ". Piwik_Translate('General_Logout'). "</a></b><br />";
Piwik_ExitWithMessage($errorMessage, false, true);
}

Piwik_FrontController::dispatch('Login', false);
exit;
}


/**
* Returns default website for Piwik to load
* @return Piwik_Site
*/
protected function getDefaultWebsiteId()
{
$defaultWebsiteId = false;
Piwik_PostEvent( 'Controller.getDefaultWebsiteId', $defaultWebsiteId );

if($defaultWebsiteId)
{
return $defaultWebsiteId;
}

$sitesId = Piwik_SitesManager_API::getInstance()->getSitesIdWithAtLeastViewAccess();
if(!empty($sitesId))
{
return $sitesId[0];
}
return false;
}

/**
* Returns default date for Piwik reports
* @return string today, 2010-01-01, etc.
*/
protected function getDefaultDate()
{
return Zend_Registry::get('config')->General->default_day;
}

/**
* Returns default period for Piwik reports
* @return string day, week, etc.
*/
protected function getDefaultPeriod()
{
return Zend_Registry::get('config')->General->default_period;
}
}
Something went wrong with that request. Please try again.