class.ilObjBibliographicGUI.php

Go to the documentation of this file.

<?php

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

require_once "./Services/Object/classes/class.ilObject2GUI.php";
require_once "./Modules/Bibliographic/classes/class.ilBibliographicDetailsGUI.php";


class ilObjBibliographicGUI extends ilObject2GUI
{

    protected $bibl_obj;

    public function __construct($a_id = 0, $a_id_type = self::REPOSITORY_NODE_ID, $a_parent_node_id = 0)
    {
        global $lng, $ilias;
        $this->lng = $lng;
        $this->ilias = $ilias;

        parent::__construct($a_id, $a_id_type, $a_parent_node_id);

        $lng->loadLanguageModule("bibl");
        if($a_id > 0)
        {
            $this->bibl_obj = $this->object;
        }

    }

    public function getStandardCmd()
    {
        return "view";
    }

    public function getType()
    {
        return "bibl";
    }

    public function executeCommand()
    {
        global $ilCtrl, $ilTabs, $ilNavigationHistory, $tpl, $lng;

        // Navigation History
        $link = $ilCtrl->getLinkTarget($this, $this->getStandardCmd());

        if($this->object != NULL)
        {
            $ilNavigationHistory->addItem($this->object->getRefId(), $link, "bibl");
        }

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


        switch($next_class)
        {
            case "ilinfoscreengui":
                $this->prepareOutput();
                $ilTabs->activateTab("id_info");
                $this->infoScreenForward();
                break;

            case "ilcommonactiondispatchergui":
                include_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;

            case "ilpermissiongui":
                $this->prepareOutput();
                $ilTabs->activateTab("id_permissions");
                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;

            case "ilobjectcopygui":
                include_once "./Services/Object/classes/class.ilObjectCopyGUI.php";
                $cp = new ilObjectCopyGUI($this);
                $cp->setType('bibl');

                $tpl->getStandardTemplate();
                $this->ctrl->forwardCommand($cp);

                break;

            case "ilobjfilegui":
                $this->prepareOutput();
                $ilTabs->setTabActive("id_records");
                include_once("./Modules/File/classes/class.ilObjFile.php");
                $file_gui = new ilObjFile($this);
                $this->ctrl->forwardCommand($file_gui);
                break;

            default:
                return parent::executeCommand();
        }

        return true;
    }



    public function infoScreen()
    {
        $this->ctrl->setCmd("showSummary");
        $this->ctrl->setCmdClass("ilinfoscreengui");
        $this->infoScreenForward();
    }


    public function infoScreenForward()
    {
        global $ilTabs, $ilErr, $lng;

        if (!$this->checkPermissionBool("visible"))
        {
            ilUtil::sendFailure($lng->txt("msg_no_perm_read"), true);
            $this->ctrl->redirectByClass('ilPersonalDesktopGUI', '');
        }

        $ilTabs->activateTab("id_info");

        include_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");
        $info = new ilInfoScreenGUI($this);
        $info->enablePrivateNotes();
        $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());

        $this->ctrl->forwardCommand($info);
    }

    /*
     * addLocatorItems
     */
    public function addLocatorItems()
    {
        global $ilLocator;

        if (is_object($this->object))
        {
            $ilLocator->addItem($this->object->getTitle(), $this->ctrl->getLinkTarget($this, ""), "", $this->node_id);
        }
    }

    public static function _goto($a_target)
    {
        global $ilAccess, $ilErr, $ilCtrl;

        $id = explode("_", $a_target);

            $ilCtrl->setTargetScript("ilias.php");
            $ilCtrl->initBaseClass("ilRepositoryGUI");
            $ilCtrl->setParameterByClass("ilobjbibliographicgui", "ref_id",  $id[0]);

            //Detail-View
            if($id[1])
            {
                    $ilCtrl->setParameterByClass("ilobjbibliographicgui", "entryId",  $id[1]);
                    $ilCtrl->redirectByClass(array( "ilRepositoryGUI", "ilobjbibliographicgui" ), "showDetails");
            }
            else
            {
                    $ilCtrl->redirectByClass(array( "ilRepositoryGUI", "ilobjbibliographicgui" ), "view");
            }
    }



    /*
     * initCreationForms
     */
    protected function initCreationForms($a_new_type)
    {
        global $lng;

        $forms = parent::initCreationForms($a_new_type);

        // disabling import     
        unset($forms[self::CFORM_IMPORT]);
        

        // Add File-Upload
        $in_file = new ilFileInputGUI($lng->txt("bibliography file"), "bibliographic_file");

        $in_file->setSuffixes(array("ris", "bib", "bibtex"));

        $in_file->setRequired(true);
        $forms[self::CFORM_NEW]->addItem($in_file);
        $this->ctrl->saveParameterByClass('ilobjrootfoldergui', 'new_type');
        $forms[self::CFORM_NEW]->setFormAction($this->ctrl->getFormActionByClass('ilobjrootfoldergui', "save"));



        return $forms;
    }


    /*
     * Override save method to check (checkInput()) upload file extension
     */
    public function save()
    {
        global $tpl;
        $form = $this->initCreationForms($this->getType());
        if ($form[self::CFORM_NEW]->checkInput()){
            parent::save();

        }else{
            $form = $form[self::CFORM_NEW];
            $form->setValuesByPost();
            $tpl->setContent($form->getHtml());
        }

    }

    protected function afterSave(ilObject $a_new_object)
    {
        $a_new_object->doUpdate();

        $this->ctrl->redirect($this, "edit");
    }



    public function setTabs()
    {
        global $ilAccess, $ilTabs, $lng;

        // info screen
        if ($ilAccess->checkAccess('read', "", $this->object->getRefId()))
        {
            $ilTabs->addTab("content",
            $lng->txt("content"),
            $this->ctrl->getLinkTarget($this, "showContent"));
        }

        // info screen
        if ($ilAccess->checkAccess('visible', "", $this->object->getRefId()))
        {
            $ilTabs->addTab("id_info",
                $lng->txt("info_short"),
                $this->ctrl->getLinkTargetByClass("ilinfoscreengui", "showSummary"));
        }

        // settings
        if ($ilAccess->checkAccess('write', "", $this->object->getRefId()))
        {
            $ilTabs->addTab("settings",
                $lng->txt("settings"),
                $this->ctrl->getLinkTarget($this, "editObject"));
        }

        // edit permissions
        if ($ilAccess->checkAccess('edit_permission', "", $this->object->getRefId()))
        {
            $ilTabs->addTab("id_permissions",
                $lng->txt("perm_settings"),
                $this->ctrl->getLinkTargetByClass("ilpermissiongui", "perm"));
        }


    }

    public function initEditForm(){
        global $lng;

        $form = parent::initEditForm();


        // Add File-Upload
        $in_file = new ilFileInputGUI($lng->txt("bibliography file"), "bibliographic_file");

        $in_file->setSuffixes(array("ris", "bib", "bibtex"));

        $in_file->setRequired(false);

        $cb_override = new ilCheckboxInputGUI($this->lng->txt("Override Entries"), "override_entries");
        $cb_override->addSubItem($in_file);
        $form->addItem($cb_override);

        $form->setFormAction($this->ctrl->getFormAction($this, "save"));

        return $form;

    }

    protected function initEditCustomForm(ilPropertyFormGUI $a_form)
    {
        global $ilTabs;

        $ilTabs->activateTab("settings");

        // is_online
        $cb = new ilCheckboxInputGUI($this->lng->txt("online"), "is_online");

        $a_form->addItem($cb);

    }

    public function getEditFormCustomValues(array &$a_values)
    {
        $a_values["is_online"] = $this->object->getOnline();

        return $a_values;
    }

    /*
     * getBibliographicObject
     */
    public function getBibliographicObject()
    {
        $obj = new ilObjBibliographic($this->ref_id, true);

        return $obj;
    }


    public function render(){
        $this->showContent();
    }

    public function showContent(){
        global $ilAccess, $tpl, $lng, $ilToolbar, $ilCtrl, $ilTabs;
        // if user has read permission and object is online OR user has write permissions
        if(($ilAccess->checkAccess('read', "", $this->object->getRefId()) && $this->object->getOnline()) || $ilAccess->checkAccess('write', "", $this->object->getRefId())){
            $ilTabs->setTabActive("content");

            include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
            $ilToolbar = new ilToolbarGUI();
            $ilToolbar->addButton($lng->txt("Download Original File"), $ilCtrl->getLinkTargetByClass("ilBibliographicDetailsGUI", "sendFile"));

            include_once "./Modules/Bibliographic/classes/class.ilBibliographicRecordListTableGUI.php";
            $table = new ilDataBibliographicRecordListTableGUI($this, $this->cmd);
            $html = $table->getHTML();
            $tpl->setContent($html);

            //Permanent Link
            $tpl->setPermanentLink("bibl", $this->object->getRefId());
        }else{
            $object_title = ilObject::_lookupTitle(ilObject::_lookupObjId($_GET["ref_id"]));
            ilUtil::sendFailure(sprintf($this->lng->txt("msg_no_perm_read_item"), $object_title), true);
            //redirect to repository without any parameters
            unset($_GET);
            ilObjectGUI::_gotoRepositoryRoot();
        }
    }

    public function sendFile(){
        global $ilAccess, $tpl, $lng;
        if($ilAccess->checkAccess('read', "", $this->object->getRefId())){

            $file_path = $this->bibl_obj->getFileAbsolutePath();

            if($file_path){
                if(is_file($file_path)){
                    $path_array = explode(DIRECTORY_SEPARATOR, $file_path);
                    $filename = $path_array[sizeof($path_array)-1];
                    ilUtil::deliverFile($file_path, $filename);
                }else{
                    ilUtil::sendFailure($lng->txt("file_not_found"));
                    $this->showContent($this->bibl_obj);
                }
            }
        }else{
            ilUtil::sendFailure($this->lng->txt("no_permission"), true);
                ilObjectGUI::_gotoRepositoryRoot();
        }
    }

    public function showDetails() {
        global $ilAccess, $tpl, $lng;
        if($ilAccess->checkAccess('read', "", $this->object->getRefId())){
            $bibGUI = new ilBibliographicDetailsGUI();
            $bibGUI->showDetails($this->bibl_obj, $_GET['entryId']);
        }else{
                ilUtil::sendFailure($this->lng->txt("no_permission"), true);
                ilObjectGUI::_gotoRepositoryRoot();
        }
    }

    public function view(){
        $this->showContent();
    }


    public function updateCustom(ilPropertyFormGUI $a_form)
    {
        global $ilUser, $ilAccess, $tpl, $lng;
        if($ilAccess->checkAccess('write', "", $this->object->getRefId())){
            if($this->object->getOnline() != $a_form->getInput("is_online")){
                $this->object->setOnline($a_form->getInput("is_online"));
            }
        }else{
                ilUtil::sendFailure($this->lng->txt("no_permission"), true);
                ilObjectGUI::_gotoRepositoryRoot();
        }
    }

    /*
     * toggleNotification
     */
    public function toggleNotification()
    {
        global $ilCtrl, $ilUser;

        include_once "./Services/Notification/classes/class.ilNotification.php";
        switch($_GET["ntf"])
        {
            case 1:
                ilNotification::setNotification(ilNotification::TYPE_DATA_COLLECTION, $ilUser->getId(), $this->obj_id, false);
                break;
            case 2:
                ilNotification::setNotification(ilNotification::TYPE_DATA_COLLECTION, $ilUser->getId(), $this->obj_id, true);
                break;
        }
        $ilCtrl->redirect($this, "");
    }

    /*
     * addHeaderAction
     */
    public function addHeaderAction($a_redraw = false)
    {
        global $ilUser, $ilAccess, $tpl, $lng, $ilCtrl;

        include_once "Services/Object/classes/class.ilCommonActionDispatcherGUI.php";
        $dispatcher = new ilCommonActionDispatcherGUI(ilCommonActionDispatcherGUI::TYPE_REPOSITORY,
            $ilAccess, "dcl", $this->ref_id,$this->obj_id);

        include_once "Services/Object/classes/class.ilObjectListGUI.php";
        ilObjectListGUI::prepareJSLinks($this->ctrl->getLinkTarget($this, "redrawHeaderAction", "", true),
            $ilCtrl->getLinkTargetByClass(array("ilcommonactiondispatchergui", "ilnotegui"), "", "", true, false),
            $ilCtrl->getLinkTargetByClass(array("ilcommonactiondispatchergui", "iltagginggui"), "", "", true, false));

        $lg = $dispatcher->initHeaderAction();


        // notification
        if ($ilUser->getId() != ANONYMOUS_USER_ID && $this->object->getNotification() == 1)
        {
            include_once "./Services/Notification/classes/class.ilNotification.php";
            if(ilNotification::hasNotification(ilNotification::TYPE_DATA_COLLECTION, $ilUser->getId(), $this->obj_id))
            {
                //Command Activate Notification
                $ilCtrl->setParameter($this, "ntf", 1);
                $lg->addCustomCommand($ilCtrl->getLinkTarget($this, "toggleNotification"), "dcl_notification_deactivate_dcl");

                $lg->addHeaderIcon("not_icon",
                    ilUtil::getImagePath("notification_on.png"),
                    $lng->txt("dcl_notification_activated"));
            }
            else
            {
                //Command Deactivate Notification
                $ilCtrl->setParameter($this, "ntf", 2);
                $lg->addCustomCommand($ilCtrl->getLinkTarget($this,"toggleNotification"), "dcl_notification_activate_dcl");

                $lg->addHeaderIcon("not_icon",
                    ilUtil::getImagePath("notification_off.png"),
                    $lng->txt("dcl_notification_deactivated"));
            }
            $ilCtrl->setParameter($this, "ntf", "");
        }

        if(!$a_redraw)
        {
            $tpl->setHeaderActionMenu($lg->getHeaderAction());
        }
        else
        {
            return $lg->getHeaderAction();
        }

        $tpl->setHeaderActionMenu($lg->getHeaderAction());
    }
}

?>