lib.php 25.1 KB
Newer Older
1
2
<?php
/**
Francois Marier's avatar
Francois Marier committed
3
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
4
 * Copyright (C) 2006-2008 Catalyst IT Ltd (http://www.catalyst.net.nz)
5
 *
Francois Marier's avatar
Francois Marier committed
6
7
8
9
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
10
 *
Francois Marier's avatar
Francois Marier committed
11
12
13
14
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
15
 *
Francois Marier's avatar
Francois Marier committed
16
17
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18
19
20
 *
 * @package    mahara
 * @subpackage artefact-blog
21
 * @author     Catalyst IT Ltd
22
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
23
 * @copyright  (C) 2006-2008 Catalyst IT Ltd http://catalyst.net.nz
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 *
 */

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

/** 
 * Users can create blogs and blog posts using this plugin.
 */
class PluginArtefactBlog extends PluginArtefact {

    public static function get_artefact_types() {
        return array(
            'blog',
            'blogpost',
        );
    }
40
41
42
43
    
    public static function get_block_types() {
        return array();
    }
44
45
46
47
48
49
50

    public static function get_plugin_name() {
        return 'blog';
    }

    public static function menu_items() {
        return array(
Martyn Smith's avatar
Martyn Smith committed
51
            array(
52
53
                'path'   => 'myportfolio/blogs',
                'url'    => 'artefact/blog/',
54
                'title'  => get_string('myblogs', 'artefact.blog'),
55
56
                'weight' => 30,
            ),
57
58
        );
    }
59

60
    public static function get_cron() {
61
        return array();
62
63
    }

64

65
66
67
68
69
70
71
72
73
74
    public static function get_event_subscriptions() {
        return array(
            (object)array(
                'plugin'       => 'blog',
                'event'        => 'createuser',
                'callfunction' => 'create_default_blog',
            ),
        );
    }

75
76
77
78
79
80
81
    public static function block_advanced_options_element($configdata, $artefacttype) {
        $strartefacttype = get_string($artefacttype, 'artefact.blog');
        return array(
            'type' => 'fieldset',
            'name' => 'advanced',
            'collapsible' => true,
            'collapsed' => false,
82
            'legend' => get_string('moreoptions', 'artefact.blog'),
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
            'elements' => array(
                'copytype' => array(
                    'type' => 'select',
                    'title' => get_string('blockcopypermission', 'view'),
                    'description' => get_string('blockcopypermissiondesc', 'view'),
                    'defaultvalue' => isset($configdata['copytype']) ? $configdata['copytype'] : 'nocopy',
                    'options' => array(
                        'nocopy' => get_string('copynocopy', 'artefact.blog'),
                        'reference' => get_string('copyreference', 'artefact.blog', $strartefacttype),
                        'full' => get_string('copyfull', 'artefact.blog', $strartefacttype),
                    ),
                ),
            ),
        );
    }

99
100
101
102
103
104
105
106
    public static function create_default_blog($event, $user) {
        $name = display_name($user, null, true);
        $blog = new ArtefactTypeBlog(0, (object) array(
            'title'       => get_string('defaultblogtitle', 'artefact.blog', $name),
            'owner'       => $user['id'],
        ));
        $blog->commit();
    }
107
108
109
110
111
112
113
}

/**
 * A Blog artefact is a collection of BlogPost artefacts.
 */
class ArtefactTypeBlog extends ArtefactType {

Alastair Pharo's avatar
Alastair Pharo committed
114
115
116
117
    /**
     * This constant gives the per-page pagination for listing blogs.
     */
    const pagination = 10;
118
119


120
121
122
123
124
125
126
127
    /**
     * We override the constructor to fetch the extra data.
     *
     * @param integer
     * @param object
     */
    public function __construct($id = 0, $data = null) {
        parent::__construct($id, $data);
128
129
130
131
132
133
134
135

        if (empty($this->id)) {
            $this->container = 1;
        }
    }

    public function is_container() {
        return true;
136
    }
Alastair Pharo's avatar
Alastair Pharo committed
137
138

    /**
139
140
141
     * This function updates or inserts the artefact.  This involves putting
     * some data in the artefact table (handled by parent::commit()), and then
     * some data in the artefact_blog_blog table.
Alastair Pharo's avatar
Alastair Pharo committed
142
     */
143
    public function commit() {
144
145
146
147
148
149
150
151
152
153
154
155
        // Just forget the whole thing when we're clean.
        if (empty($this->dirty)) {
            return;
        }
      
        // We need to keep track of newness before and after.
        $new = empty($this->id);
        
        // Commit to the artefact table.
        parent::commit();

        $this->dirty = false;
156
157
    }

Alastair Pharo's avatar
Alastair Pharo committed
158
    /**
159
160
     * This function extends ArtefactType::delete() by deleting blog-specific
     * data.
Alastair Pharo's avatar
Alastair Pharo committed
161
     */
162
    public function delete() {
163
164
165
166
167
168
        if (empty($this->id)) {
            return;
        }

        // Delete the artefact and all children.
        parent::delete();
169
170
    }

171
172
173
174
175
176
177
178
179
180
181
182
183
    /**
     * Checks that the person viewing this blog is the owner. If not, throws an 
     * AccessDeniedException. Used in the blog section to ensure only the 
     * owners of the blogs can view or change them there. Other people see 
     * blogs when they are placed in views.
     */
    public function check_permission() {
        global $USER;
        if ($USER->get('id') != $this->owner) {
            throw new AccessDeniedException(get_string('youarenottheownerofthisblog', 'artefact.blog'));
        }
    }

184

185
186
    public function describe_size() {
        return $this->count_children() . ' ' . get_string('posts', 'artefact.blog');
187
188
    }

189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
    /**
     * Renders a blog for a view. This involves using a tablerenderer to paginate the posts.
     *
     * This uses some legacy stuff from the old views interface, including its 
     * dependence on javascript and the table renderer, which would be nice to 
     * fix using the new pagination stuff some time.
     *
     * @param  array  Options for rendering
     * @return array  A two key array, 'html' and 'javascript'.
     */
    public function render_self($options) {
        $this->add_to_render_path($options);

        $smarty = smarty_core();
        if (isset($options['viewid'])) {
204
205
            $smarty->assign('artefacttitle', '<a href="' . get_config('wwwroot') . 'view/artefact.php?artefact='
                                             . $this->get('id') . '&view=' . $options['viewid']
Richard Mansfield's avatar
Richard Mansfield committed
206
                                             . '">' . hsc($this->get('title')) . '</a>');
207
208
        }
        else {
Richard Mansfield's avatar
Richard Mansfield committed
209
            $smarty->assign('artefacttitle', hsc($this->get('title')));
210
211
212
        }

        $smarty->assign('options', $options);
Richard Mansfield's avatar
Richard Mansfield committed
213
        $smarty->assign('description', clean_html($this->get('description')));
214
215
216

        // Remove unnecessary options for blog posts
        unset($options['hidetitle']);
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254

        $page = (isset($options['page'])) ? abs(intval($options['page'])) : abs(param_integer('page', 1));
        $offset = $page ? $page * self::pagination - self::pagination : 1;

        $postids = get_column_sql("
            SELECT a.id
            FROM {artefact} a
            LEFT JOIN {artefact_blog_blogpost} bp ON a.id = bp.blogpost
            WHERE a.parent = ?
            AND bp.published = 1
            ORDER BY a.ctime DESC
            LIMIT ? OFFSET ?", array($this->get('id'), self::pagination, $offset));
        $postcount = $this->count_published_posts();

        $data = array();
        foreach($postids as $postid) {
            $blogpost = new ArtefactTypeBlogPost($postid);
            $data[] = array(
                'id' => $postid,
                'content' => $blogpost->render_self($options)
            );
        }
        $smarty->assign('postdata', $data);

        // Pagination
        if ($postcount > self::pagination) {
            $baselink = get_config('wwwroot') . 'view/artefact.php?artefact=' . $this->get('id');
            if (isset($options['viewid'])) {
                $baselink .= '&view=' . $options['viewid'];
            }

            if ($offset + self::pagination < $postcount) {
                $smarty->assign('olderpostslink',  $baselink . '&page=' . ($page + 1));
            }
            if ($offset > 0) {
                $smarty->assign('newerpostslink',  $baselink . '&page=' . ($page - 1));
            }
        }
255
256
257
258

        return array('html' => $smarty->fetch('blocktype:blog:blog_render_self.tpl'), 'javascript' => '');
    }

259
                
260
    public static function get_icon($options=null) {
261
262
    }

Nigel McNie's avatar
Nigel McNie committed
263
    public static function is_singular() {
Penny Leach's avatar
Penny Leach committed
264
265
266
        return false;
    }

Alastair Pharo's avatar
Alastair Pharo committed
267
    public static function collapse_config() {
268
269
    }

Alastair Pharo's avatar
Alastair Pharo committed
270
271
272
273
274
275
    /**
     * This function returns a list of the given user's blogs.
     *
     * @param User
     * @return array (count: integer, data: array)
     */
276
277
    public static function get_blog_list($limit, $offset) {
        global $USER;
Alastair Pharo's avatar
Alastair Pharo committed
278
        ($result = get_records_sql_array("
279
280
         SELECT * FROM {artefact} WHERE owner = ? AND artefacttype = 'blog'
         ORDER BY title LIMIT ? OFFSET ?", array($USER->get('id'), $limit, $offset)))
Alastair Pharo's avatar
Alastair Pharo committed
281
282
            || ($result = array());

283
        $count = (int)get_field('artefact', 'COUNT(*)', 'owner', $USER->get('id'), 'artefacttype', 'blog');
Alastair Pharo's avatar
Alastair Pharo committed
284
285
286
287

        return array($count, $result);
    }

288
289
290
    public static function build_blog_list_html(&$blogs) {
        $smarty = smarty_core();
        $smarty->assign_by_ref('blogs', $blogs);
291
292
        $blogs->tablerows = $smarty->fetch('artefact:blog:bloglist.tpl');
        $pagination = build_pagination(array(
293
294
295
            'id' => 'bloglist_pagination',
            'class' => 'center',
            'url' => get_config('wwwroot') . 'artefact/blog/index.php',
296
297
            'jsonscript' => 'artefact/blog/index.json.php',
            'datatable' => 'bloglist',
298
299
300
301
302
303
304
305
306
307
308
            'count' => $blogs->count,
            'limit' => $blogs->limit,
            'offset' => $blogs->offset,
            'firsttext' => '',
            'previoustext' => '',
            'nexttext' => '',
            'lasttext' => '',
            'numbersincludefirstlast' => false,
            'resultcounttextsingular' => get_string('blog', 'artefact.blog'),
            'resultcounttextplural' => get_string('blogs', 'artefact.blog'),
        ));
309
310
        $blogs->pagination = $pagination['html'];
        $blogs->pagination_js = $pagination['javascript'];
311
312
    }

Alastair Pharo's avatar
Alastair Pharo committed
313
314
315
316
317
318
    /**
     * This function creates a new blog.
     *
     * @param User
     * @param array
     */
Alastair Pharo's avatar
Alastair Pharo committed
319
    public static function new_blog(User $user, array $values) {
Alastair Pharo's avatar
Alastair Pharo committed
320
321
322
323
        $artefact = new ArtefactTypeBlog();
        $artefact->set('title', $values['title']);
        $artefact->set('description', $values['description']);
        $artefact->set('owner', $user->get('id'));
324
        $artefact->set('tags', $values['tags']);
Alastair Pharo's avatar
Alastair Pharo committed
325
        $artefact->commit();
326
    }
Alastair Pharo's avatar
Alastair Pharo committed
327
328
329
330
331
332
333
334
335
336
337
338
339

    /**
     * This function updates an existing blog.
     *
     * @param User
     * @param array
     */
    public static function edit_blog(User $user, array $values) {
        if (empty($values['id']) || !is_numeric($values['id'])) {
            return;
        }

        $artefact = new ArtefactTypeBlog($values['id']);
340
341
342
343
        if ($user->get('id') != $artefact->get('owner')) {
            return;
        }
        
Alastair Pharo's avatar
Alastair Pharo committed
344
345
        $artefact->set('title', $values['title']);
        $artefact->set('description', $values['description']);
346
        $artefact->set('tags', $values['tags']);
Alastair Pharo's avatar
Alastair Pharo committed
347
348
        $artefact->commit();
    }
349

Martyn Smith's avatar
Martyn Smith committed
350
351
    public static function get_links($id) {
        $wwwroot = get_config('wwwroot');
352

Martyn Smith's avatar
Martyn Smith committed
353
354
355
356
357
        return array(
            '_default'                                  => $wwwroot . 'artefact/blog/view/?id=' . $id,
            get_string('blogsettings', 'artefact.blog') => $wwwroot . 'artefact/blog/settings/?id=' . $id,
        );
    }
358
359
360
361
362

    public function copy_extra($new) {
        $new->set('title', get_string('Copyof', 'mahara', $this->get('title')));
    }

363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
    /**
     * Returns the number of posts in this blog that have been published.
     *
     * The result of this function looked up from the database each time, so 
     * cache it if you know it's safe to do so.
     *
     * @return int
     */
    public function count_published_posts() {
        return (int)get_field_sql("
            SELECT COUNT(*)
            FROM {artefact} a
            LEFT JOIN {artefact_blog_blogpost} bp ON a.id = bp.blogpost
            WHERE a.parent = ?
            AND bp.published = 1", array($this->get('id')));
    }

380
381
382
383
384
385
386
}

/**
 * BlogPost artefacts occur within Blog artefacts
 */
class ArtefactTypeBlogPost extends ArtefactType {

387
    /**
Alastair Pharo's avatar
Alastair Pharo committed
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
     * This defines whether the blogpost is published or not.
     *
     * @var boolean
     */
    protected $published = false;

    /**
     * We override the constructor to fetch the extra data.
     *
     * @param integer
     * @param object
     */
    public function __construct($id = 0, $data = null) {
        parent::__construct($id, $data);

403
404
405
406
407
        if ($this->id) {
            if ($bpdata = get_record('artefact_blog_blogpost', 'blogpost', $this->id)) {
                foreach($bpdata as $name => $value) {
                    if (property_exists($this, $name)) {
                        $this->$name = $value;
408
                    }
Alastair Pharo's avatar
Alastair Pharo committed
409
                }
410
411
412
413
            }
            else {
                // This should never happen unless the user is playing around with blog post IDs in the location bar or similar
                throw new ArtefactNotFoundException(get_string('blogpostdoesnotexist', 'artefact.blog'));
414
415
            }
        }
Alastair Pharo's avatar
Alastair Pharo committed
416
417
418
    }

    /**
419
     * This method extends ArtefactType::commit() by adding additional data
Alastair Pharo's avatar
Alastair Pharo committed
420
     * into the artefact_blog_blogpost table.
421
422
423
424
425
     *
     * This method also works out what blockinstances this blogpost is in, and 
     * informs them that they should re-check what artefacts they have in them.
     * The post content may now link to different artefacts. See {@link 
     * PluginBlocktypeBlogPost::get_artefacts for more information}
426
     */
427
    public function commit() {
Alastair Pharo's avatar
Alastair Pharo committed
428
429
430
431
        if (empty($this->dirty)) {
            return;
        }

432
        db_begin();
Alastair Pharo's avatar
Alastair Pharo committed
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
        $new = empty($this->id);
      
        parent::commit();

        $this->dirty = true;

        $data = (object)array(
            'blogpost'  => $this->get('id'),
            'published' => ($this->get('published') ? 1 : 0)
        );

        if ($new) {
            insert_record('artefact_blog_blogpost', $data);
        }
        else {
            update_record('artefact_blog_blogpost', $data, 'blogpost');
        }

451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
        // We want to get all blockinstances that contain this blog post. That is currently:
        // 1) All blogpost blocktypes with this post in it
        // 2) All blog blocktypes with this posts's blog in it
        //
        // With these, we tell them to rebuild what artefacts they have in them, 
        // since the post content could have changed and now have links to 
        // different artefacts in it
        $blockinstanceids = (array)get_column_sql('SELECT block
            FROM {view_artefact}
            WHERE artefact = ?
            OR artefact = ?', array($this->get('id'), $this->get('parent')));
        if ($blockinstanceids) {
            require_once(get_config('docroot') . 'blocktype/lib.php');
            foreach ($blockinstanceids as $id) {
                $instance = new BlockInstance($id);
                $instance->rebuild_artefact_list();
            }
        }

        db_commit();
Alastair Pharo's avatar
Alastair Pharo committed
471
        $this->dirty = false;
472
473
    }

474
    /**
Alastair Pharo's avatar
Alastair Pharo committed
475
476
     * This function extends ArtefactType::delete() by also deleting anything
     * that's in blogpost.
477
     */
478
    public function delete() {
Alastair Pharo's avatar
Alastair Pharo committed
479
480
481
        if (empty($this->id)) {
            return;
        }
482

483
        $this->detach(); // Detach all file attachments
Alastair Pharo's avatar
Alastair Pharo committed
484
485
486
487
        delete_records('artefact_blog_blogpost', 'blogpost', $this->id);
      
        parent::delete();
    }
488
489
490
491
492
493
494
495
496
497
498
499
500

    /**
     * Checks that the person viewing this blog is the owner. If not, throws an 
     * AccessDeniedException. Used in the blog section to ensure only the 
     * owners of the blogs can view or change them there. Other people see 
     * blogs when they are placed in views.
     */
    public function check_permission() {
        global $USER;
        if ($USER->get('id') != $this->owner) {
            throw new AccessDeniedException(get_string('youarenottheownerofthisblogpost', 'artefact.blog'));
        }
    }
501
  
502
503
    public function describe_size() {
        return $this->count_attachments() . ' ' . get_string('attachments', 'artefact.blog');
504
505
    }

506
507
508
509
    public function render_self($options) {
        $smarty = smarty_core();
        if (empty($options['hidetitle'])) {
            if (isset($options['viewid'])) {
510
                $smarty->assign('artefacttitle', '<a href="' . get_config('wwwroot') . 'view/artefact.php?artefact='
511
                     . $this->get('id') . '&amp;view=' . $options['viewid']
Richard Mansfield's avatar
Richard Mansfield committed
512
                     . '">' . hsc($this->get('title')) . '</a>');
513
514
            }
            else {
Richard Mansfield's avatar
Richard Mansfield committed
515
                $smarty->assign('artefacttitle', hsc($this->get('title')));
516
517
518
519
            }
        }

        // We need to make sure that the images in the post have the right viewid associated with them
Richard Mansfield's avatar
Richard Mansfield committed
520
        $postcontent = clean_html($this->get('description'));
521
        if (isset($options['viewid'])) {
522
523
            safe_require('artefact', 'file');
            $postcontent = ArtefactTypeFolder::append_view_url($postcontent, $options['viewid']);
524
525
526
        }
        $smarty->assign('artefactdescription', $postcontent);
        $smarty->assign('artefact', $this);
527
        $attachments = $this->get_attachments();
528
529
        if ($attachments) {
            $this->add_to_render_path($options);
530
            require_once(get_config('docroot') . 'artefact/lib.php');
531
532
533
            foreach ($attachments as &$attachment) {
                $f = artefact_instance_from_id($attachment->id);
                $attachment->size = $f->describe_size();
534
535
                $attachment->iconpath = $f->get_icon(array('id' => $attachment->id, 'viewid' => isset($options['viewid']) ? $options['viewid'] : 0));
                $attachment->viewpath = get_config('wwwroot') . 'view/artefact.php?artefact=' . $attachment->id . '&view=' . (isset($options['viewid']) ? $options['viewid'] : 0);
536
537
                $attachment->downloadpath = get_config('wwwroot') . 'artefact/file/download.php?file=' . $attachment->id;
                if (isset($options['viewid'])) {
538
                    $attachment->downloadpath .= '&view=' . $options['viewid'];
539
540
541
542
543
544
545
546
547
548
549
550
                }
            }
            $smarty->assign('attachments', $attachments);
        }
        $smarty->assign('postedbyon', get_string('postedbyon', 'artefact.blog',
                                                 display_name($this->owner),
                                                 format_date($this->ctime)));
        return array('html' => $smarty->fetch('artefact:blog:render/blogpost_renderfull.tpl'),
                     'javascript' => '');
    }


551
552
    public function can_have_attachments() {
        return true;
Richard Mansfield's avatar
Richard Mansfield committed
553
554
555
    }


556
    public static function get_icon($options=null) {
557
558
    }

Nigel McNie's avatar
Nigel McNie committed
559
    public static function is_singular() {
Penny Leach's avatar
Penny Leach committed
560
561
562
        return false;
    }

Alastair Pharo's avatar
Alastair Pharo committed
563
    public static function collapse_config() {
564
565
    }

Alastair Pharo's avatar
Alastair Pharo committed
566
567
568
569
570
571
572
573
574
    /**
     * This function returns a list of the current user's blog posts, for the
     * given blog.
     *
     * @param User
     * @param integer
     * @param integer
     */
    public static function get_posts(User $user, $id, $limit = self::pagination, $offset = 0) {
575
        ($result = get_records_sql_assoc("
576
         SELECT a.id, a.title, a.description, " . db_format_tsfield('a.ctime', 'ctime') . ', ' . db_format_tsfield('a.mtime', 'mtime') . ", bp.published
577
578
         FROM {artefact} a
          LEFT OUTER JOIN {artefact_blog_blogpost} bp
Alastair Pharo's avatar
Alastair Pharo committed
579
580
581
582
           ON a.id = bp.blogpost
         WHERE a.parent = ?
          AND a.artefacttype = 'blogpost'
          AND a.owner = ?
583
         ORDER BY bp.published ASC, a.ctime DESC
Alastair Pharo's avatar
Alastair Pharo committed
584
585
586
587
588
589
590
591
         LIMIT ? OFFSET ?;", array(
            $id,
            $user->get('id'),
            $limit,
            $offset
        )))
            || ($result = array());

592
593
594
        $count = (int)get_field('artefact', 'COUNT(*)', 'owner', $user->get('id'), 
                                'artefacttype', 'blogpost', 'parent', $id);

595
        if (count($result) > 0) {
596
            // Get the attached files.
597
            $files = ArtefactType::attachments_from_id_list(array_map(create_function('$a', 'return $a->id;'), $result));
598
            if ($files) {
599
600
601
                safe_require('artefact', 'file');
                foreach ($files as &$file) {
                    $file->icon = call_static_method(generate_artefact_class_name($file->artefacttype), 'get_icon', array('id' => $file->attachment));
602
                    $result[$file->artefact]->files[] = $file;
603
604
                }
            }
605
606
607
608
609

            // Format dates properly
            foreach ($result as &$post) {
                $post->ctime = format_date($post->ctime, 'strftimedaydatetime');
                $post->mtime = format_date($post->mtime);
Richard Mansfield's avatar
Richard Mansfield committed
610
                $post->description = clean_html($post->description);
611
            }
612
        }
Alastair Pharo's avatar
Alastair Pharo committed
613

614
        return array($count, array_values($result));
Alastair Pharo's avatar
Alastair Pharo committed
615
616
    }

617
    /** 
Alastair Pharo's avatar
Alastair Pharo committed
618
619
620
621
622
623
624
625
626
627
    /**
     * This function creates a new blog post.
     *
     * @param User
     * @param array
     */
    public static function new_post(User $user, array $values) {
        $artefact = new ArtefactTypeBlogPost();
        $artefact->set('title', $values['title']);
        $artefact->set('description', $values['description']);
Alastair Pharo's avatar
Alastair Pharo committed
628
        $artefact->set('published', $values['published']);
Alastair Pharo's avatar
Alastair Pharo committed
629
        $artefact->set('owner', $user->get('id'));
630
        $artefact->set('parent', $values['parent']);
Alastair Pharo's avatar
Alastair Pharo committed
631
        $artefact->commit();
632
        return true;
633
    }
Alastair Pharo's avatar
Alastair Pharo committed
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649

    /** 
     * This function updates an existing blog post.
     *
     * @param User
     * @param array
     */
    public static function edit_post(User $user, array $values) {
        $artefact = new ArtefactTypeBlogPost($values['id']);
        if ($user->get('id') != $artefact->get('owner')) {
            return false;
        }

        $artefact->set('title', $values['title']);
        $artefact->set('description', $values['description']);
        $artefact->set('published', $values['published']);
650
        $artefact->set('tags', $values['tags']);
Alastair Pharo's avatar
Alastair Pharo committed
651
652
653
654
        $artefact->commit();
        return true;
    }

655

Alastair Pharo's avatar
Alastair Pharo committed
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
    /**
     * This function publishes the blog post.
     *
     * @return boolean
     */
    public function publish() {
        if (!$this->id) {
            return false;
        }
        
        $data = (object)array(
            'blogpost'  => $this->id,
            'published' => 1
        );

        if (get_field('artefact_blog_blogpost', 'COUNT(*)', 'blogpost', $this->id)) {
            update_record('artefact_blog_blogpost', $data, 'blogpost');
        }
        else {
            insert_record('artefact_blog_blogpost', $data);
        }
        return true;
    }
679

680
    
Martyn Smith's avatar
Martyn Smith committed
681
682
683
684
685
686
687
    public static function get_links($id) {
        $wwwroot = get_config('wwwroot');

        return array(
            '_default'                                  => $wwwroot . 'artefact/blog/post.php?blogpost=' . $id,
        );
    }
688
689
690
691
692
693
694
695
696
697

    public function update_artefact_references(&$view, &$template, &$artefactcopies, $oldid) {
        parent::update_artefact_references($view, $template, $artefactcopies, $oldid);
        // Attach copies of the files that were attached to the old post.
        // Update <img> tags in the post body to refer to the new image artefacts.
        $regexp = array();
        $replacetext = array();
        if (isset($artefactcopies[$oldid]->oldattachments)) {
            foreach ($artefactcopies[$oldid]->oldattachments as $a) {
                if (isset($artefactcopies[$a])) {
698
                    $this->attach($artefactcopies[$a]->newid);
699
700
701
702
703
704
705
706
                }
                $regexp[] = '#<img([^>]+)src="' . get_config('wwwroot') . 'artefact/file/download.php\?file=' . $a . '"#';
                $replacetext[] = '<img$1src="' . get_config('wwwroot') . 'artefact/file/download.php?file=' . $artefactcopies[$a]->newid . '"';
            }
            $this->set('description', preg_replace($regexp, $replacetext, $this->get('description')));
        }
    }

707
708
709
710
711
    /**
     * During the copying of a view, we might be allowed to copy
     * blogposts but not the containing blog.  We need to create a new
     * blog to hold the copied posts.
     */
712
    public function default_parent_for_copy(&$view, &$template, $artefactstoignore) {
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
        static $blogid;

        if (!empty($blogid)) {
            return $blogid;
        }

        $blogname = get_string('viewposts', 'artefact.blog', $view->get('id'));
        $data = (object) array(
            'title'       => $blogname,
            'description' => get_string('postscopiedfromview', 'artefact.blog', $template->get('title')),
            'owner'       => $view->get('owner'),
            'group'       => $view->get('group'),
            'institution' => $view->get('institution'),
        );
        $blog = new ArtefactTypeBlog(0, $data);
        $blog->commit();

        $blogid = $blog->get('id');

        return $blogid;
    }
734
735
736
737
738
739
740
741

    /**
     * Looks through the blog post text for links to download artefacts, and 
     * returns the IDs of those artefacts.
     */
    public function get_referenced_artefacts_from_postbody() {
        return artefact_get_references_in_html($this->get('description'));
    }
742
}
743

744

745
?>