class.ilPCInteractiveImageGUI.php

Go to the documentation of this file.

<?php

use ILIAS\FileUpload\Location;
use ILIAS\FileUpload\FileUpload;
use ILIAS\FileUpload\Handler\BasicHandlerResult;
use ILIAS\FileUpload\DTO\UploadResult;
use ILIAS\FileUpload\Handler\HandlerResult;

class ilPCInteractiveImageGUI extends ilPageContentGUI
{
    protected \ILIAS\COPage\PC\InteractiveImage\IIMManager $iim_manager;
    protected \ILIAS\COPage\PC\InteractiveImage\GUIService $iim_gui;
    protected ilTabsGUI $tabs;
    protected ilToolbarGUI $toolbar;

    public function __construct(
        ilPageObject $a_pg_obj,
        ?ilPageContent $a_content_obj,
        string $a_hier_id,
        string $a_pc_id = ""
    ) {
        global $DIC;

        $this->tpl = $DIC["tpl"];
        $this->lng = $DIC->language();
        $this->tabs = $DIC->tabs();
        $this->ctrl = $DIC->ctrl();
        $this->toolbar = $DIC->toolbar();
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
        $this->iim_gui = $DIC->copage()->internal()->gui()->pc()->interactiveImage();
        $this->iim_manager = $DIC->copage()->internal()->domain()->pc()->interactiveImage();
    }

    public function executeCommand(): void
    {
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;

        // get next class that processes or forwards current command
        $next_class = $this->ctrl->getNextClass($this);

        // get current command
        $cmd = $this->ctrl->getCmd();

        if (is_object($this->content_obj)) {
            $tpl->setTitleIcon(ilUtil::getImagePath("standard/icon_mob.svg"));
            $this->getTabs();
        }

        switch ($next_class) {
            case strtolower(ilRepoStandardUploadHandlerGUI::class):
                $this->forwardFormToUploadHandler();
                break;

            default:
                $this->$cmd();
                break;
        }
    }

    protected function forwardFormToUploadHandler(): void
    {
        switch($this->request->getString("mode")) {
            case "overlayUpload":
                $form = $this->getOverlayUploadFormAdapter();
                $gui = $form->getRepoStandardUploadHandlerGUI("overlay_file");
                break;

            case "backgroundUpdate":
                $form = $this->getBackgroundPropertiesFormAdapter();
                $gui = $form->getRepoStandardUploadHandlerGUI("input_file");
                break;

            default:
                $form = $this->getImportFormAdapter();
                $gui = $form->getRepoStandardUploadHandlerGUI("input_file");
                break;
        }
        $this->ctrl->forwardCommand($gui);
    }

    public function getTabs(
        bool $a_create = false,
        bool $a_change_obj_ref = false
    ): void {
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;
        $lng = $this->lng;

        if (!$a_create) {
            $ilTabs->setBackTarget(
                $lng->txt("pg"),
                (string) $ilCtrl->getParentReturn($this)
            );
        }
    }

    public function insert(
        string $a_post_cmd = "edpost",
        string $a_submit_cmd = "create_mob",
        bool $a_input_error = false
    ): void {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $this->tpl->setOnScreenMessage('info', $lng->txt("cont_iim_create_info"));

        $form = $this->initForm("create");
        $form->setFormAction($ilCtrl->getFormAction($this));

        $this->displayValidationError();

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

    public function edit(): void
    {
        $ilCtrl = $this->ctrl;
        $ilCtrl->redirect($this, "editor");
    }

    public function editBaseImage(): void
    {
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
        $ilTabs->activateTab("edit_base_image");
        $form = $this->initForm();
        $tpl->setContent($form->getHTML());
    }


    public function initForm(string $a_mode = "edit"): ilPropertyFormGUI
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ti = null;

        $form = new ilPropertyFormGUI();

        // image file
        $fi = new ilImageFileInputGUI($lng->txt("cont_file"), "image_file");
        $fi->setAllowDeletion(false);
        if ($a_mode == "edit") {
            $fi->setImage($this->content_obj->getBaseThumbnailTarget());
        } else {
            $fi->setRequired(true);
        }
        $form->addItem($fi);

        if ($a_mode == "edit") {
            // caption
            $ti = new ilTextInputGUI($this->lng->txt("cont_caption"), "caption");
            $ti->setMaxLength(200);
            $ti->setSize(50);
            $form->addItem($ti);
        }

        // save and cancel commands
        if ($a_mode == "create") {
            $form->setTitle($lng->txt("cont_ed_insert_iim"));
            $form->addCommandButton("create_iim", $lng->txt("save"));
            $form->addCommandButton("cancelCreate", $lng->txt("cancel"));
        } else {
            // get caption
            $std_alias_item = new ilMediaAliasItem(
                $this->content_obj->getDomDoc(),
                $this->getHierId(),
                "Standard",
                $this->content_obj->getPCId(),
                "InteractiveImage"
            );
            $ti->setValue($std_alias_item->getCaption());

            $form->setTitle($lng->txt("cont_edit_base_image"));
            $form->addCommandButton("update", $lng->txt("save"));
        }

        $form->setFormAction($ilCtrl->getFormAction($this));

        return $form;
    }

    public function create(): void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;

        $form = $this->initForm("create");
        if (!$form->checkInput()) {
            $this->displayValidationError();
            $form->setValuesByPost();
            $tpl->setContent($form->getHTML());
            return;
        }

        $this->content_obj = new ilPCInteractiveImage($this->getPage());
        $this->content_obj->createMediaObject();
        $media_obj = $this->content_obj->getMediaObject();
        $media_obj->setTitle($_FILES['image_file']['name']);
        $media_obj->create();
        $mob_dir = ilObjMediaObject::_getDirectory($media_obj->getId());
        //              $media_obj->setStandardType("File");
        $media_obj->createDirectory();
        $media_item = new ilMediaItem();
        $media_obj->addMediaItem($media_item);
        $media_item->setPurpose("Standard");

        $file = $mob_dir . "/" . $_FILES['image_file']['name'];
        try {
            ilFileUtils::moveUploadedFile(
                $_FILES['image_file']['tmp_name'],
                $_FILES['image_file']['name'],
                $file
            );
        } catch (ilException $e) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("file_is_infected"), true);
            return;
        }
        // get mime type
        $format = ilObjMediaObject::getMimeType($file);
        $location = $_FILES['image_file']['name'];

        // set real meta and object data
        $media_item->setFormat($format);
        $media_item->setLocation($location);
        $media_item->setLocationType("LocalFile");

        ilFileUtils::renameExecutables($mob_dir);
        $media_obj->update();

        $this->content_obj->createAlias($this->pg_obj, $this->hier_id, $this->pc_id);
        $this->updated = $this->pg_obj->update();
        if ($this->updated === true) {
            $this->pg_obj->stripHierIDs();
            $this->pg_obj->addHierIDs();
            $ilCtrl->setParameter($this, "hier_id", $this->content_obj->readHierId());
            $ilCtrl->setParameter($this, "pc_id", $this->content_obj->readPCId());
            $this->content_obj->setHierId($this->content_obj->readHierId());
            $this->setHierId($this->content_obj->readHierId());
            $this->content_obj->setPcId($this->content_obj->readPCId());
            $this->tpl->setOnScreenMessage('success', $lng->txt("cont_saved_interactive_image"), true);
            $this->ctrl->redirectByClass("ilpcinteractiveimagegui", "edit");

            //$this->ctrl->returnToParent($this, "jump".$this->hier_id);
        } else {
            $this->insert();
        }
    }

    public function update(): void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $form = $this->initForm("edit");
        if ($form->checkInput()) {
            $mob = $this->content_obj->getMediaObject();
            $mob_dir = ilObjMediaObject::_getDirectory($mob->getId());
            $std_item = $mob->getMediaItem("Standard");
            $location = $_FILES['image_file']['name'];

            if ($location != "" && is_file($_FILES['image_file']['tmp_name'])) {
                $file = $mob_dir . "/" . $_FILES['image_file']['name'];
                ilFileUtils::moveUploadedFile(
                    $_FILES['image_file']['tmp_name'],
                    $_FILES['image_file']['name'],
                    $file
                );

                // get mime type
                $format = ilObjMediaObject::getMimeType($file);
                $location = $_FILES['image_file']['name'];
                $std_item->setFormat($format);
                $std_item->setLocation($location);
                $std_item->setLocationType("LocalFile");
                $mob->setDescription($format);
                $mob->update();
            }

            // set caption
            $std_alias_item = new ilMediaAliasItem(
                $this->content_obj->getDomDoc(),
                $this->getHierId(),
                "Standard",
                $this->content_obj->getPCId(),
                "InteractiveImage"
            );
            $std_alias_item->setCaption(
                $form->getInput("caption")
            );
            $this->edit_repo->setPageError($this->pg_obj->update());
            $this->tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
        }

        $ilCtrl->redirectByClass("ilpcinteractiveimagegui", "editBaseImage");
    }


    public function centerAlign(): void
    {
        $std_alias_item = new ilMediaAliasItem(
            $this->content_obj->getDomDoc(),
            $this->getHierId(),
            "Standard",
            $this->content_obj->getPCId(),
            "InteractiveImage"
        );
        $std_alias_item->setHorizontalAlign("Center");
        $this->updateAndReturn();
    }

    public function leftAlign(): void
    {
        $std_alias_item = new ilMediaAliasItem(
            $this->dom,
            $this->getHierId(),
            "Standard",
            $this->content_obj->getPCId(),
            "InteractiveImage"
        );
        $std_alias_item->setHorizontalAlign("Left");
        $this->updateAndReturn();
    }

    public function rightAlign(): void
    {
        $std_alias_item = new ilMediaAliasItem(
            $this->content_obj->getDomDoc(),
            $this->getHierId(),
            "Standard",
            $this->content_obj->getPCId(),
            "InteractiveImage"
        );
        $std_alias_item->setHorizontalAlign("Right");
        $this->updateAndReturn();
    }

    public function leftFloatAlign(): void
    {
        $std_alias_item = new ilMediaAliasItem(
            $this->content_obj->getDomDoc(),
            $this->getHierId(),
            "Standard",
            $this->content_obj->getPCId(),
            "InteractiveImage"
        );
        $std_alias_item->setHorizontalAlign("LeftFloat");
        $this->updateAndReturn();
    }

    public function rightFloatAlign(): void
    {
        $std_alias_item = new ilMediaAliasItem(
            $this->content_obj->getDomDoc(),
            $this->getHierId(),
            "Standard",
            $this->content_obj->getPCId(),
            "InteractiveImage"
        );
        $std_alias_item->setHorizontalAlign("RightFloat");
        $this->updateAndReturn();
    }


    public function listOverlayImages(): void
    {
        $tpl = $this->tpl;
        $ilToolbar = $this->toolbar;
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;
        $lng = $this->lng;

        $this->tpl->setOnScreenMessage('info', $lng->txt("cont_iim_overlay_info"));

        $ilTabs->setTabActive("list_overlays");

        $ilToolbar->addButton(
            $lng->txt("cont_add_images"),
            $ilCtrl->getLinkTarget($this, "addOverlayImages")
        );

        $tab = new ilPCIIMOverlaysTableGUI(
            $this,
            "listOverlayImages",
            $this->content_obj->getMediaObject()
        );
        $tpl->setContent($tab->getHTML());
    }

    public function addOverlayImages(ilPropertyFormGUI $a_form = null): void
    {
        $tpl = $this->tpl;

        if ($a_form) {
            $form = $a_form;
        } else {
            $form = $this->initAddOverlaysForm();
        }

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

    public function initAddOverlaysForm(): ilPropertyFormGUI
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;

        $ilTabs->setTabActive("list_overlays");

        $form = new ilPropertyFormGUI();
        $form->setTitle($lng->txt("cont_add_images"));
        $form->setFormAction($ilCtrl->getFormAction($this));

        // file input
        $fi = new ilFileWizardInputGUI($lng->txt("file"), "ovfile");
        $fi->setSuffixes(array("gif", "jpeg", "jpg", "png"));
        $fi->setFilenames(array(0 => ''));
        $fi->setRequired(true);
        $form->addItem($fi);

        $form->addCommandButton("uploadOverlayImages", $lng->txt("upload"));
        $form->addCommandButton("listOverlayImages", $lng->txt("cancel"));

        return $form;
    }

    public function uploadOverlayImages(): void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        $form = $this->initAddOverlaysForm();
        if ($form->checkInput()) {
            if (is_array($_FILES["ovfile"]["name"])) {
                foreach ($_FILES["ovfile"]["name"] as $k => $v) {
                    $name = $_FILES["ovfile"]["name"][$k];
                    $tmp_name = $_FILES["ovfile"]["tmp_name"][$k];

                    $this->content_obj->getMediaObject()->uploadAdditionalFile(
                        $name,
                        $tmp_name,
                        "overlays"
                    );
                    $piname = pathinfo($name);
                    $this->content_obj->getMediaObject()->makeThumbnail(
                        "overlays/" . $name,
                        basename($name, "." . $piname['extension']) . ".png"
                    );
                }
            }
            $this->tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"));
            $ilCtrl->redirect($this, "listOverlayImages");
        } else {
            $form->setValuesByPost();
            $this->addOverlayImages($form);
        }
    }

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

        $ilTabs->setTabActive("list_overlays");

        $files = $this->request->getStringArray("file");
        if (count($files) == 0) {
            $this->tpl->setOnScreenMessage('failure', $lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "listOverlayImages");
        } else {
            $cgui = new ilConfirmationGUI();
            $cgui->setFormAction($ilCtrl->getFormAction($this));
            $cgui->setHeaderText($lng->txt("cont_really_delete_overlays"));
            $cgui->setCancel($lng->txt("cancel"), "listOverlayImages");
            $cgui->setConfirm($lng->txt("delete"), "deleteOverlays");

            foreach ($files as $i => $d) {
                $cgui->addItem("file[]", $i, $i);
            }

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

    public function deleteOverlays(): void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $files = $this->request->getStringArray("file");
        if (count($files) > 0) {
            foreach ($files as $f) {
                $f = str_replace("..", "", ilUtil::stripSlashes($f));
                $this->content_obj->getMediaObject()
                    ->removeAdditionalFile("overlays/" . $f);
            }

            $this->tpl->setOnScreenMessage('success', $lng->txt("cont_overlays_have_been_deleted"), true);
        }
        $ilCtrl->redirect($this, "listOverlayImages");
    }



    public function listContentPopups(): void
    {
        $tpl = $this->tpl;
        $ilToolbar = $this->toolbar;
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;
        $lng = $this->lng;

        $this->tpl->setOnScreenMessage('info', $lng->txt("cont_iim_content_popups_info"));

        $ilTabs->setTabActive("content_popups");

        $ilToolbar->addButton(
            $lng->txt("cont_add_popup"),
            $ilCtrl->getLinkTarget($this, "addPopup")
        );

        $iim = $this->content_obj;
        $tab = new ilPCIIMPopupTableGUI(
            $this,
            "listContentPopups",
            $iim
        );
        $tpl->setContent($tab->getHTML());
    }

    public function addPopup(): void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $this->content_obj->addContentPopup();
        $this->pg_obj->update();
        $this->tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
        $ilCtrl->redirect($this, "listContentPopups");
    }

    public function savePopups(): void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $titles = $this->request->getStringArray("title");
        if (count($titles) > 0) {
            $this->content_obj->savePopups($titles);
            $this->pg_obj->update();
            $this->tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
        }
        $ilCtrl->redirect($this, "listContentPopups");
    }

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

        $ilTabs->setTabActive("content_popups");

        $tids = $this->request->getStringArray("tid");
        $titles = $this->request->getStringArray("title");

        if (count($tids) == 0) {
            $this->tpl->setOnScreenMessage('failure', $lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "listContentPopups");
        } else {
            $cgui = new ilConfirmationGUI();
            $cgui->setFormAction($ilCtrl->getFormAction($this));
            $cgui->setHeaderText($lng->txt("cont_really_delete_popups"));
            $cgui->setCancel($lng->txt("cancel"), "listContentPopups");
            $cgui->setConfirm($lng->txt("delete"), "deletePopups");

            foreach ($tids as $i => $d) {
                $cgui->addItem("tid[]", $i, $titles[$i]);
            }

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

    public function deletePopups(): void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        $tids = $this->request->getStringArray("tid");

        if (count($tids) > 0) {
            foreach ($tids as $id) {
                $id = explode(":", $id);
                $this->content_obj->deletePopup($id[0], $id[1]);
            }
            $this->pg_obj->update();
            $this->tpl->setOnScreenMessage('success', $lng->txt("cont_popups_have_been_deleted"), true);
        }
        $ilCtrl->redirect($this, "listContentPopups");
    }

    public function getImportFormAdapter(): \ILIAS\Repository\Form\FormAdapterGUI
    {
        $this->ctrl->setParameter($this, "cname", "InteractiveImage");
        $form = $this->gui->form([self::class], "#")
                          ->async()
            ->section("f", $this->lng->txt("cont_ed_insert_iim"))
                          ->file(
                              "input_file",
                              $this->lng->txt("file"),
                              \Closure::fromCallable([$this, 'handleUploadResult']),
                              "mob_id",
                              "",
                              1,
                              [],
                              [self::class],
                              "copg"
                          )->required();
        return $form;
    }

    public function handleUploadResult(
        FileUpload $upload,
        UploadResult $result
    ): BasicHandlerResult {
        return $this->iim_manager->handleUploadResult($upload, $result);
    }

    public function editor(): void
    {
        $ilTabs = $this->tabs;
        $ilTabs->activateTab("editor");
        $this->tpl->addCss(ilObjStyleSheet::getBaseContentStylePath());
        $this->tpl->setContent($this->iim_gui->editorInit()->getInitHtml());
        $this->initInteractiveImageEditor();
    }

    protected function initInteractiveImageEditor(): void
    {
        $this->setEditorToolContext();
        $this->iim_gui->editorInit()->initUI($this->tpl);
    }

    public function getOverlayUploadFormAdapter(array $path = null): \ILIAS\Repository\Form\FormAdapterGUI
    {
        if (is_null($path)) {
            $path = [self::class];
        }

        $f = $this->gui->form($path, "#")
                       ->async()
                       ->file(
                           "overlay_file",
                           $this->lng->txt("file"),
                           \Closure::fromCallable([$this, 'handleOverlayUpload']),
                           "mob_id",
                           "",
                           1,
                           ["image/png", "image/jpeg", "image/gif"],
                           $path,
                           "copg"
                       );
        return $f;
    }


    public function handleOverlayUpload(
        FileUpload $upload,
        UploadResult $result
    ): BasicHandlerResult {
        return $this->iim_manager->handleOverlayUpload(
            $this->content_obj->getMediaObject(),
            $upload,
            $result
        );
    }

    public function getPopupFormAdapter(): \ILIAS\Repository\Form\FormAdapterGUI
    {
        $f = $this->gui->form(null, "#")
                       ->text(
                           "title",
                           $this->lng->txt("title")
                       );
        return $f;
    }

    public function getBackgroundPropertiesFormAdapter(array $path = null): \ILIAS\Repository\Form\FormAdapterGUI
    {
        if (is_null($path)) {
            $path = [self::class];
        }

        $f = $this->gui->form($path, "#")
                       ->async()
                       ->file(
                           "input_file",
                           $this->lng->txt("file"),
                           \Closure::fromCallable([$this, 'handleBackgroundUpload']),
                           "mob_id",
                           "",
                           1,
                           ["image/png", "image/jpeg", "image/gif"],
                           $path,
                           "copg"
                       )->text(
                           "caption",
                           $this->lng->txt("cont_caption")
                       );
        return $f;
    }


    public function handleBackgroundUpload(
        FileUpload $upload,
        UploadResult $result
    ): BasicHandlerResult {
        $this->log->debug(">>>");
        $this->log->debug("Start upload");
        $this->log->debug($this->content_obj->getMediaObject()->getId());
        return $this->iim_manager->handleUploadResult(
            $upload,
            $result,
            $this->content_obj->getMediaObject()
        );
    }

}