2 /* vim: set expandtab tabstop=4 shiftwidth=4: */
3 // +----------------------------------------------------------------------+
5 // +----------------------------------------------------------------------+
6 // | Copyright (c) 1997-2002 The PHP Group |
7 // +----------------------------------------------------------------------+
8 // | This source file is subject to version 2.02 of the PHP license, |
9 // | that is bundled with this package in the file LICENSE, and is |
10 // | available at through the world-wide-web at |
11 // | http://www.php.net/license/2_02.txt. |
12 // | If you did not receive a copy of the PHP license and are unable to |
13 // | obtain it through the world-wide-web, please send a note to |
14 // | license@php.net so we can mail you a copy immediately. |
15 // +----------------------------------------------------------------------+
16 // | Authors: Alan Knowles <alan@akbkhome.com> |
17 // +----------------------------------------------------------------------+
19 // $Id: Page.php,v 1.5 2003/02/22 01:52:50 alan Exp $
21 // A Base Page Class for use with HTML_Template_Flexy
22 // You could write one of these which used another template engine.
26 require_once 'HTML/Template/Flexy.php' ;
27 require_once 'HTML/Template/Flexy/Factory.php' ;
30 * The Base Page class - extend and override the methods to implement your own pages.
36 class HTML_FlexyFramework_Page {
40 * the main Template name (which can include a body template)
42 * @var string template name
45 var $masterTemplate = "master.html";
47 * the body Template name
49 * @var string template name
52 var $template = "error.html";
59 * can be 'output', or 'data'
60 * used to set a default caching method
66 var $cacheMethod = '';
72 * cache store (PEAR's Cache Object Instance
73 * initialized at start
74 * set at output stage.
83 /* ---- Variables set by Page loader -------- */
88 * baseURL, that can be prefixed to URL's to ensure that they correctly relate to application
89 * (set by page loader)
95 * rootURL, the base installation directory - can be used to get images directories.
96 * (set by page loader)
102 * rootDir, the base installation directory - can be used to find relative files.
103 * (set by page loader)
109 * the full request string used by the getCacheID().
110 * (set by page loader)
114 var $request; // clean page request for page
116 * overrides for elements.
121 var $elements = array(); // key=>HTML_Template_Flexy_Element
124 * errors for elements
129 var $errors = array(); // key(element name)=>error message
133 * is the page being run from the command line?
140 * Arguments from cli if static $cli_opts is used.
145 var $cli_args = array(); // key(element name)=>error message
148 * Reference to the page loader
149 * @var type HTML_FlexyFramework -
153 var $bootLoader = false;
158 * The default page handler
159 * by default relays to get(), or post() methods depending on the request.
161 * Override this if you do not handle get or post differently.
164 * @param string request, the remainder of the request not handled by the object.
166 * @return none|string none = handled, string = redirect to another page = eg. data/list
170 function start($request,$isRedirect=false,$args=array())
172 $cli= HTML_Flexyframework::get()->cli;
173 if (!$cli && !$isRedirect && !empty($_SERVER["REQUEST_METHOD"]) && $_SERVER["REQUEST_METHOD"] == "POST") {
174 return $this->post($request,$args);
176 return $this->get($request,$args,$isRedirect);
180 * The get page handler
182 * Override this if you want to handle get requests
185 * @param string request, the remainder of the request not handled by the object.
187 * @return none|string none = handled, string = redirect to another page = eg. data/list
190 function get($request)
194 * The post page handler
196 * Override this if you want to handle get requests
199 * @param string request, the remainder of the request not handled by the object.
201 * @return none|string none = handled, string = redirect to another page = eg. data/list
204 function post($request)
208 * Authentication Check method
209 * Override this with a straight return for pages that do not require authentication
212 * a) redirects to login if authenticaiton fails
213 * b) checks to see if a isAdmin method exists on the auth object
214 * if it does see if the user is admin and let them in.
215 * otherwise access denied error is raised
220 * @return none or string redirection to another page.
235 * The master Output layer.
237 * compiles the template
238 * if no caching - just runs the template.
239 * otherwise stores it in the cache.
241 * you dont normally need to override this.
243 * called by the page loader.
252 if (!empty($this->cli)) {
256 /* output the body if no masterTemplate is set */
257 $options = HTML_FlexyFramework::get();
259 $type = isset($this->contentType) ? $this->contentType : 'text/html';
260 header('Content-Type: '.$type.';charset='.( empty($options->charset) ? 'UTF-8' : $options->charset ));
263 if (!$this->masterTemplate) {
264 return $this->outputBody();
266 /* master template */
269 $template_engine = new HTML_Template_Flexy();
270 $template_engine->compile($this->masterTemplate);
271 if (!$this->_cache || !$this->cacheMethod) {
272 $template_engine->outputObject($this,$this->elements);
276 $id = $this->_cache->generateID($this->getID());
277 $this->_cache->save($id, $template_engine->bufferedOutputObject($this,$this->elements));
278 echo $this->_cache->get($id);
282 * The body Output layer.
284 * compiles the template
285 * At present there is no caching in here.. - this may change latter..
287 * used by putting {outputBody} in the main template.
290 function outputBody() {
292 $template_engine = new HTML_Template_Flexy();
293 $template_engine->compile($this->template);
294 if ($this->elements) { /* BC crap! */
295 $this->elements = HTML_Template_Flexy_Factory::setErrors($this->elements,$this->errors);
297 $template_engine->elements = $this->elements;
298 $template_engine->outputObject($this,$this->elements);
304 * Do any Page Caching if $this->cacheMethod is set.
305 * You should also look at output caching by overriding the outputBody Method.
307 * Note that Caching is disabled in a number of situations.
308 * a) cacheMethod is empty
310 * c) if sess is set (Eg. if you are using sessions)
311 * d) useCache is not set in the [Cache] section of the config.
313 * utilizes $this->getCacheID() to
315 * @return none|boolean|string|int|object Description
316 * @access public|private
317 * @see see also methods.....
321 function getCache() {
322 if (!$this->cacheMethod) {
325 if ($_SERVER["REQUEST_METHOD"] == "POST") {
329 /* lets assume we can cache ourselves.. */
330 $coptions = PEAR::getStaticProperty('Cache','options');
334 if (empty($coptions['useCache'])) {
337 require_once 'Cache.php';
339 $this->_cache = new Cache($coptions['container'], $coptions);
340 $id = $this->_cache->generateID($this->getCacheID());
341 if ($_SERVER["REQUEST_METHOD"] == "POST") {
342 $this->_cache->flush($id);
345 if ($data = $this->_cache->get($id)) {
353 * Get a distinct Page Cache ID.
355 * By default this is the full request string
356 * override this to define a more precise string
358 * @return string distinct page id (eg. the request url)
362 function getCacheID() {
363 return $this->request;
369 * Utility method : get the Class name (used on templates)
371 * @return string class name
376 function getClass() {
377 return get_class($this);
380 * Utility method : get the Time taken to generate the page.
382 * @return string time in seconds..
388 $m = explode(' ',microtime());
389 $ff = HTML_FlexyFramework::get();
390 return sprintf('%0.2fs',($m[0] + $m[1]) - $ff->start)
391 . '/ Files ' . count(get_included_files());
396 * turn on off session - wrap long database queries or
397 * data processing with this to prevent locking
399 * @param int $state new session state - 0 = off, 1 = on
402 function sessionState($state)
404 static $ses_status = false;
407 if (!empty($_SERVER['PHP_AUTH_USER'])) {
408 // do not do sessions if we are using http auth.
412 // session status is only php5.4 and up..
413 if (!defined('PHP_SESSION_ACTIVE')) {
414 define('PHP_SESSION_ACTIVE' , 1);
416 if(!function_exists('session_status')){
419 $ses_status = ($ses_status === false) ? session_status() : $ses_status;
421 if (PHP_SESSION_ACTIVE != $ses_status) {
427 session_write_close();
431 ini_set('session.use_only_cookies', false);
432 ini_set('session.use_cookies', false);
433 ini_set('session.use_trans_sid', false);
434 ini_set('session.cache_limiter', null);
437 // sometimes raises a notice - ps_files_cleanup_dir.
439 $this->dedupeSessionCookies();
444 function dedupeSessionCookies()
446 if (headers_sent()) {
451 foreach (headers_list() as $header) {
452 // Identify cookie headers
453 if (strpos($header, 'Set-Cookie:') === 0) {
454 $cookies[] = $header;
457 header_remove('Set-Cookie');
459 // Restore one copy of each cookie
460 foreach(array_unique($cookies) as $cookie) {
461 header($cookie, false);