class.ilObjBadgeAdministrationGUI.php

Go to the documentation of this file.

<?php

use ILIAS\Badge\ilBadgeImageTemplateTableGUI;
use ILIAS\HTTP\Services;
use ILIAS\Badge\ilBadgeTypesTableGUI;
use ILIAS\Badge\ilObjectBadgeTableGUI;
use ILIAS\Badge\ilBadgeUserTableGUI;

class ilObjBadgeAdministrationGUI extends ilObjectGUI
{
    public const TABLE_ALL_OBJECTS_ACTION = 'ALL_OBJECTS';
    private \ILIAS\ResourceStorage\Services $resource_storage;
    private ilRbacSystem $rbacsystem;
    private ilBadgeGUIRequest $badge_request;
    private ilTabsGUI $tabs;
    private Services $http;

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

        $this->resource_storage = $DIC->resourceStorage();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->ctrl = $DIC->ctrl();
        $this->access = $DIC->access();
        $this->lng = $DIC->language();
        $this->toolbar = $DIC->toolbar();
        $this->tpl = $DIC['tpl'];
        $this->tabs = $DIC->tabs();
        $this->type = 'bdga';
        $this->http = $DIC->http();
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);

        $this->badge_request = new ilBadgeGUIRequest(
            $DIC->http(),
            $DIC->refinery()
        );

        $this->lng->loadLanguageModule('badge');
    }

    public function executeCommand(): void
    {
        $next_class = $this->ctrl->getNextClass($this) ?? '';
        $cmd = $this->ctrl->getCmd() ?? '';

        $this->prepareOutput();

        switch (strtolower($next_class)) {
            case strtolower(ilPermissionGUI::class):
                $this->tabs_gui->setTabActive('perm_settings');
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;

            case strtolower(ilBadgeManagementGUI::class):
                $this->assertActive();
                $this->tabs_gui->setTabActive('activity');
                $gui = new ilBadgeManagementGUI($this->ref_id, $this->obj_id, $this->type);
                $this->ctrl->forwardCommand($gui);
                break;

            default:
                if (!$cmd || $cmd === 'view') {
                    $cmd = 'editSettings';
                }

                if ($this->badge_request->getBadgeIdFromUrl()) {
                    $this->ctrl->setParameter($this, 'tid', $this->badge_request->getBadgeIdFromUrl());
                }

                $table_action = $this->http->wrapper()->query()->retrieve(
                    'tid_table_action',
                    $this->refinery->byTrying([
                        $this->refinery->kindlyTo()->string(),
                        $this->refinery->always('')
                    ])
                );

                $render_default = true;
                if ($table_action === 'badge_type_activate') {
                    $this->activateTypes();
                } elseif ($table_action === 'badge_type_deactivate') {
                    $this->deactivateTypes();
                } elseif ($table_action === 'badge_image_template_editImageTemplate') {
                    $this->editImageTemplate();
                    $render_default = false;
                } elseif ($table_action === 'obj_badge_user') {
                    $this->editImageTemplate();
                    $render_default = false;
                } elseif ($table_action === 'obj_badge_activate') {
                    $this->activateObjectBadges();
                    $render_default = false;
                } elseif ($table_action === 'obj_badge_deactivate') {
                    $this->deactivateObjectBadges();
                    $render_default = false;
                } elseif ($table_action === 'obj_badge_show_users') {
                    $this->listObjectBadgeUsers();
                    $render_default = false;
                } elseif ($table_action === 'badge_image_template_delete') {
                    $this->confirmDeleteImageTemplates();
                    $render_default = false;
                } elseif ($table_action === 'obj_badge_delete') {
                    $this->confirmDeleteObjectBadges();
                    $render_default = false;
                }

                if ($render_default) {
                    $this->$cmd();
                    break;
                }
        }
    }

    public function getAdminTabs(): void
    {
        $rbacsystem = $this->rbacsystem;

        if ($rbacsystem->checkAccess('visible,read', $this->object->getRefId())) {
            $this->tabs_gui->addTab(
                'settings',
                $this->lng->txt('settings'),
                $this->ctrl->getLinkTarget($this, 'editSettings')
            );

            if (ilBadgeHandler::getInstance()->isActive()) {
                $this->tabs_gui->addTab(
                    'types',
                    $this->lng->txt('badge_types'),
                    $this->ctrl->getLinkTarget($this, 'listTypes')
                );

                $this->tabs_gui->addTab(
                    'imgtmpl',
                    $this->lng->txt('badge_image_templates'),
                    $this->ctrl->getLinkTarget($this, 'listImageTemplates')
                );

                $this->tabs_gui->addTab(
                    'activity',
                    $this->lng->txt('badge_activity_badges'),
                    $this->ctrl->getLinkTargetByClass('ilbadgemanagementgui', '')
                );

                $this->tabs_gui->addTab(
                    'obj_badges',
                    $this->lng->txt('badge_object_badges'),
                    $this->ctrl->getLinkTarget($this, 'listObjectBadges')
                );
            }
        }

        if ($rbacsystem->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTab(
                'perm_settings',
                $this->lng->txt('perm_settings'),
                $this->ctrl->getLinkTargetByClass('ilpermissiongui', 'perm')
            );
        }
    }

    protected function assertActive(): void
    {
        if (!ilBadgeHandler::getInstance()->isActive()) {
            $this->ctrl->redirect($this, 'editSettings');
        }
    }


    //
    // settings
    //

    protected function editSettings(?ilPropertyFormGUI $a_form = null): void
    {
        $this->tabs_gui->setTabActive('settings');

        if (!$a_form) {
            $a_form = $this->initFormSettings();
        }

        $this->tpl->setContent($a_form->getHTML());
    }

    protected function saveSettings(): void
    {
        $ilCtrl = $this->ctrl;

        $this->checkPermission('write');

        $form = $this->initFormSettings();
        if ($form->checkInput()) {
            $handler = ilBadgeHandler::getInstance();
            $handler->setActive((bool) $form->getInput('act'));

            $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
            $ilCtrl->redirect($this, 'editSettings');
        }

        $form->setValuesByPost();
        $this->editSettings($form);
    }

    protected function initFormSettings(): ilPropertyFormGUI
    {
        $ilAccess = $this->access;

        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt('badge_settings'));

        if ($ilAccess->checkAccess('write', '', $this->object->getRefId())) {
            $form->addCommandButton('saveSettings', $this->lng->txt('save'));
            $form->addCommandButton('editSettings', $this->lng->txt('cancel'));
        }

        $act = new ilCheckboxInputGUI($this->lng->txt('badge_service_activate'), 'act');
        $act->setInfo($this->lng->txt('badge_service_activate_info'));
        $form->addItem($act);

        $handler = ilBadgeHandler::getInstance();
        $act->setChecked($handler->isActive());

        return $form;
    }


    //
    // types
    //

    protected function listTypes(): void
    {
        $ilAccess = $this->access;

        $this->assertActive();
        $this->tabs_gui->setTabActive('types');

        $tpl = new ilBadgeTypesTableGUI($this->access->checkAccess("write", "", $this->object->getRefId()));
        $tpl->renderTable();
    }

    protected function activateTypes(): void
    {
        $lng = $this->lng;
        $this->assertActive();

        $tmpl_ids = $this->badge_request->getMultiActionBadgeIdsFromUrl();
        if ($this->checkPermissionBool('write') && count($tmpl_ids) > 0) {
            $handler = ilBadgeHandler::getInstance();
            $change_state = [];
            foreach ($handler->getInactiveTypes() as $type) {
                if (!in_array($type, $tmpl_ids)) {
                    $change_state[] = $type;
                }
            }

            if (current($tmpl_ids) === self::TABLE_ALL_OBJECTS_ACTION) {
                $handler->setInactiveTypes([]);
            } else {
                $handler->setInactiveTypes($change_state);
            }

            $this->tpl->setOnScreenMessage('success', $lng->txt('settings_saved'), true);
        }
        $this->ctrl->redirect($this, 'listTypes');
    }

    protected function deactivateTypes(): void
    {
        $lng = $this->lng;
        $this->assertActive();

        $tmpl_ids = $this->badge_request->getMultiActionBadgeIdsFromUrl();
        if ($this->checkPermissionBool('write') && count($tmpl_ids) > 0) {
            $handler = ilBadgeHandler::getInstance();
            $change_state = [];
            foreach ($handler->getInactiveTypes() as $type) {
                if (!in_array($type, $tmpl_ids)) {
                    $change_state[] = $type;
                }
            }

            $res = [];
            if (current($tmpl_ids) === self::TABLE_ALL_OBJECTS_ACTION) {
                $types = $handler->getAvailableTypes(false);
                foreach ($types as $id => $type) {
                    $res[] = $id;
                }
                $handler->setInactiveTypes($res);
            } else {
                $handler->setInactiveTypes($change_state);
            }
            $inactive = array_merge($handler->getInactiveTypes(), $tmpl_ids);
            $handler->setInactiveTypes($inactive);

            $this->tpl->setOnScreenMessage('success', $lng->txt('settings_saved'), true);
        }
        $this->ctrl->redirect($this, 'listTypes');
    }


    //
    // images templates
    //

    protected function listImageTemplates(): void
    {
        $lng = $this->lng;
        $ilToolbar = $this->toolbar;
        $ilCtrl = $this->ctrl;

        $this->assertActive();
        $this->tabs_gui->setTabActive('imgtmpl');

        if ($this->checkPermissionBool('write')) {
            $ilToolbar->addButton(
                $lng->txt('badge_add_template'),
                $ilCtrl->getLinkTarget($this, 'addImageTemplate')
            );
        }

        $template_table = new ilBadgeImageTemplateTableGUI($this->access->checkAccess("write", "", $this->object->getRefId()));
        $template_table->renderTable();
    }


    protected function addImageTemplate(
        ?ilPropertyFormGUI $a_form = null
    ): void {
        $tpl = $this->tpl;

        $this->checkPermission('write');

        $this->assertActive();
        $this->tabs_gui->setTabActive('imgtmpl');

        if (!$a_form) {
            $a_form = $this->initImageTemplateForm('create');
        }

        $tpl->setContent($a_form->getHTML());
    }

    protected function initImageTemplateForm(
        string $a_mode
    ): ilPropertyFormGUI {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this, 'saveBadge'));
        $form->setTitle($lng->txt('badge_image_template_form'));

        $title = new ilTextInputGUI($lng->txt('title'), 'title');
        $title->setMaxLength(255);
        $title->setRequired(true);
        $form->addItem($title);

        $img = new ilImageFileInputGUI($lng->txt('image'), 'img');
        $img->setSuffixes(['png', 'svg']);
        if ($a_mode === 'create') {
            $img->setRequired(true);
        }
        $img->setUseCache(false);
        $img->setAllowDeletion(false);
        $form->addItem($img);

        $types_mode = new ilRadioGroupInputGUI($lng->txt('badge_template_types'), 'tmode');
        $types_mode->setRequired(true);
        $types_mode->setValue('all');
        $form->addItem($types_mode);

        $type_all = new ilRadioOption($lng->txt('badge_template_types_all'), 'all');
        $types_mode->addOption($type_all);

        $type_spec = new ilRadioOption($lng->txt('badge_template_types_specific'), 'spec');
        $types_mode->addOption($type_spec);

        $types = new ilCheckboxGroupInputGUI($lng->txt('badge_types'), 'type');
        $types->setRequired(true);
        $type_spec->addSubItem($types);

        foreach (ilBadgeHandler::getInstance()->getAvailableTypes(false) as $id => $type) {
            $types->addOption(new ilCheckboxOption($type->getCaption(), $id));
        }

        if ($a_mode === 'create') {
            $form->addCommandButton('saveImageTemplate', $lng->txt('save'));
        } else {
            $form->addCommandButton('updateImageTemplate', $lng->txt('save'));
        }
        $form->addCommandButton('listImageTemplates', $lng->txt('cancel'));

        return $form;
    }

    protected function saveImageTemplate(): void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $this->checkPermission('write');

        $form = $this->initImageTemplateForm('create');
        if ($form->checkInput()) {
            $tmpl = new ilBadgeImageTemplate();
            $tmpl->setTitle($form->getInput('title'));
            $tmpl->setTypes($form->getInput('type'));
            $tmpl->create();

            $tmpl->processImageUpload($tmpl);

            $this->tpl->setOnScreenMessage('success', $lng->txt('settings_saved'), true);
            $ilCtrl->redirect($this, 'listImageTemplates');
        }

        $form->setValuesByPost();
        $this->addImageTemplate($form);
    }

    protected function editImageTemplate(
        ?ilPropertyFormGUI $a_form = null
    ): void {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;

        $this->checkPermission('write');

        $this->assertActive();
        $this->tabs_gui->setTabActive('imgtmpl');

        $tmpl_ids = $this->badge_request->getMultiActionBadgeIdsFromUrl();
        if (count($tmpl_ids) !== 1) {
            $this->ctrl->redirect($this, 'listImageTemplates');
        }

        $template_id = (int) array_pop($tmpl_ids);
        $ilCtrl->setParameter($this, 'tid', $template_id);

        $tmpl = new ilBadgeImageTemplate($template_id);

        if (!$a_form) {
            $a_form = $this->initImageTemplateForm('edit');
            $this->setImageTemplateFormValues($a_form, $tmpl);
        }

        $tpl->setContent($a_form->getHTML());
    }

    protected function setImageTemplateFormValues(
        ilPropertyFormGUI $a_form,
        ilBadgeImageTemplate $a_tmpl
    ): void {
        $a_form->getItemByPostVar('title')->setValue($a_tmpl->getTitle());
        if ($a_tmpl->getImageRid() !== null) {
            $img = $a_tmpl->getImageFromResourceId();
            $a_form->getItemByPostVar('img')->setImage($img);
            $a_form->getItemByPostVar('img')->setValue($a_tmpl->getImageRid());
        } else {
            $a_form->getItemByPostVar('img')->setImage($a_tmpl->getImagePath());
            $a_form->getItemByPostVar('img')->setValue($a_tmpl->getImage());
        }

        if ($a_tmpl->getTypes()) {
            $a_form->getItemByPostVar('tmode')->setValue('spec');
            $a_form->getItemByPostVar('type')->setValue($a_tmpl->getTypes());
        } else {
            $a_form->getItemByPostVar('tmode')->setValue('all');
        }
    }

    protected function updateImageTemplate(): void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $this->checkPermission('write');

        $tmpl_id = $this->badge_request->getTemplateId();
        if (!$tmpl_id) {
            $ilCtrl->redirect($this, 'listImageTemplates');
        }

        $ilCtrl->setParameter($this, 'tid', $tmpl_id);

        $tmpl = new ilBadgeImageTemplate($tmpl_id);

        $form = $this->initImageTemplateForm('update');
        if ($form->checkInput()) {
            $tmpl->setTitle($form->getInput('title'));

            if ($form->getInput('tmode') !== 'all') {
                $tmpl->setTypes($form->getInput('type'));
            } else {
                $tmpl->setTypes(null);
            }

            $tmpl->update();

            $tmpl->processImageUpload($tmpl);

            $this->tpl->setOnScreenMessage('success', $lng->txt('settings_saved'), true);
            $ilCtrl->redirect($this, 'listImageTemplates');
        }

        $this->setImageTemplateFormValues($form, $tmpl);
        $form->setValuesByPost();
        $this->editImageTemplate($form);
    }

    protected function confirmDeleteImageTemplates(): void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;

        $this->checkPermission('write');

        $tmpl_ids = $this->badge_request->getBadgeAssignableUsers();
        if ($tmpl_ids === ['ALL_OBJECTS']) {
            $tmpl_ids = [];
            foreach (ilBadgeImageTemplate::getInstances() as $template) {
                $tmpl_ids[] = $template->getId();
            }
        }

        if (!$tmpl_ids) {
            $ilCtrl->redirect($this, 'listImageTemplates');
        }

        $ilTabs->clearTargets();
        $ilTabs->setBackTarget(
            $lng->txt('back'),
            $ilCtrl->getLinkTarget($this, 'listImageTemplates')
        );

        $confirmation_gui = new ilConfirmationGUI();
        $confirmation_gui->setFormAction($ilCtrl->getFormAction($this));
        $confirmation_gui->setHeaderText($lng->txt('badge_template_deletion_confirmation'));
        $confirmation_gui->setCancel($lng->txt('cancel'), 'listImageTemplates');
        $confirmation_gui->setConfirm($lng->txt('delete'), 'deleteImageTemplates');

        foreach ($tmpl_ids as $tmpl_id) {
            $tmpl = new ilBadgeImageTemplate($tmpl_id);
            $confirmation_gui->addItem('id[]', $tmpl_id, $tmpl->getTitle());
        }

        $tpl->setContent($confirmation_gui->getHTML());
    }

    protected function deleteImageTemplates(): void
    {
        $lng = $this->lng;
        $tmpl_ids = $this->badge_request->getIds();

        if ($this->checkPermissionBool('write') && count($tmpl_ids) > 0) {
            if (current($tmpl_ids) === self::TABLE_ALL_OBJECTS_ACTION) {
                $tmpl_ids = [];
                foreach (ilBadgeImageTemplate::getInstances() as $template) {
                    $tmpl_ids[] = $template->getId();
                }
            }
            foreach ($tmpl_ids as $tmpl_id) {
                $tmpl = new ilBadgeImageTemplate((int) $tmpl_id);
                $tmpl->delete();
            }
            $this->tpl->setOnScreenMessage('success', $lng->txt('badge_deletion'), true);
        } else {
            $this->tpl->setOnScreenMessage('failure', $lng->txt('badge_select_one'), true);
        }

        $this->ctrl->redirect($this, 'listImageTemplates');
    }


    //
    // object badges
    //

    protected function applyObjectFilter(): void
    {
        $this->listObjectBadges();
    }

    protected function resetObjectFilter(): void
    {
        $this->listObjectBadges();
    }

    protected function listObjectBadgeUsers(): void
    {
        $parent_obj_id = $this->badge_request->getParentId();
        if (!$parent_obj_id && $this->badge_request->getBadgeIdFromUrl()) {
            // In this case, we want't to list the users that have been awarded a specific badge
            $badge = new ilBadge($this->badge_request->getBadgeIdFromUrl());
            $parent_obj_id = $badge->getParentId();
        }
        if (!$parent_obj_id) {
            $this->ctrl->redirect($this, 'listObjectBadges');
        }

        $this->assertActive();

        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget(
            $this->lng->txt('back'),
            $this->ctrl->getLinkTarget($this, 'listObjectBadges')
        );

        $this->ctrl->saveParameter($this, 'pid');

        $tbl = new ilBadgeUserTableGUI(null, null, $parent_obj_id, $this->badge_request->getBadgeId());
        $tbl->renderTable();
    }

    protected function applylistObjectBadgeUsers(): void
    {
        $this->listObjectBadges();
    }

    protected function resetlistObjectBadgeUsers(): void
    {
        $this->listObjectBadges();
    }

    protected function listObjectBadges(): void
    {
        $this->assertActive();
        $this->tabs_gui->setTabActive('obj_badges');

        $tbl = new ilObjectBadgeTableGUI($this, $this->access->checkAccess("write", "", $this->object->getRefId()));
        $tbl->renderTable();
    }

    //
    // see ilBadgeManagementGUI
    //

    protected function getObjectBadgesFromMultiAction(): array
    {
        $ilAccess = $this->access;
        $ilCtrl = $this->ctrl;

        $badge_ids = $this->badge_request->getMultiActionBadgeIdsFromUrl();
        if (!$badge_ids ||
            !$ilAccess->checkAccess('write', '', $this->object->getRefId())) {
            $ilCtrl->redirect($this, 'listObjectBadges');
        }

        return $badge_ids;
    }

    protected function toggleObjectBadges(bool $a_status): void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $badge_ids = $this->getObjectBadgesFromMultiAction();
        if (current($badge_ids) === self::TABLE_ALL_OBJECTS_ACTION) {
            $filter = ['type' => '' , 'title' => '', 'object' => ''];
            $badge_ids = [];
            foreach (ilBadge::getObjectInstances($filter) as $badge_item) {
                $badge_ids[] = $badge_item['id'];
            }
            foreach ($badge_ids as $badge_id) {
                $badge = new ilBadge($badge_id);
                $badge->setActive($a_status);
                $badge->update();
            }
        } else {
            foreach ($badge_ids as $badge_id) {
                $badge = new ilBadge($badge_id);
                $badge->setActive($a_status);
                $badge->update();
            }
        }


        $this->tpl->setOnScreenMessage('success', $lng->txt('settings_saved'), true);
        $ilCtrl->redirect($this, 'listObjectBadges');
    }

    protected function activateObjectBadges(): void
    {
        $this->toggleObjectBadges(true);
    }

    protected function deactivateObjectBadges(): void
    {
        $this->toggleObjectBadges(false);
    }

    protected function confirmDeleteObjectBadges(): void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;

        $badge_ids = $this->badge_request->getMultiActionBadgeIdsFromUrl();

        $ilTabs->clearTargets();
        $ilTabs->setBackTarget(
            $lng->txt('back'),
            $ilCtrl->getLinkTarget($this, 'listObjectBadges')
        );

        $confirmation_gui = new ilConfirmationGUI();
        $confirmation_gui->setFormAction($ilCtrl->getFormAction($this));
        $confirmation_gui->setHeaderText($lng->txt('badge_deletion_confirmation'));
        $confirmation_gui->setCancel($lng->txt('cancel'), 'listObjectBadges');
        $confirmation_gui->setConfirm($lng->txt('delete'), 'deleteObjectBadges');

        if ($badge_ids === ['ALL_OBJECTS']) {
            $badge_ids = [];
            $filter = [
                'type' => '',
                'title' => '',
                'object' => ''
            ];
            foreach (ilBadge::getObjectInstances($filter) as $badge_item) {
                $badge_ids[] = $badge_item['id'];
            }
        }
        foreach ($badge_ids as $badge_id) {
            $badge = new ilBadge($badge_id);
            $parent = $badge->getParentMeta();

            $container = '(' . $parent['type'] . '/' .
                $parent['id'] . ') ' .
                $parent['title'];
            if ($parent['deleted']) {
                $container .= ' <span class="il_ItemAlertProperty">' . $lng->txt('deleted') . '</span>';
            }

            $confirmation_gui->addItem(
                'id[]',
                $badge_id,
                $container . ' - ' .
                $badge->getTitle() .
                ' (' . count(ilBadgeAssignment::getInstancesByBadgeId($badge_id)) . ')'
            );
        }

        $tpl->setContent($confirmation_gui->getHTML());
    }

    protected function deleteObjectBadges(): void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $badge_ids = $this->badge_request->getMultiActionBadgeIdsFromPost();

        foreach ($badge_ids as $badge_id) {
            $badge = new ilBadge($badge_id);
            $badge->delete();
        }

        $this->tpl->setOnScreenMessage('success', $lng->txt('settings_saved'), true);
        $ilCtrl->redirect($this, 'listObjectBadges');
    }

}