class.ilObjMediaCast.php

Go to the documentation of this file.

<?php

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

require_once "./Services/Object/classes/class.ilObject.php";

class ilObjMediaCast extends ilObject
{
    protected $user;

    //public static $purposes = array("Standard", "VideoAlternative", "VideoPortable", "AudioPortable");
    public static $purposes = array("Standard");
    protected $online = false;
    protected $publicfiles = false;
    protected $downloadable = true;
    protected $order;
    protected $view_mode = "";
    
    const ORDER_TITLE = 1;
    const ORDER_CREATION_DATE_ASC = 2;
    const ORDER_CREATION_DATE_DESC = 3;
    const ORDER_MANUAL = 4;
    
    const VIEW_LIST = "";
    const VIEW_GALLERY = "gallery";

    protected $defaultAccess = 0;

    // mapping for copy process
    protected $mob_mapping = [];
    
    public function __construct($a_id = 0, $a_call_by_reference = true)
    {
        global $DIC;

        $this->db = $DIC->database();
        $this->user = $DIC->user();
        $this->type = "mcst";
        parent::__construct($a_id, $a_call_by_reference);
        $mcst_set = new ilSetting("mcst");
        $this->setDefaultAccess($mcst_set->get("defaultaccess") == "users" ? 0 : 1);
        $this->setOrder(self::ORDER_CREATION_DATE_DESC);
    }

    public function setOnline($a_online)
    {
        $this->online = $a_online;
    }

    public function getOnline()
    {
        return $this->online;
    }

    public function setPublicFiles($a_publicfiles)
    {
        $this->publicfiles = $a_publicfiles;
    }

    public function getPublicFiles()
    {
        return $this->publicfiles;
    }

    public function setViewMode($a_val)
    {
        $this->view_mode = $a_val;
    }
    
    public function getViewMode()
    {
        return $this->view_mode;
    }
    public function setItemsArray($a_itemsarray)
    {
        $this->itemsarray = $a_itemsarray;
    }

    public function getItemsArray()
    {
        return $this->itemsarray;
    }

    public function getSortedItemsArray()
    {
        $med_items = $this->getItemsArray();

        // sort by order setting
        switch ($this->getOrder()) {
            case ilObjMediaCast::ORDER_TITLE:
                $med_items = ilUtil::sortArray($med_items, "title", "asc", false, true);
                break;
            
            case ilObjMediaCast::ORDER_CREATION_DATE_ASC:
                $med_items = ilUtil::sortArray($med_items, "creation_date", "asc", false, true);
                break;
            
            case ilObjMediaCast::ORDER_CREATION_DATE_DESC:
                $med_items = ilUtil::sortArray($med_items, "creation_date", "desc", false, true);
                break;
            
            case ilObjMediaCast::ORDER_MANUAL:
                $order = array_flip($this->readOrder());
                $pos = sizeof($order);
                foreach (array_keys($med_items) as $idx) {
                    if (array_key_exists($idx, $order)) {
                        $med_items[$idx]["order"] = ($order[$idx] + 1) * 10;
                    }
                    // item has no order yet
                    else {
                        $med_items[$idx]["order"] = (++$pos) * 10;
                    }
                }
                
                $med_items = ilUtil::sortArray($med_items, "order", "asc", true, true);
                break;
        }

        return $med_items;
    }
    
    
    public function setDownloadable($a_downloadable)
    {
        $this->downloadable = $a_downloadable;
    }
    public function getDownloadable()
    {
        return $this->downloadable;
    }
    
    public function getDefaultAccess()
    {
        return $this->defaultAccess;
    }
    
    public function setDefaultAccess($value)
    {
        $this->defaultAccess = (int) $value == 0 ? 0 : 1;
    }
    
    public function setOrder($a_value)
    {
        $this->order = $a_value;
    }
    public function getOrder()
    {
        return $this->order;
    }
    
    public function getDiskUsage()
    {
        require_once("./Modules/MediaCast/classes/class.ilObjMediaCastAccess.php");
        return ilObjMediaCastAccess::_lookupDiskUsage($this->id);
    }
    
    public function create()
    {
        $ilDB = $this->db;

        parent::create();
        
        $query = "INSERT INTO il_media_cast_data (" .
            " id" .
            ", is_online" .
            ", public_files" .
            ", downloadable" .
            ", def_access" .
            ", sortmode" .
            ", viewmode" .
            " ) VALUES (" .
            $ilDB->quote($this->getId(), "integer")
            . "," . $ilDB->quote((int) $this->getOnline(), "integer")
            . "," . $ilDB->quote((int) $this->getPublicFiles(), "integer")
            . "," . $ilDB->quote((int) $this->getDownloadable(), "integer")
            . "," . $ilDB->quote((int) $this->getDefaultAccess(), "integer")
            . "," . $ilDB->quote((int) $this->getOrder(), "integer")
            . "," . $ilDB->quote((int) $this->getViewMode(), "text")
            . ")";
        $ilDB->manipulate($query);
    }

    public function update()
    {
        $ilDB = $this->db;
        
        if (!parent::update()) {
            return false;
        }

        // update media cast data
        $query = "UPDATE il_media_cast_data SET " .
            " is_online = " . $ilDB->quote((int) $this->getOnline(), "integer") .
            ", public_files = " . $ilDB->quote((int) $this->getPublicFiles(), "integer") .
            ", downloadable = " . $ilDB->quote((int) $this->getDownloadable(), "integer") .
            ", def_access = " . $ilDB->quote((int) $this->getDefaultAccess(), "integer") .
            ", sortmode = " . $ilDB->quote((int) $this->getOrder(), "integer") .
            ", viewmode = " . $ilDB->quote($this->getViewMode(), "text") .
            " WHERE id = " . $ilDB->quote((int) $this->getId(), "integer");

        $ilDB->manipulate($query);

        return true;
    }
    
    public function read()
    {
        $ilDB = $this->db;
        
        parent::read();
        $this->readItems();
        
        $query = "SELECT * FROM il_media_cast_data WHERE id = " .
            $ilDB->quote($this->getId(), "integer");
        $set = $ilDB->query($query);
        $rec = $ilDB->fetchAssoc($set);

        $this->setOnline($rec["is_online"]);
        $this->setPublicFiles($rec["public_files"]);
        $this->setDownloadable($rec["downloadable"]);
        $this->setDefaultAccess($rec["def_access"]);
        $this->setOrder($rec["sortmode"]);
        $this->setViewMode($rec["viewmode"]);
    }


    public function delete()
    {
        $ilDB = $this->db;

        // always call parent delete function first!!
        if (!parent::delete()) {
            return false;
        }

        // delete all items
        $med_items = $this->getItemsArray();
        foreach ($med_items as $item) {
            include_once("./Services/News/classes/class.ilNewsItem.php");
            $news_item = new ilNewsItem($item["id"]);
            $news_item->delete();
        }
        
        $this->deleteOrder();

        // delete record of table il_media_cast_data
        $query = "DELETE FROM il_media_cast_data" .
            " WHERE id = " . $ilDB->quote($this->getId(), "integer");
        $ilDB->manipulate($query);
        
        return true;
    }

    public function readItems($a_oldest_first = false)
    {
        //
        include_once("./Services/News/classes/class.ilNewsItem.php");
        $it = new ilNewsItem();
        $it->setContextObjId($this->getId());
        $it->setContextObjType($this->getType());
        $this->itemsarray = $it->queryNewsForContext(false, 0, "", false, $a_oldest_first);
        
        return $this->itemsarray;
    }

    public function deleteOrder()
    {
        $ilDB = $this->db;
        
        if (!$this->getId()) {
            return;
        }
        
        $sql = "DELETE FROM il_media_cast_data_ord" .
            " WHERE obj_id = " . $ilDB->quote($this->getId(), "integer");
        $ilDB->manipulate($sql);
    }
    
    public function readOrder()
    {
        $ilDB = $this->db;
        
        if (!$this->getId()) {
            return;
        }
        
        $all = array();
        $sql = "SELECT item_id FROM il_media_cast_data_ord" .
            " WHERE obj_id = " . $ilDB->quote($this->getId(), "integer") .
            " ORDER BY pos";
        $res = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($res)) {
            $all[] = $row["item_id"];
        }
        return $all;
    }
    
    public function saveOrder(array $a_items)
    {
        $ilDB = $this->db;
        
        if (!$this->getId()) {
            return;
        }
        
        $this->deleteOrder();
        
        $pos = 0;
        foreach ($a_items as $item_id) {
            $pos++;
            
            $sql = "INSERT INTO il_media_cast_data_ord (obj_id,item_id,pos)" .
                " VALUES (" . $ilDB->quote($this->getId(), "integer") . "," .
                $ilDB->quote($item_id, "integer") . "," .
                $ilDB->quote($pos, "integer") . ")";
            $ilDB->manipulate($sql);
        }
    }

    protected function copyOrder($newObj, $mapping)
    {
        $items = [];
        foreach ($this->readOrder() as $i) {
            $items[] = $mapping[$i];
        }
        $newObj->saveOrder($items);
    }

    public function cloneObject($a_target_id, $a_copy_id = 0, $a_omit_tree = false)
    {
        $new_obj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);

        //copy online status if object is not the root copy object
        $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);

        if (!$cp_options->isRootNode($this->getRefId())) {
            $new_obj->setOnline($this->getOnline());
        }
        
        //$new_obj->setTitle($this->getTitle());
        $new_obj->setPublicFiles($this->getPublicFiles());
        $new_obj->setDownloadable($this->getDownloadable());
        $new_obj->setDefaultAccess($this->getDefaultAccess());
        $new_obj->setOrder($this->getOrder());
        $new_obj->setViewMode($this->getViewMode());
        $new_obj->update();

        include_once("./Services/Block/classes/class.ilBlockSetting.php");
        $pf = ilBlockSetting::_lookup("news", "public_feed", 0, $this->getId());
        $keeprss = (int) ilBlockSetting::_lookup("news", "keep_rss_min", 0, $this->getId());
        ilBlockSetting::_write("news", "public_feed", $pf, 0, $new_obj->getId());
        ilBlockSetting::_write("news", "keep_rss_min", $keeprss, 0, $new_obj->getId());

        // copy items
        $mapping = $this->copyItems($new_obj);
        $this->copyOrder($new_obj, $mapping);
        

        // clone LP settings
        include_once('./Services/Tracking/classes/class.ilLPObjSettings.php');
        $obj_settings = new ilLPObjSettings($this->getId());
        $obj_settings->cloneSettings($new_obj->getId());
        unset($obj_settings);

        $olp = ilObjectLP::getInstance($this->getId());
        $collection = $olp->getCollectionInstance();
        if ($collection) {
            $collection->cloneCollection($new_obj->getRefId(), $cp_options->getCopyId(), $this->mob_mapping);
        }

        return $new_obj;
    }

    public function copyItems($a_new_obj)
    {
        $ilUser = $this->user;

        $item_mapping = [];
        include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
        foreach ($this->readItems(true) as $item) {
            // copy media object
            $mob_id = $item["mob_id"];
            $mob = new ilObjMediaObject($mob_id);
            $new_mob = $mob->duplicate();

            // copy news item
            // create new media cast item
            include_once("./Services/News/classes/class.ilNewsItem.php");
            $mc_item = new ilNewsItem();
            $mc_item->setMobId($new_mob->getId());
            $mc_item->setContentType(NEWS_AUDIO);
            $mc_item->setContextObjId($a_new_obj->getId());
            $mc_item->setContextObjType($a_new_obj->getType());
            $mc_item->setUserId($ilUser->getId());
            $mc_item->setPlaytime($item["playtime"]);
            $mc_item->setTitle($item["title"]);
            $mc_item->setContent($item["content"]);
            $mc_item->setVisibility($item["visibility"]);
            $mc_item->create();
            $this->mob_mapping[$mob_id] = $new_mob->getId();
            $item_mapping[$item["id"]] = $mc_item->getId();
        }
        return $item_mapping;
    }
    
    public function handleLPUpdate($a_user_id, $a_mob_id)
    {
        // using read events to persist mob status
        require_once 'Services/Tracking/classes/class.ilChangeEvent.php';
        ilChangeEvent::_recordReadEvent(
            "mob",
            $this->getRefId(),
            $a_mob_id,
            $a_user_id
        );
        
        // trigger LP update
        require_once 'Services/Tracking/classes/class.ilLPStatusWrapper.php';
        ilLPStatusWrapper::_updateStatus($this->getId(), $a_user_id);
    }

    public function addMobToCast($mob_id, $user_id, $long_desc = "")
    {
        $mob = new ilObjMediaObject($mob_id);
        $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->getId());
        $mc_item->setContextObjType($this->getType());
        $mc_item->setUserId($user_id);
        $med_item = $mob->getMediaItem("Standard");
        $mc_item->setPlaytime($this->getPlaytimeForSeconds($med_item->getDuration()));
        $mc_item->setTitle($mob->getTitle());
        $mc_item->setContent($mob->getLongDescription());
        if ($long_desc != "") {
            $mc_item->setContent($long_desc);
        }
        $mc_item->setLimitation(false);
        // @todo handle visibility
        $mc_item->create();

        $lp = ilObjectLP::getInstance($this->getId());

        // see ilLPListOfSettingsGUI assign
        $collection = $lp->getCollectionInstance();
        if ($collection && $collection->hasSelectableItems()) {
            /* not yet...
            $collection->activateEntries([$mob_id]);
            $lp->resetCaches();
            ilLPStatusWrapper::_refreshStatus($this->getId());
            */
        }
        return $mc_item->getId();
    }

    protected function getPlaytimeForSeconds(int $seconds)
    {
        $hours = floor($seconds / 3600);
        $minutes = floor(($seconds % 3600) / 60);
        $seconds = $seconds % 60;
        $duration = str_pad($hours, 2, "0", STR_PAD_LEFT) . ":" .
            str_pad($minutes, 2, "0", STR_PAD_LEFT) . ":" .
            str_pad($seconds, 2, "0", STR_PAD_LEFT);
        return $duration;
    }
}