lib.php 67 KB
Newer Older
1
2
3
4
<?php
/**
 *
 * @package    mahara
Penny Leach's avatar
Penny Leach committed
5
 * @subpackage artefact
6
 * @author     Catalyst IT Ltd
7
8
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL version 3 or later
 * @copyright  For copyright information on Mahara, please see the README file distributed with this software.
9
10
11
12
 *
 */

defined('INTERNAL') || die();
13
require_once(get_config('libroot') . 'group.php');
14
15

/**
16
 * Helper interface to hold the PluginArtefact's abstract static functions
17
 */
18
interface IPluginArtefact {
Aaron Wells's avatar
Aaron Wells committed
19
20
    /**
     * This function returns a list of classnames
21
     * of artefact types this plugin provides.
Penny Leach's avatar
Penny Leach committed
22
     * @abstract
23
24
     * @return array
     */
25
    public static function get_artefact_types();
Aaron Wells's avatar
Aaron Wells committed
26

27
28
29
30
31
32
33
    /**
    * This function returns a list of classnames
    * of block types this plugin provides
    * they must match directories inside artefact/$name/blocktype
    * @abstract
    * @return array
    */
34
    public static function get_block_types();
35

36
37
    /**
     * This function returns the name of the plugin.
Penny Leach's avatar
Penny Leach committed
38
     * @abstract
39
40
     * @return string
     */
41
42
    public static function get_plugin_name();
}
43

44
45
46
47
48
49
50
51
52
/**
 * Base artefact plugin class
 * @abstract
 */
abstract class PluginArtefact extends Plugin implements IPluginArtefact {

    public static function get_plugintype_name() {
        return 'artefact';
    }
53

54
55
56
    /**
     * This function returns an array of menu items
     * to be displayed
57
58
59
60
     *
     * See the function find_menu_children() in lib/web.php
     * for a description of the expected array structure.
     *
61
62
63
64
65
     * @return array
     */
    public static function menu_items() {
        return array();
    }
66
67
68
69
70
71
72
73
74
75
76
77
78


    /**
     * This function returns an array of menu items to be displayed
     * on a group page when viewed by group members.
     * Each item should be a StdClass object containing -
     * - title language pack key
     * - url relative to wwwroot
     * @return array
     */
    public static function group_tabs($groupid) {
        return array();
    }
79
80
81
82
83
84
85
86
87
88
89


    /**
     * Returns any artefacts that are not inside a view
     * but which need to be exported along with it.
     * @param array $viewids
     * @return array of artefact ids
     */
    public static function view_export_extra_artefacts($viewids) {
        return array();
    }
90
91
92
93

    /**
     * When filtering searches, some artefact types are classified the same way
     * even when they come from different artefact plugins.  This function allows
94
     * artefact plugins to declare which search filter content type each of their
95
96
97
98
99
100
     * artefact types belong to.
     * @return array of artefacttype => array of filter content types
     */
    public static function get_artefact_type_content_types() {
        return array();
    }
101
102
103


    /**
104
105
106
107
     * Indicates whether this particular plugin has any progress bar options. By default, any new plugin
     * will have progress bar options, for creating at least one of the artefact.
     *
     * @return boolean
108
     */
109
110
    public static function has_progressbar_options() {
        return true;
111
112
    }

113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
    /**
     * Returns the relative URL path to the place in mahara that relates
     * to the artefact.
     * E.g. For plan artefact the link will be 'artefact/plans/index.php'
     * @param int The name of the artefact type (in case different ones need different links)
     * @return string Url path to artefact.
     */
    public static function progressbar_link($artefacttype) {
        return '';
    }

    public static function progressbar_task_label($artefacttype, $target, $completed) {
        // By default we check to see if they provided a string called "progress_{$artefacttype}"
        // in the plugin lang file (which takes one param with the count remaining)
        $label = get_string('progress_' . $artefacttype, 'artefact.' . static::get_plugin_name(), ($target - $completed));

        // Kind of a hack: if get_string() gave us a result indicating the string could not be found,
        // try to construct one using the plugin and artefact name.
        if (substr($label, 0, 2) == '[[') {
            $artname = get_string($artefacttype, 'artefact.' . static::get_plugin_name());
            if (substr($artname, 0, 2) == '[[') {
                $artname = $artefacttype;
            }
            $label = get_string('progressbargenerictask', 'mahara', ($target - $completed), $artname);
        }
        return $label;
    }

141
142
143
144
145
146
147
    /**
     * Add any special progress items that may not exist as an artefact type.
     * @return array of objects each containing name, title, plugin, active, iscountable
     */
    public static function progressbar_additional_items() {
        return array();
    }
148
149
150
151
152
153
154
155
156
157
158

    /**
     * If this plugin provides some progress bar metaartefacts, then this method should
     * provide the logic to count them.
     * @param string $name The name of the meta-artefact to count
     * @return object A record containing the count data to be displayed in the sidebar.
     *                It should contain the fields "artefacttype" and "completion"
     */
    public static function progressbar_metaartefact_count($name) {
        return false;
    }
159
160
}

161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/**
 * Helper interface to hold the Artefact class's abstract static functions
 */
interface IArtefactType {
    /**
     * Returns a URL for an icon for the appropriate artefact
     *
     * @param array $options Options for the artefact. The array MUST have the
     *                       'id' key, representing the ID of the artefact for
     *                       which the icon is being generated. Other keys
     *                       include 'size' for a [width]x[height] version of
     *                       the icon, as opposed to the default 20x20, and
     *                       'view' for the id of the view in which the icon is
     *                       being displayed.
     * @abstract
     * @return string URL for the icon
     */
    public static function get_icon($options=null);

    /**
     * whether a user will have exactly 0 or 1 of this artefact type
     * @abstract
     */
    public static function is_singular();

    /**
     * Returns a list of key => value pairs where the key is either '_default'
     * or a language string, and value is a URL linking to that behaviour for
     * this artefact type
     *
     * @param integer This is the ID of the artefact being linked to
     */
    public static function get_links($id);

    // @TODO maybe uncomment this later and implement it everywhere
    // when we know a bit more about what blocks we want.
    //public function render_self($options);
}

Aaron Wells's avatar
Aaron Wells committed
200
/**
201
202
203
 * Base artefact type class
 * @abstract
 */
204
abstract class ArtefactType implements IArtefactType {
205

206
    protected $dirty;
207
    protected $deleted = false;
208
    protected $id;
209
210
    protected $artefacttype;
    protected $owner;
211
    protected $container;
212
    protected $parent;
213
    protected $oldparent;
214
215
    protected $ctime;
    protected $mtime;
216
    protected $atime;
217
218
219
220
    protected $locked;
    protected $title;
    protected $description;
    protected $note;
221
    protected $tags = array();
222
    protected $institution;
223
    protected $group;
224
225
    protected $author;
    protected $authorname;
226
    protected $allowcomments;
227
    protected $approvecomments;
Richard Mansfield's avatar
Richard Mansfield committed
228
    protected $rolepermissions;
229
    protected $mtimemanuallyset;
230
231
232
    protected $license;
    protected $licensor;
    protected $licensorurl;
233
    protected $path;
234

Penny Leach's avatar
Penny Leach committed
235
236
237
238
239
240
241
    protected $viewsinstances;
    protected $viewsmetadata;
    protected $childreninstances;
    protected $childrenmetadata;
    protected $parentinstance;
    protected $parentmetadata;

242
243
    /**
     * Constructor.
244
245
246
247
248
249
     * If an id is supplied, will query the database
     * to build up the basic information about the object.
     * If an id is not supplied, we just create an empty
     * artefact, ready to be filled up
     * @param int $id artefact.id
     */
Penny Leach's avatar
Penny Leach committed
250
    public function __construct($id=0, $data=null) {
251
        if (!empty($id)) {
Penny Leach's avatar
Penny Leach committed
252
253
            if (empty($data)) {
                if (!$data = get_record('artefact','id',$id)) {
254
                    throw new ArtefactNotFoundException(get_string('artefactnotfound', 'error', $id));
Penny Leach's avatar
Penny Leach committed
255
                }
256
            }
257
            $this->id = $id;
258
259
        }
        else {
260
261
            $this->ctime = $this->mtime = time();
            $this->dirty = true;
262
        }
263
264
265
266
267
        if (empty($data)) {
            $data = array();
        }
        foreach ((array)$data as $field => $value) {
            if (property_exists($this, $field)) {
268
269
                if (in_array($field, array('atime', 'ctime', 'mtime'))) {
                    $value = strtotime($value);
Aaron Wells's avatar
Aaron Wells committed
270
                }
Richard Mansfield's avatar
Richard Mansfield committed
271
                if ($field == 'tags' && !is_array($value)) {
272
273
                    $value = preg_split("/\s*,\s*/", trim($value));
                }
274
275
276
277
                $this->{$field} = $value;
            }
        }

278
279
280
281
282
283
284
        $this->artefacttype = $this->get_artefact_type();
        if (!empty($data->artefacttype)) {
            if ($this->artefacttype != $data->artefacttype) {
                throw new SystemException(get_string('artefacttypemismatch', 'error', $data->artefacttype, $this->artefacttype));
            }
        }

285
286
        // load tags
        if ($this->id) {
287
            $this->tags = ArtefactType::artefact_get_tags($this->id);
288
289
        }

Richard Mansfield's avatar
Richard Mansfield committed
290
        // load group permissions
291
        if ($this->group && !is_array($this->rolepermissions)) {
Richard Mansfield's avatar
Richard Mansfield committed
292
293
294
            $this->load_rolepermissions();
        }

295
        $this->atime = time();
296
297
    }

298
299
300
301
302
303
304
305
306
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
332
333
334
335
336
337
338
    /**
     * returns duplicated artefacts which have the same value of the following fields:
     *  - owner
     *  - type
     *  - content
     *      - title
     *      - description
     *
     * @param array $values
     */
    public static function get_duplicated_artefacts(array $values) {
        if (!empty($values['content']['description'])) {
            return get_column_sql('
                SELECT id
                FROM {artefact}
                WHERE owner = ?
                    AND artefacttype = ?
                    AND title = ?
                    AND description = ?',
                array($values['owner'], $values['type'], $values['content']['title'], $values['content']['description'])
            );
        }
        else {
            return get_column('artefact', 'id',
                'owner', $values['owner'],
                'artefacttype', $values['type'],
                'title', $values['content']['title']);
        }
    }

    /**
     * returns existing artefacts which have the same artefacttype and owner
     *
     * @param array $values
     */
    public static function get_existing_artefacts(array $values) {
        return get_column('artefact', 'id',
                        'owner', $values['owner'],
                        'artefacttype', $values['type']);
    }

339
340
341
342
343
    /**
     * Returns the instances of all views where this artefact is used.
     *
     * @return array Array of view instances.
     */
344
    public function get_views_instances() {
345
346
347
348
349
        // @todo test this
        if (!isset($this->viewsinstances)) {
            $this->viewsinstances = false;
            if ($views = $this->get_views_metadata()) {
                $this->viewsinstances = array();
350
351
352
                if (!class_exists('View')) {
                    require_once(get_config('libroot') . 'view.php');
                }
353
                foreach ($views as $view) {
354
                    $this->viewsinstances[] = new View($view->view);
355
356
357
358
                }
            }
        }
        return $this->viewsinstances;
359
    }
360

361
    public function get_views_metadata() {
362
363
364
365
        if (!isset($this->viewsmetadata)) {
            $this->viewsmetadata = get_records_array('view_artefact', 'artefact', $this->id);
        }
        return $this->viewsmetadata;
366
367
    }

Richard Mansfield's avatar
Richard Mansfield committed
368
369
370
371
    public function count_children() {
        return count_records('artefact', 'parent', $this->get('id'));
    }

372
373
374
375
376
377
378
    public function has_children() {
        if ($this->get_children_metadata()) {
            return true;
        }
        return false;
    }

379
380
381
382
    public function get_plugin_name() {
        return get_field('artefact_installed_type', 'plugin', 'name', $this->get('artefacttype'));
    }

Aaron Wells's avatar
Aaron Wells committed
383
384
    /**
     * This function returns the instances
Penny Leach's avatar
Penny Leach committed
385
     * of all children of this artefact
Aaron Wells's avatar
Aaron Wells committed
386
     * If you just want the basic info,
Penny Leach's avatar
Penny Leach committed
387
     * use {@link get_children_metadata} instead.
Aaron Wells's avatar
Aaron Wells committed
388
     *
Penny Leach's avatar
Penny Leach committed
389
390
     * @return array of instances.
     */
391
    public function get_children_instances() {
Penny Leach's avatar
Penny Leach committed
392
393
394
395
396
        if (!isset($this->childreninstances)) {
            $this->childreninstances = false;
            if ($children = $this->get_children_metadata()) {
                $this->childreninstances = array();
                foreach ($children as $child) {
397
                    $classname = generate_artefact_class_name($child->artefacttype);
Penny Leach's avatar
Penny Leach committed
398
399
400
401
402
403
                    $instance = new $classname($child->id, $child);
                    $this->childreninstances[] = $instance;
                }
            }
        }
        return $this->childreninstances;
404
405
    }

406
    /**
Aaron Wells's avatar
Aaron Wells committed
407
408
     * This function returns the db rows
     * from the artefact table that have this
409
410
411
     * artefact as the parent.
     * If you want instances, use {@link get_children_instances}
     * but bear in mind this will have a performance impact.
Aaron Wells's avatar
Aaron Wells committed
412
     *
413
414
     * @return array
     */
415
    public function get_children_metadata() {
Penny Leach's avatar
Penny Leach committed
416
        if (!isset($this->childrenmetadata)) {
417
            $this->childrenmetadata = get_records_array('artefact', 'parent', $this->id);
Penny Leach's avatar
Penny Leach committed
418
419
        }
        return $this->childrenmetadata;
420
    }
Penny Leach's avatar
Penny Leach committed
421
422
423
424
425
426
427
428
429

    /**
     * This function returns the instance relating to the parent
     * of this object, or false if there isn't one.
     * If you just want basic information about it,
     * use {@link get_parent_metadata} instead.
     *
     * @return ArtefactType
     */
430
    public function get_parent_instance() {
Penny Leach's avatar
Penny Leach committed
431
432
433
        if (!isset($this->parentinstance)) {
            $this->parentinstance = false;
            if ($parent = $this->get_parent_metadata()) {
434
                $classname = generate_artefact_class_name($parent->artefacttype);
Penny Leach's avatar
Penny Leach committed
435
436
437
438
                $this->parentinstance = new $classname($parent->id, $parent);
            }
        }
        return $this->parentinstance;
439
    }
440

Aaron Wells's avatar
Aaron Wells committed
441
442
    /**
     * This function returns the db row
443
444
     * (if there is one) of the parent
     * artefact for this instance.
Aaron Wells's avatar
Aaron Wells committed
445
     * If you want the instance, use
446
     * {@link get_parent_instance} instead.
Aaron Wells's avatar
Aaron Wells committed
447
     *
448
     * @return object - db row
449
     */
450
    public function get_parent_metadata() {
451
452
453
        if (empty($this->parent)) {
            return false;
        }
454
        return get_record('artefact','id',$this->parent);
455
456
    }

457
458
459
    /**
     * Returns how much quota this artefact has used.
     *
Aaron Wells's avatar
Aaron Wells committed
460
     * It should try to not instantiate the artefact, because it is normally
461
462
463
464
465
466
467
468
     * called as part of an expensive cron job
     *
     * @return int Size in bytes that the artefact is taking up in quota
     */
    public static function get_quota_usage($artefact) {
        return 0;
    }

469
    public function get($field) {
470
        if (!property_exists($this, $field)) {
471
            throw new InvalidArgumentException("Field $field wasn't found in class " . get_class($this));
472
473
474
475
476
        }
        return $this->{$field};
    }

    public function set($field, $value) {
477
        if (property_exists($this, $field)) {
478
            if ($this->{$field} != $value) {
479
                // Only set it to dirty if it's changed.
480
                $this->dirty = true;
481
482
483
484
                // Set oldparent only if it has changed.
                if ($field == 'parent') {
                    $this->oldparent = $this->parent;
                }
485
            }
486
            $this->{$field} = $value;
487
488
489
490
491
492
            if ($field == 'mtime') {
                $this->mtimemanuallyset = true;
            }
            else if (!$this->mtimemanuallyset) {
                $this->mtime = time();
            }
493
494
            return true;
        }
495
        throw new InvalidArgumentException("Field $field wasn't found in class " . get_class($this));
496
    }
Aaron Wells's avatar
Aaron Wells committed
497

498
499
500
    /**
     * Artefact destructor. Calls commit and marks the
     * artefact cache as dirty if necessary.
501
502
503
     *
     * A special case is when the object has just been deleted.  In this case,
     * we do nothing.
504
     */
505
    public function __destruct() {
506
507
508
        if ($this->deleted) {
            return;
        }
Aaron Wells's avatar
Aaron Wells committed
509

510
        if (!empty($this->dirty) && !defined('MAHARA_CRASHING')) {
511
512
            $this->commit();
        }
513
    }
Aaron Wells's avatar
Aaron Wells committed
514
515

    /**
516
517
518
     * This method updates the contents of the artefact table only.  If your
     * artefact has extra information in other tables, you need to override
     * this method, and call parent::commit() in your own function.
519
     */
520
    public function commit() {
521
522
        static $last_source, $last_output;

523
524
525
        if (empty($this->dirty)) {
            return;
        }
526

527
528
529
530
        if (empty($this->author) && empty($this->authorname)) {
            $this->set_author();
        }

531
532
        db_begin();

533
        $fordb = new StdClass();
534
535
536
        foreach (get_object_vars($this) as $k => $v) {
            $fordb->{$k} = $v;
            if (in_array($k, array('mtime', 'ctime', 'atime')) && !empty($v)) {
537
538
539
540
541
                if ($v !== $last_source) {
                  $last_output = db_format_timestamp($v);
                  $last_source = $v;
                }
                $fordb->{$k} = $last_output;
542
543
544
545
            }
        }
        if (empty($this->id)) {
            $this->id = insert_record('artefact', $fordb, 'id', true);
Richard Mansfield's avatar
Richard Mansfield committed
546
547
548
            if ($this->can_be_logged()) {
                $this->log('created');
            }
549
            $this->add_hierarchy_path($this->parent);
550
551
        }
        else {
Richard Mansfield's avatar
Richard Mansfield committed
552
553
554
            if ($this->can_be_logged()) {
                $this->log('edited');
            }
555
            update_record('artefact', $fordb, 'id');
556
            $this->update_hierarchy_path($this->parent);
557
        }
558

Richard Mansfield's avatar
Richard Mansfield committed
559
560
561
562
        if (!empty($this->group)) {
            $this->save_rolepermissions();
        }

563
564
        delete_records('artefact_tag', 'artefact', $this->id);
        if (is_array($this->tags)) {
565
            $this->tags = check_case_sensitive($this->tags, 'artefact_tag');
Martyn Smith's avatar
Martyn Smith committed
566
            foreach (array_unique($this->tags) as $tag) {
567
568
569
                if (empty($tag)) {
                    continue;
                }
570
571
572
573
574
575
576
577
578
579
                insert_record(
                    'artefact_tag',
                    (object) array(
                        'artefact' => $this->id,
                        'tag'      => $tag,
                    )
                );
            }
        }

580
        artefact_watchlist_notification(array($this->id));
581

582
583
        handle_event('saveartefact', $this);

584
        $this->dirty = false;
585
        $this->deleted = false;
586
587

        db_commit();
588
589
    }

Aaron Wells's avatar
Aaron Wells committed
590
    /**
591
592
593
594
595
596
597
     * This function provides basic delete functionality.  It gets rid of the
     * artefact's row in the artefact table, and the tables that reference the
     * artefact table.  It also recursively deletes child artefacts.
     *
     * If your artefact has additional data in another table, you should
     * override this function, but you MUST call parent::delete() after you
     * have done your own thing.
598
     */
599
600
    public function delete() {
        if (empty($this->id)) {
601
            $this->dirty = false;
602
603
            return;
        }
Aaron Wells's avatar
Aaron Wells committed
604

605
        db_begin();
606

607
608
609
610
        // Call delete() on comments (if there are any)
        safe_require('artefact', 'comment');
        ArtefactTypeComment::delete_comments_onartefacts(array($this->id));

611
612
613
614
615
616
        // Call delete() on children (if there are any)
        if ($children = $this->get_children_instances()) {
            foreach ($children as $child) {
                $child->delete();
            }
        }
617

618
        artefact_watchlist_notification(array($this->id));
619

620
        self::_delete_dbrecords(array($this->id));
Richard Mansfield's avatar
Richard Mansfield committed
621
622
623
624

        if ($this->can_be_logged()) {
            $this->log('deleted');
        }
Aaron Wells's avatar
Aaron Wells committed
625

626
627
        handle_event('deleteartefact', $this);

628
        // Set flags.
629
        $this->dirty = false;
630
        $this->deleted = true;
631

632
        db_commit();
633
634
    }

635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
    /**
     * Does a bulk_delete on a list of artefacts, grouping artefacts of
     * the same type.
     *
     * Currently only tested for folders and their contents.
     */
    public static function delete_by_artefacttype($artefactids) {
        if (empty($artefactids)) {
            return;
        }

        db_begin();

        artefact_watchlist_notification($artefactids);

650
651
652
653
        // Delete comments first
        safe_require('artefact', 'comment');
        ArtefactTypeComment::delete_comments_onartefacts($artefactids);

654
655
        $records = get_records_select_assoc(
            'artefact',
656
            'id IN (' . join(',', array_map('intval', $artefactids)) . ')',
657
658
659
660
661
662
663
            null, 'artefacttype', 'id,parent,artefacttype,container'
        );

        $containers = array();
        $leaves = array();
        foreach ($records as $r) {
            if ($r->container) {
664
                $containers[$r->artefacttype][] = (int)$r->id;
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
            }
            else {
                $leaves[$r->artefacttype][] = $r->id;
            }
        }

        // Delete non-containers grouped by artefacttype
        foreach ($leaves as $artefacttype => $ids) {
            $classname = generate_artefact_class_name($artefacttype);
            call_static_method($classname, 'bulk_delete', $ids);
        }

        // Delete containers grouped by artefacttype
        foreach ($containers as $artefacttype => $ids) {
            $classname = generate_artefact_class_name($artefacttype);
680
681
682
            if (is_mysql()) {
                set_field_select('artefact', 'parent', null, 'id IN (' . join(',', $ids) . ')', array());
            }
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
            call_static_method($classname, 'bulk_delete', $ids);
        }

        handle_event('deleteartefacts', $artefactids);

        db_commit();
    }

    /**
     * Faster delete for multiple artefacts.
     *
     * Should only be called on artefacts with no children, after
     * additional data in other tables has already been deleted.
     */
    public static function bulk_delete($artefactids, $log=false) {
        db_begin();

        self::_delete_dbrecords($artefactids);

        // Logging must be triggered by the caller because it's
        // slow to go through each artefact and ask it if it should
        // be logged.
        if ($log) {
            global $USER;
            $entry = (object) array(
                'usr'      => $USER->get('id'),
                'time'     => db_format_timestamp(time()),
                'deleted'  => 1,
            );
            foreach ($artefactids as $id) {
                $entry->artefact = $id;
                insert_record('artefact_log', $entry);
            }
        }

        db_commit();
    }


    private static function _delete_dbrecords($artefactids) {
        if (empty($artefactids)) {
            return;
        }

727
        $idstr = '(' . join(',', array_map('intval', $artefactids)) . ')';
728
729
730

        db_begin();

731
        // Detach any files from this artefact
732
        delete_records_select('artefact_attachment', "artefact IN $idstr");
733

734
735
736
737
738
739
740
741
742
743
744
745
        // Make sure that the artefacts are removed from any view blockinstances
        if ($records = get_records_sql_array("
            SELECT va.block, va.artefact, bi.configdata
            FROM {view_artefact} va JOIN {block_instance} bi ON va.block = bi.id
            WHERE va.artefact IN $idstr", array())) {
            require_once(get_config('docroot') . 'blocktype/lib.php');
            BlockInstance::bulk_delete_artefacts($records);
        }
        delete_records_select('view_artefact', "artefact IN $idstr");
        delete_records_select('artefact_tag', "artefact IN $idstr");
        delete_records_select('artefact_access_role', "artefact IN $idstr");
        delete_records_select('artefact_access_usr', "artefact IN $idstr");
746
        execute_sql("UPDATE {usr} SET profileicon = NULL WHERE profileicon IN $idstr");
747
        execute_sql("UPDATE {institution} SET logo = NULL WHERE logo IN $idstr");
748
749
750
751
752
753

        delete_records_select('artefact', "id IN $idstr");

        db_commit();
    }

754
755
756
757
758
759
760
761
762
763
764
765
766
767
768

    /**
     * Initialise artefact author to either the artefact owner, the
     * logged-in user, or the system user.
     */
    private function set_author() {
        global $USER;
        if (isset($this->owner)) {
            $this->author = $this->owner;
        }
        else {
            $this->author = $USER->get('id');
        }
    }

769
770
771
772
773
774
775
776
777
778
    /**
     * By default users are notified of all feedback on artefacts
     * which they own.  Artefact types which want to allow this
     * notification to be turned off should redefine this function.
     */
    public function feedback_notify_owner() {
        return true;
    }


779
780
781
782
    /**
     * A dummy method, giving graceful output, if this method is not implemented in the relevant child class
     */
    public function render_self($options) {
783
784
        $smarty = smarty_core();
        $smarty->assign('title', $this->get('title'));
785
786
        $smarty->assign('owner', $this->get('owner'));
        $smarty->assign('tags', $this->get('tags'));
787
        $smarty->assign('description', $this->get('description'));
788
789
790
791
792
793
        if (!empty($options['details']) and get_config('licensemetadata')) {
            $smarty->assign('license', render_license($this));
        }
        else {
            $smarty->assign('license', false);
        }
794
795

        return array(
796
            'html' => $smarty->fetch('artefact.tpl'),
797
798
799
800
801
            'javascript'=>''
        );
    }


802
803
804
805
806
807
808
809
810
811
    // ******************** STATIC FUNCTIONS ******************** //

    public static function get_instances_by_userid($userid, $order, $offset, $limit) {
        // @todo
    }

    public static function get_metadata_by_userid($userid, $order, $offset, $limit) {
        // @todo
    }

812
813
814
815
816
817
818
819
    /**
    * Returns the printable name of this artefact
    * (used in lists and such)
    */
    public function get_name() {
        return $this->get('title');
    }

820
821
822
823
824
825
826
827
    /**
    * Should the artefact be linked to from the listing on my views?
    */
    public function in_view_list() {
        return true;
    }

    /**
Aaron Wells's avatar
Aaron Wells committed
828
    * Returns a short name for the artefact to be used in a list of artefacts in a view
829
830
831
    */
    public function display_title($maxlen=null) {
        if ($maxlen) {
832
            return str_shorten_text($this->get('title'), $maxlen, true);
833
834
835
836
        }
        return $this->get('title');
    }

837
838
839
840
841
842
843
    public function display_owner() {
        if ($owner = $this->get('owner')) {
            return display_name($owner);
        }
        if ($group = $this->get('group')) {
            return get_field('group', 'name', 'id', $group);
        }
844
845
846
847
848
849
        if ($institution = $this->get('institution')) {
            if ($institution == 'mahara') {
                return get_config('sitename');
            }
            return get_field('institution', 'displayname', 'name', $institution);
        }
850
851
852
853
        return null;
    }


854
855
856
857
    // ******************** HELPER FUNCTIONS ******************** //

    protected function get_artefact_type() {
        $classname = get_class($this);
Aaron Wells's avatar
Aaron Wells committed
858

859
860
        $type = strtolower(substr($classname, strlen('ArtefactType')));

861
        if (!artefact_type_installed($type)) {
862
863
864
865
866
            throw new InvalidArgumentException("Classname $classname not a valid artefact type");
        }

        return $type;
    }
867

868
    public function to_stdclass() {
Aaron Wells's avatar
Aaron Wells committed
869
       return (object)get_object_vars($this);
870
871
    }

872
873
874
875
876
877
878
879
880
881
882
    public static function has_config() {
        return false;
    }

    public static function get_config_options() {
        return array();
    }

    public static function collapse_config() {
        return false;
    }
Richard Mansfield's avatar
Richard Mansfield committed
883
884

    private function save_rolepermissions() {
885
        if (!$this->group) {
Richard Mansfield's avatar
Richard Mansfield committed
886
887
            return;
        }
888
        if (!isset($this->rolepermissions)) {
889
            $this->rolepermissions = group_get_default_artefact_permissions($this->group);
890
        }
Richard Mansfield's avatar
Richard Mansfield committed
891
892
893
        $id = $this->get('id');
        db_begin();
        delete_records('artefact_access_role', 'artefact', $id);
894
        foreach ($this->rolepermissions as $role => $permissions) {
Richard Mansfield's avatar
Richard Mansfield committed
895
896
897
            insert_record('artefact_access_role', (object) array(
                'artefact'      => $id,
                'role'          => $role,
898
899
900
                'can_view'      => (int) !empty($permissions->view),
                'can_edit'      => (int) !empty($permissions->edit),
                'can_republish' => (int) !empty($permissions->republish),
Richard Mansfield's avatar
Richard Mansfield committed
901
902
903
904
905
906
            ));
        }
        db_commit();
    }

    private function load_rolepermissions() {
907
908
909
        if (!$this->group) {
            return;
        }
Richard Mansfield's avatar
Richard Mansfield committed
910
911
        $records = get_records_array('artefact_access_role', 'artefact', $this->get('id'));
        if ($records) {
912
            $this->rolepermissions = array();
Richard Mansfield's avatar
Richard Mansfield committed
913
            foreach ($records as $r) {
914
                $this->rolepermissions[$r->role] = (object) array(
Richard Mansfield's avatar
Richard Mansfield committed
915
916
917
918
919
920
                    'view' => (bool) $r->can_view,
                    'edit' => (bool) $r->can_edit,
                    'republish' => (bool) $r->can_republish,
                );
            }
        }
921
        else {
922
            $this->rolepermissions = group_get_default_artefact_permissions($this->group);
923
        }
Richard Mansfield's avatar
Richard Mansfield committed
924
925
    }

926
927
928
929
    public function role_has_permission($role, $permission) {
        return $this->rolepermissions[$role]->{$permission};
    }

Richard Mansfield's avatar
Richard Mansfield committed
930
931
932
933
934
935
936
937
938
939
940
941
942
943
    public function copy_data() {
        $ignore = array(
            'dirty' => 1,
            'deleted' => 1,
            'id' => 1,
            'locked' => 1,
            'rolepermissions' => 1,
            'viewsinstances' => 1,
            'viewsmetadata' => 1,
            'childreninstances' => 1,
            'childrenmetadata' => 1,
            'parentinstance' => 1,
            'parentmetadata' => 1
        );
944
        $data = new StdClass;
Richard Mansfield's avatar
Richard Mansfield committed
945
        foreach (get_object_vars($this) as $k => $v) {
946
            if (in_array($k, array('atime', 'ctime', 'mtime'))) {
947
                $data->$k = db_format_timestamp($v);
948
949
            }
            else if (!isset($ignore[$k])) {
950
                $data->$k = $v;
Richard Mansfield's avatar
Richard Mansfield committed
951
952
953
954
955
956
957
958
959
960
            }
        }
        return $data;
    }

    public function copy_extra($new) {
    }

    public function copy_for_new_owner($user, $group, $institution) {
        $data = $this->copy_data();
961
962
963
964
965
966
967
        $data->owner = $user;
        $data->group = $group;
        $data->institution = $institution;
        $data->parent = null;
        $classname = generate_artefact_class_name($data->artefacttype);
        safe_require('artefact', get_field('artefact_installed_type', 'plugin', 'name', $data->artefacttype));
        $copy = new $classname(0, (object) $data);
Richard Mansfield's avatar
Richard Mansfield committed
968
        $this->copy_extra($copy);
969
        $copy->commit();
Richard Mansfield's avatar
Richard Mansfield committed
970
971
        return $copy->get('id');
    }
Richard Mansfield's avatar
Richard Mansfield committed
972

973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
    /**
     * Called after a view has been copied to rewrite all artefact
     * references in the new artefact (which still point to the
     * original artefacts) so that they also point to new artefacts
     * that were copied during the view copy.
     *
     * @param View $view The newly copied view
     * @param View $template The old view
     * @param array $artefactcopies The mapping between old artefact ids and new ones (created in blockinstance copy)
     * @param integer $oldid id of the artefact this artefact was copied from
     */
    public function update_artefact_references(&$view, &$template, &$artefactcopies, $oldid) {
        $copyinfo = $artefactcopies[$oldid];
        if (isset($artefactcopies[$copyinfo->oldparent])) {
            $this->set('parent', $artefactcopies[$copyinfo->oldparent]->newid);
        }
        else {
990
            $this->set('parent', $this->default_parent_for_copy($view, $template, array_map(create_function('$a', 'return $a->newid;'), $artefactcopies)));
991
992
993
        }
    }

994
    /**
Aaron Wells's avatar
Aaron Wells committed
995
     * Returns the ID of the artefact that should be the parent for copied
996
997
998
999
1000
1001
     * artefacts - e.g. the folder that files should be placed in.
     *
     * The $artefactstoignore is used to work around bug #3106
     *
     * @param View $view The new view being created by the copy
     * @param View $template The view being copied from
Aaron Wells's avatar
Aaron Wells committed
1002
1003
1004
1005
1006
1007
1008
1009
     * @param array $artefacttoignore A list of artefact IDs to ignore. In
     *                                particular, it's a list of artefact IDs
     *                                that have been created by a view being
     *                                copied. This is so we don't accidentally
     *                                try to use a new artefact as the parent
     *                                for all of the artefacts, else we can get
     *                                into a nasty infinite loop (e.g. when a
     *                                folder called 'viewfiles' is being
1010
1011
1012
     *                                copied).
     */
    public function default_parent_for_copy(&$view, &$template, $artefactstoignore) {
1013
1014
1015
        return null;
    }

Richard Mansfield's avatar
Richard Mansfield committed
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
    public function can_be_logged() {
        return false;
    }

    public function log($action) {
        global $USER;
        $entry = (object) array(
            'artefact' => $this->id,
            'usr'      => $USER->get('id'),
            'time'     => db_format_timestamp($this->mtime),
            $action    => 1,
        );
        if ($action == 'deleted') {
            insert_record('artefact_log', $entry);
            return;
        }
        $loggedfields = array('title', 'description', 'parent');
        if ($action == 'edited') {
            $old = get_record('artefact', 'id', $this->id);
            foreach ($loggedfields as $key) {
                if ($this->$key != $old->$key) {
                    $entry->$key = $this->$key;
                    $changed = true;
Aaron Wells's avatar
Aaron Wells committed
1039
                }
Richard Mansfield's avatar
Richard Mansfield committed
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
            }
            if (isset($changed)) {
                insert_record('artefact_log', $entry);
            }
        }
        if ($action == 'created') {
            foreach ($loggedfields as $key) {
                $entry->$key = $this->$key;
            }
            insert_record('artefact_log', $entry);
        }
    }
1052

1053
1054
1055
1056
1057
1058
1059
1060
    public function can_have_attachments() {
        return false;
    }

    public function count_attachments() {
        return count_records('artefact_attachment', 'artefact', $this->get('id'));
    }

1061
    public function attachment_id_list() {
1062
1063
1064
1065
1066
1067
1068
        // During view copying, attachment_id_list can get called on artefacts of any type; don't call
        // get_column here unless it might actually return something.
        if ($this->can_have_attachments()) {
            if ($list = get_column('artefact_attachment', 'attachment', 'artefact', $this->get('id'))) {
                return $list;
            }
        }
1069
1070
        return array();
    }
1071

1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
    public function attachment_id_list_with_item($itemid) {
        // If artefact attachment table has 'item' column utilised.
        if ($this->can_have_attachments()) {
            if ($list = get_column('artefact_attachment', 'attachment', 'artefact', $this->get('id'), 'item', $itemid)) {
                return $list;
            }
        }
        return array();
    }

1082
1083
1084
1085
    public function attachments_from_id_list($artefactids) {
        if (empty($artefactids)) {
            return array();
        }
1086
1087
1088
1089
1090
        // @todo: Join on artefact_file_files shouldn't happen below.
        // We could either assume all attachments are files and then
        // move all these attachment functions to the artefact file
        // plugin, or we could allow artefact plugins to add stuff
        // to this query.
1091
1092
        $attachments = get_records_sql_array('
            SELECT
1093
                aa.artefact, aa.attachment, a.artefacttype, a.title, a.description, f.size
1094
1095
            FROM {artefact_attachment} aa
                INNER JOIN {artefact} a ON aa.attachment = a.id
1096
                LEFT JOIN {artefact_file_files} f ON a.id = f.artefact
1097
            WHERE aa.artefact IN (' . join(', ', array_map('intval', $artefactids)) . ')', '');
1098
1099
1100
1101
1102
1103
        if (!$attachments) {
            return array();
        }
        return $attachments;
    }

1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
    public function tags_from_id_list($artefactids) {
        if (empty($artefactids)) {
            return array();
        }
        $artefactids = join(',', array_map('intval', $artefactids));
        $tags = get_records_select_array('artefact_tag', 'artefact IN (' . $artefactids . ')');
        if (!$tags) {
            return array();
        }
        return $tags;
    }

1116
    public function get_attachments($assoc=false) {
Aaron Wells's avatar
Aaron Wells committed
1117
        $list = get_records_sql_assoc('SELECT a.id, a.artefacttype, a.title, a.description
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
            FROM {artefact_attachment} aa
            INNER JOIN {artefact} a ON a.id = aa.attachment
            WHERE aa.artefact = ?
            ORDER BY a.title', array($this->id));

        // load tags
        if ($list) {
            $tags = get_records_select_array('artefact_tag', 'artefact IN (' . join(',', array_keys($list)) . ')');
            if ($tags) {
                foreach ($tags as $t) {
                    $list[$t->artefact]->tags[] = $t->tag;
                }
                foreach ($list as &$attachment) {
                    if (!empty($attachment->tags)) {
                        $attachment->tags = join(', ', $attachment->tags);
                    }
                }
            }
        }
1137
1138
1139
1140
1141
1142
1143
        else {
            return array();
        }

        if ($assoc) {          // Remove once tablerenderers are gone.
            return $list;
        }
1144
1145
1146
        return array_values($list);
    }

1147
    public function attach($attachmentid, $itemid=null) {
1148
1149
1150
        if (record_exists('artefact_attachment', 'artefact', $this->get('id'), 'attachment', $attachmentid)) {
            return;
        }
1151
1152
1153
        if (!record_exists('artefact', 'id', $attachmentid)) {
            throw new ArtefactNotFoundException(get_string('artefactnotfound', 'mahara', $attachmentid));
        }
1154
        $data = new StdClass();
1155
1156
        $data->artefact = $this->get('id');
        $data->attachment = $attachmentid;
1157
        $data->item = $itemid;
1158
1159
1160
1161
1162
1163
1164
1165
        insert_record('artefact_attachment', $data);
    }

    public function detach($attachmentid=null) {
        if (is_null($attachmentid)) {
            delete_records('artefact_attachment', 'artefact', $this->id);
            return;
        }
1166
1167
1168
        if (!record_exists('artefact', 'id', $attachmentid)) {
            throw new ArtefactNotFoundException(get_string('artefactnotfound', 'mahara', $attachmentid));
        }
1169
1170
1171
1172
1173
1174
1175
        delete_records('artefact_attachment', 'artefact', $this->get('id'), 'attachment', $attachmentid);
    }

    // Interface:
    public static function attached_id_list($attachmentid) {
        return get_column('artefact_attachment', 'artefact', 'attachment', $attachmentid);
    }
1176
1177
1178
1179

    public function exportable() {
        return true;
    }
1180
1181
1182
1183
1184
1185
1186

    // Update the locked field on a user's artefacts
    // Lock anything in a submitted view, and unlock anything that isn't
    public static function update_locked($userid) {
        if (empty($userid)) {
            return;
        }
1187
1188
1189
1190
1191
1192
1193
1194
        $submitted = get_column_sql('
            SELECT a.id
            FROM {artefact} a
                JOIN {view_artefact} va ON a.id = va.artefact
                JOIN {view} v ON va.view = v.id
            WHERE a.owner = ?
                AND v.owner = ?
                AND (v.submittedgroup IS NOT NULL OR v.submittedhost IS NOT NULL)',
1195
1196
            array($userid, $userid)
        );
1197
        if ($submitted) {
1198
1199
1200
1201
1202
1203
1204
            $submitted = artefact_get_descendants($submitted);
            if ($attachments = get_column_sql('
                SELECT attachment FROM {artefact_attachment}
                WHERE artefact IN (' . join(',', $submitted) . ')',
                array())) {
                $submitted = array_merge($submitted, $attachments);
            }
1205
1206
        }
        db_begin();
1207
1208
        if (!empty($submitted)) {
            $idstr = '(' . join(',', $submitted) . ')';
1209
1210
1211
1212
1213
1214
1215
1216
            set_field_select('artefact', 'locked', 1, "locked = 0 AND id IN $idstr", array());
        }
        // Unlock
        $select = 'locked = 1 AND "owner" = ?';
        if (isset($idstr)) {
            $select .= " AND NOT id IN $idstr";
        }
        set_field_select('artefact', 'locked', 0, $select, array($userid));
1217
1218
        db_commit();
    }
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236

    /**
     * Return an array of tags associated to an artefact
     *
     * @param int  ID of the artefact
     *
     * @return array of strings
     */
    public static function artefact_get_tags($id) {
        if (empty($id)) {
            return array();
        }
        $tags = get_column_sql('SELECT tag FROM {artefact_tag} WHERE artefact = ? ORDER BY tag', array($id));
        if (!$tags) {
            return array();
        }
        return $tags;
    }
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266

    /**
     * Checks to see if artefact type is allowed to be part of the progress bar.
     * By default all artefacts are included in progress bar. To remove an artefact
     * from being a progress bar option have your artefacttype return false for this.
     * @return boolean
     */
    public static function is_allowed_in_progressbar() {
        return true;
    }

    /**
     * Checks to see if artefact for the progress bar is countable.
     * By default all artefacts are counted as true/false (1 or 0). If you need to have
     * more then one instance counting towards progress, say image upload, you can specify
     * it to be countable. This will show a select box rather than a check box on the
     * progress admin screen.
     * @return boolean
     */
    public static function is_countable_progressbar() {
        return false;
    }

    /**
     * Check if artefacttype is meant to be handled as a meta artefact by progress bar
     * @return boolean
     */
    public static function is_metaartefact() {
        return false;
    }
1267
1268
1269
1270
1271
1272
1273
1274

    /**
     * The (optional) custom title of this artefact on the profile completion progress bar config page
     * @return mixed FALSE if it should just use the artefact type, a string otherwise
     */
    public static function get_title_progressbar() {
        return false;
    }
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365