question/format/gift/format.php

   1 <?php // $Id$
   2 //
   3 ///////////////////////////////////////////////////////////////
   4 // The GIFT import filter was designed as an easy to use method
   5 // for teachers writing questions as a text file. It supports most
   6 // question types and the missing word format.
   7 //
   8 // Multiple Choice / Missing Word
   9 //     Who's buried in Grant's tomb?{~Grant ~Jefferson =no one}
  10 //     Grant is {~buried =entombed ~living} in Grant's tomb.
  11 // True-False:
  12 //     Grant is buried in Grant's tomb.{FALSE}
  13 // Short-Answer.
  14 //     Who's buried in Grant's tomb?{=no one =nobody}
  15 // Numerical
  16 //     When was Ulysses S. Grant born?{#1822:5}
  17 // Matching
  18 //     Match the following countries with their corresponding
  19 //     capitals.{=Canada->Ottawa =Italy->Rome =Japan->Tokyo}
  20 //
  21 // Comment lines start with a double backslash (//).
  22 // Optional question names are enclosed in double colon(::).
  23 // Answer feedback is indicated with hash mark (#).
  24 // Percentage answer weights immediately follow the tilde (for
  25 // multiple choice) or equal sign (for short answer and numerical),
  26 // and are enclosed in percent signs (% %). See docs and examples.txt for more.
  27 //
  28 // This filter was written through the collaboration of numerous
  29 // members of the Moodle community. It was originally based on
  30 // the missingword format, which included code from Thomas Robb
  31 // and others. Paul Tsuchido Shew wrote this filter in December 2003.
  32 //////////////////////////////////////////////////////////////////////////
  33 // Based on default.php, included by ../import.php
  34 /**
  35  * @package questionbank
  36  * @subpackage importexport
  37  */
  38 class qformat_gift extends qformat_default {
  39
  40     function provide_import() {
  41         return true;
  42     }
  43
  44     function provide_export() {
  45         return true;
  46     }
  47
  48     function answerweightparser(&$answer) {
  49         $answer = substr($answer, 1);                        // removes initial %
  50         $end_position  = strpos($answer, "%");
  51         $answer_weight = substr($answer, 0, $end_position);  // gets weight as integer
  52         $answer_weight = $answer_weight/100;                 // converts to percent
  53         $answer = substr($answer, $end_position+1);          // removes comment from answer
  54         return $answer_weight;
  55     }
  56
  57
  58     function commentparser(&$answer) {
  59         if (strpos($answer,"#") > 0){
  60             $hashpos = strpos($answer,"#");
  61             $comment = substr($answer, $hashpos+1);
  62             $comment = addslashes(trim($this->escapedchar_post($comment)));
  63             $answer  = substr($answer, 0, $hashpos);
  64         } else {
  65             $comment = " ";
  66         }
  67         return $comment;
  68     }
  69
  70     function split_truefalse_comment($comment){
  71         // splits up comment around # marks
  72         // returns an array of true/false feedback
  73         $bits = explode('#',$comment);
  74         $feedback = array('wrong' => $bits[0]);
  75         if (count($bits) >= 2) {
  76             $feedback['right'] = $bits[1];
  77         } else {
  78             $feedback['right'] = '';
  79         }
  80         return $feedback;
  81     }
  82
  83     function escapedchar_pre($string) {
  84         //Replaces escaped control characters with a placeholder BEFORE processing
  85
  86         $escapedcharacters = array("\\:",    "\\#",    "\\=",    "\\{",    "\\}",    "\\~",    "\\n"   );  //dlnsk
  87         $placeholders      = array("&&058;", "&&035;", "&&061;", "&&123;", "&&125;", "&&126;", "&&010" );  //dlnsk
  88
  89         $string = str_replace("\\\\", "&&092;", $string);
  90         $string = str_replace($escapedcharacters, $placeholders, $string);
  91         $string = str_replace("&&092;", "\\", $string);
  92         return $string;
  93     }
  94
  95     function escapedchar_post($string) {
  96         //Replaces placeholders with corresponding character AFTER processing is done
  97         $placeholders = array("&&058;", "&&035;", "&&061;", "&&123;", "&&125;", "&&126;", "&&010"); //dlnsk
  98         $characters   = array(":",     "#",      "=",      "{",      "}",      "~",      "\n"   ); //dlnsk
  99         $string = str_replace($placeholders, $characters, $string);
 100         return $string;
 101     }
 102
 103     function check_answer_count( $min, $answers, $text ) {
 104         $countanswers = count($answers);
 105         if ($countanswers < $min) {
 106             $importminerror = get_string( 'importminerror', 'quiz' );
 107             $this->error( $importminerror, $text );
 108             return false;
 109         }
 110
 111         return true;
 112     }
 113
 114
 115     function readquestion($lines) {
 116     // Given an array of lines known to define a question in this format, this function
 117     // converts it into a question object suitable for processing and insertion into Moodle.
 118
 119         $question = $this->defaultquestion();
 120         $comment = NULL;
 121         // define replaced by simple assignment, stop redefine notices
 122         $gift_answerweight_regex = "^%\-*([0-9]{1,2})\.?([0-9]*)%";
 123
 124         // REMOVED COMMENTED LINES and IMPLODE
 125         foreach ($lines as $key => $line) {
 126             $line = trim($line);
 127             if (substr($line, 0, 2) == "//") {
 128                 $lines[$key] = " ";
 129             }
 130         }
 131
 132         $text = trim(implode(" ", $lines));
 133
 134         if ($text == "") {
 135             return false;
 136         }
 137
 138         // Substitute escaped control characters with placeholders
 139         $text = $this->escapedchar_pre($text);
 140
 141         // Look for category modifier
 142         if (ereg( '^\$CATEGORY:', $text)) {
 143             // $newcategory = $matches[1];
 144             $newcategory = trim(substr( $text, 10 ));
 145
 146             // build fake question to contain category
 147             $question->qtype = 'category';
 148             $question->category = $newcategory;
 149             return $question;
 150         }
 151
 152         // QUESTION NAME parser
 153         if (substr($text, 0, 2) == "::") {
 154             $text = substr($text, 2);
 155
 156             $namefinish = strpos($text, "::");
 157             if ($namefinish === false) {
 158                 $question->name = false;
 159                 // name will be assigned after processing question text below
 160             } else {
 161                 $questionname = substr($text, 0, $namefinish);
 162                 $question->name = addslashes(trim($this->escapedchar_post($questionname)));
 163                 $text = trim(substr($text, $namefinish+2)); // Remove name from text
 164             }
 165         } else {
 166             $question->name = false;
 167         }
 168
 169
 170         // FIND ANSWER section
 171         // no answer means its a description
 172         $answerstart = strpos($text, "{");
 173         $answerfinish = strpos($text, "}");
 174
 175         $description = false;
 176         if (($answerstart === false) and ($answerfinish === false)) {
 177             $description = true;
 178             $answertext = '';
 179             $answerlength = 0;
 180         }
 181         elseif (!(($answerstart !== false) and ($answerfinish !== false))) {
 182             $this->error( get_string( 'braceerror', 'quiz' ), $text );
 183             return false;
 184         }
 185         else {
 186             $answerlength = $answerfinish - $answerstart;
 187             $answertext = trim(substr($text, $answerstart + 1, $answerlength - 1));
 188         }
 189
 190         // Format QUESTION TEXT without answer, inserting "_____" as necessary
 191         if ($description) {
 192             $questiontext = $text;
 193         }
 194         elseif (substr($text, -1) == "}") {
 195             // no blank line if answers follow question, outside of closing punctuation
 196             $questiontext = substr_replace($text, "", $answerstart, $answerlength+1);
 197         } else {
 198             // inserts blank line for missing word format
 199             $questiontext = substr_replace($text, "_____", $answerstart, $answerlength+1);
 200         }
 201
 202         // get questiontext format from questiontext
 203         $oldquestiontext = $questiontext;
 204         $questiontextformat = 0;
 205         if (substr($questiontext,0,1)=='[') {
 206             $questiontext = substr( $questiontext,1 );
 207             $rh_brace = strpos( $questiontext, ']' );
 208             $qtformat= substr( $questiontext, 0, $rh_brace );
 209             $questiontext = substr( $questiontext, $rh_brace+1 );
 210             if (!$questiontextformat = text_format_name( $qtformat )) {
 211                 $questiontext = $oldquestiontext;
 212             }
 213         }
 214         $question->questiontextformat = $questiontextformat;
 215         $question->questiontext = addslashes(trim($this->escapedchar_post($questiontext)));
 216
 217         // set question name if not already set
 218         if ($question->name === false) {
 219             $question->name = $question->questiontext;
 220             }
 221
 222         // ensure name is not longer than 250 characters
 223         $question->name = shorten_text( $question->name, 250 );
 224
 225         // determine QUESTION TYPE
 226         $question->qtype = NULL;
 227
 228         if ($description) {
 229             $question->qtype = DESCRIPTION;
 230         }
 231         elseif ($answertext == '') {
 232             $question->qtype = ESSAY;
 233         }
 234         elseif ($answertext{0} == "#"){
 235             $question->qtype = NUMERICAL;
 236
 237         } elseif (strpos($answertext, "~") !== false)  {
 238             // only Multiplechoice questions contain tilde ~
 239             $question->qtype = MULTICHOICE;
 240
 241         } elseif (strpos($answertext, "=")  !== false
 242                 && strpos($answertext, "->") !== false) {
 243             // only Matching contains both = and ->
 244             $question->qtype = MATCH;
 245
 246         } else { // either TRUEFALSE or SHORTANSWER
 247
 248             // TRUEFALSE question check
 249             $truefalse_check = $answertext;
 250             if (strpos($answertext,"#") > 0){
 251                 // strip comments to check for TrueFalse question
 252                 $truefalse_check = trim(substr($answertext, 0, strpos($answertext,"#")));
 253             }
 254
 255             $valid_tf_answers = array("T", "TRUE", "F", "FALSE");
 256             if (in_array($truefalse_check, $valid_tf_answers)) {
 257                 $question->qtype = TRUEFALSE;
 258
 259             } else { // Must be SHORTANSWER
 260                     $question->qtype = SHORTANSWER;
 261             }
 262         }
 263
 264         if (!isset($question->qtype)) {
 265             $giftqtypenotset = get_string('giftqtypenotset','quiz');
 266             $this->error( $giftqtypenotset, $text );
 267             return false;
 268         }
 269
 270         switch ($question->qtype) {
 271             case DESCRIPTION:
 272                 return $question;
 273                 break;
 274             case ESSAY:
 275                 $question->feedback = '';
 276                 $question->fraction = 0;
 277                 return $question;
 278                 break;
 279             case MULTICHOICE:
 280                 if (strpos($answertext,"=") === false) {
 281                     $question->single = 0;   // multiple answers are enabled if no single answer is 100% correct
 282                 } else {
 283                     $question->single = 1;   // only one answer allowed (the default)
 284                 }
 285
 286                 $answertext = str_replace("=", "~=", $answertext);
 287                 $answers = explode("~", $answertext);
 288                 if (isset($answers[0])) {
 289                     $answers[0] = trim($answers[0]);
 290                 }
 291                 if (empty($answers[0])) {
 292                     array_shift($answers);
 293                 }
 294
 295                 $countanswers = count($answers);
 296
 297                 if (!$this->check_answer_count( 2,$answers,$text )) {
 298                     return false;
 299                     break;
 300                 }
 301
 302                 foreach ($answers as $key => $answer) {
 303                     $answer = trim($answer);
 304
 305                     // determine answer weight
 306                     if ($answer[0] == "=") {
 307                         $answer_weight = 1;
 308                         $answer = substr($answer, 1);
 309
 310                     } elseif (ereg($gift_answerweight_regex, $answer)) {    // check for properly formatted answer weight
 311                         $answer_weight = $this->answerweightparser($answer);
 312
 313                     } else {     //default, i.e., wrong anwer
 314                         $answer_weight = 0;
 315                     }
 316                     $question->fraction[$key] = $answer_weight;
 317                     $question->feedback[$key] = $this->commentparser($answer); // commentparser also removes comment from $answer
 318                     $question->answer[$key]   = addslashes($this->escapedchar_post($answer));
 319                     $question->correctfeedback = '';
 320                     $question->partiallycorrectfeedback = '';
 321                     $question->incorrectfeedback = '';
 322                 }  // end foreach answer
 323
 324                 //$question->defaultgrade = 1;
 325                 //$question->image = "";   // No images with this format
 326                 return $question;
 327                 break;
 328
 329             case MATCH:
 330                 $answers = explode("=", $answertext);
 331                 if (isset($answers[0])) {
 332                     $answers[0] = trim($answers[0]);
 333                 }
 334                 if (empty($answers[0])) {
 335                     array_shift($answers);
 336                 }
 337
 338                 if (!$this->check_answer_count( 2,$answers,$text )) {
 339                     return false;
 340                     break;
 341                 }
 342
 343                 foreach ($answers as $key => $answer) {
 344                     $answer = trim($answer);
 345                     if (strpos($answer, "->") === false) {
 346                         $giftmatchingformat = get_string('giftmatchingformat','quiz');
 347                         $this->error($giftmatchingformat, $answer );
 348                         return false;
 349                         break 2;
 350                     }
 351
 352                     $marker = strpos($answer,"->");
 353                     $question->subquestions[$key] = addslashes(trim($this->escapedchar_post(substr($answer, 0, $marker))));
 354                     $question->subanswers[$key]   = addslashes(trim($this->escapedchar_post(substr($answer, $marker+2))));
 355
 356                 }  // end foreach answer
 357
 358                 return $question;
 359                 break;
 360
 361             case TRUEFALSE:
 362                 $answer = $answertext;
 363                 $comment = $this->commentparser($answer); // commentparser also removes comment from $answer
 364                 $feedback = $this->split_truefalse_comment($comment);
 365
 366                 if ($answer == "T" OR $answer == "TRUE") {
 367                     $question->answer = 1;
 368                     $question->feedbacktrue = $feedback['right'];
 369                     $question->feedbackfalse = $feedback['wrong'];
 370                 } else {
 371                     $question->answer = 0;
 372                     $question->feedbackfalse = $feedback['right'];
 373                     $question->feedbacktrue = $feedback['wrong'];
 374                 }
 375
 376                 $question->correctanswer = $question->answer;
 377
 378                 return $question;
 379                 break;
 380
 381             case SHORTANSWER:
 382                 // SHORTANSWER Question
 383                 $answers = explode("=", $answertext);
 384                 if (isset($answers[0])) {
 385                     $answers[0] = trim($answers[0]);
 386                 }
 387                 if (empty($answers[0])) {
 388                     array_shift($answers);
 389                 }
 390
 391                 if (!$this->check_answer_count( 1,$answers,$text )) {
 392                     return false;
 393                     break;
 394                 }
 395
 396                 foreach ($answers as $key => $answer) {
 397                     $answer = trim($answer);
 398
 399                     // Answer Weight
 400                     if (ereg($gift_answerweight_regex, $answer)) {    // check for properly formatted answer weight
 401                         $answer_weight = $this->answerweightparser($answer);
 402                     } else {     //default, i.e., full-credit anwer
 403                         $answer_weight = 1;
 404                     }
 405                     $question->fraction[$key] = $answer_weight;
 406                     $question->feedback[$key] = $this->commentparser($answer); //commentparser also removes comment from $answer
 407                     $question->answer[$key]   = addslashes($this->escapedchar_post($answer));
 408                 }     // end foreach
 409
 410                 //$question->usecase = 0;  // Ignore case
 411                 //$question->defaultgrade = 1;
 412                 //$question->image = "";   // No images with this format
 413                 return $question;
 414                 break;
 415
 416             case NUMERICAL:
 417                 // Note similarities to ShortAnswer
 418                 $answertext = substr($answertext, 1); // remove leading "#"
 419
 420                 // If there is feedback for a wrong answer, store it for now.
 421                 if (($pos = strpos($answertext, '~')) !== false) {
 422                     $wrongfeedback = substr($answertext, $pos);
 423                     $answertext = substr($answertext, 0, $pos);
 424                 } else {
 425                     $wrongfeedback = '';
 426                 }
 427
 428                 $answers = explode("=", $answertext);
 429                 if (isset($answers[0])) {
 430                     $answers[0] = trim($answers[0]);
 431                 }
 432                 if (empty($answers[0])) {
 433                     array_shift($answers);
 434                 }
 435
 436                 if (count($answers) == 0) {
 437                     // invalid question
 438                     $giftnonumericalanswers = get_string('giftnonumericalanswers','quiz');
 439                     $this->error( $giftnonumericalanswers, $text );
 440                     return false;
 441                     break;
 442                 }
 443
 444                 foreach ($answers as $key => $answer) {
 445                     $answer = trim($answer);
 446
 447                     // Answer weight
 448                     if (ereg($gift_answerweight_regex, $answer)) {    // check for properly formatted answer weight
 449                         $answer_weight = $this->answerweightparser($answer);
 450                     } else {     //default, i.e., full-credit anwer
 451                         $answer_weight = 1;
 452                     }
 453                     $question->fraction[$key] = $answer_weight;
 454                     $question->feedback[$key] = $this->commentparser($answer); //commentparser also removes comment from $answer
 455
 456                     //Calculate Answer and Min/Max values
 457                     if (strpos($answer,"..") > 0) { // optional [min]..[max] format
 458                         $marker = strpos($answer,"..");
 459                         $max = trim(substr($answer, $marker+2));
 460                         $min = trim(substr($answer, 0, $marker));
 461                         $ans = ($max + $min)/2;
 462                         $tol = $max - $ans;
 463                     } elseif (strpos($answer,":") > 0){ // standard [answer]:[errormargin] format
 464                         $marker = strpos($answer,":");
 465                         $tol = trim(substr($answer, $marker+1));
 466                         $ans = trim(substr($answer, 0, $marker));
 467                     } else { // only one valid answer (zero errormargin)
 468                         $tol = 0;
 469                         $ans = trim($answer);
 470                     }
 471
 472                     if (!(is_numeric($ans) || $ans = '*') || !is_numeric($tol)) {
 473                             $errornotnumbers = get_string( 'errornotnumbers' );
 474                             $this->error( $errornotnumbers, $text );
 475                         return false;
 476                         break;
 477                     }
 478
 479                     // store results
 480                     $question->answer[$key] = $ans;
 481                     $question->tolerance[$key] = $tol;
 482                 } // end foreach
 483
 484                 if ($wrongfeedback) {
 485                     $key += 1;
 486                     $question->fraction[$key] = 0;
 487                     $question->feedback[$key] = $this->commentparser($wrongfeedback);
 488                     $question->answer[$key] = '';
 489                     $question->tolerance[$key] = '';
 490                 }
 491
 492                 return $question;
 493                 break;
 494
 495                 default:
 496                     $giftnovalidquestion = get_string('giftnovalidquestion','quiz');
 497                     $this->error( $giftnovalidquestion, $text );
 498                 return false;
 499                 break;
 500
 501         } // end switch ($question->qtype)
 502
 503     }    // end function readquestion($lines)
 504
 505 function repchar( $text, $format=0 ) {
 506     // escapes 'reserved' characters # = ~ { ) : and removes new lines
 507     // also pushes text through format routine
 508     $reserved = array( '#', '=', '~', '{', '}', ':', "\n","\r");
 509     $escaped =  array( '\#','\=','\~','\{','\}','\:','\n',''  ); //dlnsk
 510
 511     $newtext = str_replace( $reserved, $escaped, $text );
 512     $format = 0; // turn this off for now
 513     if ($format) {
 514         $newtext = format_text( $format );
 515     }
 516     return $newtext;
 517     }
 518
 519 function writequestion( $question ) {
 520     // turns question into string
 521     // question reflects database fields for general question and specific to type
 522
 523     // initial string;
 524     $expout = "";
 525
 526     // add comment
 527     $expout .= "// question: $question->id  name: $question->name \n";
 528
 529     // get  question text format
 530     $textformat = $question->questiontextformat;
 531     $tfname = "";
 532     if ($textformat!=FORMAT_MOODLE) {
 533         $tfname = text_format_name( (int)$textformat );
 534         $tfname = "[$tfname]";
 535     }
 536
 537     // output depends on question type
 538     switch($question->qtype) {
 539     case 'category':
 540         // not a real question, used to insert category switch
 541         $expout .= "\$CATEGORY: $question->category\n";
 542         break;
 543     case DESCRIPTION:
 544         $expout .= '::'.$this->repchar($question->name).'::';
 545         $expout .= $tfname;
 546         $expout .= $this->repchar( $question->questiontext, $textformat);
 547         break;
 548     case ESSAY:
 549         $expout .= '::'.$this->repchar($question->name).'::';
 550         $expout .= $tfname;
 551         $expout .= $this->repchar( $question->questiontext, $textformat);
 552         $expout .= "{}\n";
 553         break;
 554     case TRUEFALSE:
 555         $trueanswer = $question->options->answers[$question->options->trueanswer];
 556         $falseanswer = $question->options->answers[$question->options->falseanswer];
 557         if ($trueanswer->fraction == 1) {
 558             $answertext = 'TRUE';
 559             $right_feedback = $trueanswer->feedback;
 560             $wrong_feedback = $falseanswer->feedback;
 561         } else {
 562             $answertext = 'FALSE';
 563             $right_feedback = $falseanswer->feedback;
 564             $wrong_feedback = $trueanswer->feedback;
 565         }
 566
 567         $wrong_feedback = $this->repchar($wrong_feedback);
 568         $right_feedback = $this->repchar($right_feedback);
 569         $expout .= "::".$this->repchar($question->name)."::".$tfname.$this->repchar( $question->questiontext,$textformat )."{".$this->repchar( $answertext );
 570         if ($wrong_feedback) {
 571             $expout .= "#" . $wrong_feedback;
 572         } else if ($right_feedback) {
 573             $expout .= "#";
 574         }
 575         if ($right_feedback) {
 576             $expout .= "#" . $right_feedback;
 577         }
 578         $expout .= "}\n";
 579         break;
 580     case MULTICHOICE:
 581         $expout .= "::".$this->repchar($question->name)."::".$tfname.$this->repchar( $question->questiontext, $textformat )."{\n";
 582         foreach($question->options->answers as $answer) {
 583             if ($answer->fraction==1) {
 584                 $answertext = '=';
 585             }
 586             elseif ($answer->fraction==0) {
 587                 $answertext = '~';
 588             }
 589             else {
 590                 $export_weight = $answer->fraction*100;
 591                 $answertext = "~%$export_weight%";
 592             }
 593             $expout .= "\t".$answertext.$this->repchar( $answer->answer );
 594             if ($answer->feedback!="") {
 595                 $expout .= "#".$this->repchar( $answer->feedback );
 596             }
 597             $expout .= "\n";
 598         }
 599         $expout .= "}\n";
 600         break;
 601     case SHORTANSWER:
 602         $expout .= "::".$this->repchar($question->name)."::".$tfname.$this->repchar( $question->questiontext, $textformat )."{\n";
 603         foreach($question->options->answers as $answer) {
 604             $weight = 100 * $answer->fraction;
 605             $expout .= "\t=%".$weight."%".$this->repchar( $answer->answer )."#".$this->repchar( $answer->feedback )."\n";
 606         }
 607         $expout .= "}\n";
 608         break;
 609     case NUMERICAL:
 610         $expout .= "::".$this->repchar($question->name)."::".$tfname.$this->repchar( $question->questiontext, $textformat )."{#\n";
 611         foreach ($question->options->answers as $answer) {
 612             if ($answer->answer != '') {
 613                 $expout .= "\t=".$answer->answer.":".(float)$answer->tolerance."#".$this->repchar( $answer->feedback )."\n";
 614             } else {
 615                 $expout .= "\t~#".$this->repchar( $answer->feedback )."\n";
 616             }
 617         }
 618         $expout .= "}\n";
 619         break;
 620     case MATCH:
 621         $expout .= "::".$this->repchar($question->name)."::".$tfname.$this->repchar( $question->questiontext, $textformat )."{\n";
 622         foreach($question->options->subquestions as $subquestion) {
 623             $expout .= "\t=".$this->repchar( $subquestion->questiontext )." -> ".$this->repchar( $subquestion->answertext )."\n";
 624         }
 625         $expout .= "}\n";
 626         break;
 627     case DESCRIPTION:
 628         $expout .= "// DESCRIPTION type is not supported\n";
 629         break;
 630     case MULTIANSWER:
 631         $expout .= "// CLOZE type is not supported\n";
 632         break;
 633     default:
 634         notify("No handler for qtype $question->qtype for GIFT export" );
 635     }
 636     // add empty line to delimit questions
 637     $expout .= "\n";
 638     return $expout;
 639 }
 640 }
 641 ?>