view.php 285 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
    private $numcolumns; // Obsolete - need to leave for upgrade purposes. This can be deleted once we no longer need to support direct upgrades from 15.10 and earlier.
42
    private $columnsperrow; // assoc array of rows set and get using view_rows_columns db table
43
    private $oldcolumnsperrow; // for when we change stuff
44
    private $numrows;
45
    private $layout;
Nigel McNie's avatar
Nigel McNie committed
46
    private $theme;
47
    private $rows;
48
    private $columns;
49
50
    private $dirtyrows; // for when we change stuff
    private $dirtycolumns; // now includes reference to row [row][column]
51
    private $tags;
52
    private $categorydata;
53
    private $template;
54
    private $retainview;
55
    private $copynewuser = 0;
56
    private $copynewgroups;
57
    private $type;
58
    private $visits;
59
    private $allowcomments;
60
    private $approvecomments;
61
    private $collection;
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
    // constansts view templates
    const USER_TEMPLATE = 1;
    const SITE_TEMPLATE = 2;

75
76
77
78
79
80
81
82
83
84
85
86
    /**
     * 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',
    );

87
    /**
88
89
90
     * 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.
91
92
93
     *
     * 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
94
     */
95
    public static $basic_column_layouts = array(
96
97
98
99
100
101
102
103
104
105
106
        1 => array(
            '100',
        ),
        2 => array(
            '50,50',
            '67,33',
            '33,67',
        ),
        3 => array(
            '33,33,33',
            '25,50,25',
107
108
            '25,25,50',
            '50,25,25',
109
110
111
112
113
114
115
116
117
118
119
            '15,70,15',
        ),
        4 => array(
            '25,25,25,25',
            '20,30,30,20',
        ),
        5 => array(
            '20,20,20,20,20',
        ),
    );

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

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

Penny Leach's avatar
Penny Leach committed
236
    public function __construct($id=0, $data=null) {
237
        global $USER;
238
239
240
241
242
        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 = ?',
243
244
                array($id['urlid'], $id['ownerurlid']),
                ERROR_MULTIPLE
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
            );
            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)) {
262
263
264
265
266
267
            $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)
            );
268
            if (empty($tempdata)) {
269
270
                throw new ViewNotFoundException(get_string('viewnotfound', 'error', $id));
            }
271
272
        }
        if (isset($tempdata)) {
273
274
275
276
277
278
            if (!empty($data)) {
                $data = array_merge((array)$tempdata, $data);
            }
            else {
                $data = $tempdata; // use what the database has
            }
279
            $this->id = $tempdata->id;
Penny Leach's avatar
Penny Leach committed
280
281
282
        }
        else {
            $this->ctime = time();
283
            $this->mtime = time();
Penny Leach's avatar
Penny Leach committed
284
            $this->dirty = true;
Penny Leach's avatar
Penny Leach committed
285
286
        }

287
288
        $data = empty($data) ? array() : (array)$data;
        foreach ($data as $field => $value) {
Penny Leach's avatar
Penny Leach committed
289
290
291
292
            if (property_exists($this, $field)) {
                $this->{$field} = $value;
            }
        }
293

294
295
296
297
        if (empty(self::$layoutcolumns)) {
            self::$layoutcolumns = get_records_assoc('view_layout_columns', '', '', 'columns,id');
        }

298
299
300
301
302
303
304
305
306
307
308
        // 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
309
        $this->atime = time();
310
        $this->rows = array();
311
        $this->columns = array();
312
        $this->dirtyrows = array();
313
        $this->dirtycolumns = array();
314
        $this->oldcolumnsperrow = $this->get('columnsperrow');
315
        // set only for existing views - _create provides default value
316
        // Ignore if the constructor is called with deleted set to true
317
318
        if (empty($this->deleted)) {
            if ($this->columnsperrow === false || ($this->numrows > 0 && count($this->columnsperrow) != $this->numrows)) {
319
320
321
322
323
324
325
326
327
328
                // if we are missing the info for some reason we will give the page it's layout back
                // this can happen in MySQL when many users are copying the same page
                if ($this->layout) {
                    if ($rowscols = get_records_sql_array("
                        SELECT vlrc.row, vlc.columns
                        FROM {view_layout_rows_columns} vlrc
                        JOIN {view_layout_columns} vlc ON vlc.id = vlrc.columns
                        WHERE viewlayout = ?", array($this->layout))) {
                            $default = array();
                            foreach ($rowscols as $row) {
329
330
331
332
333
334
335
336
                                if ($this->get('id')) {
                                    $vrc = (object) array(
                                        'view' => $this->get('id'),
                                        'row' => $row->row,
                                        'columns' => $row->columns
                                    );
                                    ensure_record_exists('view_rows_columns', $vrc, $vrc);
                                }
337
338
339
340
341
342
343
344
345
346
347
348
349
                                $default[$row->row] = $row;
                            }
                    }
                }
                else if ($rowscols = get_records_sql_array("
                    SELECT vrc.row, vrc.columns
                    FROM {view} v
                    JOIN {view_rows_columns} vrc ON vrc.view = v.id
                    WHERE v.template = ?
                    AND v.type = ?", array(self::SITE_TEMPLATE, $this->type))) {
                        // Layout not specified so use the view type default layout
                        $default = array();
                        foreach ($rowscols as $row) {
350
351
352
353
354
355
356
357
                            if ($this->get('id')) {
                                $vrc = (object) array(
                                    'view' => $this->get('id'),
                                    'row' => $row->row,
                                    'columns' => $row->columns
                                );
                                ensure_record_exists('view_rows_columns', $vrc, $vrc);
                            }
358
359
360
361
362
                            $default[$row->row] = $row;
                        }
                }
                else {
                    // Layout not known so make it 1 row / 3 cols
363
364
365
366
367
                    if ($this->get('id')) {
                        insert_record('view_rows_columns', (object) array(
                            'view' => $this->get('id'),
                            'row' => 1, 'columns' => 3));
                    }
368
369
370
371
                    $default = self::default_columnsperrow();
                }
                $this->columnsperrow = $default;
            }
372
        }
Penny Leach's avatar
Penny Leach committed
373
374
    }

375
376
    /**
     * Creates a new View for the given user/group/institution.
377
378
     *
     * You can specify who the view is being created _by_ with the second
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
     * 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;
    }

    /**
395
     * Creates a View for the given user, based off a given template and other
396
397
     * View information supplied.
     *
398
     * Will set a default title of 'Copy of $viewtitle' if title is not
399
     * specified in $viewdata and $titlefromtemplate == false.
400
401
402
     *
     * @param array $viewdata See View::_create
     * @param int $templateid The ID of the View to copy
403
     * @param int $userid     The user who has issued the command to create the
404
     *                        view. See View::_create
405
     * @param int $checkaccess Whether to check that the user can see the view before copying it
406
407
     * @param bool $titlefromtemplate Use the default title supplied by template
     * @param array $artefactcopies The mapping between old artefact ids and new ones (created in blockinstance copy)
408
409
     * @return array A list consisting of the new view, the template view and
     *               information about the copy - i.e. how many blocks and
410
     *               artefacts were copied
411
     * @throws SystemException under various circumstances, see the source for
412
413
     *                         more information
     */
414
    public static function create_from_template($viewdata, $templateid, $userid=null, $checkaccess=true, $titlefromtemplate=false, &$artefactcopies) {
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
        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");
        }

431
        if ($checkaccess && !$template->get('template') && !$user->can_edit_view($template)) {
432
433
            throw new SystemException("View::create_from_template: Attempting to create a View from another View that is not marked as a template");
        }
434
        else if ($checkaccess && !can_view_view($templateid, $userid)) {
435
436
437
438
439
440
            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
441
442
443
        if ($titlefromtemplate) {
            $view->set('title', $template->get('title'));
        }
444
        else if (!isset($viewdata['title'])
445
                && !($template->get('owner') === 0
446
                    && $template->get('type') == 'portfolio')) {
447
448
449
450
451
            $desiredtitle = $template->get('title');
            if (get_config('renamecopies')) {
                $desiredtitle = get_string('Copyof', 'mahara', $desiredtitle);
            }
            $view->set('title', self::new_title($desiredtitle, (object)$viewdata));
452
453
            $view->set('dirty', true);
        }
454

455
456
457
458
        $view->urlid = generate_urlid($view->title, get_config('cleanurlviewdefault'), 3, 100);
        $viewdata['owner'] = $userid;
        $view->urlid = self::new_urlid($view->urlid, (object)$viewdata);

459
        try {
460
            $copystatus = $view->copy_contents($template, $artefactcopies);
461
462
463
464
465
        }
        catch (QuotaExceededException $e) {
            db_rollback();
            return array(null, $template, array('quotaexceeded' => true));
        }
466
467

        $view->commit();
468

469
470
471
472
473
        // 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) {
474
475
476
                // is the owner of the copy going to be a group or institution or not?
                $group = $view->group;
                $institution = $view->institution;
477
478
479
480
481
482
483
484
485
                $owner = (!empty($institution) || !empty($group)) ? null : $view->owner;
                $data = (object) array(
                    'usr' => $owner,
                    'group' => $group,
                    'institution' => $institution,
                    'layout' =>  $template->get('layout'),
                );
                $where = clone $data;
                ensure_record_exists('usr_custom_layout', $where, $data);
486
487
488
            }
        }

489
490
491
        $blocks = get_records_array('block_instance', 'view', $view->get('id'));
        if ($blocks) {
            foreach ($blocks as $b) {
492
493
494
495
                // 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();
496
497
498
499
500
501
502
503
504
505
506
507
508
509
                $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);
            }
        }
510
511
512
513
514
515
516

        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');
517
518
519
520
521
522
523
524
            $vaid = insert_record('view_access', $obj, 'id', true);
            handle_event('updateviewaccess', array(
                'id' => $vaid,
                'eventfor' => (!empty($template->get('group')) ? 'group' : 'user'),
                'parentid' => $view->get('id'),
                'parenttype' => 'view',
                'rules' => $obj)
            );
525
526
        }

527
528
529
530
531
532
533
534
535
        db_commit();
        return array(
            $view,
            $template,
            $copystatus,
        );
    }

    /**
536
     * Creates a new View for the given user, based on the given information
537
538
     * about the view.
     *
539
     * Validation of the view data is performed, then the View is created. If
540
541
     * the View is to be owned by a group, that group is given access to it.
     *
542
     * @param array $viewdata Data about the view. You can pass in most fields
543
544
     *                        that appear in the view table.
     *
545
546
     *                        Note that you set who owns the View by setting
     *                        either the owner, group or institution field as
547
548
     *                        approriate.
     *
549
550
     *                        Currently, you cannot pass in access data. Use
     *                        $view->set_access() after retrieving the $view
551
552
     *                        object.
     *
553
554
     * @param int $userid The user who has issued the command to create the
     *                    View (note: this is different from the "owner" of the
555
556
557
     *                    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
558
     * @throws SystemException if the View data is invalid - mostly this is due
559
560
561
     *                         to owner information being specified incorrectly.
     */
    private static function _create(&$viewdata, $userid) {
562
        // If no owner information is provided, assume that the view is being
563
564
565
566
567
568
569
570
571
572
573
574
575
576
        // 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']}");
                }
            }

577
            // Users can only have one view of each non-portfolio type
578
            if (isset($viewdata['type']) && $viewdata['type'] != 'portfolio' && get_record('view', 'owner', $viewdata['owner'], 'type', $viewdata['type'])) {
579
580
                $viewdata['type'] = 'portfolio';
            }
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
        }

        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(
600
            'numcolumns'    => 2, // Obsolete - need to leave for upgrade purposes. This can be deleted once we no longer need to support direct upgrades from 15.10 and earlier.
601
            'numrows'       => 1,
602
            'columnsperrow' => self::default_columnsperrow(),
603
604
605
            'template'      => 0,
            'type'          => 'portfolio',
            'title'         => (array_key_exists('title', $viewdata)) ? $viewdata['title'] : self::new_title(get_string('Untitled', 'view'), (object)$viewdata),
606
            'anonymise'     => 0,
607
608
609
610
        );

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

611
612
613
614
615
        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);
        }

616
617
        $view = new View(0, $data);
        $view->commit();
618

619
620
621
        if (isset($viewdata['group']) &&
            (empty($viewdata['type']) || (!empty($viewdata['type']) && $viewdata['type'] != 'grouphomepage'))
           ) {
622
623
624
            require_once('activity.php');

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

628
            // By default, group views should be visible to the group
629
            $newaccess = (object) array(
630
631
                'view'  => $view->get('id'),
                'group' => $viewdata['group'],
632
                'ctime' => db_format_timestamp(time()),
633
            );
634
635
636
637
638
639
640
641
            $vaid = insert_record('view_access', $newaccess, 'id', true);
            handle_event('updateviewaccess', array(
                'id' => $vaid,
                'eventfor' => 'group',
                'parentid' => $view->get('id'),
                'parenttype' => 'view',
                'rules' => $newaccess)
            );
642
643
            // Notify group members
            $accessdata = new StdClass;
644
            $accessdata->view = $view->get('id');
645
646
            $accessdata->oldusers = $beforeusers;
            activity_occurred('viewaccess', $accessdata);
647
648
        }

649
650
651
652
653
654
655
656
657
658
659
        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));
                }
            }
        }

660
        return new View($view->get('id')); // Reread to ensure defaults are set
661
662
    }

Son Nguyen's avatar
Son Nguyen committed
663
    public static function default_columnsperrow() {
664
665
        $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)) {
666
            throw new SystemException("View::default_columnsperrow: Default columns = 3, widths = '33,33,33' not in view_layout_columns table");
667
668
669
670
        }
        return $default;
    }

Penny Leach's avatar
Penny Leach committed
671
672
673
674
    public function get($field) {
        if (!property_exists($this, $field)) {
            throw new InvalidArgumentException("Field $field wasn't found in class " . get_class($this));
        }
675
676
677
        if ($field == 'tags') { // special case
            return $this->get_tags();
        }
678
679
680
        if ($field == 'categorydata') {
            return $this->get_category_data();
        }
681
682
683
        if ($field == 'collection') {
            return $this->get_collection();
        }
684
685
686
        if ($field == 'columnsperrow') {
            return $this->get_columnsperrow();
        }
Penny Leach's avatar
Penny Leach committed
687
688
689
        return $this->{$field};
    }

690
691
692
693
694
695
696
    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;
697
698
699
700
701
            if ($field != 'atime') {
                // don't bother updating the modified time if we are
                // only wanting to update the accessed time
                $this->mtime = time();
            }
702
703
704
705
706
            return true;
        }
        throw new InvalidArgumentException("Field $field wasn't found in class " . get_class($this));
    }

707
708
709
710
711
712
713
    public function get_tags() {
        if (!isset($this->tags)) {
            $this->tags = get_column('view_tag', 'tag', 'view', $this->get('id'));
        }
        return $this->tags;
    }

714
715
716
    public function get_collection() {
        if (!isset($this->collection)) {
            require_once(get_config('libroot') . 'collection.php');
717
            $this->collection = Collection::search_by_view_id($this->id);
718
719
720
721
        }
        return $this->collection;
    }

722
723
724
725
726
727
728
    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;
    }

729
730
731
732
733
734
735
    public function collection_id() {
        if ($collection = $this->get_collection()) {
            return $collection->get('id');
        }
        return false;
    }

736
737
738
739
740
741
742
743
744
745
    /**
     * 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;
        }
746

747
748
749
750
751
        if (!empty($this->dirty)) {
            return $this->commit();
        }
    }

752
    /**
753
754
755
756
757
758
759
760
761
     * 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;
762
            if (in_array($k, array('mtime', 'ctime', 'atime', 'startdate', 'stopdate', 'submittedtime')) && !empty($v)) {
763
764
765
                $fordb->{$k} = db_format_timestamp($v);
            }
        }
766
767

        db_begin();
768
        $creating = false;
769
        if (empty($this->id)) {
770
            $creating = true;
771
            // users are only allowed one profile view
772
            if (!$this->template && $this->type == 'profile' && record_exists('view', 'owner', $this->owner, 'type', 'profile')) {
773
                throw new SystemException(get_string('onlonlyyoneprofileviewallowed', 'error'));
774
            }
775
            $this->id = insert_record('view', $fordb, 'id', true);
776
            handle_event('createview', array('id' => $this->id, 'eventfor' => 'view', 'viewtype' => $this->type));
777
778
779
        }
        else {
            update_record('view', $fordb, 'id');
780
            handle_event('saveview', array('id' => $this->id, 'eventfor' => 'view', 'viewtype' => $this->type));
781
        }
782

783
        if (isset($this->tags)) {
784
            $this->tags = check_case_sensitive($this->tags, 'view_tag');
785
786
            delete_records('view_tag', 'view', $this->get('id'));
            foreach ($this->get_tags() as $tag) {
787
788
                //truncate the tag before insert it into the database
                $tag = substr($tag, 0, 128);
789
790
                insert_record('view_tag', (object)array( 'view' => $this->get('id'), 'tag' => $tag));
            }
791
792
        }

793
794
795
796
797
798
799
        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));
            }
        }

800
801
802
803
804
805
806
807
808
809
810
811
        $columnsperrowchanged = (!empty($this->oldcolumnsperrow)) ? array_udiff($this->oldcolumnsperrow, $this->columnsperrow, function($oa, $ob) {
            $rows = $oa->row - $ob->row;
            $columns = $oa->columns - $ob->columns;
            if ($rows != 0) {
                return $rows;
            }
            else if ($columns != 0) {
                return $columns;
            }
            return 0;
        }) : false;

812
        if (isset($this->columnsperrow) && (!empty($columnsperrowchanged) || $creating)) {
813
814
815
816
817
818
            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));
            }
        }

819
820
        db_commit();

821
822
823
824
        $this->dirty = false;
        $this->deleted = false;
    }

825
826
827
828
829
    /**
     * Returns an array of all the artefacts on this page.
     *
     * @return array
     */
Penny Leach's avatar
Penny Leach committed
830
    public function get_artefact_instances() {
831
        $this->artefact_instances = array();
Penny Leach's avatar
Penny Leach committed
832

833
834
835
836
837
838
        $sql = 'SELECT a.*, i.name, i.plugin, va.block
                FROM {view_artefact} va
                JOIN {artefact} a ON va.artefact = a.id
                JOIN {artefact_installed_type} i ON a.artefacttype = i.name
                WHERE va.view = ?';
        $this->artefact_metadata = get_records_sql_array($sql, array($this->id));
Penny Leach's avatar
Penny Leach committed
839

840
841
842
843
844
845
        if ($instances = $this->artefact_metadata) {
            foreach ($instances as $instance) {
                safe_require('artefact', $instance->plugin);
                $classname = generate_artefact_class_name($instance->artefacttype);
                $i = new $classname($instance->id, $instance);
                $this->artefact_instances[] = $i;
846
847
            }
        }
848
        return $this->artefact_instances;
Penny Leach's avatar
Penny Leach committed
849
    }
Penny Leach's avatar
Penny Leach committed
850
851

    public function get_owner_object() {
852
        if (empty($this->owner)) {
853
854
            return false;
        }
Penny Leach's avatar
Penny Leach committed
855
        if (!isset($this->ownerobj)) {
856
857
858
859
            // $this->ownerobj = get_user_for_display($this->get('owner'));
            $user = new User();
            $user->find_by_id($this->get('owner'));
            $this->ownerobj = $user;
Penny Leach's avatar
Penny Leach committed
860
861
862
863
        }
        return $this->ownerobj;
    }

864
865
    public function get_group_object() {
        if (!isset($this->groupobj)) {
866
            $this->groupobj = get_group_by_id($this->get('group'), true);
867
868
869
870
        }
        return $this->groupobj;
    }

871
872
873
874
875
876
877
    public function get_institution_object() {
        if (!isset($this->institutionobj)) {
            $this->institutionobj = get_record('institution', 'name', $this->get('institution'));
        }
        return $this->institutionobj;
    }

878
    public function delete() {
879
        safe_require('artefact', 'comment');
880
        db_begin();
881
        ArtefactTypeComment::delete_view_comments($this->id);
882
        delete_records('view_access','view',$this->id);
883
        delete_records('view_autocreate_grouptype', 'view', $this->id);
884
        delete_records('view_tag','view',$this->id);
885
        delete_records('view_visit','view',$this->id);
886
        $eventdata = array('id' => $this->id, 'eventfor' => 'view');
887
        if ($collection = $this->get_collection()) {
888
            $eventdata['collection'] = $collection->get('id');
889
890
            $collection->remove_view($this->id);
        }
891
        delete_records('usr_watchlist_view','view',$this->id);
892
        if ($blockinstanceids = get_column('block_instance', 'id', 'view', $this->id)) {
893
            require_once(get_config('docroot') . 'blocktype/lib.php');
894
895
896
897
898
            foreach ($blockinstanceids as $id) {
                $bi = new BlockInstance($id);
                $bi->delete();
            }
        }
899
        handle_event('deleteview', $eventdata);
900
        delete_records('view_rows_columns', 'view', $this->id);
901
        delete_records('view','id',$this->id);
902
903
904
905
906
        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);
        }
907
908
        require_once('embeddedimage.php');
        EmbeddedImage::delete_embedded_images('description', $this->id);
909
        $this->deleted = true;
910
        db_commit();
911
912
    }

913
914
915
916
917
918
    /* 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.
     */
919
    public function get_access($timeformat=null) {
920
        if ($data = $this->get_access_records()) {
921
            return $this->process_access_records($data, $timeformat);
922
923
924
        }
        return array();
    }
925

926
    public function get_access_records() {
927
        $data = get_records_sql_array("
928
            SELECT accesstype, va.group, institution, role, usr, startdate, stopdate, allowcomments, approvecomments
929
            FROM {view_access} va
930
            WHERE view = ? AND visible = 1 AND token IS NULL
931
932
933
            ORDER BY
                accesstype IS NULL, accesstype DESC,
                va.group, role IS NOT NULL, role,
934
                institution, usr,
935
936
                startdate IS NOT NULL, startdate, stopdate IS NOT NULL, stopdate,
                allowcomments, approvecomments",
937
938
            array($this->id)
        );
939
940
        return $data ? $data : array();
    }
941

942
    public function process_access_records($data=array(), $timeformat=null) {
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
        $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()
            );
        }
958

959
960
        foreach ($data as &$item) {
            $item = (array)$item;
Eugene Venter's avatar
Eugene Venter committed
961
            $item['locked'] = false; // Indicate if item is editable
962
963
964
965
966
967
968
969
            if ($item['usr']) {
                $item['type'] = 'user';
                $item['id'] = $item['usr'];
            }
            else if ($item['group']) {
                $item['type'] = 'group';
                $item['id'] = $item['group'];
            }
970
971
972
            else if ($item['institution']) {
                $item['type'] = 'institution';
                $item['id'] = $item['institution'];
973
974
975
976
977
978
979

                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;
                    }
                }
980
            }
981
982
983
984
985
            else {
                $item['type'] = $item['accesstype'];
                $item['id'] = null;
            }

986
987
988
989
            if ($this->type == 'profile' && $item['type'] == 'loggedin' && get_config('loggedinprofileviewaccess')) {
                $item['locked'] = true;
            }

990
991
992
993
994
995
            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']));
996
                }
997
998
                if ($item['stopdate']) {
                    $item['stopdate'] = strftime($timeformat, strtotime($item['stopdate']));
999
                }
1000
            }
1001
        }
1002
1003
1004
        return $data;
    }

1005
1006
1007
1008
1009
    public static function update_view_access($config, $viewids) {

        db_begin();

        // Use set_access() on the first view to get a hopefully consistent
1010
        // and complete representation of the access list
1011
        $firstview = new View($viewids[0]);
1012
        $fullaccesslist = $firstview->set_access($config['accesslist'], $viewids, $config['allowcomments']);
1013
1014

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

1017
1018
1019
        // 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
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
        usort(
            $fullaccesslist,
            static function ($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))
                    || ($c = !empty($a->institution) - !empty($b->institution))
                    || ($c = strcmp($a->institution, $b->institution))
                    || ($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;
            }
        );
1041

1042
1043
1044
1045
1046
1047
1048
1049
1050
        // Hash the config object so later on we can easily find
        // all the views with the same config/access rights
        $config['accesslist'] = $fullaccesslist;

        foreach ($viewids as $viewid) {
            $v = new View((int) $viewid);
            $v->set('startdate', $config['startdate']);
            $v->set('stopdate', $config['stopdate']);
            $v->set('template', $config['template']);
1051
            $v->set('retainview', $config['retainview']);
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
            $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->commit();
        }

        db_commit();
    }

1066
1067
1068
1069
    /* Returns preview image for creation of custom layout
     *
     * @param array
     * @return string SVG preview image
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
     */
    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);
1094
            $customlayout[$i+1] = $widths;
1095
1096
            $hyphenatedwidths = str_replace(',', '-', $widths);
            $alttext .= $hyphenatedwidths;
1097
            if ($i != $numrows - 1) {
1098
1099
1100
1101
                $alttext .= ' / ';
            }
        }

1102
1103
1104
1105
1106
1107
1108
1109
1110
        // Generate thumbnail images.
        $data = array();
        $data['layout'] = $customlayout;
        $data['text'] = $alttext;

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

        return $previewimage;
1111
1112
    }

1113
1114
1115
1116
1117
1118
1119
    /*
     * Adds custom layout records to database and returns an array
    * with layout id and image preview.
    *
    * @param array
    * @return array
    */
1120
    public function addcustomlayout($values) {
1121
        require_once(get_config('libroot') . 'layoutpreviewimage.php');
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
        $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)];
            }
        }

1150
        $owner = $this->owner;
1151
1152
1153
        $group = $this->group;
        $institution = $this->institution;
        if (!empty($group)) {
1154