[Cs-content-commits] SF.net SVN: cs-content:[334] trunk/1.0
PHP Templating & Includes System
Brought to you by:
crazedsanity
Menu
▾
▴
[Cs-content-commits] SF.net SVN: cs-content:[334] trunk/1.0
|
From: <cra...@us...> - 2009-01-29 21:15:25
|
Revision: 334
http://cs-content.svn.sourceforge.net/cs-content/?rev=334&view=rev
Author: crazedsanity
Date: 2009-01-29 21:15:20 +0000 (Thu, 29 Jan 2009)
Log Message:
-----------
Fix references from cs_genericPageClass.php to cs_genericPage.class.php.
/contentSystem.class.php:
* MAIN:::
-- fix include to point to new cs_genericPage{} class file
/cs_genericPage.class.php [RENAMED FROM cs_genericPageClass.php]
/cs_genericPageClass.php [RENAMED TO cs_genericPage.class.php]
Modified Paths:
--------------
trunk/1.0/contentSystem.class.php
Added Paths:
-----------
trunk/1.0/cs_genericPage.class.php
Removed Paths:
-------------
trunk/1.0/cs_genericPageClass.php
Modified: trunk/1.0/contentSystem.class.php
===================================================================
--- trunk/1.0/contentSystem.class.php 2009-01-29 21:04:18 UTC (rev 333)
+++ trunk/1.0/contentSystem.class.php 2009-01-29 21:15:20 UTC (rev 334)
@@ -73,7 +73,7 @@
require_once(dirname(__FILE__) ."/abstract/cs_content.abstract.class.php");
require_once(dirname(__FILE__) ."/cs_fileSystem.class.php");
require_once(dirname(__FILE__) ."/cs_sessionClass.php");
-require_once(dirname(__FILE__) ."/cs_genericPageClass.php");
+require_once(dirname(__FILE__) ."/cs_genericPage.class.php");
require_once(dirname(__FILE__) ."/cs_tabsClass.php");
class contentSystem extends cs_contentAbstract {
Copied: trunk/1.0/cs_genericPage.class.php (from rev 331, trunk/1.0/cs_genericPageClass.php)
===================================================================
--- trunk/1.0/cs_genericPage.class.php (rev 0)
+++ trunk/1.0/cs_genericPage.class.php 2009-01-29 21:15:20 UTC (rev 334)
@@ -0,0 +1,619 @@
+<?php
+/*
+ * FILE INFORMATION:
+ * $HeadURL$
+ * $Id$
+ * $LastChangedDate$
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ */
+require_once(dirname(__FILE__) ."/template.inc");
+require_once(dirname(__FILE__) ."/abstract/cs_content.abstract.class.php");
+
+class cs_genericPage extends cs_contentAbstract {
+ var $templateObj; //template object to parse the pages
+ var $templateVars = array(); //our copy of the global templateVars
+ var $mainTemplate; //the default layout of the site
+
+ private $tmplDir;
+ private $libDir;
+ private $siteRoot;
+ private $allowRedirect;
+
+ private $showEditableLink = FALSE;
+
+ private $allowInvalidUrls=NULL;
+
+ //---------------------------------------------------------------------------------------------
+ /**
+ * The constructor.
+ */
+ public function __construct($restrictedAccess=TRUE, $mainTemplateFile=NULL, $allowRedirect=TRUE) {
+ //handle some configuration.
+ $this->allowRedirect = $allowRedirect;
+
+ //initialize stuff from our parent...
+ parent::__construct();
+
+ //initialize some internal stuff.
+ $this->initialize_locals($mainTemplateFile);
+
+ //if they need to be logged-in...
+ $this->check_login($restrictedAccess);
+
+ if(!defined('CS-CONTENT_SESSION_NAME')) {
+ define("CS-CONTENT_SESSION_NAME", ini_get('session.name'));
+ }
+
+ //TODO: if the end page doesn't want to allow the "edit" links, will this still work?
+ if(defined("CS_CONTENT_MODIFIABLE") && constant("CS_CONTENT_MODIFIABLE") === TRUE) {
+ $this->showEditableLink = TRUE;
+ }
+ }//end __construct()
+ //---------------------------------------------------------------------------------------------
+
+
+
+ //---------------------------------------------------------------------------------------------
+ /**
+ * Initializes some internal objects, variables, and so on.
+ */
+ protected function initialize_locals($mainTemplateFile) {
+
+ //NOTE: this **requires** that the global variable "SITE_ROOT" is already set.
+ $this->siteRoot = preg_replace('/\/public_html/', '', $_SERVER['DOCUMENT_ROOT']);
+ $this->tmplDir = $this->siteRoot .'/templates';
+ $this->libDir = $this->siteRoot .'/lib';
+
+ //if there have been some global template vars (or files) set, read 'em in here.
+ if(is_array($GLOBALS['templateVars']) && count($GLOBALS['templateVars'])) {
+ foreach($GLOBALS['templateVars'] as $key=>$value) {
+ $this->add_template_var($key, $value);
+ }
+ }
+ if(isset($GLOBALS['templateFiles']) && is_array($GLOBALS['templateFiles'])) {
+ foreach($GLOBALS['templateFiles'] as $key => $value) {
+ $this->templateFiles[$key] = $value;
+ }
+ }
+ unset($GLOBALS['templateVars'], $GLOBALS['templateFiles']);
+
+ //build a new instance of the template library (from PHPLib)
+ $this->templateObj=new Template($this->tmplDir,"keep"); //initialize a new template parser
+
+ if(preg_match('/^\//', $mainTemplateFile)) {
+ $mainTemplateFile = $this->tmplDir ."/". $mainTemplateFile;
+ }
+ $this->mainTemplate=$mainTemplateFile; //load the default layout
+ }//end initialize_locals()
+ //---------------------------------------------------------------------------------------------
+
+
+
+ //---------------------------------------------------------------------------------------------
+ /**
+ * Should just check to see if they've authenticated. In reality, this
+ * just performs blind redirection if $restrictedAccess is set (and if
+ * redirecting is allowed).
+ */
+ public function check_login($restrictedAccess) {
+ if($restrictedAccess) {
+ $myUri = $_SERVER['SCRIPT_NAME'];
+ $doNotRedirectArr = array('/login.php', '/admin/login.php', '/index.php', '/admin.php',
+ '/content', '/content/index.php'
+ );
+ $myUrlString="";
+ $myGetArr = $_GET;
+ if(is_array($myGetArr) && count($myGetArr) > 0) {
+ unset($myGetArr['PHPSESSID']);
+ unset($myGetArr[CS-CONTENT_SESSION_NAME]);
+ $myUrlString = string_from_array($myGetArr, NULL, 'url');
+ }
+
+ //TODO: make the redirectHere variable dynamic--an argument, methinks.
+ $redirectHere = '/login.php?destination='. $myUrlString;
+
+ //Not exitting after conditional_header() is... bad, m'kay?
+ $this->conditional_header($redirectHere, TRUE);
+ exit;
+ }
+ }//end check_login()
+ //---------------------------------------------------------------------------------------------
+
+
+
+ //---------------------------------------------------------------------------------------------
+ /**
+ * Remove all data from the special template var "content" (or optionally another ver).
+ *
+ * @param $section (str,optional) defines what template var to wip-out.
+ * @return (NULL)
+ */
+ public function clear_content($section="content"){
+ $this->change_content(" ",$section);
+ }//end clear_content()
+ //---------------------------------------------------------------------------------------------
+
+
+
+ //---------------------------------------------------------------------------------------------
+ /**
+ * Change the content of a template to the given data.
+ *
+ * @param $htmlString (str) data to use.
+ * @param $section (str,optional) define a different section.
+ *
+ * @return (NULL)
+ */
+ public function change_content($htmlString,$section="content"){
+ $this->templateVars[$section] = $htmlString;
+ }//end change_content()
+ //---------------------------------------------------------------------------------------------
+
+
+
+ //---------------------------------------------------------------------------------------------
+ /**
+ * Adds a template file (with the given handle) to be parsed.
+ *
+ * TODO: check if $fileName exists before blindly trying to parse it.
+ */
+ public function add_template_file($handleName, $fileName){
+ if($this->showEditableLink) {
+ $prefix = '[<a href="#NULL_page='. $fileName .'"><font color="red"><b>Edit "'. $handleName .'"</b></font></a>]<BR>';
+ $this->add_template_var($handleName, $prefix .$this->file_to_string($fileName));
+ }
+ else {
+ $this->add_template_var($handleName, $this->file_to_string($fileName));
+ }
+ }//end add_template_file()
+ //---------------------------------------------------------------------------------------------
+
+
+
+ //---------------------------------------------------------------------------------------------
+ /**
+ * Adds a value for a template placeholder.
+ */
+ public function add_template_var($varName, $varValue){
+ $this->templateVars[$varName]=$varValue;
+ }//end add_template_var();
+ //---------------------------------------------------------------------------------------------
+
+
+
+ //---------------------------------------------------------------------------------------------
+ /**
+ * Rips the given block row name from the parent templateVar, (optionally) replacing it with
+ * a template var of the same name.
+ *
+ * @param $parent (str) name of the templateVar to pull the block row from.
+ * @param $handle (str) name of the block row to rip from it's parent.
+ * @param $removeDefs (bool,optional) if evaluated as FALSE, no template var is left in
+ * place of the block row.
+ *
+ * @return (bool false) FAIL: unable to find block row.
+ * @return (str) PASS: content of the block row.
+ */
+ public function set_block_row($parent, $handle, $removeDefs=0) {
+ $name = $handle;
+ $str = $this->templateVars[$parent];
+
+ $reg = "/<!-- BEGIN $handle -->.+<!-- END $handle -->/sU";
+ preg_match_all($reg, $str, $m);
+ if(!is_string($m[0][0])) {
+ #exit("set_block_row(): couldn't find '$handle' in var '$parent'");
+ $retval = FALSE;
+ } else {
+ if($removeDefs) {
+ $openHandle = "<!-- BEGIN $handle -->";
+ $endHandle = "<!-- END $handle -->";
+ $m[0][0] = str_replace($openHandle, "", $m[0][0]);
+ $m[0][0] = str_replace($endHandle, "", $m[0][0]);
+ }
+
+ $str = preg_replace($reg, "{" . "$name}", $str);
+ $this->templateVars[$parent] = $str;
+ $this->templateRows[$name] = $m[0][0];
+ $this->add_template_var($name, "");
+ $retval = $m[0][0];
+ }
+ return($retval);
+ }//end set_block_row()
+ //---------------------------------------------------------------------------------------------
+
+
+
+ //---------------------------------------------------------------------------------------------
+ /**
+ * Using the given template, it will replace each index (in $repArr) with it's value: each
+ * var to be replaced must begin the given begin & end delimiters.
+ *
+ * @param $template (str) Data to perform the replacements on.
+ * @param $repArr (array) Array of name=>value pairs, where name is to be replaced with value.
+ * @param $b (str,optional) beginning delimiter.
+ * @param $e (str,optional) ending delimiter.
+ */
+ public function mini_parser($template, $repArr, $b='%%', $e='%%') {
+ return($this->gfObj->mini_parser($template, $repArr, $b, $e));
+ }//end mini_parser()
+ //---------------------------------------------------------------------------------------------
+
+
+
+ //---------------------------------------------------------------------------------------------
+ /**
+ * Processes all template vars & files, etc, to produce the final page. NOTE: it is a wise idea
+ * for most pages to have this called *last*.
+ *
+ * @param $stripUndefVars (bool,optional) Remove all undefined template vars.
+ *
+ * @return (str) Final, parsed page.
+ */
+ public function print_page($stripUndefVars=1) {
+ //Show any available messages.
+ $this->process_set_message();
+
+ //Load the default page layout.
+ $this->templateObj->set_file("main", $this->mainTemplate);
+
+ //load the placeholder names and thier values
+ $this->templateObj->set_var($this->templateVars);
+ $this->templateObj->parse("out","main"); //parse the sub-files into the main page
+
+ if($stripUndefVars) {
+ $numLoops = 0;
+ while(preg_match_all('/\{.\S+?\}/', $this->templateObj->varvals['out'], $tags) && $numLoops < 50) {
+ $tags = $tags[0];
+
+ //TODO: figure out why this works when running it twice.
+ foreach($tags as $key=>$str) {
+ $str2 = str_replace("{", "", $str);
+ $str2 = str_replace("}", "", $str2);
+ if(!$this->templateVars[$str2] && $stripUndefVars) {
+ //TODO: set an internal pointer or something to use here, so they can see what was missed.
+ $this->templateObj->varvals[out] = str_replace($str, '', $this->templateObj->varvals[out]);
+ }
+ }
+ $this->templateObj->parse("out", "out");
+ $numLoops++;
+ }
+ }
+ $this->templateObj->pparse("out","out"); //parse the main page
+
+ }//end of print_page()
+ //---------------------------------------------------------------------------------------------
+
+
+
+ //---------------------------------------------------------------------------------------------
+ /**
+ * Handles a message that was set into the session.
+ */
+ public function process_set_message() {
+ //if there's not a message set, skip.
+ $errorBox = "";
+ if(isset($_SESSION['message']) && is_array($_SESSION['message'])) {
+ $errorBox = $this->file_to_string("system/message_box.tmpl");
+ //let's make sure the "type" value is *lowercase*.
+ $_SESSION['message']['type'] = strtolower($_SESSION['message']['type']);
+
+ //WARNING::: if you give it the wrong type, it'll STILL be parsed. Otherwise
+ // this has to match set_message() FAR too closely. And it's a pain.
+ $_SESSION['message']['messageType'] = $_SESSION['message']['type'];
+ $errorBox = $this->gfObj->mini_parser($errorBox, $_SESSION['message'], '{', '}');
+ if($_SESSION['message']['type'] == "fatal") {
+ //replace content of the page with our error.
+ $this->change_content($errorBox);
+ } else {
+ //Non-fatal: put it into a template var.
+ $this->add_template_var("error_msg", $errorBox);
+ }
+
+ //now that we're done displaying the message, let's get it out of the session (otherwise
+ // they'll never get past this point).
+ unset($_SESSION['message']);
+ }
+ return($errorBox);
+ }//end of process_set_message()
+ //---------------------------------------------------------------------------------------------
+
+
+
+ //---------------------------------------------------------------------------------------------
+ /**
+ * Takes a template file, whose root must be within $GLOBALS['TMPLDIR'], pulls it's
+ * content & returns it.
+ */
+ public function file_to_string($templateFileName) {
+ $templateFileName = preg_replace('/\/\//', '\/', $templateFileName);
+ if($this->template_file_exists($templateFileName)) {
+ $retval = file_get_contents($this->tmplDir .'/'. $templateFileName);
+ } else {
+ $this->set_message_wrapper(array(
+ "title" => 'Template File Error',
+ "message" => 'Not all templates could be found for this page.',
+ "type" => 'error'
+ ));
+ }
+ return($retval);
+ }//end file_to_string()
+ //---------------------------------------------------------------------------------------------
+
+
+
+ //---------------------------------------------------------------------------------------------
+ /**
+ * Checks to see if the given filename exists within the template directory.
+ */
+ public function template_file_exists($file) {
+ $retval = 0;
+ //If the string doesn't start with a /, add one
+ if (strncmp("/",$file,1)) {
+ //strncmp returns 0 if they match, so we're putting a / on if they don't
+ $file="/".$file;
+ }
+ $filename=$this->tmplDir.$file;
+
+ if(file_exists($filename)) {
+ $retval = $filename;
+ }
+ return($retval);
+ }//end template_file_exists()
+ //---------------------------------------------------------------------------------------------
+
+
+
+ //---------------------------------------------------------------------------------------------
+ /**
+ * Creates an array in the session, used by the templating system as a way to
+ * get messages generated by the code into the page, without having to add
+ * special templates & such each time.
+ *
+ * @param $title (str) the title of the message.
+ * @param $message (str) text beneath the title.
+ * @param $linkURL (str,optional) URL for the link below the message.
+ * @param $type (str) notice/status/error/fatal message, indicating
+ * it's importance. Generally, fatal messages
+ * cause only the message to be shown.
+ * @param $linkText (str,optional) text that the link wraps.
+ * @param $overwriteSame (bool,optional) whether setting a message which has
+ * the same type as an already set message will
+ * overwite the previous. More important messages
+ * always overwrite lesser ones.
+ * @param $priority (int,optional) specify the message's priority.
+ *
+ * @return (bool) Indicates pass (true)/fail (false)
+ */
+ function set_message($title=NULL, $message=NULL, $linkURL=NULL, $type=NULL, $linkText=NULL, $overwriteSame=NULL, $priority=NULL) {
+ if(!isset($overwriteSame)) {
+ $overwriteSame = 1;
+ }
+
+ //defines the importance level of each type of message: the higher the value, the more important it is.
+ $priorityArr = array(
+ 'notice' => 10,
+ 'status' => 20,
+ 'error' => 30,
+ 'fatal' => 100
+ );
+ if(!isset($type) || !isset($priorityArr[$type])) {
+ //set a default type.
+ $arrayKeys = array_keys();
+ $type = $arrayKeys[0];
+ }
+
+ if(strlen($linkURL)) {
+ if(!strlen($linkText) || is_null($linkText)) {
+ $linkText = "Link";
+ }
+ $redirectText = '<a href="'. $linkURL .'">'. $linkText .'</a>';
+ }
+
+ //Create the array.
+ $myArr = array(
+ "title" => $title,
+ "message" => $message,
+ "redirect" => $redirectText,
+ "type" => $type,
+ "priority" => $priority
+
+ );
+
+ //make sure the message type is IN the priority array...
+ if(!in_array($type, array_keys($priorityArr))) {
+ //invalid type.
+ $retval = FALSE;
+ } elseif($_SESSION['message']) {
+ //there's already a message... check if the new one should overwrite the existing.
+ if((!$overwriteSame) AND ($priorityArr[$_SESSION['message']['type']] == $priorityArr[$type])) {
+ //no overwriting.
+ $retval = FALSE;
+ } elseif($priorityArr[$_SESSION['message']['type']] <= $priorityArr[$type]) {
+ // the existing message is less important. Overwrite it.
+ $_SESSION['message'] = $myArr;
+ }
+ }
+ else {
+ $_SESSION['message'] = $myArr;
+ $retval = TRUE;
+ }
+
+ return($retval);
+
+ } // end of set_message()
+ //---------------------------------------------------------------------------------------------
+
+
+
+ //---------------------------------------------------------------------------------------------
+ public function set_message_wrapper($array) {
+ @$this->set_message(
+ $array['title'],
+ $array['message'],
+ $array['linkURL'],
+ $array['type'],
+ $array['linkText'],
+ $array['overwriteSame'],
+ $array['priority']
+ );
+ }//end set_message_wrapper()
+ //---------------------------------------------------------------------------------------------
+
+
+
+ //---------------------------------------------------------------------------------------------
+ /**
+ * Performs redirection, provided it is allowed.
+ */
+ function conditional_header($url, $exitAfter=TRUE) {
+ if($this->allowRedirect) {
+ //checks to see if headers were sent; if yes: use a meta redirect.
+ // if no: send header("location") info...
+ if(headers_sent()) {
+ //headers sent. Use the meta redirect.
+ print "
+ <HTML>
+ <HEAD>
+ <TITLE>Redirect Page</TITLE>
+ <META HTTP-EQUIV='refresh' content='0; URL=$url'>
+ </HEAD>
+ <a href=\"$url\"></a>
+ </HTML>
+ ";
+ }
+ else {
+ header("location:$url");
+ }
+
+ if($exitAfter) {
+ //redirecting without exitting is bad, m'kay?
+ exit;
+ }
+ }
+ else {
+ //TODO: should an exception be thrown, or maybe exit here anyway?
+ throw new exception(__METHOD__ .": auto redirects not allowed...?");
+ }
+ }//end conditional_header()
+ //---------------------------------------------------------------------------------------------
+
+
+ //---------------------------------------------------------------------------------------------
+ /**
+ * Given the name of a templateVar (defaults to "content"), this method will retrieve all block
+ * row definitions in the order that they can safely be ripped-out/set by set_block_row().
+ *
+ * @parm $templateVar (str,optional) templateVar to parse.
+ *
+ * @return (array) Contains all rows, complete & incomplete.
+ *
+ * NOTE: Layout of array:::
+ * array(
+ * incomplete => array(
+ * begin => array(),
+ * end => array()
+ * ),
+ * ordered => array()
+ * NOTE2: each "array()" above is a list of block row names.
+ * NOTE3: failure to parse the template will return a blank array.
+ *
+ *
+ */
+ function get_block_row_defs($templateVar="content") {
+ //cast $retArr as an array, so it's clean.
+ $retArr = array();
+
+ //NOTE: the value 31 isn't just a randomly chosen length; it's the minimum
+ // number of characters to have a block row. EG: "<!-- BEGIN x -->o<!-- END x -->"
+ $templateContents = $this->templateVars[$templateVar];
+ if(strlen($templateContents) >= 31) {
+ //looks good to me. Run the regex...
+ $flags = PREG_PATTERN_ORDER;
+ $reg = "/<!-- BEGIN (.+) -->/";
+ preg_match_all($reg, $templateContents, $beginArr, $flags);
+ $beginArr = $beginArr[1];
+
+ $endReg = "/<!-- END (.+) -->/";
+ preg_match_all($endReg, $templateContents, $endArr, $flags);
+ $endArr = $endArr[1];
+
+ //create a part of the array that shows any orphaned "BEGIN" statements (no matching "END"
+ // statement), and orphaned "END" statements (no matching "BEGIN" statements)
+ // NOTE::: by doing this, should easily be able to tell if the block rows were defined
+ // properly or not.
+ if(count($retArr['incomplete']['begin'] = array_diff($beginArr, $endArr)) > 0) {
+ //I'm sure there's an easier way to do this, but my head hurts too much when
+ // I try to do the magic. Maybe I need to put another level in CodeMancer...
+ foreach($retArr['incomplete']['begin'] as $num=>$val) {
+ unset($beginArr[$num]);
+ }
+ }
+ if(count($retArr['incomplete']['end'] = array_diff($endArr, $beginArr)) > 0) {
+ //both of the below foreach's simply pulls undefined vars out of the
+ // proper arrays, so I don't have to deal with them later.
+ foreach($retArr['incomplete']['end'] as $num=>$val) {
+ unset($endArr[$num]);
+ }
+ }
+
+ //YAY!!! we've got valid data!!!
+ //reverse the order of the array, so when the ordered array
+ // is looped through, all block rows can be pulled.
+ $retArr['ordered'] = array_reverse($beginArr);
+ } else {
+ //nothin' doin'. Return a blank array.
+ $retArr = array();
+ }
+
+ return($retArr);
+ }//end get_block_row_defs()
+ //---------------------------------------------------------------------------------------------
+
+
+
+ //---------------------------------------------------------------------------------------------
+ function rip_all_block_rows($templateVar="content", $exceptionArr=array()) {
+ $rowDefs = $this->get_block_row_defs($templateVar);
+
+ $useTheseBlockRows = $rowDefs['ordered'];
+ $retval = array();
+ if(is_array($useTheseBlockRows)) {
+ foreach($useTheseBlockRows as $blockRowName)
+ {
+ if(!in_array($blockRowName, $exceptionArr))
+ {
+ //remove the block row.
+ $rowData = $this->set_block_row($templateVar, $blockRowName);
+ $retval[$blockRowName] = $rowData;
+ }
+ }
+ }
+
+ return($retval);
+ }//end rip_all_block_rows()
+ //---------------------------------------------------------------------------------------------
+
+
+
+ //---------------------------------------------------------------------------------------------
+ public function set_all_block_rows($templateVar="content", $exceptionArr=array())
+ {
+ $retval = $this->rip_all_block_rows($templateVar, $exceptionArr);
+ return($retval);
+ }//end set_all_block_rows()
+ //---------------------------------------------------------------------------------------------
+
+
+
+ //---------------------------------------------------------------------------------------------
+ public function allow_invalid_urls($newSetting=NULL) {
+ if(!is_null($newSetting) && is_bool($newSetting)) {
+ $this->allowInvalidUrls = $newSetting;
+ }
+ return($this->allowInvalidUrls);
+ }//end allow_invalid_urls()
+ //---------------------------------------------------------------------------------------------
+
+}//end cs_genericPage{}
+?>
Property changes on: trunk/1.0/cs_genericPage.class.php
___________________________________________________________________
Added: svn:executable
+ *
Added: svn:keywords
+ HeadURL
Id
LastChangedBy
LastChangedDate
LastChangedRevision
Added: svn:mergeinfo
+
Added: svn:eol-style
+ native
Deleted: trunk/1.0/cs_genericPageClass.php
===================================================================
--- trunk/1.0/cs_genericPageClass.php 2009-01-29 21:04:18 UTC (rev 333)
+++ trunk/1.0/cs_genericPageClass.php 2009-01-29 21:15:20 UTC (rev 334)
@@ -1,619 +0,0 @@
-<?php
-/*
- * FILE INFORMATION:
- * $HeadURL$
- * $Id$
- * $LastChangedDate$
- * $LastChangedBy$
- * $LastChangedRevision$
- */
-require_once(dirname(__FILE__) ."/template.inc");
-require_once(dirname(__FILE__) ."/abstract/cs_content.abstract.class.php");
-
-class cs_genericPage extends cs_contentAbstract {
- var $templateObj; //template object to parse the pages
- var $templateVars = array(); //our copy of the global templateVars
- var $mainTemplate; //the default layout of the site
-
- private $tmplDir;
- private $libDir;
- private $siteRoot;
- private $allowRedirect;
-
- private $showEditableLink = FALSE;
-
- private $allowInvalidUrls=NULL;
-
- //---------------------------------------------------------------------------------------------
- /**
- * The constructor.
- */
- public function __construct($restrictedAccess=TRUE, $mainTemplateFile=NULL, $allowRedirect=TRUE) {
- //handle some configuration.
- $this->allowRedirect = $allowRedirect;
-
- //initialize stuff from our parent...
- parent::__construct();
-
- //initialize some internal stuff.
- $this->initialize_locals($mainTemplateFile);
-
- //if they need to be logged-in...
- $this->check_login($restrictedAccess);
-
- if(!defined('CS-CONTENT_SESSION_NAME')) {
- define("CS-CONTENT_SESSION_NAME", ini_get('session.name'));
- }
-
- //TODO: if the end page doesn't want to allow the "edit" links, will this still work?
- if(defined("CS_CONTENT_MODIFIABLE") && constant("CS_CONTENT_MODIFIABLE") === TRUE) {
- $this->showEditableLink = TRUE;
- }
- }//end __construct()
- //---------------------------------------------------------------------------------------------
-
-
-
- //---------------------------------------------------------------------------------------------
- /**
- * Initializes some internal objects, variables, and so on.
- */
- protected function initialize_locals($mainTemplateFile) {
-
- //NOTE: this **requires** that the global variable "SITE_ROOT" is already set.
- $this->siteRoot = preg_replace('/\/public_html/', '', $_SERVER['DOCUMENT_ROOT']);
- $this->tmplDir = $this->siteRoot .'/templates';
- $this->libDir = $this->siteRoot .'/lib';
-
- //if there have been some global template vars (or files) set, read 'em in here.
- if(is_array($GLOBALS['templateVars']) && count($GLOBALS['templateVars'])) {
- foreach($GLOBALS['templateVars'] as $key=>$value) {
- $this->add_template_var($key, $value);
- }
- }
- if(isset($GLOBALS['templateFiles']) && is_array($GLOBALS['templateFiles'])) {
- foreach($GLOBALS['templateFiles'] as $key => $value) {
- $this->templateFiles[$key] = $value;
- }
- }
- unset($GLOBALS['templateVars'], $GLOBALS['templateFiles']);
-
- //build a new instance of the template library (from PHPLib)
- $this->templateObj=new Template($this->tmplDir,"keep"); //initialize a new template parser
-
- if(preg_match('/^\//', $mainTemplateFile)) {
- $mainTemplateFile = $this->tmplDir ."/". $mainTemplateFile;
- }
- $this->mainTemplate=$mainTemplateFile; //load the default layout
- }//end initialize_locals()
- //---------------------------------------------------------------------------------------------
-
-
-
- //---------------------------------------------------------------------------------------------
- /**
- * Should just check to see if they've authenticated. In reality, this
- * just performs blind redirection if $restrictedAccess is set (and if
- * redirecting is allowed).
- */
- public function check_login($restrictedAccess) {
- if($restrictedAccess) {
- $myUri = $_SERVER['SCRIPT_NAME'];
- $doNotRedirectArr = array('/login.php', '/admin/login.php', '/index.php', '/admin.php',
- '/content', '/content/index.php'
- );
- $myUrlString="";
- $myGetArr = $_GET;
- if(is_array($myGetArr) && count($myGetArr) > 0) {
- unset($myGetArr['PHPSESSID']);
- unset($myGetArr[CS-CONTENT_SESSION_NAME]);
- $myUrlString = string_from_array($myGetArr, NULL, 'url');
- }
-
- //TODO: make the redirectHere variable dynamic--an argument, methinks.
- $redirectHere = '/login.php?destination='. $myUrlString;
-
- //Not exitting after conditional_header() is... bad, m'kay?
- $this->conditional_header($redirectHere, TRUE);
- exit;
- }
- }//end check_login()
- //---------------------------------------------------------------------------------------------
-
-
-
- //---------------------------------------------------------------------------------------------
- /**
- * Remove all data from the special template var "content" (or optionally another ver).
- *
- * @param $section (str,optional) defines what template var to wip-out.
- * @return (NULL)
- */
- public function clear_content($section="content"){
- $this->change_content(" ",$section);
- }//end clear_content()
- //---------------------------------------------------------------------------------------------
-
-
-
- //---------------------------------------------------------------------------------------------
- /**
- * Change the content of a template to the given data.
- *
- * @param $htmlString (str) data to use.
- * @param $section (str,optional) define a different section.
- *
- * @return (NULL)
- */
- public function change_content($htmlString,$section="content"){
- $this->templateVars[$section] = $htmlString;
- }//end change_content()
- //---------------------------------------------------------------------------------------------
-
-
-
- //---------------------------------------------------------------------------------------------
- /**
- * Adds a template file (with the given handle) to be parsed.
- *
- * TODO: check if $fileName exists before blindly trying to parse it.
- */
- public function add_template_file($handleName, $fileName){
- if($this->showEditableLink) {
- $prefix = '[<a href="#NULL_page='. $fileName .'"><font color="red"><b>Edit "'. $handleName .'"</b></font></a>]<BR>';
- $this->add_template_var($handleName, $prefix .$this->file_to_string($fileName));
- }
- else {
- $this->add_template_var($handleName, $this->file_to_string($fileName));
- }
- }//end add_template_file()
- //---------------------------------------------------------------------------------------------
-
-
-
- //---------------------------------------------------------------------------------------------
- /**
- * Adds a value for a template placeholder.
- */
- public function add_template_var($varName, $varValue){
- $this->templateVars[$varName]=$varValue;
- }//end add_template_var();
- //---------------------------------------------------------------------------------------------
-
-
-
- //---------------------------------------------------------------------------------------------
- /**
- * Rips the given block row name from the parent templateVar, (optionally) replacing it with
- * a template var of the same name.
- *
- * @param $parent (str) name of the templateVar to pull the block row from.
- * @param $handle (str) name of the block row to rip from it's parent.
- * @param $removeDefs (bool,optional) if evaluated as FALSE, no template var is left in
- * place of the block row.
- *
- * @return (bool false) FAIL: unable to find block row.
- * @return (str) PASS: content of the block row.
- */
- public function set_block_row($parent, $handle, $removeDefs=0) {
- $name = $handle;
- $str = $this->templateVars[$parent];
-
- $reg = "/<!-- BEGIN $handle -->.+<!-- END $handle -->/sU";
- preg_match_all($reg, $str, $m);
- if(!is_string($m[0][0])) {
- #exit("set_block_row(): couldn't find '$handle' in var '$parent'");
- $retval = FALSE;
- } else {
- if($removeDefs) {
- $openHandle = "<!-- BEGIN $handle -->";
- $endHandle = "<!-- END $handle -->";
- $m[0][0] = str_replace($openHandle, "", $m[0][0]);
- $m[0][0] = str_replace($endHandle, "", $m[0][0]);
- }
-
- $str = preg_replace($reg, "{" . "$name}", $str);
- $this->templateVars[$parent] = $str;
- $this->templateRows[$name] = $m[0][0];
- $this->add_template_var($name, "");
- $retval = $m[0][0];
- }
- return($retval);
- }//end set_block_row()
- //---------------------------------------------------------------------------------------------
-
-
-
- //---------------------------------------------------------------------------------------------
- /**
- * Using the given template, it will replace each index (in $repArr) with it's value: each
- * var to be replaced must begin the given begin & end delimiters.
- *
- * @param $template (str) Data to perform the replacements on.
- * @param $repArr (array) Array of name=>value pairs, where name is to be replaced with value.
- * @param $b (str,optional) beginning delimiter.
- * @param $e (str,optional) ending delimiter.
- */
- public function mini_parser($template, $repArr, $b='%%', $e='%%') {
- return($this->gfObj->mini_parser($template, $repArr, $b, $e));
- }//end mini_parser()
- //---------------------------------------------------------------------------------------------
-
-
-
- //---------------------------------------------------------------------------------------------
- /**
- * Processes all template vars & files, etc, to produce the final page. NOTE: it is a wise idea
- * for most pages to have this called *last*.
- *
- * @param $stripUndefVars (bool,optional) Remove all undefined template vars.
- *
- * @return (str) Final, parsed page.
- */
- public function print_page($stripUndefVars=1) {
- //Show any available messages.
- $this->process_set_message();
-
- //Load the default page layout.
- $this->templateObj->set_file("main", $this->mainTemplate);
-
- //load the placeholder names and thier values
- $this->templateObj->set_var($this->templateVars);
- $this->templateObj->parse("out","main"); //parse the sub-files into the main page
-
- if($stripUndefVars) {
- $numLoops = 0;
- while(preg_match_all('/\{.\S+?\}/', $this->templateObj->varvals['out'], $tags) && $numLoops < 50) {
- $tags = $tags[0];
-
- //TODO: figure out why this works when running it twice.
- foreach($tags as $key=>$str) {
- $str2 = str_replace("{", "", $str);
- $str2 = str_replace("}", "", $str2);
- if(!$this->templateVars[$str2] && $stripUndefVars) {
- //TODO: set an internal pointer or something to use here, so they can see what was missed.
- $this->templateObj->varvals[out] = str_replace($str, '', $this->templateObj->varvals[out]);
- }
- }
- $this->templateObj->parse("out", "out");
- $numLoops++;
- }
- }
- $this->templateObj->pparse("out","out"); //parse the main page
-
- }//end of print_page()
- //---------------------------------------------------------------------------------------------
-
-
-
- //---------------------------------------------------------------------------------------------
- /**
- * Handles a message that was set into the session.
- */
- public function process_set_message() {
- //if there's not a message set, skip.
- $errorBox = "";
- if(isset($_SESSION['message']) && is_array($_SESSION['message'])) {
- $errorBox = $this->file_to_string("system/message_box.tmpl");
- //let's make sure the "type" value is *lowercase*.
- $_SESSION['message']['type'] = strtolower($_SESSION['message']['type']);
-
- //WARNING::: if you give it the wrong type, it'll STILL be parsed. Otherwise
- // this has to match set_message() FAR too closely. And it's a pain.
- $_SESSION['message']['messageType'] = $_SESSION['message']['type'];
- $errorBox = $this->gfObj->mini_parser($errorBox, $_SESSION['message'], '{', '}');
- if($_SESSION['message']['type'] == "fatal") {
- //replace content of the page with our error.
- $this->change_content($errorBox);
- } else {
- //Non-fatal: put it into a template var.
- $this->add_template_var("error_msg", $errorBox);
- }
-
- //now that we're done displaying the message, let's get it out of the session (otherwise
- // they'll never get past this point).
- unset($_SESSION['message']);
- }
- return($errorBox);
- }//end of process_set_message()
- //---------------------------------------------------------------------------------------------
-
-
-
- //---------------------------------------------------------------------------------------------
- /**
- * Takes a template file, whose root must be within $GLOBALS['TMPLDIR'], pulls it's
- * content & returns it.
- */
- public function file_to_string($templateFileName) {
- $templateFileName = preg_replace('/\/\//', '\/', $templateFileName);
- if($this->template_file_exists($templateFileName)) {
- $retval = file_get_contents($this->tmplDir .'/'. $templateFileName);
- } else {
- $this->set_message_wrapper(array(
- "title" => 'Template File Error',
- "message" => 'Not all templates could be found for this page.',
- "type" => 'error'
- ));
- }
- return($retval);
- }//end file_to_string()
- //---------------------------------------------------------------------------------------------
-
-
-
- //---------------------------------------------------------------------------------------------
- /**
- * Checks to see if the given filename exists within the template directory.
- */
- public function template_file_exists($file) {
- $retval = 0;
- //If the string doesn't start with a /, add one
- if (strncmp("/",$file,1)) {
- //strncmp returns 0 if they match, so we're putting a / on if they don't
- $file="/".$file;
- }
- $filename=$this->tmplDir.$file;
-
- if(file_exists($filename)) {
- $retval = $filename;
- }
- return($retval);
- }//end template_file_exists()
- //---------------------------------------------------------------------------------------------
-
-
-
- //---------------------------------------------------------------------------------------------
- /**
- * Creates an array in the session, used by the templating system as a way to
- * get messages generated by the code into the page, without having to add
- * special templates & such each time.
- *
- * @param $title (str) the title of the message.
- * @param $message (str) text beneath the title.
- * @param $linkURL (str,optional) URL for the link below the message.
- * @param $type (str) notice/status/error/fatal message, indicating
- * it's importance. Generally, fatal messages
- * cause only the message to be shown.
- * @param $linkText (str,optional) text that the link wraps.
- * @param $overwriteSame (bool,optional) whether setting a message which has
- * the same type as an already set message will
- * overwite the previous. More important messages
- * always overwrite lesser ones.
- * @param $priority (int,optional) specify the message's priority.
- *
- * @return (bool) Indicates pass (true)/fail (false)
- */
- function set_message($title=NULL, $message=NULL, $linkURL=NULL, $type=NULL, $linkText=NULL, $overwriteSame=NULL, $priority=NULL) {
- if(!isset($overwriteSame)) {
- $overwriteSame = 1;
- }
-
- //defines the importance level of each type of message: the higher the value, the more important it is.
- $priorityArr = array(
- 'notice' => 10,
- 'status' => 20,
- 'error' => 30,
- 'fatal' => 100
- );
- if(!isset($type) || !isset($priorityArr[$type])) {
- //set a default type.
- $arrayKeys = array_keys();
- $type = $arrayKeys[0];
- }
-
- if(strlen($linkURL)) {
- if(!strlen($linkText) || is_null($linkText)) {
- $linkText = "Link";
- }
- $redirectText = '<a href="'. $linkURL .'">'. $linkText .'</a>';
- }
-
- //Create the array.
- $myArr = array(
- "title" => $title,
- "message" => $message,
- "redirect" => $redirectText,
- "type" => $type,
- "priority" => $priority
-
- );
-
- //make sure the message type is IN the priority array...
- if(!in_array($type, array_keys($priorityArr))) {
- //invalid type.
- $retval = FALSE;
- } elseif($_SESSION['message']) {
- //there's already a message... check if the new one should overwrite the existing.
- if((!$overwriteSame) AND ($priorityArr[$_SESSION['message']['type']] == $priorityArr[$type])) {
- //no overwriting.
- $retval = FALSE;
- } elseif($priorityArr[$_SESSION['message']['type']] <= $priorityArr[$type]) {
- // the existing message is less important. Overwrite it.
- $_SESSION['message'] = $myArr;
- }
- }
- else {
- $_SESSION['message'] = $myArr;
- $retval = TRUE;
- }
-
- return($retval);
-
- } // end of set_message()
- //---------------------------------------------------------------------------------------------
-
-
-
- //---------------------------------------------------------------------------------------------
- public function set_message_wrapper($array) {
- @$this->set_message(
- $array['title'],
- $array['message'],
- $array['linkURL'],
- $array['type'],
- $array['linkText'],
- $array['overwriteSame'],
- $array['priority']
- );
- }//end set_message_wrapper()
- //---------------------------------------------------------------------------------------------
-
-
-
- //---------------------------------------------------------------------------------------------
- /**
- * Performs redirection, provided it is allowed.
- */
- function conditional_header($url, $exitAfter=TRUE) {
- if($this->allowRedirect) {
- //checks to see if headers were sent; if yes: use a meta redirect.
- // if no: send header("location") info...
- if(headers_sent()) {
- //headers sent. Use the meta redirect.
- print "
- <HTML>
- <HEAD>
- <TITLE>Redirect Page</TITLE>
- <META HTTP-EQUIV='refresh' content='0; URL=$url'>
- </HEAD>
- <a href=\"$url\"></a>
- </HTML>
- ";
- }
- else {
- header("location:$url");
- }
-
- if($exitAfter) {
- //redirecting without exitting is bad, m'kay?
- exit;
- }
- }
- else {
- //TODO: should an exception be thrown, or maybe exit here anyway?
- throw new exception(__METHOD__ .": auto redirects not allowed...?");
- }
- }//end conditional_header()
- //---------------------------------------------------------------------------------------------
-
-
- //---------------------------------------------------------------------------------------------
- /**
- * Given the name of a templateVar (defaults to "content"), this method will retrieve all block
- * row definitions in the order that they can safely be ripped-out/set by set_block_row().
- *
- * @parm $templateVar (str,optional) templateVar to parse.
- *
- * @return (array) Contains all rows, complete & incomplete.
- *
- * NOTE: Layout of array:::
- * array(
- * incomplete => array(
- * begin => array(),
- * end => array()
- * ),
- * ordered => array()
- * NOTE2: each "array()" above is a list of block row names.
- * NOTE3: failure to parse the template will return a blank array.
- *
- *
- */
- function get_block_row_defs($templateVar="content") {
- //cast $retArr as an array, so it's clean.
- $retArr = array();
-
- //NOTE: the value 31 isn't just a randomly chosen length; it's the minimum
- // number of characters to have a block row. EG: "<!-- BEGIN x -->o<!-- END x -->"
- $templateContents = $this->templateVars[$templateVar];
- if(strlen($templateContents) >= 31) {
- //looks good to me. Run the regex...
- $flags = PREG_PATTERN_ORDER;
- $reg = "/<!-- BEGIN (.+) -->/";
- preg_match_all($reg, $templateContents, $beginArr, $flags);
- $beginArr = $beginArr[1];
-
- $endReg = "/<!-- END (.+) -->/";
- preg_match_all($endReg, $templateContents, $endArr, $flags);
- $endArr = $endArr[1];
-
- //create a part of the array that shows any orphaned "BEGIN" statements (no matching "END"
- // statement), and orphaned "END" statements (no matching "BEGIN" statements)
- // NOTE::: by doing this, should easily be able to tell if the block rows were defined
- // properly or not.
- if(count($retArr['incomplete']['begin'] = array_diff($beginArr, $endArr)) > 0) {
- //I'm sure there's an easier way to do this, but my head hurts too much when
- // I try to do the magic. Maybe I need to put another level in CodeMancer...
- foreach($retArr['incomplete']['begin'] as $num=>$val) {
- unset($beginArr[$num]);
- }
- }
- if(count($retArr['incomplete']['end'] = array_diff($endArr, $beginArr)) > 0) {
- //both of the below foreach's simply pulls undefined vars out of the
- // proper arrays, so I don't have to deal with them later.
- foreach($retArr['incomplete']['end'] as $num=>$val) {
- unset($endArr[$num]);
- }
- }
-
- //YAY!!! we've got valid data!!!
- //reverse the order of the array, so when the ordered array
- // is looped through, all block rows can be pulled.
- $retArr['ordered'] = array_reverse($beginArr);
- } else {
- //nothin' doin'. Return a blank array.
- $retArr = array();
- }
-
- return($retArr);
- }//end get_block_row_defs()
- //---------------------------------------------------------------------------------------------
-
-
-
- //---------------------------------------------------------------------------------------------
- function rip_all_block_rows($templateVar="content", $exceptionArr=array()) {
- $rowDefs = $this->get_block_row_defs($templateVar);
-
- $useTheseBlockRows = $rowDefs['ordered'];
- $retval = array();
- if(is_array($useTheseBlockRows)) {
- foreach($useTheseBlockRows as $blockRowName)
- {
- if(!in_array($blockRowName, $exceptionArr))
- {
- //remove the block row.
- $rowData = $this->set_block_row($templateVar, $blockRowName);
- $retval[$blockRowName] = $rowData;
- }
- }
- }
-
- return($retval);
- }//end rip_all_block_rows()
- //---------------------------------------------------------------------------------------------
-
-
-
- //---------------------------------------------------------------------------------------------
- public function set_all_block_rows($templateVar="content", $exceptionArr=array())
- {
- $retval = $this->rip_all_block_rows($templateVar, $exceptionArr);
- return($retval);
- }//end set_all_block_rows()
- //---------------------------------------------------------------------------------------------
-
-
-
- //---------------------------------------------------------------------------------------------
- public function allow_invalid_urls($newSetting=NULL) {
- if(!is_null($newSetting) && is_bool($newSetting)) {
- $this->allowInvalidUrls = $newSetting;
- }
- return($this->allowInvalidUrls);
- }//end allow_invalid_urls()
- //---------------------------------------------------------------------------------------------
-
-}//end cs_genericPage{}
-?>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
