Action.class.php

gehe zur Dokumentation dieser Datei

<?php
// ---------------------------------------------------------------------------
// $Id$
// ---------------------------------------------------------------------------
// OpenRat Content Management System
// Copyright (C) 2002-2004 Jan Dankert, cms@jandankert.de
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.


define('OR_NOTICE_OK'   ,'ok'     );
define('OR_NOTICE_WARN' ,'warning');
define('OR_NOTICE_ERROR','error'  );

class Action
{
     var $db;
     var $templateVars = Array();
     var $actionName;
     var $subActionName;
     var $actionClassName;

     var $writable;
     var $publishing;
     var $actionConfig;
     
     var $currentUser;


     function init()
     {
          global $conf;
          $this->writable    = !$conf['security']['readonly' ];
          $this->publishing  = !$conf['security']['nopublish'];
          $this->currentUser = Session::getUser();
          
          $this->templateVars['errors' ] = array();
          $this->templateVars['notices'] = array();
          $this->templateVars['mode'   ] = $this->getRequestVar('mode');
          
          header('Content-Language: '.$conf['language']['language_code']);
     }


     function getSessionVar( $varName )
     {
          global $SESS;

          if   ( !isset($SESS[ $varName ]) )
               return '';
          else return $SESS[ $varName ];
     }


     function setSessionVar( $varName,$value )
     {
          global $SESS;

          $SESS[ $varName ] = $value;
     }


     function getRequestVar( $varName,$transcode='' )
     {
          global $REQ;

          if   ( !isset($REQ[ $varName ]) )
               return '';
               
          
          switch( $transcode )
          {
               case 'abc':
                    $value  = strip_tags( strtolower($REQ[ $varName ] ) );
                    $my_set = 'abcdefghijklmnopqrstuvwxyz._-';
                    $first  = strtr( $value, $my_set, str_repeat('#', strlen($my_set)) );
                    $second = strtr( $value, $first , str_repeat('_', strlen($first )) );
                    return $second;

               case 'all':
                    return strip_tags( $REQ[ $varName ] );
                    
               default:
                    return $REQ[ $varName ];
          }
     }


     function hasRequestVar( $varName )
     {
          global $REQ;

          return( !empty($REQ[$varName]) );
     }


     function getRequestId()
     {
          if   ( $this->hasRequestVar('idvar') )
               return intval( $this->getRequestVar( $this->getRequestVar('idvar') ) );
          else
               return intval( $this->getRequestVar( REQ_PARAM_ID ) );
     }



     function setTemplateVar( $varName,$value )
     {
          $this->templateVars[ $varName ] = $value;
     }


     function setTemplateVars( $varList )
     {
          foreach( $varList as $name=>$value )
          {
               $this->setTemplateVar( $name,$value );
          }
     }


     function addValidationError( $name,$message="COMMON_VALIDATION_ERROR",$vars=array(),$log=array() )
     {
          if   ( !empty($message) )
               $this->addNotice('','',$message,OR_NOTICE_ERROR,$vars,$log);

          $this->templateVars['errors'][] = $name;
     }

     
     function addNotice( $type,$name,$text,$status=OR_NOTICE_OK,$vars=array(),$log=array() )
     {
          if   ( !is_array($log))
               $log = array($log);

          if   ( !is_array($vars))
               $vars = array($vars);
               
          if   ( $status === true )
               $status = OR_NOTICE_OK;
          elseif    ( $status === false )
               $status = OR_NOTICE_ERROR;

          $this->templateVars['notices'][] = array('type'=>$type,
                                                 'name'=>$name,
                                                   'key'=>'NOTICE_'.$text,
                                                   'vars'=>$vars,
                                                   'text'=>lang('NOTICE_'.$text,$vars),
                                                   'log'=>$log,
                                                   'status'=>$status);
     }


     
     function message( $title='ERROR',$add_info='' )
     {
          Logger::warn( 'creating error message, info='.$add_info );

          $this->setTemplateVar( 'title',lang( $title         ) );
          $this->setTemplateVar( 'text' ,lang( $title.'_DESC' ) );
          $this->setTemplateVar( 'info' ,$add_info );
          
          $this->forward('message');
     }


     function forward( $unbenutzterParameter = "" )
     {
          if   ( isset($this->actionConfig[$this->subActionName]['direct']) )
               exit; // Die Ausgabe ist bereits erfolgt (z.B. Bin�rdateien o. WebDAV)

          // Pruefen, ob HTTP-Header gesendet wurden. Dies deutet stark darauf hin, dass eine
          // PHP-Fehlermeldung ausgegeben wurde. In diesem Fall wird hier abgebrochen.
          // Weitere Ausgabe wuerde keinen Sinn machen, da wir nicht wissen, was
          // passiert ist.
          if   ( headers_sent() )
               Http::serverError("Some server error messages occured - see above - CMS canceled.");
               
          $httpAccept = getenv('HTTP_ACCEPT');
          $types = explode(',',$httpAccept);
          
          // Weitere Variablen anreichern.
          $this->templateVars['session'] = array('name'=>session_name(),'id'=>session_id());
          $this->templateVars['version'] = OR_VERSION;
          
          if   ( sizeof($types)==1 && in_array('application/json',$types) || $this->getRequestVar('output')=='json' )
          {
               require_once( OR_SERVICECLASSES_DIR."JSON.class.".PHP_EXT );
               $json = new JSON();
               header('Content-Type: application/json');
               echo $json->encode( $this->templateVars );
               exit;
          }

          if   ( sizeof($types)==1 && in_array('application/xml',$types) || $this->getRequestVar('output')=='xml' )
          {
               require_once( OR_SERVICECLASSES_DIR."XML.class.".PHP_EXT );
               $xml = new XML();
               $xml->root = 'server'; // Name des XML-root-Elementes
               header('Content-Type: application/xml');
               echo $xml->encode( $this->templateVars );
               exit;
          }

          $this->setMenu();
          
          $tplName = $this->actionName.'/'.$this->subActionName;

               
          if   ( isset($this->actionConfig[$this->subActionName]['action']) )
               $tplName = $this->actionConfig[$this->subActionName]['action'].'/'.$this->subActionName;

          if   (isset($this->actionConfig[$this->subActionName]['alias']))
               $tplName = (method_exists(new ObjectAction(),$this->subActionName)?'object':$this->actionName).'/'.$this->actionConfig[$this->subActionName]['alias'];
               
          if   (isset($this->actionConfig[$this->subActionName]['target']))
               $targetSubActionName = $this->actionConfig[$this->subActionName]['target'];

          if   ( isset($this->actionConfig[$this->subActionName]['menu']))
               $windowTitle = 'menu_title_'.$this->actionName.'_'.$this->actionConfig[$this->subActionName]['menu'];

          global $conf;
          global $REQ;
          global $PHP_SELF;
          global $HTTP_SERVER_VARS;
          global $image_dir;
                 
          $tplName = str_replace( '_','/',$tplName );
          
          $tplFileName = $tplName.'.tpl.'.PHP_EXT;
          $conf_php = PHP_EXT;
     
          // ?bertragen der Array-Variablen in den aktuellen Kontext
          //
          extract( $this->templateVars );

          // ?bertragen der Array-Variablen in den aktuellen Kontext
          //
          
          if   ( count($errors)>0 )
               extract( $REQ );
     
          // Setzen einiger Standard-Variablen
          //
          $tpl_dir    = OR_THEMES_DIR.$conf['interface']['theme'].'/pages/html/';
          $image_dir  = OR_THEMES_EXT_DIR.$conf['interface']['theme'].'/images/';
     
          $user = Session::getUser();
          
          if   ( strpos($conf['interface']['style']['extend'],'/')===false )
               $root_stylesheet = OR_THEMES_EXT_DIR.$conf['interface']['theme'].'/css/'.$conf['interface']['style']['extend'].'.css';
          else
               $root_stylesheet = $style['extend'];
               
          if   ( !is_object($user) )
               $user_stylesheet = OR_THEMES_EXT_DIR.$conf['interface']['theme'].'/css/'.$conf['interface']['style']['default'].'.css';
          else
               $user_stylesheet = OR_THEMES_EXT_DIR.$conf['interface']['theme'].'/css/'.$user->style.'.css';
          
          $self = $HTTP_SERVER_VARS['PHP_SELF'];
     
          $tplFileName = str_replace( '_','/',$tplFileName );

          if   ( !empty($conf['interface']['override_title']) )
               $cms_title = $conf['interface']['override_title'];
          else
               $cms_title = OR_TITLE.' '.OR_VERSION;

          $charset = $this->getCharset();
               
          $showDuration = $conf['interface']['show_duration'];

          $subActionName = $this->subActionName;
          $actionName    = $this->actionName;
          $requestId     = $this->getRequestId();
          
          if   ( $conf['theme']['compiler']['enable'] )
          {
               $te = new TemplateEngine();
               $te->compile( $tplName );
               unset($te);
          }

          // Einbinden des Templates
          require( $tpl_dir.$tplFileName );
          
          exit;
     }
     
     
     function callSubAction( $subActionName )
     {
          if   ( in_array($this->actionName,array('page','file','link','folder')) )
               Session::setSubaction( $subActionName );

          $this->subActionName = $subActionName;       

          Logger::trace("next subaction is '$subActionName'");
          
          $this->$subActionName();
     }


     function userIsAdmin()
     {
          $user = Session::getUser();
          return $user->isAdmin;
     }



     function getUserFromSession()
     {
          return Session::getUser();
     }


     
     function lastModified( $time )
     {
          $user = Session::getUser();
          if   ( $user->loginDate > $time )
               // Falls Benutzer-Login nach letzter �nderung.
               // Zweck: Nach einem Login sollte mind. 1x jede Seite neu geladen werden, dies
               // Ist z.B. nach einer Style-�nderung durch den Benutzer notwendig.
               // Falls aus Versehen doch einmal zuviel gecacht wurde, kann man das durch ein
               // Neu-Login beheben. 
               $time = $user->loginDate;

          // Conditional-Get eingeschaltet?
          global $conf;
          if   ( ! $conf['cache']['conditional_get'] )
               return;

          $lastModified = substr(date('r',$time-date('Z')),0,-5).'GMT';
          $etag         = '"'.md5($lastModified).'"';

          // Header senden
          header('Last-Modified: '.$lastModified );
          header('ETag: '         .$etag          );
          
          // Die vom Interpreter sonst automatisch gesetzten
          // Header uebersteuern
          header('Cache-Control: must-revalidate');
          header('Pragma:');

          // See if the client has provided the required headers
          $if_modified_since = isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) ? stripslashes($_SERVER['HTTP_IF_MODIFIED_SINCE']) : false;
          $if_none_match     = isset($_SERVER['HTTP_IF_NONE_MATCH']    ) ? stripslashes($_SERVER['HTTP_IF_NONE_MATCH']    ) :     false;

          if   ( !$if_modified_since && !$if_none_match )
               return;

          // At least one of the headers is there - check them
          if   ( $if_none_match && $if_none_match != $etag )
               return; // etag is there but doesn't match


          if   ( $if_modified_since && $if_modified_since != $lastModified )
               return; // if-modified-since is there but doesn't match

          // Der entfernte Browser bzw. Proxy holt die Seite nun aus seinem Cache 
          header('HTTP/1.0 304 Not Modified');
          exit;  // Sofortiges Skript-Ende
     }



     function maxAge( $max=3600 ) 
     {
          // Die Header "Last-Modified" und "ETag" wurden bereits in der
          // Methode "lastModified()" gesetzt.
          
          header('Expires: '.substr(date('r',time()-date('Z')+$max),0,-5).'GMT' );
          header('Pragma: '); // 'Pragma' ist Bullshit und
                              // wird von den meisten Browsern ignoriert.
          header('Cache-Control: public, max-age='.$max.", s-maxage=".$max);
     }    
     
     
     
     function setMenu()
     {
          if   (!isset($this->actionConfig[$this->subActionName]['menu']))
               return;
          $windowMenu = array();
          $name       = $this->actionConfig[$this->subActionName]['menu'];
          $menuList   = explode(',',$this->actionConfig['menu'][$name]);

          if   ( isset($this->actionConfig[$this->subActionName]['menuaction']))
               $actionName = $this->actionConfig[$this->subActionName]['menuaction'];
          else
               $actionName = $this->subActionName;
          
          foreach( $menuList as $menuName )
          {
               if   ( isset($this->actionConfig[$menuName]['alias']) )
                    $menuText = 'menu_'.$this->actionName.'_'.$this->actionConfig[$menuName]['alias'];
               else
                    $menuText = 'menu_'.$this->actionName.'_'.$menuName;
               
               
               $menuKey = 'accesskey_window_'.$menuName;
               
//             Logger::trace("testing menu $menuName");
               $menuEntry = array('subaction'=>$menuName,
                               'text'     =>$menuText,
                               'title'    =>$menuText.'_DESC',
                               'key'      =>$menuKey );
                               
               if   ( $this->checkMenu($menuName) )
                    $menuEntry['url'] = Html::url($actionName,$menuName,$this->getRequestId());
                    
               $windowMenu[] = $menuEntry;
          }
          $this->setTemplateVar('windowMenu',$windowMenu);
     }
     
     
     
     function checkMenu( $name )
     {
          // Standard: Alle Men�punkt sind aktiv.
          return true;
     }
     
     
     
     function getCharset()
     {
          $db = db_connection();
          
          if   ( isset($db->conf['charset']) )
               return $db->conf['charset'];
          else
               return lang('CHARSET');
     }
     
     
     function isEditable()
     {
          return isset($this->actionConfig[$this->subActionName]['editable']) && $this->actionConfig[$this->subActionName]['editable']; 
     }

     
     function isEditMode()
     {
          return !$this->isEditable() || $this->getRequestVar('mode')=='edit' || (isset($this->templateVars) && $this->templateVars['mode']=='edit'); 
     }
}

?>