File Source for LPageService.php

<?php
/**
* class file.
*
* @license http://opensource.org/licenses/mozilla1.1.php Mozilla Public License
* @copyright 2005, diemeisterei GmbH. All rights reserved.
* @author $Author: schmunk $
* @version $Revision: 636 $ $Date: 2007-02-25 14:01:09 +0100 (So, 25 Feb 2007) $
* @package Phundament.Packages
* @subpackage LVirtualNodes
*/
/**
* Extended page service.
*
* This service is able to use propel node tree objects from a database
* (l_virtual_nodes). You can request a node with a predefined NODE_PREFIX the node
* maps to a .page or and external link.
*
* @package System.Web.Services
* @subpackage Services
*/
Prado :: setPathOfAlias("LPageService", dirname(__FILE__));
if (is_dir(dirname(__FILE__) . "/db/propel"))
{
Prado :: using("LPageService.db.propel.*");
Prado :: using("LPageService.db.propel.l_virtual_nodes.*");
}
class LPageService extends TPageService
{
const NODE_PREFIX= '*';
const PATH_PREFIX= '§';
private $_nodes;
private $_nodes_list;
private $_currentNode = null;
private $_currentNodeId = 0;
private $_currentNodeAlias = null;
private $_areNodesAvailable;
/**
* Returns if node-based service is available
*/
public function areNodesAvailable()
{
if ($this->Application->getGlobalState("LVirtualNodes:available") !== true)
{
$this->checkVirtualNodes();
$this->Application->setGlobalState("LVirtualNodes:available", $this->_areNodesAvailable);
}
else
{
$this->_areNodesAvailable= $this->Application->getGlobalState("LVirtualNodes:available");
}
return $this->_areNodesAvailable;
}
/**
* Returns all nodes in tree structure starting from root
*/
function getNodes()
{
if (!is_object($this->_nodes))
{
$this->prepareNodes();
}
return $this->_nodes;
}
/**
* Returns all nodes in list structure
*/
function getNodesList()
{
if (!is_object($this->_nodes_list))
{
$this->prepareNodes();
}
return $this->_nodes_list;
}
/**
* Returns the current node object
*/
function getCurrentNode()
{
if ($this->_currentNodeId == 0 || $this->_currentNode !== null)
return $this->_currentNode;
$this->_currentNode = $this->findNodeById($this->getNodes(), $this->_currentNodeId);
return $this->_currentNode;
}
/**
* Returns the current node object
*/
function getPageName()
{
if (!is_object($this->getCurrentNode()))
return $this->getServicePage();
$string= ($this->getCurrentNode()->getDescriptiveName()) ? $this->getCurrentNode()->getDescriptiveName() : $this->getCurrentNode()->getAlias();
return $string;
}
/**
* return current selected page for this service
*/
public function getServicePage($return_node_alias= false)
{
if (!$this->_currentNodeAlias && !$this->_currentNodeId)
{
// static page
$p = $this->getRequest()->getServiceParameter();
return (empty ($p)) ? $this->getDefaultPage() : $p;
}
else if ($return_node_alias)
return $this->_currentNodeAlias;
else
return self :: NODE_PREFIX . $this->_currentNodeId;
}
/**
* Reads MasterConfig
*/
public function init($config)
{
parent :: init($config);
}
/**
* Checks availablity of node service
*/
private function checkVirtualNodes()
{
try
{
$conn= $this->Application->getModule("database")->getConnection("l_virtual_nodes", "propel");
$query= "SELECT id FROM l_virtual_nodes_site LIMIT 1";
$result= LCreole :: doQuery($query, $conn); // Propel-like object (getter & setter)
#var_dump($result[0]);
$this->_areNodesAvailable= true;
Prado :: trace("Virtual Nodes available", 'Lithron.LPageService');
}
catch (Exception $e)
{
Prado :: log($e->getMessage(), 4, 'Lithron.LPageService');
$this->_areNodesAvailable= false;
}
}
/**
* Queries all nodes in database and serves them for later use
*/
private function prepareNodes()
{
// query nodes if not in cache
if (!is_object($this->_nodes))
{
$conn= $this->Application->getModule("database")->getConnection("l_virtual_nodes", "propel");
$this->_nodes= LVirtualNodesSiteNodePeer :: retrieveRootNode(true, $conn);
$fc= new Criteria;
$fc->addAnd(LVirtualNodesSitePeer :: ID, 1, Criteria :: NOT_EQUAL);
$fc->addAscendingOrderByColumn(LVirtualNodesSitePeer :: PATH);
$this->_nodes_list= LVirtualNodesSitePeer :: doSelect($fc);
Prado :: trace("Nodes prepared ...", 'Lithron.LPageService');
}
}
public function getNodeById($id)
{
if (substr($id, 0, 1) == self :: NODE_PREFIX)
{
$id= str_replace(self :: NODE_PREFIX, "", $id);
return $this->findNodeById($this->getNodes(), $id);
}
elseif (is_numeric($id))
{
return $this->findNodeById($this->getNodes(), $id);
}
else
{
return $this->findNodeByAlias($this->getNodes(), $id);
}
}
/**
* Finds a node in the tree by id
*/
private function findNodeById($startNode, $searchId)
{
if ($startNode->getId() == $searchId)
return $startNode;
$child= $startNode->getFirstChildNode();
while ($child)
{
$nodeId= $child->getId();
if ($nodeId == $searchId)
{
return $child;
}
$return= $this->findNodeById($child, $searchId);
if ($return)
return $return;
$child= $child->getSiblingNode();
}
}
/**
* Finds a node in the tree by alias
*/
private function findNodeByAlias($startNode, $searchAlias)
{
#echo $startNode->getAlias()."=$searchAlias | ";
if ($startNode->getAlias() == $searchAlias)
return $startNode;
$child= $startNode->getFirstChildNode();
while ($child)
{
$alias= $child->getAlias();
if ($alias == $searchAlias)
{
return $child;
}
$return= $this->findNodeByAlias($child, $searchAlias);
if ($return)
return $return;
$child= $child->getSiblingNode();
}
}
/**
* Determines the requested page path.
* 1. nodeId (database needed)
* 2. path (database needed)
* 3. page
* @return string page path requested
*/
protected function determineRequestedPagePath()
{
Prado :: log("Determining requested PagePath", 1, 'Lithron.LPageService');
$param = $this->getRequest()->getServiceParameter();
$cache = $this->Application->Cache;
$cache = null;
// default page
if (empty ($param))
{
$param = $this->getDefaultPage();
Prado :: log("default page requested ($param)", 1, 'Lithron.LPageService');
}
// static page
$static_page_file = Prado :: getPathOfAlias("Pages") . "/" . str_replace(".", "/", $param) . ".page";
if (file_exists($static_page_file))
{
$pagePath = $param;
Prado :: log("static page found ($pagePath)", 1, 'Lithron.LPageService');
return $pagePath;
}
// check specials
$special = $param[0];
$suffix = substr($param, 1);
switch($special)
{
case self::NODE_PREFIX:
if (!is_numeric($suffix))
throw new Exception("no valid id given!");
$this->_currentNodeId = TPropertyValue::ensureInteger($suffix);
$cache_entry_path = "LVirtualNodes:PathForNodeId:" . $suffix;
$cache_entry_alias = "LVirtualNodes:AliasForNodeId:" . $suffix;
if ($cache && $cache->get($cache_entry_path) && $cache->get($cache_entry_alias))
{
$pagePath = $cache->get($cache_entry_path);
$this->_currentNodeAlias = $cache->get($cache_entry_alias);
Prado :: log("node by id ($suffix) found in cache ($pagePath)", 1, 'Lithron.LPageService');
return $pagePath;
}
$current_node = $this->findNodeById($this->getNodes(), $suffix);
if (!$current_node)
throw new Exception("node with id $suffix not found!");
$pagePath = $current_node->getPage();
$this->_currentNodeAlias = $current_node->getAlias();
if ($cache)
{
$cache->set($cache_entry_path, $pagePath);
$cache->set($cache_entry_alias, $this->_currentNodeAlias);
}
Prado :: log("node by id ($suffix) found in database and saved to cache ($pagePath)", 1, 'Lithron.LPageService');
return $pagePath;
}
// check alias
$cache_entry_path = "LVirtualNodes:PathForNodeAlias:" . $param;
$cache_entry_id = "LVirtualNodes:IdForNodeAlias:" . $param;
$this->_currentNodeAlias = $param;
if ($cache && $cache->get($cache_entry_path) && $cache->get($cache_entry_id))
{
$pagePath = $cache->get($cache_entry_path);
$this->_currentNodeId = $cache->get($cache_entry_id);
Prado :: log("node by alias ($param) found in cache ($pagePath)", 1, 'Lithron.LPageService');
return $pagePath;
}
$current_node = $this->findNodeByAlias($this->getNodes(), $param);
if ($current_node)
{
$pagePath = $current_node->getPage();
$this->_currentNodeId = $current_node->getId();
if ($cache)
{
$cache->set($cache_entry_path, $pagePath);
$cache->set($cache_entry_id, $this->_currentNodeId);
}
Prado :: log("node by alias ($param) found in database and saved to cache ($pagePath)", 1, 'Lithron.LPageService');
return $pagePath;
}
// when we come here, the requested page is no
// A) static page
// B) node page by id
// C) node page by alias
// we could fall back to prado here, but I will rather throw an exception,
// because it's pretty sure Prado can't serve anything else.
throw new THttpException(404,'pageservice_page_unknown', $param);
$pagePath = $param;
Prado :: log("unknown pagetype - falling back to PRADO ($pagePath)", 1, 'Lithron.LPageService');
return $pagePath;
}
/**
* wrapper function
*/
public function constructUrl($pagePath, $getParams= null, $encodeAmpersand= true, $encodeGetItems= true, $log= false)
{
if ($log) echo "constructUrl for $pagePath<br>";
if ($pattern= $this->Application->Parameters['LinkUrlType'])
{
$p= $this->parseGetParams($getParams, $encodeAmpersand, $encodeGetItems);
if ($this->Application->getModule('geo_ip') instanceof TModule)
{
$geoip_country_code= $this->Application->getModule('geo_ip')->getCountryCode();
$geoip_country_name= $this->Application->getModule('geo_ip')->getCountryName();
}
else
{
$geoip_country_code= "--";
$geoip_country_name= "--";
}
$trans= array (
"{REQ_APPURL}" => $this->Request->ApplicationUrl,
"{REQ_APPURL_NOINDEX}" => str_replace("index.php",
"",
$this->Request->ApplicationUrl
), "{CULTURE}" => $this->Application->Globalization->Culture, "{GEOIP_COUNTRY}" => $geoip_country_code, "{ALIAS}" => $pagePath, "{AMP_GET_PARAM}" => ($p ? "&" . $p : ""), "{QM_GET_PARAM}" => ($p ? "?" . $p : ""),);
$res = strtr($pattern, $trans);
if ($log) var_dump($res);
return $res;
}
return $this->getRequest()->constructUrl($this->getID(), $pagePath, $getParams, $encodeAmpersand, $encodeGetItems);
}
private function parseGetParams($getParams= null, $encodeAmpersand= false, $encodeGetItems= true)
{
$params= "";
if ($getParams != null)
{
foreach ($getParams AS $key => $value)
$params .= $key . "=" . $value . "&"; // TODO
return $params;
}
else
{
return "";
}
}
public function reload()
{
Lithron :: saveLogging($this->Application);
$url = $this->constructUrl($this->getServicePage(true));
$this->Response->redirect($url);
}
}
?>

Source for file LPageService.php