Admin Modules Controller
Class declared in MODPATH/gleez/classes/controller/admin/modules.php on line 10.
boolean $auto_renderAuto render template?
boolean $debugTurn debugging on?
Request $requestRequest that created the controller
Response $responseThe response that will be returned from controller
string $site_nameThe site name
string $templatePage template
string $titleThe page title
string $title_separatorThe delimiter page header and site name
array $_accept_formatsList all supported formats for this controller (accept-type => path to format template)
boolean $_ajaxIs ajax request?
object $_authThe Auth Object
array $_benchmarkProfiling
Kohana_Config $_configThe configuration settings
array $_destiThe destination url
Format $_formatAn Format instance
boolean $_internalis internal request?
string $_page_classCurrent page class
string $_page_idCurrent page id, defaults to controller name
array $_regionsThe sidebar content
string $_response_formatHold the response format for this request
boolean $_sidebarsEnable sidebars for this request? For example: add or edit page don't requires sidebars
array $_tabsTabs navigation
object $_widgetsThe Widgets Object
array $redirectThe destination url
Confirm action
public function action_confirm()
{
if ( ! $this->valid_post('modules'))
{
throw new HTTP_Exception_403('Unauthorised access attempt to action');
}
$messages = array("error" => array(), "warn" => array());
$desired_list = array();
foreach (Module::available() as $module_name => $info)
{
if ($info->locked)
{
continue;
}
if ($desired = Arr::get($_POST, $module_name) == 1)
{
$desired_list[] = $module_name;
}
if ($info->active AND ! $desired AND Module::is_active($module_name))
{
$messages = Arr::merge($messages, Module::can_deactivate($module_name));
}
else if (!$info->active AND $desired AND ! Module::is_active($module_name))
{
$messages = Arr::merge($messages, Module::can_activate($module_name));
}
}
// Clear any cache for sure
Gleez::cache_delete();
if (empty($messages["error"]) AND empty($messages["warn"]))
{
$this->_do_save();
$result["reload"] = 1;
$this->request->redirect(Route::get('admin/module')->uri(), 200);
}
else
{
$v = new View('admin_modules_confirm.html');
$v->messages = $messages;
$v->modules = $desired_list;
$result["dialog"] = (string) $v;
$result["allow_continue"] = empty($messages["error"]);
}
}Module list
public function action_index()
{
// Clear any cache for sure
Gleez::cache('load_modules', '');
// Load modules
Module::load_modules(TRUE);
$this->title = __('Modules');
$view = View::factory('admin/module/list')
->set('available', Module::available());
$this->response->body($view);
}final public function action_skip()
{
// Do nothing
}If debugging is enabled, append profiler stats for non-production environments.
voidpublic function after()
{
parent::after();
}Loads the template View object, if it is direct request
voidpublic function before()
{
// Inform tht we're in admin section for themers/developers
Theme::$is_admin = TRUE;
if ( class_exists('ACL') )
{
ACL::required('administer site');
}
parent::before();
}public function index()
{
$this->response->body( __('Welcome to admin') );
}Is frontpage?
booleanpublic function is_frontpage()
{
$uri = preg_replace("#(/p\d+)+$#uD", '', rtrim($this->request->uri(), '/'));
return (empty($uri) OR ($uri === $this->_config->front_page));
}Returns TRUE if the POST has a valid CSRF
Usage:
if ($this->valid_post('upload_photo')) { ... }
string|NULL
$submit
= NULL - Submit value [Optional]boolean - Return TRUE if it's valid $_POSTpublic function valid_post($submit = NULL)
{
if ( ! $this->request->is_post())
{
return FALSE;
}
if (Request::post_max_size_exceeded())
{
Message::error(__('Max file size of :max Bytes exceeded!',
array(':max' => Request::get_post_max_size())
));
return FALSE;
}
if ( ! is_null($submit) )
{
if ( ! isset($_POST[$submit]))
{
Message::error(__('This form has altered. Please try submitting it again.'));
return FALSE;
}
}
$_token = $this->request->post('_token');
$_action = $this->request->post('_action');
$has_csrf = ! empty($_token) AND ! empty($_action);
$valid_csrf = $has_csrf AND CSRF::valid($_token, $_action);
if ($has_csrf AND ! $valid_csrf)
{
// CSRF was submitted but expired
Message::error(__('This form has expired. Please try submitting it again.'));
return FALSE;
}
if (isset($_POST['_captcha']))
{
$captcha = $this->request->post('_captcha');
if (empty($captcha))
{
// CSRF was not entered
Message::error(__('The security code can\'t be empty.'));
return FALSE;
}
elseif ( ! Captcha::valid($captcha))
{
Message::error(__('The security answer was wrong.'));
return FALSE;
}
}
return $has_csrf AND $valid_csrf;
}Creates a new controller instance. Each controller must be constructed with the request object that created it.
Request
$request
required - Request that created the controllerResponse
$response
required - The request's responsevoidpublic function __construct(Request $request, Response $response)
{
// Assign the request to the controller
$this->request = $request;
// Assign a response to the controller
$this->response = $response;
}Add sidebar column class
This method is chainable.
protected function _set_column_class()
{
$sidebar_left = $this->template->sidebar_left;
$sidebar_right = $this->template->sidebar_right;
if ( ! empty($sidebar_left) AND ! empty($sidebar_right))
{
$this->template->column_class = 'main-both';
$this->template->main_column = 6;
}
else
{
if ( ! empty($sidebar_left))
{
$this->template->column_class = 'main-left';
$this->template->main_column = 9;
}
if ( ! empty($sidebar_right))
{
$this->template->column_class = 'main-right';
$this->template->main_column = 9;
}
}
return $this;
}Set default CSS
protected function _set_default_css()
{
Assets::css('bootstrap', 'media/css/bootstrap.min.css', NULL, array('weight' => -15));
Assets::css('font-awesome', 'media/css/font-awesome.min.css', array('weight' => -13));
Assets::css('default', 'media/css/default.css', NULL, array('weight' => 0));
Assets::css('style', 'media/css/style.css', array('default'), array('weight' => 1));
}Set default JavaScript
protected function _set_default_js()
{
Assets::js('bootstrap', 'media/js/bootstrap.min.js', array('jquery'), FALSE, array('weight' => 5));
// Google js only in production and not in admin section
if (Kohana::PRODUCTION === Kohana::$environment AND Theme::$is_admin === FALSE)
{
$ua = $this->_config->get('google_ua', NULL);
if ( ! is_null($ua))
{
Assets::google_stats($ua);
}
}
}Set the default meta links
Used configuration settings.
protected function _set_default_meta_links()
{
$meta = $this->_config->get('meta', array());
$links = Arr::get($meta, 'links');
if ($links)
{
foreach ($links as $url => $attributes)
{
Meta::links($url, $attributes);
}
}
}Set the default meta tags
Using configuration settings.
protected function _set_default_meta_tags()
{
$meta = $this->_config->get('meta', array());
$tags = Arr::get($meta, 'tags');
if ($tags)
{
foreach ($tags as $handle => $value)
{
$conditional = NULL;
if (is_array($value))
{
$conditional = Arr::get($value, 'conditional');
$value = Arr::get($value, 'value', '');
}
$attrs = array();
if (isset($conditional))
{
$attrs['conditional'] = $conditional;
}
Meta::tags($handle, $value, $attrs);
}
}
}Set the default server headers
protected function _set_default_server_headers()
{
$headers = $this->_config->get('headers', array());
$headers['X-Gleez-Version'] = 'Gleez CMS v ' . Gleez::VERSION . ' (' . Gleez::CODENAME . ')';
$xmlrpc = $this->_config->get('xmlrpc', NULL);
/** @var $xmlrpc string|NULL */
if ( ! is_null($xmlrpc))
{
$headers['X-Pingback'] = URL::site($xmlrpc, TRUE);
}
$this->_set_server_headers($headers);
}Set the page title
protected function _set_head_title()
{
if ($this->title)
{
$head_title = array(
strip_tags($this->title),
$this->template->site_name
);
}
else
{
$head_title = array(
$this->template->site_name
);
if ($this->template->site_slogan)
{
$head_title[] = $this->template->site_slogan;
}
}
$this->template->head_title = implode($this->title_separator, $head_title);
}Set the profiler stats into template.
protected function _set_profiler_stats()
{
$queries = 0;
if (Kohana::$profiling)
{
// DB queries
foreach (Profiler::groups() as $group => $benchmarks)
{
if (strpos($group, 'database') === 0)
{
$queries += count($benchmarks);
}
}
}
// Get the total memory and execution time
$total = array(
'{memory_usage}' => number_format((memory_get_peak_usage() - KOHANA_START_MEMORY) / 1024 / 1024, 2) . 'MB',
'{gleez_version}' => Gleez::VERSION,
'{execution_time}' => number_format(microtime(TRUE) - KOHANA_START_TIME, 3) . ' seconds',
'{included_files}' => count(get_included_files()),
'{database_queries}' => $queries
);
// Insert the totals into the response
$this->template = strtr((string) $this->template, $total);
}Set the server headers
array
$headers
required - An associative array of server headersprotected function _set_server_headers($headers)
{
if (is_array($headers) AND ! empty($headers))
{
$this->response->headers($headers);
}
}Add sidebars
This method is chainable.
protected function _set_sidebars()
{
if ($this->_sidebars !== FALSE)
{
$this->template->sidebar_left = $this->_widgets->render('left');
$this->template->sidebar_right = $this->_widgets->render('right');
}
return $this;
}Do save
private function _do_save()
{
$changes = new stdClass();
$changes->activate = array();
$changes->deactivate = array();
$activated_names = array();
$deactivated_names = array();
foreach (Module::available() as $module_name => $info)
{
if ($info->locked)
{
continue;
}
try
{
$desired = Arr::get($_POST, $module_name) == 1;
if ($info->active AND ! $desired AND Module::is_active($module_name))
{
Module::deactivate($module_name);
$changes->deactivate[] = $module_name;
$deactivated_names[] = __($info->name);
}
elseif ( ! $info->active AND $desired AND ! Module::is_active($module_name))
{
if (Module::is_installed($module_name))
{
Module::upgrade($module_name);
}
else
{
Module::install($module_name);
}
Module::activate($module_name);
$changes->activate[] = $module_name;
$activated_names[] = __($info->name);
}
}
catch (Exception $e)
{
Kohana::$log->add(LOG::ERROR, Kohana::exception_text($e));
}
}
Module::event('module_change', $changes);
// @todo This type of collation is questionable from an i18n perspective
if ($activated_names)
{
Message::success(__('Activated: %names', array('%names' => join(", ", $activated_names))));
}
if ($deactivated_names)
{
Message::success(__('Deactivated: %names', array('%names' => join(", ", $deactivated_names))));
}
// Clear any cache for sure
Gleez::cache_delete();
}