class.ilSoapInstallationInfoXMLWriter.php

Go to the documentation of this file.

<?php

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


include_once "./Services/Xml/classes/class.ilXmlWriter.php";

class ilSoapInstallationInfoXMLWriter extends ilXmlWriter
{
    private $exportAdvMDDefs = false;
    private $exportUDFDefs = false;
    
    public function __construct()
    {
        parent::__construct();
    }
    
    public function setSettings($settings)
    {
        $this->settings = $settings;
    }

    public function start()
    {
        $this->__buildHeader();
        $this->__buildInstallationInfo();
        $this->xmlStartTag("Clients");
    }
    
    public function addClient($client)
    {
        if (is_object($client)) {
            $this->__buildClient($client);
        }
    }
    
    public function end()
    {
        $this->xmlEndTag("Clients");
        $this->__buildFooter();
    }

    public function getXML()
    {
        return $this->xmlDumpMem(false);
    }
    
    private function __buildHeader()
    {
        // we have to build the http path here since this request is client independent!
        $httpPath = ilSoapFunctions::buildHTTPPath();
        $this->xmlSetDtdDef("<!DOCTYPE Installation PUBLIC \"-//ILIAS//DTD InstallationInfo//EN\" \"" . $httpPath . "/xml/ilias_installation_info_5_3.dtd\">");
        $this->xmlSetGenCmt("Export of ILIAS clients.");
        $this->xmlHeader();
        $this->xmlStartTag(
            "Installation",
            array(
                "version" => ILIAS_VERSION,
                "path" => $httpPath,
            )
        );
        
        return true;
    }

    private function __buildFooter()
    {
        $this->xmlEndTag('Installation');
    }
    
    private function __buildClient($setting)
    {
        // determine skins/styles
        $skin_styles = array();
        include_once("./Services/Style/System/classes/class.ilStyleDefinition.php");
        $skins = ilStyleDefinition::getAllSkins();

        if (is_array($skins)) {
            foreach ($skins as $skin) {
                foreach ($skin->getStyles() as $style) {
                    include_once("./Services/Style/System/classes/class.ilSystemStyleSettings.php");
                    if (!ilSystemStyleSettings::_lookupActivatedStyle($skin->getId(), $style->getId())) {
                        continue;
                    }
                    $skin_styles [] = $skin->getId() . ":" . $style->getId();
                }
            }
        }

        // timezones
        include_once('Services/Calendar/classes/class.ilTimeZone.php');
        
        
        $this->xmlStartTag(
            "Client",
            array(
                "inst_id" => $setting->get("inst_id"),
                "id" => $setting->clientid,
                "enabled" => $setting->access == 1 ? "TRUE" : "FALSE",
                "default_lang" => $setting->language,
                
            )
        );
        $this->xmlEndTag("Client");
        
        return;
        
        
        // END here due to security reasons.

        
        
        $auth_modes = ilAuthUtils::_getActiveAuthModes();
        $auth_mode_default =  strtoupper(ilAuthUtils::_getAuthModeName(array_shift($auth_modes)));
        $auth_mode_names = array();
        foreach ($auth_modes as $mode) {
            $auth_mode_names[] = strtoupper(ilAuthUtils::_getAuthModeName($mode));
        }
        

        $this->xmlElement("Name", null, $setting->get("inst_name"));
        $this->xmlElement("Description", null, $setting->description);
        $this->xmlElement("Institution", null, $setting->get("inst_institution"));
        $this->xmlStartTag("Responsible");
        $this->xmlElement("Firstname", null, $setting->get("admin_firstname"));
        $this->xmlElement("Lastname", null, $setting->get("admin_lastname"));
        $this->xmlElement("Title", null, $setting->get("admin_title"));
        $this->xmlElement("Institution", null, $setting->get("admin_institution"));
        $this->xmlElement("Position", null, $setting->get("admin_position"));
        $this->xmlElement("Email", null, $setting->get("admin_email"));
        $this->xmlElement("Street ", null, $setting->get("admin_street"));
        $this->xmlElement("ZipCode ", null, $setting->get("admin_zipcode"));
        $this->xmlElement("City", null, $setting->get("admin_city"));
        $this->xmlElement("Country", null, $setting->get("admin_country"));
        $this->xmlElement("Phone", null, $setting->get("admin_phone"));
        $this->xmlEndTag("Responsible");
        $this->xmlStartTag("Settings");
        $this->xmlElement("Setting", array("key" => "error_recipient"), $setting->get("error_recipient"));
        $this->xmlElement("Setting", array("key" => "feedback_recipient"), $setting->get("feedback_recipient"));
        $this->xmlElement("Setting", array("key" => "session_expiration"), $setting->session);
        $this->xmlElement("Setting", array("key" => "soap_enabled"), $setting->get("soap_user_administration"));
        $this->xmlElement("Setting", array("key" => "authentication_methods"), join(",", $auth_mode_names));
        $this->xmlElement("Setting", array("key" => "authentication_default_method"), $auth_mode_default);
        $this->xmlElement("Setting", array("key" => "skins"), join(",", $skin_styles));
        $this->xmlElement("Setting", array("key" => "default_skin"), $setting->default_skin_style);
        $this->xmlElement("Setting", array("key" => "default_timezone"), ilTimeZone::_getDefaultTimeZone());
        $this->xmlElement("Setting", array("key" => "default_hits_per_page"), $setting->default_hits_per_page);
        $this->xmlElement("Setting", array("key" => "default_show_users_online"), $setting->default_show_users_online);
        $this->xmlEndTag("Settings");
        
        if ($this->exportAdvMDDefs) {
            // create advanced meta data record xml
            include_once 'Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php';
            include_once 'Services/AdvancedMetaData/classes/class.ilAdvancedMDRecordXMLWriter.php';
            
            $record_ids = array();
            $record_types = ilAdvancedMDRecord::_getAssignableObjectTypes();
            
            foreach ($record_types as $type_info) {
                $type = $type_info['obj_type'];
                $records = ilAdvancedMDRecord::_getActivatedRecordsByObjectType($type);
                foreach ($records as $record) {
                    $record_ids [] = $record->getRecordId();
                }
            }
            $record_ids = array_unique($record_ids);
            $this->xmlStartTag('AdvancedMetaDataRecords');
        
            if (count($record_ids) > 0) {
                foreach ($record_ids as $record_id) {
                    $record_obj = ilAdvancedMDRecord::_getInstanceByrecordId($record_id);
                    $record_obj->toXML($this);
                }
            }
            $this->xmlEndTag('AdvancedMetaDataRecords');
        }
        
        if ($this->exportUDFDefs) {
            // create user defined fields record xml
            include_once("./Services/User/classes/class.ilUserDefinedFields.php");
            $udf_data = &ilUserDefinedFields::_newInstance();
            $udf_data->addToXML($this);
        }
                

        $this->xmlEndTag("Client");
    }
    
    private function __buildInstallationInfo()
    {
        $this->xmlStartTag("Settings");
        $this->xmlElement("Setting", array("key" => "default_client"), $GLOBALS['DIC']['ilIliasIniFile']->readVariable("clients", "default"));
        #$this->xmlElement("Setting", array("key" => "post_max_size"), ilSoapAdministration::return_bytes(ini_get("post_max_size")));
        #$this->xmlElement("Setting", array("key" => "upload_max_filesize"), ilSoapAdministration::return_bytes(ini_get("upload_max_filesize")));
        $this->xmlEndTag("Settings");
    }

    public function setExportAdvancedMetaDataDefinitions($value)
    {
        $this->exportAdvMDDefs = $value ? true : false;
    }
    
    
    public function setExportUDFDefinitions($value)
    {
        $this->exportUDFDefs = $value ? true: false;
    }
}