OpenCast.class.php

<?php
/*
 * OpenCast.class.php - A course plugin for Stud.IP which includes an opencast player
 * Copyright (c) 2010  André Klaßen
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 */

require_once 'vendor/trails/trails.php';
require_once 'models/OCModel.php';
require_once 'models/OCCourseModel.class.php';
require_once 'models/OCSeriesModel.php';
require_once 'classes/OCRestClient/SearchClient.php';
require_once 'classes/OCRestClient/SeriesClient.php';
require_once 'controllers/opencast_controller.php';


define('OC_UPLOAD_CHUNK_SIZE', '10000000');
define('OC_CLEAN_SESSION_AFTER_DAYS', '1');

//Rest.IP
NotificationCenter::addObserver('OpenCast', 'getAPIDataForCourseRecordings', 'restip.courses.get');
NotificationCenter::addObserver('OpenCast', 'getAPIDataForCourseRecordings', 'restip.courses-course_id.get');
NotificationCenter::addObserver('OpenCast', 'getAPIDataForCourseRecordings', 'restip.courses-semester-semester_id.get');

class OpenCast extends StudipPlugin implements SystemPlugin, StandardPlugin
{
    const GETTEXT_DOMAIN = 'opencast';

    /**
     * Initialize a new instance of the plugin.
     */
    function __construct()
    {
        parent::__construct();

        bindtextdomain(static::GETTEXT_DOMAIN, $this->getPluginPath() . '/locale');
        bind_textdomain_codeset(static::GETTEXT_DOMAIN, 'ISO-8859-1');

        global $SessSemName, $perm;
        $GLOBALS['ocplugin_path'] = $this->getPluginURL();

        if ($perm->have_perm('root')) {

            //check if we already have an connection to an opencast matterhorn
            //.. now the subnavi
            $main = new Navigation($this->_("Opencast Administration"));
            // TODO think about an index page.. for the moment the config page is in charge..
            $main->setURL(PluginEngine::getURL('opencast/admin/config'));

            $config = new Navigation($this->_('Opencast Einstellungen'));
            $config->setURL(PluginEngine::getURL('opencast/admin/config'));
            $main->addSubNavigation('oc-config', $config);

            Navigation::addItem('/start/opencast', $main);
            Navigation::addItem('/admin/config/oc-config', $config);

            if (OCModel::getConfigurationstate()) {
                $resources = new Navigation($this->_('Opencast Ressourcen'));
                $resources->setURL(PluginEngine::getURL('opencast/admin/resources'));
                $main->addSubNavigation('oc-resources', $resources);
                Navigation::addItem('/admin/config/oc-resources', $resources);

                if ($perm->have_perm('root')) {
                    $endpoints = new Navigation('Opencast Endpoints');
                    $endpoints->setURL(PluginEngine::getURL('opencast/admin/endpoints'));
                    $main->addSubNavigation('oc-endpoints', $endpoints);
                    Navigation::addItem('/admin/config/oc-endpoints', $endpoints);
                }
            }
        }


        if (!$GLOBALS['opencast_already_loaded']) {

            $this->addStylesheet('stylesheets/oc.less');

            PageLayout::addScript($this->getPluginUrl() . '/javascripts/application.js');

            if (class_exists('Context')) {
                $id = Context::getId();
            } else {
                $id = $GLOBALS['SessionSeminar'];
            }

            $id = Request::get('sem_id', $id);

            if ($perm->have_perm('dozent') && OCModel::getConfigurationstate()) {
                PageLayout::addScript($this->getPluginUrl() . '/javascripts/embed.js');
                PageLayout::addStylesheet($this->getpluginUrl() . '/stylesheets/embed.css');
                PageLayout::addScript($this->getpluginUrl() . '/vendor/jquery.ui.widget.js');
                PageLayout::addScript($this->getpluginUrl() . '/vendor/chosen/chosen.jquery.min.js');
                PageLayout::addStylesheet($this->getpluginUrl() . '/vendor/chosen/chosen.min.css');

            }

            if (OCModel::getConfigurationstate()) {

                StudipFormat::addStudipMarkup('opencast', '\[opencast\]', '\[\/opencast\]', 'OpenCast::markupOpencast');

            }

            NotificationCenter::addObserver($this, "NotifyUserOnNewEpisode", "NewEpisodeForCourse");
        }

        $GLOBALS['opencast_already_loaded'] = true;
    }

    /**
     * Plugin localization for a single string.
     * This method supports sprintf()-like execution if you pass additional
     * parameters.
     *
     * @param String $string String to translate
     * @return translated string
     */
    public function _($string)
    {
        $result = static::GETTEXT_DOMAIN === null
                ? $string
                : dcgettext(static::GETTEXT_DOMAIN, $string, LC_MESSAGES);
        if ($result === $string) {
            $result = _($string);
        }

        if (func_num_args() > 1) {
            $arguments = array_slice(func_get_args(), 1);
            $result = vsprintf($result, $arguments);
        }

        return studip_utf8decode($result);
    }

    /**
     * Plugin localization for plural strings.
     * This method supports sprintf()-like execution if you pass additional
     * parameters.
     *
     * @param String $string0 String to translate (singular)
     * @param String $string1 String to translate (plural)
     * @param mixed  $n       Quantity factor (may be an array or array-like)
     * @return translated string
     */
    public function _n($string0, $string1, $n)
    {
        if (is_array($n)) {
            $n = count($n);
        }

        $result = static::GETTEXT_DOMAIN === null
                ? $string0
                : dngettext(static::GETTEXT_DOMAIN, $string0, $string1, $n);
        if ($result === $string0 || $result === $string1) {
            $result = ngettext($string0, $string1, $n);
        }

        if (func_num_args() > 3) {
            $arguments = array_slice(func_get_args(), 3);
            $result = vsprintf($result, $arguments);
        }

        return studip_utf8decode($result);
    }

    /**
     * This method takes care of the Navigation
     *
     * @param string   course_id
     * @param string   last_visit
     */
    function getIconNavigation($course_id, $last_visit, $user_id = NULL)
    {

        $ocmodel = new OCCourseModel($course_id);
        if (!$this->isActivated($course_id) || $ocmodel->getSeriesVisibility() != 'visible') {
            return;
        }

        $this->image_path = $this->getPluginURL() . '/images/';

        if ($GLOBALS['perm']->have_studip_perm('user', $course_id)) {
            $ocgetcount = $ocmodel->getCount($last_visit);
            $text = sprintf($this->_('Es gibt %s neue Opencast Aufzeichnung(en) seit ihrem letzten Besuch.'), $ocgetcount);
        } else {
            $num_entries = 0;
            $text = $this->_('Opencast Aufzeichnungen');
        }

        $navigation = new Navigation('opencast', PluginEngine::getURL($this, array(), 'course/index/false'));
        $navigation->setBadgeNumber($num_entries);

        if ($ocgetcount > 0) {
            $navigation->setImage(new Icon($this->image_path .'oc20red.png'), array('title' => $text));
        } else {
            $navigation->setImage(new Icon($this->image_path .'oc20grey.png'), array('title' => $text));
        }

        return $navigation;
    }

    /**
     * Return a template (an instance of the Flexi_Template class)
     * to be rendered on the course summary page. Return NULL to
     * render nothing for this plugin.
     *
     * The template will automatically get a standard layout, which
     * can be configured via attributes set on the template:
     *
     *  title        title to display, defaults to plugin name
     *  icon_url     icon for this plugin (if any)
     *  admin_url    admin link for this plugin (if any)
     *  admin_title  title for admin link (default: Administration)
     *
     * @return object   template object to render or NULL
     */
    public function getInfoTemplate($course_id)
    {
        return null;
    }


    function getTabNavigation($course_id)
    {

        if (!$this->isActivated($course_id) || !OCModel::getConfigurationstate()) {
            return;
        }


        $ocmodel = new OCCourseModel($course_id);

        $main = new Navigation("Opencast");
        $main->setURL(PluginEngine::getURL('opencast/course'));
        $main->setImage(new Icon($this->getPluginUrl() . '/images/oc-logo-white.png'));
        $main->setActiveImage(new Icon($this->getPluginUrl() . '/images/oc-logo-black.png'));


        $overview = new Navigation($this->_('Aufzeichnungen'));
        $overview->setURL(PluginEngine::getURL('opencast/course/index'));

        $scheduler = new Navigation($this->_('Aufzeichnungen planen'));
        $scheduler->setURL(PluginEngine::getURL('opencast/course/scheduler'));

        $main->addSubNavigation('overview', $overview);


        if ($GLOBALS['perm']->have_studip_perm('dozent', $course_id)) {
            $series_metadata = OCSeriesModel::getConnectedSeriesDB($course_id);
            if ($series_metadata[0]['schedule'] == '1') {
                $main->addSubNavigation('scheduler', $scheduler);
            }
        }
        if($ocmodel->getSeriesVisibility() == 'visible' || $GLOBALS['perm']->have_studip_perm('dozent', $course_id)){
            return array('opencast' => $main);
        } else return array();

    }

    /**
     * return a list of ContentElement-objects, containing
     * everything new in this module
     *
     * @param  string $course_id the course-id to get the new stuff for
     * @param  int $last_visit when was the last time the user visited this module
     * @param  string $user_id the user to get the notification-objects for
     *
     * @return array an array of ContentElement-objects
     */
    function getNotificationObjects($course_id, $since, $user_id)
    {
        return false;
    }

    static function markupOpencast($markup, $matches, $contents)
    {
        $search_client = SearchClient::getInstance(OCRestClient::getCourseIdForSeries($contents));
        $embed = $search_client->getBaseURL() . "/engage/ui/embed.html?id=" . $contents;

        return sprintf('<iframe src="%s" style="border:0px #FFFFFF none;" name="Opencast Matterhorn - Media Player" scrolling="no" frameborder="0" marginheight="0px" marginwidth="0px" width="540" height="404"></iframe><br>', $embed);
    }


    /**
     * getAPIDataForCourseRecordings - Event handler for modifying course data
     */
    public function getAPIDataForCourseRecordings()
    {

        $router = RestIP\Router::getInstance(null);
        $router->hook('restip.before.render', function () use ($router, $addon) {

            $result = $router->getRouteResult();


            if (key($result) === 'course') {
                if (empty($result['course']['course_id'])) {
                    return;
                }
                $pm = PluginManager::getInstance();
                $pinfo = $pm->getPluginInfo('OpenCast');
                $pid = $pinfo['id'];
                $ocmodel = new OCCourseModel($result['course']['course_id']);
                if($ocmodel->getSeriesVisibility() == 'visible') {
                    $result['course'] = OpenCast::extendCourseRoute($result['course'], $pm->isPluginActivated($pid, $result['course']['course_id']), true);
                }
            } elseif (key($result) === 'courses') {
                foreach ($result['courses'] as $index => $course) {
                    if (empty($course['course_id'])) {
                        continue;
                    }
                    $pm = PluginManager::getInstance();
                    $pinfo = $pm->getPluginInfo('OpenCast');
                    $pid = $pinfo['id'];
                    $ocmodel = new OCCourseModel($course['course_id']);
                    if($ocmodel->getSeriesVisibility() == 'visible') {
                        $result['courses'][$index] = OpenCast::extendCourseRoute($course, $pm->isPluginActivated($pid, $course['course_id']), false);
                    }
                }
            }

            $router->setRouteResult($result);
        });
    }

    public function extendCourseRoute($course, $activation = false, $additional_data = false)
    {
        if ($course['modules']['oc_matterhorn'] = $activation) {
            if ($additional_data) {
                if (!isset($course['additonal_data'])) {
                    $course['additional_data'] = array();
                }
                $course['additional_data']['oc_recordings'] = OpenCast::getRecordings($course['course_id']);
            }
        }
        return $course;

    }


    public function getRecordings($course_id)
    {

        $ocmodel = new OCCourseModel($course_id);
        $episodes = $ocmodel->getEpisodesforREST();

        return $episodes;

    }

    public function NotifyUserOnNewEpisode($x, $data){
        $ocmodel = new OCCourseModel($data['course_id']);
        if($ocmodel->getSeriesVisibility() == 'visible') {
            $course = Course::find($data['course_id']);
            $members = $course->members;

            $users = array();
            foreach($members as $member){
                $users[] = $member->user_id;
            }

            $notification =  sprintf($this->_('Neue Vorlesungsaufzeichnung  "%s" im Kurs "%s"'), $data['episode_title'], $course->name);
            PersonalNotifications::add(
                $users, PluginEngine::getLink('opencast/course/index/'. $data['episode_id']),
                $notification, $data['episode_id'],
                Assets::image_path("icons/40/blue/file-video.png")
            );
        }

    }


    /**
     * @inherits
     *
     * Overwrite default metadata-function to return correctly encoded strings
     * depending on Stud.IP version
     *
     * @return array correctly encoded metadata
     */
    public function getMetadata()
    {
        $metadata = parent::getMetadata();

        if (version_compare($GLOBALS['SOFTWARE_VERSION'], '4', '<=')) {
            foreach ($metadata as $key => $value) {
                if (is_string($value)) {
                    $metadata[$key] = utf8_decode($value);
                }
            }
        }

       return $metadata;
    }
}