lib.php 36.2 KB
Newer Older
1
2
3
4
5
6
<?php
/**
 *
 * @package    mahara
 * @subpackage export-html
 * @author     Catalyst IT Ltd
7
8
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL version 3 or later
 * @copyright  For copyright information on Mahara, please see the README file distributed with this software.
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 *
 */

defined('INTERNAL') || die();

/**
 * HTML export plugin
 */
class PluginExportHtml extends PluginExport {

    /**
     * name of resultant zipfile
     */
    protected $zipfile;

    /**
Aaron Wells's avatar
Aaron Wells committed
25
     * The name of the directory under which all the other directories and
26
27
28
29
     * files will be placed in the export
     */
    protected $rootdir;

30
31
32
33
34
35
    /**
     * List of directories of static files provided by artefact plugins
     */
    private $pluginstaticdirs = array();

    /**
36
37
     * List of stylesheets to include in the export.
     *
Aaron Wells's avatar
Aaron Wells committed
38
     * This is keyed by artefact plugin name, the empty string key contains
39
     * stylesheets that will be included on all pages.
40
     */
41
    private $stylesheets = array('' => array());
42

43
44
    /**
     * Whether the user requested to export just one view. In this case,
Aaron Wells's avatar
Aaron Wells committed
45
     * the generated export doesn't have the home page - just the View is
46
47
48
49
     * exported (plus artefacts of course)
     */
    protected $exportingoneview = false;

50
51
52
53
    /**
    * constructor.  overrides the parent class
    * to set up smarty and the attachment directory
    */
54
    public function __construct(User $user, $views, $artefacts, $progresscallback=null) {
55
        global $THEME;
56
        parent::__construct($user, $views, $artefacts, $progresscallback);
57
        $this->rootdir = 'portfolio-for-' . self::text_to_filename($user->get('username'));
58
59

        // Create basic required directories
60
        foreach (array('files', 'views', 'static', 'static/smilies', 'static/profileicons') as $directory) {
61
62
63
64
65
66
            $directory = "{$this->exportdir}/{$this->rootdir}/{$directory}/";
            if (!check_dir_exists($directory)) {
                throw new SystemException("Couldn't create the temporary export directory $directory");
            }
        }
        $this->zipfile = 'mahara-export-html-user'
67
            . $this->get('user')->get('id') . '-' . $this->exporttime . '.zip';
68
69

        // Find what stylesheets need to be included
70
        $themedirs = $THEME->get_path('', true, 'export/html');
71
        $stylesheets = array('style.css', 'print.css', 'jquery.rating.css');
72
73
74
        foreach ($themedirs as $theme => $themedir) {
            foreach ($stylesheets as $stylesheet) {
                if (is_readable($themedir . 'style/' . $stylesheet)) {
75
                    array_unshift($this->stylesheets[''], 'theme/' . $theme . '/static/style/' . $stylesheet);
76
77
78
79
                }
            }
        }

80
81
82
83
84
85
86
        // Don't export the dashboard
        foreach (array_keys($this->views) as $i) {
            if ($this->views[$i]->get('type') == 'dashboard') {
                unset($this->views[$i]);
            }
        }

87
88
89
90
91
92
        $this->exportingoneview = (
            $this->viewexportmode == PluginExport::EXPORT_LIST_OF_VIEWS &&
            $this->artefactexportmode == PluginExport::EXPORT_ARTEFACTS_FOR_VIEWS &&
            count($this->views) == 1
        );

93
        $this->notify_progress_callback(15, get_string('setupcomplete', 'export'));
94
95
    }

96
97
98
99
100
101
102
103
    public static function get_title() {
        return get_string('title', 'export.html');
    }

    public static function get_description() {
        return get_string('description', 'export.html');
    }

104
105
106
107
    public function is_diskspace_available() {
        return true; // need to create a check here
    }

108
    /**
Nigel McNie's avatar
Nigel McNie committed
109
110
     * Main export routine
     */
111
    public function export() {
112
        global $THEME, $SESSION;
113
114
        raise_memory_limit('128M');

115
        $summaries = array();
116
        $plugins = plugins_installed('artefact', true);
117
        $exportplugins = array();
118
        $progressstart = 15;
119
        $progressend   = 25;
120
        $plugincount   = count($plugins);
121

Aaron Wells's avatar
Aaron Wells committed
122
        // First pass: find out which plugins are exporting like us, and ask
123
        // them about the static data they want to include in every template
124
125
        $i = 0;
        foreach ($plugins as $plugin) {
126
            $plugin = $plugin->name;
127
            $this->notify_progress_callback(intval($progressstart + (++$i / $plugincount) * ($progressend - $progressstart)), get_string('preparing', 'export.html', $plugin));
128

129
            if (safe_require('export', 'html/' . $plugin, 'lib.php', 'require_once', true)) {
130
131
                $exportplugins[] = $plugin;

132
133
134
135
136
137
138
                $classname = 'HtmlExport' . ucfirst($plugin);
                if (!is_subclass_of($classname, 'HtmlExportArtefactPlugin')) {
                    throw new SystemException("Class $classname does not extend HtmlExportArtefactPlugin as it should");
                }

                safe_require('artefact', $plugin);

139
                // Find out whether the plugin has static data for us
140
                $themestaticdirs = array_reverse($THEME->get_path('', true, 'artefact/' . $plugin . '/export/html'));
141
142
143
144
145
                foreach ($themestaticdirs as $dir) {
                    $staticdir = substr($dir, strlen(get_config('docroot') . 'artefact/'));
                    $this->pluginstaticdirs[] = $staticdir;
                    foreach (array('style.css', 'print.css') as $stylesheet) {
                        if (is_readable($dir . 'style/' . $stylesheet)) {
146
                            $this->stylesheets[$plugin][] = str_replace('export/html/', '', $staticdir) . 'style/' . $stylesheet;
147
148
                        }
                    }
149
                }
150
151
152
            }
        }

153
154
        // Second pass: actually dump data for active export plugins
        $progressstart = 25;
155
        $progressend   = 50;
156
157
        $i = 0;
        foreach ($exportplugins as $plugin) {
158
            $this->notify_progress_callback(intval($progressstart + (++$i / $plugincount) * ($progressend - $progressstart)), get_string('exportingdatafor', 'export.html', $plugin));
159
160
161
162
            $classname = 'HtmlExport' . ucfirst($plugin);
            $artefactexporter = new $classname($this);
            $artefactexporter->dump_export_data();
            // If just exporting a list of views, we don't care about the summaries for each artefact plugin
163
164
            if (!(($this->viewexportmode == PluginExport::EXPORT_LIST_OF_VIEWS || $this->viewexportmode == PluginExport::EXPORT_COLLECTIONS)
                && $this->artefactexportmode == PluginExport::EXPORT_ARTEFACTS_FOR_VIEWS)) {
165
166
167
168
                $summaries[$plugin] = array($artefactexporter->get_summary_weight(), $artefactexporter->get_summary());
            }
        }

169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
        // Views in collections
        if (!$this->exportingoneview && $this->collections) {
            $viewlist = join(',', array_keys($this->views));
            $collectionlist = join(',', array_keys($this->collections));
            $records = get_records_select_array(
                'collection_view',
                "view IN ($viewlist) AND collection IN ($collectionlist)"
            );
            if ($records) {
                foreach ($records as &$r) {
                    $this->collectionview[$r->collection][] = $r->view;
                    $this->viewcollection[$r->view] = $r->collection;
                }
            }
        }

Nigel McNie's avatar
Nigel McNie committed
185
        // Get the view data
186
        $this->notify_progress_callback(55, get_string('exportingviews', 'export'));
Nigel McNie's avatar
Nigel McNie committed
187
188
        $this->dump_view_export_data();

189
190
        if (!$this->exportingoneview) {
            $summaries['view'] = array(100, $this->get_view_summary());
191

192
            // Sort by weight (then drop the weight information)
193
            $this->notify_progress_callback(75, get_string('buildingindexpage', 'export.html'));
194
195
196
197
198
199
200
201
            uasort($summaries, create_function('$a, $b', 'return $a[0] > $b[0];'));
            foreach ($summaries as &$summary) {
                $summary = $summary[1];
            }

            // Build index.html
            $this->build_index_page($summaries);
        }
202
203

        // Copy all static files into the export
204
        $this->notify_progress_callback(80, get_string('copyingextrafiles', 'export.html'));
205
        $this->copy_static_files();
206
207
208
209
210

        // Copy all resized images that were found while rewriting the HTML
        $copyproxy = HtmlExportCopyProxy::singleton();
        $copydata = $copyproxy->get_copy_data();
        foreach ($copydata as $from => $to) {
211
212
            $to = $this->get('exportdir') . '/' . $this->get('rootdir') . $to;
            if (!check_dir_exists(dirname($to))) {
213
                $SESSION->add_error_msg(get_string('couldnotcreatedirectory', 'export', $todir));
214
215
            }
            if (!copy($from, $to)) {
216
                $SESSION->add_error_msg(get_string('couldnotcopystaticfile', 'export', $from));
217
218
            }
        }
219
220

        // zip everything up
221
        $this->notify_progress_callback(90, get_string('creatingzipfile', 'export'));
222
223
224
225
226
227
228
229
230
231
232
233
234
235
        $cwd = getcwd();
        $command = sprintf('%s %s %s %s',
            get_config('pathtozip'),
            get_config('ziprecursearg'),
            escapeshellarg($this->exportdir .  $this->zipfile),
            escapeshellarg($this->rootdir)
        );
        $output = array();
        chdir($this->exportdir);
        exec($command, $output, $returnvar);
        chdir($cwd);
        if ($returnvar != 0) {
            throw new SystemException('Failed to zip the export file');
        }
236
        $this->notify_progress_callback(100, get_string('Done', 'export'));
237
238
239
240
241
242
243
244
        return $this->zipfile;
    }

    public function cleanup() {
        // @todo remove temporary files and directories
        // @todo maybe move the zip file somewhere else - like to files/export or something
    }

245
246
247
248
249
250
251
    public function get_smarty($rootpath='', $section='') {
        if ($section && isset($this->stylesheets[$section])) {
            $stylesheets = array_merge($this->stylesheets[''], $this->stylesheets[$section]);
        }
        else {
            $stylesheets = $this->stylesheets[''];
        }
252
253
254
        $smarty = smarty_core();
        $smarty->assign('user', $this->get('user'));
        $smarty->assign('rootpath', $rootpath);
255
        $smarty->assign('export_time', $this->exporttime);
256
        $smarty->assign('sitename', get_config('sitename'));
257
        $smarty->assign('stylesheets', $stylesheets);
258
        $smarty->assign('maharalogo', $rootpath . $this->theme_path('images/logo.png'));
259
260
261
262

        return $smarty;
    }

263
    /**
Aaron Wells's avatar
Aaron Wells committed
264
     * Converts a relative path to a static file that the HTML export theme
265
266
267
268
269
     * should have, to a path in the static export where the file will reside.
     *
     * This returns the path in the most appropriate theme.
     */
    private function theme_path($path) {
270
271
        global $THEME;
        $themestaticdirs = $THEME->get_path('', true, 'export/html');
272
273
274
275
276
277
278
        foreach ($themestaticdirs as $theme => $dir) {
            if (is_readable($dir . $path)) {
                return 'static/theme/' . $theme . '/static/' . $path;
            }
        }
    }

279
    /**
280
     * Converts the UTF-8 passed text into a a form that could be used in a file name.
281
282
283
284
     *
     * @param string $text The text to convert
     * @return string      The converted text
     */
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
    public static function text_to_filename($text) {
        // truncates the text and replaces NOT allowed characters to hyphens
        return preg_replace('#["*/:<>?\\| ]+#', '-', mb_substr($text, 0, parent::MAX_FILENAME_LENGTH, 'utf-8'));
    }

    /**
     * Converts the UTF-8 passed text into a a form that could be used in a URL.
     *
     * @param string $text The text to convert
     * @return string      The converted text
     */
    public static function text_to_URLpath($text) {
        $tab_text = str_split($text);
        $output = '';
        foreach ($tab_text as $id=>$char){
            $hex = dechex(ord($char));
            $output .= '%' . $hex;
        }
        return $output;
304
305
    }

306
307
308
    /**
     * Sanitises a string meant to be used as a filesystem path.
     *
Aaron Wells's avatar
Aaron Wells committed
309
     * Mahara allows file/folder artefact names to have slashes in them, which
310
311
312
     * aren't legal on most real filesystems.
     */
    public static function sanitise_path($path) {
313
        return trim(substr(str_replace('/', '_', $path), 0, 255));
314
315
316
    }


317
318
    private function build_index_page($summaries) {
        $smarty = $this->get_smarty();
319
        $smarty->assign('page_heading', full_name($this->get('user')));
320
321
        $smarty->assign('summaries', $summaries);
        $content = $smarty->fetch('export:html:index.tpl');
322
323
324
        if (!file_put_contents($this->exportdir . '/' . $this->rootdir . '/index.html', $content)) {
            throw new SystemException("Could not create index.html for the export");
        }
325
326
    }

327
328
329
330
331
332
333
334
    private function collection_menu($collectionid) {
        static $menus = array();
        if (!isset($menus[$collectionid])) {
            $menus[$collectionid] = array();
            foreach ($this->collectionview[$collectionid] as $viewid) {
                $title = $this->views[$viewid]->get('title');
                $menus[$collectionid][] = array(
                    'id'   => $viewid,
335
                    'url'  => self::text_to_URLpath(self::text_to_filename($title)) . '/index.html',
336
337
338
339
340
341
342
                    'text' => $title,
                );
            }
        }
        return $menus[$collectionid];
    }

Nigel McNie's avatar
Nigel McNie committed
343
344
345
346
    /**
     * Dumps all views into the HTML export
     */
    private function dump_view_export_data() {
347
        safe_require('artefact', 'comment');
348
349
350
351
        $progressstart = 55;
        $progressend   = 75;
        $i = 0;
        $viewcount = count($this->views);
352
353
        $rootpath = ($this->exportingoneview) ? './' : '../../';
        $smarty = $this->get_smarty($rootpath);
354
        foreach ($this->views as $viewid => $view) {
355
            $this->notify_progress_callback(intval($progressstart + (++$i / $viewcount) * ($progressend - $progressstart)), get_string('exportingviewsprogress', 'export', $i, $viewcount));
356
            $smarty->assign('page_heading', $view->get('title'));
357
            $smarty->assign('viewdescription', $view->get('description'));
358

359
360
361
362
363
364
365
366
367
            if ($this->exportingoneview) {
                $smarty->assign('nobreadcrumbs', true);
                $directory = $this->exportdir . '/' . $this->rootdir;
            }
            else {
                $smarty->assign('breadcrumbs', array(
                    array('text' => get_string('Views', 'view')),
                    array('text' => $view->get('title'), 'path' => 'index.html'),
                ));
368
                $directory = $this->exportdir . '/' . $this->rootdir . '/views/' . self::text_to_filename($view->get('title'));
369
370
371
                if (is_dir($directory)) {
                    throw new SystemException(get_string('duplicatepagetitle', 'export.html'));
                }
372
373
374
                if (!check_dir_exists($directory)) {
                    throw new SystemException("Could not create directory for view $viewid");
                }
375
            }
Nigel McNie's avatar
Nigel McNie committed
376

377
            // Collection menu data
378
            if (isset($this->viewcollection[$viewid]) && $this->viewexportmode == PluginExport::EXPORT_COLLECTIONS) {
379
380
381
382
383
                $smarty->assign_by_ref('collectionname', $this->collections[$this->viewcollection[$viewid]]->get('name'));
                $smarty->assign_by_ref('collectionmenu', $this->collection_menu($this->viewcollection[$viewid]));
                $smarty->assign('viewid', $viewid);
            }

384
            $outputfilter = new HtmlExportOutputFilter($rootpath, $this);
385
386
387

            // Include comments
            if ($this->includefeedback) {
388
389
390
391
392
                $commentoptions = ArtefactTypeComment::get_comment_options();
                $commentoptions->view = $view;
                $commentoptions->limit = 0;
                $commentoptions->export = true;
                if ($feedback = ArtefactTypeComment::get_comments($commentoptions)) {
393
394
395
396
397
                    $feedback->tablerows = $outputfilter->filter($feedback->tablerows);
                }
                $smarty->assign('feedback', $feedback);
            }

398
            $smarty->assign('view', $outputfilter->filter($view->build_rows()));
399
400
401
            $content = $smarty->fetch('export:html:view.tpl');
            if (!file_put_contents("$directory/index.html", $content)) {
                throw new SystemException("Could not write view page for view $viewid");
Nigel McNie's avatar
Nigel McNie committed
402
403
404
405
406
407
408
            }
        }
    }

    private function get_view_summary() {
        $smarty = $this->get_smarty('../');

409
410
411
412
413
414
415
416
        $list = array();
        foreach ($this->collections as $id => $collection) {
            $list['c' . $id] = array(
                'title' => $collection->get('name'),
                'views' => array(),
            );
        }

417
        $ncollections = count($this->collections);
418
419
        $nviews = 0;
        foreach ($this->views as $id => $view) {
Nigel McNie's avatar
Nigel McNie committed
420
            if ($view->get('type') != 'profile') {
421
                $item = array(
Nigel McNie's avatar
Nigel McNie committed
422
                    'title' => $view->get('title'),
423
                    'folder' => self::text_to_filename($view->get('title')),
Nigel McNie's avatar
Nigel McNie committed
424
                );
425
426
427
428
429
430
431
                if (isset($this->viewcollection[$id])) {
                    $list['c' . $this->viewcollection[$id]]['views'][] = $item;
                }
                else {
                    $list[$id] = $item;
                }
                $nviews++;
Nigel McNie's avatar
Nigel McNie committed
432
433
            }
        }
434
435
436
        function sort_by_title($a, $b) {
            return strnatcasecmp($a['title'], $b['title']);
        }
437
438
439
440
441
        foreach (array_keys($this->collections) as $id) {
            usort($list['c' . $id]['views'], 'sort_by_title');
        }
        usort($list, 'sort_by_title');
        $smarty->assign('list', $list);
442

443
        if ($list) {
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
            if ($this->viewexportmode != PluginExport::EXPORT_COLLECTIONS) {
                $stryouhaveviews = ($nviews == 1)
                    ? get_string('youhaveoneview', 'view')
                    : get_string('youhaveviews', 'view', $nviews);
            }
            else {
                $stryouhavecollections = ($ncollections == 1)
                    ? get_string('youhaveonecollection', 'collection')
                    : get_string('youhavecollections', 'collection', $ncollections);

                $smarty->assign('stryouhavecollections', $stryouhavecollections);
                return array(
                    'title' => get_string('Collections', 'collection'),
                    'description' => $smarty->fetch('export:html:collectionsummary.tpl'),
                );
            }
460
461
462
463
464
        }
        else {
            $stryouhaveviews = get_string('youhavenoviews', 'view');
        }
        $smarty->assign('stryouhaveviews', $stryouhaveviews);
Nigel McNie's avatar
Nigel McNie committed
465
466

        return array(
467
            'title' => get_string('Views', 'view'),
Nigel McNie's avatar
Nigel McNie committed
468
469
470
471
            'description' => $smarty->fetch('export:html:viewsummary.tpl'),
        );
    }

472
473
474
475
    /**
     * Copies the static files (stylesheets etc.) into the export
     */
    private function copy_static_files() {
476
        global $THEME, $SESSION;
477
        require_once('file.php');
478
        $staticdir = $this->get('exportdir') . '/' . $this->get('rootdir') . '/static/';
479
480
481
        $directoriestocopy = array();

        // Get static directories from each theme for HTML export
482
        $themestaticdirs = $THEME->get_path('', true, 'export/html');
483
484
485
486
487
488
489
490
491
        foreach ($themestaticdirs as $theme => $dir) {
            $themedir = $staticdir . 'theme/' . $theme . '/static/';
            $directoriestocopy[$dir] = $themedir;
            if (!check_dir_exists($themedir)) {
                throw new SystemException("Could not create theme directory for theme $theme");
            }
        }

        // Smilies
492
        $directoriestocopy[get_config('docroot') . 'js/tinymce/plugins/emoticons/img'] = $staticdir . 'smilies/';
493

494
495
496
        $filestocopy = array(
            get_config('docroot') . 'theme/views.css' => $staticdir . 'views.css',
        );
497

498
        foreach ($this->pluginstaticdirs as $dir) {
499
500
            $destinationdir = str_replace('export/html/', '', $dir);
            if (!check_dir_exists($staticdir . $destinationdir)) {
501
                $SESSION->add_error_msg(get_string('couldnotcreatestaticdirectory', 'export', $destinationdir));
502
            }
503
            $directoriestocopy[get_config('docroot') . 'artefact/' . $dir] = $staticdir . $destinationdir;
504
505
        }

506
        foreach ($directoriestocopy as $from => $to) {
507
            if (!copyr($from, $to)) {
508
                $SESSION->add_error_msg(get_string('couldnotcopyfilesfromto', 'export', $from, $to));
509
510
            }
        }
511
512

        foreach ($filestocopy as $from => $to) {
513
514
            if (!is_file($from) || !copy($from, $to)) {
                $SESSION->add_error_msg(get_string('couldnotcopystaticfile', 'export', $from));
515
516
            }
        }
517
518
    }

519
520
521
522
523
524
525
526
527
528
529
530
531
}

abstract class HtmlExportArtefactPlugin {

    protected $exporter;

    protected $fileroot;

    public function __construct(PluginExportHTML $exporter) {
        $this->exporter = $exporter;
        $pluginname = strtolower(substr(get_class($this), strlen('HtmlExport')));
        $this->fileroot = $this->exporter->get('exportdir') . '/' . $this->exporter->get('rootdir') . '/files/' . $pluginname . '/';
        if (!check_dir_exists($this->fileroot)) {
Nigel McNie's avatar
Nigel McNie committed
532
            throw new SystemException("Could not create the temporary export directory $this->fileroot");
533
        }
534
535
536
537
        $this->extrafileroot = $this->exporter->get('exportdir') . '/' . $this->exporter->get('rootdir') . '/files/extra/';
        if (!check_dir_exists($this->extrafileroot)) {
            throw new SystemException("Could not create the temporary export directory $this->extrafileroot");
        }
538
539
540
541
542
543
544
545
    }

    abstract public function dump_export_data();

    abstract public function get_summary();

    abstract public function get_summary_weight();

546
547
548
    public function paginate($artefact) {

        // Create directory for storing the artefact
549
        $dirname = PluginExportHtml::text_to_filename(trim($artefact->get('title')));
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
        if (!check_dir_exists($this->fileroot . $dirname)) {
            throw new SystemException("Couldn't create artefact directory {$this->fileroot}{$dirname}");
        }

        // Get artefact-specific pagination options
        $options = $this->pagination_data($artefact);

        // Render the first page of the artefact (the only one if there aren't many children)
        $smarty = $this->exporter->get_smarty('../../../', $artefact->get('artefacttype'));
        $smarty->assign('page_heading', $artefact->get('title'));
        $smarty->assign('breadcrumbs', array(
            array('text' => $options['plural']),
            array('text' => $artefact->get('title'), 'path' => 'index.html'),
        ));
        $rendered = $artefact->render_self(array('hidetitle' => true));
        $outputfilter = new HtmlExportOutputFilter('../../../', $this->exporter);
        $smarty->assign('rendered', $outputfilter->filter($rendered['html']));
        $content = $smarty->fetch('export:html:page.tpl');

        if (false === file_put_contents($this->fileroot . $dirname . '/index.html', $content)) {
            throw new SystemException("Unable to create index.html for artefact " . $artefact->get('id'));
        }

        // If the artefact has many children, we'll need to write out archive pages
        if ($options['childcount'] > $options['perpage']) {
            for ($i = $options['perpage']; $i <= $options['childcount']; $i += $options['perpage']) {
                $rendered = $artefact->render_self(array('limit' => $options['perpage'], 'offset' => $i));
                $smarty->assign('rendered', $outputfilter->filter($rendered['html']));
                $content = $smarty->fetch('export:html:page.tpl');

                if (false === file_put_contents($this->fileroot . $dirname . "/{$i}.html", $content)) {
                    throw new SystemException("Unable to create {$i}.html for artefact {$artefact->get('id')}");
                }
            }
        }
    }
586
587
}

588
/**
Aaron Wells's avatar
Aaron Wells committed
589
 * Provides a mechanism for converting the HTML generated by views and
590
591
 * artefacts for the HTML export.
 *
Aaron Wells's avatar
Aaron Wells committed
592
 * Mostly, this means rewriting links to artefacts to point the correct place
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
 * in the export.
 */
class HtmlExportOutputFilter {

    /**
     * The relative path to the root of the generated export - used for link munging
     */
    private $basepath = '';

    /**
     * A cache of view titles. See replace_view_link()
     */
    private $viewtitles = array();

    /**
608
     * A cache of folder data. See get_folder_path_for_file()
609
610
611
     */
    private $folderdata = null;

612
613
614
615
    /**
     */
    private $htmlexportcopyproxy = null;

616
617
618
619
    /**
     */
    private $exporter = null;

620
621
622
623
    /**
     */
    private $owner = null;

624
625
626
    /**
     * @param string $basepath The relative path to the root of the generated export
     */
627
    public function __construct($basepath, &$exporter=null) {
628
        $this->basepath = preg_replace('#/$#', '', $basepath);
629
        $this->htmlexportcopyproxy = HtmlExportCopyProxy::singleton();
630
        $this->exporter = $exporter;
631
        $this->owner = $exporter->get('user')->get('id');
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
    }

    /**
     * Filters the given HTML for HTML export purposes
     *
     * @param string $html The HTML to filter
     * @return string      The filtered HTML
     */
    public function filter($html) {
        $wwwroot = preg_quote(get_config('wwwroot'));
        $html = preg_replace(
            array(
                // We don't care about javascript
                '#<script[^>]*>.*?</script>#si',
                // Fix simlies from tinymce
647
                '#<img ([^>]*)src="(' . $wwwroot . ')?/?js/tinymce/plugins/emoticons/img/([^"]+)"([^>]+)>#',
648
649
                // No forms
                '#<form[^>]*>.*?</form>#si',
650
651
                // Gratuitous hack for the RSS blocktype
                '#<div id="blocktype_externalfeed_lastupdate">[^<]*</div>#',
652
653
654
            ),
            array(
                '',
655
                '<img $1src="' . $this->basepath . '/static/smilies/$3"$4>',
656
                '',
657
                '',
658
659
660
661
662
663
664
665
666
667
668
669
670
            ),
            $html
        );

        // Links to views
        $html = preg_replace_callback(
            '#' . $wwwroot . 'view/view\.php\?id=(\d+)#',
            array($this, 'replace_view_link'),
            $html
        );

        // Links to artefacts
        $html = preg_replace_callback(
671
            '#<a[^>]+href="(' . $wwwroot . ')?/?view/artefact\.php\?artefact=(\d+)(&amp;view=\d+)?(&amp;offset=\d+)?"[^>]*>([^<]*)</a>#',
672
673
674
675
            array($this, 'replace_artefact_link'),
            $html
        );

676
677
678
679
680
681
682
        // Links to image artefacts
        $html = preg_replace_callback(
            '#<a[^>]+href="(' . $wwwroot . ')?/?view/artefact\.php\?artefact=(\d+)(&amp;view=\d+)?(&amp;offset=\d+)?"[^>]*>(<img[^>]+>)</a>#',
            array($this, 'replace_artefact_link'),
            $html
        );

683
684
        // Links to download files
        $html = preg_replace_callback(
685
            '#(?<=[\'"])(' . $wwwroot . ')?/?artefact/file/download\.php\?file=(\d+)(?:(?:&amp;|&|%26)([a-z]+=[x0-9]+)+)*#',
686
687
688
689
            array($this, 'replace_download_link'),
            $html
        );

690
        // Thumbnails
691
        require_once('file.php');
692
        $html = preg_replace_callback(
693
            '#(?<=[\'"])(' . $wwwroot . ')?/?thumb\.php\?type=([a-z]+)((?:(?:&amp;|&|%26)[a-z]+=[x0-9]+)+)*#',
694
695
696
697
            array($this, 'replace_thumbnail_link'),
            $html
        );

698
699
        // Images out of the theme directory
        $html = preg_replace_callback(
700
            '#(?<=[\'"])(' . $wwwroot . '|/)?((?:[a-z]+/)*)theme/([a-zA-Z0-9_.-]+)/static/images/([a-z0-9_.-]+)#',
701
702
703
704
            array($this, 'replace_theme_image_link'),
            $html
        );

705
706
707
708
        return $html;
    }

    /**
Aaron Wells's avatar
Aaron Wells committed
709
     * Callback to replace links to views to point to the correct location in
710
711
712
713
     * the HTML export
     */
    private function replace_view_link($matches) {
        $viewid = $matches[1];
714
715
716
717
        // Don't rewrite links to views that are not going to be included in the export
        if (!isset($this->exporter->views[$viewid])) {
            return $matches[0];
        }
718
        if (!isset($this->viewtitles[$viewid])) {
719
            $this->viewtitles[$viewid] = PluginExportHtml::text_to_URLpath(PluginExportHtml::text_to_filename(get_field('view', 'title', 'id', $viewid)));
720
721
722
723
724
        }
        return $this->basepath . '/views/' . $this->viewtitles[$viewid] . '/index.html';
    }

    /**
Aaron Wells's avatar
Aaron Wells committed
725
     * Callback to replace links to artefact to point to the correct location
726
727
728
729
     * in the HTML export
     */
    private function replace_artefact_link($matches) {
        $artefactid = $matches[2];
730
731
732
733
734
735
        try {
            $artefact = artefact_instance_from_id($artefactid);
        }
        catch (ArtefactNotFoundException $e) {
            return $matches[5];
        }
736

737
738
        $artefacttype = $artefact->get('artefacttype');
        switch ($artefacttype) {
739
        case 'blog':
740
741
        case 'plan':
            $dir = $artefacttype == 'plan' ? 'plans' : $artefacttype;
742
743
            $offset = ($matches[4]) ? intval(substr($matches[4], strlen('&amp;offset='))) : 0;
            $offset = ($offset == 0) ? 'index' : $offset;
744
            return '<a href="' . $this->basepath . "/files/$dir/" . PluginExportHtml::text_to_URLpath(PluginExportHtml::text_to_filename($artefact->get('title'))) . '/' . $offset . '.html">' . $matches[5] . '</a>';
745
        case 'file':
746
        case 'folder':
747
        case 'image':
748
        case 'profileicon':
749
        case 'archive':
750
751
        case 'video':
        case 'audio':
752
            return '<a href="' . $this->get_export_path_for_file($artefact, array()) . '">' . $matches[5] . '</a>';
753
754
755
756
757
758
        default:
            return $matches[5];
        }
    }

    /**
Aaron Wells's avatar
Aaron Wells committed
759
     * Callback to replace links to artefact/file/download.php to point to the
760
761
762
763
     * correct file in the HTML export
     */
    private function replace_download_link($matches) {
        $artefactid = $matches[2];
764
765
766
767
768
769
        try {
            $artefact = artefact_instance_from_id($artefactid);
        }
        catch (ArtefactNotFoundException $e) {
            return '';
        }
770

Aaron Wells's avatar
Aaron Wells committed
771
        // If artefact type not something that would be served by download.php,
772
773
774
775
776
        // replace link with nothing
        if ($artefact->get_plugin_name() != 'file') {
            return '';
        }

777
        $options = array();
778
779
780
        for ($i = 3; $i < count($matches); $i++) {
            list($key, $value) = explode('=', $matches[$i]);
            $options[$key] = $value;
781
782
        }

783
        return $this->get_export_path_for_file($artefact, $options);
784
785
786
    }

    /**
Aaron Wells's avatar
Aaron Wells committed
787
     * Callback to replace links to thumb.php to point to the correct file in
788
789
790
791
792
793
     * the HTML export
     */
    private function replace_thumbnail_link($matches) {
        if (isset($matches[3])) {
            $type = $matches[2];

794
795
            $parts = preg_split('/(&amp;|&|%26)/', $matches[3]);
            array_shift($parts);
796
797
798
799
800
801
802
803
804
805
806
807
808
            foreach ($parts as $part) {
                list($key, $value) = explode('=', $part);
                $options[$key] = $value;
            }

            if (!isset($options['id'])) {
                return '';
            }

            switch ($type) {
            case 'profileicon':
                // Convert the user ID to a profile icon ID
                if (!$options['id'] = get_field_sql('SELECT profileicon FROM {usr} WHERE id = ?', array($options['id']))) {
809
810
811
                    // No profile icon, get the default one
                    list($size, $prefix) = $this->get_size_from_options($options);
                    if ($from = get_dataroot_image_path('artefact/file/profileicons/no_userphoto/' . get_config('theme'), 0, $size)) {
812
                        $to = '/static/profileicons/0-' . $prefix . 'no_userphoto.png';
813
814
815
                        $this->htmlexportcopyproxy->add($from, $to);
                    }
                    return $this->basepath . $to;
816
817
                }
            case 'profileiconbyid':
818
819
820
821
822
823
                try {
                    $icon = artefact_instance_from_id($options['id']);
                }
                catch (ArtefactNotFoundException $e) {
                    return '';
                }
824
825
826
827
828
829
830
831
832
833
834
835
                if ($icon->get_plugin_name() != 'file') {
                    return '';
                }
                return $this->get_export_path_for_file($icon, $options, '/static/profileicons/');
            default:
                return '';
            }
        }

        return '';
    }

836
837
838
839
    /**
     * Callback
     */
    private function replace_theme_image_link($matches) {
840
        $file = $matches[2] . 'theme/' . $matches[3] . '/static/images/' . $matches[4];
841
842
843
844
845
846
847
        $this->htmlexportcopyproxy->add(
            get_config('docroot') . $file,
            '/static/' . $file
        );
        return $this->basepath . '/static/' . $file;
    }

848
849
    /**
     * Given a file, returns the folder path for it in the Mahara files area
850
     *
851
     * The path is pre-sanitised so it can be used when generating the export
852
     *
853
     * @param  $file The file or folder to get the folder path for
854
855
     * @return string
     */
856
    private function get_folder_path_for_file($file) {
857
858
        if ($this->folderdata === null) {
            $this->folderdata = get_records_select_assoc('artefact', "artefacttype = 'folder' AND owner = ?", array($file->get('owner')));
859
860
861
862
            if ($this->folderdata) {
                foreach ($this->folderdata as &$folder) {
                    $folder->title = PluginExportHtml::sanitise_path($folder->title);
                }
863
            }
864
865
866
867
868
        }
        $folderpath = ArtefactTypeFileBase::get_full_path($file->get('parent'), $this->folderdata);
        return $folderpath;
    }

869
    /**
Aaron Wells's avatar
Aaron Wells committed
870
     * Generates a path, relative to the root of the export, that the given
871
872
     * file will appear in the export.
     *
Aaron Wells's avatar
Aaron Wells committed
873
     * If the file is a thumbnail, the copy proxy is informed about it so that
874
875
876
     * the image can later be copied in to place.
     *
     * @param ArtefactTypeFileBase $file The file to get the exported path for
Aaron Wells's avatar
Aaron Wells committed
877
878
879
     * @param array $options             Options from the URL that was linking
     *                                   to the image - most importantly, size
     *                                   related options about how the image
880
     *                                   was thumbnailed, if it was.
Aaron Wells's avatar
Aaron Wells committed
881
     * @param string $basefolder         What folder in the export to dump the
882
     *                                   file in
Aaron Wells's avatar
Aaron Wells committed
883
     * @return string                    The relative path to where the file
884
885
     *                                   will be placed
     */
886
887
888
889
890
891
892
893
894
895
    private function get_export_path_for_file(ArtefactTypeFileBase $file, array $options, $basefolder=null) {
        if (is_null($basefolder)) {
            if ($file->get('owner') == $this->owner) {
                $basefolder = '/files/file/' . $this->get_folder_path_for_file($file);
            }
            else {
                $basefolder = '/files/extra/';
            }
        }

896
897
        unset($options['view']);
        $prefix = '';
898
899
        $title = PluginExportHtml::sanitise_path($file->get('title'));

900
        if ($options) {
901
            list($size, $prefix) = $this->get_size_from_options($options);
902
903
            $from = $file->get_path($size);

904
            $to = $basefolder . $file->get('id') . '-' . $prefix . $title;
905
906
907
            $this->htmlexportcopyproxy->add($from, $to);
        }
        else {
908
909
910
911
            if ($basefolder == '/files/extra/') {
                $title = $file->get('id') . '-' . $title;
            }
            $to = $basefolder . $title;
912
913
914
915
916
        }

        return $this->basepath . $to;
    }

917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
    /**
     * Helper method
     */
    private function get_size_from_options($options) {
        $prefix = '';
        foreach (array('size', 'width', 'height', 'maxsize', 'maxwidth', 'maxheight') as $param) {
            if (isset($options[$param])) {
                $$param = $options[$param];
                $prefix .= $param . '-' . $options[$param] . '-';
            }
            else {
                $$param = null;
            }
        }

        return array(imagesize_data_to_internal_form($size, $width, $height, $maxsize, $maxwidth, $maxheight), $prefix);
    }

935
936
937
}

/**
Aaron Wells's avatar
Aaron Wells committed
938
 * Gathers a list of files that need to be copied into the export, as they're
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
 * found by the HtmlExportOutputFilter
 */
class HtmlExportCopyProxy {

    private static $instance = null;
    private $copy = array();

    private function __construct() {
    }

    public static function singleton() {
        if (is_null(self::$instance)) {
            self::$instance = new HtmlExportCopyProxy();
        }
        return self::$instance;
    }

    public function add($from, $to) {
        $this->copy[$from] = $to;
    }

    public function get_copy_data() {
        return $this->copy;
    }
963
}