class.ilObjMDSettingsGUI.php

Go to the documentation of this file.

<?php
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
    |                                                                             |
    | This program is free software; you can redistribute it and/or               |
    | modify it under the terms of the GNU General Public License                 |
    | as published by the Free Software Foundation; either version 2              |
    | of the License, or (at your option) any later version.                      |
    |                                                                             |
    | This program is distributed in the hope that it will be useful,             |
    | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
    | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
    | GNU General Public License for more details.                                |
    |                                                                             |
    | You should have received a copy of the GNU General Public License           |
    | along with this program; if not, write to the Free Software                 |
    | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
    +-----------------------------------------------------------------------------+
*/
include_once("./Services/Object/classes/class.ilObjectGUI.php");


class ilObjMDSettingsGUI extends ilObjectGUI
{

    public function __construct($a_data, $a_id, $a_call_by_reference = true, $a_prepare_output = true)
    {
        global $DIC;

        $lng = $DIC['lng'];
        
        $this->type = 'mds';
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);

        $this->lng = $lng;
        $this->lng->loadLanguageModule("meta");
    }

    public function executeCommand()
    {
        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];
        $ilErr = $DIC['ilErr'];
        $ilAccess = $DIC['ilAccess'];

        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        $this->prepareOutput();

        if (!$ilAccess->checkAccess('read', '', $this->object->getRefId())) {
            $ilErr->raiseError($this->lng->txt('no_permission'), $ilErr->WARNING);
        }

        switch ($next_class) {
            case 'iladvancedmdsettingsgui':
                $this->tabs_gui->setTabActive('md_advanced');
                include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDSettingsGUI.php');
                $adv_md = new ilAdvancedMDSettingsGUI();
                $ret = $this->ctrl->forwardCommand($adv_md);
                break;
            
            case 'ilpermissiongui':
                $this->tabs_gui->setTabActive('perm_settings');
                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                $perm_gui = new ilPermissionGUI($this);
                $ret = &$this->ctrl->forwardCommand($perm_gui);
                break;

            case 'ilmdcopyrightusagegui':
                // this command is used if copyrightUsageGUI calls getParentReturn (see ...UsageGUI->setTabs)
                $this->ctrl->setReturn($this, 'showCopyrightSettings');
                $copyright_id = $_GET['entry_id'];
                $gui = new ilMDCopyrightUsageGUI((int) $copyright_id);
                $this->ctrl->forwardCommand($gui);
                break;

            default:
                $this->initMDSettings();
                if (!$cmd || $cmd == 'view') {
                    $cmd = "showGeneralSettings";
                }

                $this->$cmd();
                break;
        }
        return true;
    }

    protected function getType()
    {
        return $this->type;
    }

    protected function getParentObjType()
    {
        return 'meta';
    }


    protected function getAdministrationFormId()
    {
        return ilAdministrationSettingsFormHandler::FORM_META_COPYRIGHT;
    }


    public function getAdminTabs()
    {
        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];
        $ilAccess = $DIC['ilAccess'];

        if ($rbacsystem->checkAccess("visible,read", $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                "md_general_settings",
                $this->ctrl->getLinkTarget($this, "showGeneralSettings"),
                array("showGeneralSettings", "view")
            );

            $this->tabs_gui->addTarget(
                "md_copyright",
                $this->ctrl->getLinkTarget($this, "showCopyrightSettings"),
                array("showCopyrightSettings")
            );

            $this->tabs_gui->addTarget(
                "md_advanced",
                $this->ctrl->getLinkTargetByClass('iladvancedmdsettingsgui', ""),
                '',
                'iladvancedmdsettingsgui'
            );
        }

        if ($rbacsystem->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                "perm_settings",
                $this->ctrl->getLinkTargetByClass('ilpermissiongui', "perm"),
                array(),
                'ilpermissiongui'
            );
        }
    }

    public function showGeneralSettings()
    {
        global $DIC;

        $tpl = $DIC['tpl'];
        
        $this->initGeneralSettingsForm();
        $tpl->setContent($this->form->getHTML());
    }
    
    public function initGeneralSettingsForm($a_mode = "edit")
    {
        global $DIC;

        $lng = $DIC['lng'];
        $ilAccess = $DIC['ilAccess'];
        
        $this->tabs_gui->setTabActive('md_general_settings');
        
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $this->form = new ilPropertyFormGUI();
    
        $ti = new ilTextInputGUI($this->lng->txt("md_delimiter"), "delimiter");
        $ti->setInfo($this->lng->txt("md_delimiter_info"));
        $ti->setMaxLength(1);
        $ti->setSize(1);
        $ti->setValue($this->md_settings->getDelimiter());
        $this->form->addItem($ti);
                    
        if ($ilAccess->checkAccess('write', '', $this->object->getRefId())) {
            $this->form->addCommandButton("saveGeneralSettings", $lng->txt("save"));
            $this->form->addCommandButton("showGeneralSettings", $lng->txt("cancel"));
        }
                    
        $this->form->setTitle($lng->txt("md_general_settings"));
        $this->form->setFormAction($this->ctrl->getFormAction($this));
    }
    
    public function saveGeneralSettings()
    {
        global $DIC;

        $ilCtrl = $DIC['ilCtrl'];
        $ilAccess = $DIC['ilAccess'];
        
        if (!$ilAccess->checkAccess('write', '', $this->object->getRefId())) {
            $ilCtrl->redirect($this, "showGeneralSettings");
        }
        
        $delim = (trim($_POST['delimiter']) == "")
            ? ","
            : trim($_POST['delimiter']);
        $this->md_settings->setDelimiter($delim);
        $this->md_settings->save();
        ilUtil::sendSuccess($this->lng->txt('settings_saved'), true);

        $ilCtrl->redirect($this, "showGeneralSettings");
    }
    
    
    public function showCopyrightSettings()
    {
        global $DIC;

        $ilAccess = $DIC['ilAccess'];
        
        $this->tabs_gui->setTabActive('md_copyright');
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.settings.html', 'Services/MetaData');
        
        $this->initSettingsForm();
        $this->tpl->setVariable('SETTINGS_TABLE', $this->form->getHTML());
        
        $has_write = $ilAccess->checkAccess('write', '', $this->object->getRefId());
        
        include_once("./Services/MetaData/classes/class.ilMDCopyrightTableGUI.php");
        $table_gui = new ilMDCopyrightTableGUI($this, 'showCopyrightSettings', $has_write);
        $table_gui->setTitle($this->lng->txt("md_copyright_selection"));
        $table_gui->parseSelections();

        if ($has_write) {
            //          $table_gui->addCommandButton("updateCopyrightSelection", $this->lng->txt("save"));
            $table_gui->addCommandButton('addEntry', $this->lng->txt('add'));
            $table_gui->addMultiCommand("confirmDeleteEntries", $this->lng->txt("delete"));
            $table_gui->setSelectAllCheckbox("entry_id");
        }
        
        $this->tpl->setVariable('COPYRIGHT_TABLE', $table_gui->getHTML());
    }

    public function saveCopyrightSettings()
    {
        global $DIC;

        $ilAccess = $DIC['ilAccess'];
        
        if (!$ilAccess->checkAccess('write', '', $this->object->getRefId())) {
            $this->ctrl->redirect($this, "showCopyrightSettings");
        }
        
        $this->md_settings->activateCopyrightSelection((int) $_POST['active']);
        $this->md_settings->save();
        ilUtil::sendSuccess($this->lng->txt('settings_saved'));
        $this->showCopyrightSettings();
    }

    public function showCopyrightUsages()
    {
        $this->ctrl->setParameterByClass('ilmdcopyrightusagegui', 'entry_id', $_GET['entry_id']);
        $this->ctrl->redirectByClass('ilmdcopyrightusagegui', "showUsageTable");
    }
    
    public function editEntry()
    {
        $this->ctrl->saveParameter($this, 'entry_id');
        $this->initCopyrightEditForm();
        $this->tpl->setContent($this->form->getHTML());
    }
    
    public function addEntry()
    {
        $this->initCopyrightEditForm('add');
        $this->tpl->setContent($this->form->getHTML());
    }
    
    
    public function saveEntry()
    {
        global $DIC;

        $ilErr = $DIC['ilErr'];

        include_once('Services/MetaData/classes/class.ilMDCopyrightSelectionEntry.php');
        $this->entry = new ilMDCopyrightSelectionEntry(0);
    
        $this->entry->setTitle(ilUtil::stripSlashes($_POST['title']));
        $this->entry->setDescription(ilUtil::stripSlashes($_POST['description']));
        $this->entry->setCopyright($this->stripSlashes($_POST['copyright']));
        $this->entry->setLanguage('en');
        $this->entry->setCopyrightAndOtherRestrictions(true);
        $this->entry->setCosts(false);
        $this->entry->setOutdated((int) $_POST['outdated']);
        
        if (!$this->entry->validate()) {
            ilUtil::sendInfo($this->lng->txt('fill_out_all_required_fields'));
            $this->addEntry();
            return false;
        }
        $this->entry->add();
        ilUtil::sendSuccess($this->lng->txt('settings_saved'));
        $this->showCopyrightSettings();
        return true;
    }
    
    public function confirmDeleteEntries()
    {
        if (!is_array($_POST['entry_id']) or !count($_POST['entry_id'])) {
            ilUtil::sendInfo($this->lng->txt('select_one'));
            $this->showCopyrightSettings();
            return true;
        }
        
        include_once('Services/Utilities/classes/class.ilConfirmationGUI.php');
        $c_gui = new ilConfirmationGUI();
        
        // set confirm/cancel commands
        $c_gui->setFormAction($this->ctrl->getFormAction($this, "deleteEntries"));
        $c_gui->setHeaderText($this->lng->txt("md_delete_cp_sure"));
        $c_gui->setCancel($this->lng->txt("cancel"), "showCopyrightSettings");
        $c_gui->setConfirm($this->lng->txt("confirm"), "deleteEntries");

        include_once('Services/MetaData/classes/class.ilMDCopyrightSelectionEntry.php');

        // add items to delete
        foreach ($_POST["entry_id"] as $entry_id) {
            $entry = new ilMDCopyrightSelectionEntry($entry_id);
            $c_gui->addItem('entry_id[]', $entry_id, $entry->getTitle());
        }
        $this->tpl->setContent($c_gui->getHTML());
    }
    
    public function deleteEntries()
    {
        if (!is_array($_POST['entry_id']) or !count($_POST['entry_id'])) {
            ilUtil::sendInfo($this->lng->txt('select_one'));
            $this->showCopyrightSettings();
            return true;
        }

        include_once('Services/MetaData/classes/class.ilMDCopyrightSelectionEntry.php');
        foreach ($_POST["entry_id"] as $entry_id) {
            $entry = new ilMDCopyrightSelectionEntry($entry_id);
            $entry->delete();
        }
        ilUtil::sendSuccess($this->lng->txt('md_copyrights_deleted'));
        $this->showCopyrightSettings();
        return true;
    }

    public function updateEntry()
    {
        global $DIC;

        $ilErr = $DIC['ilErr'];

        include_once('Services/MetaData/classes/class.ilMDCopyrightSelectionEntry.php');
        $this->entry = new ilMDCopyrightSelectionEntry((int) $_REQUEST['entry_id']);
    
        $this->entry->setTitle(ilUtil::stripSlashes($_POST['title']));
        $this->entry->setDescription(ilUtil::stripSlashes($_POST['description']));
        $this->entry->setCopyright($this->stripSlashes($_POST['copyright']));
        $this->entry->setOutdated((int) $_POST['outdated']);
        
        if (!$this->entry->validate()) {
            ilUtil::sendInfo($this->lng->txt('fill_out_all_required_fields'));
            $this->editEntry();
            return false;
        }
        $this->entry->update();
        ilUtil::sendSuccess($this->lng->txt('settings_saved'));
        $this->showCopyrightSettings();
        return true;
    }
    
    
    protected function initSettingsForm()
    {
        global $DIC;

        $ilAccess = $DIC['ilAccess'];
        
        if (is_object($this->form)) {
            return true;
        }
        include_once('Services/Form/classes/class.ilPropertyFormGUI.php');
        $this->form = new ilPropertyFormGUI();
        $this->form->setFormAction($this->ctrl->getFormAction($this));
        $this->form->setTitle($this->lng->txt('md_copyright_settings'));


        if ($ilAccess->checkAccess('write', '', $this->object->getRefId())) {
            $this->form->addCommandButton('saveCopyrightSettings', $this->lng->txt('save'));
            $this->form->addCommandButton('showCopyrightSettings', $this->lng->txt('cancel'));
        }
        
        $check = new ilCheckboxInputGUI($this->lng->txt('md_copyright_enabled'), 'active');
        $check->setChecked($this->md_settings->isCopyrightSelectionActive());
        $check->setValue(1);
        $check->setInfo($this->lng->txt('md_copyright_enable_info'));
        $this->form->addItem($check);

        ilAdministrationSettingsFormHandler::addFieldsToForm(
            $this->getAdministrationFormId(),
            $this->form,
            $this
        );
    }
    
    public function initCopyrightEditForm($a_mode = 'edit')
    {
        if (is_object($this->form)) {
            return true;
        }
        if (!is_object($this->entry)) {
            include_once('Services/MetaData/classes/class.ilMDCopyrightSelectionEntry.php');
            $this->entry = new ilMDCopyrightSelectionEntry((int) $_REQUEST['entry_id']);
        }
        
        include_once('Services/Form/classes/class.ilPropertyFormGUI.php');
        $this->form = new ilPropertyFormGUI();
        $this->form->setFormAction($this->ctrl->getFormAction($this));
        
        $tit = new ilTextInputGUI($this->lng->txt('title'), 'title');
        $tit->setValue($this->entry->getTitle());
        $tit->setRequired(true);
        $tit->setSize(40);
        $tit->setMaxLength(255);
        $this->form->addItem($tit);
        
        $des = new ilTextAreaInputGUI($this->lng->txt('description'), 'description');
        $des->setValue($this->entry->getDescription());
        $des->setRows(3);
        $this->form->addItem($des);
        
        $cop = new ilTextAreaInputGUI($this->lng->txt('md_copyright_value'), 'copyright');
        $cop->setValue($this->entry->getCopyright());
        $cop->setRows(5);
        $this->form->addItem($cop);

        $usage = new ilRadioGroupInputGUI($this->lng->txt('meta_copyright_usage'), 'outdated');
        $use = new ilRadioOption($this->lng->txt('meta_copyright_in_use'), 0);
        $out = new ilRadioOption($this->lng->txt('meta_copyright_outdated'), 1);
        $usage->addOption($use);
        $usage->addOption($out);
        $usage->setValue($this->entry->getOutdated());
        $this->form->addItem($usage);
        
        switch ($a_mode) {
            case 'edit':
                $this->form->setTitle($this->lng->txt('md_copyright_edit'));
                $this->form->addCommandButton('updateEntry', $this->lng->txt('save'));
                $this->form->addCommandButton('showCopyrightSettings', $this->lng->txt('cancel'));
                break;
            
            case 'add':
                $this->form->setTitle($this->lng->txt('md_copyright_add'));
                $this->form->addCommandButton('saveEntry', $this->lng->txt('save'));
                $this->form->addCommandButton('showCopyrightSettings', $this->lng->txt('cancel'));
                break;
        }
    }
    
    protected function initMDSettings()
    {
        include_once('Services/MetaData/classes/class.ilMDSettings.php');
        $this->md_settings = ilMDSettings::_getInstance();
    }
    
    protected function stripSlashes($a_str)
    {
        if (ini_get("magic_quotes_gpc")) {
            $a_str = stripslashes($a_str);
        }
        return $a_str;
    }

    public function saveCopyrightPosition()
    {
        if (!isset($_POST['order'])) {
            $this->ctrl->redirect($this, 'showCopyrightSettings');
            return false;
        }

        $positions = $_POST['order'];
        asort($positions);
        $position = 0;
        foreach ($positions as $entry_id => $position_ignored) {
            $copyright = new ilMDCopyrightSelectionEntry($entry_id);
            $copyright->setOrderPosition($position++);
            $copyright->update();
        }
        ilUtil::sendSuccess($this->lng->txt('settings_saved'));
        $this->ctrl->redirect($this, 'showCopyrightSettings');
        return false;
    }
}