lib.php 35.9 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
25
26
27
28
29
 *
 */

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

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

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

    /**
     * The name of the directory under which all the other directories and 
     * 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
38
39
     * List of stylesheets to include in the export.
     *
     * This is keyed by artefact plugin name, the empty string key contains 
     * stylesheets that will be included on all pages.
40
     */
41
    private $stylesheets = array('' => array());
42

43
44
45
46
47
48
49
    /**
     * Whether the user requested to export just one view. In this case,
     * the generated export doesn't have the home page - just the View is 
     * 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
    /**
Nigel McNie's avatar
Nigel McNie committed
105
106
     * Main export routine
     */
107
    public function export() {
108
        global $THEME, $SESSION;
109
110
        raise_memory_limit('128M');

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

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

125
            if (safe_require('export', 'html/' . $plugin, 'lib.php', 'require_once', true)) {
126
127
                $exportplugins[] = $plugin;

128
129
130
131
132
133
134
                $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);

135
                // Find out whether the plugin has static data for us
136
                $themestaticdirs = array_reverse($THEME->get_path('', true, 'artefact/' . $plugin . '/export/html'));
137
138
139
140
141
                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)) {
142
                            $this->stylesheets[$plugin][] = str_replace('export/html/', '', $staticdir) . 'style/' . $stylesheet;
143
144
                        }
                    }
145
                }
146
147
148
            }
        }

149
150
        // Second pass: actually dump data for active export plugins
        $progressstart = 25;
151
        $progressend   = 50;
152
153
        $i = 0;
        foreach ($exportplugins as $plugin) {
154
            $this->notify_progress_callback(intval($progressstart + (++$i / $plugincount) * ($progressend - $progressstart)), get_string('exportingdatafor', 'export.html', $plugin));
155
156
157
158
            $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
159
160
            if (!(($this->viewexportmode == PluginExport::EXPORT_LIST_OF_VIEWS || $this->viewexportmode == PluginExport::EXPORT_COLLECTIONS)
                && $this->artefactexportmode == PluginExport::EXPORT_ARTEFACTS_FOR_VIEWS)) {
161
162
163
164
                $summaries[$plugin] = array($artefactexporter->get_summary_weight(), $artefactexporter->get_summary());
            }
        }

165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
        // 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
181
        // Get the view data
182
        $this->notify_progress_callback(55, get_string('exportingviews', 'export'));
Nigel McNie's avatar
Nigel McNie committed
183
184
        $this->dump_view_export_data();

185
186
        if (!$this->exportingoneview) {
            $summaries['view'] = array(100, $this->get_view_summary());
187

188
            // Sort by weight (then drop the weight information)
189
            $this->notify_progress_callback(75, get_string('buildingindexpage', 'export.html'));
190
191
192
193
194
195
196
197
            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);
        }
198
199

        // Copy all static files into the export
200
        $this->notify_progress_callback(80, get_string('copyingextrafiles', 'export.html'));
201
        $this->copy_static_files();
202
203
204
205
206

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

        // zip everything up
217
        $this->notify_progress_callback(90, get_string('creatingzipfile', 'export'));
218
219
220
221
222
223
224
225
226
227
228
229
230
231
        $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');
        }
232
        $this->notify_progress_callback(100, get_string('Done', 'export'));
233
234
235
236
237
238
239
240
        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
    }

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

        return $smarty;
    }

259
260
261
262
263
264
265
    /**
     * Converts a relative path to a static file that the HTML export theme 
     * 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) {
266
267
        global $THEME;
        $themestaticdirs = $THEME->get_path('', true, 'export/html');
268
269
270
271
272
273
274
        foreach ($themestaticdirs as $theme => $dir) {
            if (is_readable($dir . $path)) {
                return 'static/theme/' . $theme . '/static/' . $path;
            }
        }
    }

275
    /**
276
     * Converts the UTF-8 passed text into a a form that could be used in a file name.
277
278
279
280
     *
     * @param string $text The text to convert
     * @return string      The converted text
     */
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
    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;
300
301
    }

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


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

323
324
325
326
327
328
329
330
    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,
331
                    'url'  => self::text_to_URLpath(self::text_to_filename($title)) . '/index.html',
332
333
334
335
336
337
338
                    'text' => $title,
                );
            }
        }
        return $menus[$collectionid];
    }

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

355
356
357
358
359
360
361
362
363
            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'),
                ));
364
                $directory = $this->exportdir . '/' . $this->rootdir . '/views/' . self::text_to_filename($view->get('title'));
365
366
367
                if (is_dir($directory)) {
                    throw new SystemException(get_string('duplicatepagetitle', 'export.html'));
                }
368
369
370
                if (!check_dir_exists($directory)) {
                    throw new SystemException("Could not create directory for view $viewid");
                }
371
            }
Nigel McNie's avatar
Nigel McNie committed
372

373
            // Collection menu data
374
            if (isset($this->viewcollection[$viewid]) && $this->viewexportmode == PluginExport::EXPORT_COLLECTIONS) {
375
376
377
378
379
                $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);
            }

380
            $outputfilter = new HtmlExportOutputFilter($rootpath, $this);
381
382
383
384
385
386
387
388
389
390
391

            // Include comments
            if ($this->includefeedback) {
                $feedback = null;
                $artefact = null;
                if ($feedback = ArtefactTypeComment::get_comments(0, 0, null, $view, $artefact, true)) {
                    $feedback->tablerows = $outputfilter->filter($feedback->tablerows);
                }
                $smarty->assign('feedback', $feedback);
            }

392
            $smarty->assign('view', $outputfilter->filter($view->build_rows()));
393
394
395
            $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
396
397
398
399
400
401
402
            }
        }
    }

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

403
404
405
406
407
408
409
410
        $list = array();
        foreach ($this->collections as $id => $collection) {
            $list['c' . $id] = array(
                'title' => $collection->get('name'),
                'views' => array(),
            );
        }

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

437
        if ($list) {
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
            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'),
                );
            }
454
455
456
457
458
        }
        else {
            $stryouhaveviews = get_string('youhavenoviews', 'view');
        }
        $smarty->assign('stryouhaveviews', $stryouhaveviews);
Nigel McNie's avatar
Nigel McNie committed
459
460

        return array(
461
            'title' => get_string('Views', 'view'),
Nigel McNie's avatar
Nigel McNie committed
462
463
464
465
            'description' => $smarty->fetch('export:html:viewsummary.tpl'),
        );
    }

466
467
468
469
    /**
     * Copies the static files (stylesheets etc.) into the export
     */
    private function copy_static_files() {
470
        global $THEME, $SESSION;
471
        require_once('file.php');
472
        $staticdir = $this->get('exportdir') . '/' . $this->get('rootdir') . '/static/';
473
474
475
        $directoriestocopy = array();

        // Get static directories from each theme for HTML export
476
        $themestaticdirs = $THEME->get_path('', true, 'export/html');
477
478
479
480
481
482
483
484
485
        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
486
        $directoriestocopy[get_config('docroot') . 'js/tinymce/plugins/emotions/img'] = $staticdir . 'smilies/';
487

488
489
490
        $filestocopy = array(
            get_config('docroot') . 'theme/views.css' => $staticdir . 'views.css',
        );
491

492
        foreach ($this->pluginstaticdirs as $dir) {
493
494
            $destinationdir = str_replace('export/html/', '', $dir);
            if (!check_dir_exists($staticdir . $destinationdir)) {
495
                $SESSION->add_error_msg(get_string('couldnotcreatestaticdirectory', 'export', $destinationdir));
496
            }
497
            $directoriestocopy[get_config('docroot') . 'artefact/' . $dir] = $staticdir . $destinationdir;
498
499
        }

500
        foreach ($directoriestocopy as $from => $to) {
501
            if (!copyr($from, $to)) {
502
                $SESSION->add_error_msg(get_string('couldnotcopyfilesfromto', 'export', $from, $to));
503
504
            }
        }
505
506

        foreach ($filestocopy as $from => $to) {
507
508
            if (!is_file($from) || !copy($from, $to)) {
                $SESSION->add_error_msg(get_string('couldnotcopystaticfile', 'export', $from));
509
510
            }
        }
511
512
    }

513
514
515
516
517
518
519
520
521
522
523
524
525
}

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
526
            throw new SystemException("Could not create the temporary export directory $this->fileroot");
527
        }
528
529
530
531
        $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");
        }
532
533
534
535
536
537
538
539
    }

    abstract public function dump_export_data();

    abstract public function get_summary();

    abstract public function get_summary_weight();

540
541
542
    public function paginate($artefact) {

        // Create directory for storing the artefact
543
        $dirname = PluginExportHtml::text_to_filename(trim($artefact->get('title')));
544
545
546
547
548
549
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
        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')}");
                }
            }
        }
    }
580
581
}

582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
/**
 * Provides a mechanism for converting the HTML generated by views and 
 * artefacts for the HTML export.
 *
 * Mostly, this means rewriting links to artefacts to point the correct place 
 * 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();

    /**
602
     * A cache of folder data. See get_folder_path_for_file()
603
604
605
     */
    private $folderdata = null;

606
607
608
609
    /**
     */
    private $htmlexportcopyproxy = null;

610
611
612
613
    /**
     */
    private $exporter = null;

614
615
616
617
    /**
     */
    private $owner = null;

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

    /**
     * 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
641
                '#<img ([^>]*)src="(' . $wwwroot . ')?/?js/tinymce/plugins/emotions/img/([^"]+)"([^>]+)>#',
642
643
                // No forms
                '#<form[^>]*>.*?</form>#si',
644
645
                // Gratuitous hack for the RSS blocktype
                '#<div id="blocktype_externalfeed_lastupdate">[^<]*</div>#',
646
647
648
            ),
            array(
                '',
649
                '<img $1src="' . $this->basepath . '/static/smilies/$3"$4>',
650
                '',
651
                '',
652
653
654
655
656
657
658
659
660
661
662
663
664
            ),
            $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(
665
            '#<a[^>]+href="(' . $wwwroot . ')?/?view/artefact\.php\?artefact=(\d+)(&amp;view=\d+)?(&amp;offset=\d+)?"[^>]*>([^<]*)</a>#',
666
667
668
669
            array($this, 'replace_artefact_link'),
            $html
        );

670
671
672
673
674
675
676
        // 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
        );

677
678
        // Links to download files
        $html = preg_replace_callback(
679
            '#(?<=[\'"])(' . $wwwroot . ')?/?artefact/file/download\.php\?file=(\d+)(?:(?:&amp;|&|%26)([a-z]+=[x0-9]+)+)*#',
680
681
682
683
            array($this, 'replace_download_link'),
            $html
        );

684
        // Thumbnails
685
        require_once('file.php');
686
        $html = preg_replace_callback(
687
            '#(?<=[\'"])(' . $wwwroot . ')?/?thumb\.php\?type=([a-z]+)((?:(?:&amp;|&|%26)[a-z]+=[x0-9]+)+)*#',
688
689
690
691
            array($this, 'replace_thumbnail_link'),
            $html
        );

692
693
        // Images out of the theme directory
        $html = preg_replace_callback(
694
            '#(?<=[\'"])(' . $wwwroot . '|/)?((?:[a-z]+/)*)theme/([a-zA-Z0-9_.-]+)/static/images/([a-z0-9_.-]+)#',
695
696
697
698
            array($this, 'replace_theme_image_link'),
            $html
        );

699
700
701
702
703
704
705
706
707
        return $html;
    }

    /**
     * Callback to replace links to views to point to the correct location in 
     * the HTML export
     */
    private function replace_view_link($matches) {
        $viewid = $matches[1];
708
709
710
711
        // 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];
        }
712
        if (!isset($this->viewtitles[$viewid])) {
713
            $this->viewtitles[$viewid] = PluginExportHtml::text_to_URLpath(PluginExportHtml::text_to_filename(get_field('view', 'title', 'id', $viewid)));
714
715
716
717
718
719
720
721
722
723
        }
        return $this->basepath . '/views/' . $this->viewtitles[$viewid] . '/index.html';
    }

    /**
     * Callback to replace links to artefact to point to the correct location 
     * in the HTML export
     */
    private function replace_artefact_link($matches) {
        $artefactid = $matches[2];
724
725
726
727
728
729
        try {
            $artefact = artefact_instance_from_id($artefactid);
        }
        catch (ArtefactNotFoundException $e) {
            return $matches[5];
        }
730

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

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

        // If artefact type not something that would be served by download.php, 
        // replace link with nothing
        if ($artefact->get_plugin_name() != 'file') {
            return '';
        }

771
        $options = array();
772
773
774
        for ($i = 3; $i < count($matches); $i++) {
            list($key, $value) = explode('=', $matches[$i]);
            $options[$key] = $value;
775
776
        }

777
        return $this->get_export_path_for_file($artefact, $options);
778
779
780
    }

    /**
781
782
783
784
785
786
787
     * Callback to replace links to thumb.php to point to the correct file in 
     * the HTML export
     */
    private function replace_thumbnail_link($matches) {
        if (isset($matches[3])) {
            $type = $matches[2];

788
789
            $parts = preg_split('/(&amp;|&|%26)/', $matches[3]);
            array_shift($parts);
790
791
792
793
794
795
796
797
798
799
800
801
802
            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']))) {
803
804
805
                    // 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)) {
806
                        $to = '/static/profileicons/0-' . $prefix . 'no_userphoto.png';
807
808
809
                        $this->htmlexportcopyproxy->add($from, $to);
                    }
                    return $this->basepath . $to;
810
811
                }
            case 'profileiconbyid':
812
813
814
815
816
817
                try {
                    $icon = artefact_instance_from_id($options['id']);
                }
                catch (ArtefactNotFoundException $e) {
                    return '';
                }
818
819
820
821
822
823
824
825
826
827
828
829
                if ($icon->get_plugin_name() != 'file') {
                    return '';
                }
                return $this->get_export_path_for_file($icon, $options, '/static/profileicons/');
            default:
                return '';
            }
        }

        return '';
    }

830
831
832
833
    /**
     * Callback
     */
    private function replace_theme_image_link($matches) {
834
        $file = $matches[2] . 'theme/' . $matches[3] . '/static/images/' . $matches[4];
835
836
837
838
839
840
841
        $this->htmlexportcopyproxy->add(
            get_config('docroot') . $file,
            '/static/' . $file
        );
        return $this->basepath . '/static/' . $file;
    }

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

863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
    /**
     * Generates a path, relative to the root of the export, that the given 
     * file will appear in the export.
     *
     * If the file is a thumbnail, the copy proxy is informed about it so that 
     * the image can later be copied in to place.
     *
     * @param ArtefactTypeFileBase $file The file to get the exported path for
     * @param array $options             Options from the URL that was linking 
     *                                   to the image - most importantly, size 
     *                                   related options about how the image 
     *                                   was thumbnailed, if it was.
     * @param string $basefolder         What folder in the export to dump the 
     *                                   file in
     * @return string                    The relative path to where the file 
     *                                   will be placed
     */
880
881
882
883
884
885
886
887
888
889
    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/';
            }
        }

890
891
        unset($options['view']);
        $prefix = '';
892
893
        $title = PluginExportHtml::sanitise_path($file->get('title'));

894
        if ($options) {
895
            list($size, $prefix) = $this->get_size_from_options($options);
896
897
            $from = $file->get_path($size);

898
            $to = $basefolder . $file->get('id') . '-' . $prefix . $title;
899
900
901
            $this->htmlexportcopyproxy->add($from, $to);
        }
        else {
902
903
904
905
            if ($basefolder == '/files/extra/') {
                $title = $file->get('id') . '-' . $title;
            }
            $to = $basefolder . $title;
906
907
908
909
910
        }

        return $this->basepath . $to;
    }

911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
    /**
     * 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);
    }

929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
}

/**
 * Gathers a list of files that need to be copied into the export, as they're 
 * 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;
    }
957
}