path: root/app/controllers/course/enrolment.php

<?php
/**
 * enrolment.php - enrolment in courses
 *
 * 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      André Noack <noack@data-quest.de>
 * @license     http://www.gnu.org/licenses/gpl-2.0.html GPL version 2
 * @category    Stud.IP
 * @package     admin
 */

/**
 * @addtogroup notifications
 *
 * Enrolling in a course triggers a CourseDidEnroll
 * notification. The course's ID is transmitted as
 * subject of the notification.
 */
class Course_EnrolmentController extends AuthenticatedController
{
    protected $allow_nobody = true;

    /**
     * common tasks for all actions
     */
    public function before_filter(&$action, &$args)
    {
        parent::before_filter($action, $args);
        $this->course_id = $args[0];

        if (!in_array($action, words('apply claim delete order_down order_up'))) {
            $this->redirect($this->applyURL($action));
            return false;
        }
        if (!get_object_type($this->course_id, ['sem'])) {
            throw new Trails\Exception(400);
        }
        $course = Course::find($this->course_id);
        $enrolment_info = $course->getEnrolmentInformation($GLOBALS['user']->id);
        //Ist bereits Teilnehmer/Admin/freier Zugriff -> gleich weiter
        if (
            $enrolment_info->isEnrolmentAllowed()
            && (
                in_array($enrolment_info->getCodeword(), ['root', 'course_admin', 'already_member'])
                || ($enrolment_info->getCodeword() === 'free_access' && !User::findCurrent())
            )
        ) {
            $redirect_url = URLHelper::getUrl('dispatch.php/course/go', ['to' => $this->course_id]);
            if (Request::isXhr()) {
                $this->response->add_header('X-Location', $redirect_url);
                $this->render_nothing();
            } else {
                $this->redirect($redirect_url);
            }
            return false;
        }
        //Grundsätzlich verboten
        if (!$enrolment_info->isEnrolmentAllowed()) {
            throw new AccessDeniedException($enrolment_info->getMessage());
        }
        PageLayout::setTitle($course->getFullName() . ' - ' . _('Veranstaltungsanmeldung'));
        if (Request::submitted('cancel')) {
            $this->redirect(URLHelper::getURL('dispatch.php/course/details/', ['sem_id' => $this->course_id]));
        }
    }

    /**
     * A person applies for a course.
     */
    public function apply_action()
    {
        if (Request::submitted('decline')) {
            $this->relocate(URLHelper::getLink('dispatch.php/course/details', ['sem_id' => $this->course_id]));
            return;
        }
        $this->admission_error = '';
        $this->admission_form = '';
        $this->course = Course::find($this->course_id);

        try {
            CSRFProtection::verifyUnsafeRequest();
            $this->confirmed = Request::submittedSome('apply', 'claim');
        } catch (Exception $e) {
            $this->confirmed = false;
        }
        $msg_details = [];
        $msg = '';
        $user = User::findCurrent();
        $enrol_user = false;
        $courseset = CourseSet::getSetForCourse($this->course_id);
        if ($courseset) {
            $errors = $courseset->checkAdmission($user->id, $this->course_id);
            if (count($errors)) {
                $this->courseset_message = $courseset->toString(true);
                $this->admission_error = MessageBox::error(_('Die Anmeldung war nicht erfolgreich.'), $errors);
                $admission_form = '';
                foreach ($courseset->getAdmissionRules() as $rule) {
                    $admission_form .= $rule->getInput();
                }
                if ($admission_form) {
                    $this->admission_form = $admission_form;
                }
            } else {
                if ($courseset->isSeatDistributionEnabled()) {
                    if ($courseset->hasAlgorithmRun()) {
                        if ($courseset->getSeatDistributionTime()) {
                            $msg = _('Die Plätze in dieser Veranstaltung wurden automatisch verteilt.');
                        }
                        if (StudipLock::get('enrolment' . $this->course_id)) {
                            $course = Course::find($this->course_id);
                            if ($course->getFreeSeats() && !$course->getNumWaiting()) {
                                $enrol_user = true;
                            } elseif ($user && $course->isWaitlistAvailable()) {

                                try {
                                    $application = $course->addMemberToWaitlist($user, 'last');
                                    $msg = _('Diese Veranstaltung ist teilnahmebeschränkt.');
                                    $msg_details[] = sprintf(_('Alle Plätze sind belegt, Sie wurden daher auf Platz %s der Warteliste gesetzt.'), $application->position);
                                } catch (Studip\Exception $e) {
                                    $this->admission_error = MessageBox::error($e->getMessage());
                                }

                            } elseif ($course->admission_disable_waitlist) {
                                $this->admission_error = MessageBox::error(_('Die Anmeldung war nicht erfolgreich. Alle Plätze sind belegt und es steht keine Warteliste zur Verfügung.'));
                            } else {
                                $this->admission_error = MessageBox::error(_('Die Anmeldung war nicht erfolgreich. Alle Plätze sind belegt und es stehen keine Wartelistenplätze zur Verfügung, da die Warteliste voll ist.'));
                            }
                        } else {
                            $this->admission_error = MessageBox::error(_('Die Anmeldung war wegen technischer Probleme nicht erfolgreich. Bitte versuchen Sie es später noch einmal.'));
                        }
                    } else {
                        $msg = _('Die Plätze in dieser Veranstaltung werden automatisch verteilt.');
                        if ($limit = $courseset->getAdmissionRule('LimitedAdmission')) {
                            $this->user_max_limit = $limit->getMaxNumberForUser($user->id);
                            if (Config::get()->IMPORTANT_SEMNUMBER) {
                                $order = "ORDER BY VeranstaltungsNummer, Name";
                            } else {
                                $order = "ORDER BY Name";
                            }
                            $this->priocourses = Course::findMany($courseset->getCourses(), $order);
                            if (!$GLOBALS['perm']->have_perm(Config::get()->SEM_VISIBILITY_PERM)) {
                                $this->priocourses = array_filter($this->priocourses,
                                    function ($c) {
                                        return $c->visible;
                                    }
                                );
                            }
                            $msg_details[] = sprintf(_('Diese Veranstaltung gehört zu einem Anmeldeset mit %s Veranstaltungen. Sie können maximal %s davon belegen. Bei der Verteilung werden die von Ihnen gewünschten Prioritäten berücksichtigt.'), count($this->priocourses), $limit->getMaxNumber());
                            $this->user_prio = AdmissionPriority::getPrioritiesByUser($courseset->getId(), $user->id);
                            $this->max_limit = $limit->getMaxNumber();
                            $this->prio_stats = AdmissionPriority::getPrioritiesStats($courseset->getId());
                            $this->already_claimed = count($this->user_prio);
                        } else {
                            $this->priocourses = Course::find($this->course_id);
                            $this->already_claimed = array_key_exists($this->course_id, AdmissionPriority::getPrioritiesByUser($courseset->getId(), $user->id));
                        }
                        $msg_details[] = _('Zeitpunkt der automatischen Verteilung: ') . strftime("%x %X", $courseset->getSeatDistributionTime());
                        $this->num_claiming = count(AdmissionPriority::getPrioritiesByCourse($courseset->getId(), $this->course_id));
                        if ($this->already_claimed) {
                            $msg_details[] = _('Sie sind bereits für die Verteilung angemeldet.');
                        }
                    }
                    if ($msg) {
                        $this->courseset_message = MessageBox::info($msg, $msg_details);
                    }
                } else {
                    $enrol_user = true;
                }
            }
        } else {
            $enrol_user = true;
        }

        if (!$this->course->getSemClass()['studygroup_mode'] && $this->course->admission_prelim && $this->course->admission_prelim_txt && !Request::submitted('apply')) {
            $this->admission_prelim_txt = $this->course->admission_prelim_txt;
            $this->admission_prelim_comment = Config::get()->ADMISSION_PRELIM_COMMENT_ENABLE;
            $this->admission_form = $this->render_template_as_string('course/enrolment/prelim');
            $enrol_user = false;
        }

        if ($enrol_user && $this->confirmed) {
            $course = Course::find($this->course_id);
            if ($course->admission_prelim) {
                if (Request::get('admission_comment')) {
                    $admission_comment = get_fullname() . ': ' . Request::get('admission_comment');
                } else {
                    $admission_comment = '';
                }
                try {
                    $course->addPreliminaryMember($user, $admission_comment);
                } catch (Exception $e) {
                    PageLayout::postError($e->getMessage());
                    return;
                }
                if ($course->isStudygroup()) {
                    if (StudygroupModel::isInvited($user->id, $this->course_id)) {
                        // an invitation exists, so accept the join request automatically
                        $status = 'autor';
                        StudygroupModel::accept_user($user->username, $this->course_id);
                        StudygroupModel::cancelInvitation($user->username, $this->course_id);
                        $success = sprintf(
                            _('Sie wurden in die Veranstaltung %1$s als %2$s eingetragen.'),
                            htmlReady($course->getFullName()),
                            htmlReady(get_title_for_status($status, 1, $course->status))
                        );
                        PageLayout::postSuccess($success);
                    } else {
                        $success = sprintf(
                            _('Sie wurden auf die Anmeldeliste der Studiengruppe %s eingetragen. Die Personen, die die Studiengruppe moderieren, können Sie jetzt freischalten.'),
                            htmlReady($course->name)
                        );
                        PageLayout::postSuccess($success);
                    }
                } else {
                    $success = sprintf(
                        _('Sie wurden in die Veranstaltung %s vorläufig eingetragen.'),
                        htmlReady($course->getFullName())
                    );
                    PageLayout::postSuccess($success);
                }
            } else {
                $status = 'autor';
                try {
                    $course->addMember($user, $status);
                } catch (Studip\Exception $e) {
                    PageLayout::postError($e->getMessage());
                }
                $success = sprintf(
                    _('Sie wurden in die Veranstaltung %1$s als %2$s eingetragen.'),
                    htmlReady($course->getFullName()),
                    htmlReady(get_title_for_status($status, 1, $course->status))
                );
                PageLayout::postSuccess($success);

                if (StudygroupModel::isInvited($user->id, $this->course_id)) {
                    // delete an existing invitation
                    StudygroupModel::cancelInvitation($user->username, $this->course_id);
                }
            }
            unset($this->courseset_message);
        }

        $this->enrol_user = $enrol_user ?: false;

        StudipLock::release();

        if ($enrol_user && $this->confirmed) {
            if (!empty($course) && $course->admission_prelim) {
                $this->relocate(URLHelper::getLink('dispatch.php/course/details', ['sem_id' => $this->course_id]));
            } else {
                $this->relocate(URLHelper::getLink('dispatch.php/course/go', ['to' => $this->course_id]));
            }
        } elseif ($enrol_user) {

            PageLayout::postQuestion(
                sprintf(
                    _('Wollen Sie sich zu der Veranstaltung "%s" wirklich anmelden?'),
                    htmlReady(Course::find($this->course_id)->name)
                ),
                $this->action_url("apply/{$this->course_id}", ['apply' => 1]),
                $this->action_url("apply/{$this->course_id}", ['decline' => 1])
            );

            $this->relocate(URLHelper::getLink('dispatch.php/course/details', ['sem_id' => $this->course_id]));
        }
    }

    /**
     * Prioritize courses.
     */
    public function claim_action()
    {
        CSRFProtection::verifyUnsafeRequest();
        $user_id = $GLOBALS['user']->id;
        $courseset = CourseSet::getSetForCourse($this->course_id);
        $anchor = '';
        $changed = 0;
        if ($courseset->isSeatDistributionEnabled() && !count($courseset->checkAdmission($user_id, $this->course_id))) {
            if ($limit = $courseset->getAdmissionRule('LimitedAdmission')) {
                $admission_user_limit = Request::int('admission_user_limit');
                if ($admission_user_limit && $admission_user_limit <= $limit->getMaxNumber()) {
                    $limit->setCustomMaxNumber($user_id, $admission_user_limit);
                }
                $admission_prio = $this->getPrioritiesFromRequest();
                $old_prio_count = AdmissionPriority::unsetAllPrioritiesForUser($courseset->getId(), $user_id);
                if ($order_up = key(Request::getArray('admission_prio_order_up'))) {
                    $prio_to_move = $admission_prio[$order_up];
                    $change_with = array_search($prio_to_move - 1, $admission_prio);
                    $admission_prio[$order_up] = $prio_to_move - 1;
                    $admission_prio[$change_with] = $prio_to_move;
                }
                if ($order_down = key(Request::getArray('admission_prio_order_down'))) {
                    $prio_to_move = $admission_prio[$order_down];
                    $change_with = array_search($prio_to_move + 1, $admission_prio);
                    $admission_prio[$order_down] = $prio_to_move + 1;
                    $admission_prio[$change_with] = $prio_to_move;
                }
                if ($delete = key(Request::getArray('admission_prio_delete'))) {
                    unset($admission_prio[$delete]);
                    $changed = 1;

                    if ($admission_prio) {
                        $admission_prio = array_combine(
                            array_keys($admission_prio),
                            range(1, count($admission_prio))
                        );
                    }
                }
                foreach ($admission_prio as $course_id => $p) {
                    $changed += AdmissionPriority::setPriority($courseset->getId(), $user_id, $course_id, $p);
                }
                if ($changed || ($old_prio_count && !count($admission_prio))) {
                    if (count(AdmissionPriority::getPrioritiesByUser($courseset->getId(), $user_id))) {
                        $anchor = '#enrollment';
                        PageLayout::postSuccess(_('Ihre Priorisierung wurde gespeichert.'));
                    } else {
                        PageLayout::postSuccess(_('Ihre Anmeldung zur Platzvergabe wurde zurückgezogen.'));
                    }
                }
            } else {
                if (Request::int('courseset_claimed')) {
                    if (AdmissionPriority::setPriority($courseset->getId(), $user_id, $this->course_id, 1)) {
                        PageLayout::postSuccess(_('Ihre Anmeldung zur Platzvergabe wurde gespeichert.'));
                    }
                } else {
                    if (AdmissionPriority::unsetPriority($courseset->getId(), $user_id, $this->course_id)) {
                        PageLayout::postSuccess(_('Ihre Anmeldung zur Platzvergabe wurde zurückgezogen.'));
                    }
                }
            }
        }
        $this->redirect($this->action_url("apply/{$this->course_id}{$anchor}"));
    }

    /**
     * Get the priorities from the request. This will discard all defined
     * priorities and set them according to their position.
     */
    private function getPrioritiesFromRequest(): array
    {
        $admission_prio = Request::getArray('admission_prio');
        if (count($admission_prio) === 0) {
            return [];
        }

        // Ensure all items have a positive priority that is not zero
        $max_prio = max($admission_prio);
        foreach ($admission_prio as $course_id => $prio) {
            if ($prio <= 0) {
                $admission_prio[$course_id] = ++$max_prio;
            }
        }

        // Sort the array by the defined priories
        asort($admission_prio);

        // Set the priorities according to their position
        return array_combine(
            array_keys($admission_prio),
            range(1, count($admission_prio))
        );
    }
}