notification/GlobalNotification.php
<?php
/*=========================================================================
Midas Server
Copyright Kitware SAS, 26 rue Louis Guérin, 69100 Villeurbanne, France.
All rights reserved.
For more information visit http://www.kitware.com/.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0.txt
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
=========================================================================*/
/**
* Provides global function to the notification managers.
*
* @property ActivedownloadModel $Activedownload
* @property AssetstoreModel $Assetstore
* @property BitstreamModel $Bitstream
* @property CommunityModel $Community
* @property CommunityInvitationModel $CommunityInvitation
* @property object $Component
* @property FeedModel $Feed
* @property FeedpolicygroupModel $Feedpolicygroup
* @property FeedpolicyuserModel $Feedpolicyuser
* @property FolderModel $Folder
* @property FolderpolicygroupModel $Folderpolicygroup
* @property FolderpolicyuserModel $Folderpolicyuser
* @property object $Form
* @property GroupModel $Group
* @property ItemModel $Item
* @property ItempolicygroupModel $Itempolicygroup
* @property ItempolicyuserModel $Itempolicyuser
* @property ItemRevisionModel $ItemRevision
* @property LicenseModel $License
* @property MetadataModel $Metadata
* @property ModuleModel $Module
* @property object $ModuleComponent
* @property object $ModuleForm
* @property ModuleModel $Module
* @property NewUserInvitationModel $NewUserInvitation
* @property PendingUserModel $PendingUser
* @property ProgressModel $Progress
* @property SettingModel $Setting
* @property TokenModel $Token
* @property UserModel $User
* @property UserapiModel $Userapi;
*/
class MIDAS_Notification
{
/** @var array */
private $_task = array();
/** @var array */
private $_notification = array();
/**
* Return the translation of a given string.
*
* @param string $text string to translate
* @return string translated string or the input string if there is no translation
*/
protected function t($text)
{
Zend_Loader::loadClass('InternationalizationComponent', BASE_PATH.'/core/controllers/components');
return InternationalizationComponent::translate($text);
}
/** Constructor. */
public function __construct()
{
$this->loadElements();
$this->loadModuleElements();
if (!method_exists($this, 'init')) {
echo 'Init method missing in notification class';
exit;
}
$this->init();
}
/**
* Register task.
*
* @param string $name
* @param string $method
* @param string $comment
*/
public function addTask($name, $method, $comment)
{
$this->_task[$name] = array('method' => $method, 'comment' => $comment);
}
/**
* Register callback.
*
* @param string $name
* @param string $method
*/
public function addCallBack($name, $method)
{
if (isset($this->_notification[$name])) {
$this->_notification[$name] = array();
}
$this->_notification[$name][] = array('type' => 'callback', 'call' => $method);
}
/**
* Register event.
*
* @param string $name
* @param string $task
* @param int $priority
*/
public function addEvent($name, $task, $priority = MIDAS_EVENT_PRIORITY_NORMAL)
{
if (isset($this->_notification[$name])) {
$this->_notification[$name] = array();
}
$this->_notification[$name][] = array('type' => 'task', 'call' => $task, 'priority' => $priority);
}
/**
* Get Tasks.
*
* @return array
*/
public function getTasks()
{
return $this->_task;
}
/**
* Get notifications.
*
* @return array
*/
public function getNotifications()
{
return $this->_notification;
}
/**
* Fetch the logger from the Zend registry.
*
* @return Zend_Log
*/
public function getLogger()
{
return Zend_Registry::get('logger');
}
/** Load core components, DAOs, forms, and models. */
public function loadElements()
{
Zend_Registry::set('models', array());
if (isset($this->_models)) {
MidasLoader::loadModels($this->_models);
}
$modelsArray = Zend_Registry::get('models');
foreach ($modelsArray as $key => $tmp) {
$this->$key = $tmp;
}
if (isset($this->_daos)) {
foreach ($this->_daos as $dao) {
Zend_Loader::loadClass($dao.'Dao', BASE_PATH.'/core/models/dao');
}
}
Zend_Registry::set('components', array());
if (isset($this->_components)) {
foreach ($this->_components as $component) {
$nameComponent = $component.'Component';
Zend_Loader::loadClass($nameComponent, BASE_PATH.'/core/controllers/components');
if (!isset($this->Component)) {
$this->Component = new stdClass();
}
$this->Component->$component = new $nameComponent();
}
}
Zend_Registry::set('forms', array());
if (isset($this->_forms)) {
foreach ($this->_forms as $forms) {
$nameForm = $forms.'Form';
Zend_Loader::loadClass($nameForm, BASE_PATH.'/core/controllers/forms');
if (!isset($this->Form)) {
$this->Form = new stdClass();
}
$this->Form->$forms = new $nameForm();
}
}
}
/**
* Load module components, DAOs, forms, and models.
*
* @throws Zend_Exception
*/
public function loadModuleElements()
{
if (isset($this->_moduleModels)) {
MidasLoader::loadModels($this->_moduleModels, $this->moduleName);
$modelsArray = Zend_Registry::get('models');
foreach ($this->_moduleModels as $value) {
if (isset($modelsArray[$this->moduleName.$value])) {
$tmp = ucfirst($this->moduleName).'_'.$value;
$this->$tmp = $modelsArray[$this->moduleName.$value];
}
}
}
if (isset($this->_moduleDaos)) {
foreach ($this->_moduleDaos as $dao) {
if (file_exists(BASE_PATH.'/modules/'.$this->moduleName.'/models/dao/'.$dao.'Dao.php')) {
include_once BASE_PATH.'/modules/'.$this->moduleName.'/models/dao/'.$dao.'Dao.php';
} elseif (file_exists(
BASE_PATH.'/privateModules/'.$this->moduleName.'/models/dao/'.$dao.'Dao.php'
)) {
include_once BASE_PATH.'/privateModules/'.$this->moduleName.'/models/dao/'.$dao.'Dao.php';
} else {
throw new Zend_Exception('Unable to find dao '.$dao);
}
}
}
if (isset($this->_moduleComponents)) {
foreach ($this->_moduleComponents as $component) {
$nameComponent = ucfirst($this->moduleName).'_'.$component.'Component';
if (file_exists(
BASE_PATH.'/modules/'.$this->moduleName.'/controllers/components/'.$component.'Component.php'
)) {
include_once BASE_PATH.'/modules/'.$this->moduleName.'/controllers/components/'.$component.'Component.php';
} elseif (file_exists(
BASE_PATH.'/privateModules/'.$this->moduleName.'/controllers/components/'.$component.'Component.php'
)) {
include_once BASE_PATH.'/privateModules/'.$this->moduleName.'/controllers/components/'.$component.'Component.php';
} else {
throw new Zend_Exception('Unable to find components '.$component);
}
if (!class_exists($nameComponent)) {
throw new Zend_Exception('Unable to find '.$nameComponent);
}
if (!isset($this->ModuleComponent)) {
$this->ModuleComponent = new stdClass();
}
$this->ModuleComponent->$component = new $nameComponent();
}
}
if (isset($this->_moduleForms)) {
foreach ($this->_moduleForms as $forms) {
$nameForm = ucfirst($this->moduleName).'_'.$forms.'Form';
include_once BASE_PATH.'/modules/'.$this->moduleName.'/controllers/forms/'.$forms.'Form.php';
if (file_exists(
BASE_PATH.'/modules/'.$this->moduleName.'/controllers/forms/'.$forms.'Form.php'
)) {
include_once BASE_PATH.'/modules/'.$this->moduleName.'/controllers/forms/'.$forms.'Form.php';
} elseif (file_exists(
BASE_PATH.'/privateModules/'.$this->moduleName.'/controllers/forms/'.$forms.'Form.php'
)) {
include_once BASE_PATH.'/privateModules/'.$this->moduleName.'/controllers/forms/'.$forms.'Form.php';
} else {
throw new Zend_Exception('Unable to find form '.$forms);
}
if (!class_exists($nameForm)) {
throw new Zend_Exception('Unable to find '.$nameForm);
}
if (!isset($this->ModuleForm)) {
$this->ModuleForm = new stdClass();
}
$this->ModuleForm->$forms = new $nameForm();
}
}
}
}