lib.php 36.7 KB
Newer Older
1
2
3
<?php
/**
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
4
5
 * Copyright (C) 2006-2009 Catalyst IT Ltd and others; see:
 *                         http://wiki.mahara.org/Contributors
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @package    mahara
 * @subpackage export-html
 * @author     Catalyst IT Ltd
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
24
 * @copyright  (C) 2006-2009 Catalyst IT Ltd http://catalyst.net.nz
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 *
 */

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;

46
47
48
49
50
51
    /**
     * List of directories of static files provided by artefact plugins
     */
    private $pluginstaticdirs = array();

    /**
52
53
54
55
     * 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.
56
     */
57
    private $stylesheets = array('' => array());
58

59
60
61
62
63
64
65
    /**
     * 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;

66
67
68
69
    /**
    * constructor.  overrides the parent class
    * to set up smarty and the attachment directory
    */
70
    public function __construct(User $user, $views, $artefacts, $progresscallback=null) {
71
        global $THEME;
72
        parent::__construct($user, $views, $artefacts, $progresscallback);
73
        $this->rootdir = 'portfolio-for-' . self::text_to_filename($user->get('username'));
74
75

        // Create basic required directories
76
        foreach (array('files', 'views', 'static', 'static/smilies', 'static/profileicons') as $directory) {
77
78
79
80
81
82
            $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'
83
            . $this->get('user')->get('id') . '-' . $this->exporttime . '.zip';
84
85

        // Find what stylesheets need to be included
86
        $themedirs = $THEME->get_path('', true, 'export/html');
87
        $stylesheets = array('style.css', 'print.css', 'jquery.rating.css');
88
89
90
        foreach ($themedirs as $theme => $themedir) {
            foreach ($stylesheets as $stylesheet) {
                if (is_readable($themedir . 'style/' . $stylesheet)) {
91
                    array_unshift($this->stylesheets[''], 'theme/' . $theme . '/static/style/' . $stylesheet);
92
93
94
95
                }
            }
        }

96
97
98
99
100
101
102
        // Don't export the dashboard
        foreach (array_keys($this->views) as $i) {
            if ($this->views[$i]->get('type') == 'dashboard') {
                unset($this->views[$i]);
            }
        }

103
104
105
106
107
108
        $this->exportingoneview = (
            $this->viewexportmode == PluginExport::EXPORT_LIST_OF_VIEWS &&
            $this->artefactexportmode == PluginExport::EXPORT_ARTEFACTS_FOR_VIEWS &&
            count($this->views) == 1
        );

109
        $this->notify_progress_callback(15, get_string('setupcomplete', 'export'));
110
111
    }

112
113
114
115
116
117
118
119
    public static function get_title() {
        return get_string('title', 'export.html');
    }

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

120
    /**
Nigel McNie's avatar
Nigel McNie committed
121
122
     * Main export routine
     */
123
    public function export() {
124
        global $THEME, $SESSION;
125
126
        raise_memory_limit('128M');

127
        $summaries = array();
128
        $plugins = plugins_installed('artefact', true);
129
        $exportplugins = array();
130
        $progressstart = 15;
131
        $progressend   = 25;
132
        $plugincount   = count($plugins);
133
134
135

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

141
            if (safe_require('export', 'html/' . $plugin, 'lib.php', 'require_once', true)) {
142
143
                $exportplugins[] = $plugin;

144
145
146
147
148
149
150
                $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);

151
                // Find out whether the plugin has static data for us
152
                $themestaticdirs = array_reverse($THEME->get_path('', true, 'artefact/' . $plugin . '/export/html'));
153
154
155
156
157
                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)) {
158
                            $this->stylesheets[$plugin][] = str_replace('export/html/', '', $staticdir) . 'style/' . $stylesheet;
159
160
                        }
                    }
161
                }
162
163
164
            }
        }

165
166
        // Second pass: actually dump data for active export plugins
        $progressstart = 25;
167
        $progressend   = 50;
168
169
        $i = 0;
        foreach ($exportplugins as $plugin) {
170
            $this->notify_progress_callback(intval($progressstart + (++$i / $plugincount) * ($progressend - $progressstart)), get_string('exportingdatafor', 'export.html', $plugin));
171
172
173
174
            $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
175
176
            if (!(($this->viewexportmode == PluginExport::EXPORT_LIST_OF_VIEWS || $this->viewexportmode == PluginExport::EXPORT_COLLECTIONS)
                && $this->artefactexportmode == PluginExport::EXPORT_ARTEFACTS_FOR_VIEWS)) {
177
178
179
180
                $summaries[$plugin] = array($artefactexporter->get_summary_weight(), $artefactexporter->get_summary());
            }
        }

181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
        // 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
197
        // Get the view data
198
        $this->notify_progress_callback(55, get_string('exportingviews', 'export'));
Nigel McNie's avatar
Nigel McNie committed
199
200
        $this->dump_view_export_data();

201
202
        if (!$this->exportingoneview) {
            $summaries['view'] = array(100, $this->get_view_summary());
203

204
            // Sort by weight (then drop the weight information)
205
            $this->notify_progress_callback(75, get_string('buildingindexpage', 'export.html'));
206
207
208
209
210
211
212
213
            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);
        }
214
215

        // Copy all static files into the export
216
        $this->notify_progress_callback(80, get_string('copyingextrafiles', 'export.html'));
217
        $this->copy_static_files();
218
219
220
221
222

        // Copy all resized images that were found while rewriting the HTML
        $copyproxy = HtmlExportCopyProxy::singleton();
        $copydata = $copyproxy->get_copy_data();
        foreach ($copydata as $from => $to) {
223
224
            $to = $this->get('exportdir') . '/' . $this->get('rootdir') . $to;
            if (!check_dir_exists(dirname($to))) {
225
                $SESSION->add_error_msg(get_string('couldnotcreatedirectory', 'export', $todir));
226
227
            }
            if (!copy($from, $to)) {
228
                $SESSION->add_error_msg(get_string('couldnotcopystaticfile', 'export', $from));
229
230
            }
        }
231
232

        // zip everything up
233
        $this->notify_progress_callback(90, get_string('creatingzipfile', 'export'));
234
235
236
237
238
239
240
241
242
243
244
245
246
247
        $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');
        }
248
        $this->notify_progress_callback(100, get_string('Done', 'export'));
249
250
251
252
253
254
255
256
        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
    }

257
258
259
260
261
262
263
    public function get_smarty($rootpath='', $section='') {
        if ($section && isset($this->stylesheets[$section])) {
            $stylesheets = array_merge($this->stylesheets[''], $this->stylesheets[$section]);
        }
        else {
            $stylesheets = $this->stylesheets[''];
        }
264
265
266
        $smarty = smarty_core();
        $smarty->assign('user', $this->get('user'));
        $smarty->assign('rootpath', $rootpath);
267
        $smarty->assign('export_time', $this->exporttime);
268
        $smarty->assign('sitename', get_config('sitename'));
269
        $smarty->assign('stylesheets', $stylesheets);
270
        $smarty->assign('maharalogo', $rootpath . $this->theme_path('images/logo.png'));
271
272
273
274

        return $smarty;
    }

275
276
277
278
279
280
281
    /**
     * 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) {
282
283
        global $THEME;
        $themestaticdirs = $THEME->get_path('', true, 'export/html');
284
285
286
287
288
289
290
        foreach ($themestaticdirs as $theme => $dir) {
            if (is_readable($dir . $path)) {
                return 'static/theme/' . $theme . '/static/' . $path;
            }
        }
    }

291
    /**
292
     * Converts the UTF-8 passed text into a a form that could be used in a file name.
293
294
295
296
     *
     * @param string $text The text to convert
     * @return string      The converted text
     */
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
    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;
316
317
    }

318
319
320
321
322
323
324
    /**
     * 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) {
325
        return trim(substr(str_replace('/', '_', $path), 0, 255));
326
327
328
    }


329
330
    private function build_index_page($summaries) {
        $smarty = $this->get_smarty();
331
        $smarty->assign('page_heading', full_name($this->get('user')));
332
333
        $smarty->assign('summaries', $summaries);
        $content = $smarty->fetch('export:html:index.tpl');
334
335
336
        if (!file_put_contents($this->exportdir . '/' . $this->rootdir . '/index.html', $content)) {
            throw new SystemException("Could not create index.html for the export");
        }
337
338
    }

339
340
341
342
343
344
345
346
    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,
347
                    'url'  => self::text_to_URLpath(self::text_to_filename($title)) . '/index.html',
348
349
350
351
352
353
354
                    'text' => $title,
                );
            }
        }
        return $menus[$collectionid];
    }

Nigel McNie's avatar
Nigel McNie committed
355
356
357
358
    /**
     * Dumps all views into the HTML export
     */
    private function dump_view_export_data() {
359
        safe_require('artefact', 'comment');
360
361
362
363
        $progressstart = 55;
        $progressend   = 75;
        $i = 0;
        $viewcount = count($this->views);
364
365
        $rootpath = ($this->exportingoneview) ? './' : '../../';
        $smarty = $this->get_smarty($rootpath);
366
        foreach ($this->views as $viewid => $view) {
367
            $this->notify_progress_callback(intval($progressstart + (++$i / $viewcount) * ($progressend - $progressstart)), get_string('exportingviewsprogress', 'export', $i, $viewcount));
368
            $smarty->assign('page_heading', $view->get('title'));
369
            $smarty->assign('viewdescription', $view->get('description'));
370

371
372
373
374
375
376
377
378
379
            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'),
                ));
380
                $directory = $this->exportdir . '/' . $this->rootdir . '/views/' . self::text_to_filename($view->get('title'));
381
382
383
                if (is_dir($directory)) {
                    throw new SystemException(get_string('duplicatepagetitle', 'export.html'));
                }
384
385
386
                if (!check_dir_exists($directory)) {
                    throw new SystemException("Could not create directory for view $viewid");
                }
387
            }
Nigel McNie's avatar
Nigel McNie committed
388

389
            // Collection menu data
390
            if (isset($this->viewcollection[$viewid]) && $this->viewexportmode == PluginExport::EXPORT_COLLECTIONS) {
391
392
393
394
395
                $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);
            }

396
            $outputfilter = new HtmlExportOutputFilter($rootpath, $this);
397
398
399
400
401
402
403
404
405
406
407

            // 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);
            }

408
            $smarty->assign('view', $outputfilter->filter($view->build_rows()));
409
410
411
            $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
412
413
414
415
416
417
418
            }
        }
    }

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

419
420
421
422
423
424
425
426
        $list = array();
        foreach ($this->collections as $id => $collection) {
            $list['c' . $id] = array(
                'title' => $collection->get('name'),
                'views' => array(),
            );
        }

427
        $ncollections = count($this->collections);
428
429
        $nviews = 0;
        foreach ($this->views as $id => $view) {
Nigel McNie's avatar
Nigel McNie committed
430
            if ($view->get('type') != 'profile') {
431
                $item = array(
Nigel McNie's avatar
Nigel McNie committed
432
                    'title' => $view->get('title'),
433
                    'folder' => self::text_to_filename($view->get('title')),
Nigel McNie's avatar
Nigel McNie committed
434
                );
435
436
437
438
439
440
441
                if (isset($this->viewcollection[$id])) {
                    $list['c' . $this->viewcollection[$id]]['views'][] = $item;
                }
                else {
                    $list[$id] = $item;
                }
                $nviews++;
Nigel McNie's avatar
Nigel McNie committed
442
443
            }
        }
444
445
446
        function sort_by_title($a, $b) {
            return strnatcasecmp($a['title'], $b['title']);
        }
447
448
449
450
451
        foreach (array_keys($this->collections) as $id) {
            usort($list['c' . $id]['views'], 'sort_by_title');
        }
        usort($list, 'sort_by_title');
        $smarty->assign('list', $list);
452

453
        if ($list) {
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
            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'),
                );
            }
470
471
472
473
474
        }
        else {
            $stryouhaveviews = get_string('youhavenoviews', 'view');
        }
        $smarty->assign('stryouhaveviews', $stryouhaveviews);
Nigel McNie's avatar
Nigel McNie committed
475
476

        return array(
477
            'title' => get_string('Views', 'view'),
Nigel McNie's avatar
Nigel McNie committed
478
479
480
481
            'description' => $smarty->fetch('export:html:viewsummary.tpl'),
        );
    }

482
483
484
485
    /**
     * Copies the static files (stylesheets etc.) into the export
     */
    private function copy_static_files() {
486
        global $THEME, $SESSION;
487
        require_once('file.php');
488
        $staticdir = $this->get('exportdir') . '/' . $this->get('rootdir') . '/static/';
489
490
491
        $directoriestocopy = array();

        // Get static directories from each theme for HTML export
492
        $themestaticdirs = $THEME->get_path('', true, 'export/html');
493
494
495
496
497
498
499
500
501
        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
502
        $directoriestocopy[get_config('docroot') . 'js/tinymce/plugins/emotions/img'] = $staticdir . 'smilies/';
503

504
505
506
        $filestocopy = array(
            get_config('docroot') . 'theme/views.css' => $staticdir . 'views.css',
        );
507

508
        foreach ($this->pluginstaticdirs as $dir) {
509
510
            $destinationdir = str_replace('export/html/', '', $dir);
            if (!check_dir_exists($staticdir . $destinationdir)) {
511
                $SESSION->add_error_msg(get_string('couldnotcreatestaticdirectory', 'export', $destinationdir));
512
            }
513
            $directoriestocopy[get_config('docroot') . 'artefact/' . $dir] = $staticdir . $destinationdir;
514
515
        }

516
        foreach ($directoriestocopy as $from => $to) {
517
            if (!copyr($from, $to)) {
518
                $SESSION->add_error_msg(get_string('couldnotcopyfilesfromto', 'export', $from, $to));
519
520
            }
        }
521
522

        foreach ($filestocopy as $from => $to) {
523
524
            if (!is_file($from) || !copy($from, $to)) {
                $SESSION->add_error_msg(get_string('couldnotcopystaticfile', 'export', $from));
525
526
            }
        }
527
528
    }

529
530
531
532
533
534
535
536
537
538
539
540
541
}

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
542
            throw new SystemException("Could not create the temporary export directory $this->fileroot");
543
        }
544
545
546
547
        $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");
        }
548
549
550
551
552
553
554
555
    }

    abstract public function dump_export_data();

    abstract public function get_summary();

    abstract public function get_summary_weight();

556
557
558
    public function paginate($artefact) {

        // Create directory for storing the artefact
559
        $dirname = PluginExportHtml::text_to_filename(trim($artefact->get('title')));
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
586
587
588
589
590
591
592
593
594
595
        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')}");
                }
            }
        }
    }
596
597
}

598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
/**
 * 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();

    /**
618
     * A cache of folder data. See get_folder_path_for_file()
619
620
621
     */
    private $folderdata = null;

622
623
624
625
    /**
     */
    private $htmlexportcopyproxy = null;

626
627
628
629
    /**
     */
    private $exporter = null;

630
631
632
633
    /**
     */
    private $owner = null;

634
635
636
    /**
     * @param string $basepath The relative path to the root of the generated export
     */
637
    public function __construct($basepath, &$exporter=null) {
638
        $this->basepath = preg_replace('#/$#', '', $basepath);
639
        $this->htmlexportcopyproxy = HtmlExportCopyProxy::singleton();
640
        $this->exporter = $exporter;
641
        $this->owner = $exporter->get('user')->get('id');
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
    }

    /**
     * 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
657
                '#<img ([^>]*)src="(' . $wwwroot . ')?/?js/tinymce/plugins/emotions/img/([^"]+)"([^>]+)>#',
658
659
                // No forms
                '#<form[^>]*>.*?</form>#si',
660
661
                // Gratuitous hack for the RSS blocktype
                '#<div id="blocktype_externalfeed_lastupdate">[^<]*</div>#',
662
663
664
            ),
            array(
                '',
665
                '<img $1src="' . $this->basepath . '/static/smilies/$3"$4>',
666
                '',
667
                '',
668
669
670
671
672
673
674
675
676
677
678
679
680
            ),
            $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(
681
            '#<a[^>]+href="(' . $wwwroot . ')?/?view/artefact\.php\?artefact=(\d+)(&amp;view=\d+)?(&amp;offset=\d+)?"[^>]*>([^<]*)</a>#',
682
683
684
685
            array($this, 'replace_artefact_link'),
            $html
        );

686
687
688
689
690
691
692
        // 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
        );

693
694
        // Links to download files
        $html = preg_replace_callback(
695
            '#(?<=[\'"])(' . $wwwroot . ')?/?artefact/file/download\.php\?file=(\d+)(?:(?:&amp;|&|%26)([a-z]+=[x0-9]+)+)*#',
696
697
698
699
            array($this, 'replace_download_link'),
            $html
        );

700
        // Thumbnails
701
        require_once('file.php');
702
        $html = preg_replace_callback(
703
            '#(?<=[\'"])(' . $wwwroot . ')?/?thumb\.php\?type=([a-z]+)((?:(?:&amp;|&|%26)[a-z]+=[x0-9]+)+)*#',
704
705
706
707
            array($this, 'replace_thumbnail_link'),
            $html
        );

708
709
        // Images out of the theme directory
        $html = preg_replace_callback(
710
            '#(?<=[\'"])(' . $wwwroot . '|/)?((?:[a-z]+/)*)theme/([a-zA-Z0-9_.-]+)/static/images/([a-z0-9_.-]+)#',
711
712
713
714
            array($this, 'replace_theme_image_link'),
            $html
        );

715
716
717
718
719
720
721
722
723
        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];
724
725
726
727
        // 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];
        }
728
        if (!isset($this->viewtitles[$viewid])) {
729
            $this->viewtitles[$viewid] = PluginExportHtml::text_to_URLpath(PluginExportHtml::text_to_filename(get_field('view', 'title', 'id', $viewid)));
730
731
732
733
734
735
736
737
738
739
        }
        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];
740
741
742
743
744
745
        try {
            $artefact = artefact_instance_from_id($artefactid);
        }
        catch (ArtefactNotFoundException $e) {
            return $matches[5];
        }
746

747
748
        $artefacttype = $artefact->get('artefacttype');
        switch ($artefacttype) {
749
        case 'blog':
750
751
        case 'plan':
            $dir = $artefacttype == 'plan' ? 'plans' : $artefacttype;
752
753
            $offset = ($matches[4]) ? intval(substr($matches[4], strlen('&amp;offset='))) : 0;
            $offset = ($offset == 0) ? 'index' : $offset;
754
            return '<a href="' . $this->basepath . "/files/$dir/" . PluginExportHtml::text_to_URLpath(PluginExportHtml::text_to_filename($artefact->get('title'))) . '/' . $offset . '.html">' . $matches[5] . '</a>';
755
        case 'file':
756
        case 'folder':
757
        case 'image':
758
        case 'profileicon':
759
        case 'archive':
760
761
        case 'video':
        case 'audio':
762
            return '<a href="' . $this->get_export_path_for_file($artefact, array()) . '">' . $matches[5] . '</a>';
763
764
765
766
767
768
769
770
771
772
773
        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];
774
775
776
777
778
779
        try {
            $artefact = artefact_instance_from_id($artefactid);
        }
        catch (ArtefactNotFoundException $e) {
            return '';
        }
780
781
782
783
784
785
786

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

787
        $options = array();
788
789
790
        for ($i = 3; $i < count($matches); $i++) {
            list($key, $value) = explode('=', $matches[$i]);
            $options[$key] = $value;
791
792
        }

793
        return $this->get_export_path_for_file($artefact, $options);
794
795
796
    }

    /**
797
798
799
800
801
802
803
     * 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];

804
805
            $parts = preg_split('/(&amp;|&|%26)/', $matches[3]);
            array_shift($parts);
806
807
808
809
810
811
812
813
814
815
816
817
818
            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']))) {
819
820
821
                    // 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)) {
822
                        $to = '/static/profileicons/0-' . $prefix . 'no_userphoto.png';
823
824
825
                        $this->htmlexportcopyproxy->add($from, $to);
                    }
                    return $this->basepath . $to;
826
827
                }
            case 'profileiconbyid':
828
829
830
831
832
833
                try {
                    $icon = artefact_instance_from_id($options['id']);
                }
                catch (ArtefactNotFoundException $e) {
                    return '';
                }
834
835
836
837
838
839
840
841
842
843
844
845
                if ($icon->get_plugin_name() != 'file') {
                    return '';
                }
                return $this->get_export_path_for_file($icon, $options, '/static/profileicons/');
            default:
                return '';
            }
        }

        return '';
    }

846
847
848
849
    /**
     * Callback
     */
    private function replace_theme_image_link($matches) {
850
        $file = $matches[2] . 'theme/' . $matches[3] . '/static/images/' . $matches[4];
851
852
853
854
855
856
857
        $this->htmlexportcopyproxy->add(
            get_config('docroot') . $file,
            '/static/' . $file
        );
        return $this->basepath . '/static/' . $file;
    }

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

879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
    /**
     * 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
     */
896
897
898
899
900
901
902
903
904
905
    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/';
            }
        }

906
907
        unset($options['view']);
        $prefix = '';
908
909
        $title = PluginExportHtml::sanitise_path($file->get('title'));

910
        if ($options) {
911
            list($size, $prefix) = $this->get_size_from_options($options);
912
913
            $from = $file->get_path($size);

914
            $to = $basefolder . $file->get('id') . '-' . $prefix . $title;
915
916
917
            $this->htmlexportcopyproxy->add($from, $to);
        }
        else {
918
919
920
921
            if ($basefolder == '/files/extra/') {
                $title = $file->get('id') . '-' . $title;
            }
            $to = $basefolder . $title;
922
923
924
925
926
        }

        return $this->basepath . $to;
    }

927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
    /**
     * 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);
    }

945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
}

/**
 * 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;
    }
973
}