File Source for modulo.classe.php

<?php
/**
* modulo.classe.php
*
* Faz inclusão de módulos validando e limpando $_REQUEST
*
* @copyright 2008 Soomp
* @author Marcio Merlone <mmerlone@gmail.com>
* @version 1.0
* @since 11/12/2006
* @package Soomp
*/
/* $Id: modulo.classe.php,v 1.34 2007/05/29 20:38:34 mmerlone Exp $ */
require_once(CFG_LOCAL_FRAMEWORK.'stdio.classe.php');
/**
* Faz a pré-carga de módulos, verifica permissões e executa o módulo
*/
class modulo extends stdio{
/**
* @var array $arrModulos Armazena os módulos disponíveis cfme. $CFG_MODULOS.
*/
protected $arrModulos = array();
/**
* @var string $strModule Armazena o nome do modulo $_GET['m'] solicitado
*/
protected $strModule = null;
/**
* @var object $objConfig Objeto de configuração do módulo
*/
protected $objConfig;
/**
* @var string $strAcao Define a ação para a qual desejamos saber se há permissão
*/
protected $strAcao = '';
/**
* @var string $strPath Nome completo do arquivo do módulo
*/
protected $strPath = null;
/**
* @var array $arrStylesScripts Armazena as folhas de estilo (css)
* e scripts (js) de cada módulo/ação
*/
protected $arrStylesScripts = array('css' => array(), 'js' => array());
/**
* @var array $arrInstances Armazena os objetos de módulos controladores já instanciados
* <code>
* $this->arrInstances = array('usuario' => (object) $usuario, 'grupo' => (object) $grupo, ...);
* </code>
*/
protected $arrInstances = array();
/**
* @var string $template_dir Caminho para os templates do módulo
*/
private $template_dir = null;
/**
* @var string $compile_dir Caminho para compilação dos templates
*/
private $compile_dir = null;
/**
* @var string $prev_template_dir Caminho para os templates anterior ao módulo
*/
private $prev_template_dir = null;
/**
* @var string $prev_compile_dir Caminho para compilação dos templates anterior ao módulo
*/
private $prev_compile_dir = null;
/**
* Construtor.
* @param array $CFG_MODULOS array com os modulos ativos no sistema (config.php)
*/
public function __construct(&$CFG_MODULOS = false){
if($CFG_MODULOS){
$this->arrModulos = $CFG_MODULOS;
}
}
/**
* Processa a requisição executando o método com nome $_GET['a'] definido
* na classe controladora do módulo $_GET['m'] solicitado.
*/
protected function run(){
$this->setModule();
$this->loadConfig();
$this->_setAction();
if(!empty($this->strModule) && !empty($this->strAcao)){
if(!$this->endRequest($this->_runModule())){
$this->msg(0, 'Erro ao executar o módulo.', 'erro');
}
}else{
switch($this->strAcao){
case 'login';
$this->_login();
break;
case 'logindo':
$this->_logindo();
break;
case 'logout':
$this->_logout();
break;
default:
$this->_outputIndex();
break;
}
exit;
}
}
/**
* Exibe o formulário de login
*/
private function _login(){
if($this->_smarty()){
$this->outputHead();
$this->smarty->assign('username', isset($_SESSION['wronglogin']) ? $_SESSION['wronglogin'] : null);
$this->smarty->display('usuarioLogin.tpl');
$this->outputFoot();
unset($_SESSION['wronglogin']);
}
}
/**
* Encerra a sessão autenticada
*/
protected function _logout(){
if (isset($_COOKIE[session_name()])){
setcookie(session_name(), session_id(), time()-42000, '/');
}
session_destroy();
session_name(CFG_PROJETO);
session_start();
session_regenerate_id();
$_SESSION = array();
if(is_object($this->objUser) && $this->objUser->{CFG_USUARIO_DB_PK} >= 0){
$this->msg(0, 'Logout efetuado com sucesso.', 'sucesso');
$this->objUser = new usuario();
}else{
$this->msg(0, 'Sessão expirada.', 'sucesso');
}
$this->endRequest('index.php');
break;
}
/**
* Processa os dados de autenticação do formulário de login
*/
private function _logindo(){
$u = new usuario();
$u->Load($_POST[CFG_USUARIO_DB_USERNAME]);
if($u->Auth($_POST[CFG_USUARIO_DB_SENHA])){
$this->objUser = $u;
$this->objUser->ip = $_SERVER['REMOTE_ADDR'];
if(property_exists($this->objUser, 'TS_LOGIN')){
if($this->objUser->TS_LOGIN == '0000-00-00 00:00:00'){
$strWelcome = 'Este é seu primeiro acesso. Bem vindo.';
}else{
$strWelcome = 'Seu último acesso foi em '.strftime('%c', strtotime($this->objUser->TS_LOGIN)).'.';
}
}
$this->msg(0, 'Login efetuado com sucesso. '.$strWelcome, 'sucesso');
$this->objUser->TS_LOGIN = date('Y-m-d H:i:s', time()); // 2007-02-23 11:42:51
$this->objUser->Save();
if(!is_null(CFG_MODULE_LOGIN_MODULE) && CFG_MODULE_LOGIN_MODULE!= '' && !is_null(CFG_MODULE_LOGIN_ACTION) && CFG_MODULE_LOGIN_ACTION != ''){
$this->endRequest('index.php?m='.CFG_MODULE_LOGIN_MODULE.'&a='.CFG_MODULE_LOGIN_ACTION);
}else{
$this->endRequest('index.php');
}
}else{
$this->msg(0, 'Usuario desconhecido ou senha incorreta.', 'erro');
$_SESSION['wronglogin'] = $_POST[CFG_USUARIO_DB_USERNAME];
$this->endRequest('index.php?a=login&s=401');
}
break;
}
/**
* Exibe o template index.tpl
*/
private function _outputIndex(){
if($this->_smarty()){
$this->outputHead();
$this->smarty->display('index.tpl'); // Se não pediu nada mostra o index
$this->outputFoot();
}
}
/**
* Exibe o cabeçalho HTML como DTD e etc.
* Caso exista, exibirá o css e/ou js do módulo/ação solicitados.
* Por ex.: index.php?m=usuario&a=lista irá exibir
* - usuario.lista.[css|js]
* - lista.[css|js]
* - usuario.[css|js]
*/
public function outputHead(){
if(isset($_GET['s'])){
switch((int) $_GET['s']){
case 401:
header('HTTP/1.0 401 Unauthorized');
break;
case 404:
header('HTTP/1.1 404 Not Found');
header('Status: 404 Not Found');
break;
}
}
if($this->_smarty()){
$this->smarty->assign('USER', $this->objUser);
$this->smarty->assign('acao', $this->strAcao);
$this->smarty->assign('modulo', $this->strModule);
$this->smarty->assign('debugged', isset($_SESSION['debugged']) ? $_SESSION['debugged'] : false);
$this->smarty->display('head.tpl');
$_SESSION['debugged'] = true;
ob_flush(); // Força o output dos buffers para o browser
flush();
}
}
/**
* Exibe o rodapé HTML, fecha tags, exibe mensagens de sistema, etc.
*/
public function outputFoot(){
if($this->_smarty()){
$this->smarty->outputMsgs();
$this->smarty->display('foot.tpl');
}
}
/**
* Define $this->strModule
* @param string $strModule nome do módulo
*/
public function setModule($strModule = false){
if($strModule){
if(isset($this->arrModulos[$strModule])){
$this->strModule = $strModule;
}else{
$this->strModule = null;
$this->msg(0, 'Modulo desconhecido: "'.$strModule.'"', 'erro');
}
}elseif(isset($_GET['m']) && !empty($_GET['m'])){
if(isset($this->arrModulos[$_GET['m']])){
$this->strModule = $_GET['m'];
}else{
header('HTTP/1.1 404 Not Found');
header('Status: 404 Not Found');
$this->strModule = null;
$this->msg(0, 'Modulo desconhecido: "'.$_GET['m'].'"', 'erro');
}
}elseif(!is_null(CFG_MODULE_DEFAULT_MODULE)){
if(isset($this->arrModulos[CFG_MODULE_DEFAULT_MODULE])){
$this->strModule = CFG_MODULE_DEFAULT_MODULE;
}else{
header('HTTP/1.1 404 Not Found');
header('Status: 404 Not Found');
$this->strModule = null;
$this->msg(0, 'Erro de configuração, modulo "'.CFG_MODULE_DEFAULT_MODULE.'" desconhecido. Verifique CFG_MODULE_DEFAULT_MODULE no config.php do módulo.', 'erro');
}
}else{
$this->strModule = null;
}
$this->strPath = !is_null($this->strModule) && isset($this->arrModulos[$this->strModule]) ? $this->arrModulos[$this->strModule] : null;
}
/**
* Lê a configuração do módulo
* @param string $strPath caminho para o módulo com o config.php
*/
public function loadConfig($strPath = false){
if($strPath){
$this->strPath = $strPath;
}
if($this->strPath){
require_once($this->strPath.'/config.php');
$strConfName = $this->strModule.'_conf';
$this->objConfig = new $strConfName();
require_once(CFG_LOCAL_FRAMEWORK.'idioma.classe.php');
$idioma = idioma::getInstance();
foreach($this->objConfig->actions as &$action){
if(is_array($action[1])){
$action[1] = convertCharset($idioma->getString($action[1]));
}
}
if(!$this->objConfig->active){
$this->objConfig = $this->strPath = $this->strModule = null;
$this->msg(0, 'Módulo indisponível. Contate o administrador do sistema.', 'erro');
}
return $this->objConfig;
}
}
/**
* Overload de propriedades privadas
* @param string $var nome da propriedade
* @param mixed $value valor da propriedade
*/
private function __set($var, $value){
$this->$var = $value;
}
/**
* Overload de propriedades privadas
* @param string $var nome da propriedade
* @return mixed valor da propriedade
*/
private function __get($var){
return $this->$var;
}
/**
* Define $this->strAcao
*/
private function _setAction(){
if(isset($_GET['a']) && !empty($_GET['a'])){
$arrAcoesAuth = array('login' => 1, 'logindo' => 1, 'logout' => 1);
if(isset($arrAcoesAuth[$_GET['a']]) || ($this->strPath && isset($this->objConfig->actions[$_GET['a']]))){
$this->strAcao = $_GET['a'];
}else{
header('HTTP/1.1 404 Not Found');
header('Status: 404 Not Found');
$this->strAcao = $this->strModule = null;
$this->msg(0, 'Ação desconhecida: "'.$_GET['a'].'"', 'erro');
}
}elseif(!is_null(CFG_MODULE_DEFAULT_ACTION)){
if(isset($this->objConfig->actions[CFG_MODULE_DEFAULT_ACTION])){
$this->strAcao = CFG_MODULE_DEFAULT_ACTION;
}else{
header('HTTP/1.1 404 Not Found');
header('Status: 404 Not Found');
$this->strAcao = $this->strModule = null;
$this->msg(0, 'Erro de configuração, ação "'.CFG_MODULE_DEFAULT_ACTION.'" desconhecida. Verifique CFG_MODULE_DEFAULT_ACTION no config.php do módulo.', 'erro');
}
}else{
$this->strAcao = 'lista';
}
}
/**
* Procura e carrega arquivos css, js, etc em CFG_PATH.'web/*'
* Busca por arquivos no padrão <strModule>.<strAcao>.<tipo>, onde <tipo>
* pode ser 'js' ou 'css'
* Por ex.: index.php?m=usuario&a=lista deverá possuir um arquivo <tipo>
* no mesmo dir especificado com os nomes (em ordem):
* - usuario.lista.xxx
* - usuario.xxx
* - lista.xxx
* Serão usados TODOS OS ARQUIVOS encontrados.
*/
private function _loadScriptsStyles(){
if(isset($this->strModule) && isset($this->strAcao) && $this->_smarty()){
foreach(array('js', 'css') as $strTipo){
switch($strTipo){
case 'js':
$strDir = CFG_PATH.'/web/j/';
break;
case 'css':
$strDir = CFG_PATH.'/web/c/';
break;
}
$arrFiles = array($this->strModule.'.'.$this->strAcao.'.'.$strTipo,
$this->strModule.'.'.$strTipo,
$this->strAcao.'.'.$strTipo);
foreach($arrFiles as $file){
if(!isset($this->arrStylesScripts[$strTipo][$this->strModule][$this->strAcao][$file])){
if(is_file($strDir.$file)){
$this->arrStylesScripts[$strTipo][$this->strModule][$this->strAcao][$file] = $file;
}
}
}
}
}
}
/**
* Reconfigura os diretórios do smarty para o módulo
* Pode-se criar um diretório 't' no mesmo diretório do módulo para os
* templates do módulo.
* Pode-se criar um diretório 'templates_c' no mesmo diretório do módulo
* para os templates compilados do módulo
*/
private function _configSmarty(){
if($this->_smarty()){
$this->smarty->assign('modulo', $this->strModule);
$dir = dirname($this->strPath);
$this->prev_compile_dir = $this->smarty->compile_dir;
if(is_dir($dir.'/templates_c')){
$this->smarty->compile_dir = $this->compile_dir = $dir.'/templates_c/';
}
$this->prev_template_dir = $this->smarty->template_dir;
if(is_dir($dir.'/t')){
$this->smarty->template_dir = $this->template_dir = $dir.'/t/';
}
$this->smarty->assign('csss', isset($this->arrStylesScripts['css'][$this->strModule][$this->strAcao]) && !empty($this->arrStylesScripts['css'][$this->strModule][$this->strAcao]) ? $this->arrStylesScripts['css'][$this->strModule][$this->strAcao] : array());
$this->smarty->assign('scripts', isset($this->arrStylesScripts['js'][$this->strModule][$this->strAcao]) && !empty($this->arrStylesScripts['js'][$this->strModule][$this->strAcao]) ? $this->arrStylesScripts['js'][$this->strModule][$this->strAcao] : array());
}
}
/**
* Restaura as configurações prévias do smarty
*/
private function _restoreSmarty(){
if($this->_smarty()){
$this->smarty->compile_dir = $this->prev_compile_dir;
$this->smarty->template_dir = $this->prev_template_dir;
}
}
/**
* Carrega o módulo, verifica existência dos arrays de permissões
*/
private function _runModule(){
if($this->strModule){
$strModuleController = 'c'.$this->strModule;
/**
* Instancia o controlador caso ainda não esteja e o armazena em
* $this->arrInstances[this->strModule]
*/
if(!isset($this->arrInstances[$this->strModule]) || !is_object($this->arrInstances[$this->strModule])){
require_once($this->strPath.'/'.$strModuleController.'.modulo.php');
$this->arrInstances[$this->strModule] = new $strModuleController();
}
/**
* Verifica se o módulo possui a propriedade $acoes
*/
if($this->_checkModulo()){
require_once(CFG_LOCAL_FRAMEWORK.'perms.classe.php');
$perms = new perms();
$bitsPermsModule = isset($this->objConfig->actions->permissions) ? $this->objConfig->actions->permissions : $perms->getBitsPerm($this->strModule);
$perms->setBitsUser($this->objUser, $bitsPermsModule);
$this->_loadScriptsStyles();
/**
* Verifica nos grupos do usuário se o $acoes do modulo permite
* acesso
*/
if($perms->checkUser($this->objConfig->actions[$this->strAcao][0])){
/**
* GO! GO! GO!
* É aqui que o módulo é executado.
*/
$this->_configSmarty();
$retorno = $this->arrInstances[$this->strModule]->{$this->strAcao}($this);
$this->_restoreSmarty();
}else{
if(defined('INDEX')){
if (isset($_COOKIE[session_name()])){
$this->msg(0, 'Sem permissão para este recurso.', 'erro');
}else{
$this->msg(0, 'Sessão expirada, favor efetuar novo login.', 'erro');
}
header('HTTP/1.0 401 Unauthorized');
$this->redireciona(401); // Manda para o index.
}else{
/**
* @todo verificar se é interessante definir códigos
* de erro para o ajax
*/
$retorno = false;
}
}
if(defined('AJAX')){
require_once(CFG_LOCAL_FRAMEWORK.'/terceiros/json.classe.php');
$objJsonConverter = new Services_JSON();
echo $objJsonConverter->encode($retorno);
exit;
}
return $retorno;
}else{
$this->msg(0, 'Modulo "'.$this->strModule.'" não implementa a ação solicitada, permissões ou nenhuma ação!', E_USER_NOTICE);
$this->strModule = null;
return false;
}
}else{
return false;
}
}
/**
* Verifica se a configuração da classe controladora do módulo está habilitada
* ($this->objConfig->active) e se possui as propriedades necessárias para execução:
* - Se possui ações (!empty($this->objConfig->actions))
* - Se existe $this->objConfig->actions[$_GET['a']]
* - Se existe o método $_GET['a'] em $this->arrInstances[$this->strModule]
*/
private function _checkModulo(){
if($this->objConfig->active
&& is_array($this->objConfig->actions)
&& isset($this->objConfig->actions[$this->strAcao])
&& method_exists($this->arrInstances[$this->strModule], $this->strAcao)){
return true;
}else{
$this->arrInstances[$this->strModule] = null;
return false;
}
}
}
?>

Documentation generated on Sun, 09 Mar 2008 23:52:36 -0300 by phpDocumentor 1.4.0

Source for file modulo.classe.php