libretime/legacy/application/controllers/plugins/PageLayoutInitPlugin.php

249 lines
11 KiB
PHP

<?php
/** Our standard page layout initialization has to be done via a plugin
* because some of it requires session variables, and some of the routes
* run without a session (like API calls). This is an optimization because
* starting the session adds a fair amount of overhead.
*/
class PageLayoutInitPlugin extends Zend_Controller_Plugin_Abstract
{
protected $_bootstrap;
public function __construct($boostrap)
{
$this->_bootstrap = $boostrap;
}
/**
* Start the session depending on which controller your request is going to.
* We start the session explicitly here so that we can avoid starting sessions
* needlessly for (stateless) requests to the API.
*
* @throws Zend_Session_Exception
*/
public function routeShutdown(Zend_Controller_Request_Abstract $request)
{
$controller = strtolower($request->getControllerName());
$action = strtolower($request->getActionName());
// List of controllers where we don't need a session, and we don't need
// all the standard HTML / JS boilerplate.
if (!in_array($controller, [
'index', // Radio Page
'api',
'auth',
'error',
'upgrade',
'embed',
'feeds',
])) {
// Start the session
Zend_Session::start();
Application_Model_Auth::pinSessionToClient(Zend_Auth::getInstance());
// localization configuration
Application_Model_Locale::configureLocalization();
$this->_initGlobals();
$this->_initCsrfNamespace();
$this->_initHeadLink();
$this->_initHeadScript();
$this->_initTitle();
$this->_initTranslationGlobals();
$this->_initViewHelpers();
}
// Skip task management when running unit tests
if (getenv('AIRTIME_UNIT_TEST') != 1) {
$taskManager = TaskManager::getInstance();
// Piggyback the TaskManager onto API calls. This provides guaranteed consistency
// (there is at least one API call made from pypo to Airtime every 7 minutes) and
// greatly reduces the chances of lock contention on cc_pref while the TaskManager runs
if ($controller == 'api') {
$taskManager->runTasks();
}
}
}
protected function _initGlobals()
{
if (!Zend_Session::isStarted()) {
return;
}
$view = $this->_bootstrap->getResource('view');
$baseUrl = Config::getBasePath();
$view->headScript()->appendScript("var baseUrl = '{$baseUrl}';");
$this->_initTranslationGlobals($view);
$user = Application_Model_User::GetCurrentUser();
if (!is_null($user)) {
$userType = $user->getType();
} else {
$userType = '';
}
$view->headScript()->appendScript("var userType = '{$userType}';");
// Dropzone also accept file extensions and doesn't correctly extract certain mimetypes (eg. FLAC - try it),
// so we append the file extensions to the list of mimetypes and that makes it work.
$mimeTypes = FileDataHelper::getUploadAudioMimeTypeArray();
$fileExtensions = array_values($mimeTypes);
foreach ($fileExtensions as &$extension) {
$extension = '.' . $extension;
}
$view->headScript()->appendScript('var acceptedMimeTypes = ' . json_encode(array_merge(array_keys($mimeTypes), $fileExtensions)) . ';');
}
/**
* Create a global namespace to hold a session token for CSRF prevention.
*/
protected function _initCsrfNamespace()
{
/*
if (!Zend_Session::isStarted()) {
return;
}*/
$csrf_namespace = new Zend_Session_Namespace('csrf_namespace');
// Check if the token exists
if (!$csrf_namespace->authtoken) {
// If we don't have a token, regenerate it and set a 1 week timeout
// Should we log the user out here if the token is expired?
$csrf_namespace->authtoken = sha1(uniqid(random_int(0, getrandmax()), 1));
$csrf_namespace->setExpirationSeconds(168 * 60 * 60);
}
// Here we are closing the session for writing because otherwise no requests
// in this session will be handled in parallel. This gives a major boost to the perceived performance
// of the application (page load times are more consistent, no lock contention).
session_write_close();
// Zend_Session::writeClose(true);
}
/**
* Ideally, globals should be written to a single js file once
* from a php init function. This will save us from having to
* reinitialize them every request.
*/
private function _initTranslationGlobals()
{
$view = $this->_bootstrap->getResource('view');
$view->headScript()->appendScript("var PRODUCT_NAME = '" . PRODUCT_NAME . "';");
$view->headScript()->appendScript("var USER_MANUAL_URL = '" . USER_MANUAL_URL . "';");
$view->headScript()->appendScript("var COMPANY_NAME = '" . COMPANY_NAME . "';");
// Each page refresh or tab open has uniqID, not to be used for security
$view->headScript()->appendScript("var UNIQID = '" . uniqid() . "';");
$track_type_options = [];
$track_types = Application_Model_Tracktype::getTracktypes();
array_multisort(array_map(function ($element) {
return $element['type_name'];
}, $track_types), SORT_ASC, $track_types);
foreach ($track_types as $key => $tt) {
$track_type_options[$tt['id']] = ['name' => $tt['type_name'], 'code' => $tt['code']];
}
$ttarr = json_encode($track_type_options, JSON_FORCE_OBJECT);
$view->headScript()->appendScript('var TRACKTYPES = ' . $ttarr . ';');
}
protected function _initHeadLink()
{
$view = $this->_bootstrap->getResource('view');
$baseUrl = Config::getBasePath();
$view->headLink(['rel' => 'icon', 'href' => $baseUrl . 'favicon.ico', 'type' => 'image/x-icon'], 'PREPEND')
->appendStylesheet(Assets::url('css/bootstrap.css'))
->appendStylesheet(Assets::url('css/redmond/jquery-ui-1.8.8.custom.css'))
->appendStylesheet(Assets::url('css/pro_dropdown_3.css'))
->appendStylesheet(Assets::url('css/qtip/jquery.qtip.min.css'))
->appendStylesheet(Assets::url('css/styles.css'))
->appendStylesheet(Assets::url('css/masterpanel.css'))
->appendStylesheet(Assets::url('css/tipsy/jquery.tipsy.css'));
}
protected function _initHeadScript()
{
if (!Zend_Session::isStarted()) {
return;
}
$view = $this->_bootstrap->getResource('view');
$baseUrl = Config::getBasePath();
$view->headScript()->appendFile(Assets::url('js/libs/jquery-1.8.3.min.js'), 'text/javascript')
->appendFile(Assets::url('js/libs/jquery-ui-1.8.24.min.js'), 'text/javascript')
->appendFile(Assets::url('js/libs/angular.min.js'), 'text/javascript')
->appendFile(Assets::url('js/bootstrap/bootstrap.min.js'), 'text/javascript')
->appendFile(Assets::url('js/libs/underscore-min.js'), 'text/javascript')
->appendFile(Assets::url('js/qtip/jquery.qtip.js'), 'text/javascript')
->appendFile(Assets::url('js/jplayer/jquery.jplayer.min.js'), 'text/javascript')
->appendFile(Assets::url('js/sprintf/sprintf-0.7-beta1.js'), 'text/javascript')
->appendFile(Assets::url('js/cookie/js.cookie.js'), 'text/javascript')
->appendFile(Assets::url('js/i18n/jquery.i18n.js'), 'text/javascript')
->appendFile($baseUrl . 'locale/general-translation-table', 'text/javascript')
->appendFile($baseUrl . 'locale/datatables-translation-table', 'text/javascript')
->appendScript('$.i18n.setDictionary(general_dict)')
->appendScript("var baseUrl='{$baseUrl}'");
// These timezones are needed to adjust javascript Date objects on the client to make sense to the user's set timezone
// or the server's set timezone.
$serverTimeZone = new DateTimeZone(Application_Model_Preference::GetDefaultTimezone());
$now = new DateTime('now', $serverTimeZone);
$offset = $now->format('Z') * -1;
$view->headScript()->appendScript("var serverTimezoneOffset = {$offset}; //in seconds");
if (class_exists('Zend_Auth', false) && Zend_Auth::getInstance()->hasIdentity()) {
$userTimeZone = new DateTimeZone(Application_Model_Preference::GetUserTimezone());
$now = new DateTime('now', $userTimeZone);
$offset = $now->format('Z') * -1;
$view->headScript()->appendScript("var userTimezoneOffset = {$offset}; //in seconds");
}
// scripts for now playing bar
$view->headScript()->appendFile(Assets::url('js/airtime/airtime_bootstrap.js'), 'text/javascript')
->appendFile(Assets::url('js/airtime/dashboard/helperfunctions.js'), 'text/javascript')
->appendFile(Assets::url('js/airtime/dashboard/dashboard.js'), 'text/javascript')
->appendFile(Assets::url('js/airtime/dashboard/versiontooltip.js'), 'text/javascript')
->appendFile(Assets::url('js/tipsy/jquery.tipsy.js'), 'text/javascript')
->appendFile(Assets::url('js/airtime/common/common.js'), 'text/javascript')
->appendFile(Assets::url('js/airtime/common/audioplaytest.js'), 'text/javascript');
// include wavesurfer.js for waveform display
$view->headScript()->appendFile(Assets::url('js/wavesurfer/wavesurfer.min.js'), 'text/javascript')
->appendFile(Assets::url('js/wavesurfer/timeline.min.js'), 'text/javascript')
->appendFile(Assets::url('js/wavesurfer/regions.min.js'), 'text/javascript')
->appendFile(Assets::url('js/wavesurfer/cursor.min.js'), 'text/javascript')
->appendFile(Assets::url('js/wavesurfer/libretime.js'), 'text/javascript');
$user = Application_Model_User::getCurrentUser();
if (!is_null($user)) {
$userType = $user->getType();
} else {
$userType = '';
}
$view->headScript()->appendScript("var userType = '{$userType}';");
}
protected function _initViewHelpers()
{
$view = $this->_bootstrap->getResource('view');
$view->addHelperPath(APPLICATION_PATH . '/views/helpers', 'Airtime_View_Helper');
}
protected function _initTitle()
{
$view = $this->_bootstrap->getResource('view');
$view->headTitle(Application_Model_Preference::GetHeadTitle());
}
}