require_login($course, false, $cm);
require_sesskey();
$PAGE->set_context($context);
// Get the reference only of this users' uploaded file, to avoid rogue users' accessing other peoples files.
$fs = get_file_storage();
$usercontext = context_user::instance($USER->id);
$file = $fs->get_file($usercontext->id, 'user', 'draft', $itemid, '/', basename($filename));
if ($file) {
// We have to save the uploaded as a real temporary file so we can process it using zip_open(), etc.
$tmpfilename = $file->copy_content_to_temp();
debugging(basename(__FILE__) . " (" . __LINE__ . "): \"{$filename}\" saved to \"{$tmpfilename}\"", DEBUG_WORDIMPORT);
// But we delete it from the draft file area to avoid a name-clash message if it is re-uploaded in the same edit.
$file->delete();
// Convert the Word file into XHTML with images, and delete it once we're finished.
$htmltext = tinymce_wordimport_convert_to_xhtml($tmpfilename, $contextid, $itemid);
tinymce_wordimport_debug_unlink($tmpfilename);
if ($htmltext !== false) {
debugging(basename(__FILE__) . " (" . __LINE__ . "): htmltext = |" . str_replace("\n", " ", substr($htmltext, 0, 500)) . "...|", DEBUG_WORDIMPORT);
// Get the body content only, ignoring any metadata in the head.
$bodytext = tinymce_wordimport_get_html_body($htmltext);
// Convert the string to JSON-encoded format.
$htmltextjson = json_encode($bodytext);
if ($htmltextjson) {
echo '{"html": ' . $htmltextjson . '}';
} else {
debugging(basename(__FILE__) . " (" . __LINE__ . "): JSON encoding failed ", DEBUG_WORDIMPORT);
echo '{"error": "' . get_string('cannotuploadfile') . "}";
}
} else {
debugging(basename(__FILE__) . " (" . __LINE__ . "): File conversion failed ", DEBUG_WORDIMPORT);
echo '{"error": "' . get_string('cannotuploadfile') . '"}';
/**
* Extract the WordProcessingML XML files from the .docx file, and use a sequence of XSLT
* steps to convert it into XHTML
*
* @param string $filename name of file uploaded to file repository as a draft
* @param int $contextid ID of draft file area where images should be stored
* @param int $draftitemid ID of particular group in draft file area where images should be stored
* @return mixed Boolean false or XHTML content extracted from Word file
*/
function tinymce_wordimport_convert_to_xhtml($filename, $contextid, $draftitemid)
{
global $CFG, $USER;
$word2mqxmlstylesheet1 = __DIR__ . "/wordml2xhtml_pass1.xsl";
// Convert WordML into basic XHTML.
$word2mqxmlstylesheet2 = __DIR__ . "/wordml2xhtml_pass2.xsl";
// Refine basic XHTML into Word-compatible XHTML.
debugging(__FUNCTION__ . ":" . __LINE__ . ": Word file = {$filename}", DEBUG_WORDIMPORT);
// Give XSLT as much memory as possible, to enable larger Word files to be imported.
raise_memory_limit(MEMORY_HUGE);
// Check that XSLT is installed, and the XSLT stylesheet is present.
if (!class_exists('XSLTProcessor') || !function_exists('xslt_create')) {
debugging(__FUNCTION__ . " (" . __LINE__ . "): XSLT not installed", DEBUG_WORDIMPORT);
return false;
} else {
if (!file_exists($word2mqxmlstylesheet1)) {
// XSLT stylesheet to transform WordML into XHTML doesn't exist.
debugging(__FUNCTION__ . " (" . __LINE__ . "): XSLT stylesheet missing: {$word2mqxmlstylesheet1}", DEBUG_WORDIMPORT);
return false;
}
}
// Set common parameters for all XSLT transformations.
$parameters = array('moodle_language' => current_language(), 'moodle_textdirection' => right_to_left() ? 'rtl' : 'ltr', 'moodle_release' => $CFG->release, 'moodle_url' => $CFG->wwwroot . "/", 'pluginname' => 'tinymce_wordimport', 'debug_flag' => DEBUG_WORDIMPORT);
// Pre-XSLT preparation: merge the WordML and image content from the .docx Word file into one large XML file.
// Initialise an XML string to use as a wrapper around all the XML files.
$xmldeclaration = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>';
$wordmldata = $xmldeclaration . "\n<pass1Container>\n";
$imagestring = "";
$fs = get_file_storage();
// Prepare filerecord array for creating each new image file.
$fileinfo = array('contextid' => $contextid, 'component' => 'user', 'filearea' => 'draft', 'userid' => $USER->id, 'itemid' => $draftitemid, 'filepath' => '/', 'filename' => '');
$imagestring = "";
// Open the Word 2010 Zip-formatted file and extract the WordProcessingML XML files.
$zfh = zip_open($filename);
if ($zfh) {
debugging(__FUNCTION__ . ":" . __LINE__ . ": Opened Zip file for reading", DEBUG_WORDIMPORT);
$zipentry = zip_read($zfh);
while ($zipentry) {
if (zip_entry_open($zfh, $zipentry, "r")) {
$zefilename = zip_entry_name($zipentry);
$zefilesize = zip_entry_filesize($zipentry);
// Insert internal images into the files table.
if (strpos($zefilename, "media")) {
$imageformat = substr($zefilename, strrpos($zefilename, ".") + 1);
$imagedata = zip_entry_read($zipentry, $zefilesize);
$imagename = basename($zefilename);
$imagesuffix = strtolower(substr(strrchr($zefilename, "."), 1));
// gif, png, jpg and jpeg handled OK, but bmp and other non-Internet formats are not.
if ($imagesuffix == 'gif' or $imagesuffix == 'png' or $imagesuffix == 'jpg' or $imagesuffix == 'jpeg') {
// Prepare the file details for storage, ensuring the image name is unique.
$imagenameunique = $imagename;
$file = $fs->get_file($contextid, 'user', 'draft', $draftitemid, '/', $imagenameunique);
while ($file) {
$imagenameunique = basename($imagename, '.' . $imagesuffix) . '_' . substr(uniqid(), 8, 4) . '.' . $imagesuffix;
$file = $fs->get_file($contextid, 'user', 'draft', $draftitemid, '/', $imagenameunique);
}
$fileinfo['filename'] = $imagenameunique;
$fs->create_file_from_string($fileinfo, $imagedata);
debugging(__FUNCTION__ . ":" . __LINE__ . ": stored \"{$imagename}\"" . " as \"{$imagenameunique}\" with itemid {$draftitemid}", DEBUG_WORDIMPORT);
$imageurl = "{$CFG->wwwroot}/draftfile.php/{$contextid}/user/draft/{$draftitemid}/{$imagenameunique}";
// Return all the details of where the file is stored, even though we don't need them at the moment.
$imagestring .= "<file filename=\"media/{$imagename}\"";
$imagestring .= " contextid=\"{$contextid}\" itemid=\"{$draftitemid}\"";
$imagestring .= " name=\"{$imagenameunique}\" url=\"{$imageurl}\">{$imageurl}</file>\n";
} else {
debugging(__FUNCTION__ . ":" . __LINE__ . ": ignore unsupported media file {$zefilename}" . " = {$imagename}, imagesuffix = {$imagesuffix}", DEBUG_WORDIMPORT);
}
} else {
// Look for required XML files, read and wrap it, remove the XML declaration, and add it to the XML string.
switch ($zefilename) {
case "word/document.xml":
$wordmldata .= "<wordmlContainer>" . str_replace($xmldeclaration, "", zip_entry_read($zipentry, $zefilesize)) . "</wordmlContainer>\n";
break;
case "docProps/core.xml":
$wordmldata .= "<dublinCore>" . str_replace($xmldeclaration, "", zip_entry_read($zipentry, $zefilesize)) . "</dublinCore>\n";
break;
case "docProps/custom.xml":
$wordmldata .= "<customProps>" . str_replace($xmldeclaration, "", zip_entry_read($zipentry, $zefilesize)) . "</customProps>\n";
break;
case "word/styles.xml":
$wordmldata .= "<styleMap>" . str_replace($xmldeclaration, "", zip_entry_read($zipentry, $zefilesize)) . "</styleMap>\n";
break;
case "word/_rels/document.xml.rels":
$wordmldata .= "<documentLinks>" . str_replace($xmldeclaration, "", zip_entry_read($zipentry, $zefilesize)) . "</documentLinks>\n";
break;
case "word/footnotes.xml":
$wordmldata .= "<footnotesContainer>" . str_replace($xmldeclaration, "", zip_entry_read($zipentry, $zefilesize)) . "</footnotesContainer>\n";
break;
case "word/_rels/footnotes.xml.rels":
$wordmldata .= "<footnoteLinks>" . str_replace($xmldeclaration, zip_entry_read($zipentry, $zefilesize), "") . "</footnoteLinks>\n";
break;
/*
case "word/_rels/settings.xml.rels":
$wordmldata .= "<settingsLinks>" . str_replace($xmldeclaration, "",
zip_entry_read($zipentry, $zefilesize)) . "</settingsLinks>\n";
break;
*/
/*
case "word/_rels/settings.xml.rels":
$wordmldata .= "<settingsLinks>" . str_replace($xmldeclaration, "",
zip_entry_read($zipentry, $zefilesize)) . "</settingsLinks>\n";
break;
*/
default:
// debugging(__FUNCTION__ . ":" . __LINE__ . ": Ignore $zefilename", DEBUG_WORDIMPORT);
}
}
} else {
// Can't read the file from the Word .docx file.
zip_close($zfh);
return false;
}
// Get the next file in the Zip package.
$zipentry = zip_read($zfh);
}
// End while loop.
zip_close($zfh);
} else {
// Can't open the Word .docx file for reading.
debugging(__FUNCTION__ . ":" . __LINE__ . ": Cannot unzip Word file ('{$filename}') to read XML", DEBUG_WORDIMPORT);
tinymce_wordimport_debug_unlink($filename);
return false;
}
// Add images section and close the merged XML file.
$wordmldata .= "<imagesContainer>\n" . $imagestring . "</imagesContainer>\n" . "</pass1Container>";
// Pass 1 - convert WordML into linear XHTML.
// Create a temporary file to store the merged WordML XML content to transform.
$tempwordmlfilename = $CFG->dataroot . '/temp/' . basename($filename, ".tmp") . ".wml";
// Strip out superfluous namespace declarations on paragraph elements, which Moodle 2.7+ on Windows seems to throw in.
$xsltoutput = str_replace('<p xmlns="http://www.w3.org/1999/xhtml"', '<p', $xsltoutput);
$xsltoutput = str_replace(' xmlns=""', '', $xsltoutput);
// Write the WordML contents to be imported.
if (($nbytes = file_put_contents($tempwordmlfilename, $wordmldata)) == 0) {
debugging(__FUNCTION__ . ":" . __LINE__ . ": Failed to save XML data to temporary file ('" . $tempwordmlfilename . "')", DEBUG_WORDIMPORT);
return false;
}
debugging(__FUNCTION__ . ":" . __LINE__ . ": XML data saved to {$tempwordmlfilename}", DEBUG_WORDIMPORT);
$xsltproc = xslt_create();
if (!($xsltoutput = xslt_process($xsltproc, $tempwordmlfilename, $word2mqxmlstylesheet1, null, null, $parameters))) {
debugging(__FUNCTION__ . ":" . __LINE__ . ": Transformation failed", DEBUG_WORDIMPORT);
tinymce_wordimport_debug_unlink($tempwordmlfilename);
return false;
}
tinymce_wordimport_debug_unlink($tempwordmlfilename);
debugging(__FUNCTION__ . ":" . __LINE__ . ": Import XSLT Pass 1 succeeded, XHTML output fragment = " . str_replace("\n", "", substr($xsltoutput, 0, 200)), DEBUG_WORDIMPORT);
// Write output of Pass 1 to a temporary file, for use in Pass 2.
$tempxhtmlfilename = $CFG->dataroot . '/temp/' . basename($filename, ".tmp") . ".if1";
if (($nbytes = file_put_contents($tempxhtmlfilename, $xsltoutput)) == 0) {
debugging(__FUNCTION__ . ":" . __LINE__ . ": Failed to save XHTML data to temporary file ('" . $tempxhtmlfilename . "')", DEBUG_WORDIMPORT);
return false;
}
debugging(__FUNCTION__ . ":" . __LINE__ . ": Import Pass 1 output XHTML data saved to {$tempxhtmlfilename}", DEBUG_WORDIMPORT);
// Pass 2 - tidy up linear XHTML a bit.
debugging(__FUNCTION__ . ":" . __LINE__ . ": XSLT Pass 2 using \"" . $word2mqxmlstylesheet2 . "\"", DEBUG_WORDIMPORT);
if (!($xsltoutput = xslt_process($xsltproc, $tempxhtmlfilename, $word2mqxmlstylesheet2, null, null, $parameters))) {
debugging(__FUNCTION__ . ":" . __LINE__ . ": Import Pass 2 Transformation failed", DEBUG_WORDIMPORT);
tinymce_wordimport_debug_unlink($tempxhtmlfilename);
return false;
}
tinymce_wordimport_debug_unlink($tempxhtmlfilename);
debugging(__FUNCTION__ . ":" . __LINE__ . ": Import Pass 2 succeeded, XHTML output fragment = " . str_replace("\n", "", substr($xsltoutput, 600, 500)), DEBUG_WORDIMPORT);
// Strip out most MathML element and attributes for compatibility with MathJax
$xsltoutput = str_replace('<mml:', '<', $xsltoutput);
$xsltoutput = str_replace('</mml:', '</', $xsltoutput);
$xsltoutput = str_replace(' mathvariant="normal"', '', $xsltoutput);
$xsltoutput = str_replace(' xmlns:mml="http://www.w3.org/1998/Math/MathML"', '', $xsltoutput);
$xsltoutput = str_replace('<math>', '<math xmlns="http://www.w3.org/1998/Math/MathML">', $xsltoutput);
// Keep the converted XHTML file for debugging if developer debugging enabled.
if (debugging(null, DEBUG_WORDIMPORT)) {
$tempxhtmlfilename = $CFG->dataroot . '/temp/' . basename($filename, ".tmp") . ".xhtml";
if (($nbytes = file_put_contents($tempxhtmlfilename, $xsltoutput)) == 0) {
return false;
}
}
return $xsltoutput;
}
