-
Notifications
You must be signed in to change notification settings - Fork 0
/
lib.php
1504 lines (1331 loc) · 50.3 KB
/
lib.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
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
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
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
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
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
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* Mahara: Electronic portfolio, weblog, resume builder and social networking
* Copyright (C) 2006-2009 Catalyst IT Ltd and others; see:
* http://wiki.mahara.org/Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @package mahara
* @subpackage artefact
* @author Catalyst IT Ltd
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL
* @copyright (C) 2006-2009 Catalyst IT Ltd http://catalyst.net.nz
*
*/
defined('INTERNAL') || die();
/**
* Base artefact plugin class
* @abstract
*/
abstract class PluginArtefact extends Plugin {
/**
* This function returns a list of classnames
* of artefact types this plugin provides.
* @abstract
* @return array
*/
public static abstract function get_artefact_types();
/**
* This function returns a list of classnames
* of block types this plugin provides
* they must match directories inside artefact/$name/blocktype
* @abstract
* @return array
*/
public static abstract function get_block_types();
/**
* This function returns the name of the plugin.
* @abstract
* @return string
*/
public static abstract function get_plugin_name();
/**
* This function returns an array of menu items
* to be displayed
* Each item should be a StdClass object containing -
* - name language pack key
* - url relative to wwwroot
* @return array
*/
public static function menu_items() {
return array();
}
/**
* 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();
}
/**
* 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();
}
/**
* When filtering searches, some artefact types are classified the same way
* even when they come from different artefact plugins. This function allows
* artefact plugins to declare which search filter content type each of their
* artefact types belong to.
* @return array of artefacttype => array of filter content types
*/
public static function get_artefact_type_content_types() {
return array();
}
}
/**
* Base artefact type class
* @abstract
*/
abstract class ArtefactType {
protected $dirty;
protected $parentdirty;
protected $deleted = false;
protected $id;
protected $artefacttype;
protected $owner;
protected $container;
protected $parent;
protected $ctime;
protected $mtime;
protected $atime;
protected $locked;
protected $title;
protected $description;
protected $note;
protected $tags = array();
protected $institution;
protected $group;
protected $author;
protected $authorname;
protected $allowcomments;
protected $approvecomments;
protected $rolepermissions;
protected $mtimemanuallyset;
protected $viewsinstances;
protected $viewsmetadata;
protected $childreninstances;
protected $childrenmetadata;
protected $parentinstance;
protected $parentmetadata;
/**
* Constructer.
* 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
*/
public function __construct($id=0, $data=null) {
if (!empty($id)) {
if (empty($data)) {
if (!$data = get_record('artefact','id',$id)) {
throw new ArtefactNotFoundException(get_string('artefactnotfound', 'error', $id));
}
}
$this->id = $id;
}
else {
$this->ctime = $this->mtime = time();
$this->dirty = true;
}
if (empty($data)) {
$data = array();
}
foreach ((array)$data as $field => $value) {
if (property_exists($this, $field)) {
if (in_array($field, array('atime', 'ctime', 'mtime'))) {
$value = strtotime($value);
}
if ($field == 'tags' && !is_array($value)) {
$value = preg_split("/\s*,\s*/", trim($value));
}
$this->{$field} = $value;
}
}
$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));
}
}
// load tags
if ($this->id) {
$tags = get_column('artefact_tag', 'tag', 'artefact', $this->id);
if (is_array($tags)) {
$this->tags = $tags;
}
}
// load group permissions
if ($this->group && !is_array($this->rolepermissions)) {
$this->load_rolepermissions();
}
$this->atime = time();
}
public function get_views_instances() {
// @todo test this
if (!isset($this->viewsinstances)) {
$this->viewsinstances = false;
if ($views = $this->get_views_metadata()) {
$this->viewsinstances = array();
foreach ($views as $view) {
$this->viewsinstances[] = new View($view->id, $view);
}
}
}
return $this->viewsinstances;
}
public function get_views_metadata() {
if (!isset($this->viewsmetadata)) {
$this->viewsmetadata = get_records_array('view_artefact', 'artefact', $this->id);
}
return $this->viewsmetadata;
}
public function count_children() {
return count_records('artefact', 'parent', $this->get('id'));
}
public function has_children() {
if ($this->get_children_metadata()) {
return true;
}
return false;
}
public function get_plugin_name() {
return get_field('artefact_installed_type', 'plugin', 'name', $this->get('artefacttype'));
}
/**
* This function returns the instances
* of all children of this artefact
* If you just want the basic info,
* use {@link get_children_metadata} instead.
*
* @return array of instances.
*/
public function get_children_instances() {
if (!isset($this->childreninstances)) {
$this->childreninstances = false;
if ($children = $this->get_children_metadata()) {
$this->childreninstances = array();
foreach ($children as $child) {
$classname = generate_artefact_class_name($child->artefacttype);
$instance = new $classname($child->id, $child);
$this->childreninstances[] = $instance;
}
}
}
return $this->childreninstances;
}
/**
* This function returns the db rows
* from the artefact table that have this
* artefact as the parent.
* If you want instances, use {@link get_children_instances}
* but bear in mind this will have a performance impact.
*
* @return array
*/
public function get_children_metadata() {
if (!isset($this->childrenmetadata)) {
$this->childrenmetadata = get_records_array('artefact', 'parent', $this->id);
}
return $this->childrenmetadata;
}
/**
* 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
*/
public function get_parent_instance() {
if (!isset($this->parentinstance)) {
$this->parentinstance = false;
if ($parent = $this->get_parent_metadata()) {
$classname = generate_artefact_class_name($parent->artefacttype);
$this->parentinstance = new $classname($parent->id, $parent);
}
}
return $this->parentinstance;
}
/**
* This function returns the db row
* (if there is one) of the parent
* artefact for this instance.
* If you want the instance, use
* {@link get_parent_instance} instead.
*
* @return object - db row
*/
public function get_parent_metadata() {
if (empty($this->parent)) {
return false;
}
return get_record('artefact','id',$this->parent);
}
/**
* Returns how much quota this artefact has used.
*
* It should try to not instantiate the artefact, because it is normally
* 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;
}
public function get($field) {
if (!property_exists($this, $field)) {
throw new InvalidArgumentException("Field $field wasn't found in class " . get_class($this));
}
return $this->{$field};
}
public function set($field, $value) {
if (property_exists($this, $field)) {
if ($this->{$field} != $value) {
// only set it to dirty if it's changed
$this->dirty = true;
}
$this->{$field} = $value;
if ($field == 'parent') {
$this->parentdirty = true;
}
if ($field == 'mtime') {
$this->mtimemanuallyset = true;
}
else if (!$this->mtimemanuallyset) {
$this->mtime = time();
}
return true;
}
throw new InvalidArgumentException("Field $field wasn't found in class " . get_class($this));
}
/**
* Artefact destructor. Calls commit and marks the
* artefact cache as dirty if necessary.
*
* A special case is when the object has just been deleted. In this case,
* we do nothing.
*/
public function __destruct() {
if ($this->deleted) {
return;
}
if (!empty($this->dirty) && !defined('MAHARA_CRASHING')) {
$this->commit();
}
}
/**
* 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.
*/
public function commit() {
if (empty($this->dirty)) {
return;
}
if (empty($this->author) && empty($this->authorname)) {
$this->set_author();
}
db_begin();
$fordb = new StdClass;
foreach (get_object_vars($this) as $k => $v) {
$fordb->{$k} = $v;
if (in_array($k, array('mtime', 'ctime', 'atime')) && !empty($v)) {
$fordb->{$k} = db_format_timestamp($v);
}
}
if (empty($this->id)) {
$this->id = insert_record('artefact', $fordb, 'id', true);
if ($this->can_be_logged()) {
$this->log('created');
}
if (!empty($this->parent)) {
$this->parentdirty = true;
}
}
else {
if ($this->can_be_logged()) {
$this->log('edited');
}
update_record('artefact', $fordb, 'id');
}
if (!empty($this->group)) {
$this->save_rolepermissions();
}
delete_records('artefact_tag', 'artefact', $this->id);
if (is_array($this->tags)) {
foreach (array_unique($this->tags) as $tag) {
if (empty($tag)) {
continue;
}
insert_record(
'artefact_tag',
(object) array(
'artefact' => $this->id,
'tag' => $tag,
)
);
}
}
artefact_watchlist_notification(array($this->id));
handle_event('saveartefact', $this);
if (!empty($this->parentdirty)) {
if ($this->parent) {
// Make sure we have a record for the new parent
delete_records('artefact_parent_cache', 'artefact', $this->id, 'parent', $this->parent);
insert_record('artefact_parent_cache', (object)array(
'artefact' => $this->id,
'parent' => $this->parent,
'dirty' => 0
));
// Set anything relating to this artefact as dirty
set_field_select('artefact_parent_cache', 'dirty', 1,
'artefact = ? OR parent = ?', array($this->id, $this->id));
}
else {
// No parent - no need for any records in the apc then
delete_records('artefact_parent_cache', 'artefact', $this->id);
}
}
$this->dirty = false;
$this->deleted = false;
$this->parentdirty = false;
db_commit();
}
/**
* 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.
*/
public function delete() {
if (empty($this->id)) {
$this->dirty = false;
return;
}
db_begin();
// Call delete() on comments (if there are any)
safe_require('artefact', 'comment');
ArtefactTypeComment::delete_comments_onartefacts(array($this->id));
// Call delete() on children (if there are any)
if ($children = $this->get_children_instances()) {
foreach ($children as $child) {
$child->delete();
}
}
artefact_watchlist_notification(array($this->id));
self::_delete_dbrecords(array($this->id));
if ($this->can_be_logged()) {
$this->log('deleted');
}
handle_event('deleteartefact', $this);
// Set flags.
$this->dirty = false;
$this->parentdirty = true;
$this->deleted = true;
db_commit();
}
/**
* 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);
// Delete comments first
safe_require('artefact', 'comment');
ArtefactTypeComment::delete_comments_onartefacts($artefactids);
$records = get_records_select_assoc(
'artefact',
'id IN (' . join(',', array_map('intval', $artefactids)) . ')',
null, 'artefacttype', 'id,parent,artefacttype,container'
);
$containers = array();
$leaves = array();
foreach ($records as $r) {
if ($r->container) {
$containers[$r->artefacttype][] = (int)$r->id;
}
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);
if (is_mysql()) {
set_field_select('artefact', 'parent', null, 'id IN (' . join(',', $ids) . ')', array());
}
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;
}
$idstr = '(' . join(',', array_map('intval', $artefactids)) . ')';
db_begin();
// Detach any files from this artefact
delete_records_select('artefact_attachment', "artefact IN $idstr");
// Delete any references to these artefacts from non-artefact places.
delete_records_select('artefact_parent_cache', "artefact IN $idstr");
// The artefacts should have no 'real' children at this point, but they
// could still be in the artefact_parent_cache as parents if they had
// attachments, or if any of their children had attachments.
delete_records_select('artefact_parent_cache', "parent IN $idstr");
// 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");
delete_records_select('artefact', "id IN $idstr");
db_commit();
}
/**
* 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');
}
}
/**
* this function provides the way to link to viewing very deeply nested artefacts
* within a view
*
* @todo not sure the comment here is appropriate
*/
public function add_to_render_path(&$options) {
if (empty($options['path'])) {
$options['path'] = $this->get('id');
}
else {
$options['path'] .= ',' . $this->get('id');
}
}
/**
* 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;
}
/**
* 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 abstract function get_icon($options=null);
// ******************** 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
}
/**
* whether a user will have exactly 0 or 1 of this artefact type
* @abstract
*/
public static abstract function is_singular();
/**
* Returns a list of key => value pairs where the key is either '_default'
* or a langauge 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 abstract 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 abstract function render_self($options);
/**
* Returns the printable name of this artefact
* (used in lists and such)
*/
public function get_name() {
return $this->get('title');
}
/**
* Should the artefact be linked to from the listing on my views?
*/
public function in_view_list() {
return true;
}
/**
* Returns a short name for the artefact to be used in a list of artefacts in a view
*/
public function display_title($maxlen=null) {
if ($maxlen) {
return str_shorten_text($this->get('title'), $maxlen, true);
}
return $this->get('title');
}
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);
}
if ($institution = $this->get('institution')) {
if ($institution == 'mahara') {
return get_config('sitename');
}
return get_field('institution', 'displayname', 'name', $institution);
}
return null;
}
// ******************** HELPER FUNCTIONS ******************** //
protected function get_artefact_type() {
$classname = get_class($this);
$type = strtolower(substr($classname, strlen('ArtefactType')));
if (!artefact_type_installed($type)) {
throw new InvalidArgumentException("Classname $classname not a valid artefact type");
}
return $type;
}
public function to_stdclass() {
return (object)get_object_vars($this);
}
public static function has_config() {
return false;
}
public static function get_config_options() {
return array();
}
public static function collapse_config() {
return false;
}
private function save_rolepermissions() {
if (!$this->group) {
return;
}
require_once(get_config('libroot') . 'group.php');
if (!isset($this->rolepermissions)) {
$this->rolepermissions = group_get_default_artefact_permissions($this->group);
}
$id = $this->get('id');
db_begin();
delete_records('artefact_access_role', 'artefact', $id);
foreach ($this->rolepermissions as $role => $permissions) {
insert_record('artefact_access_role', (object) array(
'artefact' => $id,
'role' => $role,
'can_view' => (int) !empty($permissions->view),
'can_edit' => (int) !empty($permissions->edit),
'can_republish' => (int) !empty($permissions->republish),
));
}
db_commit();
}
private function load_rolepermissions() {
if (!$this->group) {
return;
}
$records = get_records_array('artefact_access_role', 'artefact', $this->get('id'));
if ($records) {
$this->rolepermissions = array();
foreach ($records as $r) {
$this->rolepermissions[$r->role] = (object) array(
'view' => (bool) $r->can_view,
'edit' => (bool) $r->can_edit,
'republish' => (bool) $r->can_republish,
);
}
}
else {
$this->rolepermissions = group_get_default_artefact_permissions($this->group);
}
}
public function copy_data() {
$ignore = array(
'dirty' => 1,
'parentdirty' => 1,
'deleted' => 1,
'id' => 1,
'locked' => 1,
'rolepermissions' => 1,
'viewsinstances' => 1,
'viewsmetadata' => 1,
'childreninstances' => 1,
'childrenmetadata' => 1,
'parentinstance' => 1,
'parentmetadata' => 1
);
$data = new StdClass;
foreach (get_object_vars($this) as $k => $v) {
if (in_array($k, array('atime', 'ctime', 'mtime'))) {
$data->$k = db_format_timestamp($v);
}
else if (!isset($ignore[$k])) {
$data->$k = $v;
}
}
return $data;
}
public function copy_extra($new) {
}
public function copy_for_new_owner($user, $group, $institution) {
$data = $this->copy_data();
$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);
$this->copy_extra($copy);
$copy->commit();
return $copy->get('id');
}
/**
* 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 {
$this->set('parent', $this->default_parent_for_copy($view, $template, array_map(create_function('$a', 'return $a->newid;'), $artefactcopies)));
}
}
/**
* Returns the ID of the artefact that should be the parent for copied
* 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
* @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
* copied).
*/
public function default_parent_for_copy(&$view, &$template, $artefactstoignore) {
return null;
}
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;
}
}
if (isset($changed)) {
insert_record('artefact_log', $entry);
}
}
if ($action == 'created') {
foreach ($loggedfields as $key) {
$entry->$key = $this->$key;
}
insert_record('artefact_log', $entry);
}
}
public function can_have_attachments() {
return false;
}
public function count_attachments() {
return count_records('artefact_attachment', 'artefact', $this->get('id'));
}
public function attachment_id_list() {
// 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;
}
}
return array();
}
public function attachments_from_id_list($artefactids) {
if (empty($artefactids)) {
return array();
}
// @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.
$attachments = get_records_sql_array('
SELECT
aa.artefact, aa.attachment, a.artefacttype, a.title, a.description, f.size
FROM {artefact_attachment} aa
INNER JOIN {artefact} a ON aa.attachment = a.id
LEFT JOIN {artefact_file_files} f ON a.id = f.artefact
WHERE aa.artefact IN (' . join(', ', array_map('intval', $artefactids)) . ')', '');
if (!$attachments) {
return array();
}
return $attachments;