edit.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/>.
/**
 * Edit page. Allows user to edit and/or preview wiki pages.
 *
 * @copyright &copy; 2007 The Open University
 * @author s.marshall@open.ac.uk
 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
 * @package ouwiki
 */

require_once(dirname(__FILE__).'/../../config.php');
require_once($CFG->dirroot.'/lib/ajax/ajaxlib.php');
require_once($CFG->dirroot.'/mod/ouwiki/basicpage.php');
require_once($CFG->dirroot.'/mod/ouwiki/edit_form.php');

if (file_exists($CFG->dirroot.'/local/mobile/ou_lib.php')) {
    require_once($CFG->dirroot.'/local/mobile/ou_lib.php');
}

$action = optional_param('editoption', '', PARAM_TEXT);

// for creating pages and sections
$frompage = optional_param('frompage', null, PARAM_TEXT);
$newsection = optional_param('newsection', null, PARAM_TEXT);

// for creating/editing sections
$section = optional_param('section', null, PARAM_RAW);

$urlparams = array();
$urlparams['id'] = $cm->id;
if (!empty($pagename)) {
    $urlparams['page'] = $pagename;
}
if (!empty($newsection)) {
    $urlparams['newsection'] = $newsection;
}
if (!empty($section)) {
    $urlparams['section'] = $section;
}

// sort out if the action was save or cancel
$save = $action === get_string('savechanges') ? true : false;
$cancel = $action === get_string('cancel') ? true : false;

if (!$cm = get_coursemodule_from_id('ouwiki', $id)) {
    throw new moodle_exception('invalidcoursemodule');
}

// Checking course instance
$course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);

if (!$ouwiki = $DB->get_record('ouwiki', array('id' => $cm->instance))) {
    throw new moodle_exception('invalidcoursemodule');
}

$PAGE->set_cm($cm);

// When creating a new page, do some checks
$addpage = false;
if (!is_null($frompage)) {
    $urlparams['frompage'] = $frompage;
    $returnurl = new moodle_url('/mod/ouwiki/view.php',
            ouwiki_display_wiki_parameters($frompage, $subwiki, $cm, OUWIKI_PARAMS_ARRAY));
    if (trim($pagename) === '') {
        throw new moodle_exception('emptypagetitle', 'ouwiki', $returnurl);
    }
    // Strip whitespace from new page name from form (editor does this for other links).
    $pagename = preg_replace('/\s+/', ' ', $pagename);

    $addpage = true;
}

$returnurl = new moodle_url('/mod/ouwiki/view.php',
        ouwiki_display_wiki_parameters($pagename, $subwiki, $cm, OUWIKI_PARAMS_ARRAY));

// When creating a section, do checks
$addsection = false;
if (!is_null($newsection)) {
    if (trim($newsection) === '') {
        throw new moodle_exception('emptysectiontitle', 'ouwiki', $returnurl);
    }
    $addsection = true;
}

$context = context_module::instance($cm->id);
$PAGE->set_pagelayout('incourse');
require_course_login($course, true, $cm);

$ouwikioutput = $PAGE->get_renderer('mod_ouwiki');

require_capability('mod/ouwiki:edit', $context);

$url = new moodle_url('/mod/ouwiki/edit.php', $urlparams);
$PAGE->set_url($url);

// Check permission
if (!$subwiki->canedit) {
    throw new moodle_exception('You do not have permission to edit this wiki');
}

$useattachments = !$addsection && !$section;

// create the new mform
// customdata indicates whether attachments are used (no for sections)
$mform = new mod_ouwiki_edit_page_form('edit.php', (object)array(
        'attachments' => $useattachments, 'startpage' => $pagename === '',
        'addpage' => $addpage, 'addsection' => $addsection));

// get form content if save/preview
$content = null;
$formdata = null;
if ($formdata = $mform->get_data()) {
    if ($content = $formdata->content['text']) {
        // Check if they used the plaintext editor, if so fixup linefeeds
        if ((isset($formdata->content['format'])) && ($formdata->content['format'] != FORMAT_HTML)) {
            $content = ouwiki_plain_to_xhtml($content);
        }
        $content = ouwiki_format_xhtml_a_bit($content); // Tidy up HTML
    }
}

// new content for section
if ($newsection) {
    $new = new StdClass;
    $new->name = ouwiki_display_user($USER, $course->id);
    $new->date = userdate(time());
    $sectionheader = html_writer::tag('h3', s($newsection)) .
            html_writer::tag('p', '(' . get_string('createdbyon', 'ouwiki', $new) . ')');
}

// if cancel redirect before going too far
if ($cancel) {
    // Get pageid to unlock.
    $pageversion = ouwiki_get_current_page($subwiki, $pagename);
    if (!empty($pageversion->pageid)) {
        ouwiki_release_lock($pageversion->pageid);
    }
    redirect($returnurl);
    exit;
}

// Get the current page version, creating page if needed
$pageversion = ouwiki_get_current_page($subwiki, $pagename, OUWIKI_GETPAGE_CREATE);
if ($addpage && !is_null($pageversion->xhtml)) {
    throw new moodle_exception('duplicatepagetitle', 'ouwiki', $returnurl);
}
if ($pageversion->locked === '1') {
    throw new moodle_exception('thispageislocked', 'ouwiki', 'view.php?id=' . $cm->id);
}

// Need list of known sections on current version
$knownsections = ouwiki_find_sections($pageversion->xhtml);

// Get section, make sure the name is valid
if ($section && !preg_match('/^[0-9]+_[0-9]+$/', $section)) {
    $section = null;
}
if ($section) {
    if (!array_key_exists($section, $knownsections)) {
        throw new moodle_exception("Unknown section $section");
    }
    $sectiontitle = $knownsections[$section];
    $sectiondetails = ouwiki_get_section_details($pageversion->xhtml, $section);
}


// Get lock
if (!$cancel) {
    list($lockok, $lock) = ouwiki_obtain_lock($ouwiki, $pageversion->pageid);
}

if ($save) {
    if (!$newsection ) {
        // Check we started editing the right version
        $startversionid = required_param('startversionid', PARAM_INT);
        $versionok = $startversionid == $pageversion->versionid;
    } else {
        $versionok = true;
    }

    // If we either don't have a lock or are editing the wrong version...
    if (!$versionok || !$lockok) {
        $savefailtitle = get_string('savefailtitle', 'ouwiki');
        $specificmessage = get_string(!$versionok ? 'savefaildesynch' : 'savefaillocked', 'ouwiki');
        $returntoview = get_string('returntoview', 'ouwiki');
        $savefailcontent = get_string('savefailcontent', 'ouwiki');
        $actualcontent = ouwiki_convert_content($content, $subwiki, $cm, null, $pageversion->xhtmlformat);

        // we are either returning to an existing page or a "new" one that ws
        // simultaneously created by someone else at the same time
        $returnpage = $addpage ? $frompage : $pagename;

        ouwiki_release_lock($pageversion->pageid);
        echo $OUTPUT->header();

        $pagefield = '';
        if ($returnpage !== '') {
            $pagefield = html_writer::empty_tag('input', array('type' => 'hidden',
                    'name' => 'page', 'value' => $returnpage));
        }
        print '<div id="ouwiki_savefail">'
            .'<h2>'.$savefailtitle.'</h2>'
            .'<p>'.$specificmessage.'</p>'
            .'<form action="view.php" method="get">'
            .'<input type="hidden" name="id" value="'.$cm->id.'" />'
            . $pagefield
            .'<input type="submit" value="'.$returntoview.'" />'
            .'</form>'
            .'<p>'.$savefailcontent.'</p>'
            .'<div class="ouwiki_savefailcontent">'.$actualcontent.'</div>'
            .'</div><div>';

        ouwiki_print_footer($course, $cm, $subwiki, $pagename);
        exit;
    }

    $event = null;
    if ($section) {
        ouwiki_save_new_version_section($course, $cm, $ouwiki, $subwiki, $pagename, $pageversion->xhtml, $formdata->content['text'], $sectiondetails, $formdata);
    } else {
        if ($addpage) {
            ouwiki_create_new_page($course, $cm, $ouwiki, $subwiki, $frompage, $pagename, $content, $formdata);
        } else {
            if ($addsection) {
                ouwiki_create_new_section($course, $cm, $ouwiki, $subwiki, $pagename, $formdata->content['text'], $sectionheader, $formdata);
            } else {
                // Normal save
                ouwiki_save_new_version($course, $cm, $ouwiki, $subwiki, $pagename, $content, -1, -1, -1, null, $formdata);
            }
        }
    }

    // Update completion state
    $completion = new completion_info($course);
    if ($completion->is_enabled($cm) && ($ouwiki->completionedits || $ouwiki->completionpages)) {
        $completion->update_state($cm, COMPLETION_COMPLETE);
    }

    // Release lock, log and redirect.
    ouwiki_release_lock($pageversion->pageid);

    // Log.
    $info = '';
    if ($pagename) {
        $info = $pagename;
    }

    // Log usage edit.
    $params = array(
            'context' => $context,
            'objectid' => $pageversion->pageid,
            'other' => array('info' => $info, 'logurl' => $url->out_as_local_url())
    );

    if ($addpage) {
        $event = \mod_ouwiki\event\page_created::create($params);
    } else {
        $event = \mod_ouwiki\event\page_updated::create($params);
    }
    $event->add_record_snapshot('course_modules', $cm);
    $event->add_record_snapshot('course', $course);
    $event->add_record_snapshot('ouwiki', $ouwiki);
    $event->trigger();

    // Redirect.
    redirect($returnurl);
    exit;
}

if ($section) {
    $sectionfields = "<input type='hidden' name='section' value='$section' />";
} else {
    $sectionfields = '';
}

// Handle case where page is locked by someone else
if (!$lockok) {
    echo $OUTPUT->header();

    $lockholder = $DB->get_record('user', array('id' => $lock->userid));
    $canoverride = has_capability('mod/ouwiki:overridelock', $context);
    $pagelockedtimeout = null;

    $cancel = get_string('cancel');
    $tryagain = get_string('tryagain', 'ouwiki');
    $pagelockedtitle = get_string('pagelockedtitle', 'ouwiki');
    $overridelock = get_string('overridelock', 'ouwiki');

    $details = new StdClass;
    $details->name = fullname($lockholder);
    $details->lockedat = ouwiki_nice_date($lock->lockedat);
    $details->seenat = ouwiki_nice_date($lock->seenat);
    if ($lock->seenat > time()) {
        // When the 'seen at' value is greater than current time, that means
        // their lock has been automatically confirmed in advance because they
        // don't have JavaScript support.
        $details->nojs = ouwiki_nice_date($lock->seenat + OUWIKI_LOCK_PERSISTENCE);
        $pagelockeddetails = get_string('pagelockeddetailsnojs', 'ouwiki', $details);
    } else {
        $pagelockeddetails = get_string('pagelockeddetails', 'ouwiki', $details);
        if ($lock->expiresat) {
            $pagelockedtimeout = get_string('pagelockedtimeout', 'ouwiki', userdate($lock->expiresat));
        }
    }

    $pagelockedoverride = $canoverride ? '<p>'.get_string('pagelockedoverride', 'ouwiki').'</p>' : '';

    print "<div id='ouwiki_lockinfo'>
        <h2>$pagelockedtitle</h2>
        <p>$pagelockeddetails $pagelockedtimeout</p>
        $pagelockedoverride
        <div class='ouwiki_lockinfobuttons'>";

    if ($pagename === '') {
        $pageinputs = '';
    } else {
        $pageinputs = html_writer::empty_tag('input', array('type' => 'hidden',
                        'name' => 'page', 'value' => $pagename));
    }
    if ($addpage) {
        $pageinputs .= html_writer::empty_tag('input', array('type' => 'hidden',
                        'name' => 'frompage', 'value' => $frompage));
    }

    $newsectioninput = '';
    if ($addsection) {
        $newsectioninput = html_writer::empty_tag('input', array('type' => 'hidden',
                'name' => 'newsection', 'value' => $newsection));
    }

    print "<form action='edit.php' method='get'>
            <input type='hidden' name='id' value='$cm->id' />
            $pageinputs
            $newsectioninput
            $sectionfields
            <input type='submit' value='$tryagain' />
        </form>";

    print "<form action='view.php' method='get'>
            <input type='hidden' name='id' value='$cm->id' />
            $pageinputs
            $newsectioninput
            $sectionfields
            <input type='submit' value='$cancel' />
        </form>";

    print $canoverride
        ? "<form class='ouwiki_overridelock' action='override.php' method='post'>
        <input type='hidden' name='id' value='$cm->id' />
        $pageinputs
        $newsectioninput
        <input type='submit' value='$overridelock' /></form>"
        : '';

    print "</div></div><div>";

    ouwiki_print_footer($course, $cm, $subwiki, $pagename);
    exit;
}

// The page is now locked to us! Go ahead and print edit form

// get title of the page
$title = get_string('editingpage', 'ouwiki');
$wikiname = format_string(htmlspecialchars($ouwiki->name));
$name = '';
if ($pagename) {
    $title .= ': ' . $pagename;
} else {
    if ($addsection) {
        $sectiontitle = $newsection;
        $name = htmlspecialchars($newsection);
        $title = get_string('editingsection', 'ouwiki', $name);
        $section = true;
    } else {
        if (!$section) {
            $name = get_string('startpage', 'ouwiki');
        } else {
            $name = htmlspecialchars($sectiontitle);
            $title = get_string('editingsection', 'ouwiki', $name);
        }
    }
}
$title = $wikiname.' - '.$title;

echo $ouwikioutput->ouwiki_print_start($ouwiki, $cm, $course, $subwiki, $pagename, $context,
    array(array('name' =>
        $section
            ? get_string('editingsection', 'ouwiki', htmlspecialchars($sectiontitle))
            : get_string('editingpage', 'ouwiki'), 'link' => null)
        ), false, false, '', $title);

if ($newsection) {
    $section = false;
}

// Tabs
ouwiki_print_tabs('edit', $pagename, $subwiki, $cm, $context, $pageversion->versionid ? true : false);

// setup the edit locking
ouwiki_print_editlock($lock, $ouwiki);

// Calculate initial text for editor
if ($section) {
    $existing = $sectiondetails->content;
} else if ($newsection) {
    $existing = $sectionheader;
} else if ($pageversion) {
    $existing = $pageversion->xhtml;
} else {
    $existing = '';
}

// print the preview box
if ($content) {
    echo $ouwikioutput->ouwiki_print_preview($content, $pagename, $subwiki, $cm, $pageversion->xhtmlformat);
    $existing = $content;
}

// Get the annotations and add prepare them for editing
$annotations = ouwiki_get_annotations($pageversion);
ouwiki_highlight_existing_annotations($existing, $annotations, 'edit');

print get_string('advice_edit', 'ouwiki', $OUTPUT->help_icon('createlinkedwiki', 'ouwiki'));
if ($ouwiki->timeout) {
    $countdowntext = get_string('countdowntext', 'ouwiki', $ouwiki->timeout/60);
    print("<p><div id=\"ouw_countdown\" ></div>$countdowntext<span id=\"ouw_countdownurgent\" aria-live=\"polite\"></span><span id=\"ouw_countdownurgent_sr\" aria-live=\"polite\" class=\"sr-only\"></span></p>");
}

// Set up basic form data
$data = new StdClass;
$data->id = $cm->id;
$data->startversionid = $pageversion->versionid;
$data->page = $pagename;
$data->frompage = $frompage;
$data->newsection = $newsection;
$data->section = $section;
$data->user = $subwiki->userid;

// Prepare form file manager attachments
if ($useattachments) {
    $attachmentsdraftid = file_get_submitted_draft_itemid('attachments');
    file_prepare_draft_area($attachmentsdraftid, $context->id, 'mod_ouwiki',
            'attachment', empty($pageversion->versionid) ? null : $pageversion->versionid);
    $data->attachments = $attachmentsdraftid;
}

// Prepare form editor attachments
$contentdraftid = file_get_submitted_draft_itemid('content');
$currenttext = file_prepare_draft_area($contentdraftid, $context->id, 'mod_ouwiki', 'content',
        empty($pageversion->versionid) ? null : $pageversion->versionid,
        array('subdirs' => false), empty($existing) ? '' : $existing);

$data->content = array('text' => $currenttext,
       'format' => empty($pageversion->xhtmlformat)
           ? editors_get_preferred_format() : $pageversion->xhtmlformat,
       'itemid' => $contentdraftid);

$mform->set_data($data);

$mform->display();

echo $ouwikioutput->get_bottom_buttons($subwiki, $cm, $context, $pageversion, false);

$stringlist = array(
        array('savefailnetwork', 'ouwiki'),
        array('savefailtitle', 'ouwiki'),
        array('savefailsession', 'ouwiki'),
        array('savefailtext', 'ouwiki'),
);
$jsmodule = array(
        'name' => 'mod_ouwiki_edit',
        'fullpath' => '/mod/ouwiki/module.js',
        'requires' => array('base', 'event', 'io', 'node', 'anim', 'moodle-core-notification-alert', 'button'),
        'strings'  => $stringlist
);
if (get_config('mod_ouwiki', 'savecheck')) {
    $PAGE->requires->js_init_call('M.mod_ouwiki_edit.init', array($context->id), true, $jsmodule);
}

// Footer
ouwiki_print_footer($course, $cm, $subwiki, $pagename);