view.php

<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle 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 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * This page prints a particular instance of etherpadlite.
 *
 * @package    mod_etherpadlite
 *
 * @author     Timo Welde <tjwelde@gmail.com>
 * @copyright  2012 Humboldt-Universität zu Berlin <moodle-support@cms.hu-berlin.de>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

require_once(dirname(__DIR__, 2) . '/config.php');
require_once(__DIR__ . '/lib.php');

$id = optional_param('id', 0, PARAM_INT); // The course_module id.
$a  = optional_param('a', 0, PARAM_INT);  // The etherpadlite instance id.

list($course, $cm, $etherpadlite) = \mod_etherpadlite\util::get_coursemodule($id, $a);

$context = context_module::instance($cm->id);

// This must be here, so that require login doesn't throw a warning.
$url = new moodle_url('/mod/etherpadlite/view.php', ['id' => $cm->id]);

$PAGE->set_url($url);
require_login($course, true, $cm);
$config = get_config('etherpadlite');

if ($config->ssl) {
    // The https_required doesn't work, if $CFG->loginhttps doesn't work.
    $CFG->httpswwwroot = str_replace('http:', 'https:', $CFG->wwwroot);
    if (!isset($_SERVER['HTTPS'])) {
        $url = $CFG->httpswwwroot . '/mod/etherpadlite/view.php?id=' . $id;

        redirect($url);
    }
}

// START of Initialise the session for the Author.
// Set vars.
$padid = $etherpadlite->uri;

// Make a new intance from the etherpadlite client. It might throw an exception.
$client = \mod_etherpadlite\api\client::get_instance($config->apikey, $config->url);

// Get group mode.
$groupmode      = groups_get_activity_groupmode($cm);
$canaddinstance = has_capability('mod/etherpadlite:addinstance', $context);
$isgroupmember  = true;
$urlpadid       = $padid;

if ($groupmode) {
    $activegroup = groups_get_activity_group($cm, true);
    if ($activegroup != 0) {
        $urlpadid .= $activegroup;
        $isgroupmember = groups_is_member($activegroup);
    }
}

// Check if Activity is in the open timeframe.
$time            = time();
$openrestricted  = !empty($etherpadlite->timeopen) && ($etherpadlite->timeopen >= $time);
$closerestricted = !empty($etherpadlite->timeclose) && ($etherpadlite->timeclose <= $time);
$timerestricted  = ($openrestricted || $closerestricted) && !$canaddinstance;

// Are there some guest restrictions?
$guestrestricted = isguestuser() && !etherpadlite_guestsallowed($etherpadlite);

// Are there some groups restrictions?
$grouprestricted = !$isgroupmember && !$canaddinstance;

// Fullurl generation depending on the restrictions.
if ($guestrestricted || $grouprestricted || $timerestricted) {
    if (!$readonlyid = $client->get_readonly_id($urlpadid)) {
        throw new \moodle_exception('could not get readonly id');
    }
    $fullurl = $client->get_baseurl() . '/p/' . $readonlyid;
} else {
    $fullurl = $client->get_baseurl() . '/p/' . $urlpadid;
}

// Get the groupID.
$epgroupid = explode('$', $padid);
$epgroupid = $epgroupid[0];

// Create author if not exists for logged in user (with full name as it is obtained from Moodle core library).
if ((isguestuser() && etherpadlite_guestsallowed($etherpadlite)) || !$isgroupmember) {
    $authorid = $client->create_author('Guest-' . etherpadlite_gen_random_string());
} else {
    $authorid = $client->create_author_if_not_exists_for($USER->id, fullname($USER));
}
if (!$authorid) {
    throw new \moodle_exception('could not create etherpad author');
}

// Create a browser session to the etherpad lite server.
if (!$client->create_session($epgroupid, $authorid)) {
    throw new \moodle_exception('could not create etherpad session');
}

// END of Etherpad Lite init.
// Display the etherpadlite and possibly results.
$eventparams = [
    'context'  => $context,
    'objectid' => $etherpadlite->id,
];
$event = \mod_etherpadlite\event\course_module_viewed::create($eventparams);
$event->add_record_snapshot('course_modules', $cm);
$event->add_record_snapshot('course', $course);
$event->add_record_snapshot('etherpadlite', $etherpadlite);
$event->trigger();

$PAGE->set_title(get_string('modulename', 'mod_etherpadlite') . ': ' . format_string($etherpadlite->name));
$PAGE->set_heading(format_string($course->fullname));
$PAGE->set_context($context);

// Add the keepalive system to keep checking for a connection.
\core\session\manager::keepalive();

$renderer = $PAGE->get_renderer('mod_etherpadlite');

// Print the page header.
echo $renderer->header();

require_once($CFG->libdir . '/grouplib.php');
$groupselecturl = new moodle_url($CFG->wwwroot . '/mod/etherpadlite/view.php',
    ['id' => $cm->id,
    ]);

groups_print_activity_menu($cm, $groupselecturl);

// Print the etherpad content.
if (\mod_etherpadlite\api\client::is_testing()) {
    $fullurl = new \moodle_url('/mod/etherpadlite/tests/fixtures/dummyoutput.html');
}
echo $renderer->render_etherpad($etherpadlite, $cm, $fullurl);

// Close the page.
echo $renderer->footer();