lib.php 72.2 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


    /**
     * 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
     */
76
    public static function group_tabs($groupid, $role) {
77
78
        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

    /**
     * This function returns an array of menu items
     * to be displayed in the top right navigation menu
     *
     * See the function find_menu_children() in lib/web.php
     * for a description of the expected array structure.
     *
     * @return array
     */
    public static function right_nav_menu_items() {
        return array();
    }
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
200
201
202
203
204
205
206
207
208
209
210

    /**
     * This function returns an array of admin menu items
     * to be displayed
     *
     * See the function find_menu_children() in lib/web.php
     * for a description of the expected array structure.
     *
     * @return array
     */
    public static function admin_menu_items() {
        return array();
    }

    /**
     * This function returns an array of institution menu items
     * to be displayed
     *
     * See the function find_menu_children() in lib/web.php
     * for a description of the expected array structure.
     *
     * @return array
     */
    public static function institution_menu_items() {
        return array();
    }

    /**
     * This function returns an array of institution staff menu items
     * to be displayed
     *
     * See the function find_menu_children() in lib/web.php
     * for a description of the expected array structure.
     *
     * @return array
     */
    public static function institution_staff_menu_items() {
        return array();
    }
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
240
241
242
243
244
245
246
247
248
249
250
251
/**
 * 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
252
/**
253
254
255
 * Base artefact type class
 * @abstract
 */
256
abstract class ArtefactType implements IArtefactType {
257

258
    protected $dirty;
259
    protected $deleted = false;
260
    protected $id;
261
262
    protected $artefacttype;
    protected $owner;
263
    protected $container = 0;
264
    protected $parent;
265
    protected $oldparent;
266
267
    protected $ctime;
    protected $mtime;
268
    protected $atime;
269
    protected $locked = 0;
270
271
272
    protected $title;
    protected $description;
    protected $note;
273
    protected $tags = array();
274
    protected $institution;
275
    protected $group;
276
277
    protected $author;
    protected $authorname;
278
279
    protected $allowcomments = 0;
    protected $approvecomments = 0;
Richard Mansfield's avatar
Richard Mansfield committed
280
    protected $rolepermissions;
281
    protected $mtimemanuallyset;
282
283
284
    protected $license;
    protected $licensor;
    protected $licensorurl;
285
    protected $path;
286

Penny Leach's avatar
Penny Leach committed
287
288
289
290
291
292
293
    protected $viewsinstances;
    protected $viewsmetadata;
    protected $childreninstances;
    protected $childrenmetadata;
    protected $parentinstance;
    protected $parentmetadata;

294
295
    /**
     * Constructor.
296
297
298
     * 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
299
300
301
302
303
304
305
     * artefact, ready to be filled up.
     * If the $new parameter is true, we can skip the query
     * because we know the artefact is new.
     *
     * @param int   $id     artefact.id
     * @param mixed $data   optional data supplied for artefact
     * @param bool  $new
306
     */
307
    public function __construct($id=0, $data=null, $new = FALSE) {
308
        if (!empty($id)) {
Penny Leach's avatar
Penny Leach committed
309
310
            if (empty($data)) {
                if (!$data = get_record('artefact','id',$id)) {
311
                    throw new ArtefactNotFoundException(get_string('artefactnotfound', 'error', $id));
Penny Leach's avatar
Penny Leach committed
312
                }
313
            }
314
            $this->id = $id;
315
316
        }
        else {
317
318
            $this->ctime = $this->mtime = time();
            $this->dirty = true;
319
        }
320
321
322
323
324
        if (empty($data)) {
            $data = array();
        }
        foreach ((array)$data as $field => $value) {
            if (property_exists($this, $field)) {
325
                if (in_array($field, array('atime', 'ctime', 'mtime'))) {
326
327
328
                    if (!(!empty($value) && is_string($value) && $value = strtotime($value))) {
                        $value = time();
                    }
Aaron Wells's avatar
Aaron Wells committed
329
                }
Richard Mansfield's avatar
Richard Mansfield committed
330
                if ($field == 'tags' && !is_array($value)) {
331
332
                    $value = preg_split("/\s*,\s*/", trim($value));
                }
333
334
335
336
                $this->{$field} = $value;
            }
        }

337
338
339
340
        if (!empty($this->parent)) {
            $this->oldparent = $this->parent;
        }

341
342
343
344
345
346
347
        $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));
            }
        }

348
349
        // load tags
        if ($this->id) {
350
            $this->tags = ArtefactType::artefact_get_tags($this->id);
351
352
        }

Richard Mansfield's avatar
Richard Mansfield committed
353
        // load group permissions
354
        if ($this->group && !is_array($this->rolepermissions)) {
Richard Mansfield's avatar
Richard Mansfield committed
355
356
357
            $this->load_rolepermissions();
        }

358
        $this->atime = time();
359
360
    }

361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
    /**
     * 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']);
    }

402
403
404
405
406
    /**
     * Returns the instances of all views where this artefact is used.
     *
     * @return array Array of view instances.
     */
407
    public function get_views_instances() {
408
409
410
411
412
        // @todo test this
        if (!isset($this->viewsinstances)) {
            $this->viewsinstances = false;
            if ($views = $this->get_views_metadata()) {
                $this->viewsinstances = array();
413
414
415
                if (!class_exists('View')) {
                    require_once(get_config('libroot') . 'view.php');
                }
416
                foreach ($views as $view) {
417
                    $this->viewsinstances[] = new View($view->view);
418
419
420
421
                }
            }
        }
        return $this->viewsinstances;
422
    }
423

424
    public function get_views_metadata() {
425
426
427
428
        if (!isset($this->viewsmetadata)) {
            $this->viewsmetadata = get_records_array('view_artefact', 'artefact', $this->id);
        }
        return $this->viewsmetadata;
429
430
    }

Richard Mansfield's avatar
Richard Mansfield committed
431
432
433
434
    public function count_children() {
        return count_records('artefact', 'parent', $this->get('id'));
    }

435
436
437
438
439
440
441
    public function has_children() {
        if ($this->get_children_metadata()) {
            return true;
        }
        return false;
    }

442
    public function get_plugin_name() {
443
444
445
446
447
448
449
450
        static $cache = array();

        $type = $this->get('artefacttype');
        if (!isset($cache[$type])) {
            $cache[$type] = get_field('artefact_installed_type', 'plugin', 'name', $type);
        }

        return $cache[$type];
451
452
    }

Aaron Wells's avatar
Aaron Wells committed
453
454
    /**
     * This function returns the instances
Penny Leach's avatar
Penny Leach committed
455
     * of all children of this artefact
Aaron Wells's avatar
Aaron Wells committed
456
     * If you just want the basic info,
Penny Leach's avatar
Penny Leach committed
457
     * use {@link get_children_metadata} instead.
Aaron Wells's avatar
Aaron Wells committed
458
     *
459
     * @return array of instances or false if no children.
Penny Leach's avatar
Penny Leach committed
460
     */
461
    public function get_children_instances() {
Penny Leach's avatar
Penny Leach committed
462
463
464
465
466
        if (!isset($this->childreninstances)) {
            $this->childreninstances = false;
            if ($children = $this->get_children_metadata()) {
                $this->childreninstances = array();
                foreach ($children as $child) {
467
                    $classname = generate_artefact_class_name($child->artefacttype);
Penny Leach's avatar
Penny Leach committed
468
469
470
471
472
473
                    $instance = new $classname($child->id, $child);
                    $this->childreninstances[] = $instance;
                }
            }
        }
        return $this->childreninstances;
474
475
    }

476
    /**
Aaron Wells's avatar
Aaron Wells committed
477
478
     * This function returns the db rows
     * from the artefact table that have this
479
480
481
     * 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
482
     *
483
     * @return array of false if no children
484
     */
485
    public function get_children_metadata() {
Penny Leach's avatar
Penny Leach committed
486
        if (!isset($this->childrenmetadata)) {
487
            $this->childrenmetadata = get_records_array('artefact', 'parent', $this->id);
Penny Leach's avatar
Penny Leach committed
488
489
        }
        return $this->childrenmetadata;
490
    }
Penny Leach's avatar
Penny Leach committed
491
492
493
494
495
496
497
498
499

    /**
     * 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
     */
500
    public function get_parent_instance() {
Penny Leach's avatar
Penny Leach committed
501
502
503
        if (!isset($this->parentinstance)) {
            $this->parentinstance = false;
            if ($parent = $this->get_parent_metadata()) {
504
                $classname = generate_artefact_class_name($parent->artefacttype);
Penny Leach's avatar
Penny Leach committed
505
506
507
508
                $this->parentinstance = new $classname($parent->id, $parent);
            }
        }
        return $this->parentinstance;
509
    }
510

Aaron Wells's avatar
Aaron Wells committed
511
512
    /**
     * This function returns the db row
513
514
     * (if there is one) of the parent
     * artefact for this instance.
Aaron Wells's avatar
Aaron Wells committed
515
     * If you want the instance, use
516
     * {@link get_parent_instance} instead.
Aaron Wells's avatar
Aaron Wells committed
517
     *
518
     * @return object - db row
519
     */
520
    public function get_parent_metadata() {
521
522
523
        if (empty($this->parent)) {
            return false;
        }
524
        return get_record('artefact','id',$this->parent);
525
526
    }

527
528
529
    /**
     * Returns how much quota this artefact has used.
     *
Aaron Wells's avatar
Aaron Wells committed
530
     * It should try to not instantiate the artefact, because it is normally
531
532
533
534
535
536
537
538
     * 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;
    }

539
    public function get($field) {
540
        if (!property_exists($this, $field)) {
541
            throw new InvalidArgumentException("Field $field wasn't found in class " . get_class($this));
542
543
544
545
546
        }
        return $this->{$field};
    }

    public function set($field, $value) {
547
        if (property_exists($this, $field)) {
548
            if ($this->{$field} != $value) {
549
                // Only set it to dirty if it's changed.
550
                $this->dirty = true;
551
552
553
554
                // Set oldparent only if it has changed.
                if ($field == 'parent') {
                    $this->oldparent = $this->parent;
                }
555
            }
556
            $this->{$field} = $value;
557
558
559
560
561
562
            if ($field == 'mtime') {
                $this->mtimemanuallyset = true;
            }
            else if (!$this->mtimemanuallyset) {
                $this->mtime = time();
            }
563
564
            return true;
        }
565
        throw new InvalidArgumentException("Field $field wasn't found in class " . get_class($this));
566
    }
Aaron Wells's avatar
Aaron Wells committed
567

568
569
570
    /**
     * Artefact destructor. Calls commit and marks the
     * artefact cache as dirty if necessary.
571
572
573
     *
     * A special case is when the object has just been deleted.  In this case,
     * we do nothing.
574
     */
575
    public function __destruct() {
576
577
578
        if ($this->deleted) {
            return;
        }
Aaron Wells's avatar
Aaron Wells committed
579

580
        if (!empty($this->dirty) && !defined('MAHARA_CRASHING')) {
581
582
            $this->commit();
        }
583
    }
Aaron Wells's avatar
Aaron Wells committed
584
585

    /**
586
587
588
     * 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.
589
     */
590
    public function commit() {
591
592
        static $last_source, $last_output;

593
594
        $is_new = false;

595
596
597
        if (empty($this->dirty)) {
            return;
        }
598

599
600
601
602
        if (empty($this->author) && empty($this->authorname)) {
            $this->set_author();
        }

603
604
        db_begin();

605
        $fordb = new StdClass();
606
607
608
        foreach (get_object_vars($this) as $k => $v) {
            $fordb->{$k} = $v;
            if (in_array($k, array('mtime', 'ctime', 'atime')) && !empty($v)) {
609
610
611
612
613
                if ($v !== $last_source) {
                  $last_output = db_format_timestamp($v);
                  $last_source = $v;
                }
                $fordb->{$k} = $last_output;
614
615
616
            }
        }
        if (empty($this->id)) {
617
            $is_new = true;
618
            $this->id = insert_record('artefact', $fordb, 'id', true);
Richard Mansfield's avatar
Richard Mansfield committed
619
620
621
            if ($this->can_be_logged()) {
                $this->log('created');
            }
622
            $this->add_hierarchy_path($this->parent);
623
624
        }
        else {
Richard Mansfield's avatar
Richard Mansfield committed
625
626
627
            if ($this->can_be_logged()) {
                $this->log('edited');
            }
628
            update_record('artefact', $fordb, 'id');
629
            $this->update_hierarchy_path($this->parent);
630
        }
631

Richard Mansfield's avatar
Richard Mansfield committed
632
633
634
635
        if (!empty($this->group)) {
            $this->save_rolepermissions();
        }

636
637
638
639
        if (!$is_new) {
          $deleted = delete_records('artefact_tag', 'artefact', $this->id);
        }

640
        if (is_array($this->tags)) {
641
            $this->tags = check_case_sensitive($this->tags, 'artefact_tag');
Martyn Smith's avatar
Martyn Smith committed
642
            foreach (array_unique($this->tags) as $tag) {
643
644
645
                if (empty($tag)) {
                    continue;
                }
646
647
648
649
650
651
652
653
654
655
                insert_record(
                    'artefact_tag',
                    (object) array(
                        'artefact' => $this->id,
                        'tag'      => $tag,
                    )
                );
            }
        }

656
        $this->postcommit_hook($is_new);
657

658
659
        handle_event('saveartefact', $this);

660
        $this->dirty = false;
661
        $this->deleted = false;
662
663

        db_commit();
664
665
    }

666
667
668
669
670
671
672
673
674
675
676
677
    /**
     * A hook method called immediately after the basic data is save in the commit() method,
     * but before the DB transaction is closed and before the saveartefact event is triggered.
     *
     * Child classes may use this to alter data or add data into additional tables so that
     * it's present when the saveartefact event is called.
     *
     * @param boolean $new True if the artefact has just been created
     */
    protected function postcommit_hook($new) {
    }

Aaron Wells's avatar
Aaron Wells committed
678
    /**
679
680
681
682
683
684
685
     * 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.
686
     */
687
688
    public function delete() {
        if (empty($this->id)) {
689
            $this->dirty = false;
690
691
            return;
        }
Aaron Wells's avatar
Aaron Wells committed
692

693
        db_begin();
694

695
696
697
698
        // Call delete() on comments (if there are any)
        safe_require('artefact', 'comment');
        ArtefactTypeComment::delete_comments_onartefacts(array($this->id));

699
700
701
702
703
704
        // Call delete() on children (if there are any)
        if ($children = $this->get_children_instances()) {
            foreach ($children as $child) {
                $child->delete();
            }
        }
705

706
        artefact_watchlist_notification(array($this->id));
707

708
        self::_delete_dbrecords(array($this->id));
Richard Mansfield's avatar
Richard Mansfield committed
709
710
711
712

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

714
715
716
717
718
719
        $ignorefields = array(
            'dirty', 'deleted', 'mtime', 'atime',
            'tags', 'allowcomments', 'approvecomments', 'path'
        );

        handle_event('deleteartefact', $this, $ignorefields);
720

721
        // Set flags.
722
        $this->dirty = false;
723
        $this->deleted = true;
724

725
        db_commit();
726
727
    }

728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
    /**
     * 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);

743
744
745
746
        // Delete comments first
        safe_require('artefact', 'comment');
        ArtefactTypeComment::delete_comments_onartefacts($artefactids);

747
748
749
750
751
752
        $sql = 'SELECT a.id, a.parent, a.artefacttype, a.container, i.plugin
                FROM {artefact} a
                JOIN {artefact_installed_type} i ON a.artefacttype = i.name
                WHERE a.id IN (' . join(',', array_fill(0, count($artefactids), '?')) . ')'.
                ' ORDER BY artefacttype';
        $records = get_records_sql_assoc($sql, $artefactids);
753
754
755
756

        $containers = array();
        $leaves = array();
        foreach ($records as $r) {
757
            safe_require('artefact', $r->plugin);
758
            if ($r->container) {
759
                $containers[$r->artefacttype][] = (int)$r->id;
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
            }
            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);
775
776
777
            if (is_mysql()) {
                set_field_select('artefact', 'parent', null, 'id IN (' . join(',', $ids) . ')', array());
            }
778
779
            call_static_method($classname, 'bulk_delete', $ids);
        }
780
781
        $logdata = array_merge($containers, $leaves);
        handle_event('deleteartefacts', $logdata);
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821

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

822
        $idstr = '(' . join(',', array_map('intval', $artefactids)) . ')';
823
824
825

        db_begin();

826
        // Detach any files from this artefact
827
        delete_records_select('artefact_attachment', "artefact IN $idstr");
828

829
        // Make sure that the artefacts are removed from any view blockinstances
830
831
832
        require_once(get_config('docroot') . 'blocktype/lib.php');
        BlockInstance::bulk_remove_artefacts($artefactids);

833
834
835
836
        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");
837
        execute_sql("UPDATE {usr} SET profileicon = NULL WHERE profileicon IN $idstr");
838
        execute_sql("UPDATE {institution} SET logo = NULL WHERE logo IN $idstr");
839

840
841
842
        // Delete any references to files embedded in textboxes
        delete_records_select('artefact_file_embedded', "fileid IN $idstr");

843
844
845
846
847
        delete_records_select('artefact', "id IN $idstr");

        db_commit();
    }

848
849
850
851
852
853
854
855
856
857
858
859
860
861
862

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

863
    /**
864
     * By default users are notified of all comments on artefacts
865
866
867
868
869
870
871
872
     * 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;
    }


873
874
875
876
    /**
     * A dummy method, giving graceful output, if this method is not implemented in the relevant child class
     */
    public function render_self($options) {
877
878
        $smarty = smarty_core();
        $smarty->assign('title', $this->get('title'));
879
880
        $smarty->assign('owner', $this->get('owner'));
        $smarty->assign('tags', $this->get('tags'));
881
        $smarty->assign('description', $this->get('description'));
882
883
884
885
886
887
        if (!empty($options['details']) and get_config('licensemetadata')) {
            $smarty->assign('license', render_license($this));
        }
        else {
            $smarty->assign('license', false);
        }
888
        $smarty->assign('view', (!empty($options['viewid']) ? $options['viewid'] : null));
889
        return array(
890
            'html' => $smarty->fetch('artefact.tpl'),
891
892
893
894
895
            'javascript'=>''
        );
    }


896
897
898
899
900
901
902
903
904
905
    // ******************** 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
    }

906
907
908
909
910
911
912
913
    /**
    * Returns the printable name of this artefact
    * (used in lists and such)
    */
    public function get_name() {
        return $this->get('title');
    }

914
915
916
917
918
919
920
921
    /**
    * 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
922
    * Returns a short name for the artefact to be used in a list of artefacts in a view
923
924
925
    */
    public function display_title($maxlen=null) {
        if ($maxlen) {
926
            return str_shorten_text($this->get('title'), $maxlen, true);
927
928
929
930
        }
        return $this->get('title');
    }

931
932
933
934
935
936
937
    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);
        }
938
939
940
941
942
943
        if ($institution = $this->get('institution')) {
            if ($institution == 'mahara') {
                return get_config('sitename');
            }
            return get_field('institution', 'displayname', 'name', $institution);
        }
944
945
946
947
        return null;
    }


948
949
950
951
    // ******************** HELPER FUNCTIONS ******************** //

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

953
954
        $type = strtolower(substr($classname, strlen('ArtefactType')));

955
        if (!artefact_type_installed($type)) {
956
957
958
959
960
            throw new InvalidArgumentException("Classname $classname not a valid artefact type");
        }

        return $type;
    }
961

962
    public function to_stdclass() {
Aaron Wells's avatar
Aaron Wells committed
963
       return (object)get_object_vars($this);
964
965
    }

966
967
968
969
970
971
972
973
974
975
976
    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
977
978

    private function save_rolepermissions() {
979
        if (!$this->group) {
Richard Mansfield's avatar
Richard Mansfield committed
980
981
            return;
        }
982
        if (!isset($this->rolepermissions)) {
983
            $this->rolepermissions = group_get_default_artefact_permissions($this->group);
984
        }
Richard Mansfield's avatar
Richard Mansfield committed
985
986
987
        $id = $this->get('id');
        db_begin();
        delete_records('artefact_access_role', 'artefact', $id);
988
        foreach ($this->rolepermissions as $role => $permissions) {
Richard Mansfield's avatar
Richard Mansfield committed
989
990
991
            insert_record('artefact_access_role', (object) array(
                'artefact'      => $id,
                'role'          => $role,
992
993
994
                '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
995
996
997
998
999
1000
            ));
        }
        db_commit();
    }

    private function load_rolepermissions() {
1001
1002
1003
        if (!$this->group) {
            return;
        }
Richard Mansfield's avatar
Richard Mansfield committed
1004
1005
        $records = get_records_array('artefact_access_role', 'artefact', $this->get('id'));
        if ($records) {
1006
            $this->rolepermissions = array();
Richard Mansfield's avatar
Richard Mansfield committed
1007
            foreach ($records as $r) {
1008
                $this->rolepermissions[$r->role] = (object) array(
Richard Mansfield's avatar
Richard Mansfield committed
1009
1010
1011
1012
1013
1014
                    'view' => (bool) $r->can_view,
                    'edit' => (bool) $r->can_edit,
                    'republish' => (bool) $r->can_republish,
                );
            }
        }
1015
        else {
1016
            $this->rolepermissions = group_get_default_artefact_permissions($this->group);
1017
        }
Richard Mansfield's avatar
Richard Mansfield committed
1018
1019
    }

1020
1021
1022
1023
    public function role_has_permission($role, $permission) {
        return $this->rolepermissions[$role]->{$permission};
    }

Richard Mansfield's avatar
Richard Mansfield committed
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
    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,
1036
1037
            'parentmetadata' => 1,
            'path' => 1    // the path value will be updated later
Richard Mansfield's avatar
Richard Mansfield committed
1038
        );
1039
        $data = new StdClass;
Richard Mansfield's avatar
Richard Mansfield committed
1040
        foreach (get_object_vars($this) as $k => $v) {
1041
            if (in_array($k, array('atime', 'ctime', 'mtime'))) {
1042
                $data->$k = db_format_timestamp($v);
1043
1044
            }
            else if (!isset($ignore[$k])) {
1045
                $data->$k = $v;
Richard Mansfield's avatar
Richard Mansfield committed
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
            }
        }
        return $data;
    }

    public function copy_extra($new) {
    }

    public function copy_for_new_owner($user, $group, $institution) {
        $data = $this->copy_data();
1056
1057
1058
1059
1060
1061
1062
        $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
1063
        $this->copy_extra($copy);
1064
        $copy->commit();
Richard Mansfield's avatar
Richard Mansfield committed
1065
1066
        return $copy->get('id');
    }
Richard Mansfield's avatar
Richard Mansfield committed
1067

1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
    /**
     * 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 {
1085
            $this->set('parent', $this->default_parent_for_copy($view, $template, array_map(create_function('$a', 'return $a->newid;'), $artefactcopies)));
1086
1087
1088
        }
    }

1089
    /**
Aaron Wells's avatar
Aaron Wells committed
1090
     * Returns the ID of the artefact that should be the parent for copied
1091
1092
1093
1094
1095
1096
     * 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
1097
1098
1099
1100
1101
1102
1103
1104
     * @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
1105
1106
1107
     *                                copied).
     */
    public function default_parent_for_copy(&$view, &$template, $artefactstoignore) {
1108
1109
1110
        return null;
    }

Richard Mansfield's avatar
Richard Mansfield committed
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
    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
1134
                }
Richard Mansfield's avatar
Richard Mansfield committed
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
            }
            if (isset($changed)) {
                insert_record('artefact_log', $entry);
            }
        }
        if ($action == 'created') {
            foreach ($loggedfields as $key) {
                $entry->$key = $this->$key;
            }
            insert_record('artefact_log', $entry);
        }
    }
1147

1148
1149
1150
1151
1152
1153
1154
1155
    public function can_have_attachments() {
        return false;
    }

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

1156
    public function attachment_id_list() {
1157
1158
1159
1160
1161
1162
1163
        // 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;
            }
        }
1164
1165
        return array();
    }
1166

1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
/**
 * Returns a list of embedded image artefact ids
 * This function is called when copying a view
 *
 * @return array
 */
    public function embed_id_list() {
        if ($this->can_have_attachments()) {
            if ($list = get_column('artefact_file_embedded', 'fileid', 'resourceid', $this->get('id'))) {
                return $list;
            }
        }
        return array();
    }

1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
    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();
    }

1192
1193
1194
1195
    public function attachments_from_id_list($artefactids) {
        if (empty($artefactids)) {
            return array();
        }
1196
1197
1198
1199
1200
        // @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.
1201
1202
        $attachments = get_records_sql_array('
            SELECT
1203
                aa.artefact, aa.attachment, a.artefacttype, a.title, a.description, f.size
1204
1205
            FROM {artefact_attachment} aa
                INNER JOIN {artefact} a ON aa.attachment = a.id
1206
                LEFT JOIN {artefact_file_files} f ON a.id = f.artefact
1207
            WHERE aa.artefact IN (' . join(', ', array_map('intval', $artefactids)) . ')', array());
1208
1209
1210
1211
1212
1213
        if (!$attachments) {
            return array();
        }
        return $attachments;
    }

1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
    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;
    }

1226
    public function get_attachments($assoc=false) {
Aaron Wells's avatar
Aaron Wells committed
1227
        $list = get_records_sql_assoc('SELECT a.id, a.artefacttype, a.title, a.description
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
            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);
                    }
                }
            }
        }
1247
1248
1249
1250
1251
1252
1253
        else {
            return array();
        }

        if ($assoc) {          // Remove once tablerenderers are gone.
            return $list;
        }
1254
1255
1256
        return array_values($list);
    }

1257
    public function attach($attachmentid, $itemid=null) {
1258
1259
1260
        if (record_exists('artefact_attachment', 'artefact', $this->get('id'), 'attachment', $attachmentid)) {
            return;
        }
1261
1262
1263
        if (!record_exists('artefact', 'id', $attachmentid)) {
            throw new ArtefactNotFoundException(get_string('artefactnotfound', 'mahara', $attachmentid));
        }
1264
        $data = new StdClass();
1265
1266
        $data->artefact = $this->get('id');
        $data->attachment = $attachmentid;