Format code using php-cs-fixer

This commit is contained in:
jo 2021-10-11 16:10:47 +02:00
parent 43d7dc92cd
commit d52c6184b9
352 changed files with 17473 additions and 17041 deletions

View file

@ -4,31 +4,30 @@ class Zend_Controller_Plugin_Acl extends Zend_Controller_Plugin_Abstract
{
/**
* @var Zend_Acl
**/
*/
protected $_acl;
/**
* @var string
**/
*/
protected $_roleName;
/**
* @var array
**/
*/
protected $_errorPage;
/**
* Constructor
* Constructor.
*
* @param mixed $aclData
* @param $roleName
* @return void
**/
*/
public function __construct(Zend_Acl $aclData, $roleName = 'G')
{
$this->_errorPage = array('module' => 'default',
'controller' => 'error',
'action' => 'error');
$this->_errorPage = ['module' => 'default',
'controller' => 'error',
'action' => 'error', ];
$this->_roleName = $roleName;
@ -38,32 +37,32 @@ class Zend_Controller_Plugin_Acl extends Zend_Controller_Plugin_Abstract
}
/**
* Sets the ACL object
* Sets the ACL object.
*
* @param mixed $aclData
* @return void
**/
* @param mixed $aclData
*/
public function setAcl(Zend_Acl $aclData)
{
$this->_acl = $aclData;
}
/**
* Returns the ACL object
* Returns the ACL object.
*
* @return Zend_Acl
**/
*/
public function getAcl()
{
return $this->_acl;
}
/**
* Returns the ACL role used
* Returns the ACL role used.
*
* @return string
*
* @author
**/
*/
public function getRoleName()
{
return $this->_roleName;
@ -75,25 +74,24 @@ class Zend_Controller_Plugin_Acl extends Zend_Controller_Plugin_Abstract
}
/**
* Sets the error page
* Sets the error page.
*
* @param string $action
* @param string $controller
* @param string $module
* @return void
**/
* @param string $action
* @param string $controller
* @param string $module
*/
public function setErrorPage($action, $controller = 'error', $module = 'default')
{
$this->_errorPage = array('module' => $module,
'controller' => $controller,
'action' => $action);
$this->_errorPage = ['module' => $module,
'controller' => $controller,
'action' => $action, ];
}
/**
* Returns the error page
* Returns the error page.
*
* @return array
**/
*/
public function getErrorPage()
{
return $this->_errorPage;
@ -102,82 +100,73 @@ class Zend_Controller_Plugin_Acl extends Zend_Controller_Plugin_Abstract
/**
* Predispatch
* Checks if the current user identified by roleName has rights to the requested url (module/controller/action)
* If not, it will call denyAccess to be redirected to errorPage
*
* @return void
**/
* If not, it will call denyAccess to be redirected to errorPage.
*/
public function preDispatch(Zend_Controller_Request_Abstract $request)
{
$controller = strtolower($request->getControllerName());
if (in_array($controller, array(
"index",
"login",
"api",
"auth",
"error",
"locale",
"upgrade",
"embed",
"feeds"
)))
{
$this->setRoleName("G");
}
elseif (Zend_Session::isStarted() && !Zend_Auth::getInstance()->hasIdentity()) {
if (in_array($controller, [
'index',
'login',
'api',
'auth',
'error',
'locale',
'upgrade',
'embed',
'feeds',
])) {
$this->setRoleName('G');
} elseif (Zend_Session::isStarted() && !Zend_Auth::getInstance()->hasIdentity()) {
//The controller uses sessions but we don't have an identity yet.
// If we don't have an identity and we're making a RESTful request,
// we need to do API key verification
if ($request->getModuleName() == "rest") {
if ($request->getModuleName() == 'rest') {
if (!$this->verifyAuth()) {
//$this->denyAccess();
//$this->getResponse()->sendResponse();
//$r->gotoSimpleAndExit('index', 'login', $request->getModuleName());
//die();
throw new Zend_Controller_Exception("Incorrect API key", 401);
throw new Zend_Controller_Exception('Incorrect API key', 401);
}
}
else //Non-REST, regular Airtime web app requests
{
} else { //Non-REST, regular Airtime web app requests
// Redirect user to the landing page if they are trying to
// access a resource that requires a valid session.
// Skip the redirection if they are already on the landing page
// or the login page.
if ($controller !== 'index' && $controller !== 'login') {
if ($request->isXmlHttpRequest()) {
$url = 'http://'.$request->getHttpHost().'/';
$json = Zend_Json::encode(array('auth' => false, 'url' => $url));
$url = 'http://' . $request->getHttpHost() . '/';
$json = Zend_Json::encode(['auth' => false, 'url' => $url]);
// Prepare response
$this->getResponse()
->setHttpResponseCode(401)
->setBody($json)
->sendResponse();
->setHttpResponseCode(401)
->setBody($json)
->sendResponse()
;
//redirectAndExit() cleans up, sends the headers and stops the script
Zend_Controller_Action_HelperBroker::getStaticHelper('redirector')->redirectAndExit();
} else {
$r = Zend_Controller_Action_HelperBroker::getStaticHelper('redirector');
$r->gotoSimpleAndExit('index', 'index', $request->getModuleName());
}
}
}
}
} else { //We have a session/identity.
// If we have an identity and we're making a RESTful request,
// we need to check the CSRF token
if ($_SERVER['REQUEST_METHOD'] != "GET" && $request->getModuleName() == "rest") {
$token = $request->getParam("csrf_token");
if ($_SERVER['REQUEST_METHOD'] != 'GET' && $request->getModuleName() == 'rest') {
$token = $request->getParam('csrf_token');
// PUT requests don't parameterize the data in the body, so we can't
// fetch it with getParam or getPost; instead we have to parse the body and
// check for the token in the JSON. (Hopefully we can find a better way to do this) -- Duncan
if (empty($token)) {
$token = json_decode($this->getRequest()->getRawBody(), true)["csrf_token"];
$token = json_decode($this->getRequest()->getRawBody(), true)['csrf_token'];
}
$tokenValid = $this->verifyCSRFToken($token);
@ -185,15 +174,17 @@ class Zend_Controller_Plugin_Acl extends Zend_Controller_Plugin_Abstract
$csrf_namespace = new Zend_Session_Namespace('csrf_namespace');
$csrf_namespace->authtoken = sha1(openssl_random_pseudo_bytes(128));
Logging::warn("Invalid CSRF token: $token");
Logging::warn("Invalid CSRF token: {$token}");
$this->getResponse()
->setHttpResponseCode(401)
->appendBody("ERROR: CSRF token mismatch.")
->sendResponse();
die();
->setHttpResponseCode(401)
->appendBody('ERROR: CSRF token mismatch.')
->sendResponse()
;
exit();
}
}
$userInfo = Zend_Auth::getInstance()->getStorage()->read();
$this->setRoleName($userInfo->type);
@ -208,28 +199,32 @@ class Zend_Controller_Plugin_Acl extends Zend_Controller_Plugin_Abstract
$resourceName .= $controller;
/** Check if the controller/action can be accessed by the current user */
// Check if the controller/action can be accessed by the current user
if (!$this->getAcl()->has($resourceName)) {
$this->setErrorPage('error404');
$this->denyAccess();
} else if (!$this->getAcl()->isAllowed($this->_roleName,
$resourceName,
$request->getActionName())) {
/** Redirect to access denied page */
} elseif (!$this->getAcl()->isAllowed(
$this->_roleName,
$resourceName,
$request->getActionName()
)) {
// Redirect to access denied page
$this->setErrorPage('error403');
$this->denyAccess();
}
}
}
private function verifyAuth() {
private function verifyAuth()
{
if ($this->verifyAPIKey() || $this->isVerifiedDownload()) {
return true;
}
$this->getResponse()
->setHttpResponseCode(401)
->appendBody("ERROR: Incorrect API key.");
->appendBody('ERROR: Incorrect API key.')
;
return false;
}
@ -239,47 +234,50 @@ class Zend_Controller_Plugin_Acl extends Zend_Controller_Plugin_Abstract
* It should satisfy the following requirements:
* * request path is /rest/media/:id/download
* * download key is correct
* * requested file belongs to the station podcast
* * requested file belongs to the station podcast.
*
* @return bool
*/
private function isVerifiedDownload() {
private function isVerifiedDownload()
{
$request = $this->getRequest();
$fileId = $request->getParam("id");
$key = $request->getParam("download_key");
$fileId = $request->getParam('id');
$key = $request->getParam('download_key');
$module = $request->getModuleName();
$controller = $request->getControllerName();
$action = $request->getActionName();
$stationPodcast = StationPodcastQuery::create()
->findOneByDbPodcastId(Application_Model_Preference::getStationPodcastId());
return $module == "rest" && $controller == "media" && $action == "download"
->findOneByDbPodcastId(Application_Model_Preference::getStationPodcastId())
;
return $module == 'rest' && $controller == 'media' && $action == 'download'
&& $key === Application_Model_Preference::getStationPodcastDownloadKey()
&& $stationPodcast->hasEpisodeForFile($fileId);
}
private function verifyCSRFToken($token) {
private function verifyCSRFToken($token)
{
return SecurityHelper::verifyCSRFToken($token);
}
private function verifyAPIKey() {
private function verifyAPIKey()
{
// The API key is passed in via HTTP "basic authentication":
// http://en.wikipedia.org/wiki/Basic_access_authentication
$CC_CONFIG = Config::getConfig();
// Decode the API key that was passed to us in the HTTP request.
$authHeader = $this->getRequest()->getHeader("Authorization");
$encodedRequestApiKey = substr($authHeader, strlen("Basic "));
$encodedStoredApiKey = base64_encode($CC_CONFIG["apiKey"][0] . ":");
return ($encodedRequestApiKey === $encodedStoredApiKey);
$authHeader = $this->getRequest()->getHeader('Authorization');
$encodedRequestApiKey = substr($authHeader, strlen('Basic '));
$encodedStoredApiKey = base64_encode($CC_CONFIG['apiKey'][0] . ':');
return $encodedRequestApiKey === $encodedStoredApiKey;
}
/**
* Deny Access Function
* Redirects to errorPage, this can be called from an action using the action helper
*
* @return void
**/
* Redirects to errorPage, this can be called from an action using the action helper.
*/
public function denyAccess()
{
$this->_request->setModuleName($this->_errorPage['module']);

View file

@ -2,14 +2,16 @@
class Zend_Controller_Plugin_Maintenance extends Zend_Controller_Plugin_Abstract
{
public function preDispatch(Zend_Controller_Request_Abstract $request) {
$maintenanceFile = isset($_SERVER['AIRTIME_BASE']) ? $_SERVER['AIRTIME_BASE']."maintenance.txt" : "/tmp/maintenance.txt";
public function preDispatch(Zend_Controller_Request_Abstract $request)
{
$maintenanceFile = isset($_SERVER['AIRTIME_BASE']) ? $_SERVER['AIRTIME_BASE'] . 'maintenance.txt' : '/tmp/maintenance.txt';
if (file_exists($maintenanceFile)) {
$request->setModuleName('default')
->setControllerName('index')
->setActionName('maintenance')
->setDispatched(true);
->setControllerName('index')
->setActionName('maintenance')
->setDispatched(true)
;
}
}
}
}

View file

@ -7,9 +7,10 @@
*/
class PageLayoutInitPlugin extends Zend_Controller_Plugin_Abstract
{
protected $_bootstrap = null;
protected $_bootstrap;
public function __construct($boostrap) {
public function __construct($boostrap)
{
$this->_bootstrap = $boostrap;
}
@ -17,7 +18,7 @@ class PageLayoutInitPlugin extends Zend_Controller_Plugin_Abstract
* 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.
* @param Zend_Controller_Request_Abstract $request
*
* @throws Zend_Session_Exception
*/
public function routeShutdown(Zend_Controller_Request_Abstract $request)
@ -27,15 +28,15 @@ class PageLayoutInitPlugin extends Zend_Controller_Plugin_Abstract
//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, array(
"index", //Radio Page
"api",
"auth",
"error",
"upgrade",
"embed",
"feeds"
))
if (!in_array($controller, [
'index', //Radio Page
'api',
'auth',
'error',
'upgrade',
'embed',
'feeds',
])
) {
//Start the session
Zend_Session::start();
@ -54,7 +55,7 @@ class PageLayoutInitPlugin extends Zend_Controller_Plugin_Abstract
}
// Skip upgrades and task management when running unit tests
if (getenv("AIRTIME_UNIT_TEST") != 1) {
if (getenv('AIRTIME_UNIT_TEST') != 1) {
$taskManager = TaskManager::getInstance();
// Run the upgrade on each request (if it needs to be run)
@ -66,7 +67,7 @@ class PageLayoutInitPlugin extends Zend_Controller_Plugin_Abstract
// 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") {
if ($controller == 'api') {
$taskManager->runTasks();
}
}
@ -81,29 +82,29 @@ class PageLayoutInitPlugin extends Zend_Controller_Plugin_Abstract
$view = $this->_bootstrap->getResource('view');
$baseUrl = Application_Common_OsPath::getBaseDir();
$view->headScript()->appendScript("var baseUrl = '$baseUrl';");
$view->headScript()->appendScript("var baseUrl = '{$baseUrl}';");
$this->_initTranslationGlobals($view);
$user = Application_Model_User::GetCurrentUser();
if (!is_null($user)) {
$userType = $user->getType();
} else {
$userType = "";
$userType = '';
}
$view->headScript()->appendScript("var userType = '$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::getAudioMimeTypeArray();
$fileExtensions = array_values($mimeTypes);
foreach($fileExtensions as &$extension) {
foreach ($fileExtensions as &$extension) {
$extension = '.' . $extension;
}
$view->headScript()->appendScript("var acceptedMimeTypes = " . json_encode(array_merge(array_keys($mimeTypes), $fileExtensions)) . ";");
$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
* Create a global namespace to hold a session token for CSRF prevention.
*/
protected function _initCsrfNamespace()
{
@ -131,7 +132,7 @@ class PageLayoutInitPlugin extends Zend_Controller_Plugin_Abstract
/**
* 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
* reinitialize them every request.
*/
private function _initTranslationGlobals()
{
@ -142,18 +143,18 @@ class PageLayoutInitPlugin extends Zend_Controller_Plugin_Abstract
//Each page refresh or tab open has uniqID, not to be used for security
$view->headScript()->appendScript("var UNIQID = '" . uniqid() . "';");
$track_type_options = array();
$track_type_options = [];
$track_types = Application_Model_Tracktype::getTracktypes();
array_multisort(array_map(function($element) {
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['code']] = $tt['type_name'];
}
$ttarr = json_encode($track_type_options, JSON_FORCE_OBJECT);
$view->headScript()->appendScript("var TRACKTYPES = " . $ttarr . ";");
$view->headScript()->appendScript('var TRACKTYPES = ' . $ttarr . ';');
}
protected function _initHeadLink()
@ -164,14 +165,15 @@ class PageLayoutInitPlugin extends Zend_Controller_Plugin_Abstract
$baseUrl = Application_Common_OsPath::getBaseDir();
$view->headLink(array('rel' => 'icon', 'href' => $baseUrl . 'favicon.ico?' . $CC_CONFIG['airtime_version'], 'type' => 'image/x-icon'), 'PREPEND')
$view->headLink(['rel' => 'icon', 'href' => $baseUrl . 'favicon.ico?' . $CC_CONFIG['airtime_version'], 'type' => 'image/x-icon'], 'PREPEND')
->appendStylesheet($baseUrl . 'css/bootstrap.css?' . $CC_CONFIG['airtime_version'])
->appendStylesheet($baseUrl . 'css/redmond/jquery-ui-1.8.8.custom.css?' . $CC_CONFIG['airtime_version'])
->appendStylesheet($baseUrl . 'css/pro_dropdown_3.css?' . $CC_CONFIG['airtime_version'])
->appendStylesheet($baseUrl . 'css/qtip/jquery.qtip.min.css?' . $CC_CONFIG['airtime_version'])
->appendStylesheet($baseUrl . 'css/styles.css?' . $CC_CONFIG['airtime_version'])
->appendStylesheet($baseUrl . 'css/masterpanel.css?' . $CC_CONFIG['airtime_version'])
->appendStylesheet($baseUrl . 'css/tipsy/jquery.tipsy.css?' . $CC_CONFIG['airtime_version']);
->appendStylesheet($baseUrl . 'css/tipsy/jquery.tipsy.css?' . $CC_CONFIG['airtime_version'])
;
}
protected function _initHeadScript()
@ -200,20 +202,21 @@ class PageLayoutInitPlugin extends Zend_Controller_Plugin_Abstract
->appendFile($baseUrl . 'locale/general-translation-table?' . $CC_CONFIG['airtime_version'], 'text/javascript')
->appendFile($baseUrl . 'locale/datatables-translation-table?' . $CC_CONFIG['airtime_version'], 'text/javascript')
->appendScript("$.i18n.setDictionary(general_dict)")
->appendScript("var baseUrl='$baseUrl'");
->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;
$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()) {
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;
$now = new DateTime('now', $userTimeZone);
$offset = $now->format('Z') * -1;
$view->headScript()->appendScript("var userTimezoneOffset = {$offset}; //in seconds");
}
@ -225,16 +228,17 @@ class PageLayoutInitPlugin extends Zend_Controller_Plugin_Abstract
->appendFile($baseUrl . 'js/tipsy/jquery.tipsy.js?' . $CC_CONFIG['airtime_version'], 'text/javascript')
->appendFile($baseUrl . 'js/airtime/common/common.js?' . $CC_CONFIG['airtime_version'], 'text/javascript')
->appendFile($baseUrl . 'js/airtime/common/audioplaytest.js?' . $CC_CONFIG['airtime_version'], 'text/javascript');
->appendFile($baseUrl . 'js/airtime/common/audioplaytest.js?' . $CC_CONFIG['airtime_version'], 'text/javascript')
;
$user = Application_Model_User::getCurrentUser();
if (!is_null($user)) {
$userType = $user->getType();
} else {
$userType = "";
$userType = '';
}
$view->headScript()->appendScript("var userType = '$userType';");
$view->headScript()->appendScript("var userType = '{$userType}';");
}
protected function _initViewHelpers()

View file

@ -5,15 +5,15 @@ class RabbitMqPlugin extends Zend_Controller_Plugin_Abstract
public function dispatchLoopShutdown()
{
if (Application_Model_RabbitMq::$doPush) {
$md = array('schedule' => Application_Model_Schedule::getSchedule());
Application_Model_RabbitMq::SendMessageToPypo("update_schedule", $md);
$md = ['schedule' => Application_Model_Schedule::getSchedule()];
Application_Model_RabbitMq::SendMessageToPypo('update_schedule', $md);
}
if (memory_get_peak_usage() > 30*pow(2, 20)) {
Logging::debug("Peak memory usage: "
.(memory_get_peak_usage()/1000000)
." MB while accessing URI ".$_SERVER['REQUEST_URI']);
Logging::debug("Should try to keep memory footprint under 25 MB");
if (memory_get_peak_usage() > 30 * pow(2, 20)) {
Logging::debug('Peak memory usage: '
. (memory_get_peak_usage() / 1000000)
. ' MB while accessing URI ' . $_SERVER['REQUEST_URI']);
Logging::debug('Should try to keep memory footprint under 25 MB');
}
}
}