Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
<?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/>.

/**
 * Blackboard V5 and V6 question importer.
 *
 * @package    qformat_blackboard_six
 * @copyright  2005 Michael Penney
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined('MOODLE_INTERNAL') || die();

require_once($CFG->libdir . '/xmlize.php');
require_once($CFG->dirroot . '/question/format/blackboard_six/formatbase.php');
require_once($CFG->dirroot . '/question/format/blackboard_six/formatqti.php');
require_once($CFG->dirroot . '/question/format/blackboard_six/formatpool.php');

/**
 * Class to represent a Blackboard file.
 *
 * @package    qformat_blackboard_six
 * @copyright  2005 Michael Penney
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class qformat_blackboard_six_file {
    /** @var int type of file being imported, one of the constants FILETYPE_QTI or FILETYPE_POOL. */
    public $filetype;
    /** @var string the xml text */
    public $text;
    /** @var string path to path to root of image tree in unzipped archive. */
    public $filebase = '';
}

/**
 * Blackboard Six QTI file importer class.
 *
 * @package    qformat_blackboard_six
 * @copyright  2005 Michael Penney
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class qformat_blackboard_six extends qformat_blackboard_six_base {
    /** @var int Blackboard assessment qti files were always imported by the blackboard_six plugin. */
    const FILETYPE_QTI = 1;
    /** @var int Blackboard question pool files were previously handled by the blackboard plugin. */
    const FILETYPE_POOL = 2;
> /** @var string temporary directory/folder. */ > public $temp_dir;
/** * Return the content of a file given by its path in the tempdir directory. * * @param string $path path to the file inside tempdir * @return mixed contents array or false on failure */ public function get_filecontent($path) { $fullpath = $this->tempdir . '/' . clean_param($path, PARAM_PATH); if (is_file($fullpath) && is_readable($fullpath)) { return file_get_contents($fullpath); } return false; } /** * Return content of all files containing questions, * as an array one element for each file found, * For each file, the corresponding element is an array of lines. * * @param string $filename name of file * @return mixed contents array or false on failure */ public function readdata($filename) { global $CFG; // Find if we are importing a .dat file. if (strtolower(pathinfo($filename, PATHINFO_EXTENSION)) == 'dat') { if (!is_readable($filename)) { $this->error(get_string('filenotreadable', 'error')); return false; } $fileobj = new qformat_blackboard_six_file(); // As we are not importing a .zip file, // there is no imsmanifest, and it is not possible // to parse it to find the file type. // So we need to guess the file type by looking at the content. // For now we will do that searching for a required tag. // This is certainly not bullet-proof but works for all usual files. $fileobj->text = file_get_contents($filename); if (strpos($fileobj->text, '<questestinterop>')) { $fileobj->filetype = self::FILETYPE_QTI; } if (strpos($fileobj->text, '<POOL>')) { $fileobj->filetype = self::FILETYPE_POOL; } // In all other cases we are not able to handle this question file. // Readquestions is now expecting an array of strings. return array($fileobj); } // We are importing a zip file. // Create name for temporary directory. $uniquecode = time(); $this->tempdir = make_temp_directory('bbquiz_import/' . $uniquecode); if (is_readable($filename)) { if (!copy($filename, $this->tempdir . '/bboard.zip')) { $this->error(get_string('cannotcopybackup', 'question')); fulldelete($this->tempdir); return false; } $packer = get_file_packer('application/zip'); if ($packer->extract_to_pathname($this->tempdir . '/bboard.zip', $this->tempdir)) { $dom = new DomDocument(); if (!$dom->load($this->tempdir . '/imsmanifest.xml')) { $this->error(get_string('errormanifest', 'qformat_blackboard_six')); fulldelete($this->tempdir); return false; } $xpath = new DOMXPath($dom); // We starts from the root element. $query = '//resources/resource'; $qfile = array(); $examfiles = $xpath->query($query); foreach ($examfiles as $examfile) { $fileobj = new qformat_blackboard_six_file(); if ($examfile->getAttribute('type') == 'assessment/x-bb-qti-test' || $examfile->getAttribute('type') == 'assessment/x-bb-qti-pool') { if ($content = $this->get_filecontent($examfile->getAttribute('bb:file'))) { $fileobj->filetype = self::FILETYPE_QTI; $fileobj->filebase = $this->tempdir; $fileobj->text = $content; $qfile[] = $fileobj; } } if ($examfile->getAttribute('type') == 'assessment/x-bb-pool') { if ($examfile->getAttribute('baseurl')) { $fileobj->filebase = $this->tempdir. '/' . clean_param($examfile->getAttribute('baseurl'), PARAM_PATH); } if ($content = $this->get_filecontent($examfile->getAttribute('file'))) { $fileobj->filetype = self::FILETYPE_POOL; $fileobj->text = $content; $qfile[] = $fileobj; } } } if ($qfile) { return $qfile; } else { $this->error(get_string('cannotfindquestionfile', 'question')); fulldelete($this->tempdir); } } else { $this->error(get_string('cannotunzip', 'question')); fulldelete($this->temp_dir); } } else { $this->error(get_string('cannotreaduploadfile', 'error')); fulldelete($this->tempdir); } return false; } /** * Parse the array of objects into an array of questions. * Each object is the content of a .dat questions file. * This *could* burn memory - but it won't happen that much * so fingers crossed! * * @param array $lines array of qformat_blackboard_six_file objects for each input file. * @return array (of objects) question objects. */ public function readquestions($lines) { // Set up array to hold all our questions. $questions = array(); // Each element of $lines is a qformat_blackboard_six_file object. foreach ($lines as $fileobj) { if ($fileobj->filetype == self::FILETYPE_QTI) { $importer = new qformat_blackboard_six_qti(); } else if ($fileobj->filetype == self::FILETYPE_POOL) { $importer = new qformat_blackboard_six_pool(); } else { // In all other cases we are not able to import the file. debugging('fileobj type not recognised', DEBUG_DEVELOPER); continue; } $importer->set_filebase($fileobj->filebase); $questions = array_merge($questions, $importer->readquestions($fileobj->text)); } // Give any unnamed categories generated names. $unnamedcount = 0; foreach ($questions as $question) { if ($question->qtype == 'category' && $question->category == '') { $question->category = get_string('importedcategory', 'qformat_blackboard_six', ++$unnamedcount); } } return $questions; } }