lib.php 35.5 KB
Newer Older
1
2
<?php
/**
Francois Marier's avatar
Francois Marier committed
3
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
4
 * Copyright (C) 2006-2008 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
 *
 * @package    mahara
 * @subpackage artefact-internal
21
 * @author     Catalyst IT Ltd
22
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
23
 * @copyright  (C) 2006-2008 Catalyst IT Ltd http://catalyst.net.nz
24
25
26
27
28
 *
 */

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
72
73
    public static function postinst($prevversion) {
        if ($prevversion == 0) {
            set_config_plugin('artefact', 'file', 'defaultquota', 10485760);
        }
74
        self::resync_filetype_list();
75
76
    }

77
    public static function newuser($event, $user) {
78
79
80
        if (empty($user->quota)) {
            update_record('usr', array('quota' => get_config_plugin('artefact', 'file', 'defaultquota')), array('id' => $user['id']));
        }
81
    }
82
    
Richard Mansfield's avatar
Richard Mansfield committed
83

84
85
86
87
88
89
90
91
92
    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
93

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

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

148
149
150
151
152
153
154
    public static function jshelp($type) {
        static $jshelp = array(
            'file' => array(
                'artefact.file' => array(
                    'notice',
                    'quota_message',
                    'uploadfile',
155
                    'tags',
156
157
158
159
160
161
                ),
            ),
        );
        return $jshelp[$type];
    }

162
163
164
165
166
167
168
169
170
171
172
173

    /**
     * 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');

174
        $currentlist = get_column('artefact_file_file_types', 'description');
175
176
177
178
179
180
181
182
183
184
185
186
187
188
        $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]['#'];
189
                insert_record('artefact_file_file_types', $record);
190
191
192
193
194
195
196
197
198
199
            }
            $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]);
200
201
                delete_records('artefact_file_mime_types', 'description', $type);
                delete_records('artefact_file_file_types', 'description', $type);
202
203
204
205
206
207
            }
        }


        // Get a list of all current mimetypes for each file type
        $currentmimetypes = array();
208
        $dbmimetypes = get_records_array('artefact_file_mime_types');
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
235
236
237
238
239
        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);
240
                delete_records('artefact_file_mime_types', 'description', $description);
241
242
243
244
                foreach ($newmimetypes as $newmimetype) {
                    $record = new StdClass;
                    $record->mimetype    = $newmimetype;
                    $record->description = $description;
245
                    insert_record('artefact_file_mime_types', $record);
246
247
248
249
250
251
252
253
                }
            }
        }
       
        db_commit();
        //db_rollback();
    }

254
255
}

Martyn Smith's avatar
Martyn Smith committed
256
abstract class ArtefactTypeFileBase extends ArtefactType {
257

Richard Mansfield's avatar
Richard Mansfield committed
258
    protected $size;
259
260
261
262
263
    // 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.
264
    protected $oldextension;
Richard Mansfield's avatar
Richard Mansfield committed
265
266
267
268
269
270
271
272
273
274
275

    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)) {
276
                    $this->{$name} = $value;
Richard Mansfield's avatar
Richard Mansfield committed
277
278
279
280
281
282
                }
            }
        }

    }

283
284
285
286
287
    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'])) {
288
            $downloadpath .= '&view=' . $options['viewid'];
289
        }
290
291
292
293
294
        $filetype = get_string($this->get('oldextension'), 'artefact.file');
        if (substr($filetype, 0, 2) == '[[') {
            $filetype = $this->get('oldextension') . ' ' . get_string('file', 'artefact.file');
        }

295
296
297
        $smarty = smarty_core();
        $smarty->assign('iconpath', $this->get_icon($options));
        $smarty->assign('downloadpath', $downloadpath);
298
        $smarty->assign('filetype', $filetype);
299
300
301
302
303
304
305
306
307
308
309
310
        $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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
    /**
     * 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'),
336
            'oldextension'  => $this->get('oldextension')
Richard Mansfield's avatar
Richard Mansfield committed
337
338
339
340
341
342
343
344
345
346
347
348
        );

        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
349
    public static function is_singular() {
Penny Leach's avatar
Penny Leach committed
350
351
352
        return false;
    }

353
    public static function get_icon($options=null) {
354
355
356
357
358
359
360

    }

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

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

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

Richard Mansfield's avatar
Richard Mansfield committed
379
380
    // Check if something exists in the db with a given title and parent,
    // either in adminfiles or with a specific owner.
381
    public static function file_exists($title, $owner, $folder, $institution=null) {
382
        $filetypesql = "('" . join("','", PluginArtefactFile::get_artefact_types()) . "')";
383
384
385
386
387
388
389
390
        $phvals = array($title);
        if ($institution) {
            $ownersql = 'a.institution = ? AND a.owner IS NULL';
            $phvals[] = $institution;
        } else {
            $ownersql = 'a.institution IS NULL AND a.owner = ?';
            $phvals[] = $owner;
        }
391
392
        return get_field_sql('SELECT a.id FROM {artefact} a
            LEFT OUTER JOIN {artefact_file_files} f ON f.artefact = a.id
393
394
            WHERE a.title = ?
            AND ' . $ownersql . '
Richard Mansfield's avatar
Richard Mansfield committed
395
            AND a.parent ' . (empty($folder) ? ' IS NULL' : ' = ' . $folder) . '
396
            AND a.artefacttype IN ' . $filetypesql, $phvals);
397
398
    }

399
400
401
402
403
404
405
406

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


407
    public static function get_my_files_data($parentfolderid, $userid, $institution=null) {
408

409
410
        $foldersql = $parentfolderid ? ' = ' . $parentfolderid : ' IS NULL';

411
412
413
414
415
416
417
418
        if ($institution) {
            $ownersql = 'a.institution = ? AND a.owner IS NULL';
            $phvals = array($institution);
        } else {
            $ownersql = 'a.institution IS NULL AND a.owner = ?';
            $phvals = array($userid);
        }

419
420
        // if blogs are installed then also return the number of blog
        // posts each file is attached to
421
        $bloginstalled = get_field('artefact_installed', 'active', 'name', 'blog');
422

423
        $filetypesql = "('" . join("','", PluginArtefactFile::get_artefact_types()) . "')";
Richard Mansfield's avatar
Richard Mansfield committed
424
425
        $filedata = get_records_sql_array('
            SELECT
426
                a.id, a.artefacttype, a.mtime, f.size, a.title, a.description,
Penny Leach's avatar
Penny Leach committed
427
428
                COUNT(c.id) AS childcount ' 
                . ($bloginstalled ? ', COUNT (b.blogpost) AS attachcount' : '') . '
429
430
431
432
433
            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') : '') . '
434
            WHERE a.parent' . $foldersql . '
435
                AND ' . $ownersql . '
436
437
                AND a.artefacttype IN ' . $filetypesql . '
            GROUP BY
438
                a.id, a.artefacttype, a.mtime, f.size, a.title, a.description;', $phvals);
439
440
441
442
443
444

        if (!$filedata) {
            $filedata = array();
        }
        else {
            foreach ($filedata as $item) {
Richard Mansfield's avatar
Richard Mansfield committed
445
                $item->mtime = format_date(strtotime($item->mtime), 'strfdaymonthyearshort');
446
447
448
449
                $item->tags = get_column('artefact_tag', 'tag', 'artefact', $item->id);
                if (!is_array($item->tags)) {
                    $item->tags = array();
                }
450
451
452
            }
        }

Richard Mansfield's avatar
Richard Mansfield committed
453
454
455
456
457
458
459
460
461
462
463
464
        // 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
            );
        }

465
        usort($filedata, array("ArtefactTypeFileBase", "my_files_cmp"));
466
467
        return $filedata;
    }
468
469
}

470
class ArtefactTypeFile extends ArtefactTypeFileBase {
471

472
473
474
    public function __construct($id = 0, $data = null) {
        parent::__construct($id, $data);
        
Richard Mansfield's avatar
Richard Mansfield committed
475
476
        if (empty($this->id)) {
            $this->container = 0;
477
        }
478

479
480
    }

481
    public static function get_file_directory($id) {
482
        return "artefact/file/originals/" . ($id % 256);
483
484
    }

485
486
    public function get_path() {
        return get_config('dataroot') . self::get_file_directory($this->id) . '/' .  $this->id;
487
488
    }

489
490
491
492
493
494
495
496
    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';
    }

497
498
499
500
    /**
     * Test file type and return a new Image or File.
     */
    public static function new_file($path, $data) {
Richard Mansfield's avatar
Richard Mansfield committed
501
502
        require_once('file.php');
        $type = get_mime_type($path);
503
        if (ArtefactTypeImage::is_image_mime_type($type)) {
504
            list($data->width, $data->height) = getimagesize($path);
505
506
507
508
509
            return new ArtefactTypeImage(0, $data);
        }
        return new ArtefactTypeFile(0, $data);
    }

510
511
512
513
514
    /**
     * 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
515
    public static function save_file($pathname, $data) {
516
517
518
        // 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. 
519
520
521
522
523
        $dataroot = get_config('dataroot');
        $pathname = $dataroot . $pathname;
        if (!$size = filesize($pathname)) {
            return false;
        }
524
        $f = self::new_file($pathname, $data);
Richard Mansfield's avatar
Richard Mansfield committed
525
526
527
528
529
        $f->set('size', $size);
        $f->commit();
        $id = $f->get('id');

        $newdir = $dataroot . self::get_file_directory($id);
530
        check_dir_exists($newdir);
Richard Mansfield's avatar
Richard Mansfield committed
531
        $newname = $newdir . '/' . $id;
532
        if (!rename($pathname, $newname)) {
Richard Mansfield's avatar
Richard Mansfield committed
533
            $f->delete();
534
            return false;
535
        }
536
537
        global $USER;
        $USER->quota_add($size);
538
        $USER->commit();
Richard Mansfield's avatar
Richard Mansfield committed
539
        return $id;
540
    }
Richard Mansfield's avatar
Richard Mansfield committed
541

542
    /**
Richard Mansfield's avatar
Richard Mansfield committed
543
544
     * Processes a newly uploaded file, copies it to disk, and creates
     * a new artefact object.
545
546
547
548
549
550
551
552
553
     * 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
554
        $size = $um->file['size'];
555
        global $USER;
556
        if (!$USER->quota_allowed($size) && !$data->institution) {
557
            return get_string('uploadexceedsquota', 'artefact.file');
Richard Mansfield's avatar
Richard Mansfield committed
558
559
560
        }
        $f = self::new_file($um->file['tmp_name'], $data);
        $f->set('size', $size);
561
        $f->set('oldextension', $um->original_filename_extension());
562
563
564
565
566
567
568
        $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
569
570
        else {
            $USER->quota_add($size);
571
            $USER->commit();
Richard Mansfield's avatar
Richard Mansfield committed
572
        }
573
574
        return $error;
    }
Richard Mansfield's avatar
Richard Mansfield committed
575

576

577
578
579
580
581
582
583
584
585
586
587
    // 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;
    }

588

589
    public static function get_admin_files($public) {
590
        $pubfolder = ArtefactTypeFolder::admin_public_folder_id();
591
        $artefacts = get_records_sql_assoc("
592
            SELECT
593
                a.id, a.title, a.parent, a.artefacttype
594
595
            FROM {artefact} a
                INNER JOIN {artefact_file_files} f ON f.artefact = a.id
596
            WHERE a.institution = 'mahara'", array());
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618

        $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;
619
    }
Richard Mansfield's avatar
Richard Mansfield committed
620

621
622
623
624
    public function delete() {
        if (empty($this->id)) {
            return; 
        }
Richard Mansfield's avatar
Richard Mansfield committed
625
        $file = $this->get_path();
626
627
        // Detach this file from any view feedback
        set_field('view_feedback', 'attachment', null, 'attachment', $this->id);
628
629
630
631
632
        if (is_file($file)) {
            $size = filesize($file);
            unlink($file);
            global $USER;
            // Deleting other users' files won't lower their quotas yet...
633
            if (!$this->institution && $USER->id == $this->get('owner')) {
634
635
                $USER->quota_remove($size);
                $USER->commit();
636
            }
Richard Mansfield's avatar
Richard Mansfield committed
637
        }
638
639
640
        parent::delete();
    }

641
642
643
644
    public static function has_config() {
        return true;
    }

645
    public static function get_icon($options=null) {
646
        return theme_get_url('images/file.gif');
647
648
    }

649
    public static function get_config_options() {
650
        $elements = array();
651
652
653
654
        $defaultquota = get_config_plugin('artefact', 'file', 'defaultquota');
        if (empty($defaultquota)) {
            $defaultquota = 1024 * 1024 * 10;
        }
655
656
657
        $elements['quotafieldset'] = array(
            'type' => 'fieldset',
            'legend' => get_string('defaultquota', 'artefact.file'),
658
            'elements' => array(
659
660
661
                'defaultquotadescription' => array(
                    'value' => '<tr><td colspan="2">' . get_string('defaultquotadescription', 'artefact.file') . '</td></tr>'
                ),
662
663
664
665
                'defaultquota' => array(
                    'title'        => get_string('defaultquota', 'artefact.file'), 
                    'type'         => 'bytes',
                    'defaultvalue' => $defaultquota,
666
                )
667
            ),
668
669
670
671
672
673
            'collapsible' => true
        );


        // Allowed file types
        $filetypes = array();
674
        foreach (get_records_array('artefact_file_file_types', null, null, 'description') as $filetype) {
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
            $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'
699
700
701
702
703
        );
    }

    public static function save_config_options($values) {
        set_config_plugin('artefact', 'file', 'defaultquota', $values['defaultquota']);
704
        foreach (get_records_array('artefact_file_file_types') as $filetype) {
705
706
            $key = preg_replace('/[^a-zA-Z0-9_]/', '_', $filetype->description);
            $filetype->enabled = intval($values[$key]);
707
            update_record('artefact_file_file_types', $filetype, 'description');
708
        }
709
    }
710

Richard Mansfield's avatar
Richard Mansfield committed
711
    public function describe_size() {
712
713
714
715
716
        $bytes = $this->get('size');
        if ($bytes < 1024) {
            return $bytes <= 0 ? '0' : ($bytes . ' ' . get_string('bytes', 'artefact.file'));
        }
        if ($bytes < 1048576) {
717
            return floor(($bytes / 1024) * 10 + 0.5) / 10 . 'K';
718
719
720
721
        }
        return floor(($bytes / 1048576) * 10 + 0.5) / 10 . 'M';
    }

Martyn Smith's avatar
Martyn Smith committed
722
723
724
725
726
727
728
729
    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,
        );
    }
730
731
732
733
734
735
736
737
738
739
740
741
742
743

    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;
    }
744
}
745
746
747

class ArtefactTypeFolder extends ArtefactTypeFileBase {

748
749
750
751
    public function __construct($id = 0, $data = null) {

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

Richard Mansfield's avatar
Richard Mansfield committed
752
753
754
755
        if (empty($this->id)) {
            $this->container = 1;
            $this->size = null;
        }
756
757
758

    }

759
    public function folder_contents() {
760
        return get_records_array('artefact', 'parent', $this->get('id'));
761
762
    }

763
764
765
766
767
    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']);
768
        $smarty->assign('simpledisplay', isset($options['simpledisplay']) ? $options['simpledisplay'] : false);
769
770
771
772
773
774
775

        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);
776
777
778
779
                $child->title = $child->hovertitle = $c->get('title');
                if (!empty($options['simpledisplay'])) {
                    $child->title = str_shorten($child->title, 20);
                }
780
781
782
783
784
785
786
787
788
                $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
789
790
791
792
    public function describe_size() {
        return $this->count_children() . ' ' . get_string('files', 'artefact.file');
    }

793
    public static function get_icon($options=null) {
794
        return theme_get_url('images/folder.gif');
795
796
797
798
799
800
    }

    public static function collapse_config() {
        return 'file';
    }
    
801
    public static function admin_public_folder_id() {
802
803
804
805
        // 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');
806
        $folderid = get_field_sql("
807
808
           SELECT
             a.id
809
810
           FROM {artefact} a
             INNER JOIN {artefact_file_files} f ON a.id = f.artefact
811
812
           WHERE a.title = ?
             AND a.artefacttype = ?
813
814
             AND a.institution = 'mahara'
             AND a.parent IS NULL", array($name, 'folder'));
815
816
        if (!$folderid) {
            global $USER;
817
            if (get_field('usr', 'admin', 'id', $USER->id)) {
818
819
                $description = get_string_from_language(get_config('lang'), 
                                                        'adminpublicdirdescription', 'admin');
820
821
822
                $data = (object) array('title' => $name,
                                       'description' => $description,
                                       'owner' => $USER->id,
823
                                       'institution' => 'mahara');
824
825
826
827
828
829
                $f = new ArtefactTypeFolder(0, $data);
                $f->commit();
                $folderid = $f->get('id');
            } else {
                return false;
            }
830
831
832
833
        }
        return $folderid;
    }

834
835
    public static function change_public_folder_name($oldlang, $newlang) {
        $oldname = get_string_from_language($oldlang, 'adminpublicdirname', 'admin');
836
        $folderid = get_field_sql("
837
838
839
840
841
842
           SELECT
             a.id
           FROM {artefact} a
             INNER JOIN {artefact_file_files} f ON a.id = f.artefact
           WHERE a.title = ?
             AND a.artefacttype = ?
843
844
             AND a.institution = 'mahara'
             AND a.parent IS NULL", array($oldname, 'folder'));
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859

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

860
861
862
    public static function get_folder_by_name($name, $parentfolderid=null, $userid=null) {
        if (empty($userid)) {
            global $USER;
863
            $userid = $USER->id;
864
        }
865
        $parentclause = $parentfolderid ? 'parent = ' . $parentfolderid : 'parent IS NULL';
866
        return get_record_sql('SELECT * FROM {artefact}
867
           WHERE title = ? AND ' . $parentclause . ' AND owner = ' . $userid . "
868
869
870
871
           AND artefacttype = 'folder'", array($name));
    }

    // Get the id of a folder, creating the folder if necessary
872
    public static function get_folder_id($name, $description, $parentfolderid=null, $userid=null, $create=true) {
873
874
        if (empty($userid)) {
            global $USER;
875
            $userid = $USER->id;
876
877
        }
        if (!$record = self::get_folder_by_name($name, $parentfolderid, $userid)) {
878
879
880
            if (!$create) {
                return false;
            }
881
882
883
884
            $data = new StdClass;
            $data->title = $name;
            $data->description = $description;
            $f = new ArtefactTypeFolder(0, $data);
885
            $f->set('owner', $userid);
886
887
888
889
890
891
892
            $f->set('parent', $parentfolderid);
            $f->commit();
            return $f->get('id');
        }
        return $record->id;
    }

Martyn Smith's avatar
Martyn Smith committed
893
894
895
896
897
898
899
    public static function get_links($id) {
        $wwwroot = get_config('wwwroot');

        return array(
            '_default' => $wwwroot . 'artefact/file/?folder=' . $id,
        );
    }
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917

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

918
919
}

920
class ArtefactTypeImage extends ArtefactTypeFile {
921
922
923
924
925
926
927
928
929
930

    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)) {
931
                    $this->{$name} = $value;
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
                }
            }
        }
    }

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

975
976
    public static function collapse_config() {
        return 'file';
977
   } 
978

979
980
981
    /**
     * err... wtf. Let's find where this method is called and change the call eh?
     */
982
    public static function is_image_mime_type($type) {
Richard Mansfield's avatar
Richard Mansfield committed
983
984
        require_once('file.php');
        return is_image_mime_type($type);
985
986
    }

987
988
989
990
    public static function get_icon($options=null) {
        $url = get_config('wwwroot') . 'artefact/file/download.php?';
        $url .= 'file=' . $options['id'];

991
992
        if (isset($options['viewid'])) {
            $url .= '&view=' . $options['viewid'];
993
994
995
996
997
        }
        if (isset($options['size'])) {
            $url .= '&size=' . $options['size'];
        }
        else {
998
            $url .= '&maxheight=20&maxwidth=20';
999
1000
1001
        }

        return $url;
1002
1003
1004
    }

    public function get_path($data=array()) {
1005
        require_once('file.php');
1006
        $result = get_dataroot_image_path('artefact/file/', $this->id, $data);
1007
1008
1009
        return $result;
    }

1010
1011
1012
1013
1014
1015
1016
1017
    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
1018
    public function render_self($options) {
1019
        $result = parent::render_self($options);
1020
        $result['html'] = '<div class="fr filedata-icon" style="text-align: center;"><h4>' . get_string('Preview', 'artefact.file') . '</h4><img src="'
1021
            . hsc(get_config('wwwroot') . 'artefact/file/download.php?file=' . $this->id . '&view=' . $options['viewid'] . '&maxwidth=400&maxheight=180')
1022
1023
            . '" alt=""></div>' . $result['html'];
        return $result;
Penny Leach's avatar
Penny Leach committed
1024
    }
1025
1026
1027
}

?>