attempt.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 attempt of game
 *
 * @package mod_game
 * @copyright 2007 Vasilis Daloukas
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 **/
require_once(dirname(__FILE__).'/../../config.php');
require_once( "lib.php");
require_once( "locallib.php");

require_once( "hangman/play.php");
require_once( "cross/play.php");
require_once( "cryptex/play.php");
require_once( "millionaire/play.php");
require_once( "sudoku/play.php");
require_once( "bookquiz/play.php");
require_once( "snakes/play.php");
require_once( "hiddenpicture/play.php");

$action  = optional_param('action', "", PARAM_ALPHANUM);  // Is the param action.

game_show_header( $id, $game, $course, $context, $cm);
game_do_attempt( $game, $action, $course, $context, $cm);

/**
 * Do the required checks and print header.
 *
 * @param int $id
 * @param stdClass $game
 * @param stdClass $course
 * @param stdClass $context
 * @param stdClass $cm
 */
function game_show_header( &$id, &$game, &$course, &$context, &$cm) {
    global $DB, $USER, $PAGE, $OUTPUT;

    $id = optional_param('id', 0, PARAM_INT); // It represents Course Module ID.
    $q = optional_param('q',  0, PARAM_INT);  // It represents game id.

    if ($id) {
        if (! $cm = get_coursemodule_from_id('game', $id)) {
            print_error('invalidcoursemodule');
        }
        if (! $course = $DB->get_record('course', array('id' => $cm->course))) {
            print_error('coursemisconf');
        }
        if (! $game = $DB->get_record('game', array('id' => $cm->instance))) {
            print_error('invalidcoursemodule');
        }
    } else {
        if (! $game = $DB->get_record('game', array('id' => $q))) {
            print_error('invalidgameid', 'game');
        }
        if (! $course = $DB->get_record('course', array('id' => $game->course))) {
            print_error('invalidcourseid');
        }
        if (! $cm = get_coursemodule_from_instance('game', $game->id, $course->id)) {
            print_error('invalidcoursemodule');
        }
    }

    // Check login and get context.
    require_login($course->id, false, $cm);
    $context = game_get_context_module_instance( $cm->id);
    require_capability('mod/game:view', $context);

    // Cache some other capabilites we use several times.
    $canattempt = has_capability('mod/game:attempt', $context);
    $canreviewmine = has_capability('mod/game:reviewmyattempts', $context);

    // Create an object to manage all the other (non-roles) access rules.
    $timenow = time();

    // Log this request.
    if ( game_use_events()) {
        require( 'classes/event/game_played.php');
        \mod_game\event\game_played::played($game, $context)->trigger();
    } else {
        add_to_log($course->id, 'game', 'view', "view.php?id=$cm->id", $game->id, $cm->id);
    }

    // Initialize $PAGE, compute blocks.
    $PAGE->set_url('/mod/game/view.php', array('id' => $cm->id));

    $edit = optional_param('edit', -1, PARAM_BOOL);
    if ($edit != -1 && $PAGE->user_allowed_editing()) {
        $USER->editing = $edit;
    }

    // Note: MDL-19010 there will be further changes to printing header and blocks.
    // The code will be much nicer than this eventually.
    $title = $course->shortname . ': ' . format_string($game->name);

    if ($PAGE->user_allowed_editing() && !empty($CFG->showblocksonmodpages)) {
        $buttons = '<table><tr><td><form method="get" action="view.php"><div>'.
                '<input type="hidden" name="id" value="'.$cm->id.'" />'.
                '<input type="hidden" name="edit" value="'.($PAGE->user_is_editing() ? 'off' : 'on').'" />'.
                '<input type="submit" value="'.get_string($PAGE->user_is_editing() ? 'blockseditoff' : 'blocksediton').
                '" /></div></form></td></tr></table>';
        $PAGE->set_button($buttons);
    }

    $PAGE->set_title($title);
    $PAGE->set_heading($course->fullname);

    echo $OUTPUT->header();
}

/**
 * Do one attempt.
 *
 * @param stdClass $game
 * @param string $action
 * @param stdClass $course
 * @param stdClass $context
 * @param stdClass $cm
 */
function game_do_attempt( $game, $action, $course, $context, $cm) {
    global $OUTPUT;

    $forcenew = optional_param('forcenew', false, PARAM_BOOL); // Teacher has requested new preview.
    $endofgame = optional_param('endofgame', false, PARAM_BOOL);
    $pos = optional_param('pos',  0, PARAM_INT);
    $num = optional_param('num',  0, PARAM_INT);
    $q = optional_param('q',  0, PARAM_INT);
    $attemptid = optional_param('attemptid',  0, PARAM_INT);
    $g = optional_param('g',  '', PARAM_RAW);
    $finishattempt = optional_param('finishattempt',  '', PARAM_TEXT);
    $answer = optional_param('answer',  '', PARAM_TEXT);
    $continue = false;

    // Print the main part of the page.
    switch ( $action) {
        case 'crosscheck':
            $attempt = game_getattempt( $game, $detail);
            $g = game_cross_unpackpuzzle( $g);
            game_cross_continue( $cm, $game, $attempt, $detail, $g, $finishattempt, $context, $course);
            break;
        case 'crossprint':
            $attempt = game_getattempt( $game, $detail);
            game_cross_play( $cm->id, $game, $attempt, $detail, '', true, false, false, true, $context);
            break;
        case 'sudokucheck':     // The student tries to answer a question.
            $attempt = game_getattempt( $game, $detail);
            game_sudoku_check_questions( $cm, $game, $attempt, $detail, $finishattempt, $course, $context);
            $continue = true;
            break;
        case 'sudokucheckg':    // The student tries to guess a glossaryenry.
            $attempt = game_getattempt( $game, $detail);
            $endofgame = array_key_exists( 'endofgame', $_GET);
            $continue = game_sudoku_check_glossaryentries( $cm, $game, $attempt, $detail, $endofgame, $course);
            $continue = true;
            break;
        case 'sudokucheckn':    // The user tries to guess a number.
            $attempt = game_getattempt( $game, $detail);
            game_sudoku_check_number( $cm, $game, $attempt, $detail, $pos, $num, $context, $course);
            $continue = false;
            break;
        case 'cryptexcheck':    // The user tries to guess a question.
            $attempt = game_getattempt( $game, $detail);
            game_cryptex_check( $cm, $game, $attempt, $detail, $q, $answer, $finishattempt, $context, $course);
            break;
        case 'bookquizcheck':   // The student tries to answer a question.
            $attempt = game_getattempt( $game, $detail);
            game_bookquiz_check_questions( $cm, $game, $attempt, $detail, $context, $course);
            break;
        case 'snakescheck':     // The student tries to answer a question.
            $attempt = game_getattempt( $game, $detail);
            game_snakes_check_questions( $cm, $game, $attempt, $detail, $context, $course);
            break;
        case 'snakescheckg':    // The student tries to answer a question from glossary.
            $attempt = game_getattempt( $game, $detail);
            game_snakes_check_glossary( $cm, $game, $attempt, $detail, $context, $course);
            break;
        case 'hiddenpicturecheckg': // The student tries to guess a glossaryentry.
            $attempt = game_getattempt( $game, $detail);
            game_hiddenpicture_check_mainquestion( $cm, $game, $attempt, $detail, $endofgame, $context, $course);
            break;
        default:
            $continue = true;
            break;
    }
    if ($continue) {
        game_create( $game, $forcenew, $course, $context, $finishattempt, $cm);
    }
    // Finish the page.
    echo $OUTPUT->footer();
}

/**
 * Creates one game.
 *
 * @param stdClass $game
 * @param int $forcenew
 * @param stdClass $course
 * @param stdClass $context
 * @param boolean $finishattempt
 * @param stdClass $cm
 */
function game_create( $game, $forcenew, $course, $context, $finishattempt, $cm) {
    global $USER, $CFG, $DB;

    $attempt = game_getattempt( $game, $detail);
    $chapterid = optional_param('chapterid',  0, PARAM_INT);
    $newletter = optional_param('newletter',  '', PARAM_ALPHA);
    $action2 = optional_param('action2',  '', PARAM_ALPHA);

    switch ( $game->gamekind) {
        case 'cross':
            game_cross_continue( $cm, $game, $attempt, $detail, '', $forcenew, $context, $course);
            break;
        case 'hangman':
            game_hangman_continue( $cm, $game, $attempt, $detail, $newletter, $action2, $context, $course);
            break;
        case 'millionaire':
            game_millionaire_continue( $cm, $game, $attempt, $detail, $context, $course);
            break;
        case 'bookquiz':
            game_bookquiz_continue( $cm, $game, $attempt, $detail, $chapterid, $context, $course);
            break;
        case 'sudoku':
            game_sudoku_continue( $cm, $game, $attempt, $detail, $finishattempt, $context, $course);
            break;
        case 'cryptex':
            game_cryptex_continue( $cm, $game, $attempt, $detail, $forcenew, $context, $course);
            break;
        case 'snakes':
            game_snakes_continue( $cm, $game, $attempt, $detail, $context, $course);
            break;
        case 'hiddenpicture':
            game_hiddenpicture_continue( $cm, $game, $attempt, $detail, $context, $course);
            break;
        default:
            print_error( "Game {$game->gamekind} not found");
            break;
    }
}

/**
 * Unpacks the cross.
 *
 * @param string $g
 */
function game_cross_unpackpuzzle( $g) {
    $ret = "";
    $len = game_strlen( $g);
    while ($len) {
        for ($i = 0; $i < $len; $i++) {
            $c = game_substr( $g, $i, 1);
            if ( $c >= '1' and $c <= '9') {
                if ( $i > 0) {
                    // Found escape character.
                    if (game_substr( $g, $i - 1, 1) == '/') {
                        $g = game_substr( $g, 0, $i - 1).game_substr( $g, $i);
                        $i--;
                        $len--;
                        continue;
                    }
                }
                break;
            }
        }

        if ($i < $len) {
            // Found the start of a number.
            for ($j = $i + 1; $j < $len; $j++) {
                $c = game_substr( $g, $j, 1);
                if ($c < '0' or $c > '9') {
                    break;
                }
            }
            $count = game_substr( $g, $i, $j - $i);
            $ret .= game_substr( $g, 0, $i) . str_repeat( '_', $count);

            $g = game_substr( $g, $j);
            $len = game_strlen( $g);
        } else {
            $ret .= $g;
            break;
        }
    }

    return $ret;
}