lib.php 20.1 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
<?php
/**
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
 * Copyright (C) 2006-2008 Catalyst IT Ltd (http://www.catalyst.net.nz)
 *
 * 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
 * @copyright  (C) 2006-2008 Catalyst IT Ltd http://catalyst.net.nz
 *
 */

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;

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

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

58
59
60
61
    /**
    * constructor.  overrides the parent class
    * to set up smarty and the attachment directory
    */
62
63
    public function __construct(User $user, $views, $artefacts, $progresscallback=null) {
        parent::__construct($user, $views, $artefacts, $progresscallback);
64
        $this->rootdir = 'portfolio-for-' . self::text_to_path($user->get('username'));
65
66

        // Create basic required directories
67
        foreach (array('files', 'views', 'static', 'static/smilies') as $directory) {
68
69
70
71
72
73
            $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'
74
            . $this->get('user')->get('id') . '-' . $this->exporttime . '.zip';
75
76
77
78
79
80
81

        // Find what stylesheets need to be included
        $themedirs = theme_get_path('', 'export/html/', true);
        $stylesheets = array('style.css', 'print.css');
        foreach ($themedirs as $theme => $themedir) {
            foreach ($stylesheets as $stylesheet) {
                if (is_readable($themedir . 'style/' . $stylesheet)) {
82
                    array_unshift($this->stylesheets[''], 'theme/' . $theme . '/static/style/' . $stylesheet);
83
84
85
86
                }
            }
        }

87
        $this->notify_progress_callback(15, 'Setup complete');
88
89
    }

90
91
92
93
94
95
96
97
    public static function get_title() {
        return get_string('title', 'export.html');
    }

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

98
    /**
Nigel McNie's avatar
Nigel McNie committed
99
100
     * Main export routine
     */
101
    public function export() {
102
103
        raise_memory_limit('128M');

104
        $summaries = array();
105
        $plugins = plugins_installed('artefact', true);
106
        $exportplugins = array();
107
        $progressstart = 15;
108
        $progressend   = 25;
109
        $plugincount   = count($plugins);
110
111
112

        // First pass: find out which plugins are exporting like us, and ask 
        // them about the static data they want to include in every template
113
114
        $i = 0;
        foreach ($plugins as $plugin) {
115
            $plugin = $plugin->name;
116
            $this->notify_progress_callback(intval($progressstart + (++$i / $plugincount) * ($progressend - $progressstart)), 'Preparing ' . $plugin);
117

118
            if (safe_require('export', 'html/' . $plugin, 'lib.php', 'require_once', true)) {
119
120
                $exportplugins[] = $plugin;

121
122
123
124
125
126
127
                $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);

128
                // Find out whether the plugin has static data for us
129
                $themestaticdirs = array_reverse(theme_get_path('', 'artefact/' . $plugin . '/export/html/', true));
130
131
132
133
134
                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)) {
135
                            $this->stylesheets[$plugin][] = str_replace('export/html/', '', $staticdir) . 'style/' . $stylesheet;
136
137
                        }
                    }
138
                }
139
140
141
            }
        }

142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
        // Second pass: actually dump data for active export plugins
        $progressstart = 25;
        $progressend   = 60;
        $i = 0;
        foreach ($exportplugins as $plugin) {
            $this->notify_progress_callback(intval($progressstart + (++$i / $plugincount) * ($progressend - $progressstart)), 'Exporting data for ' . $plugin);
            $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
            if (!($this->viewexportmode == PluginExport::EXPORT_LIST_OF_VIEWS && $this->artefactexportmode == PluginExport::EXPORT_ARTEFACTS_FOR_VIEWS)) {
                $summaries[$plugin] = array($artefactexporter->get_summary_weight(), $artefactexporter->get_summary());
            }
        }

Nigel McNie's avatar
Nigel McNie committed
157
        // Get the view data
158
        $this->notify_progress_callback(65, 'Exporting Views');
Nigel McNie's avatar
Nigel McNie committed
159
160
161
        $this->dump_view_export_data();
        $summaries['view'] = array(100, $this->get_view_summary());

162
        // Sort by weight (then drop the weight information)
163
        $this->notify_progress_callback(75, 'Building index page');
164
165
166
167
168
        uasort($summaries, create_function('$a, $b', 'return $a[0] > $b[0];'));
        foreach ($summaries as &$summary) {
            $summary = $summary[1];
        }

Nigel McNie's avatar
Nigel McNie committed
169
        // Build index.html
170
        $this->build_index_page($summaries);
171
172

        // Copy all static files into the export
173
        $this->notify_progress_callback(80, 'Copying static files');
174
        $this->copy_static_files();
175
176
177
        

        // zip everything up
178
        $this->notify_progress_callback(90, 'Creating zipfile');
179
180
181
182
183
184
185
186
187
188
189
190
191
192
        $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');
        }
193
        $this->notify_progress_callback(100, 'Done');
194
195
196
197
198
199
200
201
        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
    }

202
203
204
205
206
207
208
    public function get_smarty($rootpath='', $section='') {
        if ($section && isset($this->stylesheets[$section])) {
            $stylesheets = array_merge($this->stylesheets[''], $this->stylesheets[$section]);
        }
        else {
            $stylesheets = $this->stylesheets[''];
        }
209
210
211
        $smarty = smarty_core();
        $smarty->assign('user', $this->get('user'));
        $smarty->assign('rootpath', $rootpath);
212
        $smarty->assign('export_time', $this->exporttime);
213
        $smarty->assign('sitename', get_config('sitename'));
214
        $smarty->assign('stylesheets', $stylesheets);
215
        $smarty->assign('maharalogo', $rootpath . $this->theme_path('images/logo.png'));
216
217
218
219

        return $smarty;
    }

220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
    /**
     * 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) {
        $themestaticdirs = theme_get_path('', 'export/html/', true);
        foreach ($themestaticdirs as $theme => $dir) {
            if (is_readable($dir . $path)) {
                return 'static/theme/' . $theme . '/static/' . $path;
            }
        }
    }

235
    /**
236
     * Converts the passed text into a a form that could be used in a URL.
237
238
239
240
241
     *
     * @param string $text The text to convert
     * @return string      The converted text
     */
    public static function text_to_path($text) {
242
        return substr(preg_replace('#[^a-zA-Z0-9_-]+#', '-', $text), 0, 255);
243
244
    }

245
246
247
248
249
250
251
252
253
254
255
    /**
     * 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) {
        return substr(str_replace('/', '_', $path), 0, 255);
    }


256
257
    private function build_index_page($summaries) {
        $smarty = $this->get_smarty();
258
        $smarty->assign('page_heading', full_name($this->get('user')));
259
260
        $smarty->assign('summaries', $summaries);
        $content = $smarty->fetch('export:html:index.tpl');
261
262
263
        if (!file_put_contents($this->exportdir . '/' . $this->rootdir . '/index.html', $content)) {
            throw new SystemException("Could not create index.html for the export");
        }
264
265
    }

Nigel McNie's avatar
Nigel McNie committed
266
267
268
269
    /**
     * Dumps all views into the HTML export
     */
    private function dump_view_export_data() {
270
271
        $smarty = $this->get_smarty('../../');
        foreach ($this->views as $viewid => $view) {
272
            $smarty->assign('page_heading', $view->get('title'));
273
274
275
276
            $smarty->assign('breadcrumbs', array(
                array('text' => get_string('Views', 'view')),
                array('text' => $view->get('title'), 'path' => 'index.html'),
            ));
277
            $smarty->assign('viewdescription', $view->get('description'));
278
279
280
281
282

            $directory = $this->exportdir . '/' . $this->rootdir . '/views/' . self::text_to_path($view->get('title'));
            if (!check_dir_exists($directory)) {
                throw new SystemException("Could not create directory for view $viewid");
            }
Nigel McNie's avatar
Nigel McNie committed
283

284
285
286
287
288
            $outputfilter = new HtmlExportOutputFilter('../../');
            $smarty->assign('view', $outputfilter->filter($view->build_columns()));
            $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
289
290
291
292
293
294
295
296
297
298
299
300
            }
        }
    }

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

        $views = array();
        foreach ($this->views as $view) {
            if ($view->get('type') != 'profile') {
                $views[] = array(
                    'title' => $view->get('title'),
301
                    'folder' => self::text_to_path($view->get('title')),
Nigel McNie's avatar
Nigel McNie committed
302
303
304
305
                );
            }
        }
        $smarty->assign('views', $views);
306
307
308
309
310
311
312
313
314
315

        if ($views) {
            $stryouhaveviews = (count($views) == 1)
                ? get_string('youhaveoneview', 'view')
                : get_string('youhaveviews', 'view', count($views));
        }
        else {
            $stryouhaveviews = get_string('youhavenoviews', 'view');
        }
        $smarty->assign('stryouhaveviews', $stryouhaveviews);
Nigel McNie's avatar
Nigel McNie committed
316
317

        return array(
318
            'title' => get_string('Views', 'view'),
Nigel McNie's avatar
Nigel McNie committed
319
320
321
322
            'description' => $smarty->fetch('export:html:viewsummary.tpl'),
        );
    }

323
324
325
326
327
    /**
     * Copies the static files (stylesheets etc.) into the export
     */
    private function copy_static_files() {
        $staticdir = $this->get('exportdir') . '/' . $this->get('rootdir') . '/static/';
328
329
330
331
332
333
334
335
336
337
338
339
340
341
        $directoriestocopy = array();

        // Get static directories from each theme for HTML export
        $themestaticdirs = theme_get_path('', 'export/html/', true);
        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
        $directoriestocopy[get_config('docroot') . 'js/tinymce/plugins/emotions/images'] = $staticdir . 'smilies/';
342

343
344
345
        $filestocopy = array(
            get_config('docroot') . 'theme/views.css' => $staticdir . 'views.css',
        );
346

347
        foreach ($this->pluginstaticdirs as $dir) {
348
349
350
            $destinationdir = str_replace('export/html/', '', $dir);
            if (!check_dir_exists($staticdir . $destinationdir)) {
                throw new SystemException("Could not create static directory $destinationdir");
351
            }
352
            $directoriestocopy[get_config('docroot') . 'artefact/' . $dir] = $staticdir . $destinationdir;
353
354
        }

355
        foreach ($directoriestocopy as $from => $to) {
356
357
            if (!copyr($from, $to)) {
                throw new SystemException("Could not copy $from to $to");
358
359
            }
        }
360
361
362
363
364
365

        foreach ($filestocopy as $from => $to) {
            if (!copy($from, $to)) {
                throw new SystemException("Could not copy static file $from");
            }
        }
366
367
    }

368
369
370
371
372
373
374
375
376
377
378
379
380
}

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
381
            throw new SystemException("Could not create the temporary export directory $this->fileroot");
382
383
384
385
386
387
388
389
390
391
392
        }
    }

    abstract public function dump_export_data();

    abstract public function get_summary();

    abstract public function get_summary_weight();

}

393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
/**
 * 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();

    /**
     * A cache of folder data. See get_path_for_file()
     */
    private $folderdata = null;

    /**
     * @param string $basepath The relative path to the root of the generated export
     */
    public function __construct($basepath) {
        $this->basepath = preg_replace('#/$#', '', $basepath);
    }

    /**
     * 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
                '#<img src="(' . $wwwroot . ')?/?js/tinymce/plugins/emotions/images/([^"]+)"([^>]+)>#',
438
439
                // No forms
                '#<form[^>]*>.*?</form>#si',
440
441
                // Gratuitous hack for the RSS blocktype
                '#<div id="blocktype_externalfeed_lastupdate">[^<]*</div>#',
442
443
444
445
            ),
            array(
                '',
                '<img src="' . $this->basepath . '/static/smilies/$2"$3>',
446
                '',
447
                '',
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
            ),
            $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(
            '#<a[^>]+href="(' . preg_quote(get_config('wwwroot')) . ')?/?view/artefact\.php\?artefact=(\d+)(&amp;view=\d+)?(&amp;page=\d+)?"[^>]*>([^<]*)</a>#',
            array($this, 'replace_artefact_link'),
            $html
        );

        // Links to download files
        $html = preg_replace_callback(
            '#(' . preg_quote(get_config('wwwroot')) . ')?/?artefact/file/download\.php\?file=(\d+)(&amp;view=\d+)?#',
            array($this, 'replace_download_link'),
            $html
        );

        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];
        if (!isset($this->viewtitles[$viewid])) {
            $this->viewtitles[$viewid] = PluginExportHtml::text_to_path(get_field('view', 'title', 'id', $viewid));
        }
        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];
        $artefact = artefact_instance_from_id($artefactid);

        switch ($artefact->get('artefacttype')) {
        case 'blog':
            $page = ($matches[4]) ? intval(substr($matches[4], strlen('&amp;page='))) : 1;
            $page = ($page == 1) ? 'index' : $page;
            return '<a href="' . $this->basepath . '/files/blog/' . PluginExportHtml::text_to_path($artefact->get('title')) . '/' . $page . '.html">' . $matches[5] . '</a>';
        case 'file':
        case 'image':
            $folderpath = $this->get_path_for_file($artefact);
504
            return '<a href="' . $this->basepath . '/files/file/' . $folderpath . PluginExportHtml::sanitise_path($artefact->get('title')) . '">' . $matches[5] . '</a>';
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
        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];
        $artefact = artefact_instance_from_id($artefactid);

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

        $folderpath = $this->get_path_for_file($artefact);
        return $this->basepath . '/files/file/' . $folderpath . $artefact->get('title');
    }

    /**
     * Given a file, returns the folder path in the HTML export for it
     *
     * TODO: slash escaping in file/folder names
     *
     * @param ArtefactTypeFileBase $file The file to get the folder path for
     * @return string
     */
    private function get_path_for_file(ArtefactTypeFileBase $file) {
        if ($this->folderdata === null) {
            $this->folderdata = get_records_select_assoc('artefact', "artefacttype = 'folder' AND owner = ?", array($file->get('owner')));
539
540
541
            foreach ($this->folderdata as &$folder) {
                $folder->title = PluginExportHtml::sanitise_path($folder->title);
            }
542
543
544
545
546
547
548
        }
        $folderpath = ArtefactTypeFileBase::get_full_path($file->get('parent'), $this->folderdata);
        return $folderpath;
    }

}

549
?>