Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 106 |
|
0.00% |
0 / 4 |
CRAP | |
0.00% |
0 / 1 |
| QtiTestUtils | |
0.00% |
0 / 106 |
|
0.00% |
0 / 4 |
650 | |
0.00% |
0 / 1 |
| storeQtiResource | |
0.00% |
0 / 40 |
|
0.00% |
0 / 1 |
110 | |||
| emptyImsManifest | |
0.00% |
0 / 19 |
|
0.00% |
0 / 1 |
2 | |||
| buildAssessmentItemRefsTestMap | |
0.00% |
0 / 38 |
|
0.00% |
0 / 1 |
156 | |||
| getTestDefinition | |
0.00% |
0 / 9 |
|
0.00% |
0 / 1 |
6 | |||
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * This program is free software; you can redistribute it and/or |
| 5 | * modify it under the terms of the GNU General Public License |
| 6 | * as published by the Free Software Foundation; under version 2 |
| 7 | * of the License (non-upgradable). |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
| 15 | * along with this program; if not, write to the Free Software |
| 16 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 17 | * |
| 18 | * Copyright (c) 2014 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT); |
| 19 | * |
| 20 | */ |
| 21 | |
| 22 | namespace oat\taoQtiTest\models; |
| 23 | |
| 24 | use InvalidArgumentException; |
| 25 | use oat\generis\Helper\SystemHelper; |
| 26 | use oat\taoQtiItem\model\qti\Resource; |
| 27 | use qtism\data\storage\xml\XmlDocument; |
| 28 | use oat\oatbox\filesystem\FileSystemService; |
| 29 | use oat\oatbox\filesystem\Directory; |
| 30 | use qtism\data\AssessmentTest; |
| 31 | use oat\oatbox\service\ConfigurableService; |
| 32 | use taoItems_models_classes_TemplateRenderer; |
| 33 | |
| 34 | /** |
| 35 | * Miscellaneous utility methods for the QtiTest extension. |
| 36 | * |
| 37 | * Service created from \taoQtiTest_helpers_Utils static helper class |
| 38 | * |
| 39 | * @author Jérôme Bogaerts <jerome@taotesting.com> |
| 40 | */ |
| 41 | class QtiTestUtils extends ConfigurableService |
| 42 | { |
| 43 | public const SERVICE_ID = 'taoQtiTest/QtiTestUtils'; |
| 44 | |
| 45 | /** |
| 46 | * Store a file referenced by $qtiResource into the final $testContent folder. If the path provided |
| 47 | * by $qtiResource contains sub-directories, they will be created before copying the file (even |
| 48 | * if $copy = false). |
| 49 | * |
| 50 | * @param Directory $testContent The pointer to the TAO Test Content folder. |
| 51 | * @param \oat\taoQtiItem\model\qti\Resource|string $qtiResource The QTI resource to be copied into $testContent. |
| 52 | * If given as a string, it must be the relative |
| 53 | * (to the IMS QTI Package) path to the resource file. |
| 54 | * @param string $origin The path to the directory (root folder of extracted IMS QTI package) containing the |
| 55 | * QTI resource to be copied. |
| 56 | * @param boolean $copy If set to false, the file will not be actually copied. |
| 57 | * @param string $rename A new filename e.g. 'file.css' to be used at storage time. |
| 58 | * @return string The path were the file was copied/has to be copied (depending on the $copy argument). |
| 59 | * @throws InvalidArgumentException If one of the above arguments is invalid. |
| 60 | * @throws \common_Exception |
| 61 | */ |
| 62 | public function storeQtiResource(Directory $testContent, $qtiResource, $origin, $copy = true, $rename = '') |
| 63 | { |
| 64 | $fss = $this->getServiceLocator()->get(FileSystemService::SERVICE_ID); |
| 65 | $fs = $fss->getFileSystem($testContent->getFileSystem()->getId()); |
| 66 | $contentPath = $testContent->getPrefix(); |
| 67 | |
| 68 | $ds = DIRECTORY_SEPARATOR; |
| 69 | $contentPath = rtrim($contentPath, $ds); |
| 70 | |
| 71 | if ($qtiResource instanceof Resource) { |
| 72 | $filePath = $qtiResource->getFile(); |
| 73 | } elseif (is_string($qtiResource) === true) { |
| 74 | $filePath = $qtiResource; |
| 75 | } else { |
| 76 | throw new InvalidArgumentException( |
| 77 | "The 'qtiResource' argument must be a string or a taoQTI_models_classes_QTI_Resource object." |
| 78 | ); |
| 79 | } |
| 80 | |
| 81 | $resourcePathinfo = pathinfo($filePath); |
| 82 | |
| 83 | if (empty($resourcePathinfo['dirname']) === false && $resourcePathinfo['dirname'] !== '.') { |
| 84 | // The resource file is not at the root of the archive but in a sub-folder. |
| 85 | // Let's copy it in the same way into the Test Content folder. |
| 86 | $breadCrumb = $contentPath . $ds . str_replace('/', $ds, $resourcePathinfo['dirname']); |
| 87 | $breadCrumb = rtrim($breadCrumb, $ds); |
| 88 | $finalName = (empty($rename) === true) |
| 89 | ? ($resourcePathinfo['filename'] . '.' . $resourcePathinfo['extension']) |
| 90 | : $rename; |
| 91 | $finalPath = $breadCrumb . $ds . $finalName; |
| 92 | } else { |
| 93 | // The resource file is at the root of the archive. |
| 94 | // Overwrite template test.xml (created by self::createContent() method above) file with the new one. |
| 95 | $finalName = (empty($rename) === true) |
| 96 | ? ($resourcePathinfo['filename'] . '.' . $resourcePathinfo['extension']) |
| 97 | : $rename; |
| 98 | $finalPath = $contentPath . $ds . $finalName; |
| 99 | } |
| 100 | |
| 101 | if ($copy === true) { |
| 102 | $origin = str_replace('/', $ds, $origin); |
| 103 | $origin = rtrim($origin, $ds); |
| 104 | $sourcePath = $origin . $ds . str_replace('/', $ds, $filePath); |
| 105 | |
| 106 | if (is_readable($sourcePath) === false) { |
| 107 | throw new \common_Exception( |
| 108 | "An error occured while copying the QTI resource from '${sourcePath}' to '${finalPath}'." |
| 109 | ); |
| 110 | } |
| 111 | |
| 112 | $fh = fopen($sourcePath, 'r'); |
| 113 | $success = $fs->writeStream($finalPath, $fh); |
| 114 | fclose($fh); |
| 115 | |
| 116 | if (!$success) { |
| 117 | throw new \common_Exception( |
| 118 | "An error occured while copying the QTI resource from '${sourcePath}' to '${finalPath}'." |
| 119 | ); |
| 120 | } |
| 121 | } |
| 122 | |
| 123 | return $finalPath; |
| 124 | } |
| 125 | |
| 126 | /** |
| 127 | * Returns an empty IMS Manifest file as a DOMDocument, ready to be fill with |
| 128 | * new information about IMS QTI Items and Tests. |
| 129 | * |
| 130 | * @param $version string The requested QTI version. Can be "2.1" or "2.2". Default is "2.1". |
| 131 | * @return \DOMDocument |
| 132 | */ |
| 133 | public function emptyImsManifest($version = '2.1') |
| 134 | { |
| 135 | $manifestFileName = match ($version) { |
| 136 | '2.1' => 'imsmanifest', |
| 137 | '2.2' => 'imsmanifestQti22', |
| 138 | '3.0' => 'imsmanifestQti30', |
| 139 | default => throw new InvalidArgumentException( |
| 140 | 'Invalid version provided. Only "2.1", "2.2" and "3.0" are supported.' |
| 141 | ), |
| 142 | }; |
| 143 | |
| 144 | $templateRenderer = new taoItems_models_classes_TemplateRenderer( |
| 145 | ROOT_PATH . 'taoQtiItem/model/qti/templates/' . $manifestFileName . '.tpl.php', |
| 146 | [ |
| 147 | 'qtiItems' => [], |
| 148 | 'manifestIdentifier' => 'QTI-TEST-MANIFEST-' |
| 149 | . \tao_helpers_Display::textCleaner(uniqid('tao', true), '-') |
| 150 | ] |
| 151 | ); |
| 152 | |
| 153 | $manifest = new \DOMDocument('1.0', TAO_DEFAULT_ENCODING); |
| 154 | $manifest->loadXML($templateRenderer->render()); |
| 155 | return $manifest; |
| 156 | } |
| 157 | |
| 158 | /** |
| 159 | * It is sometimes necessary to identify the link between assessmentItemRefs described in a QTI Test definition and |
| 160 | * the resources describing items in IMS Manifest file. This utility method helps you to achieve this. |
| 161 | * |
| 162 | * The method will return an array describing the IMS Manifest resources that were found in an IMS Manifest file |
| 163 | * on basis of the assessmentItemRefs found in an AssessmentTest definition. The keys of the arrays are |
| 164 | * assessmentItemRef identifiers and values are IMS Manifest Resources. |
| 165 | * |
| 166 | * If an IMS Manifest Resource cannot be found for a given assessmentItemRef, the value in the returned array will |
| 167 | * be false. |
| 168 | * |
| 169 | * @param XmlDocument $test A QTI Test Definition. |
| 170 | * @param \taoQtiTest_models_classes_ManifestParser $manifestParser A Manifest Parser. |
| 171 | * @param string $basePath The base path of the folder the IMS archive is exposed as a file system component. |
| 172 | * @return array An array containing two arrays (items and dependencies) where keys are identifiers and values |
| 173 | * are oat\taoQtiItem\model\qti\Resource objects or false. |
| 174 | */ |
| 175 | public function buildAssessmentItemRefsTestMap( |
| 176 | XmlDocument $test, |
| 177 | \taoQtiTest_models_classes_ManifestParser $manifestParser, |
| 178 | $basePath |
| 179 | ) { |
| 180 | $assessmentItemRefs = $test->getDocumentComponent()->getComponentsByClassName('assessmentItemRef'); |
| 181 | $map = ['items' => [], 'dependencies' => []]; |
| 182 | $itemResources = $manifestParser->getResources( |
| 183 | Resource::getItemTypes(), |
| 184 | \taoQtiTest_models_classes_ManifestParser::FILTER_RESOURCE_TYPE |
| 185 | ); |
| 186 | $allResources = $manifestParser->getResources(); |
| 187 | |
| 188 | // cleanup $basePath. |
| 189 | $basePath = rtrim($basePath, "/\\"); |
| 190 | $basePath = \helpers_File::truePath($basePath); |
| 191 | $basePath .= DIRECTORY_SEPARATOR; |
| 192 | |
| 193 | $documentURI = preg_replace("/^file:\/{1,3}/", '', $test->getDomDocument()->documentURI); |
| 194 | $testPathInfo = pathinfo($documentURI); |
| 195 | $testBasePath = \tao_helpers_File::truePath($testPathInfo['dirname']) . DIRECTORY_SEPARATOR; |
| 196 | |
| 197 | foreach ($assessmentItemRefs as $itemRef) { |
| 198 | // Find the QTI Resource (in IMS Manifest) related to the item ref. |
| 199 | // To achieve this, we compare their path. |
| 200 | $itemRefRelativeHref = str_replace('/', DIRECTORY_SEPARATOR, $itemRef->getHref()); |
| 201 | $itemRefRelativeHref = ltrim($itemRefRelativeHref, "/\\"); |
| 202 | $itemRefCanonicalHref = \helpers_File::truePath($testBasePath . $itemRefRelativeHref); |
| 203 | $map['items'][$itemRef->getIdentifier()] = false; |
| 204 | |
| 205 | // Compare with items referenced in the manifest. |
| 206 | foreach ($itemResources as $itemResource) { |
| 207 | $itemResourceRelativeHref = str_replace('/', DIRECTORY_SEPARATOR, $itemResource->getFile()); |
| 208 | $itemResourceRelativeHref = ltrim($itemResourceRelativeHref, "/\\"); |
| 209 | |
| 210 | $itemResourceCanonicalHref = \helpers_File::truePath($basePath . $itemResourceRelativeHref); |
| 211 | |
| 212 | // With some Windows flavours (Win7, Win8), the $itemRefCanonicalHref comes out with |
| 213 | // a leading 'file:\' component. Let's clean this. (str_replace is binary-safe \0/) |
| 214 | $os = SystemHelper::getOperatingSystem(); |
| 215 | if ($os === 'WINNT' || $os === 'WIN32' || $os === 'Windows') { |
| 216 | $itemRefCanonicalHref = str_replace('file:\\', '', $itemRefCanonicalHref); |
| 217 | |
| 218 | // And moreover, it sometimes refer the temp directory as Windows\TEMP instead of Windows\Temp. |
| 219 | $itemRefCanonicalHref = str_replace('\\TEMP\\', '\\Temp\\', $itemRefCanonicalHref); |
| 220 | $itemResourceCanonicalHref = str_replace('\\TEMP\\', '\\Temp\\', $itemResourceCanonicalHref); |
| 221 | } |
| 222 | |
| 223 | // With some MacOS flavours, the $itemRefCanonicalHref comes out with |
| 224 | // a leading '/private' component. Clean it! |
| 225 | if ($os === 'Darwin') { |
| 226 | $itemRefCanonicalHref = str_replace('/private', '', $itemRefCanonicalHref); |
| 227 | } |
| 228 | |
| 229 | if ($itemResourceCanonicalHref == $itemRefCanonicalHref && is_file($itemResourceCanonicalHref)) { |
| 230 | // assessmentItemRef <-> IMS Manifest resource successful binding! |
| 231 | $map['items'][$itemRef->getIdentifier()] = $itemResource; |
| 232 | |
| 233 | //get dependencies for each item |
| 234 | foreach ($itemResource->getDependencies() as $dependencyIdentifier) { |
| 235 | /** @var \taoQtiTest_models_classes_QtiResource $resource */ |
| 236 | foreach ($allResources as $resource) { |
| 237 | if ($dependencyIdentifier == $resource->getIdentifier()) { |
| 238 | $map['dependencies'][$dependencyIdentifier] = $resource; |
| 239 | break; |
| 240 | } |
| 241 | } |
| 242 | } |
| 243 | break; |
| 244 | } |
| 245 | } |
| 246 | } |
| 247 | return $map; |
| 248 | } |
| 249 | |
| 250 | /** |
| 251 | * Retrieve the Test Definition the test session is built from as an AssessmentTest object. |
| 252 | * @param string $qtiTestCompilation (e.g. <i>'http://sample/first.rdf#i14363448108243883- |
| 253 | * |http://sample/first.rdf#i14363448109065884+'</i>) |
| 254 | * @return AssessmentTest The AssessmentTest object the current test session is built from. |
| 255 | * @throws QtiTestExtractionFailedException |
| 256 | */ |
| 257 | public function getTestDefinition($qtiTestCompilation) |
| 258 | { |
| 259 | try { |
| 260 | $directoryIds = explode('|', $qtiTestCompilation); |
| 261 | $directory = \tao_models_classes_service_FileStorage::singleton()->getDirectoryById($directoryIds[0]); |
| 262 | $compilationDataService = $this->getServiceLocator()->get(CompilationDataService::SERVICE_ID); |
| 263 | return $compilationDataService->readCompilationData( |
| 264 | $directory, |
| 265 | \taoQtiTest_models_classes_QtiTestService::TEST_COMPILED_FILENAME |
| 266 | ); |
| 267 | } catch (\common_exception_FileReadFailedException $e) { |
| 268 | throw new QtiTestExtractionFailedException($e->getMessage()); |
| 269 | } |
| 270 | } |
| 271 | } |