<?php // $Id: edit.php,v 1.107.2.13 2009/06/05 09:18:35 tjhunt Exp $
/**
 * Page to edit quizzes
 *
 * This page generally has two columns:
 * The right column lists all available questions in a chosen category and
 * allows them to be edited or more to be added. This column is only there if
 * the quiz does not already have student attempts
 * The left column lists all questions that have been added to the current quiz.
 * The lecturer can add questions from the right hand list to the quiz or remove them
 *
 * The script also processes a number of actions:
 * Actions affecting a quiz:
 * up and down  Changes the order of questions and page breaks
 * addquestion  Adds a single question to the quiz
 * add          Adds several selected questions to the quiz
 * addrandom    Adds a certain number of random questions to the quiz
 * repaginate   Re-paginates the quiz
 * delete       Removes a question from the quiz
 * savechanges  Saves the order and grades for questions in the quiz
 *
 * @author Martin Dougiamas and many others. This has recently been extensively
 *         rewritten by Gustav Delius and other members of the Serving Mathematics project
 *         {@link http://maths.york.ac.uk/serving_maths}
 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
 * @package quiz
 */
    require_once("../../config.php");
    require_once($CFG->dirroot.'/mod/quiz/editlib.php');

    /**
     * Callback function called from question_list() function (which is called from showbank())
     * Displays action icon as first action for each question.
     */
    function module_specific_actions($pageurl, $questionid, $cmid, $canuse){
        global $CFG;
        if ($canuse){
            // for RTL languages: switch right and left arrows /****/
            if (right_to_left()) { 
                $movearrow = 'removeright.gif'; 
            } else { 
                $movearrow = 'moveleft.gif'; 
            } 
            $straddtoquiz = get_string("addtoquiz", "quiz");
            $out = "<a title=\"$straddtoquiz\" href=\"edit.php?".$pageurl->get_query_string()."&amp;addquestion=$questionid&amp;sesskey=".sesskey()."\"><img
                  src=\"$CFG->pixpath/t/$movearrow\" alt=\"$straddtoquiz\" /></a>&nbsp;";
            return $out;
        } else {
            return '';
        }
    }
    /**
     * Callback function called from question_list() function (which is called from showbank())
     * Displays button in form with checkboxes for each question.
     */
    function module_specific_buttons($cmid){
        global $THEME;
        $straddtoquiz = get_string("addtoquiz", "quiz");
        $out = "<input type=\"submit\" name=\"add\" value=\"{$THEME->larrow} $straddtoquiz\" />\n";
        return $out;
    }


    /**
     * Callback function called from question_list() function (which is called from showbank())
     */
    function module_specific_controls($totalnumber, $recurse, $category, $cmid){
        global $QTYPES;
        $out = '';
        $catcontext = get_context_instance_by_id($category->contextid);
        if (has_capability('moodle/question:useall', $catcontext)){
            $randomusablequestions = $QTYPES['random']->get_usable_questions_from_category(
                    $category->id, $recurse, '0');
            $maxrand = count($randomusablequestions);
            if ($maxrand > 0) {
                for ($i = 1;$i <= min(10, $maxrand); $i++) {
                    $randomcount[$i] = $i;
                }
                for ($i = 20;$i <= min(100, $maxrand); $i += 10) {
                    $randomcount[$i] = $i;
                }
                $out .= '<br />';
                $out .= get_string('addrandom', 'quiz', choose_from_menu($randomcount, 'randomcount', '1', '', '', '', true));
                $out .= '<input type="hidden" name="recurse" value="'.$recurse.'" />';
                $out .= '<input type="hidden" name="categoryid" value="'.$category->id.'" />';
                $out .= ' <input type="submit" name="addrandom" value="'. get_string('add') .'" />';
                $out .= helpbutton('random', get_string('random', 'quiz'), 'quiz', true, false, '', true);
            }
        }
        return $out;
    }

    list($thispageurl, $contexts, $cmid, $cm, $quiz, $pagevars) = question_edit_setup('editq', true);

    //these params are only passed from page request to request while we stay on this page
    //otherwise they would go in question_edit_setup
    $quiz_showbreaks = optional_param('showbreaks', -1, PARAM_BOOL);
    $quiz_reordertool = optional_param('reordertool', 0, PARAM_BOOL);
    if ($quiz_showbreaks > -1) {
        $thispageurl->param('showbreaks', $quiz_showbreaks);
    } else {
        $quiz_showbreaks = ($CFG->quiz_questionsperpage < 2) ? 0 : 1;
    }
    if ($quiz_reordertool != 0) {
        $thispageurl->param('reordertool', $quiz_reordertool);
    }

    $strquizzes = get_string('modulenameplural', 'quiz');
    $strquiz = get_string('modulename', 'quiz');
    $streditingquestions = get_string('editquestions', "quiz");
    $streditingquiz = get_string('editinga', 'moodle', $strquiz);

    // Get the course object and related bits.
    if (! $course = get_record("course", "id", $quiz->course)) {
        error("This course doesn't exist");
    }

    // Log this visit.
    add_to_log($cm->course, 'quiz', 'editquestions',
            "view.php?id=$cm->id", "$quiz->id", $cm->id);

    //you need mod/quiz:manage in addition to question capabilities to access this page.
    require_capability('mod/quiz:manage', $contexts->lowest());

    if (isset($quiz->instance)
        && empty($quiz->grades)){  // Construct an array to hold all the grades.
        $quiz->grades = quiz_get_all_question_grades($quiz);
    }


/// Now, check for commands on this page and modify variables as necessary
    // If any edit action makes a sifnificant change to the structure of the quiz, then we
    // will need to delete all preview attempts.
    $significantchangemade = false;

    if (($up = optional_param('up', false, PARAM_INT)) !== false and confirm_sesskey()) { /// Move the given question up a slot
        $questions = explode(",", $quiz->questions);
        if ($up > 0 and isset($questions[$up])) {
            $prevkey = ($questions[$up-1] == 0) ? $up-2 : $up-1;
            $swap = $questions[$prevkey];
            $questions[$prevkey] = $questions[$up];
            $questions[$up]   = $swap;
            $quiz->questions = implode(",", $questions);
            // Always have a page break at the end
            $quiz->questions = $quiz->questions . ',0';
            // Avoid duplicate page breaks
            $quiz->questions = str_replace(',0,0', ',0', $quiz->questions);
            if (!set_field('quiz', 'questions', $quiz->questions, 'id', $quiz->instance)) {
                error('Could not save question list');
            }
            $significantchangemade = true;
        }
    }

    if (($down = optional_param('down', false, PARAM_INT)) !== false and confirm_sesskey()) { /// Move the given question down a slot
        $questions = explode(",", $quiz->questions);
        if ($down < count($questions)) {
            $nextkey = ($questions[$down+1] == 0) ? $down+2 : $down+1;
            $swap = $questions[$nextkey];
            $questions[$nextkey] = $questions[$down];
            $questions[$down]   = $swap;
            $quiz->questions = implode(",", $questions);
            // Avoid duplicate page breaks
            $quiz->questions = str_replace(',0,0', ',0', $quiz->questions);
            if (!set_field('quiz', 'questions', $quiz->questions, 'id', $quiz->instance)) {
                error('Could not save question list');
            }
            $significantchangemade = true;
        }
    }

    if (($addquestion = optional_param('addquestion', 0, PARAM_INT)) and confirm_sesskey()) { /// Add a single question to the current quiz
        quiz_add_quiz_question($addquestion, $quiz);
        $significantchangemade = true;
    }

    if (optional_param('add', false, PARAM_BOOL) and confirm_sesskey()) { /// Add selected questions to the current quiz
        $rawdata = (array) data_submitted();
        foreach ($rawdata as $key => $value) {    // Parse input for question ids
            if (preg_match('!^q([0-9]+)$!', $key, $matches)) {
                $key = $matches[1];
                quiz_add_quiz_question($key, $quiz);
            }
        }
        $significantchangemade = true;
    }

    if (optional_param('addrandom', false, PARAM_BOOL) and confirm_sesskey()) { /// Add random questions to the quiz
        $recurse = optional_param('recurse', 0, PARAM_BOOL);
        $categoryid = required_param('categoryid', PARAM_INT);
        $randomcount = required_param('randomcount', PARAM_INT);
        // load category
        if (! $category = get_record('question_categories', 'id', $categoryid)) {
            error('Category ID is incorrect');
        }
        $catcontext = get_context_instance_by_id($category->contextid);
        require_capability('moodle/question:useall', $catcontext);
        $category->name = addslashes($category->name);
        // Find existing random questions in this category that are not used by any quiz.
        if ($existingquestions = get_records_sql(
                "SELECT * FROM " . $CFG->prefix . "question q
                WHERE qtype = '" . RANDOM . "'
                    AND category = $category->id
                    AND " . sql_compare_text('questiontext') . " = '$recurse'
                    AND NOT EXISTS (SELECT * FROM " . $CFG->prefix . "quiz_question_instances WHERE question = q.id)
                ORDER BY id")) {
            // Take as many of these as needed.
            while (($existingquestion = array_shift($existingquestions)) and $randomcount > 0) {
                quiz_add_quiz_question($existingquestion->id, $quiz);
                $randomcount--;
            }
        }

        // If more are needed, create them.
        if ($randomcount > 0) {
            $form->questiontext = $recurse; // we use the questiontext field to store the info
                                            // on whether to include questions in subcategories
            $form->questiontextformat = 0;
            $form->image = '';
            $form->defaultgrade = 1;
            $form->hidden = 1;
            for ($i = 0; $i < $randomcount; $i++) {
                $form->category = "$category->id,$category->contextid";
                $form->stamp = make_unique_id_code();  // Set the unique code (not to be changed)
                $question = new stdClass;
                $question->qtype = RANDOM;
                $question = $QTYPES[RANDOM]->save_question($question, $form, $course);
                if(!isset($question->id)) {
                    error('Could not insert new random question!');
                }
                quiz_add_quiz_question($question->id, $quiz);
            }
        }
        $significantchangemade = true;
    }

    if (optional_param('repaginate', false, PARAM_BOOL) and confirm_sesskey()) { /// Re-paginate the quiz
        $questionsperpage = optional_param('questionsperpage', $quiz->questionsperpage, PARAM_INT);
        if ($questionsperpage != $quiz->questionsperpage) {
            $quiz->questionsperpage = $questionsperpage;
            if (!set_field('quiz', 'questionsperpage', $quiz->questionsperpage, 'id', $quiz->id)) {
                error('Could not save number of questions per page');
            }
        }
        $quiz->questions = quiz_repaginate($quiz->questions, $quiz->questionsperpage);
        if (!set_field('quiz', 'questions', $quiz->questions, 'id', $quiz->id)) {
            error('Could not save layout');
        }
        $significantchangemade = true;
    }
    if (($delete = optional_param('delete', false, PARAM_INT)) !== false and confirm_sesskey()) { /// Remove a question from the quiz
        quiz_delete_quiz_question($delete, $quiz);
        $significantchangemade = true;
    }

    if (optional_param('savechanges', false, PARAM_BOOL) and confirm_sesskey()) {
    /// We need to save the new ordering (if given) and the new grades
        $oldquestions = explode(",", $quiz->questions); // the questions in the old order
        $questions = array(); // for questions in the new order
        $rawgrades = (array) data_submitted();
        unset($quiz->grades);
        foreach ($rawgrades as $key => $value) {
        /// Parse input for question -> grades
            if (preg_match('!^q([0-9]+)$!', $key, $matches)) {
                $key = $matches[1];
                $quiz->grades[$key] = clean_param($value, PARAM_INTEGER);
                quiz_update_question_instance($quiz->grades[$key], $key, $quiz->instance);

            /// Parse input for ordering info
            } elseif (preg_match('!^o([0-9]+)$!', $key, $matches)) {
                $key = $matches[1];
                // Make sure two questions don't overwrite each other. If we get a second
                // question with the same position, shift the second one along to the next gap.
                $value = clean_param($value, PARAM_INTEGER);
                while (array_key_exists($value, $questions)) {
                    $value++;
                }
                $questions[$value] = $oldquestions[$key];
            }
        }

        // If ordering info was given, reorder the questions
        if ($questions) {
            ksort($questions);
            // Make sure that the quiz does not start with a page break.
            while (reset($questions) == '0') {
                array_shift($questions);
            }
            $quiz->questions = implode(",", $questions);
            // Always have a page break at the end
            $quiz->questions = $quiz->questions . ',0';
            // Avoid duplicate page breaks
            while (strpos($quiz->questions, ',0,0')) {
                $quiz->questions = str_replace(',0,0', ',0', $quiz->questions);
            }
            if (!set_field('quiz', 'questions', $quiz->questions, 'id', $quiz->instance)) {
                error('Could not save question list');
            }
        }

        // If rescaling is required save the new maximum
        $maxgrade = optional_param('maxgrade', -1, PARAM_INTEGER);
        if ($maxgrade >= 0) {
            if (!quiz_set_grade($maxgrade, $quiz)) {
                error('Could not set a new maximum grade for the quiz');
            }
        }
        $significantchangemade = true;
    }

/// Delete any teacher preview attempts if the quiz has been modified
    if ($significantchangemade) {
        $previewattempts = get_records_select('quiz_attempts',
                'quiz = ' . $quiz->id . ' AND preview = 1');
        if ($previewattempts) {
            foreach ($previewattempts as $attempt) {
                quiz_delete_attempt($attempt, $quiz);
            }
        }
    }

    question_showbank_actions($thispageurl, $cm);

/// all commands have been dealt with, now print the page

    // Print basic page layout.
    if (isset($quiz->instance) and record_exists_select('quiz_attempts', "quiz = '$quiz->instance' AND preview = '0'")){
        // one column layout with table of questions used in this quiz
        $strupdatemodule = has_capability('moodle/course:manageactivities', $contexts->lowest())
                    ? update_module_button($cm->id, $course->id, get_string('modulename', 'quiz'))
                    : "";
        $navigation = build_navigation($streditingquiz, $cm);
        print_header_simple($streditingquiz, '', $navigation, "", "",
                 true, $strupdatemodule);

        $currenttab = 'edit';
        $mode = 'editq';

        include('tabs.php');

        print_box_start();

        echo "<div class=\"quizattemptcounts\">\n";
        echo '<a href="report.php?mode=overview&amp;id=' . $cm->id . '">' .
                quiz_num_attempt_summary($quiz, $cm) . '</a><br />' .
                get_string('cannoteditafterattempts', 'quiz');
        echo "</div>\n";

        $sumgrades = quiz_print_question_list($quiz,  $thispageurl, false, $quiz_showbreaks, $quiz_reordertool);
        if (!set_field('quiz', 'sumgrades', $sumgrades, 'id', $quiz->instance)) {
            error('Failed to set sumgrades');
        }

        print_box_end();
        print_footer($course);
        exit;
    }

    // two column layout with quiz info in left column
    $strupdatemodule = has_capability('moodle/course:manageactivities', $contexts->lowest())
        ? update_module_button($cm->id, $course->id, get_string('modulename', 'quiz'))
        : "";
    $navigation = build_navigation($streditingquiz, $cm);
    print_header_simple($streditingquiz, '', $navigation, "", "", true, $strupdatemodule);

    $currenttab = 'edit';
    $mode = 'editq';

    include('tabs.php');

    echo '<table border="0" style="width:100%" cellpadding="2" cellspacing="0">';
    echo '<tr><td style="width:50%" valign="top">';
    print_box_start('generalbox quizquestions');
    print_heading(get_string('questionsinthisquiz', 'quiz'), '', 2);

    $sumgrades = quiz_print_question_list($quiz, $thispageurl, true, $quiz_showbreaks, $quiz_reordertool);
    if (!set_field('quiz', 'sumgrades', $sumgrades, 'id', $quiz->instance)) {
        error('Failed to set sumgrades');
    }

    print_box_end();

    echo '</td><td style="width:50%" valign="top">';

    question_showbank('editq', $contexts, $thispageurl, $cm, $pagevars['qpage'], $pagevars['qperpage'], $pagevars['qsortorder'], $pagevars['qsortorderdecoded'],
                    $pagevars['cat'], $pagevars['recurse'], $pagevars['showhidden'], $pagevars['showquestiontext']);

    echo '</td></tr>';
    echo '</table>';

    print_footer($course);
?>
