/inc/bx/dbforms2/config.php

<?php
// +----------------------------------------------------------------------+
// | Flux CMS                                                             |
// +----------------------------------------------------------------------+
// | Copyright (c) 2001-2007 Liip AG                                      |
// +----------------------------------------------------------------------+
// | This program is free software; you can redistribute it and/or        |
// | modify it under the terms of the GNU General Public License (GPL)    |
// | as published by the Free Software Foundation; either version 2       |
// | of the License, or (at your option) any later version.               |
// | The GPL can be found at http://www.gnu.org/licenses/gpl.html         |
// +----------------------------------------------------------------------+
// | Author: Liip AG      <contact@liip.ch>                               |
// +----------------------------------------------------------------------+
//
// $Id$

/**
 * DOCUMENT_ME
 *
 * @package bx_dbforms2
 * @category
 * @author Liip AG      <contact@liip.ch>
 */
class bx_dbforms2_config {

    /**
     *  Config file as a DOM-object
     *  @var dom
     */
    protected $dom = NULL;

    /**
     *  XPath-object to query the config file
     *  @var xpath
     */
    protected $xpath = NULL;

    /**
     *  Name of the currently loaded form
     *  @var name
     */
    protected $name = '';

    /**
     *  constructor
     *
     *  @param  string $name Name of the form
     *  @access public
     */
    public function __construct($name = NULL) {

        $this->dom = new DOMDocument();
        if(isset($name)) {
            $this->load($name);
        }
        $this->dom->xinclude();
    }

    /**
     *  Loads a form configuration by its name. The default location for
     *  form configuration files is BX_PROJECT_DIR/dbforms2/formname.xml
     *
     *  @param  string $name Name of the form
     *  @access public
     *  @return boolean TRUE on success, FALSE otherwise
     *
     */
    public function load($name) {
        $this->name = $name;
        $file = $this->getConfigFileByName($name);
        return $this->loadFromFile($file);
    }

    /**
     *  Loads a form configuration from a file.
     *
     *  @param  string  $file Name of the configuration file
     *  @access public
     *  @return boolean TRUE on success, FALSE otherwise
     */
    protected function loadFromFile($file) {

        if(!file_exists($file)) {
            throw new PopoonFileNotFoundException($file);
        }

        if(@$this->dom->load($file)) {
            $this->xpath = new DOMXPath($this->dom);
            // register dbforms2 namespace
            $this->xpath->registerNamespace('dbform', 'http://www.flux-cms.org/dbforms2/1.0');
            return TRUE;
        } else {
            throw new PopoonXMLParseErrorException($file);
        }
        return FALSE;
    }

    /**
     *  Returns the name of the configuration file which corresponds to
     *  a form name.
     *
     *  @param  string $name Name of the form
     *  @access public
     *  @return string Configuration file name
     */

    public function getConfigFileByName($name) {
        return BX_PROJECT_DIR."dbforms2/$name.xml";
    }

    /**
     *  Returns an array containing all fields of the current form.
     *
     *  @param  DOMElement $fieldsNode The <fields/> node of the form.
     *  @param  object $parentForm The form's parent form.
     *  @access public
     *  @return array All fields of the form, including child forms.
     */
    public function getFields($fieldsNode, $parentForm) {
        $fields = array();
        // get nodeset which contains all fields of the current form
        $fieldsNS = $this->xpath->query('dbform:field|dbform:group|dbform:nofield|dbform:form', $fieldsNode);

        foreach($fieldsNS as $field) {

            switch($field->localName) {
                case 'form';
                $name = $field->getAttribute('name');
                $form = $this->getForm($field);
                $fields[$name] = $form;
                break;

                // field, nofield and group are subclasses of bx_dbforms2_field
                case 'field':
                case 'group':
                case 'nofield':
                    $type = $field->getAttribute('type');
                    $name = $field->getAttribute('name');
                    if($field->localName == 'field') {
                        $fieldInstance = $this->getFieldInstance($type, $name);
                    } else if($field->localName == 'group') {
                        $fieldInstance = $this->getGroupInstance($type, $name);
                    } else if($field->localName == 'nofield') {
                        $fieldInstance = $this->getNofieldInstance($type, $name);
                    }

                    if($fieldInstance instanceof bx_dbforms2_field) {
                        $fieldInstance->parentForm = $parentForm;

                        $attributeSet = $fieldInstance->getConfigAttributes();
                        $attributes = $this->getNodeAttributes($field, $attributeSet);

                        $fieldInstance->setAttributes($attributes);

                        // check if this field has values from the config file
                        if($fieldInstance->hasConfigValues()) {
                            $fieldInstance->setValues($this->getFieldValues($field));
                        }
                        if(($default = $this->getDefaultFieldValue($field)) !== NULL) {
                            $fieldInstance->setDefaultValue($default);
                        }

                        if($field->localName == 'field') {
                            // check if this field has a live select
                            $lsNS = $this->xpath->query('dbform:liveselect', $field);
                            if($lsNS->length > 0) {
                                $lsNode = $lsNS->item(0);

                                $type = $lsNode->getAttribute("type");

                                if ($type == 'pagetree') {
                                    $liveSelect = new bx_dbforms2_liveselect_pagetree();
                                    $liveSelect->subtree = $lsNode->getAttribute('subtree');
                                } else if ($type == 'uid') {
                                    $liveSelect = new bx_dbforms2_liveselect_uid();
                                    $liveSelect->subtree = $lsNode->getAttribute('subtree');
                                } else {
                                    $liveSelect = new bx_dbforms2_liveselect();

                                    $liveSelect->nameField = $lsNode->getAttribute('namefield');
                                    $liveSelect->whereFields = $lsNode->getAttribute('wherefields');
                                    $liveSelect->where = $lsNode->getAttribute('where');
                                    $liveSelect->idField = $lsNode->getAttribute('idfield');
                                    $liveSelect->tableName = $lsNode->getAttribute('table');
                                    $liveSelect->orderBy = $lsNode->getAttribute('orderby');
                                    $liveSelect->limit = $lsNode->getAttribute('limit');
                                    $liveSelect->setLeftJoin($lsNode->getAttribute('leftjoin'));
                                }

                                if(!$liveSelect->limit) {
                                    $liveSelect->limit  = 20;
                                }

                                $liveSelect->getMatcher = $lsNode->getAttribute('getmatcher');

                                $fieldInstance->liveSelect = $liveSelect;
                            }
                        } else if($field->localName == 'group') {
                            $fieldInstance->setFields($this->getFields($field, $parentForm));

                        } else if($field->localName == 'nofield') {
                            $fieldInstance->setValue($field->getAttribute('value'));
                        }

                        $fields[$name] = $fieldInstance;

                    } else if($fieldInstance instanceof bx_dbforms2_form) {
                        $fields[$name] = $fieldInstance;
                    } else {
                        throw new Exception("Cannot instanciate $name ($type)");
                    }

                default:
                    break;
            }

        }

        return $fields;

    }

    /**
     *  Returns all values for the given field as an array.
     *
     *  @param  DOMNode $fieldNode Node of the field
     *  @access protected
     *  @return array Field values
     */
    protected function getFieldValues($fieldNode) {
        $values = array();

        $valuesNS = $this->xpath->query('dbform:datasource', $fieldNode);
        foreach ($valuesNS as $valueNode) {
            $type = $valueNode->getAttribute("type");
            $className = 'bx_dbforms2_datasource_'.$type;
            $ds =  call_user_func(array( $className, 'getInstance'));
            $args = array();
            foreach ($valueNode->attributes as $attr) {
                $args[$attr->name] = $attr->value;
            }
            if ($valueNode->firstChild) {
                $childValue = $valueNode->firstChild->nodeValue;
            } else {
                $childValue = null;
            }

            $values = $ds->getValues($args,$childValue);
             
        }

        $valuesNS = $this->xpath->query('dbform:value', $fieldNode);
        foreach ($valuesNS as $valueNode) {
            $values[$valueNode->getAttribute('name')] = $valueNode->textContent;
        }

        return $values;
    }

    /**
     *  Returns the default value for the given field.
     *
     *  @param  DOMNode $fieldNode Node of the field
     *  @access protected
     *  @return string Default field value
     */
    protected function getDefaultFieldValue($fieldNode) {
        $fieldName = $fieldNode->getAttribute('name');

        if($fieldNode->hasAttribute('default')) {
            return $this->replaceByRequestVar($fieldName, $fieldNode->getAttribute('default'));
        }

        $valueNS = $fieldNode->getElementsByTagName('value');

        if($valueNS->length > 0)
        return $this->replaceByRequestVar($fieldName, $valueNS->item(0)->textContent);

        return $this->replaceByRequestVar($fieldName, '');
    }

    /**
     *  Replaces the given value by the request variable referenced in fieldName. If
     *  the request variable is NULL, the passed value will be returned.
     *
     *  @param  string $name Name of the request variable.
     *  @param  string $value Value to be replaced.
     *  @access protected
     *  @return string Value of the request variable or the passed value
     */
    protected function replaceByRequestVar($name, $value) {
        if(isset($_REQUEST[$name])) {
            return $_REQUEST[$name];
        }

        if ($value == '${userid}') {
            return bx_helpers_perm::getUserId();
        }
        return $value;
    }

    /**
     *  Returns a form instance for the given form node.
     *
     *  @access public
     *  @return object Form object
     */
    public function getForm($formNode) {

        $fieldsNS = $this->xpath->query("dbform:fields", $formNode);
        $fieldsNode = $fieldsNS->item(0);

        $form = new bx_dbforms2_form();
        $form->fields = $this->getFields($fieldsNode, $form);
        $form->chooser = $this->getChooser($formNode);

        $formName = $formNode->getAttribute('name');
        if(!empty($formName)) {
            $form->name = $formName;
        } else {
            $form->name = $this->name;
        }

        $form->tableName = $this->getTableName($formNode);
        $form->tablePrefix = $this->getTablePrefix($formNode);
        $form->title = $this->getFormTitle($fieldsNode);
        $form->eventHandlers = $this->getEventHandlersByForm($fieldsNode->parentNode);

        $attributeSet = $form->getConfigAttributes();
        $attributes = $this->getNodeAttributes($fieldsNode, $attributeSet);

        // backward compatibility for the onsavephp attribute
        if(!empty($attributes['onsavephp'])) {
            $form->eventHandlers['php'][bx_dbforms2::EVENT_UPDATE_POST][] = $attributes['onsavephp'];
            unset($attributes['onsavephp']);
        }

        $form->attributes = $attributes;
        if(!empty($form->attributes['thatidfield'])) {
            $fieldInstance = $this->getFieldInstance('hidden', $form->attributes['thatidfield']);
            $fieldInstance->parentForm = $form;
            $form->fields[] = $fieldInstance;
        }

        $form->jsHrefs = $this->getJSHrefs();
        return $form;
    }

    /**
     *  Returns the main form instance.
     *
     *  @access public
     *  @return object Form object
     */
    public function getMainForm() {
        $formNS = $this->xpath->query("/dbform:form");
        return $this->getForm($formNS->item(0));
    }


    /**
     *  Returns the chooser object for the given form node.
     *
     *  @param  object $formNode The form node for which to get the chooser.
     *  @access public
     *  @return object The chooser object of the given form.
     */
    public function getChooser($formNode) {

        $chooserNS = $this->xpath->query("dbform:chooser", $formNode);
        $chooserNode = $chooserNS->item(0);
        if(!isset($chooserNode)) {
            return FALSE;
        }

        $chooser = new bx_dbforms2_liveselect();

        $chooser->nameField = $chooserNode->getAttribute('namefield');
        $chooser->whereFields = $chooserNode->getAttribute('wherefields');
        $chooser->where = $chooserNode->getAttribute('where');
        $chooser->limit = $chooserNode->getAttribute('limit');

        if(!$chooser->limit)
        $chooser->limit = 20;

        $chooser->orderBy = $chooserNode->getAttribute('orderby');
        $chooser->getMatcher = $chooserNode->getAttribute('getmatcher');
        $chooser->notNullFields = $chooserNode->getAttribute('notnullfields');
        $chooser->tableName = $this->getTableName($formNode);
        $chooser->tablePrefix = $this->getTablePrefix($formNode);

        $chooser->setLeftJoin($chooserNode->getAttribute('leftjoin'));
        return $chooser;
    }

    /**
     *  Returns the title of a form.
     *
     *  @param  DOMElement $fieldsNode The <fields/> node of the form.
     *  @access protected
     *  @return string The form's title
     */
    protected function getFormTitle($fieldsNode = NULL) {
        if(!isset($fieldsNode)) {
            $fieldsNS = $this->xpath->query("/dbform:form/dbform:fields");
            $fieldsNode = $fieldsNS->item(0);
        }
        if($fieldsNode && $fieldsNode->parentNode->hasAttribute('title'))
        return $fieldsNode->parentNode->getAttribute('title');

        return '';
    }

    /**
     *  Returns the table name of a form.
     *
     *  @param  DOMElement $fieldsNode The <fields/> node of the form.
     *  @access protected
     *  @return string The form's table name
     */
    protected function getTableName($formNode = NULL) {
        $fieldsNS = $this->xpath->query("dbform:fields", $formNode);
        $fieldsNode = $fieldsNS->item(0);

        if($fieldsNode && $fieldsNode->hasAttribute('table')) {
            return $fieldsNode->getAttribute('table');
        }

        return FALSE;
    }

    /**
     *  Returns the table prefix of a form.
     *
     *  @param  DOMElement $fieldsNode The <fields/> node of the form.
     *  @access protected
     *  @return string The form's table prefix
     */
    protected function getTablePrefix($formNode = NULL) {
        $fieldsNS = $this->xpath->query("dbform:fields", $formNode);
        $fieldsNode = $fieldsNS->item(0);

        if($fieldsNode && $fieldsNode->hasAttribute('tablePrefix')) {
            return $fieldsNode->getAttribute('tablePrefix');
        }
        return $GLOBALS['POOL']->config->getTablePrefix();
    }

    /**
     *  Returns an instance of the given field type.
     *
     *  @param  string $field Type of the field
     *  @param  string $name Name of the field
     *  @access protected
     *  @return object Field instance on succes, FALSE otherwise
     */
    protected function getFieldInstance($field, $name) {
        $class = "bx_dbforms2_fields_$field";
        return new $class($name);
    }

    /**
     *  Returns an instance of the given group type.
     *
     *  @param  string $field Type of the field
     *  @param  string $name Name of the field
     *  @access protected
     *  @return object Field instance on succes, FALSE otherwise
     */
    protected function getGroupInstance($field, $name) {
        $class = "bx_dbforms2_groups_$field";
        return new $class($name);
    }

    /**
     *  Returns an instance of the given nofield type.
     *
     *  @param  string $field Type of the element
     *  @param  string $name Name of the element
     *  @access protected
     *  @return object Field instance on succes, FALSE otherwise
     */
    protected function getNofieldInstance($field, $name) {
        $class = "bx_dbforms2_nofield_$field";
        return new $class($name);
    }

    /**
     *  Returns an array with all attributes for the given field node and
     *  attribute set.
     *
     *  @param  DOMElement $node DOM-node of the field
     *  @param  array $attributeSet Attribute set
     *  @access protected
     *  @return array Array containing all field attributes
     */
    protected function getNodeAttributes($node, $attributeSet = NULL) {
        $attributes = array();
        foreach($attributeSet as $attribute => $type) {

            $attributes[$attribute] = NULL;
            if($node->hasAttribute($attribute)) {
                $value = $node->getAttribute($attribute);

                if($type === 'bool' || $type === 'boolean') {
                    $value = strtolower($value) === 'true' ? TRUE : FALSE;
                }

                $attributes[$attribute] = $value;
            }
        }
        return $attributes;
    }

    /**
     *  Returns an array containing all javascript hrefs defined for a form.
     *
     *  @access public
     *  @return array Array with hrefs
     */
    protected function getJSHrefs() {
        $hrefs = array();

        $jsNS = $this->xpath->query("/dbform:form/dbform:javascript");
        foreach($jsNS as $jsNode) {
            if($jsNode->hasAttribute('src')) {
                $hrefs[] = $jsNode->getAttribute('src');
            }
        }
        return $hrefs;
    }

    /**
     *  Returns all events handlers of the given type
     *
     *  @param  DOMElement $node DOM-node of the form
     *  @access public
     *  @return array Array with event all handlers
     */
    protected function getEventHandlersByForm($node) {
        $ehandlers = array();

        // <dbform:eventhandler event="insert_pre" type="php" handler="foo::bar"/>

        $ehNS = $this->xpath->query("dbform:eventhandler", $node);
        foreach($ehNS as $ehNode) {

            $type = $ehNode->getAttribute('type');
            $event = $ehNode->getAttribute('event');
            $handler = $ehNode->getAttribute('handler');

            if(!empty($handler) && !empty($event)) {

                if(!isset($ehandlers[$type])) {
                    $ehandlers[$type] = array();
                }

                switch($event) {
                    case 'select_pre':
                        $ehandlers[$type][bx_dbforms2::EVENT_SELECT_PRE][] = $handler;
                        break;
                    case 'select_post':
                        $ehandlers[$type][bx_dbforms2::EVENT_SELECT_POST][] = $handler;
                        break;

                    case 'insert_pre':
                        $ehandlers[$type][bx_dbforms2::EVENT_INSERT_PRE][] = $handler;
                        break;
                    case 'insert_post':
                        $ehandlers[$type][bx_dbforms2::EVENT_INSERT_POST][] = $handler;
                        break;

                    case 'update_pre':
                        $ehandlers[$type][bx_dbforms2::EVENT_UPDATE_PRE][] = $handler;
                        break;
                    case 'update_post':
                        $ehandlers[$type][bx_dbforms2::EVENT_UPDATE_POST][] = $handler;
                        break;

                    case 'delete_pre':
                        $ehandlers[$type][bx_dbforms2::EVENT_DELETE_PRE][] = $handler;
                        break;
                    case 'delete_post':
                        $ehandlers[$type][bx_dbforms2::EVENT_DELETE_POST][] = $handler;
                        break;

                    case 'copy_pre':
                        $ehandlers[$type][bx_dbforms2::EVENT_COPY_PRE][] = $handler;
                    break;
                    case 'copy_post':
                        $ehandlers[$type][bx_dbforms2::EVENT_COPY_POST][] = $handler;
                    break;
                }
            }
        }

        return $ehandlers;
    }


}

?>