'Installation_Welcome',
'systemCheck' => 'Installation_SystemCheck',
'databaseSetup' => 'Installation_DatabaseSetup',
'tablesCreation' => 'Installation_Tables',
'setupSuperUser' => 'Installation_SuperUser',
'firstWebsiteSetup' => 'Installation_SetupWebsite',
'trackingCode' => 'General_JsTrackingTag',
'finished' => 'Installation_Congratulations',
);
/**
* Get installation steps
*
* @return array installation steps
*/
public function getInstallationSteps()
{
return $this->steps;
}
/**
* Get default action (first installation step)
*
* @return string function name
*/
function getDefaultAction()
{
$steps = array_keys($this->steps);
return $steps[0];
}
/**
* Installation Step 1: Welcome
*
* Can also display an error message when there is a failure early (eg. DB connection failed)
*
* @param string $possibleErrorMessage Possible error message which may be set in the frontcontroller when event. Config.badConfigurationFile was triggered
*/
function welcome($possibleErrorMessage = null)
{
// Delete merged js/css files to force regenerations based on updated activated plugin list
Filesystem::deleteAllCacheOnUpdate();
$this->checkPiwikIsNotInstalled($possibleErrorMessage);
$view = new View(
'@Installation/welcome',
$this->getInstallationSteps(),
__FUNCTION__
);
$view->showNextStep = true;
return $view->render();
}
/**
* Installation Step 2: System Check
*/
function systemCheck()
{
$this->checkPiwikIsNotInstalled();
$this->deleteConfigFileIfNeeded();
$view = new View(
'@Installation/systemCheck',
$this->getInstallationSteps(),
__FUNCTION__
);
// Do not use dependency injection because this service requires a lot of sub-services across plugins
/** @var DiagnosticService $diagnosticService */
$diagnosticService = StaticContainer::get('Piwik\Plugins\Diagnostics\DiagnosticService');
$view->diagnosticReport = $diagnosticService->runDiagnostics();
$view->isInstallation = true;
$view->showNextStep = !$view->diagnosticReport->hasErrors();
// On the system check page, if all is green, display Next link at the top
$view->showNextStepAtTop = $view->showNextStep && !$view->diagnosticReport->hasWarnings();
return $view->render();
}
/**
* Installation Step 3: Database Set-up
* @throws Exception|Zend_Db_Adapter_Exception
*/
function databaseSetup()
{
$this->checkPiwikIsNotInstalled();
$view = new View(
'@Installation/databaseSetup',
$this->getInstallationSteps(),
__FUNCTION__
);
$view->showNextStep = false;
$form = new FormDatabaseSetup();
if ($form->validate()) {
try {
$dbInfos = $form->createDatabaseObject();
DbHelper::checkDatabaseVersion();
Db::get()->checkClientVersion();
$this->createConfigFile($dbInfos);
$this->redirectToNextStep(__FUNCTION__);
} catch (Exception $e) {
$view->errorMessage = Common::sanitizeInputValue($e->getMessage());
}
}
$view->addForm($form);
return $view->render();
}
/**
* Installation Step 4: Table Creation
*/
function tablesCreation()
{
$this->checkPiwikIsNotInstalled();
$view = new View(
'@Installation/tablesCreation',
$this->getInstallationSteps(),
__FUNCTION__
);
if ($this->getParam('deleteTables')) {
Manager::getInstance()->clearPluginsInstalledConfig();
Db::dropAllTables();
$view->existingTablesDeleted = true;
}
$tablesInstalled = DbHelper::getTablesInstalled();
$view->tablesInstalled = '';
if (count($tablesInstalled) > 0) {
// we have existing tables
$view->tablesInstalled = implode(', ', $tablesInstalled);
$view->someTablesInstalled = true;
$self = $this;
Access::doAsSuperUser(function () use ($self, $tablesInstalled, $view) {
Access::getInstance();
if ($self->hasEnoughTablesToReuseDb($tablesInstalled) &&
count(APISitesManager::getInstance()->getAllSitesId()) > 0 &&
count(APIUsersManager::getInstance()->getUsers()) > 0
) {
$view->showReuseExistingTables = true;
}
});
} else {
DbHelper::createTables();
DbHelper::createAnonymousUser();
DbHelper::recordInstallVersion();
$this->updateComponents();
Updater::recordComponentSuccessfullyUpdated('core', Version::VERSION);
$view->tablesCreated = true;
$view->showNextStep = true;
}
return $view->render();
}
function reuseTables()
{
$this->checkPiwikIsNotInstalled();
$steps = $this->getInstallationSteps();
$steps['tablesCreation'] = 'Installation_ReusingTables';
$view = new View(
'@Installation/reuseTables',
$steps,
'tablesCreation'
);
$oldVersion = Option::get('version_core');
$result = $this->updateComponents();
if ($result === false) {
$this->redirectToNextStep('tablesCreation');
}
$view->coreError = $result['coreError'];
$view->warningMessages = $result['warnings'];
$view->errorMessages = $result['errors'];
$view->deactivatedPlugins = $result['deactivatedPlugins'];
$view->currentVersion = Version::VERSION;
$view->oldVersion = $oldVersion;
$view->showNextStep = true;
return $view->render();
}
/**
* Installation Step 5: General Set-up (superuser login/password/email and subscriptions)
*/
function setupSuperUser()
{
$this->checkPiwikIsNotInstalled();
$superUserAlreadyExists = Access::doAsSuperUser(function () {
return count(APIUsersManager::getInstance()->getUsersHavingSuperUserAccess()) > 0;
});
if ($superUserAlreadyExists) {
$this->redirectToNextStep('setupSuperUser');
}
$view = new View(
'@Installation/setupSuperUser',
$this->getInstallationSteps(),
__FUNCTION__
);
$form = new FormSuperUser();
if ($form->validate()) {
try {
$loginName = $form->getSubmitValue('login');
$email = $form->getSubmitValue('email');
$this->createSuperUser($loginName,
$form->getSubmitValue('password'),
$email);
$newsletterPiwikORG = $form->getSubmitValue('subscribe_newsletter_piwikorg');
$newsletterProfessionalServices = $form->getSubmitValue('subscribe_newsletter_professionalservices');
NewsletterSignup::signupForNewsletter(
$loginName,
$email,
$newsletterPiwikORG,
$newsletterProfessionalServices
);
Onboarding::sendSysAdminMail($email);
$this->redirectToNextStep(__FUNCTION__);
} catch (Exception $e) {
$view->errorMessage = $e->getMessage();
}
}
$view->addForm($form);
return $view->render();
}
/**
* Installation Step 6: Configure first web-site
*/
public function firstWebsiteSetup()
{
$this->checkPiwikIsNotInstalled();
ServerFilesGenerator::createFilesForSecurity();
$siteIdsCount = Access::doAsSuperUser(function () {
return count(APISitesManager::getInstance()->getAllSitesId());
});
if ($siteIdsCount > 0) {
// if there is a already a website, skip this step and trackingCode step
$this->redirectToNextStep('trackingCode');
}
$view = new View(
'@Installation/firstWebsiteSetup',
$this->getInstallationSteps(),
__FUNCTION__
);
$form = new FormFirstWebsiteSetup();
if ($form->validate()) {
$name = Common::sanitizeInputValue($form->getSubmitValue('siteName'));
$url = Common::unsanitizeInputValue($form->getSubmitValue('url'));
$ecommerce = (int)$form->getSubmitValue('ecommerce');
try {
$result = Access::doAsSuperUser(function () use ($name, $url, $ecommerce) {
return APISitesManager::getInstance()->addSite($name, $url, $ecommerce);
});
$params = array(
'site_idSite' => $result,
'site_name' => urlencode($name)
);
$this->addTrustedHosts($url);
$this->redirectToNextStep(__FUNCTION__, $params);
} catch (Exception $e) {
$view->errorMessage = $e->getMessage();
}
}
// Display previous step success message, when current step form was not submitted yet
if (count($form->getErrorMessages()) == 0) {
$view->displayGeneralSetupSuccess = true;
}
$view->addForm($form);
return $view->render();
}
/**
* Installation Step 7: Display JavaScript tracking code
*/
public function trackingCode()
{
$this->checkPiwikIsNotInstalled();
$view = new View(
'@Installation/trackingCode',
$this->getInstallationSteps(),
__FUNCTION__
);
$siteName = Common::unsanitizeInputValue($this->getParam('site_name'));
$idSite = $this->getParam('site_idSite');
$javascriptGenerator = new TrackerCodeGenerator();
$jsTag = $javascriptGenerator->generate($idSite, Url::getCurrentUrlWithoutFileName());
$rawJsTag = TrackerCodeGenerator::stripTags($jsTag);
$showMatomoLinks = true;
Piwik::postEvent('SitesManager.showMatomoLinksInTrackingCodeEmail', array(&$showMatomoLinks));
$trackingUrl = trim(SettingsPiwik::getPiwikUrl(), '/') . '/' . $javascriptGenerator->getPhpTrackerEndpoint();
$emailBody = $this->renderTemplateAs('@SitesManager/_trackingCodeEmail', array(
'jsTag' => $rawJsTag,
'showMatomoLinks' => $showMatomoLinks,
'trackingUrl' => $trackingUrl,
'idSite' => $idSite
), $viewType = 'basic');
// Load the Tracking code and help text from the SitesManager
$viewTrackingHelp = new \Piwik\View('@SitesManager/_displayJavascriptCode');
$viewTrackingHelp->displaySiteName = $siteName;
$viewTrackingHelp->jsTag = $jsTag;
$viewTrackingHelp->emailBody = $emailBody;
$viewTrackingHelp->idSite = $idSite;
$viewTrackingHelp->piwikUrl = Url::getCurrentUrlWithoutFileName();
$viewTrackingHelp->isInstall = true;
$view->trackingHelp = $viewTrackingHelp->render();
$view->displaySiteName = $siteName;
$view->displayfirstWebsiteSetupSuccess = true;
$view->showNextStep = true;
return $view->render();
}
/**
* Installation Step 8: Finished!
*/
public function finished()
{
$this->checkPiwikIsNotInstalled();
$view = new View(
'@Installation/finished',
$this->getInstallationSteps(),
__FUNCTION__
);
$form = new FormDefaultSettings();
/**
* Triggered on initialization of the form to customize default Matomo settings (at the end of the installation process).
*
* @param \Piwik\Plugins\Installation\FormDefaultSettings $form
*/
Piwik::postEvent('Installation.defaultSettingsForm.init', array($form));
$form->addElement('submit', 'submit', array('value' => Piwik::translate('General_ContinueToPiwik') . ' ยป', 'class' => 'btn'));
if ($form->validate()) {
try {
/**
* Triggered on submission of the form to customize default Matomo settings (at the end of the installation process).
*
* @param \Piwik\Plugins\Installation\FormDefaultSettings $form
*/
Piwik::postEvent('Installation.defaultSettingsForm.submit', array($form));
$this->markInstallationAsCompleted();
Url::redirectToUrl('index.php');
} catch (Exception $e) {
$view->errorMessage = $e->getMessage();
}
}
$view->addForm($form);
$view->showNextStep = false;
$output = $view->render();
return $output;
}
/**
* System check will call this page which should load quickly,
* in order to look at Response headers (eg. to detect if pagespeed is running)
*
* @return string
*/
public function getEmptyPageForSystemCheck()
{
return 'Hello, world!';
}
/**
* This controller action renders an admin tab that runs the installation
* system check, so people can see if there are any issues w/ their running
* Matomo installation.
*
* This admin tab is only viewable by the Super User.
*/
public function systemCheckPage()
{
Piwik::checkUserHasSuperUserAccess();
$view = new View(
'@Installation/systemCheckPage',
$this->getInstallationSteps(),
__FUNCTION__
);
$this->setBasicVariablesView($view);
/** @var DiagnosticService $diagnosticService */
$diagnosticService = StaticContainer::get('Piwik\Plugins\Diagnostics\DiagnosticService');
$view->diagnosticReport = $diagnosticService->runDiagnostics();
return $view->render();
}
/**
* Save language selection in session-store
*/
public function saveLanguage()
{
if (DbHelper::isInstalled()) {
$this->checkTokenInUrl();
}
$language = $this->getParam('language');
LanguagesManager::setLanguageForSession($language);
Url::redirectToReferrer();
}
/**
* Return the base.less compiled to css
*
* @return string
*/
public function getInstallationCss()
{
Common::sendHeader('Content-Type: text/css');
Common::sendHeader('Cache-Control: max-age=' . (60 * 60));
$files = array(
'plugins/Morpheus/stylesheets/base/bootstrap.css',
'plugins/Morpheus/stylesheets/base/icons.css',
"node_modules/jquery-ui-dist/jquery-ui.theme.min.css",
'node_modules/materialize-css/dist/css/materialize.min.css',
'plugins/Morpheus/stylesheets/base.less',
'plugins/Morpheus/stylesheets/general/_forms.less',
'plugins/Installation/stylesheets/installation.css'
);
return AssetManager::compileCustomStylesheets($files);
}
/**
* Return the base.less compiled to css
*
* @return string
*/
public function getInstallationJs()
{
Common::sendHeader('Content-Type: application/javascript; charset=UTF-8');
Common::sendHeader('Cache-Control: max-age=' . (60 * 60));
$files = array(
"node_modules/jquery/dist/jquery.min.js",
"node_modules/jquery-ui-dist/jquery-ui.min.js",
'node_modules/materialize-css/dist/js/materialize.min.js',
"plugins/CoreHome/javascripts/materialize-bc.js",
'node_modules/angular/angular.min.js',
'node_modules/angular-sanitize/angular-sanitize.min.js',
'node_modules/angular-animate/angular-animate.min.js',
'node_modules/angular-cookies/angular-cookies.min.js',
'node_modules/ng-dialog/js/ngDialog.min.js',
'plugins/CoreHome/angularjs/common/services/service.module.js',
'plugins/CoreHome/angularjs/common/filters/filter.module.js',
'plugins/CoreHome/angularjs/common/filters/translate.js',
'plugins/CoreHome/angularjs/common/directives/directive.module.js',
'plugins/CoreHome/angularjs/piwikApp.config.js',
'plugins/CoreHome/angularjs/piwikApp.js',
'plugins/Installation/javascripts/installation.js',
'plugins/Morpheus/javascripts/piwikHelper.js',
"plugins/CoreHome/javascripts/broadcast.js",
);
CoreVue::addJsFilesTo($files);
$coreHomeUmd = Development::isEnabled() ? 'CoreHome.umd.js' : 'CoreHome.umd.min.js';
$files[] = "plugins/CoreHome/vue/dist/$coreHomeUmd";
if (defined('PIWIK_TEST_MODE') && PIWIK_TEST_MODE
&& file_exists(PIWIK_DOCUMENT_ROOT . '/tests/resources/screenshot-override/override.js')) {
$files[] = 'tests/resources/screenshot-override/override.js';
}
return AssetManager::compileCustomJs($files);
}
private function getParam($name)
{
return Common::getRequestVar($name, false, 'string');
}
/**
* Write configuration file from session-store
*/
private function createConfigFile($dbInfos)
{
$config = Config::getInstance();
// make sure DB sessions are used if the filesystem is NFS
if (count($headers = ProxyHeaders::getProxyClientHeaders()) > 0) {
$config->General['proxy_client_headers'] = $headers;
}
if (count($headers = ProxyHeaders::getProxyHostHeaders()) > 0) {
$config->General['proxy_host_headers'] = $headers;
}
if (Common::getRequestVar('clientProtocol', 'http', 'string') == 'https') {
$protocol = 'https';
} else {
$protocol = ProxyHeaders::getProtocolInformation();
}
if (!empty($protocol)
&& !\Piwik\ProxyHttp::isHttps()) {
$config->General['assume_secure_protocol'] = '1';
}
$config->General['salt'] = Common::generateUniqId();
$config->General['installation_in_progress'] = 1;
$config->database = $dbInfos;
$config->database['charset'] = DbHelper::getDefaultCharset();
$config->forceSave();
// re-save the currently viewed language (since we saved the config file, there is now a salt which makes the
// existing session cookie invalid)
$this->resetLanguageCookie();
}
private function resetLanguageCookie()
{
/** @var Translator $translator */
$translator = StaticContainer::get('Piwik\Translation\Translator');
LanguagesManager::setLanguageForSession($translator->getCurrentLanguage());
}
private function checkPiwikIsNotInstalled($possibleErrorMessage = null)
{
if (!SettingsPiwik::isMatomoInstalled()) {
return;
}
$possibleErrorMessage = $possibleErrorMessage ? sprintf('
Original error was "%s".
', $possibleErrorMessage) : '';
\Piwik\Plugins\Login\Controller::clearSession();
$message = Piwik::translate('Installation_InvalidStateError',
array($possibleErrorMessage . '
',
// piwik-is-already-installed is checked against in checkPiwikServerWorking
'',
'')
);
Piwik::exitWithErrorMessage($message);
}
/**
* Write configuration file from session-store
*/
private function markInstallationAsCompleted()
{
$config = Config::getInstance();
unset($config->General['installation_in_progress']);
$config->forceSave();
}
/**
* Redirect to next step
*
* @param string $currentStep Current step
* @return void
*/
private function redirectToNextStep($currentStep, $parameters = array())
{
$steps = array_keys($this->steps);
$nextStep = $steps[1 + array_search($currentStep, $steps)];
Piwik::redirectToModule('Installation', $nextStep, $parameters);
}
/**
* Extract host from URL
*
* @param string $url URL
*
* @return string|false
*/
private function extractHost($url)
{
$urlParts = parse_url($url);
if (isset($urlParts['host']) && strlen($host = $urlParts['host'])) {
return $host;
}
return false;
}
/**
* Add trusted hosts
*/
private function addTrustedHosts($siteUrl)
{
$trustedHosts = array();
// extract host from the request header
if (($host = $this->extractHost('http://' . Url::getHost())) !== false) {
$trustedHosts[] = $host;
}
// extract host from first web site
if (($host = $this->extractHost(urldecode($siteUrl))) !== false) {
$trustedHosts[] = $host;
}
$trustedHosts = array_unique($trustedHosts);
if (count($trustedHosts)) {
$general = Config::getInstance()->General;
$general['trusted_hosts'] = $trustedHosts;
Config::getInstance()->General = $general;
Config::getInstance()->forceSave();
}
}
private function createSuperUser($login, $password, $email)
{
Access::doAsSuperUser(function () use ($login, $password, $email) {
$api = APIUsersManager::getInstance();
$api->addUser($login, $password, $email);
$userUpdater = new UserUpdater();
$userUpdater->setSuperUserAccessWithoutCurrentPassword($login, true);
});
}
// should be private but there's a bug in php 5.3.6
public function hasEnoughTablesToReuseDb($tablesInstalled)
{
if (empty($tablesInstalled) || !is_array($tablesInstalled)) {
return false;
}
$archiveTables = ArchiveTableCreator::getTablesArchivesInstalled();
$baseTablesInstalled = count($tablesInstalled) - count($archiveTables);
$minimumCountPiwikTables = 12;
return $baseTablesInstalled >= $minimumCountPiwikTables;
}
private function deleteConfigFileIfNeeded()
{
$config = Config::getInstance();
if ($config->existsLocalConfig()) {
$config->deleteLocalConfig();
// deleting the config file removes the salt, which in turns invalidates existing cookies (including the
// one for selected language), so we re-save that cookie now
$this->resetLanguageCookie();
}
}
/**
* @return array|bool
*/
protected function updateComponents()
{
Access::getInstance();
return Access::doAsSuperUser(function () {
$updater = new Updater();
$componentsWithUpdateFile = $updater->getComponentUpdates();
if (empty($componentsWithUpdateFile)) {
return false;
}
$result = $updater->updateComponents($componentsWithUpdateFile);
return $result;
});
}
}