class.ilECSObjectSettings.php

Go to the documentation of this file.

<?php

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

abstract class ilECSObjectSettings
{
    protected $content_obj; // [ilObj]
    
    private $logger = null;
    
    const MAIL_SENDER = 6;
    
    public function __construct(ilObject $a_content_object)
    {
        $this->logger = $GLOBALS['DIC']->logger()->obj();
        $this->content_obj = $a_content_object;
    }
    
    public static function getInstanceByObject(ilObject $a_content_obj)
    {
        switch ($a_content_obj->getType()) {
            case 'crs':
                include_once 'Modules/Course/classes/class.ilECSCourseSettings.php';
                return new ilECSCourseSettings($a_content_obj);
                
            case 'cat':
                include_once 'Modules/Category/classes/class.ilECSCategorySettings.php';
                return new ilECSCategorySettings($a_content_obj);
                
            case 'file':
                include_once 'Modules/File/classes/class.ilECSFileSettings.php';
                return new ilECSFileSettings($a_content_obj);
                
            case 'glo':
                return new ilECSGlossarySettings($a_content_obj);
                
            case 'grp':
                include_once 'Modules/Group/classes/class.ilECSGroupSettings.php';
                return new ilECSGroupSettings($a_content_obj);
                
            case 'lm':
                include_once 'Modules/LearningModule/classes/class.ilECSLearningModuleSettings.php';
                return new ilECSLearningModuleSettings($a_content_obj);
                
            case 'wiki':
                include_once 'Modules/Wiki/classes/class.ilECSWikiSettings.php';
                return new ilECSWikiSettings($a_content_obj);
        }
    }
    
    public function getContentObject()
    {
        return $this->content_obj;
    }
    
    abstract protected function getECSObjectType();
    
    protected function isActive()
    {
        include_once('./Services/WebServices/ECS/classes/class.ilECSServerSettings.php');
        if (ilECSServerSettings::getInstance()->activeServerExists()) {
            // imported objects cannot be exported => why not
            #include_once('./Services/WebServices/ECS/classes/class.ilECSImport.php');
            #if(!ilECSImport::lookupServerId($this->content_obj->getId()))
            {
                return true;
            }
        }
                        
        return false;
    }

    public function addSettingsToForm(ilPropertyFormGUI $a_form, $a_type)
    {
        global $DIC;

        $lng = $DIC['lng'];
        
        $this->logger->debug('Show ecs settings.');
        if (!$this->isActive($a_type)) {
            $this->logger->debug('Object type is not active. => no settings.');
            return;
        }
        
        $obj_id = $this->content_obj->getId();

        // Return if no participant is enabled for export and the current object is not released
        include_once './Services/WebServices/ECS/classes/class.ilECSExport.php';
        include_once './Services/WebServices/ECS/classes/class.ilECSParticipantSettings.php';
        
        if (!$this->getContentObject()->withReferences()) {
            $this->logger->debug('Called withot references. => no settings.');
            return true;
        }

        $exportablePart = ilECSParticipantSettings::getExportableParticipants($a_type);
        if (!$exportablePart and !ilECSExport::_isExported($obj_id)) {
            $this->logger->debug('Object type is not exportable. => no settings.');
            return true;
        }
        if (
            $GLOBALS['DIC']['tree']->checkForParentType($GLOBALS['DIC']['tree']->getParentId($this->getContentObject()->getRefId()), 'crs', false) or
            $GLOBALS['DIC']['tree']->checkForParentType($GLOBALS['DIC']['tree']->getParentId($this->getContentObject()->getRefId()), 'grp', false)
        ) {
            $this->logger->debug('Parent crs/grp in path. => no settings.');
            return true;
        }

        $lng->loadLanguageModule('ecs');

        // show ecs property form section
        $ecs = new ilFormSectionHeaderGUI();
        $ecs->setTitle($lng->txt('ecs_' . $a_type . '_export'));
        $a_form->addItem($ecs);


        // release or not
        $exp = new ilRadioGroupInputGUI($lng->txt('ecs_' . $a_type . '_export_obj_settings'), 'ecs_export');
        $exp->setRequired(true);
        $exp->setValue(ilECSExport::_isExported($obj_id) ? 1 : 0);
        $off = new ilRadioOption($lng->txt('ecs_' . $a_type . '_export_disabled'), 0);
        $exp->addOption($off);
        $on = new ilRadioOption($lng->txt('ecs_' . $a_type . '_export_enabled'), 1);
        $exp->addOption($on);
        $a_form->addItem($exp);

        // Show all exportable participants
        $publish_for = new ilCheckboxGroupInputGUI($lng->txt('ecs_publish_for'), 'ecs_sid');

        // @TODO: Active checkboxes for recipients
        //$publish_for->setValue((array) $members);

        // Read receivers
        $receivers = array();
        include_once('./Services/WebServices/ECS/classes/class.ilECSEContentDetails.php');
        foreach (ilECSExport::getExportServerIds($obj_id) as $sid) {
            $exp = new ilECSExport($sid, $obj_id);
                        
            $participants = null;
            $details = ilECSEContentDetails::getInstance(
                $sid,
                $exp->getEContentId(),
                $this->getECSObjectType()
            );
            if ($details instanceof ilECSEContentDetails) {
                $participants = $details->getReceivers();
            }
            if ($participants) {
                foreach ($participants as $mid) {
                    $receivers[] = $sid . '_' . $mid;
                }
            }
        }
        $publish_for->setValue($receivers);

        foreach ($exportablePart as $pInfo) {
            include_once './Services/WebServices/ECS/classes/class.ilECSParticipantSetting.php';
            $partSetting = new ilECSParticipantSetting($pInfo['sid'], $pInfo['mid']);

            $com = new ilCheckboxInputGUI(
                $partSetting->getCommunityName() . ': ' . $partSetting->getTitle(),
                'sid_mid'
            );
            $com->setValue($pInfo['sid'] . '_' . $pInfo['mid']);
            $publish_for->addOption($com);
        }
        $on->addSubItem($publish_for);
        return true;
    }
    
    public function handleSettingsUpdate()
    {
        if (!$this->isActive()) {
            return true;
        }
        
        // Parse post data
        $mids = array();
        foreach ((array) $_POST['ecs_sid'] as $sid_mid) {
            $tmp = explode('_', $sid_mid);
            $mids[$tmp[0]][] = $tmp[1];
        }

        try {
            include_once './Services/WebServices/ECS/classes/class.ilECSCommunitiesCache.php';
            include_once './Services/WebServices/ECS/classes/class.ilECSParticipantSettings.php';
            include_once './Services/WebServices/ECS/classes/class.ilECSSetting.php';

            // Update for each server
            foreach (ilECSParticipantSettings::getExportServers() as $server_id) {
                $server = ilECSSetting::getInstanceByServerId($server_id);
                if ($server->isEnabled()) {
                    // Export
                    $export = true;
                    if (!$_POST['ecs_export']) {
                        $export = false;
                    }
                    if (
                        !isset($mids[$server_id]) ||
                        !is_array($mids[$server_id]) ||
                        !count($mids[$server_id])) {
                        $export = false;
                    }
                    $this->handleSettingsForServer(
                        $server,
                        $export,
                        isset($mids[$server_id]) ? $mids[$server_id] : []
                    );
                }
            }
        } catch (ilECSConnectorException $exc) {
            ilUtil::sendFailure('Error exporting to ECS server: ' . $exc->getMessage());
            return false;
        }
        return true;
    }
    
    protected function handleSettingsForServer(ilECSSetting $a_server, $a_export, $a_mids)
    {
        try {
            include_once('./Services/WebServices/ECS/classes/class.ilECSExport.php');
            $export_settings = new ilECSExport($a_server->getServerId(), $this->content_obj->getId());

            // already exported?
            if ($export_settings->isExported()) {
                // still exportable: update ecs
                if ((bool) $a_export) {
                    $this->doUpdate($a_server, $export_settings, $a_mids);
                }
                // not exportable anymore
                else {
                    $this->doDelete($a_server, $export_settings);
                }
            }
            // not exported yet
            else {
                // now to be exported
                if ($a_export) {
                    $this->doAdd($a_server, $export_settings, $a_mids);
                }
                // was not and will not be exported
                else {
                }
            }
        } catch (ilECSConnectorException $exc) {
            throw $exc;
        }
    }
    
    public function handleContentUpdate()
    {
        global $DIC;

        $ilLog = $DIC['ilLog'];
        
        if (!$this->isActive()) {
            return true;
        }

        include_once './Services/WebServices/ECS/classes/class.ilECSExport.php';
        $export_servers = ilECSExport::getExportServerIds($this->content_obj->getId());
        foreach ($export_servers as $server_id) {
            include_once './Services/WebServices/ECS/classes/class.ilECSSetting.php';
            $server = ilECSSetting::getInstanceByServerId($server_id);
            if ($server->isEnabled()) {
                try {
                    include_once('./Services/WebServices/ECS/classes/class.ilECSExport.php');
                    $export_settings = new ilECSExport($server_id, $this->content_obj->getId());
                    
                    // already exported, update ecs
                    if ($export_settings->isExported()) {
                        $this->doUpdate($server, $export_settings);
                    }
                    // not exported yet, nothing to do
                    else {
                    }
                } catch (ilECSConnectorException $exc) {
                    $ilLog->write(__METHOD__ . ': Cannot handle ECS content update. ' . $exc->getMessage());
                    return false;
                }
            }
        }
        return true;
    }
    
    protected function doAdd(ilECSSetting $a_server, ilECSExport $a_export_settings, array $a_mids)
    {
        global $DIC;

        $ilLog = $DIC['ilLog'];
        
        $ilLog->write(__METHOD__ . ': Starting ECS add resource...');

        $json = $this->buildJson($a_server);

        include_once 'Services/WebServices/ECS/classes/class.ilECSConnector.php';
        $connector = new ilECSConnector($a_server);
        $connector->addHeader(ilECSConnector::HEADER_MEMBERSHIPS, implode(',', $a_mids));
        $econtent_id = $connector->addResource(
            $this->getECSObjectType(),
            json_encode($json)
        );

        // status changed
        $a_export_settings->setExported(true);
        $a_export_settings->setEContentId($econtent_id);
        $a_export_settings->save();
        
        $this->handlePermissionUpdate($a_server, true);

        // Send mail
        $this->sendNewContentNotification($a_server, $econtent_id);
    }
    
    protected function doUpdate(ilECSSetting $a_server, ilECSExport $a_export_settings, array $a_mids = null)
    {
        global $DIC;

        $ilLog = $DIC['ilLog'];
        
        include_once 'Services/WebServices/ECS/classes/class.ilECSConnector.php';
        
        $econtent_id = $a_export_settings->getEContentId();
        if (!$econtent_id) {
            $ilLog->write(__METHOD__ . ': Missing eid. Aborting.');
            throw new ilECSConnectorException('Missing ECS content ID. Aborting.');
        }
        $connector = new ilECSConnector($a_server);
        
        if (!$a_mids) {
            $a_mids = $this->getParticipants($a_server->getServerId(), $econtent_id);
        }
        $ilLog->write(__METHOD__ . ': Start updating ECS content - ' . print_r($a_mids, true));
        $connector->addHeader(ilECSConnector::HEADER_MEMBERSHIPS, implode(',', (array) $a_mids));

        $json = $this->buildJson($a_server);
        $connector->updateResource(
            $this->getECSObjectType(),
            $econtent_id,
            json_encode($json)
        );
        
        $this->handlePermissionUpdate($a_server, true);
    }
    
    public function doDelete(ilECSSetting $a_server, ilECSExport $a_export_settings)
    {
        global $DIC;

        $ilLog = $DIC['ilLog'];
        
        // already exported?
        if ($a_export_settings->isExported()) {
            include_once './Services/WebServices/ECS/classes/class.ilECSSetting.php';
            include_once './Services/WebServices/ECS/classes/class.ilECSConnector.php';
            
            $econtent_id = $a_export_settings->getEContentId();
            if (!$econtent_id) {
                $ilLog->write(__METHOD__ . ': Missing eid. Aborting.');
                throw new ilECSConnectorException('Missing ECS content ID. Aborting.');
            }
            $connector = new ilECSConnector($a_server);

            $ilLog->write(__METHOD__ . ': Start deleting ECS content...');
            $connector->deleteResource(
                $this->getECSObjectType(),
                $econtent_id
            );

            // status changed
            $a_export_settings->setExported(false);
            $a_export_settings->save();
        }
    }
    
    public static function _handleDelete(array $a_subbtree_nodes)
    {
        // active?
        include_once './Services/WebServices/ECS/classes/class.ilECSServerSettings.php';
        if (!ilECSServerSettings::getInstance()->activeServerExists()) {
            return;
        }
        
        include_once './Services/WebServices/ECS/classes/class.ilECSSetting.php';
        include_once './Services/WebServices/ECS/classes/class.ilECSExport.php' ;
        $exported = ilECSExport::getExportedIds();
        foreach ($a_subbtree_nodes as $node) {
            if (in_array($node['obj_id'], $exported)) {
                if ($content_obj = ilObjectFactory::getInstanceByRefId($node['child'], false)) {
                    $settings = self::getInstanceByObject($content_obj);
                    
                    // Read export server ids
                    foreach (ilECSExport::getExportServerIds($node['obj_id']) as $sid) {
                        $server = ilECSSetting::getInstanceByServerId($sid);
                        $export_settings = new ilECSExport($sid, $content_obj->getId());
                        $settings->doDelete($server, $export_settings);
                    }
                }
            }
        }
    }
    
    protected function getParticipants($a_server_id, $a_econtent_id)
    {
        $receivers = array();
        include_once('./Services/WebServices/ECS/classes/class.ilECSEContentDetails.php');
        foreach ((array) $a_server_id as $sid) {
            $participants = null;
            $details = ilECSEContentDetails::getInstance($sid, $a_econtent_id, $this->getECSObjectType());
            if ($details instanceof ilECSEContentDetails) {
                $participants = $details->getReceivers();
            }
            if ($participants) {
                foreach ($participants as $mid) {
                    $receivers[] = $mid;
                }
            }
        }
        return (array) $receivers;
    }
    
    protected function sendNewContentNotification(ilECSSetting $a_server, $a_econtent_id)
    {
        global $DIC;

        $ilLog = $DIC['ilLog'];
        
        if (!count($rcps = $a_server->getApprovalRecipients())) {
            return true;
        }
        
        include_once('./Services/Mail/classes/class.ilMail.php');
        include_once('./Services/Language/classes/class.ilLanguageFactory.php');

        $lang = ilLanguageFactory::_getLanguage();
        $lang->loadLanguageModule('ecs');

        // @TODO: read mail
        $mail = new ilMail(self::MAIL_SENDER);
        $message = $lang->txt('ecs_export_created_body_a') . "\n\n";
        $message .= $lang->txt('title') . ': ' . $this->content_obj->getTitle() . "\n";
        if (strlen($desc = $this->content_obj->getDescription())) {
            $message .= $lang->txt('desc') . ': ' . $desc . "\n";
        }

        // Participant info
        $message .= ("\n" . $lang->txt('ecs_published_for'));
            
        try {
            $found = false;
            
            $receivers = null;
            include_once('./Services/WebServices/ECS/classes/class.ilECSEContentDetails.php');
            $details = ilECSEContentDetails::getInstance(
                $a_server->getServerId(),
                $a_econtent_id,
                $this->getECSObjectType()
            );
            if ($details instanceof ilECSEContentDetails) {
                $receivers = $details->getReceivers();
            }
            if ($receivers) {
                foreach ($receivers as $member) {
                    $found = true;
                    
                    include_once './Services/WebServices/ECS/classes/class.ilECSCommunityReader.php';
                    $part = ilECSCommunityReader::getInstanceByServerId($a_server->getServerId())->getParticipantByMID($member);
                    
                    $message .= ("\n\n" . $part->getParticipantName() . "\n");
                    $message .= ($part->getDescription());
                }
            }
            if ($found) {
                $message .= "\n\n";
            } else {
                $message .= (' ' . $lang->txt('ecs_not_published') . "\n\n");
            }
        } catch (ilECSConnectorException $e) {
            $ilLog->write(__METHOD__ . ': Cannot read approvements.');
            return false;
        }
        
        include_once('./Services/Link/classes/class.ilLink.php');
        $href = ilLink::_getStaticLink($this->content_obj->getRefId(), 'crs', true);
        $message .= $lang->txt("perma_link") . ': ' . $href . "\n\n";
        $message .= ilMail::_getAutoGeneratedMessageString();
        
        $mail->enqueue(
            $a_server->getApprovalRecipientsAsString(),
            '',
            '',
            $lang->txt('ecs_new_approval_subject'),
            $message,
            array()
        );
        
        return true;
    }
    
    protected function handlePermissionUpdate(ilECSSetting $server)
    {
        if (
            ($this->content_obj->getType() == 'crs') ||
            ($this->content_obj->getType() == 'grp')
        ) {
            $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': Permission update for courses/groups');
            $GLOBALS['DIC']['rbacadmin']->grantPermission(
                $server->getGlobalRole(),
                ilRbacReview::_getOperationIdsByName(array('join','visible')),
                $this->content_obj->getRefId()
            );
        }
    }
    
    protected function getJsonCore($a_etype)
    {
        $json = new stdClass();
        $json->lang = 'en_EN'; // :TODO: obsolet?
        $json->id = 'il_' . IL_INST_ID . '_' . $this->getContentObject()->getType() . '_' . $this->getContentObject()->getId();
        $json->etype = $a_etype;
        $json->title = $this->content_obj->getTitle();
        $json->abstract = $this->content_obj->getLongDescription();
        
        include_once('./Services/Link/classes/class.ilLink.php');
        $json->url = ilLink::_getLink($this->content_obj->getRefId(), $this->content_obj->getType());
        
        return $json;
    }
    
    protected function addMetadataToJson(&$a_json, ilECSSetting $a_server, array $a_definition)
    {
        include_once('./Services/WebServices/ECS/classes/class.ilECSDataMappingSettings.php');
        include_once('./Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php');
        include_once('./Services/AdvancedMetaData/classes/class.ilAdvancedMDFieldDefinition.php');
        $mappings = ilECSDataMappingSettings::getInstanceByServerId($a_server->getServerId());
        
        include_once "Services/WebServices/ECS/classes/class.ilECSUtils.php";
        $values = ilECSUtils::getAdvancedMDValuesForObjId($this->content_obj->getId());

        foreach ($a_definition as $id => $type) {
            if (is_array($type)) {
                $target = $type[1];
                $type = $type[0];
            } else {
                $target = $id;
            }
        
            if ($field = $mappings->getMappingByECSName(ilECSDataMappingSetting::MAPPING_EXPORT, $id)) {
                $value = isset($values[$field]) ? $values[$field] : '';
                
                switch ($type) {
                    case ilECSUtils::TYPE_ARRAY:
                        $a_json->$target = explode(',', $value);
                        break;
                    
                    case ilECSUtils::TYPE_INT:
                        $a_json->$target = (int) $value;
                        break;
                    
                    case ilECSUtils::TYPE_STRING:
                        $a_json->$target = (string) $value;
                        break;
                    
                    case ilECSUtils::TYPE_TIMEPLACE:
                        if (!isset($a_json->$target)) {
                            include_once('./Services/WebServices/ECS/classes/class.ilECSTimePlace.php');
                            $a_json->$target = new ilECSTimePlace();
                        }
                        $a_json->$target->{'set' . ucfirst($id)}($value);
                        break;
                }
            }
        }
    }
    
    abstract protected function buildJson(ilECSSetting $a_server);
}