lib.php 34.9 KB
Newer Older
1
2
<?php
/**
Francois Marier's avatar
Francois Marier committed
3
4
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
 * Copyright (C) 2006-2007 Catalyst IT Ltd (http://www.catalyst.net.nz)
5
 *
Francois Marier's avatar
Francois Marier committed
6
7
8
9
 * 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.
10
 *
Francois Marier's avatar
Francois Marier committed
11
12
13
14
 * 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.
15
 *
Francois Marier's avatar
Francois Marier committed
16
17
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18
19
20
21
22
23
24
25
26
27
28
 *
 * @package    mahara
 * @subpackage artefact-internal
 * @author     Penny Leach <penny@catalyst.net.nz>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
 * @copyright  (C) 2006,2007 Catalyst IT Ltd http://catalyst.net.nz
 *
 */

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

29
30
31
class PluginArtefactFile extends PluginArtefact {

    public static function get_artefact_types() {
32
33
34
35
36
        return array(
            'file',
            'folder',
            'image',
        );
37
    }
38
39
    
    public static function get_block_types() {
40
        return array('image');
41
    }
42
43
44
45
46
47

    public static function get_plugin_name() {
        return 'file';
    }

    public static function menu_items() {
Richard Mansfield's avatar
Richard Mansfield committed
48
49
        return array(
            array(
50
51
                'path' => 'myportfolio/files',
                'url' => 'artefact/file/',
52
                'title' => get_string('myfiles', 'artefact.file'),
53
54
                'weight' => 20,
            ),
Richard Mansfield's avatar
Richard Mansfield committed
55
        );
56
    }
57
58
59
60
61
62
63
64
65
66
67
68
69

    public static function get_event_subscriptions() {
        $subscriptions = array(
            (object)array(
                'plugin'       => 'file',
                'event'        => 'createuser',
                'callfunction' => 'newuser',
            ),
        );

        return $subscriptions;
    }

70
71
    public static function postinst() {
        set_config_plugin('artefact', 'file', 'defaultquota', 10485760);
72
        self::resync_filetype_list();
73
74
    }

75
    public static function newuser($event, $user) {
76
        update_record('usr', array('quota' => get_config_plugin('artefact', 'file', 'defaultquota')), array('id' => $user['id']));
77
    }
78
    
Richard Mansfield's avatar
Richard Mansfield committed
79

80
81
82
83
84
85
86
87
88
    public static function sort_child_data($a, $b) {
        if ($a->container && !$b->container) {
            return -1;
        }
        else if (!$a->container && $b->container) {
            return 1;
        }
        return strnatcasecmp($a->text, $b->text);
    }
Richard Mansfield's avatar
Richard Mansfield committed
89

Martyn Smith's avatar
Martyn Smith committed
90
91
92
93
94
95
96
97
98
99
100
    public static function themepaths($type) {
        static $themepaths = array(
            'file' => array(
                'images/file.gif',
                'images/folder.gif',
                'images/image.gif',
            ),
        );
        return $themepaths[$type];
    }

101
102
    public static function jsstrings($type) {
        static $jsstrings = array(
103
            'file' => array(
104
105
106
107
                'mahara' => array(
                    'cancel',
                    'delete',
                    'edit',
108
                    'tags',
109
110
                ),
                'artefact.file' => array(
111
                    'copyrightnotice',
112
113
114
115
                    'create',
                    'createfolder',
                    'deletefile?',
                    'deletefolder?',
116
                    'Description',
117
118
119
                    'destination',
                    'editfile',
                    'editfolder',
120
                    'File',
121
                    'fileexistsoverwritecancel',
122
                    'filenamefieldisrequired',
123
                    'home',
124
                    'Name',
125
126
127
128
                    'namefieldisrequired',
                    'nofilesfound',
                    'overwrite',
                    'savechanges',
129
130
                    'title',
                    'titlefieldisrequired',
131
                    'unlinkthisfilefromblogposts?',
132
133
134
135
136
                    'upload',
                    'uploadfile',
                    'uploadfileexistsoverwritecancel',
                    'uploadingfiletofolder',
                    'youmustagreetothecopyrightnotice',
137
                ),
138
            ),
139
140
141
        );
        return $jsstrings[$type];
    }
142

143
144
145
146
147
148
149
    public static function jshelp($type) {
        static $jshelp = array(
            'file' => array(
                'artefact.file' => array(
                    'notice',
                    'quota_message',
                    'uploadfile',
150
                    'tags',
151
152
153
154
155
156
                ),
            ),
        );
        return $jshelp[$type];
    }

157
158
159
160
161
162
163
164
165
166
167
168

    /**
     * Resyncs the allowed filetypes list with the XML configuration file.
     *
     * This can be called on install (and is, in the postinst method above),
     * and every time an upgrade is made that changes the file.
     */
    function resync_filetype_list() {
        require_once('xmlize.php');
        db_begin();
        log_info('Beginning resync of filetype list');

169
        $currentlist = get_column('artefact_file_file_types', 'description');
170
171
172
173
174
175
176
177
178
179
180
181
182
183
        $newlist     = xmlize(file_get_contents(get_config('docroot') . 'artefact/file/filetypes.xml'));
        $filetypes = $newlist['filetypes']['#']['filetype'];
        $newfiletypes = array();

        // Step one: if a filetype is in the new list that is not in the current
        // list, add it to the current list.
        foreach ($filetypes as $filetype) {
            $type = $filetype['#']['description'][0]['#'];
            if (!in_array($type, $currentlist)) {
                log_debug('Adding filetype: ' . $type);
                $currentlist[] = $type;
                $record = new StdClass;
                $record->description = $type;
                $record->enabled     = $filetype['#']['enabled'][0]['#'];
184
                insert_record('artefact_file_file_types', $record);
185
186
187
188
189
190
191
192
193
194
            }
            $newfiletypes[] = $type;
        }

        // Step two: If a filetype is in the current list that is not in the
        // new list, remove it from the current list.
        foreach ($currentlist as $key => $type) {
            if (!in_array($type, $newfiletypes)) {
                log_debug('Removing filetype: ' . $type);
                unset($currentlist[$key]);
195
196
                delete_records('artefact_file_mime_types', 'description', $type);
                delete_records('artefact_file_file_types', 'description', $type);
197
198
199
200
201
202
            }
        }


        // Get a list of all current mimetypes for each file type
        $currentmimetypes = array();
203
        $dbmimetypes = get_records_array('artefact_file_mime_types');
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
        if ($dbmimetypes) {
            foreach ($dbmimetypes as $mimetype) {
                $currentmimetypes[$mimetype->description][] = $mimetype->mimetype;
            }
        }
        unset($dbmimetypes);

        // Step three: For each filetype in the current list, update the mime
        // types allowed for it if necessary
        foreach ($currentlist as $description) {
            // Get the new mime types
            $newmimetypes = array();
            foreach ($filetypes as $filetype) {
                if ($filetype['#']['description'][0]['#'] == $description) {
                    foreach ($filetype['#']['mimetypes'][0]['#']['mimetype'] as $mimetype) {
                        $newmimetypes[] = $mimetype['#'];
                    }
                }
            }

            // Roll up roll up to see the famous array_equals implementation!
            // You'd think PHP would have a way to do this, but I couldn't find
            // it...
            sort($newmimetypes);
            if (isset($currentmimetypes[$description])) {
                sort($currentmimetypes[$description]);
            }

            if ((!isset($currentmimetypes[$description]) && $newmimetypes)
                || ((join('', $currentmimetypes[$description]) != join('', $newmimetypes)))) {
                log_debug('Need to update mime types for ' . $description);
235
                delete_records('artefact_file_mime_types', 'description', $description);
236
237
238
239
                foreach ($newmimetypes as $newmimetype) {
                    $record = new StdClass;
                    $record->mimetype    = $newmimetype;
                    $record->description = $description;
240
                    insert_record('artefact_file_mime_types', $record);
241
242
243
244
245
246
247
248
                }
            }
        }
       
        db_commit();
        //db_rollback();
    }

249
250
}

Martyn Smith's avatar
Martyn Smith committed
251
abstract class ArtefactTypeFileBase extends ArtefactType {
252

253
    protected $adminfiles = 0;
Richard Mansfield's avatar
Richard Mansfield committed
254
    protected $size;
255
256
257
258
259
    // The original filename extension (when the file is first
    // uploaded) is saved here.  This is used as a workaround for IE's
    // detecting filetypes by extension: when the file is downloaded,
    // the extension can be appended to the name if it's not there
    // already.
260
    protected $oldextension;
Richard Mansfield's avatar
Richard Mansfield committed
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278

    public function __construct($id = 0, $data = null) {
        parent::__construct($id, $data);
        
        if (empty($this->id)) {
            $this->locked = 0;
        }

        if ($this->id && ($filedata = get_record('artefact_file_files', 'artefact', $this->id))) {
            foreach($filedata as $name => $value) {
                if (property_exists($this, $name)) {
                    $this->set($name, $value);
                }
            }
        }

    }

279
280
281
282
283
    public function render_self($options) {
        $options['id'] = $this->get('id');

        $downloadpath = get_config('wwwroot') . 'artefact/file/download.php?file=' . $this->get('id');
        if (isset($options['viewid'])) {
284
            $downloadpath .= '&view=' . $options['viewid'];
285
        }
286
287
288
289
290
        $filetype = get_string($this->get('oldextension'), 'artefact.file');
        if (substr($filetype, 0, 2) == '[[') {
            $filetype = $this->get('oldextension') . ' ' . get_string('file', 'artefact.file');
        }

291
292
293
        $smarty = smarty_core();
        $smarty->assign('iconpath', $this->get_icon($options));
        $smarty->assign('downloadpath', $downloadpath);
294
        $smarty->assign('filetype', $filetype);
295
296
297
298
299
300
301
302
303
304
305
306
        $smarty->assign('owner', display_name($this->get('owner')));
        $smarty->assign('created', strftime(get_string('strftimedaydatetime'), $this->get('ctime')));
        $smarty->assign('modified', strftime(get_string('strftimedaydatetime'), $this->get('mtime')));
        $smarty->assign('size', $this->describe_size() . ' (' . $this->get('size') . ' ' . get_string('bytes', 'artefact.file') . ')');

        foreach (array('title', 'description', 'artefacttype') as $field) {
            $smarty->assign($field, $this->get($field));
        }

        return array('html' => $smarty->fetch('artefact:file:file_render_self.tpl'), 'javascript' => '');
    }

Richard Mansfield's avatar
Richard Mansfield committed
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
    /**
     * This function updates or inserts the artefact.  This involves putting
     * some data in the artefact table (handled by parent::commit()), and then
     * some data in the artefact_file_files table.
     */
    public function commit() {
        // Just forget the whole thing when we're clean.
        if (empty($this->dirty)) {
            return;
        }
      
        // We need to keep track of newness before and after.
        $new = empty($this->id);

        $this->mtime = time();

        // Commit to the artefact table.
        parent::commit();

        // Reset dirtyness for the time being.
        $this->dirty = true;

        $data = (object)array(
            'artefact'      => $this->get('id'),
            'size'          => $this->get('size'),
332
333
            'adminfiles'    => $this->get('adminfiles'),
            'oldextension'  => $this->get('oldextension')
Richard Mansfield's avatar
Richard Mansfield committed
334
335
336
337
338
339
340
341
342
343
344
345
        );

        if ($new) {
            insert_record('artefact_file_files', $data);
        }
        else {
            update_record('artefact_file_files', $data, 'artefact');
        }

        $this->dirty = false;
    }

Nigel McNie's avatar
Nigel McNie committed
346
    public static function is_singular() {
Penny Leach's avatar
Penny Leach committed
347
348
349
        return false;
    }

350
    public static function get_icon($options=null) {
351
352
353
354
355
356
357

    }

    public static function collapse_config() {
        return 'file';
    }

Richard Mansfield's avatar
Richard Mansfield committed
358
359
360
361
362
363
    public function move($newparentid) {
        $this->set('parent', $newparentid);
        $this->commit();
        return true;
    }

364
365
    public function delete() {
        if (empty($this->id)) {
Richard Mansfield's avatar
Richard Mansfield committed
366
            return; 
367
        }
368
369
370
371
        try {
            delete_records('artefact_blog_blogpost_file', 'file', $this->id);
        } 
        catch ( Exception $e ) {}
372
373
374
375
        delete_records('artefact_file_files', 'artefact', $this->id);
        parent::delete();
    }

Richard Mansfield's avatar
Richard Mansfield committed
376
377
378
    // Check if something exists in the db with a given title and parent,
    // either in adminfiles or with a specific owner.
    public static function file_exists($title, $owner, $folder, $adminfiles=false) {
379
        $filetypesql = "('" . join("','", PluginArtefactFile::get_artefact_types()) . "')";
380
381
        return get_field_sql('SELECT a.id FROM {artefact} a
            LEFT OUTER JOIN {artefact_file_files} f ON f.artefact = a.id
Richard Mansfield's avatar
Richard Mansfield committed
382
383
384
385
            WHERE ' . ($adminfiles ? 'f.adminfiles = 1' : 'f.adminfiles <> 1 AND a.owner = ' . $owner) . '
            AND a.title = ?
            AND a.parent ' . (empty($folder) ? ' IS NULL' : ' = ' . $folder) . '
            AND a.artefacttype IN ' . $filetypesql, array($title));
386
387
    }

388
389
390
391
392
393
394
395

    // Sort folders before files; then use nat sort order.
    public static function my_files_cmp($a, $b) {
        return strnatcasecmp((int)($a->artefacttype != 'folder') . $a->title,
                             (int)($b->artefacttype != 'folder') . $b->title);
    }


Richard Mansfield's avatar
Richard Mansfield committed
396
    public static function get_my_files_data($parentfolderid, $userid, $adminfiles=false) {
397

398
399
400
401
        $foldersql = $parentfolderid ? ' = ' . $parentfolderid : ' IS NULL';

        // if blogs are installed then also return the number of blog
        // posts each file is attached to
402
        $bloginstalled = !$adminfiles && get_field('artefact_installed', 'active', 'name', 'blog');
403

404
        $filetypesql = "('" . join("','", PluginArtefactFile::get_artefact_types()) . "')";
Richard Mansfield's avatar
Richard Mansfield committed
405
406
        $filedata = get_records_sql_array('
            SELECT
407
                a.id, a.artefacttype, a.mtime, f.size, a.title, a.description,
Penny Leach's avatar
Penny Leach committed
408
409
                COUNT(c.id) AS childcount ' 
                . ($bloginstalled ? ', COUNT (b.blogpost) AS attachcount' : '') . '
410
411
412
413
414
            FROM {artefact} a
                LEFT OUTER JOIN {artefact_file_files} f ON f.artefact = a.id
                LEFT OUTER JOIN {artefact} c ON c.parent = a.id '
                . ($bloginstalled ? ('LEFT OUTER JOIN
                                     {artefact_blog_blogpost_file} b ON b.file = a.id') : '') . '
415
            WHERE a.parent' . $foldersql . '
Richard Mansfield's avatar
Richard Mansfield committed
416
                AND ' . ($adminfiles ? 'f.adminfiles = 1' : ('f.adminfiles = 0 AND a.owner = ' . $userid)) . '
417
418
419
                AND a.artefacttype IN ' . $filetypesql . '
            GROUP BY
                1, 2, 3, 4, 5, 6;', '');
420
421
422
423
424
425

        if (!$filedata) {
            $filedata = array();
        }
        else {
            foreach ($filedata as $item) {
Richard Mansfield's avatar
Richard Mansfield committed
426
                $item->mtime = format_date(strtotime($item->mtime), 'strfdaymonthyearshort');
427
428
429
430
                $item->tags = get_column('artefact_tag', 'tag', 'artefact', $item->id);
                if (!is_array($item->tags)) {
                    $item->tags = array();
                }
431
432
433
            }
        }

Richard Mansfield's avatar
Richard Mansfield committed
434
435
436
437
438
439
440
441
442
443
444
445
        // Add parent folder to the list
        if (!empty($parentfolderid)) {
            $grandparentid = get_field('artefact', 'parent', 'id', $parentfolderid);
            $filedata[] = (object) array(
                'title'        => '..',
                'artefacttype' => 'folder',
                'description'  => get_string('parentfolder', 'artefact.file'),
                'isparent'     => true,
                'id'           => (int) $grandparentid
            );
        }

446
        usort($filedata, array("ArtefactTypeFileBase", "my_files_cmp"));
447
448
        return $filedata;
    }
449
450
}

451
class ArtefactTypeFile extends ArtefactTypeFileBase {
452

453
454
455
    public function __construct($id = 0, $data = null) {
        parent::__construct($id, $data);
        
Richard Mansfield's avatar
Richard Mansfield committed
456
457
        if (empty($this->id)) {
            $this->container = 0;
458
        }
459

460
461
    }

462
    public static function get_file_directory($id) {
463
        return "artefact/file/originals/" . ($id % 256);
464
465
    }

466
467
    public function get_path() {
        return get_config('dataroot') . self::get_file_directory($this->id) . '/' .  $this->id;
468
469
    }

470
471
472
473
474
475
476
477
    public static function detect_artefact_type($file) {
        require_once('file.php');
        if (ArtefactTypeImage::is_image_mime_type(get_mime_type(get_config('dataroot') . $file))) {
            return 'image';
        }
        return 'file';
    }

478
479
480
481
    /**
     * Test file type and return a new Image or File.
     */
    public static function new_file($path, $data) {
Richard Mansfield's avatar
Richard Mansfield committed
482
483
        require_once('file.php');
        $type = get_mime_type($path);
484
        if (ArtefactTypeImage::is_image_mime_type($type)) {
485
            list($data->width, $data->height) = getimagesize($path);
486
487
488
489
490
            return new ArtefactTypeImage(0, $data);
        }
        return new ArtefactTypeFile(0, $data);
    }

491
492
493
494
495
    /**
     * Moves a file into the myfiles area.
     * Takes the name of a file outside the myfiles area.
     * Returns a boolean indicating success or failure.
     */
Richard Mansfield's avatar
Richard Mansfield committed
496
    public static function save_file($pathname, $data) {
497
498
499
        // This is only used when blog posts are saved: Files which
        // have been uploaded to the post are moved to a permanent
        // location in the files area using this function. 
500
501
502
503
504
        $dataroot = get_config('dataroot');
        $pathname = $dataroot . $pathname;
        if (!$size = filesize($pathname)) {
            return false;
        }
505
        $f = self::new_file($pathname, $data);
Richard Mansfield's avatar
Richard Mansfield committed
506
507
508
509
510
        $f->set('size', $size);
        $f->commit();
        $id = $f->get('id');

        $newdir = $dataroot . self::get_file_directory($id);
511
        check_dir_exists($newdir);
Richard Mansfield's avatar
Richard Mansfield committed
512
        $newname = $newdir . '/' . $id;
513
        if (!rename($pathname, $newname)) {
Richard Mansfield's avatar
Richard Mansfield committed
514
            $f->delete();
515
            return false;
516
        }
517
518
        global $USER;
        $USER->quota_add($size);
519
        $USER->commit();
Richard Mansfield's avatar
Richard Mansfield committed
520
        return $id;
521
    }
Richard Mansfield's avatar
Richard Mansfield committed
522

523
    /**
Richard Mansfield's avatar
Richard Mansfield committed
524
525
     * Processes a newly uploaded file, copies it to disk, and creates
     * a new artefact object.
526
527
528
529
530
531
532
533
534
     * Takes the name of a file input.
     * Returns false for no errors, or a string describing the error.
     */
    public static function save_uploaded_file($inputname, $data) {
        require_once('uploadmanager.php');
        $um = new upload_manager($inputname);
        if ($error = $um->preprocess_file()) {
            return $error;
        }
Richard Mansfield's avatar
Richard Mansfield committed
535
        $size = $um->file['size'];
536
        global $USER;
Richard Mansfield's avatar
Richard Mansfield committed
537
538
539
540
        if (!$USER->quota_allowed($size) && !$data->adminfiles) {
            return get_string('uploadexceedsquota');
        }
        $f = self::new_file($um->file['tmp_name'], $data);
541
        $f->set('owner', $USER->id);
Richard Mansfield's avatar
Richard Mansfield committed
542
        $f->set('size', $size);
543
        $f->set('oldextension', $um->original_filename_extension());
544
545
546
547
548
549
550
        $f->commit();
        $id = $f->get('id');
        // Save the file using its id as the filename, and use its id modulo
        // the number of subdirectories as the directory name.
        if ($error = $um->save_file(self::get_file_directory($id) , $id)) {
            $f->delete();
        }
Richard Mansfield's avatar
Richard Mansfield committed
551
552
        else {
            $USER->quota_add($size);
553
            $USER->commit();
Richard Mansfield's avatar
Richard Mansfield committed
554
        }
555
556
        return $error;
    }
Richard Mansfield's avatar
Richard Mansfield committed
557

558

559
560
561
562
563
564
565
566
567
568
569
    // Return the title with the original extension appended to it if
    // it's not already there.
    public function download_title() {
        $extn = $this->get('oldextension');
        $name = $this->get('title');
        if (substr($name, -1-strlen($extn)) == '.' . $extn) {
            return $name;
        }
        return $name . (substr($name, -1) == '.' ? '' : '.') . $extn;
    }

570

571
    public static function get_admin_files($public) {
572
        $pubfolder = ArtefactTypeFolder::admin_public_folder_id();
573
        $artefacts = get_records_sql_assoc('
574
            SELECT
575
                a.id, a.title, a.parent, a.artefacttype
576
577
            FROM {artefact} a
                INNER JOIN {artefact_file_files} f ON f.artefact = a.id
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
            WHERE f.adminfiles = 1', array());

        $files = array();
        if (!empty($artefacts)) {
            foreach ($artefacts as $a) {
                if ($a->artefacttype != 'folder') {
                    $title = $a->title;
                    $parent = $a->parent;
                    while (!empty($parent)) {
                        if ($public && $parent == $pubfolder) {
                            $files[] = array('name' => $title, 'id' => $a->id);
                            continue 2;
                        }
                        $title = $artefacts[$parent]->title . '/' . $title;
                        $parent = $artefacts[$parent]->parent;
                    }
                    if (!$public) {
                        $files[] = array('name' => $title, 'id' => $a->id);
                    }
                }
            }
        }
        return $files;
601
    }
Richard Mansfield's avatar
Richard Mansfield committed
602

603
604
605
606
    public function delete() {
        if (empty($this->id)) {
            return; 
        }
Richard Mansfield's avatar
Richard Mansfield committed
607
        $file = $this->get_path();
608
609
        // Detach this file from any view feedback
        set_field('view_feedback', 'attachment', null, 'attachment', $this->id);
610
611
612
613
614
        if (is_file($file)) {
            $size = filesize($file);
            unlink($file);
            global $USER;
            // Deleting other users' files won't lower their quotas yet...
615
616
617
            if (!$this->adminfiles && $USER->id == $this->get('owner')) {
                $USER->quota_remove($size);
                $USER->commit();
618
            }
Richard Mansfield's avatar
Richard Mansfield committed
619
        }
620
621
622
        parent::delete();
    }

623
624
625
626
    public static function has_config() {
        return true;
    }

627
    public static function get_icon($options=null) {
628
        return theme_get_url('images/file.gif');
629
630
    }

631
    public static function get_config_options() {
632
        $elements = array();
633
634
635
636
        $defaultquota = get_config_plugin('artefact', 'file', 'defaultquota');
        if (empty($defaultquota)) {
            $defaultquota = 1024 * 1024 * 10;
        }
637
638
639
        $elements['quotafieldset'] = array(
            'type' => 'fieldset',
            'legend' => get_string('defaultquota', 'artefact.file'),
640
            'elements' => array(
641
642
643
                'defaultquotadescription' => array(
                    'value' => '<tr><td colspan="2">' . get_string('defaultquotadescription', 'artefact.file') . '</td></tr>'
                ),
644
645
646
647
                'defaultquota' => array(
                    'title'        => get_string('defaultquota', 'artefact.file'), 
                    'type'         => 'bytes',
                    'defaultvalue' => $defaultquota,
648
                )
649
            ),
650
651
652
653
654
655
            'collapsible' => true
        );


        // Allowed file types
        $filetypes = array();
656
        foreach (get_records_array('artefact_file_file_types', null, null, 'description') as $filetype) {
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
            $filetype->description = preg_replace('/[^a-zA-Z0-9_]/', '_', $filetype->description);
            $filetypes[$filetype->description] = array(
                'type'  => 'checkbox',
                'title' => get_string($filetype->description, 'artefact.file'),
                'defaultvalue' => $filetype->enabled
            );
        }
        uasort($filetypes, create_function('$a, $b', 'return $a["title"] > $b["title"];'));
        $filetypes = array_merge(array(
            'filetypedescription' => array(
                'value' => '<tr><td colspan="2">' . get_string('filetypedescription', 'artefact.file') . '</td></tr>'
            )
        ), $filetypes);
        $elements['filetypes'] = array(
            'type' => 'fieldset',
            'legend' => get_string('filetypes', 'artefact.file'),
            'elements' => $filetypes,
            'collapsible' => true,
            'collapsed' => true
        );
 
        return array(
            'elements' => $elements,
            'renderer' => 'table'
681
682
683
684
685
        );
    }

    public static function save_config_options($values) {
        set_config_plugin('artefact', 'file', 'defaultquota', $values['defaultquota']);
686
        foreach (get_records_array('artefact_file_file_types') as $filetype) {
687
688
            $key = preg_replace('/[^a-zA-Z0-9_]/', '_', $filetype->description);
            $filetype->enabled = intval($values[$key]);
689
            update_record('artefact_file_file_types', $filetype, 'description');
690
        }
691
    }
692

Richard Mansfield's avatar
Richard Mansfield committed
693
    public function describe_size() {
694
695
696
697
698
        $bytes = $this->get('size');
        if ($bytes < 1024) {
            return $bytes <= 0 ? '0' : ($bytes . ' ' . get_string('bytes', 'artefact.file'));
        }
        if ($bytes < 1048576) {
699
            return floor(($bytes / 1024) * 10 + 0.5) / 10 . 'K';
700
701
702
703
        }
        return floor(($bytes / 1048576) * 10 + 0.5) / 10 . 'M';
    }

Martyn Smith's avatar
Martyn Smith committed
704
705
706
707
708
709
710
711
    public static function get_links($id) {
        $wwwroot = get_config('wwwroot');

        return array(
            '_default' => $wwwroot . 'artefact/file/download.php?file=' . $id,
            get_string('folder', 'artefact.file') => $wwwroot . 'artefact/file/?folder=' . $id,
        );
    }
712
713
714
715
716
717
718
719
720
721
722
723
724
725

    public function override_content_type() {
        static $extensions;
        if (empty($extensions)) {
            $extensions = array(
                'wmv' => 'video/x-ms-wmv',
                'flv' => 'video/x-flv',
            );
        }
        if (array_key_exists($this->get('oldextension'), $extensions)) {
            return $extensions[$this->get('oldextension')];
        }
        return false;
    }
726
}
727
728
729

class ArtefactTypeFolder extends ArtefactTypeFileBase {

730
731
732
733
    public function __construct($id = 0, $data = null) {

        parent::__construct($id, $data);

Richard Mansfield's avatar
Richard Mansfield committed
734
735
736
737
        if (empty($this->id)) {
            $this->container = 1;
            $this->size = null;
        }
738
739
740

    }

741
    public function folder_contents() {
742
        return get_records_array('artefact', 'parent', $this->get('id'));
743
744
    }

745
746
747
748
749
    public function render_self($options) {
        $smarty = smarty_core();
        $smarty->assign('title', $this->get('title'));
        $smarty->assign('description', $this->get('description'));
        $smarty->assign('viewid', $options['viewid']);
750
        $smarty->assign('hidetitle', isset($options['hidetitle']) ? $options['hidetitle'] : false);
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767

        if ($childrecords = $this->folder_contents()) {
            $this->add_to_render_path($options);
            usort($childrecords, array('ArtefactTypeFileBase', 'my_files_cmp'));
            $children = array();
            foreach ($childrecords as &$child) {
                $c = artefact_instance_from_id($child->id);
                $child->title = $c->get('title');
                $child->date = format_date(strtotime($child->mtime), 'strfdaymonthyearshort');
                $child->iconsrc = call_static_method(generate_artefact_class_name($child->artefacttype), 'get_icon', array('id' => $child->id, 'viewid' => $options['viewid']));
            }
            $smarty->assign('children', $childrecords);
        }
        return array('html' => $smarty->fetch('artefact:file:folder_render_self.tpl'),
                     'javascript' => null);
    }

Richard Mansfield's avatar
Richard Mansfield committed
768
769
770
771
    public function describe_size() {
        return $this->count_children() . ' ' . get_string('files', 'artefact.file');
    }

772
    public static function get_icon($options=null) {
773
        return theme_get_url('images/folder.gif');
774
775
776
777
778
779
    }

    public static function collapse_config() {
        return 'file';
    }
    
780
    public static function admin_public_folder_id() {
781
782
783
784
        // There is one public files directory and many admins, so the
        // name of the directory uses the site language rather than
        // the language of the admin who first creates it.
        $name = get_string_from_language(get_config('lang'), 'adminpublicdirname', 'admin');
785
786
787
        $folderid = get_field_sql('
           SELECT
             a.id
788
789
           FROM {artefact} a
             INNER JOIN {artefact_file_files} f ON a.id = f.artefact
790
791
792
793
794
795
           WHERE a.title = ?
             AND a.artefacttype = ?
             AND f.adminfiles = 1
             AND a.parent IS NULL', array($name, 'folder'));
        if (!$folderid) {
            global $USER;
796
            if (get_field('usr', 'admin', 'id', $USER->id)) {
797
798
                $description = get_string_from_language(get_config('lang'), 
                                                        'adminpublicdirdescription', 'admin');
799
800
801
802
803
804
805
806
807
808
                $data = (object) array('title' => $name,
                                       'description' => $description,
                                       'owner' => $USER->id,
                                       'adminfiles' => 1);
                $f = new ArtefactTypeFolder(0, $data);
                $f->commit();
                $folderid = $f->get('id');
            } else {
                return false;
            }
809
810
811
812
        }
        return $folderid;
    }

813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
    public static function change_public_folder_name($oldlang, $newlang) {
        $oldname = get_string_from_language($oldlang, 'adminpublicdirname', 'admin');
        $folderid = get_field_sql('
           SELECT
             a.id
           FROM {artefact} a
             INNER JOIN {artefact_file_files} f ON a.id = f.artefact
           WHERE a.title = ?
             AND a.artefacttype = ?
             AND f.adminfiles = 1
             AND a.parent IS NULL', array($oldname, 'folder'));

        if (!$folderid) {
            return;
        }

        $name = get_string_from_language($newlang, 'adminpublicdirname', 'admin');
        $description = get_string_from_language($newlang, 'adminpublicdirdescription', 'admin');
        if (!empty($name)) {
            $artefact = artefact_instance_from_id($folderid);
            $artefact->set('title', $name);
            $artefact->set('description', $description);
            $artefact->commit();
        }
    }

839
840
841
    public static function get_folder_by_name($name, $parentfolderid=null, $userid=null) {
        if (empty($userid)) {
            global $USER;
842
            $userid = $USER->id;
843
        }
844
        $parentclause = $parentfolderid ? 'parent = ' . $parentfolderid : 'parent IS NULL';
845
        return get_record_sql('SELECT * FROM {artefact}
846
           WHERE title = ? AND ' . $parentclause . ' AND owner = ' . $userid . "
847
848
849
850
           AND artefacttype = 'folder'", array($name));
    }

    // Get the id of a folder, creating the folder if necessary
851
    public static function get_folder_id($name, $description, $parentfolderid=null, $userid=null, $create=true) {
852
853
        if (empty($userid)) {
            global $USER;
854
            $userid = $USER->id;
855
856
        }
        if (!$record = self::get_folder_by_name($name, $parentfolderid, $userid)) {
857
858
859
            if (!$create) {
                return false;
            }
860
861
862
863
            $data = new StdClass;
            $data->title = $name;
            $data->description = $description;
            $f = new ArtefactTypeFolder(0, $data);
864
            $f->set('owner', $userid);
865
866
867
868
869
870
871
            $f->set('parent', $parentfolderid);
            $f->commit();
            return $f->get('id');
        }
        return $record->id;
    }

Martyn Smith's avatar
Martyn Smith committed
872
873
874
875
876
877
878
    public static function get_links($id) {
        $wwwroot = get_config('wwwroot');

        return array(
            '_default' => $wwwroot . 'artefact/file/?folder=' . $id,
        );
    }
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896

    public static function change_language($userid, $oldlang, $newlang) {
        $oldname = get_string_from_language($oldlang, 'feedbackattachdirname', 'view');
        $artefact = ArtefactTypeFolder::get_folder_by_name($oldname, null, $userid);
        if (empty($artefact)) {
            return;
        }

        $name = get_string_from_language($newlang, 'feedbackattachdirname', 'view');
        $description = get_string_from_language($newlang, 'feedbackattachdirdesc', 'view');
        if (!empty($name)) {
            $artefact = artefact_instance_from_id($artefact->id);
            $artefact->set('title', $name);
            $artefact->set('description', $description);
            $artefact->commit();
        }
    }

897
898
}

899
class ArtefactTypeImage extends ArtefactTypeFile {
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
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

    protected $width;
    protected $height;

    public function __construct($id = 0, $data = null) {
        parent::__construct($id, $data);

        if ($this->id && ($filedata = get_record('artefact_file_image', 'artefact', $this->id))) {
            foreach($filedata as $name => $value) {
                if (property_exists($this, $name)) {
                    $this->set($name, $value);
                }
            }
        }
    }

    /**
     * This function updates or inserts the artefact.  This involves putting
     * some data in the artefact table (handled by parent::commit()), and then
     * some data in the artefact_file_image table.
     */
    public function commit() {
        // Just forget the whole thing when we're clean.
        if (empty($this->dirty)) {
            return;
        }
      
        // We need to keep track of newness before and after.
        $new = empty($this->id);

        $this->mtime = time();

        // Commit to the artefact table.
        parent::commit();

        // Reset dirtyness for the time being.
        $this->dirty = true;

        $data = (object)array(
            'artefact'      => $this->get('id'),
            'width'         => $this->get('width'),
            'height'        => $this->get('height')
        );

        if ($new) {
            insert_record('artefact_file_image', $data);
        }
        else {
            update_record('artefact_file_image', $data, 'artefact');
        }

        $this->dirty = false;
    }

954
955
    public static function collapse_config() {
        return 'file';
956
   } 
957

958
959
960
    /**
     * err... wtf. Let's find where this method is called and change the call eh?
     */
961
    public static function is_image_mime_type($type) {
Richard Mansfield's avatar
Richard Mansfield committed
962
963
        require_once('file.php');
        return is_image_mime_type($type);
964
965
    }

966
967
968
969
    public static function get_icon($options=null) {
        $url = get_config('wwwroot') . 'artefact/file/download.php?';
        $url .= 'file=' . $options['id'];

970
971
        if (isset($options['viewid'])) {
            $url .= '&view=' . $options['viewid'];
972
973
974
975
976
977
978
979
980
        }
        if (isset($options['size'])) {
            $url .= '&size=' . $options['size'];
        }
        else {
            $url .= '&size=20x20';
        }

        return $url;
981
982
983
    }

    public function get_path($data=array()) {
984
        require_once('file.php');
985
986
987
988
989
        $size = (isset($data['size'])) ? $data['size'] : null;
        $result = get_dataroot_image_path('artefact/file/', $this->id, $size);
        return $result;
    }

990
991
992
993
994
995
996
997
    public function delete() {
        if (empty($this->id)) {
            return; 
        }
        delete_records('artefact_file_image', 'artefact', $this->id);
        parent::delete();
    }

Penny Leach's avatar
Penny Leach committed
998
    public function render_self($options) {
999
        $result = parent::render_self($options);
1000
        $result['html'] = '<div class="fr filedata-icon" style="text-align: center;"><h4>' . get_string('Preview', 'artefact.file') . '</h4><img src="'
1001
            . hsc(get_config('wwwroot') . 'artefact/file/download.php?file=' . $this->id . '&view=' . $options['viewid'] . '&maxwidth=400')
1002
1003
            . '" alt=""></div>' . $result['html'];
        return $result;
Penny Leach's avatar
Penny Leach committed
1004
    }
1005
1006
1007
}

?>