class.ilObjMediaCastGUI.php

Go to the documentation of this file.

<?php
 
use ILIAS\MediaCast\StandardGUIRequest;
use ILIAS\FileUpload\MimeType;
use ILIAS\Filesystem\Exception\FileNotFoundException;
use ILIAS\Filesystem\Exception\IOException;
use ILIAS\Filesystem\Filesystem;
use ILIAS\Filesystem\Util\LegacyPathHelper;
use ILIAS\MediaCast\Settings\SettingsGUI;
 
class ilObjMediaCastGUI extends ilObjectGUI
{
    protected \ILIAS\MediaObjects\Player\GUIService $mob_player_gui;
    protected \ILIAS\MediaObjects\MediaType\MediaTypeManager $media_type;
    protected \ILIAS\MediaCast\InternalGUIService $gui;
    protected $video_gui;
    protected \ILIAS\MediaCast\MediaCastManager $mc_manager;
    protected ilPropertyFormGUI $form_gui;
    protected ilNewsItem $mcst_item;
    protected StandardGUIRequest $mc_request;
    protected ilTabsGUI $tabs;
    protected ilLogger $log;
    protected ilHelpGUI $help;
    private array $additionalPurposes = [];
    protected FileSystem $filesystem;
 
    public function __construct(
        $a_data,
        int $a_id,
        bool $a_call_by_reference,
        bool $a_prepare_output = true
    ) {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->tabs = $DIC->tabs();
        $this->tpl = $DIC["tpl"];
        $this->access = $DIC->access();
        $this->toolbar = $DIC->toolbar();
        $this->filesystem = $DIC->filesystem()->web();
        $this->log = $DIC["ilLog"];
        $this->help = $DIC["ilHelp"];
        $this->locator = $DIC["ilLocator"];
        $ilCtrl = $DIC->ctrl();
        $lng = $DIC->language();
        $this->mc_request = $DIC->mediaCast()
            ->internal()
            ->gui()
            ->standardRequest();
 
        $this->type = "mcst";
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
        $lng->loadLanguageModule("mcst");
        $lng->loadLanguageModule("news");
        $lng->loadLanguageModule("rep");
 
        $ilCtrl->saveParameter($this, "item_id");
 
        $settings = ilMediaCastSettings::_getInstance();
 
        if ($this->object) {
            $this->mc_manager = $DIC->mediaCast()->internal()
                                    ->domain()->mediaCast($this->object);
        }
        $this->gui = $DIC->mediaCast()->internal()->gui();
        $this->media_type = $DIC->mediaObjects()->internal()->domain()->mediaType();
        $this->video_gui = $DIC->mediaObjects()->internal()->gui()->video();
        $this->mob_player_gui = $DIC->mediaObjects()->internal()->gui()->player();
    }
 
    public function executeCommand(): void
    {
        $ilUser = $this->user;
        $ilTabs = $this->tabs;
 
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
        $this->prepareOutput();
 
        switch ($next_class) {
            case "ilmediacreationgui":
                $this->checkPermission('write');
 
                $this->ctrl->setReturn($this, "listItems");
                $ilTabs->activateTab("content");
                $this->addContentSubTabs("manage");
                $med_type = [];
                switch ($this->object->getViewMode()) {
                    case ilObjMediaCast::VIEW_VCAST:
                        $med_type = [ilMediaCreationGUI::TYPE_VIDEO];
                        break;
                    case ilObjMediaCast::VIEW_IMG_GALLERY:
                        $med_type = [ilMediaCreationGUI::TYPE_IMAGE];
                        break;
                    case ilObjMediaCast::VIEW_PODCAST:
                        $med_type = [ilMediaCreationGUI::TYPE_AUDIO];
                        break;
                }
                $creation = new ilMediaCreationGUI($med_type, function ($mob_id) {
                    $this->afterUpload($mob_id);
                }, function ($mob_id, $long_desc) {
                    $this->afterUrlSaving($mob_id, $long_desc);
                }, function ($mob_ids) {
                    $this->afterPoolInsert($mob_ids);
                }, function ($mob_id) {
                    $this->finishSingleUpload($mob_id);
                }, function ($mob_id) {
                    $this->onMobUpdate($mob_id);
                });
                $this->ctrl->forwardCommand($creation);
                break;
 
            case "ilinfoscreengui":
                if (!$this->checkPermissionBool("read")) {
                    $this->checkPermission("visible");
                }
                $this->infoScreen();    // forwards command
                break;
 
            case "ilexportgui":
                //                              $this->prepareOutput();
                $ilTabs->activateTab("export");
                $exp_gui = new ilExportGUI($this);
                $exp_gui->addFormat("xml");
                $ret = $this->ctrl->forwardCommand($exp_gui);
                //                              $this->tpl->show();
                break;
 
            case 'ilpermissiongui':
                $ilTabs->activateTab("id_permissions");
                $perm_gui = new ilPermissionGUI($this);
                $ret = $this->ctrl->forwardCommand($perm_gui);
                break;
 
            case 'ilobjectcopygui':
                $cp = new ilObjectCopyGUI($this);
                $cp->setType('mcst');
                $this->ctrl->forwardCommand($cp);
                break;
 
            case "ilcommonactiondispatchergui":
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;
 
            case "illearningprogressgui":
                $ilTabs->activateTab('learning_progress');
                $new_gui = new ilLearningProgressGUI(
                    ilLearningProgressBaseGUI::LP_CONTEXT_REPOSITORY,
                    $this->object->getRefId(),
                    $this->mc_request->getUserId() ?: $ilUser->getId()
                );
                $this->ctrl->forwardCommand($new_gui);
                $this->tabs_gui->setTabActive('learning_progress');
                break;
 
            case "mcstimagegallerygui":
                $view = new \McstImageGalleryGUI($this->object, $this->tpl, $this->getFeedLink());
                $this->ctrl->forwardCommand($view);
                break;
 
            case "mcstpodcastgui":
                $view = new \McstPodcastGUI($this->object, $this->tpl, $this->getFeedLink());
                $this->ctrl->forwardCommand($view);
                break;
 
            case strtolower(ilCommentGUI::class):
                $this->ctrl->forwardCommand($this->getCommentGUI());
                break;
 
            case strtolower(ilObjectMetaDataGUI::class):
                $this->checkPermission("write");
                $ilTabs->activateTab("meta_data");
                $gui = new ilObjectMetaDataGUI($this->object);
                $this->ctrl->forwardCommand($gui);
                break;
 
            case strtolower(SettingsGUI::class):
                $this->checkPermission("write");
                $ilTabs->activateTab("id_settings");
                $gui = $this->gui->settings()->settingsGUI(
                    $this->object->getId(),
                    $this->object->getRefId()
                );
                $this->ctrl->forwardCommand($gui);
                break;
 
            default:
                if (!$cmd) {
                    $cmd = "infoScreen";
                }
                $cmd .= "Object";
                if ($cmd != "infoScreenObject") {
                    $this->checkPermission("read");
                } else {
                    $this->checkPermission("visible");
                }
                $this->$cmd();
 
                break;
        }
        $this->addHeaderAction();
    }
 
    public function editObject(): void
    {
        if (!$this->checkPermissionBool("write")) {
            $this->error->raiseError($this->lng->txt("msg_no_perm_write"), $this->error->MESSAGE);
        }
 
        $this->ctrl->redirectByClass(SettingsGUI::class, "");
    }
 
 
    protected function afterSave(ilObject $new_object): void
    {
        // always send a message
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("object_added"), true);
        ilUtil::redirect("ilias.php?baseClass=ilMediaCastHandlerGUI&ref_id=" . $new_object->getRefId() . "&cmd=editSettings");
    }
 
    public function listItemsObject(bool $a_presentation_mode = false): void
    {
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilAccess = $this->access;
        $ilToolbar = $this->toolbar;
 
        $this->checkPermission("write");
 
        if ($a_presentation_mode) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("mcst_view_abandoned"));
            return;
        }
 
        if ($a_presentation_mode) {
            $this->addContentSubTabs("content");
        } else {
            $this->addContentSubTabs("manage");
        }
 
        $med_items = $this->object->getSortedItemsArray();
 
        if ($a_presentation_mode) {
            $table_gui = new ilMediaCastTableGUI($this, "showContent", false, true);
        } else {
            $table_gui = new ilMediaCastTableGUI($this, "listItems");
        }
 
        $table_gui->setData($med_items);
 
        if ($ilAccess->checkAccess("write", "", $this->requested_ref_id) && !$a_presentation_mode) {
            if (in_array($this->object->getViewMode(), [
                ilObjMediaCast::VIEW_VCAST,
                ilObjMediaCast::VIEW_IMG_GALLERY,
                ilObjMediaCast::VIEW_PODCAST
            ], true)) {
                $ilToolbar->addButton($lng->txt("add"), $this->ctrl->getLinkTargetByClass("ilMediaCreationGUI", ""));
            } else {
                $ilToolbar->addButton($lng->txt("add"), $this->ctrl->getLinkTarget($this, "addCastItem"));
            }
 
            $table_gui->addMultiCommand("confirmDeletionItems", $lng->txt("delete"));
            $table_gui->setSelectAllCheckbox("item_id");
        }
 
        $new_table = $this->getManageTableGUI();
 
        $script = <<<EOT
<script>
    window.addEventListener('load', (event) => {
        $(document).on('hidden.bs.modal', (e) => {
            $('.modal-body').html('');
        }); 
        $(document).on('shown.bs.modal', (e) => {
            window.dispatchEvent(new Event('resize'));
        });
    });
</script>
EOT;
        $tpl->setContent($this->gui->ui()->renderer()->render($new_table->get()) . $script);
    }
 
    public function tableCommandObject(): void
    {
        $new_table = $this->getManageTableGUI();
        $new_table->handleCommand();
    }
 
    protected function getManageTableGUI(): ilMediaCastManageTableGUI
    {
        return $this->gui->getMediaCastManageTableGUI($this, "tableCommand");
    }
 
    public function getFeedLink(): string
    {
        $public_feed = ilBlockSetting::_lookup(
            "news",
            "public_feed",
            0,
            $this->object->getId()
        );
        $url = "";
        // rss icon/link
        if ($public_feed) {
            $news_set = new ilSetting("news");
            $enable_internal_rss = $news_set->get("enable_rss_for_internal");
            if ($enable_internal_rss) {
                $url = ILIAS_HTTP_PATH . "/feed.php?client_id=" . rawurlencode(CLIENT_ID) . "&" . "ref_id=" . $this->requested_ref_id;
            }
        }
        return $url;
    }
 
    public function addCastItemObject(): void
    {
        $tpl = $this->tpl;
 
        $this->checkPermission("write");
 
        $this->initAddCastItemForm();
        $tpl->setContent($this->form_gui->getHTML());
    }
 
    public function editCastItemObject(): void
    {
        $item_id = $this->mc_request->getItemId();
        $this->ctrl->setParameterByClass(self::class, "item_id", $item_id);
 
        $tpl = $this->tpl;
        $ilToolbar = $this->toolbar;
        $ilCtrl = $this->ctrl;
 
        $this->checkPermission("write");
 
        $this->mcst_item = new ilNewsItem(
            $this->mc_request->getItemId()
        );
 
        // conversion toolbar
        $this->video_gui->addPreviewExtractionToToolbar(
            $this->mcst_item->getMobId(),
            self::class
        );
 
        $this->initAddCastItemForm("edit");
        $this->getCastItemValues($item_id);
        $tpl->setContent($this->form_gui->getHTML());
    }
 
    public function finishSingleUpload(int $mob_id): void
    {
        foreach ($this->object->getSortedItemsArray() as $item) {
            if ($mob_id == $item["mob_id"]) {
                $this->ctrl->setParameter($this, "item_id", $item["id"]);
                $this->ctrl->redirect($this, "editCastItem");
            }
        }
        $this->ctrl->redirect($this, "listItems");
    }
 
    protected function onMobUpdate(int $mob_id): void
    {
        foreach ($this->object->getSortedItemsArray() as $item) {
            if ($mob_id == $item["mob_id"]) {
                $mob = new ilObjMediaObject($item["mob_id"]);
                $mc_item = new ilNewsItem($item["id"]);
                $mc_item->setTitle($mob->getTitle());
                $mc_item->setContent($mob->getLongDescription());
                $mc_item->update();
            }
        }
    }
 
    public function initAddCastItemForm(string $a_mode = "create"): void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;
 
        $this->checkPermission("write");
        $ilTabs->activateTab("edit_content");
 
        $lng->loadLanguageModule("mcst");
 
        $news_set = new ilSetting("news");
        $enable_internal_rss = $news_set->get("enable_rss_for_internal");
 
        $this->form_gui = new ilPropertyFormGUI();
        $this->form_gui->setMultipart(true);
 
        // Property Title
        $text_input = new ilTextInputGUI($lng->txt("title"), "title");
        $text_input->setMaxLength(200);
        $this->form_gui->addItem($text_input);
 
        // Property Content
        $text_area = new ilTextAreaInputGUI($lng->txt("description"), "description");
        $text_area->setRequired(false);
        $this->form_gui->addItem($text_area);
 
        // Property Visibility
        if ($enable_internal_rss) {
            $radio_group = new ilRadioGroupInputGUI($lng->txt("access_scope"), "visibility");
            $radio_option = new ilRadioOption($lng->txt("access_users"), "users");
            $radio_group->addOption($radio_option);
            $radio_option = new ilRadioOption($lng->txt("access_public"), "public");
            $radio_group->addOption($radio_option);
            $radio_group->setInfo($lng->txt("mcst_visibility_info"));
            $radio_group->setRequired(true);
            $radio_group->setValue($this->object->getDefaultAccess() == 0 ? "users" : "public");
            $this->form_gui->addItem($radio_group);
        }
 
        // Duration
        if ($this->getObject()->getViewMode() !== ilObjMediaCast::VIEW_IMG_GALLERY) {
            $dur = new ilDurationInputGUI($lng->txt("mcst_duration"), "duration");
            $dur->setInfo($lng->txt("mcst_duration_info"));
            $dur->setShowDays(false);
            $dur->setShowHours(true);
            $dur->setShowSeconds(true);
            $this->form_gui->addItem($dur);
        }
 
        foreach (ilObjMediaCast::$purposes as $purpose) {
            if ($purpose == "VideoAlternative" &&
                $a_mode == "create") {
                continue;
            }
 
            $section = new ilFormSectionHeaderGUI();
            $section->setTitle($lng->txt("mcst_" . strtolower($purpose) . "_title"));
            $this->form_gui->addItem($section);
            if ($a_mode != "create") {
                $value = new ilHiddenInputGUI("value_" . $purpose);
                $label = new ilNonEditableValueGUI($lng->txt("value"));
                $label->setPostVar("label_value_" . $purpose);
                $label->setInfo($lng->txt("mcst_current_value_info"));
                $this->form_gui->addItem($label);
                $this->form_gui->addItem($value);
            }
            $file = new ilFileInputGUI($lng->txt("file"), "file_" . $purpose);
            $file->setSuffixes($this->mc_manager->getSuffixesForViewMode(
                $this->object->getViewMode()
            ));
            $this->form_gui->addItem($file);
            $text_input = new ilRegExpInputGUI($lng->txt("url"), "url_" . $purpose);
            $text_input->setPattern("/https?\:\/\/.+/i");
            $text_input->setInfo($lng->txt("mcst_reference_info"));
            $this->form_gui->addItem($text_input);
            if ($purpose != "Standard") {
                $clearCheckBox = new ilCheckboxInputGUI();
                $clearCheckBox->setPostVar("delete_" . $purpose);
                $clearCheckBox->setTitle($lng->txt("mcst_clear_purpose_title"));
                $this->form_gui->addItem($clearCheckBox);
            } else {
                //
                $ne = new ilNonEditableValueGUI($lng->txt("mcst_mimetype"), "mimetype_" . $purpose);
                $this->form_gui->addItem($ne);
 
                // preview picure
                $mob_id = 0;
                if ($a_mode !== "create") {
                    $mcst_item = new ilNewsItem($this->mc_request->getItemId());
                    $mob_id = $mcst_item->getMobId();
                }
                $this->video_gui->addPreviewInput($this->form_gui, $mob_id);
            }
        }
 
        // save/cancel button
        if ($a_mode == "create") {
            $this->form_gui->setTitle($lng->txt("mcst_add_new_item"));
            $this->form_gui->addCommandButton("saveCastItem", $lng->txt("save"));
        } else {
            $this->form_gui->setTitle($lng->txt("mcst_edit_item"));
            $this->form_gui->addCommandButton("updateCastItem", $lng->txt("save"));
        }
        $this->form_gui->addCommandButton("listItems", $lng->txt("cancel"));
        $this->form_gui->setFormAction($ilCtrl->getFormAction($this, "saveCastItem"));
    }
 
    public function getCastItemValues(int $item_id): void
    {
        $lng = $this->lng;
 
        // get mob
        $this->mcst_item = new ilNewsItem(
            $item_id
        );
        $mob = new ilObjMediaObject($this->mcst_item->getMobId());
 
        $values = array();
        $mediaItems = $this->getMediaItems(
            $this->mc_request->getItemId()
        );
        if (count($mediaItems) > 0) {
            foreach ($mediaItems as $med) {
                if (!isset($values["title"])) {
                    // first item, so set title, description, ...
                    $values["title"] = $this->mcst_item->getTitle();
                    $values["description"] = $this->mcst_item->getContent();
                    $values["visibility"] = $this->mcst_item->getVisibility();
                    $length = explode(":", $this->mcst_item->getPlaytime());
                    $values["duration"] = array("hh" => $length[0], "mm" => $length[1], "ss" => $length[2]);
                }
 
                $values["value_" . $med->getPurpose()] = (strlen($med->getLocation()) > 100) ? "..." . substr($med->getLocation(), strlen($med->getLocation()) - 100) : $med->getLocation();
                $values["label_value_" . $med->getPurpose()] = (strlen($med->getLocation()) > 100) ? "..." . substr($med->getLocation(), strlen($med->getLocation()) - 100) : $med->getLocation();
                $values["mimetype_" . $med->getPurpose()] = $med->getFormat();
            }
        }
        foreach (ilObjMediaCast::$purposes as $purpose) {
            if (!isset($values["value_" . $purpose])) {
                $values["label_value_" . $purpose] = $lng->txt("none");
                $values["value_" . $purpose] = $lng->txt("none");
            }
        }
        $this->form_gui->setValuesByArray($values);
    }
 
    public function saveCastItemObject(): void
    {
        return;
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
        $lng = $this->lng;
        $ilTabs = $this->tabs;
 
        $this->checkPermission("write");
        $ilTabs->activateTab("edit_content");
 
        $this->initAddCastItemForm();
 
        if (!$this->form_gui->checkInput() ||
            ($this->form_gui->getInput("url_Standard") == "" && !$_FILES['file_Standard']['tmp_name'])) {
            $this->tpl->setOnScreenMessage('failure', $lng->txt("mcst_input_either_file_or_url"));
            $this->populateFormFromPost();
        } else {
            // create dummy object in db (we need an id)
            $mob = new ilObjMediaObject();
            $mob->create();
 
            //handle standard purpose
            $file = $this->createMediaItemForPurpose($mob, "Standard");
 
            // set title and description
            // set title to basename of file if left empty
            $title = $this->form_gui->getInput("title") != "" ? $this->form_gui->getInput("title") : basename($file);
            $description = $this->form_gui->getInput("description");
            $mob->setTitle($title);
            $mob->setDescription($description);
 
            // save preview pic
            $this->video_gui->savePreviewInput($this->form_gui, $mob->getId());
 
            // determine duration for standard purpose
            $duration = $this->getDuration($file);
 
            // handle other purposes
            foreach ($this->additionalPurposes as $purpose) {
                // check if some purpose has been uploaded
                $file_gui = $this->form_gui->getInput("file_" . $purpose);
                $url_gui = $this->form_gui->getInput("url_" . $purpose);
                if ($url_gui || $file_gui["size"] > 0) {
                    $this->createMediaItemForPurpose($mob, $purpose);
                }
            }
 
            $mob->update();
 
            if ($prevpic["size"] == 0) {
                // re-read media object
                $mob = new ilObjMediaObject($mob->getId());
                $mob->generatePreviewPic(320, 240);
            }
 
            //
            // @todo: save usage
            //
 
            $news_set = new ilSetting("news");
            $enable_internal_rss = $news_set->get("enable_rss_for_internal");
 
            // create new media cast item
            $mc_item = new ilNewsItem();
            $mc_item->setMobId($mob->getId());
            $mc_item->setContentType(NEWS_AUDIO);
            $mc_item->setContextObjId($this->object->getId());
            $mc_item->setContextObjType($this->object->getType());
            $mc_item->setUserId($ilUser->getId());
            $mc_item->setPlaytime($duration);
            $mc_item->setTitle($title);
            $mc_item->setContent($description);
            $mc_item->setLimitation(false);
            if ($enable_internal_rss) {
                $mc_item->setVisibility($this->form_gui->getInput("visibility"));
            } else {
                $mc_item->setVisibility("users");
            }
            $mc_item->create();
 
            $ilCtrl->redirect($this, "listItems");
        }
    }
 
    private function getDuration(ilMediaItem $media_item): string
    {
        $duration = isset($this->form_gui)
            ? $this->form_gui->getInput("duration")
            : array("hh" => 0, "mm" => 0, "ss" => 0);
 
        $duration_str = str_pad($duration["hh"], 2, "0", STR_PAD_LEFT) . ":" .
            str_pad($duration["mm"], 2, "0", STR_PAD_LEFT) . ":" .
            str_pad($duration["ss"], 2, "0", STR_PAD_LEFT);
 
        if ($duration["hh"] == 0 && $duration["mm"] == 0 && $duration["ss"] == 0) {
            $media_item->determineDuration();
            $d = $media_item->getDuration();
            if ($d > 0) {
                $duration_str = $this->object->getPlaytimeForSeconds($d);
            }
        }
 
        return $duration_str;
    }
 
    private function createMediaItemForPurpose(
        ilObjMediaObject $mob,
        string $purpose
    ): string {
        $mediaItem = new ilMediaItem();
        $mob->addMediaItem($mediaItem);
        $mediaItem->setPurpose($purpose);
        return $this->updateMediaItem($mob, $mediaItem);
    }
 
    private function updateMediaItem(
        ilObjMediaObject $mob,
        ilMediaItem $mediaItem
    ): string {
        $locationType = "";
        $location = "";
        $file = "";
        $purpose = $mediaItem->getPurpose();
        $locationType = $mediaItem->getLocationType();
        $url_gui = $this->form_gui->getInput("url_" . $purpose);
        $file_gui = $this->form_gui->getInput("file_" . $purpose);
        if ($url_gui) {
            // http
            $file = $this->form_gui->getInput("url_" . $purpose);
            $title = basename($file);
            $location = $this->form_gui->getInput("url_" . $purpose);
            $locationType = "Reference";
        } elseif ($file_gui["size"] > 0) {
            // lokal
            // determine and create mob directory, move uploaded file to directory
            $mob_dir = ilObjMediaObject::_getDirectory($mob->getId());
            if (!is_dir($mob_dir)) {
                $mob->createDirectory();
            } else {
                $dir = LegacyPathHelper::createRelativePath($mob_dir);
                $old_files = $this->filesystem->finder()->in([$dir])->exclude([$dir . '/mob_vpreview.png'])->files();
                foreach ($old_files as $file) {
                    $this->filesystem->delete($file->getPath());
                }
            }
 
            $file_name = ilFileUtils::getASCIIFilename($_FILES['file_' . $purpose]['name']);
            $file_name = str_replace(" ", "_", $file_name);
 
            $file = $mob_dir . "/" . $file_name;
            $title = $file_name;
            $locationType = "LocalFile";
            $location = $title;
            ilFileUtils::moveUploadedFile($_FILES['file_' . $purpose]['tmp_name'], $file_name, $file);
            ilFileUtils::renameExecutables($mob_dir);
        }
 
        // check if not automatic mimetype detection
        $format = ilObjMediaObject::getMimeType($mediaItem->getLocation(), ($locationType === "Reference"));
        $mediaItem->setFormat($format);
 
        if ($file != "") {
            // get mime type, if not already set!
            if ($format === "") {
                $format = ilObjMediaObject::getMimeType($file, ($locationType === "Reference"));
            }
 
            // set real meta and object data
            $mediaItem->setFormat($format);
            $mediaItem->setLocation($location);
            $mediaItem->setLocationType($locationType);
            $mediaItem->setHAlign("Left");
            $mediaItem->setHeight(self::isAudio($format) ? 0 : 180);
            $mob->generatePreviewPic(320, 240);
        }
 
        if (($purpose === "Standard") && isset($title)) {
            $mob->setTitle($title);
        }
 
        return $file;
    }
 
    public function updateCastItemObject(): void
    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
        $ilLog = $this->log;
        $title = "";
        $description = "";
        $file = null;
 
        $this->checkPermission("write");
 
        $this->initAddCastItemForm("edit");
 
        if ($this->form_gui->checkInput()) {
            // create new media cast item
            $mc_item = new ilNewsItem(
                $this->mc_request->getItemId()
            );
            $mob_id = $mc_item->getMobId();
 
            // create dummy object in db (we need an id)
            $mob = new ilObjMediaObject($mob_id);
 
 
            foreach (ilObjMediaCast::$purposes as $purpose) {
                if ($this->form_gui->getInput("delete_" . $purpose)) {
                    $mob->removeMediaItem($purpose);
                    $ilLog->write("Mcst: deleting purpose $purpose");
                    continue;
                }
                $media_item = $mob->getMediaItem($purpose);
                $url_gui = $this->form_gui->getInput("url_" . $purpose);
                $file_gui = $this->form_gui->getInput("file_" . $purpose);
 
                if ($media_item == null) {
                    if ($purpose != "Standard" &&
                       ($url_gui || $file_gui["size"] > 0)) {
                        // check if we added an additional purpose when updating
                        // either by url or by file
                        $file = $this->createMediaItemForPurpose($mob, $purpose);
                    }
                } else {
                    $file = $this->updateMediaItem($mob, $media_item);
                }
 
                if ($purpose == "Standard") {
                    if ($this->getObject()->getViewMode() !== ilObjMediaCast::VIEW_IMG_GALLERY) {
                        $duration = $this->getDuration($media_item);
                    }
                    $title = $this->form_gui->getInput("title") != "" ? $this->form_gui->getInput("title") : basename($file);
                    $description = $this->form_gui->getInput("description");
 
                    $mob->setTitle($title);
                    $mob->setDescription($description);
 
                    $this->video_gui->savePreviewInput($this->form_gui, $mob->getId());
                }
            }
 
            // set real meta and object data
            $mob->update();
 
            //
            // @todo: save usage
            //
 
            $news_set = new ilSetting("news");
            $enable_internal_rss = $news_set->get("enable_rss_for_internal");
 
            $mc_item->setUserId($ilUser->getId());
            if (isset($duration)) {
                $mc_item->setPlaytime($duration);
                $dur_arr = explode(":", $duration);
                $seconds = ((int) $dur_arr[0] * 60 * 60) + ((int) $dur_arr[1] * 60) + ((int) $dur_arr[2]);
                $st_med = $mob->getMediaItem("Standard");
                $st_med->setDuration($seconds);
                $st_med->update();
            }
            $mc_item->setTitle($title);
            $mc_item->setContent($description);
            if ($enable_internal_rss) {
                $mc_item->setVisibility($this->form_gui->getInput("visibility"));
            }
            $mc_item->update();
 
            $ilCtrl->redirect($this, "listItems");
        } else {
            $this->populateFormFromPost();
        }
    }
 
    public function showCastItemObject(): void
    {
        $f = $this->gui->ui()->factory();
        $item_id = $this->mc_request->getItemId();
        $news = new ilNewsItem($item_id);
        $mob = new ilObjMediaObject($news->getMobId());
        $med = $mob->getMediaItem("Standard");
        $comp = null;
        if ($med) {
            $file = $mob->getStandardSrc();
            if ($this->media_type->isAudio($med->getFormat())) {
                $comp = $f->player()->audio($file, "");
            } elseif ($this->media_type->isVideo($med->getFormat())) {
                $comp = $f->player()->video($file);
            } elseif ($this->media_type->isImage($med->getFormat())) {
                $comp = $f->image()->responsive($file, $mob->getTitle());
            }
 
        }
        if (is_null($comp)) {
            $comp = $f->messageBox()->info($this->lng->txt("mcst_item_not_found"));
        }
        $this->gui->modal(
            $this->lng->txt("mcst_preview"),
            $this->lng->txt("close")
        )->content([$comp])->send();
    }
 
    public function confirmItemDeletionObject(): void
    {
        $items = [];
        $f = $this->gui->ui()->factory();
        $r = $this->gui->ui()->renderer();
        $ids = $this->mc_request->getItemIds();
        if (current($ids) === 'ALL_OBJECTS') {
            $arr = $this->object->getSortedItemsArray();
            $ids = array_keys($arr);
        }
 
        foreach ($ids as $id) {
            $item = new ilNewsItem($id);
            $items[] = $f->modal()->interruptiveItem()->keyValue($id, "", $item->getTitle());
        }
        $this->gui->send($r->renderAsync([
            $f->modal()->interruptive(
                $this->lng->txt("mcst_confirm_deletion"),
                $this->lng->txt("info_delete_sure"),
                $this->ctrl->getFormAction($this, "deleteItems")
            )->withAffectedItems($items)
        ]));
    }
 
    public function confirmDeletionItemsObject(): void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
 
        $this->checkPermission("write");
        $ilTabs->activateTab("edit_content");
 
        $ids = $this->mc_request->getItemIds();
        if (count($ids) == 0) {
            $this->listItemsObject();
            return;
        }
 
        $c_gui = new ilConfirmationGUI();
 
        // set confirm/cancel commands
        $c_gui->setFormAction($ilCtrl->getFormAction($this, "deleteItems"));
        $c_gui->setHeaderText($lng->txt("info_delete_sure"));
        $c_gui->setCancel($lng->txt("cancel"), "listItems");
        $c_gui->setConfirm($lng->txt("confirm"), "deleteItems");
 
        // add items to delete
        foreach ($ids as $item_id) {
            $item = new ilNewsItem($item_id);
            $c_gui->addItem(
                "item_id[]",
                $item_id,
                $item->getTitle(),
                ilUtil::getImagePath("standard/icon_mcst.svg")
            );
        }
 
        $tpl->setContent($c_gui->getHTML());
    }
 
    public function deleteItemsObject(): void
    {
        $ilCtrl = $this->ctrl;
 
        $this->checkPermission("write");
 
        // delete all selected news items
        $ids = $this->mc_request->getItemIds();
        foreach ($ids as $item_id) {
            $mc_item = new ilNewsItem($item_id);
            $mc_item->delete();
        }
        $this->object->saveOrder(array_map(function ($i) {
            return $i["id"];
        }, $this->object->readItems()));
        $ilCtrl->redirect($this, "listItems");
    }
 
    public function downloadItemObject(): void
    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
 
        $this->checkPermission("read");
        $news_item = new ilNewsItem($this->mc_request->getItemId());
        $this->object->handleLPUpdate($ilUser->getId(), $news_item->getMobId());
        if (!$news_item->deliverMobFile(
            "Standard",
            $this->mc_request->getPresentation()
        )) {
            $ilCtrl->redirect($this, "showContent");
        }
        exit;
    }
 
    public function determinePlaytimeObject(): void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $mc_item = new ilNewsItem($this->mc_request->getItemId());
        $mob = $mc_item->getMobId();
        $mob = new ilObjMediaObject($mob);
        $mob_dir = ilObjMediaObject::_getDirectory($mob->getId());
        $m_item = $mob->getMediaItem("Standard");
 
        $success = false;
 
        $m_item->determineDuration();
        $dur = $m_item->getDuration();
        if ($dur > 0) {
            $mc_item->setPlaytime($this->object->getPlaytimeForSeconds($dur));
            $mc_item->update();
            $success = true;
            $this->tpl->setOnScreenMessage('success', $lng->txt("mcst_set_playtime"), true);
        }
 
        if (!$success) {
            $this->tpl->setOnScreenMessage('failure', $lng->txt("mcst_unable_to_determin_playtime"), true);
        }
 
        $ilCtrl->redirect($this, "listItems");
    }
 
    public function infoScreenObject(): void
    {
        if (!$this->checkPermissionBool("read")) {
            $this->checkPermission("visible");
        }
        $this->ctrl->redirectByClass(ilInfoScreenGUI::class, "showSummary");
    }
 
    public function infoScreen(): void
    {
        $ilTabs = $this->tabs;
 
        $ilTabs->activateTab("id_info");
 
        if (!$this->checkPermissionBool("read")) {
            $this->checkPermission("visible");
        }
 
        $info = new ilInfoScreenGUI($this);
 
        $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());
        $info->enablePrivateNotes();
 
        // general information
        $this->lng->loadLanguageModule("meta");
        $this->lng->loadLanguageModule("mcst");
        $med_items = $this->object->getItemsArray();
        $info->addSection($this->lng->txt("meta_general"));
        $info->addProperty(
            $this->lng->txt("mcst_nr_items"),
            count($med_items)
        );
 
        if (count($med_items) > 0) {
            $cur = current($med_items);
            $last = ilDatePresentation::formatDate(new ilDateTime($cur["creation_date"], IL_CAL_DATETIME));
        } else {
            $last = "-";
        }
 
        $info->addProperty($this->lng->txt("mcst_last_submission"), $last);
 
        // forward the command
        $this->ctrl->forwardCommand($info);
    }
 
    protected function setTabs(): void
    {
        $ilAccess = $this->access;
        $ilTabs = $this->tabs;
        $lng = $this->lng;
        $ilHelp = $this->help;
 
        $ilHelp->setScreenIdComponent("mcst");
 
        // list items
        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()) ||
            $ilAccess->checkAccess('read', "", $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(
                "id_settings",
                $lng->txt("settings"),
                $this->ctrl->getLinkTargetByClass(SettingsGUI::class, "")
            );
        }
 
        if (ilLearningProgressAccess::checkAccess($this->object->getRefId())) {
            $ilTabs->addTab(
                'learning_progress',
                $lng->txt('learning_progress'),
                $this->ctrl->getLinkTargetByClass(array(__CLASS__, 'illearningprogressgui'), '')
            );
        }
 
        if ($ilAccess->checkAccess("write", "", $this->object->getRefId())) {
            $mdgui = new ilObjectMetaDataGUI($this->object);
            $mdtab = $mdgui->getTab();
            if ($mdtab) {
                $this->tabs_gui->addTab(
                    "meta_data",
                    $this->lng->txt("meta_data"),
                    $mdtab
                );
            }
        }
 
        // export
        if ($ilAccess->checkAccess("write", "", $this->object->getRefId())) {
            $ilTabs->addTab(
                "export",
                $lng->txt("export"),
                $this->ctrl->getLinkTargetByClass("ilexportgui", "")
            );
        }
 
        // 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 addContentSubTabs(
        string $a_active = "content"
    ): void {
        $ilTabs = $this->tabs;
        $ilAccess = $this->access;
        $lng = $this->lng;
 
        $ilTabs->addSubTab(
            "content",
            $lng->txt("view"),
            $this->ctrl->getLinkTarget($this, "showContent")
        );
 
        if ($ilAccess->checkAccess("write", "", $this->requested_ref_id)) {
            $ilTabs->addSubTab(
                "manage",
                $lng->txt("mcst_manage"),
                $this->ctrl->getLinkTarget($this, "listItems")
            );
 
            if ($this->object->getOrder() == ilObjMediaCast::ORDER_MANUAL) {
                $ilTabs->addSubTab(
                    "sorting",
                    $lng->txt("mcst_ordering"),
                    $this->ctrl->getLinkTarget($this, "editOrder")
                );
            }
        }
 
        $ilTabs->activateSubTab($a_active);
        $ilTabs->activateTab("content");
    }
 
    public function editSettingsObject(): void
    {
        $this->editObject();
    }
 
    protected function addLocatorItems(): void
    {
        $ilLocator = $this->locator;
 
        if (is_object($this->object)) {
            $ilLocator->addItem($this->object->getTitle(), $this->ctrl->getLinkTarget($this, "showContent"), "", $this->requested_ref_id);
        }
    }
 
    public static function _goto(string $a_target): void
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();
 
        $ilAccess = $DIC->access();
        $lng = $DIC->language();
        $ctrl = $DIC->ctrl();
 
        if ($ilAccess->checkAccess("read", "", $a_target)) {
            $ctrl->setParameterByClass("ilobjmediacastgui", "ref_id", $a_target);
            //exit;
            $ctrl->redirectByClass(["ilmediacasthandlergui", "ilobjmediacastgui"], "showContent");
        } elseif ($ilAccess->checkAccess("visible", "", $a_target)) {
            ilObjectGUI::_gotoRepositoryNode($a_target, "infoScreen");
        } elseif ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
            $main_tpl->setOnScreenMessage('failure', sprintf(
                $lng->txt("msg_no_perm_read_item"),
                ilObject::_lookupTitle(ilObject::_lookupObjId($a_target))
            ));
            ilObjectGUI::_gotoRepositoryRoot();
        }
 
        throw new ilPermissionException($lng->txt("msg_no_perm_read"));
    }
 
    protected static function isAudio(string $extension): bool
    {
        return strpos($extension, "audio") !== false;
    }
 
    protected function getMediaItem(int $id): ilMediaItem
    {
        $this->mcst_item = new ilNewsItem($id);
        // create dummy object in db (we need an id)
        $mob = new ilObjMediaObject($this->mcst_item->getMobId());
        return $mob->getMediaItem("Standard");
    }
 
    protected function getMediaItems(int $id): array
    {
        $this->mcst_item = new ilNewsItem($id);
        // create dummy object in db (we need an id)
        $mob = new ilObjMediaObject($this->mcst_item->getMobId());
        return $mob->getMediaItems();
    }
 
    private function populateFormFromPost(): void
    {
        $tpl = $this->tpl;
        $this->form_gui->setValuesByPost();
 
        //issue: we have to display the current settings
        // problem: POST does not contain values of disabled text fields
        // solution: use hidden field and label to display-> here we need to synchronize the labels
        // with the values from the hidden fields.
        foreach (ilObjMediaCast::$purposes as $purpose) {
            if ($this->form_gui->getInput("value_" . $purpose)) {
                $input = $this->form_gui->getItemByPostVar("label_value_" . $purpose);
                $input->setValue($this->form_gui->getInput("value_" . $purpose));
            }
        }
 
        $this->form_gui->setValuesByPost();
        $tpl->setContent($this->form_gui->getHTML());
    }
 
    protected function editOrderObject(): void
    {
        $ilTabs = $this->tabs;
        $lng = $this->lng;
        $tpl = $this->tpl;
 
        $this->checkPermission("write");
        $ilTabs->activateTab("edit_content");
 
        $this->addContentSubTabs("sorting");
 
        // sort by order setting
        switch ($this->object->getOrder()) {
            case ilObjMediaCast::ORDER_TITLE:
            case ilObjMediaCast::ORDER_CREATION_DATE_ASC:
            case ilObjMediaCast::ORDER_CREATION_DATE_DESC:
                $this->listItemsObject();
                return;
 
            case ilObjMediaCast::ORDER_MANUAL:
                // sub-tabs
                break;
        }
 
        $table_gui = new ilMediaCastTableGUI($this, "editOrder", true);
 
        $table_gui->setTitle($lng->txt("mcst_media_cast"));
        $table_gui->setData($this->object->getSortedItemsArray());
 
        $table_gui->addCommandButton("saveOrder", $lng->txt("mcst_save_order"));
 
        $tpl->setContent($table_gui->getHTML());
    }
 
    public function saveOrderObject(): void
    {
        $lng = $this->lng;
 
        $ids = $this->mc_request->getItemIds();
        asort($ids);
 
        $items = array();
        foreach (array_keys($ids) as $id) {
            $items[] = $id;
        }
        $this->object->saveOrder($items);
 
        $this->tpl->setOnScreenMessage('success', $lng->txt("settings_saved"), true);
        $this->ctrl->redirect($this, "editOrder");
    }
 
 
    public function showContentObject(): void
    {
        $tpl = $this->tpl;
        $ilUser = $this->user;
        $ilTabs = $this->tabs;
 
        // need read events for parent for LP statistics
        ilChangeEvent::_recordReadEvent(
            "mcst",
            $this->object->getRefId(),
            $this->object->getId(),
            $ilUser->getId()
        );
 
        // trigger LP update
        ilLPStatusWrapper::_updateStatus($this->object->getId(), $ilUser->getId());
 
        if ($this->object->getViewMode() == ilObjMediaCast::VIEW_GALLERY) {
            $this->showGallery();
        } elseif ($this->object->getViewMode() == ilObjMediaCast::VIEW_IMG_GALLERY) {
            $view = new \McstImageGalleryGUI($this->object, $this->tpl, $this->getFeedLink());
            $view->setCompletedCallback($this->ctrl->getLinkTarget(
                $this,
                "handlePlayerCompletedEvent",
                "",
                true,
                false
            ));
            $this->tabs->activateTab("content");
            $this->addContentSubTabs("content");
            $tpl->setContent($this->ctrl->getHTML($view));
        } elseif ($this->object->getViewMode() == ilObjMediaCast::VIEW_PODCAST) {
            $view = new \McstPodcastGUI($this->object, $this->tpl, $this->getFeedLink());
            $this->tabs->activateTab("content");
            $this->addContentSubTabs("content");
            $tpl->setContent($this->ctrl->getHTML($view));
        } elseif ($this->object->getViewMode() == ilObjMediaCast::VIEW_VCAST) {
            $ilTabs->activateTab("content");
            $this->addContentSubTabs("content");
            $view = new \ILIAS\MediaCast\Presentation\VideoViewGUI($this->object, $tpl, $this->getFeedLink());
            $view->setCompletedCallback($this->ctrl->getLinkTarget(
                $this,
                "handlePlayerCompletedEvent",
                "",
                true,
                false
            ));
            $view->setAutoplayCallback($this->ctrl->getLinkTarget(
                $this,
                "handleAutoplayTrigger",
                "",
                true,
                false
            ));
            $view->show();
        } else {
            $this->listItemsObject(true);
        }
 
        $tpl->setPermanentLink($this->object->getType(), $this->object->getRefId());
    }
 
    public function showGallery(): void
    {
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
 
        $this->tpl->setOnScreenMessage('info', $this->lng->txt("mcst_view_abandoned"));
    }
 
    public function extractPreviewImageObject(): void
    {
        $ilCtrl = $this->ctrl;
        $this->checkPermission("write");
        $this->mcst_item = new ilNewsItem($this->mc_request->getItemId());
        $this->video_gui->handleExtractionRequest(
            $this->mcst_item->getMobId()
        );
        $ilCtrl->redirect($this, "editCastItem");
    }
 
    public function handlePlayerEventObject(): void
    {
        if ($this->mc_request->getEvent() === "play") {
            $player = explode("_", $this->mc_request->getPlayer());
            $news_id = (int) $player[1];
            $item = new ilNewsItem($news_id);
            $item->increasePlayCounter();
 
            $mob_id = $item->getMobId();
            if ($mob_id) {
                $ilUser = $this->user;
                $this->object->handleLPUpdate($ilUser->getId(), $mob_id);
            }
        }
        exit;
    }
 
    protected function handlePlayerCompletedEventObject(): void
    {
        $mob_id = $this->mc_request->getMobId();
        if ($mob_id > 0) {
            $ilUser = $this->user;
            $this->object->handleLPUpdate($ilUser->getId(), $mob_id);
        }
        exit;
    }
 
    protected function afterUpload($mob_ids): void
    {
        $this->addMobsToCast($mob_ids, "", false);
    }
 
    protected function afterUrlSaving(int $mob_id, string $long_desc): void
    {
        $this->addMobsToCast([$mob_id], $long_desc);
    }
 
    protected function addMobsToCast(
        array $mob_ids,
        string $long_desc = "",
        bool $redirect = true,
        bool $extract = false
    ): void {
        $ctrl = $this->ctrl;
        $user = $this->user;
 
        $item_ids = [];
        foreach ($mob_ids as $mob_id) {
            $item_ids[] = $this->object->addMobToCast($mob_id, $user->getId(), $long_desc, $extract);
        }
 
        if ($redirect) {
            if (count($item_ids) === 1) {
                $ctrl->setParameter($this, "item_id", $item_ids[0]);
                $ctrl->redirect($this, "editCastItem");
            }
            $ctrl->redirect($this, "listItems");
        }
    }
 
    protected function afterPoolInsert(array $mob_ids): void
    {
        $this->addMobsToCast($mob_ids, "", true, true);
    }
 
    protected function handleAutoplayTriggerObject(): void
    {
        $this->user->writePref(
            "mcst_autoplay",
            $this->mc_request->getAutoplay()
        );
        exit;
    }
 
    protected function getCommentGUI(): ilCommentGUI
    {
        return $this->gui->comments()->commentGUI(
            $this->object->getRefId(),
            $this->mc_request->getItemId()
        );
    }
 
    protected function showCommentsObject(): void
    {
        echo $this->getCommentGUI()->getListHTML() . "<script>ilNotes.init(null);</script>";
        exit;
    }
 
    protected function renderVideoObject(): void
    {
        $mob_id = $this->mc_request->getMobId();
        $html = $this->mob_player_gui->wrapper()->renderComponent(new ilObjMediaObject($mob_id));
        $this->gui->httpUtil()->sendString($html);
    }
}