class.ilWebLinkXmlParser.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once("Services/MetaData/classes/class.ilMDSaxParser.php");
include_once("Services/MetaData/classes/class.ilMD.php");
include_once('Services/Utilities/interfaces/interface.ilSaxSubsetParser.php');

include_once './Modules/WebResource/classes/class.ilLinkResourceItems.php';
include_once './Modules/WebResource/classes/class.ilWebLinkXmlParserException.php';
include_once './Modules/WebResource/classes/class.ilParameterAppender.php';

class ilWebLinkXmlParser extends ilMDSaxParser
{
    const MODE_UNDEFINED = 0;
    const MODE_UPDATE = 1;
    const MODE_CREATE = 2;

    private $webl;
    private $mode = self::MODE_UNDEFINED;
    
    private $in_metadata = false;
    
    private $sorting_positions = array();
    private $current_sorting_position = 0;

    public function __construct($webr, $xml)
    {
        parent::__construct();
        $this->setXMLContent($xml);
        $this->setWebLink($webr);

        $this->setMDObject(new ilMD($this->getWebLink()->getId(), $this->getWebLink()->getId(), 'webr'));
        $this->setThrowException(true);
    }
    
    public function setWebLink(ilObject $webl)
    {
        $this->webl = $webl;
    }
    
    public function getWebLink()
    {
        return $this->webl;
    }
    
    public function setMode($a_mode)
    {
        $this->mode = $a_mode;
    }
    
    public function getMode()
    {
        return $this->mode;
    }
    
    public function start()
    {
        return $this->startParsing();
    }
    
    public function setHandlers($a_xml_parser)
    {
        xml_set_object($a_xml_parser, $this);
        xml_set_element_handler($a_xml_parser, 'handlerBeginTag', 'handlerEndTag');
        xml_set_character_data_handler($a_xml_parser, 'handlerCharacterData');
    }
    
    public function handlerBeginTag($a_xml_parser, $a_name, $a_attribs)
    {
        global $DIC;
        $a_attribs = $this->trimAndStripAttribs($a_attribs);
        $ilErr = $DIC['ilErr'];

        if ($this->in_metadata) {
            parent::handlerBeginTag($a_xml_parser, $a_name, $a_attribs);
            return;
        }

        switch ($a_name) {
            case "MetaData":
                $this->in_metadata = true;
                
                // Delete old meta data
                $md = new ilMD($this->getWebLink()->getId(), 0, 'webr');
                $md->deleteAll();

                parent::handlerBeginTag($a_xml_parser, $a_name, $a_attribs);
                break;

            case 'WebLink':
                
                $this->current_sorting_position = ($a_attribs['position'] ? $a_attribs['position'] : 0);
                $this->current_link_update = false;
                $this->current_link_delete = false;
                $this->current_parameters = array();
                
                if ($this->getMode() == self::MODE_CREATE or (isset($a_attribs['action']) and $a_attribs['action'] == 'Create')) {
                    // New weblink
                    $this->current_link = new ilLinkResourceItems($this->getWebLink()->getId());
                } elseif ($this->getMode() == self::MODE_UPDATE and $a_attribs['action'] == 'Delete') {
                    $this->current_link_delete = true;
                    $this->current_link = new ilLinkResourceItems($this->getWebLink()->getId());
                    $this->current_link->delete($a_attribs['id']);
                    break;
                } elseif ($this->getMode() == self::MODE_UPDATE and ($a_attribs['action'] == 'Update' or !isset($a_attribs['action']))) {
                    $this->current_link = new ilLinkResourceItems($this->getWebLink()->getId());
                    $this->current_link->readItem($a_attribs['id']);
                    $this->current_link_update = true;
                    
                    // Delete all dynamic parameter
                    include_once './Modules/WebResource/classes/class.ilParameterAppender.php';
                    foreach (ilParameterAppender::getParameterIds($this->getWebLink()->getId(), $a_attribs['id']) as $param_id) {
                        $param = new ilParameterAppender($this->getWebLink()->getId());
                        $param->delete($param_id);
                    }
                } else {
                    throw new ilWebLinkXmlParserException('Invalid action given for element "Weblink"');
                }
                
                // Active
                $this->current_link->setActiveStatus($a_attribs['active'] ? 1 : 0);
                
                // Valid
                if (!isset($a_attribs['valid'])) {
                    $valid = 1;
                } else {
                    $valid = $a_attribs['valid'] ? 1 : 0;
                }
                $this->current_link->setValidStatus($valid);
                
                // Disable check
                $this->current_link->setDisableCheckStatus($a_attribs['disableValidation'] ? 1 : 0);
                
                // internal
                if (isset($a_attribs['internal'])) {
                    $this->current_link->setInternal($a_attribs['internal']);
                }
                break;


            case 'Sorting':
                
                include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
                $sort = new ilContainerSortingSettings($this->getWebLink()->getId());
                $sort->delete();
                
                switch ($a_attribs['type']) {
                    case 'Manual':
                        $sort->setSortMode(ilContainer::SORT_MANUAL);
                        break;
                                                
                    case 'Title':
                    default:
                        $sort->setSortMode(ilContainer::SORT_TITLE);
                }
                $sort->save();
                break;
                
            case 'WebLinks':
                $this->sorting_positions = array();
                // no break
            case 'Title':
            case 'Description':
            case 'Target':
                // Nothing to do
                break;
                
            case 'DynamicParameter':
                
                $param = new ilParameterAppender($this->getWebLink()->getId());
                $param->setName($a_attribs['name']);
                
                switch ($a_attribs['type']) {
                    case 'userName':
                        $param->setValue(LINKS_LOGIN);
                        break;
                        
                    case 'userId':
                        $param->setValue(LINKS_USER_ID);
                        break;
                    
                    case 'matriculation':
                        $param->setValue(LINKS_MATRICULATION);
                        break;
                        
                    default:
                        throw new ilWebLinkXmlParserException('Invalid attribute "type" given for element "Dynamic parameter". Aborting');
                        break;
                }
                
                $this->current_parameters[] = $param;
                break;
        }
    }
    
    public function handlerEndTag($a_xml_parser, $a_name)
    {
        $this->cdata = $this->trimAndStrip((string) $this->cdata);

        if ($this->in_metadata) {
            parent::handlerEndTag($a_xml_parser, $a_name);
        }
        

        switch ($a_name) {
            case 'MetaData':
                $this->in_metadata = false;
                parent::handlerEndTag($a_xml_parser, $a_name);
                break;
                
            case 'WebLinks':
                $this->getWebLink()->MDUpdateListener('General');
                $this->getWebLink()->update();
                
                // save sorting
                include_once './Services/Container/classes/class.ilContainerSorting.php';
                $sorting = ilContainerSorting::_getInstance($this->getWebLink()->getId());
                $sorting->savePost($this->sorting_positions);
                ilLoggerFactory::getLogger('webr')->dump($this->sorting_positions);
                break;
                
            case 'WebLink':
                
                if ($this->current_link_delete) {
                    break;
                }
                if (!$this->current_link) {
                    throw new ilSaxParserException('Invalid xml structure given. Missing start tag "WebLink"');
                }
                if (!$this->current_link->validate()) {
                    throw new ilWebLinkXmlParserException('Missing required elements "Title, Target"');
                }
                
                if ($this->current_link_update) {
                    $this->current_link->update();
                } else {
                    $this->current_link->add();
                }
                
                // Save dynamic parameters
                foreach ($this->current_parameters as $param) {
                    $param->add($this->current_link->getLinkId());
                }
                
                
                // store positions
                $this->sorting_positions[$this->current_link->getLinkId()] = (int) $this->current_sorting_position;

                unset($this->current_link);
                break;
                
            case 'Title':
                if ($this->current_link) {
                    $this->current_link->setTitle(trim($this->cdata));
                }
                break;
                
            case 'Description':
                if ($this->current_link) {
                    $this->current_link->setDescription(trim($this->cdata));
                }
                break;
                
            case 'Target':
                if ($this->current_link) {
                    $this->current_link->setTarget(trim($this->cdata));
                }
                break;
        }
        
        // Reset cdata
        $this->cdata = '';
    }
    

    
    public function handlerCharacterData($a_xml_parser, $a_data)
    {
        if ($this->in_metadata) {
            parent::handlerCharacterData($a_xml_parser, $a_data);
        }

        if ($a_data != "\n") {
            // Replace multiple tabs with one space
            $a_data = preg_replace("/\t+/", " ", $a_data);
            $this->cdata .= $a_data;
        }
    }
}