view.php 246 KB
Newer Older
Penny Leach's avatar
Penny Leach committed
1
2
3
4
5
<?php
/**
 *
 * @package    mahara
 * @subpackage core
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.
Penny Leach's avatar
Penny Leach committed
9
10
11
12
13
14
15
 *
 */

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

class View {

16
17
18
19
20
    private $dirty;
    private $deleted;
    private $id;
    private $owner;
    private $ownerformat;
21
    private $group;
22
    private $institution;
23
24
25
    private $ctime;
    private $mtime;
    private $atime;
26
27
    private $startdate;
    private $stopdate;
28
29
    private $submittedgroup;
    private $submittedhost;
30
    private $submittedtime;
31
    private $submittedstatus;
32
33
34
35
36
37
38
    private $title;
    private $description;
    private $loggedin;
    private $friendsonly;
    private $artefact_instances;
    private $artefact_metadata;
    private $ownerobj;
39
    private $groupobj;
40
    private $institutionobj;
41
42
43
    private $numcolumns; // now redundant
    private $columnsperrow; // assoc array of rows set and get using view_rows_columns db table
    private $numrows;
44
    private $layout;
Nigel McNie's avatar
Nigel McNie committed
45
    private $theme;
46
    private $rows;
47
    private $columns;
48
49
    private $dirtyrows; // for when we change stuff
    private $dirtycolumns; // now includes reference to row [row][column]
50
    private $tags;
51
    private $categorydata;
52
    private $template;
53
    private $retainview;
54
    private $copynewuser = 0;
55
    private $copynewgroups;
56
    private $type;
57
    private $visits;
58
    private $allowcomments;
59
    private $approvecomments;
60
    private $collection;
61
    private $accessconf;
62
    private $locked;
63
    private $urlid;
64
    private $skin;
65
    private $anonymise = 0;
Penny Leach's avatar
Penny Leach committed
66

67
68
69
70
    const UNSUBMITTED = 0;
    const SUBMITTED = 1;
    const PENDING_RELEASE = 2;

71
72
73
74
75
76
77
78
79
80
81
82
    /**
     * Which view layout is considered the "default" for views with the given
     * number of columns. Must be present in $layouts of course.
     */
    public static $defaultcolumnlayouts = array(
            1 => '100',
            2 => '50,50',
            3 => '33,33,33',
            4 => '25,25,25,25',
            5 => '20,20,20,20,20',
    );

83
    /**
84
85
86
     * Valid view column layouts. These are read at install time and inserted into
     * view_layout_columns, but not updated afterwards, so if you're changing one
     * you'll need to do that manually.
87
88
89
     *
     * The key represents the number of columns, and the value is an array of all the
     * view_layout_columns records that have that number of columns
90
     */
91
    public static $basic_column_layouts = array(
92
93
94
95
96
97
98
99
100
101
102
        1 => array(
            '100',
        ),
        2 => array(
            '50,50',
            '67,33',
            '33,67',
        ),
        3 => array(
            '33,33,33',
            '25,50,25',
103
104
            '25,25,50',
            '50,25,25',
105
106
107
108
109
110
111
112
113
114
115
            '15,70,15',
        ),
        4 => array(
            '25,25,25,25',
            '20,30,30,20',
        ),
        5 => array(
            '20,20,20,20,20',
        ),
    );

116
117
118
119
120
121
    /**
     * The default layout options to be read at install time.
     * Each view_layout record is based on the array key and the count of its values.
     * Each view_layout_rows_columns record is based on the sub array.
     * For example:
     *  18 => array(
122
123
124
125
126
     *              1 => '100',
     *              2 => '50,50',
     *              3 => '100'
     *              'order' => 3
     *  ),
127
     * will insert a record in view_layout with id = 18 and rows = 3
128
129
130
131
     * and will insert 3 records in view_layout_rows_columns:
     *  - viewlayout = 18, rows = 1, columns = 1
     *  - viewlayout = 18, rows = 2, columns = 2
     *  - viewlayout = 18, rows = 3, columns = 1
132
     * And the "order" key indicates that this should be the 3rd option in the layout menu
133
134
135
     */
    public static $defaultlayoutoptions = array(
        1 => array(
136
137
                1 => '100',
                'order' => 1,
138
139
            ),
        2 => array(
140
141
                1 => '50,50',
                'order' => 2,
142
143
            ),
        3 => array(
144
145
                1 => '67,33',
                'order' => 3,
146
147
            ),
        4 => array(
148
149
                1 => '33,67',
                'order' => 4,
150
151
            ),
        5 => array(
152
153
                1 => '33,33,33',
                'order' => 5,
154
155
            ),
        6 => array(
156
157
                1 => '25,50,25',
                'order' => 6,
158
159
            ),
        7 => array(
160
                1 => '25,25,50'
161
162
            ),
        8 => array(
163
                1 => '50,25,25'
164
165
            ),
        9 => array(
166
                1 => '15,70,15'
167
168
            ),
        10 => array(
169
                1 => '25,25,25,25'
170
171
            ),
        11 => array(
172
                1 => '20,30,30,20'
173
174
            ),
        12 => array(
175
                1 => '20,20,20,20,20'
176
177
            ),
        13 => array(
178
179
                1 => '100',
                2 => '25,50,25'
180
181
            ),
        14 => array(
182
183
184
                1 => '100',
                2 => '33,67',
                'order' => 7
185
186
            ),
        15 => array(
187
188
                1 => '100',
                2 => '67,33'
189
190
            ),
        16 => array(
191
192
                1 => '100',
                2 => '50,50'
193
194
            ),
        17 => array(
195
196
197
                1 => '100',
                2 => '33,33,33',
                'order' => 8
198
199
            ),
        18 => array(
200
201
202
                1 => '100',
                2 => '50,50',
                3 => '100'
203
204
            ),
        19 => array(
205
206
207
208
                1 => '100',
                2 => '33,33,33',
                3 => '100',
                'order' => 9
209
210
            ),
        20 => array(
211
212
213
                1 => '100',
                2 => '25,50,25',
                3 => '100'
214
215
            ),
        21 => array(
216
217
218
219
                1 => '100',
                2 => '50,50',
                3 => '33,33,33',
                'order' => 10
220
221
222
223
224
225
226
227
228
229
230
            ),
    );

    public static $maxlayoutrows = 6; // see number of colours avail in layoutpreview.php

    /**
     * For retrieving and checking numbers of columnns in any given row
     * Initialised in constructor
     * An array of objects which represent each row in view_layout_columns
     */
    public static $layoutcolumns;
231

Penny Leach's avatar
Penny Leach committed
232
    public function __construct($id=0, $data=null) {
233
        global $USER;
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
        if (is_array($id) && isset($id['urlid']) && isset($id['ownerurlid'])) {
            $tempdata = get_record_sql('
                SELECT v.*
                FROM {view} v JOIN {usr} u ON v.owner = u.id
                WHERE v.urlid = ? AND u.urlid = ?',
                array($id['urlid'], $id['ownerurlid'])
            );
            if (empty($tempdata)) {
                throw new ViewNotFoundException(get_string('viewnotfoundbyname', 'error', $id['urlid'], $id['ownerurlid']));
            }
        }
        else if (is_array($id) && isset($id['urlid']) && isset($id['groupurlid'])) {
            $tempdata = get_record_sql('
                SELECT v.*
                FROM {view} v JOIN {group} g ON v.group = g.id
                WHERE v.urlid = ? AND g.urlid = ? AND g.deleted = 0',
                array($id['urlid'], $id['groupurlid'])
            );
            if (empty($tempdata)) {
                throw new ViewNotFoundException(get_string('viewnotfoundbyname', 'error', $id['urlid'], $id['groupurlid']));
            }
        }
        else if (!empty($id) && is_numeric($id)) {
257
258
259
260
261
262
            $tempdata = get_record_sql('
                SELECT v.*
                FROM {view} v LEFT JOIN {group} g ON v.group = g.id
                WHERE v.id = ? AND (v.group IS NULL OR g.deleted = 0)',
                array($id)
            );
263
            if (empty($tempdata)) {
264
265
                throw new ViewNotFoundException(get_string('viewnotfound', 'error', $id));
            }
266
267
        }
        if (isset($tempdata)) {
268
269
270
271
272
273
            if (!empty($data)) {
                $data = array_merge((array)$tempdata, $data);
            }
            else {
                $data = $tempdata; // use what the database has
            }
274
            $this->id = $tempdata->id;
Penny Leach's avatar
Penny Leach committed
275
276
277
        }
        else {
            $this->ctime = time();
278
            $this->mtime = time();
Penny Leach's avatar
Penny Leach committed
279
            $this->dirty = true;
Penny Leach's avatar
Penny Leach committed
280
281
        }

282
283
        $data = empty($data) ? array() : (array)$data;
        foreach ($data as $field => $value) {
Penny Leach's avatar
Penny Leach committed
284
285
286
287
            if (property_exists($this, $field)) {
                $this->{$field} = $value;
            }
        }
288

289
290
291
292
        if (empty(self::$layoutcolumns)) {
            self::$layoutcolumns = get_records_assoc('view_layout_columns', '', '', 'columns,id');
        }

293
294
295
296
297
298
299
300
301
302
303
        // Add in owner and group objects if we already happen to have them from view_search(), etc.
        if (isset($data['user']) && isset($data['user']->id) && $data['user']->id == $this->owner) {
            $this->ownerobj = $data['user'];
        }
        else if (isset($data['groupdata']->id) && $data['groupdata']->id == $this->group) {
            $this->groupobj = $data['groupdata'];
        }
        else if (!isset($data['user']) && !empty($this->owner) && $this->owner == $USER->get('id')) {
            $this->ownerobj = $USER;
        }

Penny Leach's avatar
Penny Leach committed
304
        $this->atime = time();
305
        $this->rows = array();
306
        $this->columns = array();
307
        $this->dirtyrows = array();
308
        $this->dirtycolumns = array();
309
310
311
312
313

        // set only for existing views - _create provides default value
        if (empty($this->columnsperrow)) {
            $this->columnsperrow = get_records_assoc('view_rows_columns', 'view', $this->get('id'), 'row', 'row, columns');
        }
Penny Leach's avatar
Penny Leach committed
314
315
    }

316
317
    /**
     * Creates a new View for the given user/group/institution.
318
319
     *
     * You can specify who the view is being created _by_ with the second
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
     * parameter. This defaults to the current logged in user's ID.
     *
     * @param array $viewdata See View::_create
     * @return View           The newly created View
     */
    public static function create($viewdata, $userid=null) {
        if (is_null($userid)) {
            global $USER;
            $userid = $USER->get('id');
        }

        $view = self::_create($viewdata, $userid);
        return $view;
    }

    /**
336
     * Creates a View for the given user, based off a given template and other
337
338
     * View information supplied.
     *
339
     * Will set a default title of 'Copy of $viewtitle' if title is not
340
     * specified in $viewdata and $titlefromtemplate == false.
341
342
343
     *
     * @param array $viewdata See View::_create
     * @param int $templateid The ID of the View to copy
344
     * @param int $userid     The user who has issued the command to create the
345
     *                        view. See View::_create
346
     * @param int $checkaccess Whether to check that the user can see the view before copying it
347
348
     * @return array A list consisting of the new view, the template view and
     *               information about the copy - i.e. how many blocks and
349
     *               artefacts were copied
350
     * @throws SystemException under various circumstances, see the source for
351
352
     *                         more information
     */
353
    public static function create_from_template($viewdata, $templateid, $userid=null, $checkaccess=true, $titlefromtemplate=false) {
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
        if (is_null($userid)) {
            global $USER;
            $userid = $USER->get('id');
        }

        $user = new User();
        $user->find_by_id($userid);

        db_begin();

        $template = new View($templateid);

        if ($template->get('deleted')) {
            throw new SystemException("View::create_from_template: This template has been deleted");
        }

370
        if ($checkaccess && !$template->get('template') && !$user->can_edit_view($template)) {
371
372
            throw new SystemException("View::create_from_template: Attempting to create a View from another View that is not marked as a template");
        }
373
        else if ($checkaccess && !can_view_view($templateid, $userid)) {
374
375
376
377
378
379
            throw new SystemException("View::create_from_template: User $userid is not permitted to copy View $templateid");
        }

        $view = self::_create($viewdata, $userid);

        // Set a default title if one wasn't set
380
381
382
383
        if ($titlefromtemplate) {
            $view->set('title', $template->get('title'));
        }
        else if (!isset($viewdata['title'])) {
384
385
386
387
388
            $desiredtitle = $template->get('title');
            if (get_config('renamecopies')) {
                $desiredtitle = get_string('Copyof', 'mahara', $desiredtitle);
            }
            $view->set('title', self::new_title($desiredtitle, (object)$viewdata));
389
390
            $view->set('dirty', true);
        }
391

392
393
394
395
        $view->urlid = generate_urlid($view->title, get_config('cleanurlviewdefault'), 3, 100);
        $viewdata['owner'] = $userid;
        $view->urlid = self::new_urlid($view->urlid, (object)$viewdata);

396
397
398
399
400
401
402
        try {
            $copystatus = $view->copy_contents($template);
        }
        catch (QuotaExceededException $e) {
            db_rollback();
            return array(null, $template, array('quotaexceeded' => true));
        }
403
404

        $view->commit();
405

406
407
408
409
410
        // if layout is set, and it's not a default layout
        // add an entry to usr_custom_layout if one does not already exist
        if ($template->get('layout') !== null) {
            $customlayout = get_record('view_layout', 'id', $template->get('layout'), 'iscustom', 1);
            if ($customlayout !== false) {
411
                // is the owner of the copy going to be a group or institution or not?
412
                $owner = $view->owner;
413
414
415
                $group = $view->group;
                $institution = $view->institution;
                $haslayout = false;
416

417
                if (!empty($group)) {
418
419
420
                    $owner = null;
                    $haslayout = get_record('usr_custom_layout', 'layout', $template->get('layout'), 'group', $group);
                }
421
422
423
424
                if (!empty($institution)) {
                    $owner = null;
                    $haslayout = get_record('usr_custom_layout', 'layout', $template->get('layout'), 'institution', $institution);
                }
425
426
427
428
429
                else if (isset($owner)) {
                    $haslayout = get_record('usr_custom_layout', 'layout', $template->get('layout'), 'usr', $owner);
                }

                if (!$haslayout) {
430
                    $newcustomlayout = insert_record('usr_custom_layout', (object) array('usr' => $owner, 'group' => $group, 'institution' => $institution, 'layout' => $template->get('layout')) );
431
432
433
434
                }
            }
        }

435
436
437
        $blocks = get_records_array('block_instance', 'view', $view->get('id'));
        if ($blocks) {
            foreach ($blocks as $b) {
438
439
440
441
                // As some artefact references have been changed, e.g embedded images
                // we need to rebuild the artefact list for each block
                $bi = new BlockInstance($b->id);
                $bi->rebuild_artefact_list();
442
443
444
445
446
447
448
449
450
451
452
453
454
455
                $configdata = unserialize($b->configdata);
                if (!isset($configdata['artefactid'])) {
                    continue;
                }
                if (!isset($configdata['copytype']) || $configdata['copytype'] !== 'reference') {
                    continue;
                }
                $va = new StdClass;
                $va->view = $b->view;
                $va->artefact = $configdata['artefactid'];
                $va->block = $b->id;
                insert_record('view_artefact', $va);
            }
        }
456
457
458
459
460
461
462
463
464
465

        if ($template->get('retainview') && !$template->get('institution')) {
            $obj = new StdClass;
            $obj->view  = $view->get('id');
            $obj->ctime = db_format_timestamp(time());
            $obj->usr   = $template->get('owner');
            $obj->group = $template->get('group');
            insert_record('view_access', $obj);
        }

466
467
468
469
470
471
472
473
474
475
        db_commit();

        return array(
            $view,
            $template,
            $copystatus,
        );
    }

    /**
476
     * Creates a new View for the given user, based on the given information
477
478
     * about the view.
     *
479
     * Validation of the view data is performed, then the View is created. If
480
481
     * the View is to be owned by a group, that group is given access to it.
     *
482
     * @param array $viewdata Data about the view. You can pass in most fields
483
484
     *                        that appear in the view table.
     *
485
486
     *                        Note that you set who owns the View by setting
     *                        either the owner, group or institution field as
487
488
     *                        approriate.
     *
489
490
     *                        Currently, you cannot pass in access data. Use
     *                        $view->set_access() after retrieving the $view
491
492
     *                        object.
     *
493
494
     * @param int $userid The user who has issued the command to create the
     *                    View (note: this is different from the "owner" of the
495
496
497
     *                    View - a group or institution could be the "owner",
     *                    but it's a _user_ who requests a View is created for it)
     * @return View The created View
498
     * @throws SystemException if the View data is invalid - mostly this is due
499
500
501
     *                         to owner information being specified incorrectly.
     */
    private static function _create(&$viewdata, $userid) {
502
        // If no owner information is provided, assume that the view is being
503
504
505
506
507
508
509
510
511
512
513
514
515
516
        // created by the user for themself
        if (!isset($viewdata['owner']) && !isset($viewdata['group']) && !isset($viewdata['institution'])) {
            $viewdata['owner'] = $userid;
        }

        if (isset($viewdata['owner'])) {
            if ($viewdata['owner'] != $userid) {
                $userobj = new User();
                $userobj->find_by_id($userid);
                if (!$userobj->is_admin_for_user($viewdata['owner'])) {
                    throw new SystemException("View::_create: User $userid is not allowed to create a view for owner {$viewdata['owner']}");
                }
            }

517
            // Users can only have one view of each non-portfolio type
518
            if (isset($viewdata['type']) && $viewdata['type'] != 'portfolio' && get_record('view', 'owner', $viewdata['owner'], 'type', $viewdata['type'])) {
519
520
521
                $viewdata['type'] = 'portfolio';
            }

522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
            // Try to create the view with the owner's default theme if that theme is set by an
            // institution (i.e. if it's different from the site theme)
            //
            // This needs to be modified if users are ever allowed to change their own theme
            // preference.  Currently it's okay because users' themes are forced on them by
            // the site or institution default, but if some users are allowed to change their
            // own theme pref, we should create those users' views without a theme.
            if (!get_config('userscanchooseviewthemes') && !isset($viewdata['theme'])
                && (!isset($viewdata['type']) || $viewdata['type'] != 'dashboard')) {
                global $USER;
                if ($viewdata['owner'] == $USER->get('id')) {
                    $owner = $USER;
                }
                else {
                    $owner = new User();
                    $owner->find_by_id($viewdata['owner']);
                }
539
540
                $ownerthemedata = $owner->get('institutiontheme');
                $ownertheme = isset($ownerthemedata->basename) ? $ownerthemedata->basename : null;
541
                if ($ownertheme && $ownertheme != get_config('theme') && $ownertheme != 'custom') {
542
543
544
                    $viewdata['theme'] = $ownertheme;
                }
            }
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
        }

        if (isset($viewdata['group'])) {
            require_once('group.php');
            if (!group_user_can_edit_views($viewdata['group'], $userid)) {
                throw new SystemException("View::_create: User $userid is not permitted to create a view for group {$viewdata['group']}");
            }
        }

        if (isset($viewdata['institution'])) {
            $user = new User();
            $user->find_by_id($userid);
            if (!$user->can_edit_institution($viewdata['institution'])) {
                throw new SystemException("View::_create: User $userid is not permitted to create a view for institution {$viewdata['institution']}");
            }
        }

        // Create the view
        $defaultdata = array(
564
565
            'numcolumns'    => 2,
            'numrows'       => 1,
566
            'columnsperrow' => self::default_columnsperrow(),
567
568
569
            'template'      => 0,
            'type'          => 'portfolio',
            'title'         => (array_key_exists('title', $viewdata)) ? $viewdata['title'] : self::new_title(get_string('Untitled', 'view'), (object)$viewdata),
570
            'anonymise'     => 0,
571
572
573
574
        );

        $data = (object)array_merge($defaultdata, $viewdata);

575
576
577
578
579
        if ($data->type == 'portfolio' && (!isset($data->url) || is_null($data->url) || !strlen($data->url))) {
            $data->urlid = generate_urlid($data->title, get_config('cleanurlviewdefault'), 3, 100);
            $data->urlid = self::new_urlid($data->urlid, $data);
        }

580
581
        $view = new View(0, $data);
        $view->commit();
582
583
584
        if (isset($viewdata['group']) &&
            (empty($viewdata['type']) || (!empty($viewdata['type']) && $viewdata['type'] != 'grouphomepage'))
           ) {
585
586
587
            require_once('activity.php');

            // Although group views are owned by the group, the view creator is treated as owner here.
588
589
            // So we need to ignore them from the activity_occured email.
            $beforeusers[$userid] = get_record('usr', 'id', $userid);
590

591
            // By default, group views should be visible to the group
592
593
594
            insert_record('view_access', (object) array(
                'view'  => $view->get('id'),
                'group' => $viewdata['group'],
595
                'ctime' => db_format_timestamp(time()),
596
            ));
597
598
599

            // Notify group members
            $accessdata = new StdClass;
600
            $accessdata->view = $view->get('id');
601
602
            $accessdata->oldusers = $beforeusers;
            activity_occurred('viewaccess', $accessdata);
603
604
        }

605
606
607
608
609
610
611
612
613
614
615
        if (isset($viewdata['layout'])) {
            // e.g. importing via LEAP2A
            $layoutsrowscols = get_records_select_array('view_layout_rows_columns', 'viewlayout = ?', array($viewdata['layout']));
            if ($layoutsrowscols) {
                delete_records('view_rows_columns', 'view', $view->get('id'));
                foreach ($layoutsrowscols as $layoutrow) {
                    insert_record('view_rows_columns', (object)array( 'view' => $view->get('id'), 'row' => $layoutrow->row, 'columns' =>  self::$layoutcolumns[$layoutrow->columns]->columns));
                }
            }
        }

616
        return new View($view->get('id')); // Reread to ensure defaults are set
617
618
    }

Son Nguyen's avatar
Son Nguyen committed
619
    public static function default_columnsperrow() {
620
621
622
623
624
625
626
        $default = array(1 => (object)array('row' => 1, 'columns' => 3, 'widths' => '33,33,33'));
        if (!$id = get_field('view_layout_columns', 'id', 'columns', $default[1]->columns, 'widths', $default[1]->widths)) {
            throw new SystemException("View::default_columnsperrow: Default columns = 3, widths = '33,33,33' not in view_layout_columns table");
        }
        return $default;
    }

Penny Leach's avatar
Penny Leach committed
627
628
629
630
    public function get($field) {
        if (!property_exists($this, $field)) {
            throw new InvalidArgumentException("Field $field wasn't found in class " . get_class($this));
        }
631
632
633
        if ($field == 'tags') { // special case
            return $this->get_tags();
        }
634
635
636
        if ($field == 'categorydata') {
            return $this->get_category_data();
        }
637
638
639
        if ($field == 'collection') {
            return $this->get_collection();
        }
640
641
642
        if ($field == 'columnsperrow') {
            return $this->get_columnsperrow();
        }
Penny Leach's avatar
Penny Leach committed
643
644
645
        return $this->{$field};
    }

646
647
648
649
650
651
652
    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;
653
654
655
656
657
            if ($field != 'atime') {
                // don't bother updating the modified time if we are
                // only wanting to update the accessed time
                $this->mtime = time();
            }
658
659
660
661
662
            return true;
        }
        throw new InvalidArgumentException("Field $field wasn't found in class " . get_class($this));
    }

663
664
665
666
667
668
669
    public function get_tags() {
        if (!isset($this->tags)) {
            $this->tags = get_column('view_tag', 'tag', 'view', $this->get('id'));
        }
        return $this->tags;
    }

670
671
672
    public function get_collection() {
        if (!isset($this->collection)) {
            require_once(get_config('libroot') . 'collection.php');
673
            $this->collection = Collection::search_by_view_id($this->id);
674
675
676
677
        }
        return $this->collection;
    }

678
679
680
681
682
683
684
    public function get_columnsperrow() {
        if (!isset($this->columnsperrow)) {
            $this->columnsperrow = get_records_assoc('view_rows_columns', 'view', $this->get('id'), 'row', 'row, columns');
        }
        return $this->columnsperrow;
    }

685
686
687
688
689
690
691
    public function collection_id() {
        if ($collection = $this->get_collection()) {
            return $collection->get('id');
        }
        return false;
    }

692
693
694
695
696
697
698
699
700
701
    /**
     * View destructor. Calls commit 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;
        }
702

703
704
705
706
707
        if (!empty($this->dirty)) {
            return $this->commit();
        }
    }

708
    /**
709
710
711
712
713
714
715
716
717
     * This method updates the contents of the view table only.
     */
    public function commit() {
        if (empty($this->dirty)) {
            return;
        }
        $fordb = new StdClass;
        foreach (get_object_vars($this) as $k => $v) {
            $fordb->{$k} = $v;
718
            if (in_array($k, array('mtime', 'ctime', 'atime', 'startdate', 'stopdate', 'submittedtime')) && !empty($v)) {
719
720
721
                $fordb->{$k} = db_format_timestamp($v);
            }
        }
722
723
724

        db_begin();

725
        if (empty($this->id)) {
726
727
            // users are only allowed one profile view
            if ($this->type == 'profile' && record_exists('view', 'owner', $this->owner, 'type', 'profile')) {
728
                throw new SystemException(get_string('onlonlyyoneprofileviewallowed', 'error'));
729
            }
730
731
732
733
734
            $this->id = insert_record('view', $fordb, 'id', true);
        }
        else {
            update_record('view', $fordb, 'id');
        }
735

736
        if (isset($this->tags)) {
737
            $this->tags = check_case_sensitive($this->tags, 'view_tag');
738
739
            delete_records('view_tag', 'view', $this->get('id'));
            foreach ($this->get_tags() as $tag) {
740
741
                //truncate the tag before insert it into the database
                $tag = substr($tag, 0, 128);
742
743
                insert_record('view_tag', (object)array( 'view' => $this->get('id'), 'tag' => $tag));
            }
744
745
        }

746
747
748
749
750
751
752
        if (isset($this->copynewgroups)) {
            delete_records('view_autocreate_grouptype', 'view', $this->get('id'));
            foreach ($this->copynewgroups as $grouptype) {
                insert_record('view_autocreate_grouptype', (object)array( 'view' => $this->get('id'), 'grouptype' => $grouptype));
            }
        }

753
754
755
756
757
758
759
        if (isset($this->columnsperrow)) {
            delete_records('view_rows_columns', 'view', $this->get('id'));
            foreach ($this->get_columnsperrow() as $viewrow) {
                insert_record('view_rows_columns', (object)array( 'view' => $this->get('id'), 'row' => $viewrow->row, 'columns' => $viewrow->columns));
            }
        }

760
761
        db_commit();

762
763
764
765
        $this->dirty = false;
        $this->deleted = false;
    }

Penny Leach's avatar
Penny Leach committed
766
767
768
769
770
771
772
773
    public function get_artefact_instances() {
        if (!isset($this->artefact_instances)) {
            $this->artefact_instances = false;
            if ($instances = $this->get_artefact_metadata()) {
                foreach ($instances as $instance) {
                    safe_require('artefact', $instance->plugin);
                    $classname = generate_artefact_class_name($instance->artefacttype);
                    $i = new $classname($instance->id, $instance);
Penny Leach's avatar
Penny Leach committed
774
                    $this->childreninstances[] = $i;
Penny Leach's avatar
Penny Leach committed
775
776
777
778
779
780
781
                }
            }
        }
        return $this->artefact_instances;
    }

    public function get_artefact_metadata() {
Penny Leach's avatar
Penny Leach committed
782
        if (!isset($this->artefact_metadata)) {
783
            $sql = 'SELECT a.*, i.name, va.block
784
785
786
                    FROM {view_artefact} va
                    JOIN {artefact} a ON va.artefact = a.id
                    JOIN {artefact_installed_type} i ON a.artefacttype = i.name
Penny Leach's avatar
Penny Leach committed
787
                    WHERE va.view = ?';
788
            $this->artefact_metadata = get_records_sql_array($sql, array($this->id));
Penny Leach's avatar
Penny Leach committed
789
790
791
        }
        return $this->artefact_metadata;
    }
Penny Leach's avatar
Penny Leach committed
792

793
    public function find_artefact_children($artefact, $allchildren, &$refs) {
794

795
        $children = array();
796
797
798
799
800
801
802
803
        if ($allchildren) {
            foreach ($allchildren as $child) {
                if ($child->parent != $artefact->id) {
                    continue;
                }
                $children[$child->id] = array();
                $children[$child->id]['artefact'] = $child;
                $refs[$child->id] = $child;
804
                $children[$child->id]['children'] = $this->find_artefact_children($child,
805
                                                            $allchildren, $refs);
806
807
808
809
810
811
            }
        }

        return $children;
    }

Penny Leach's avatar
Penny Leach committed
812

Penny Leach's avatar
Penny Leach committed
813
814
815
816
817
818
    public function has_artefacts() {
        if ($this->get_artefact_metadata()) {
            return true;
        }
        return false;
    }
Penny Leach's avatar
Penny Leach committed
819
820

    public function get_owner_object() {
821
        if (empty($this->owner)) {
822
823
            return false;
        }
Penny Leach's avatar
Penny Leach committed
824
        if (!isset($this->ownerobj)) {
825
            $this->ownerobj = get_user_for_display($this->get('owner'));
Penny Leach's avatar
Penny Leach committed
826
827
828
829
        }
        return $this->ownerobj;
    }

830
831
832
833
834
835
836
    public function get_group_object() {
        if (!isset($this->groupobj)) {
            $this->groupobj = get_record('group', 'id', $this->get('group'));
        }
        return $this->groupobj;
    }

837
838
839
840
841
842
843
    public function get_institution_object() {
        if (!isset($this->institutionobj)) {
            $this->institutionobj = get_record('institution', 'name', $this->get('institution'));
        }
        return $this->institutionobj;
    }

844
    public function delete() {
845
        safe_require('artefact', 'comment');
846
        db_begin();
847
        ArtefactTypeComment::delete_view_comments($this->id);
848
        delete_records('view_access','view',$this->id);
849
        delete_records('view_autocreate_grouptype', 'view', $this->id);
850
        delete_records('view_tag','view',$this->id);
851
        delete_records('view_visit','view',$this->id);
852
        delete_records('collection_view','view',$this->id);
853
        delete_records('usr_watchlist_view','view',$this->id);
854
        if ($blockinstanceids = get_column('block_instance', 'id', 'view', $this->id)) {
855
            require_once(get_config('docroot') . 'blocktype/lib.php');
856
857
858
859
860
            foreach ($blockinstanceids as $id) {
                $bi = new BlockInstance($id);
                $bi->delete();
            }
        }
861
        handle_event('deleteview', $this->id);
862
        delete_records('view_rows_columns', 'view', $this->id);
863
        delete_records('view','id',$this->id);
864
865
866
867
868
        if (!empty($this->owner) && $this->is_submitted()) {
            // There should be no way to delete a submitted view,
            // but unlock its artefacts just in case.
            ArtefactType::update_locked($this->owner);
        }
869
        $this->deleted = true;
870
        db_commit();
871
872
    }

873
874
875
876
877
878
    /* Only retrieve access records that the owner can edit on the
     * view access page.  Some records are not visible there, such as
     * tutor access records for submitted views and objectionable
     * content access records (visible = 0) and token/secret url
     * records which are managed per-view, on another page.
     */
879
    public function get_access($timeformat=null) {
880
        if ($data = $this->get_access_records()) {
881
            return $this->process_access_records($data, $timeformat);
882
883
884
        }
        return array();
    }
885

886
    public function get_access_records() {
887
        $data = get_records_sql_array("
888
            SELECT accesstype, va.group, institution, role, usr, startdate, stopdate, allowcomments, approvecomments
889
            FROM {view_access} va
890
            WHERE view = ? AND visible = 1 AND token IS NULL
891
892
893
            ORDER BY
                accesstype IS NULL, accesstype DESC,
                va.group, role IS NOT NULL, role,
894
                institution, usr,
895
896
                startdate IS NOT NULL, startdate, stopdate IS NOT NULL, stopdate,
                allowcomments, approvecomments",
897
898
            array($this->id)
        );
899
900
        return $data ? $data : array();
    }
901

902
    public function process_access_records($data=array(), $timeformat=null) {
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
        $rolegroups = array();
        foreach ($data as &$item) {
            if ($item->role && !isset($roledata[$item->group])) {
                $rolegroups[$item->group] = 1;
            }
        }
        if ($rolegroups) {
            $grouptypes = get_records_sql_assoc('
                SELECT id, grouptype
                FROM {group}
                WHERE id IN (' . join(',', array_map('intval', array_keys($rolegroups))) . ')
                AND deleted = 0',
                array()
            );
        }
918

919
920
        foreach ($data as &$item) {
            $item = (array)$item;
Eugene Venter's avatar
Eugene Venter committed
921
            $item['locked'] = false; // Indicate if item is editable
922
923
924
925
926
927
928
929
            if ($item['usr']) {
                $item['type'] = 'user';
                $item['id'] = $item['usr'];
            }
            else if ($item['group']) {
                $item['type'] = 'group';
                $item['id'] = $item['group'];
            }
930
931
932
            else if ($item['institution']) {
                $item['type'] = 'institution';
                $item['id'] = $item['institution'];
933
934
935
936
937
938
939

                if ($this->type == 'profile') {
                    $myinstitutions = array_keys(load_user_institutions($this->owner));
                    if (in_array($item['id'], $myinstitutions) && empty($item['startdate']) && empty($item['stopdate'])) {
                        $item['locked'] = true;
                    }
                }
940
            }
941
942
943
944
945
            else {
                $item['type'] = $item['accesstype'];
                $item['id'] = null;
            }

946
947
948
949
            if ($this->type == 'profile' && $item['type'] == 'loggedin' && get_config('loggedinprofileviewaccess')) {
                $item['locked'] = true;
            }

950
951
952
953
954
955
            if ($item['role']) {
                $item['roledisplay'] = get_string($item['role'], 'grouptype.'.$grouptypes[$item['group']]->grouptype);
            }
            if ($timeformat) {
                if ($item['startdate']) {
                    $item['startdate'] = strftime($timeformat, strtotime($item['startdate']));
956
                }
957
958
                if ($item['stopdate']) {
                    $item['stopdate'] = strftime($timeformat, strtotime($item['stopdate']));
959
                }
960
            }
961
        }
962
963
964
        return $data;
    }

965
966
967
968
969
970
971
972
    /* Attempt to sort two access records in the same order as the
       query in get_access_records */
    public static function cmp_accesslist($a, $b) {
        if (($c = empty($a->accesstype) - empty($b->accesstype))
            || ($c = strcmp($b->accesstype, $a->accesstype))
            || ($c = $a->group - $b->group)
            || ($c = !empty($a->role) - !empty($b->role))
            || ($c = strcmp($a->role, $b->role))
973
974
            || ($c = !empty($a->institution) - !empty($b->institution))
            || ($c = strcmp($a->institution, $b->institution))
975
976
977
978
979
980
981
982
983
984
985
            || ($c = $a->usr - $b->usr)
            || ($c = !empty($a->startdate) - !empty($b->startdate))
            || ($c = strcmp($a->startdate, $b->startdate))
            || ($c = !empty($a->stopdate) - !empty($b->stopdate))
            || ($c = strcmp($a->stopdate, $b->stopdate))
            || ($c = $a->allowcomments - $b->allowcomments)) {
            return $c;
        }
        return $a->approvecomments - $b->approvecomments;
    }

986
987
988
989
990
    public static function update_view_access($config, $viewids) {

        db_begin();

        // Use set_access() on the first view to get a hopefully consistent
991
        // and complete representation of the access list
992
        $firstview = new View($viewids[0]);
993
        $fullaccesslist = $firstview->set_access($config['accesslist'], $viewids);
994
995

        // Copy the first view's access records to all the other views
996
997
        $firstview->copy_access($viewids);

998
999
1000
1001
1002
        // Sort the full access list in the same order as the list
        // returned by get_access, so that views with the same set of
        // access records get grouped together
        usort($fullaccesslist, array('self', 'cmp_accesslist'));

1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
        // Hash the config object so later on we can easily find
        // all the views with the same config/access rights
        $config['accesslist'] = $fullaccesslist;
        $accessconf = substr(md5(serialize($config)), 0, 10);

        foreach ($viewids as $viewid) {
            $v = new View((int) $viewid);
            $v->set('startdate', $config['startdate']);
            $v->set('stopdate', $config['stopdate']);
            $v->set('template', $config['template']);
1013
            $v->set('retainview', $config['retainview']);
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
            $v->set('allowcomments', $config['allowcomments']);
            $v->set('approvecomments', $config['approvecomments']);
            if (isset($config['copynewuser'])) {
                $v->set('copynewuser', $config['copynewuser']);
            }
            if (isset($config['copynewgroups'])) {
                $v->set('copynewgroups', $config['copynewgroups']);
            }
            $v->set('accessconf', $accessconf);
            $v->commit();
        }

        db_commit();
    }

1029
1030
1031
1032
    /* Returns preview image for creation of custom layout
     *
     * @param array
     * @return string SVG preview image
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
     */
    public function updatecustomlayoutpreview($values) {
        require_once(get_config('libroot') . 'layoutpreviewimage.php');

        $require = array('numrows');
        foreach ($require as $require) {
            if (!array_key_exists($require, $values) || empty($values[$require])) {
                throw new ParamOutOfRangeException(get_string('missingparam' . $require, 'error'));
            }
        }

        $numrows = $values['numrows'];
        $collayouts = array();
        for ($i=0; $i<$numrows; $i++) {
            if (array_key_exists('row'. ($i+1), $values)) {
                $collayouts['row' . ($i+1)] = $values['row' . ($i+1)];
            }
        }

        $alttext = '';
        $customlayout = array();
        for ($i=0; $i<$numrows; $i++) {
            $id = $collayouts['row' . ($i+1)];
            $widths = get_field('view_layout_columns', 'widths', 'id', $id);
            $hyphenatedwidths = str_replace(',', '-', $widths);
            $customlayout[$i+1] = $hyphenatedwidths;
            $alttext .= $hyphenatedwidths;
1060
            if ($i != $numrows - 1) {
1061
1062
1063
1064
                $alttext .= ' / ';
            }
        }

1065
1066
1067
1068
1069
1070
1071
1072
1073
        // Generate thumbnail images.
        $data = array();
        $data['layout'] = $customlayout;
        $data['text'] = $alttext;

        $previewlayoutimage = new LayoutPreviewImage($data);
        $previewimage = $previewlayoutimage->create_preview();

        return $previewimage;
1074
1075
    }

1076
1077
1078
1079
1080
1081
1082
    /*
     * Adds custom layout records to database and returns an array
    * with layout id and image preview.
    *
    * @param array
    * @return array
    */
1083
    public function addcustomlayout($values) {
1084
        require_once(get_config('libroot') . 'layoutpreviewimage.php');
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
        $require = array('numrows');
        foreach ($require as $require) {
            if (!array_key_exists($require, $values) || empty($values[$require])) {
                throw new ParamOutOfRangeException(get_string('missingparam' . $require, 'error'));
            }
        }

        $numrows = $values['numrows'];
        $alttext = '';
        $rowscolssql = '';
        $rowscols = array();

        for ($i=0; $i<$numrows; $i++) {
            if (array_key_exists('row'. ($i+1), $values)) {
                $rowscolssql .= '(row = ' . ($i+1) . ' AND columns = ' . $values['row' . ($i+1)] . ')';
                if ($i != $numrows-1) {
                    $rowscolssql .= ' OR ';
                }
                $widths = get_field('view_layout_columns', 'widths', 'id', $values['row' . ($i+1)]);
                $hyphenatedwidths = str_replace(',', '-', $widths);
                $alttext .= $hyphenatedwidths;
                if ($i != $numrows -1) {
                    $alttext .= ' / ';
                }
                $rowscols[$i+1] = $values['row' . ($i+1)];
            }
        }

1113
        $owner = $this->owner;
1114
1115
1116
        $group = $this->group;
        $institution = $this->institution;
        if (!empty($group)) {
1117
1118
            $owner = null;
            $andclause = 'AND ucl.group = ?';
1119
1120
1121
1122
1123
1124
            $andclausevalue = $group;
        }
        else if (!empty($institution)) {
            $owner = null;
            $andclause = 'AND ucl.institution = ?';
            $andclausevalue = $institution;
1125
1126
1127
        }
        else if (isset($owner)) {
            $andclause = 'AND ucl.usr = ?';
1128
            $andclausevalue = $owner;
1129
1130
        }
        else {
1131
1132
1133
            // no group or owner or institution set
            // site pages should have institution set
            throw new SystemException("View::addcustomlayout: No owner, group or institution set for view.");
1134
1135
        }

1136
        // check for existing layout
1137
1138
1139
1140
        $sql = 'SELECT vlrc.viewlayout AS id
                FROM
                {view_layout} vl
                INNER JOIN {view_layout_rows_columns} vlrc
1141
                ON vl.id = vlrc.viewlayout
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
                INNER JOIN (
                    SELECT
                    viewlayout, COUNT(*)
                    FROM {view_layout_rows_columns}
                    GROUP BY viewlayout
                    HAVING COUNT(*) = ?
                    ) vlrc2
                ON vlrc.viewlayout = vlrc2.viewlayout
                INNER JOIN {usr_custom_layout} ucl
                ON ucl.layout = vl.id
                WHERE (' . $rowscolssql . ')
                AND (
                   vl.iscustom = 0
                   OR (