<?php
/*
 * Forum.php - Forum
 *
 * 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.
 *
 * @author      Till Glöggler <till.gloeggler@elan-ev.de>
 * @copyright   2011 ELAN e.V. <http://www.elan-ev.de>
 * @license     http://www.gnu.org/licenses/gpl-2.0.html GPL version 2
 * @category    Stud.IP
 */

// Notifications
NotificationCenter::addObserver('CoreForum', 'overviewDidClear', 'OverviewDidClear');
NotificationCenter::addObserver('CoreForum', 'removeAbosForUserAndCourse', 'UserDidLeaveCourse');

NotificationCenter::addObserver('ForumActivity', 'newEntry', 'ForumAfterInsert');
NotificationCenter::addObserver('ForumActivity', 'updateEntry', 'ForumAfterUpdate');
NotificationCenter::addObserver('ForumActivity', 'deleteEntry', 'ForumBeforeDelete');

NotificationCenter::addObserver('ForumIssue', 'unlinkIssue', 'ForumBeforeDelete');

class CoreForum extends CorePlugin implements ForumModule
{
    /* interface method */
    public function getTabNavigation($course_id)
    {
        $navigation = new Navigation(_('Forum'), 'dispatch.php/course/forum/index');
        $navigation->setImage(Icon::create('forum', 'info_alt'));

        // add main third-level navigation-item
        $navigation->addSubNavigation('index', new Navigation(_('Übersicht'), 'dispatch.php/course/forum/index'));

        if (ForumPerm::has('fav_entry', $course_id)) {
            $navigation->addSubNavigation('newest', new Navigation(_("Neue Beiträge"), 'dispatch.php/course/forum/index/newest'));
            $navigation->addSubNavigation('latest', new Navigation(_("Letzte Beiträge"), 'dispatch.php/course/forum/index/latest'));
            $navigation->addSubNavigation('favorites', new Navigation(_('Gemerkte Beiträge'), 'dispatch.php/course/forum/index/favorites'));

            // mass-administrate the forum
            if (ForumPerm::has('admin', $course_id)) {
                $navigation->addSubNavigation('admin', new Navigation(_('Administration'), 'dispatch.php/course/forum/admin'));
            }
        }

        return ['forum2' => $navigation];
    }

    /* interface method */
    public function getIconNavigation($course_id, $last_visit, $user_id = null)
    {
        if ($GLOBALS['perm']->have_studip_perm('user', $course_id)) {
            $num_entries = ForumVisit::getCount($course_id, ForumVisit::getVisit($course_id));
            $text = ForumHelpers::getVisitText($num_entries, $course_id);
        } else {
            $num_entries = 0;
            $text = 'Forum';
        }

        $navigation = new Navigation('forum', 'dispatch.php/course/forum/index/enter_seminar');
        $navigation->setBadgeNumber($num_entries);
        $navigation->setLinkAttributes(['title' => $text]);

        if ($num_entries > 0) {
            $navigation->setImage(Icon::create('forum', Icon::ROLE_ATTENTION));
        } else {
            $navigation->setImage(Icon::create('forum'));
        }

        return $navigation;
    }


    /* interface method */
    public function getManyIconNavigation(array $course_ids, ?string $user_id = null): array
    {
        $num_entries_plural = ForumVisit::getCounts($course_ids, $user_id, $this->getPluginId());

        $navs = [];
        foreach ($num_entries_plural as $course_id => $num_entries) {
            $count = 0;
            if ($GLOBALS['perm']->have_studip_perm('user', $course_id)) {
                $count = $num_entries;
                $text = ForumHelpers::getVisitText($count, $course_id);
            } else {
                $text = _('Forum');
            }

            $navigation = new Navigation('forum', 'dispatch.php/course/forum/index/enter_seminar');
            $navigation->setBadgeNumber($count);
            $icon_role = $count > 0 ? Icon::ROLE_ATTENTION : Icon::ROLE_CLICKABLE;
            $navigation->setImage(Icon::create('forum', $icon_role));
            $navigation->setLinkAttributes(['title' => $text]);
            $navs[$course_id] = $navigation;
        }

        return $navs;
    }

    /**
     * This method is called, whenever an user clicked to clear the visit timestamps
     * and set everything as visited
     *
     * @param object $notification
     * @param string $user_id
     */
    public static function overviewDidClear($notification, $user_id)
    {
        $query = "REPLACE INTO `forum_visits`
                  SELECT `user_id`, `Seminar_id`, UNIX_TIMESTAMP(), UNIX_TIMESTAMP()
                  FROM `seminar_user`
                  WHERE `user_id` = ?";
        DBManager::get()->execute($query, [$user_id]);
    }

    /**
     * This method is called whenever a user is removed from a course and thus
     * the forum abos will be removed.
     *
     * @param object $notification
     * @param string $course_id
     * @param string $user_id
     */
    public static function removeAbosForUserAndCourse($notification, $course_id, $user_id)
    {
        ForumAbo::removeForCourseAndUser($course_id, $user_id);
    }

    public function getInfoTemplate($course_id)
    {
        return null;
    }

    /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
    /* * IMPLEMENTATION OF METHODS FROM FORUMMODULE-INTERFACE  * */
    /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

    public function getLinkToThread($issue_id)
    {
        if ($topic_id = ForumIssue::getThreadIdForIssue($issue_id)) {
            return URLHelper::getLink('dispatch.php/course/forum/index/index/' . $topic_id);
        }

        return false;
    }

    public function setThreadForIssue($issue_id, $title, $content)
    {
        ForumIssue::setThreadForIssue(Context::getId(), $issue_id, $title, $content);
    }

    public function getNumberOfPostingsForUser($user_id, $seminar_id = null)
    {
        return ForumEntry::countUserEntries($user_id, $seminar_id);
    }

    public function getNumberOfPostingsForIssue($issue_id)
    {
        $topic_id = ForumIssue::getThreadIdForIssue($issue_id);

        return $topic_id ? ForumEntry::countEntries($topic_id) : 0;
    }

    public function getNumberOfPostingsForSeminar($seminar_id)
    {
        return floor(ForumEntry::countEntries($seminar_id));
    }

    public function getNumberOfPostings()
    {
        return ForumEntry::countAllEntries();
    }

    public function getEntryTableInfo()
    {
        return [
            'table'      => 'forum_entries',
            'content'    => 'content',
            'chdate'     => 'chdate',
            'seminar_id' => 'seminar_id',
            'user_id'    => 'user_id'
        ];
    }

    public function getTopTenSeminars()
    {
        return ForumEntry::getTopTenSeminars();
    }

    public function migrateUser($user_from, $user_to)
    {
        ForumEntry::migrateUser($user_from, $user_to);
    }

    public function deleteContents($seminar_id)
    {
        ForumEntry::delete($seminar_id);
    }

    public function getDump($seminar_id)
    {
        return ForumEntry::getDump($seminar_id);
    }

    public static function getDescription()
    {
        return _('Textbasierte und zeit- und ortsunabhängige '.
            'Diskursmöglichkeit. Lehrende können parallel zu '.
            'Veranstaltungsthemen Fragen stellen, die von den Studierenden '.
            'per Meinungsaustausch besprochen werden.');
    }

    /**
     * {@inheritdoc}
     */
    public function getMetadata()
    {
        return [
            'summary' => _('Veranstaltungsbegleitender Meinungsaustausch zu bestimmten Themen'),
            'description' => _('Textbasierte zeit- und ortsunabhängige Möglichkeit zum Austausch von Gedanken, Meinungen und Erfahrungen. Lehrende und/oder Studierende können parallel zu Veranstaltungsthemen Fragen stellen, die in Form von Textbeiträgen besprochen werden können. Diese Beiträge können von allen Teilnehmenden der Veranstaltung gemerkt, verlinkt, positiv bewertet (sog. "Gefällt mir") und editiert werden (Letzeres nur von Lehrenden). Lehrende können zusätzlich Themen in Bereiche gliedern, zwischen den Bereichen verschiebe, im Bereich hervorheben und diesen öffnen und schließen.'),
            'descriptionlong' => _('Textbasierte zeit- und ortsunabhängige Möglichkeit zum Austausch von Gedanken, Meinungen und Erfahrungen. Lehrende und/oder Studierende können parallel zu Veranstaltungsthemen Fragen stellen, die in Form von Textbeiträgen besprochen werden können. Diese Beiträge können von allen Teilnehmenden der Veranstaltung gemerkt, verlinkt, positiv bewertet (sog. "Gefällt mir") und editiert werden (Letzeres nur von Lehrenden). Lehrende können zusätzlich Themen in Bereiche gliedern, zwischen den Bereichen verschieben, im Bereich hervorheben und diesen öffnen und schließen.'),
            'category' => _('Kommunikation und Zusammenarbeit'),
            'keywords' => _('Möglichkeit zum intensiven, nachhaltigen textbasierten Austausch; (nachträgliche) Strukturierung der Beiträge; Editierfunktion für Lehrende'),
            'icon' => Icon::create('forum', Icon::ROLE_INFO),
            'icon_clickable' => Icon::create('forum'),
            'screenshots' => [
                'path' => 'assets/images/plus/screenshots/Forum',
                'pictures' => [
                    0 => ['source' => 'Uebersicht.jpg', 'title' => _('Übersicht')],
                    1 => ['source' => 'Beitrag.jpg', 'title' => _('Beitrag')],
                    2 => ['source' => 'Beitrag_verfassen.jpg', 'title' => _('Beitrag verfassen')],
                ]
            ]
        ];
    }
}