base-module.inc.php

Go to the documentation of this file.

<?
class BaseModule
{
    public $baseUrl;

    public $page;

    public $pageTitle;

    public $template = null; 

    public $english;

    public $xml;

    public $doCachePage = false;
    
    public static $pageCacheLife = 900;
    
    private $params = array();

    private $error = null;

    private $status = array();

    private $sideboxes = array();

    private $navigation = array();

    private static $Feeds = array();

    private static $FeedTitles = array();

    public $_Name = null;
    
    public $_Description = null;
    
    public $_Version = null;
    
    public $_Author = null;
    
    public $_Website = null;

    public function __construct()
    {
        $this->_Name = preg_replace("/([A-Z])/", " $1", get_class($this));

        $this->objectType = get_class($this);
        $this->english = strtolower(get_class($this));
        $this->baseUrl = Config::get('site_baseurl');
    }
    
    public function init($page = 'main', $vars = array())
    {
        //not installed?  give a status message
        if (!Config::get('basejumper_installed'))
        {
            $this->addStatus('BaseJumper is in installation mode. Visit the ' .
            $this->getLink("main.sitesql", "site SQL") . ' page to create your
            site sql.<br/><br/>After that, do a
            <b>Config::set("basejumper_installed", true);</b> in your
            config.inc.php when you have finished installing your
            site.<br/><br/>You may also want to visit the <a
            href="http://www.osotite.com/documentation/installation">BaseJumper
            installation</a> page.');
        }
            
        //trim the bush
        $page = trim($page);
    
        //make sure we got a value
        if (!$page)
            $page = 'main';

        //now save it.
        $this->page = $page;
        
        //get our module xml..
        $xml = $this->parseModuleXml();

        //does our page exist?
        $rs = $xml->xpath("//page[@name='$this->page']");
            
        //get our specific page
        $pageXml = $rs[0];
            
        //what about custom template?  we may need to set this before we do any error checking.
        if ($pageXml['template'])
        {
            $templateClass = "$pageXml[template]Template";
            if (class_exists($templateClass))
                $this->setTemplate(new $templateClass());
        }
        
        //do a bit of error checking.
        if (!count($rs))
            throw new PageError("The page '$this->page' does not exist in the '" . get_class($this) . "' module.\n");
        else if (count($rs) > 1)
            throw new PageError("There is more than one '$this->page' in the '" . get_class($this) . "' module.");
        else
        {
            //get our title
            if ($pageXml['title'])
                $this->pageTitle = $pageXml['title'];

            //are we caching?
            if ($pageXml['cache'] == 'true' || $pageXml['cache'] == '1')
                $this->doCachePage = true;
        
            //initialize our parameters
            $this->initParams($pageXml, $vars);
            
            //our page too
            $this->initPage($this->page);
        }
    }

    public function draw()
    {
        //draw our stuff.
        $this->template->draw();
    }

    public function setTemplate(BaseTemplate $template)
    {
        $this->template = $template;
        $this->template->object = $this;
    } 

    public function initParams($page, $vars = array())
    {
        //get our params..
        $this->params = array();
        if (is_object($page->param[0]))
        {
            foreach ($page->param AS $param)
            {
                $name = (string)$param['name'];
                $required = (int)$param['required'];
                $type = (string)$param['type'];
                $regex = (string)$param['regex'];
                
                //if its required... make sure its there
                if ($required)
                {
                    if (isset($vars[$name]) && trim($vars[$name] != ''))
                        $this->params[$name] = trim($vars[$name]);
                    else
                        throw new PageError("Expected parameter '$name' for page '$page[name]'");
                }
                //otherwise just get it and put it in our params array
                else if (isset($vars[$name]))
                        $this->params[$name] = $vars[$name];

                //start off assuming its valid.
                $valid = true;

                //if we actually got something... verify it.
                if (isset($this->params[$name]))
                {
/*
                    //does it need to be an array?
                    if ($type == 'array')
                    {
                        if (!is_array($vars[$name]))
                            throw new PageError("Expected parameter '$name' to be an array.");
                    }
*/
                    //or an integer?
                    if ($type == 'int')
                    {
                        if ($this->params['name'] != (int)$this->params['name'])
                            throw new PageError("Parameter '$name' must be an integer.");
                    }
                    //or a float?
                    else if ($type == 'float')
                    {
                        if ($this->params['name'] != (float)$this->params['name'])
                            throw new PageError("Parameter '$name' must be an float.");
                    }
                    //okay, if we have options... make sure its one of those.
                    else if (is_object($param->option[0]))
                    {
                        $valid = false;
                        foreach ($param->option AS $option)
                        {
                            if ($option['value'] == $this->params[$name])
                            {
                                $valid = true;
                                break;
                            }
                        }
                    
                        //if its invalid... create our error.
                        if (!$valid)
                        {
                            $error = "The parameter '$name' can only be one of these values: ";
                            foreach ($param->option AS $option)
                                $values[] = "'$option[value]'";
                            
                            $error .= implode(", ", $values);

                            throw new PageError($error);
                        }
                    }
                    //otherwise, is it a regex...?
                    else if ($regex)
                    {
                        if (!preg_match($regex, $this->params[$name]))
                            throw new PageError("The parameter '$name' must
                            must match the <a
                            href=\"http://www.php.net/pcre\">regular
                            expression</a>:</b><br/>\n
                            <pre>$regex</pre>\n");
                    }
                }
            }
        }
    }
        
    function initPage($page)
    {
        //some pages may have custom init functions (we want this called first
        //as they may want to redirect after they are done and not have to call
        //a draw function.
        $func = "init" . ucfirst($page) . "Page";
        if (method_exists($this, $func))
            $this->$func();
        
        //make sure our draw function exists!
        $func = "draw" . ucfirst($page) . "Page";
        if (!method_exists($this, $func))
            throw new PageError(get_class($this) . "::$func() does not exist.  You must define it.\n");
    }

    public function getTitle()
    {
        if ($this->hasError())
            $this->pageTitle = 'Error';

        return $this->pageTitle;
    }

    public function getContent()
    {
        //start our buffering...
        ob_start();
        
        //call our drawing function
        $func = "draw" . ucfirst($this->page) . "Page";
        $this->$func();

        //get our content...
        $content = trim(ob_get_contents());

        //end output buffering...
        ob_end_clean();
    
        return $content;
    }

    public function getError()
    {
        return $this->error;
    }
    
    public function getStatus()
    {
        return $this->status;
    }
    
    public function getUrl($params = array(), $base = null, $full = false)
    {
        if ($base === null)
            $url = $this->baseUrl;
        else
            $url = $base;

        if ($full)
            $url = "http://" . Config::get('site_hostname') . $url; 

        //do some regexp foo?
        if (is_string($params))
        {
            //defaults
            $module = strtolower(get_class($this));
            $page = 'main';
            $vars = array();
            
            //if (preg_match("/\%((\s*)\.?) (\s*)(\?)(.*))/", $params, $match))
            if (preg_match("/^\w*$/", $params, $match))
                $module = $match[0];
            else if (preg_match("/(\w*)\.(\w*)\??([^#]*)(#\w*)?/", $params, $match))
            {
                //get our matches.
                if ($match[1])
                    $module = $match[1];
                //and our page
                if($match[2])
                    $page = $match[2];
                //plus parameters
                if ($match[3])
                {
                    $pairs = explode("&", $match[3]);
                    if (count($pairs))
                    {
                        foreach ($pairs AS $pair)
                        {
                            $var = explode("=", $pair);
                            $vars[$var[0]] = $var[1];
                        }
                    }
                }
                if ($match[4])
                    $anchor = $match[4];
            }

            //setup our params array.
            $params = array(
                'module' => $module,
                'page' => $page,
            );
            $params += $vars;
        }

        //add the class name in...
        if (!isset($params['module']))
            $params['module'] = strtolower(get_class($this));
        if (!isset($params['page']))
            $params['page'] = 'main';

        //are we using mod_rewrite?
        if (Config::get("use_mod_rewrite"))
        {
            //remove php file
            $url = str_replace("index.php", "", $url);
            
            //set page and module.
            $url .= $params['module'] . "/" . $params['page'];
            unset($params['module']);
            unset($params['page']);

            //add in our params
            if (count($params))
                foreach ($params AS $key => $val)
                    $url .= "/$key/" . urlencode($val);
        }
        else
        {
            //snag the params.
            if (is_array($params))
                foreach ($params AS $key => $val)
                    $url = Util::setUrlParam($url, $key, $val);
        }

        //add in our #foo.
        if ($anchor)
            $url .= $anchor;

        //return it.
        return $url;
    }

    function getParams($array)
    {
        $url = $this->getUrl($array);
        $link = explode("?", $url);
        return $link[1];
    }

    public function drawUrl($params, $text)
    {
        echo $this->getLink($params, $text);
    }

    public function getLink($params, $text, $base = null, $full = false)
    {
        $url = $this->getUrl($params, $base, $full);
        return "<a href=\"$url\" class=\"BaseLink\">$text</a>";
    }

    public function hasError()
    {
        return ($this->error !== null);
    }

    public function setError($error)
    {
        $this->error = $error;
        $this->pageTitle = 'Error';
    }

    public function hasStatus()
    {
        return (bool)count($this->status);
    }

    public function addStatus($str)
    {
        $this->status[] = $str;
    }

    public function initParametersPage()
    {
        $this->pageTitle = get_class($this) . " Module - Pages and Parameters";
    }

    public function drawParametersPage()
    {
        global $me;
        
        $xml = $this->parseModuleXml();

        echo "\n<h2>Pages</h2>\n";

        echo "<ul>\n";  
        foreach ($xml->page AS $page)
        {
            echo "\t<li><b>$page[name]</b>";

            if ($page['desc'])
                echo " - $page[desc]";
            
            echo "\n\t\t<ul>\n";
            if (is_object($page->param[0]))
            {
                echo "\t\t\t<li><b>parameters:</b> (pass these in as either get or post in the url)</li>\n";
                echo "\t\t\t\t<ul>\n";
                foreach ($page->param AS $param)
                {
                    echo "\t\t\t\t\t<li>";
                    
                    echo "<i>$param[name]</i> - ";

                    if ($param['required'] == '1' || $param['requied'] == 'true')
                        echo "(<b>required</b>) ";
                    else
                        echo "(optional) ";
                    
                    if ($param['desc'])
                        echo "$param[desc]";

                    if (is_object($param->option[0]))
                    {
                        echo "\n\t\t\t\t\t\t<ul>\n";
                        echo "\t\t\t\t\t\t\t<li><b>Accepted values:</b></li>\n";
                        foreach ($param->option AS $option)
                        {
                            echo "\t\t\t\t\t\t\t<li><i>$option[value]</i>";
                            
                            if ($option['desc'])
                                echo " - $option[desc]";
                            else
                                echo " - sort by the $option[value] field";
                                
                            echo "</li>\n";

                        }
                        echo "\t\t\t\t\t\t</ul>\n";
                    }

                    //draw our regex stuff
                    $regex = (string)$param['regex'];
                    if ($regex)
                    {
                        echo "\n\t\t\t\t\t\t<ul>\n";
                        echo "\t\t\t\t\t\t\t<li>\n";
                        echo "<b>Must match the <a href=\"http://www.php.net/pcre\">regular expression</a>:</b><br/>\n";
                        echo "<pre>$regex</pre>\n";
                        echo "\t\t\t\t\t\t\t</li>\n";
                        echo "\t\t\t\t\t\t</ul>\n";
                    }
                        
                    echo "\t\t\t\t\t</li>\n";
                }
                echo "\t\t\t\t</ul>\n";
            }
            
            echo "\t\t\t<li><b>output:</b> ";

            if ($page['type'] == 'xml')
                echo "XML data suitable for parsing.";
            else
                echo "HTML data suitable for display.";
            echo "</li>\n";

            echo "\t\t</ul>\n";
            
            echo "\t</li>\n";
        }
        echo "</ul>";
    }

    public function initMainPage()
    {
        $this->pageTitle = get_class($this) . " Main";
    }
    
    public function drawMainPage()
    {
    }

    public function initModuleXmlPage()
    {
        $this->pageTitle = get_class($this) . " Module - XML Structure";
    
        $this->setTemplate(new XMLTemplate());
    }

    public function drawModuleXmlPage()
    {
        echo $this->xml;
    }
    
    public function parseModuleXml()
    {
        if (!$this->xml)
            $this->xml = $this->getModuleXml();

        return simplexml_load_string($this->xml);
    }

    function params($key = null)
    {
        if ($key === null)
            return $this->params;
        else if (array_key_exists($key, $this->params))
            return $this->params[$key];
        else
            return false;
    }

    function setParam($key, $val)
    {
        $this->params[$key] = $val;
    }
    
    function getModuleXml()
    {
        $xml = "<module name=\"" . get_class($this) . "\" english=\"$this->english\">\n";
        $xml .= $this->getPagesXml();
        $xml .= "\n\t</module>";

        return $xml;
    }

    function getPagesXml()
    {
        global $me;
        
        $xml = $this->getMainPageXml();
        $xml .= $this->getModulePageXml();
        $xml .= $this->getParametersPageXml();
        $xml .= $this->getCreateTablePageXml();

        return $xml;
    }

    function getMainPageXml()
    {
        return "\t<page name=\"main\" type=\"content\" desc=\"the main page for the module\"/>\n";
    }

    function getModulePageXml()
    {
        return "\t<page name=\"modulexml\" type=\"xml\" desc=\"get the modules structural xml description\"/>\n";
    }
        
    function getParametersPageXml()
    {
        return "\t<page name=\"parameters\" type=\"content\" desc=\"get the pages and parameters for an object\"/>\n";
    }
    
    function getCreateTablePageXml()
    {
        return "\t<page name=\"createtable\" type=\"content\" desc=\"get the MySQL syntax to create the needed tables.\"><param name=\"run\"/></page>\n";
    }

    public function addBox($box)
    {
        $this->sideboxes[] = $box;
    }

    public function needsSideBar()
    {
        return (bool)count($this->sideboxes);
    }

    public function drawSideBar()
    {
        if ($this->needsSideBar())
        {
            echo "\n<div id=\"sidebar\">\n";
            
            foreach ($this->sideboxes AS $box)
                $box->draw();
        
            Util::ieDrawClear();
            echo "\n</div>\n";
            echo "<!-- end sidebar -->\n";
        }
    }

    public function addNav($text)
    {
        $this->navigation[] = $text;
    }

    public function getNav()
    {
        return $this->navigation;
    }

    public function drawNavigation()
    {   
        if (count($this->navigation))
        {
            echo "\n<div class=\"pageNav\">\n";
            echo "\t<ul>\n";
            foreach ($this->navigation AS $nav)
                echo "\t\t<li>$nav</li>\n";
            echo "\t</ul>\n";
            Util::ieDrawClear();
            echo "</div>\n";
        }
    }

    public function drawPageNavigation($links)
    {
        $this->drawPlainNavigation($links);
    }

    public function drawPlainNavigation($links)
    {
        echo "\n\n<div class=\"PageNavigation\">";
        echo implode(" ~ ", $links);
        echo "</div>\n\n";
    }

    public function assertLogin()
    {
        global $me;

        if (!$me->id)
        {
            Util::redirect($me->getUrl(array(
                'page' => 'login',
                'redirect' => base64_encode($_SERVER['REQUEST_URI']),
                'status' => 'You must be logged in to access this part of the site.'
            )));
        }

        return $me->id;
    }

    public function needsCss($file)
    {
        global $_BJ_CSS;
        $_BJ_CSS[] = $file;
        $_BJ_CSS = array_unique($_BJ_CSS);
    }

    public function drawCss()
    {
        global $_BJ_CSS;
        
        if (count($_BJ_CSS))
            foreach ($_BJ_CSS AS $file)
                echo "\t<link rel=\"stylesheet\" href=\"$file\" type=\"text/css\" />\n";
    }

    public function needsJs($file)
    {
        global $_BJ_JAVASCRIPT;

        //remove any previous ones..
        if (count($_BJ_JAVASCRIPT))
            foreach ($_BJ_JAVASCRIPT AS $key => $val)
                if ($val == $file)
                    unset($_BJ_JAVASCRIPT[$key]);

        //add it in.
        $_BJ_JAVASCRIPT[] = $file;
    }

    public function drawJs()
    {
        global $_BJ_JAVASCRIPT;
        
        if (count($_BJ_JAVASCRIPT))
            foreach ($_BJ_JAVASCRIPT AS $file)
                echo "\t<script type=\"text/javascript\" src=\"$file\"></script>\n";
    }

    public function addFeed($url, $title)
    {
        self::$Feeds[] = $url;
        self::$FeedTitles[] = $title;
    }

    public function drawFeeds()
    {
        self::$Feeds = array_unique(self::$Feeds);
        self::$FeedTitles = array_unique(self::$FeedTitles);

        if (count(self::$Feeds))
            foreach (self::$Feeds AS $key => $feed)
                echo "\t<link rel=\"alternate\" type=\"application/rss+xml\" title=\"" . self::$FeedTitles[$key] . "\" href=\"$feed\">\n";
    }

    public function drawHead()
    {
        $this->drawCss();
        $this->drawJs();
        $this->drawFeeds();
    }

    public function initCreateTablePage()
    {
        global $me;
        
        $this->pageTitle = 'Create Table Syntax For ' . get_class($this);

        if ($this->params('run'))
        {
            if (!$me->isAdmin())
                throw new PageError('You must be an admin to run the create table query.');
            else
            {
                $this->runCreateTableSql();
                $this->addStatus('Your tables have been created.  Query(s) shown below.');
            }
        }
    }
        
    public function drawCreateTablePage()
    {
        global $me;
        
        if (!$this->params('run') && $me->isAdmin())
            echo "<p>" . $this->getLink(".createtable?run=1", "Run the SQL below.") . "</p>";
        
        echo "<p>" . nl2br($this->getCreateTableSql()) . "</p>";
    }
    
    public function runCreateTableSql()
    {
        dbExecute($this->getCreateTableSql());

        //clear our cache!
        CacheBot::delete('BaseJumper:Tables');
    }

    public function getCreateTableSql()
    {
        return '';
    }


    public static function getCachedPage($key = null)
    {
        //no key?  lets try and 
        if ($key === null)
            $key = self::getPageCacheKey();
            
        return CacheBot::get($key, self::$pageCacheLife);
    }

    public static function setCachedPage($data, $key = null)
    {
        //no key?  lets try and 
        if ($key === null)
            $key = self::getPageCacheKey();
        
        return CacheBot::set($key, $data, self::$pageCacheLife);
    }

    public static function getPageCacheKey($page = null)
    {
        if ($page === null)
            $page = $_SERVER["REQUEST_URI"];

        return "BaseJumper:autocache:$page";
    }

    public static function deleteCachedPage($page)
    {
        $key = self::getPageCacheKey($page);

        CacheBot::delete($key);
    }

    public static function tryPageCache($page = null)
    {
        //get our 
        $key = self::getPageCacheKey($page);
        
        //try to get our cached page.
        $page = self::getCachedPage($key);
        if ($page)
        {
            //send our page and return false
            echo $page;
            return false;
        }

        //nope, give them the key to cache with later.
        return $key;
    }
}
?>

---