Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Table of Contents and PDF export of the entire wiki #84

Open
wants to merge 28 commits into
base: master
Choose a base branch
from
Open

Table of Contents and PDF export of the entire wiki #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
a28f677
Adds a simple table of contents to each wiki page
Apr 5, 2016
633bb3e
Added chapter number to each heading
Apr 20, 2016
1fb22dd
Added comments
Apr 20, 2016
dde2863
Added a table of contents with chapter numbers and nested <ul>-elements
May 2, 2016
744bb46
Rewrote parser to be more robust in case of broken HTML-Code
May 3, 2016
0edd1a1
Close ul-element before edit button
Jul 6, 2016
fb7c621
Closing ul-elements correctly now. Remove comments in headings from toc
Jul 11, 2016
f253afb
Removed debug msg
Jul 11, 2016
8d9e499
Possible fix for seperate group error
Aug 22, 2016
08f2911
Possible fix for group wiki problem
Aug 30, 2016
394b3cc
Fixed group/individual MSSQL Bug
Aug 30, 2016
b0c7403
css modifications
Nov 1, 2016
a14b63a
customized headings similar to wikipedia
Nov 2, 2016
db2cd5e
plugin icon ersetzt
Dec 9, 2016
c96395e
gesamtes wiki als print-html und pdf version
Dec 9, 2016
a2cb0fa
Dropdownmenu Wiki-Drucken
Dec 9, 2016
61d3f36
merged current version
Feb 9, 2017
211c4ab
add style to display all navigation buttons inline
Mar 20, 2017
2737737
manually set the settings cog to be displayed on the page for boost-b…
Feb 27, 2018
67331a4
Refactor Table of Contents and fix wiki print function.
joeltsch Jul 8, 2019
023ff0d
Add .travis.yml
joeltsch Jul 8, 2019
bb09752
Add style directory.
joeltsch Jul 8, 2019
1f350df
Change directory for pdf images
joeltsch Jul 10, 2019
b58a03a
Update create_dir method
joeltsch Jul 10, 2019
1296748
Update .travis.yml IGNORE_PATHS
joeltsch Jul 17, 2019
3a40b28
Fix style errors
joeltsch Jul 17, 2019
860fba8
Remove unused local variables.
joeltsch Jul 18, 2019
18f4f8d
Add comments.
joeltsch Jul 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
212 changes: 175 additions & 37 deletions entirewiki.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@
*/

require_once(dirname(__FILE__) . '/../../config.php');
require($CFG->dirroot.'/mod/ouwiki/basicpage.php');
require($CFG->dirroot . '/mod/ouwiki/basicpage.php');

$id = required_param('id', PARAM_INT); // Course Module ID
$id = required_param('id', PARAM_INT); // Course Module ID.
$pagename = optional_param('page', '', PARAM_TEXT);
$filesexist = optional_param('filesexist', 0, PARAM_INT);

Expand All @@ -38,7 +38,7 @@
print_error('invalidcoursemodule');
}

// Checking course instance
// Checking course instance.
$course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);

if (!$ouwiki = $DB->get_record('ouwiki', array('id' => $cm->instance))) {
Expand All @@ -54,13 +54,14 @@
$ouwikioutput = $PAGE->get_renderer('mod_ouwiki');

$format = required_param('format', PARAM_ALPHA);
if ($format !== OUWIKI_FORMAT_HTML && $format !== OUWIKI_FORMAT_RTF && $format !== OUWIKI_FORMAT_TEMPLATE) {
if ($format !== OUWIKI_FORMAT_HTML && $format !== OUWIKI_FORMAT_PDF
&& $format !== OUWIKI_FORMAT_TEMPLATE && $format !== OUWIKI_FORMAT_HTML_PRINT) {
print_error('Unexpected format');
}

// Get basic wiki details for filename
$filename = $course->shortname.'.'.$ouwiki->name;
$filename = preg_replace('/[^A-Za-z0-9.-]/' , '_', $filename);
// Get basic wiki details for filename.
$filename = $course->shortname . '.' . $ouwiki->name;
$filename = preg_replace('/[^A-Za-z0-9.-]/', '_', $filename);

$markup = '';
$fs = null;
Expand All @@ -71,12 +72,31 @@
$files = array();
$fs = get_file_storage();
break;
case OUWIKI_FORMAT_RTF:
require_once($CFG->dirroot.'/local/rtf.php');
$markup = '<root><p>'.get_string('savedat', 'ouwiki', userdate(time())).'</p><hr />';
case OUWIKI_FORMAT_HTML_PRINT:

$urlobjectarray = $PAGE->theme->css_urls($PAGE);
$urlobject = $urlobjectarray[0];
$cssurl = $urlobject->out();

$markup = '<html>';
$markup .= '<head>';
$markup .= '<link rel="stylesheet" href="' . $cssurl . '">';
$markup .= '</head>';
$markup .= '<body>';

break;
case OUWIKI_FORMAT_PDF:

$markup = '<html>';
$css = file_get_contents(dirname(__FILE__) . '/style/pdf.css');
$markup .= '<head>';
$markup .= '<style>' . $css . '</style>';
$markup .= '</head>';
$markup .= '<body>';

break;
case OUWIKI_FORMAT_HTML:
// Do header
// Do header.
echo $ouwikioutput->ouwiki_print_start($ouwiki, $cm, $course, $subwiki, get_string('entirewiki', 'ouwiki'), $context, null, false, true);
print '<div class="ouwiki_content">';
break;
Expand All @@ -98,38 +118,65 @@
}
}


// If tree view specified.
if (($treemode) && ($format == OUWIKI_FORMAT_HTML) ) {
if (($treemode) && ($format == OUWIKI_FORMAT_HTML || $format == OUWIKI_FORMAT_PDF || $format == OUWIKI_FORMAT_HTML_PRINT)) {

ouwiki_build_tree($index);
// Print out in hierarchical form...
print '<ul class="ouw_indextree">';

$treeoutput = '<ul class="ouw_indextree">';

$functionname = 'ouwiki_display_entirewiki_page_in_index';
print ouwiki_tree_index($functionname, reset($index)->pageid, $index, $subwiki, $cm, $context);
print '</ul>';
$treeoutput .= ouwiki_tree_index($functionname, reset($index)->pageid, $index, $subwiki, $cm, $context);
$treeoutput .= '</ul>';

if ($orphans) {
print '<h2 class="ouw_orphans">'.get_string('orphanpages', 'ouwiki').'</h2>';
print '<ul class="ouw_indextree">';
$treeoutput .= '<h2 class="ouw_orphans">' . get_string('orphanpages', 'ouwiki') . '</h2>';
$treeoutput .= '<ul class="ouw_indextree">';
foreach ($index as $indexitem) {
if (count($indexitem->linksfrom) == 0 && $indexitem->title !== '') {
$orphanindex = ouwiki_get_sub_tree_from_index($indexitem->pageid, $index);
ouwiki_build_tree($orphanindex);
print ouwiki_tree_index($functionname, $indexitem->pageid, $orphanindex, $subwiki, $cm, $context);
$treeoutput .= ouwiki_tree_index($functionname, $indexitem->pageid, $orphanindex, $subwiki, $cm, $context);
}
}
print '</ul>';
$treeoutput .= '</ul>';
}

if ($format == OUWIKI_FORMAT_HTML) {
print $treeoutput;
}

if ($format == OUWIKI_FORMAT_PDF || $format == OUWIKI_FORMAT_HTML_PRINT) {

if ($format == OUWIKI_FORMAT_PDF) {
$treeoutput = replace_image_urls($context, $treeoutput, 0, true);
}

$markup .= $treeoutput;
}

} else {
foreach ($index as $pageinfo) {
if (count($pageinfo->linksfrom)!= 0 || $pageinfo->title === '') {
if (count($pageinfo->linksfrom) != 0 || $pageinfo->title === '') {
// Get page details.
$pageversion = ouwiki_get_current_page($subwiki, $pageinfo->title);
// If the page hasn't really been created yet, skip it.
if (is_null($pageversion->xhtml)) {
continue;
}

$markup .= get_online_display_content($format, $pageversion, $context, $subwiki, $cm, $index, $fs, $files);

$output = get_online_display_content($format, $pageversion, $context, $subwiki, $cm, $index, $fs, $files);

if ($format == OUWIKI_FORMAT_HTML) {
print $output;
}

if ($format == OUWIKI_FORMAT_PDF || $format == OUWIKI_FORMAT_HTML_PRINT) {
$markup .= $output;
}

if ($first) {
$first = false;
Expand All @@ -139,9 +186,9 @@

if ($orphans) {
if ($format == OUWIKI_FORMAT_HTML) {
print '<h2 class="ouw_orphans">'.get_string('orphanpages', 'ouwiki').'</h2>';
print '<h2 class="ouw_orphans">' . get_string('orphanpages', 'ouwiki') . '</h2>';
} else if ($format != OUWIKI_FORMAT_TEMPLATE) {
$markup .= '<h2 class="ouw_orphans">'.get_string('orphanpages', 'ouwiki').'</h2>';
$markup .= '<h2 class="ouw_orphans">' . get_string('orphanpages', 'ouwiki') . '</h2>';
}

foreach ($index as $indexitem) {
Expand Down Expand Up @@ -184,9 +231,28 @@
exit;
break;

case OUWIKI_FORMAT_RTF:
$markup .= '</root>';
rtf_from_html($filename.'.rtf', $markup);
case OUWIKI_FORMAT_HTML_PRINT:

$markup .= '</body></html>';

echo $markup;
break;

case OUWIKI_FORMAT_PDF:
$markup .= '</body></html>';

require_once($CFG->libdir . '/pdflib.php');

$doc = new pdf;
$doc->setFont('helvetica');
$doc->setPrintHeader(false);
$doc->setPrintFooter(false);
$doc->AddPage();
$doc->writeHTML($markup);
$doc->Output(explode('.', $filename)[1] . '.pdf');

clean_up($markup);

break;

case OUWIKI_FORMAT_HTML:
Expand All @@ -200,7 +266,7 @@ function get_online_display_content($format, $pageversion, $context, $subwiki, $

if ($format != OUWIKI_FORMAT_TEMPLATE) {
$pageversion->xhtml = file_rewrite_pluginfile_urls($pageversion->xhtml, 'pluginfile.php',
$context->id, 'mod_ouwiki', 'content', $pageversion->versionid);
$context->id, 'mod_ouwiki', 'content', $pageversion->versionid);
}

switch ($format) {
Expand All @@ -213,25 +279,25 @@ function get_online_display_content($format, $pageversion, $context, $subwiki, $
$markup .= '<versionid>' . $pageversion->versionid . '</versionid>';
// Copy images found in content.
preg_match_all('#<img.*?src="@@PLUGINFILE@@/(.*?)".*?/>#', $pageversion->xhtml, $matches);
if (! empty($matches)) {
if (!empty($matches)) {
// Extract the file names from the matches.
foreach ($matches[1] as $key => $match) {
// Get file name and copy to zip.
$match = urldecode($match);
// Copy image - on fail swap tag with string.
if ($file = $fs->get_file($context->id, 'mod_ouwiki', 'content',
$pageversion->versionid, '/', $match)) {
$pageversion->versionid, '/', $match)) {
$files["/$pageversion->versionid/$match/"] = $file;
} else {
$pageversion->xhtml = str_replace($matches[0][$key], $brokenimagestr,
$pageversion->xhtml);
$pageversion->xhtml);
}
}
}
$markup .= '<xhtml>' . htmlspecialchars($pageversion->xhtml) . '</xhtml>';
// Add attachments.
if ($attachments = $fs->get_area_files($context->id, 'mod_ouwiki', 'attachment',
$pageversion->versionid, 'itemid', false)) {
$pageversion->versionid, 'itemid', false)) {
// We have attachements.
$markup .= '<attachments>';
$attachmentsarray = array();
Expand All @@ -245,15 +311,23 @@ function get_online_display_content($format, $pageversion, $context, $subwiki, $
}
$markup .= '</page>';
break;
case OUWIKI_FORMAT_RTF:
$markup .= '<h1>' . htmlspecialchars($visibletitle) . '</h1>';
$markup .= trim($pageversion->xhtml);
$markup .= '<br /><br /><hr />';
case OUWIKI_FORMAT_PDF || OUWIKI_FORMAT_HTML_PRINT:

$markup .= '<div class="ouw_entry"><a name="' . $pageversion->pageid . '"></a><h1 class="ouw_entry_heading">' .
'<a href="view.php?' . ouwiki_display_wiki_parameters($pageversion->title, $subwiki, $cm) .
'">' . htmlspecialchars($visibletitle) . '</a></h1>';
$markup .= ouwiki_convert_content($pageversion->xhtml, $subwiki, $cm, $index, $pageversion->xhtmlformat);
$markup .= '</div>';

if ($format === OUWIKI_FORMAT_PDF) {
$markup = replace_image_urls($context, $markup, $pageversion->versionid);
}

break;
case OUWIKI_FORMAT_HTML:
print '<div class="ouw_entry"><a name="' . $pageversion->pageid . '"></a><h1 class="ouw_entry_heading">' .
'<a href="view.php?' . ouwiki_display_wiki_parameters($pageversion->title, $subwiki, $cm) .
'">' . htmlspecialchars($visibletitle) . '</a></h1>';
'<a href="view.php?' . ouwiki_display_wiki_parameters($pageversion->title, $subwiki, $cm) .
'">' . htmlspecialchars($visibletitle) . '</a></h1>';
print ouwiki_convert_content($pageversion->xhtml, $subwiki, $cm, $index, $pageversion->xhtmlformat);
print '</div>';
break;
Expand All @@ -262,3 +336,67 @@ function get_online_display_content($format, $pageversion, $context, $subwiki, $
return $markup;

}

/**
* Replace the image url in <img src="" .. > with the path of the local file.
*
* @param $context
* @param $xhtml
* @param $itemid
* @param bool $treemode
* @return mixed
*/
function replace_image_urls($context, $xhtml, $itemid, $treemode = false) {
$content = $xhtml;
preg_match_all('#<img.+?src="(.+?)".+?>#', $content, $matches);

$fs = get_file_storage();
// Create local folder for the temporary images used in the pdf.
$tmpdir = create_dir(dirname(__FILE__) . '/pdf_images');

if (!empty($matches)) {
// Extract the file names from the matches.

foreach ($matches[1] as $match) {
$urlinfo = pathinfo($match);
$image = urldecode($urlinfo['basename']);

if ($treemode) {
$tmp = explode('/', $urlinfo['dirname']);
$itemid = $tmp[count($tmp) - 1];
}

if (!$file = $fs->get_file($context->id, 'mod_ouwiki', 'content', $itemid, '/', $image)) {
continue;
}

$filename = $file->get_filename();
$filepath = "$tmpdir/$filename";
if (file_exists($filepath) || $file->copy_content_to($filepath)) {
$content = str_replace($match, $filepath, $content);
}

}
}
return $content;
}

function create_dir($path) {
if (!file_exists($path)) {
mkdir($path, 0777, true);
}
return $path;
}

/**
* Removes the temporary local image files used for creating the pdf
* @param $html
*/
function clean_up($html) {
preg_match_all('#<img.+?src="(.+?)".+?>#', $html, $matches);
if (!empty($matches)) {
foreach ($matches[1] as $filepath) {
unlink($filepath);
}
}
}
7 changes: 7 additions & 0 deletions lang/en/ouwiki.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -589,3 +589,10 @@
$string['event:ouwikipageupdated'] = 'ouwiki page updated';
$string['event:savefailed'] = 'Session fail on page save';
$string['ouwikicrontask'] = 'OU wiki maintenance jobs';

$string['tableofcontents'] = 'Table of contents';
$string['printwiki'] = 'Print Wiki ';
$string['print_pdf_alphabetic'] = 'PDF (Alphabetic)';
$string['print_pdf_tree_structure'] = 'PDF (Tree)';
$string['print_html_alphabetic'] = 'HTML (Alphabetic)';
$string['print_html_tree_structure'] = 'HTML (Tree)';
Loading