lib.php 23.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
<?php
/**
 * This program is part of Mahara
 *
 *  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 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 *
 * @package    mahara
 * @subpackage artefact-blog
 * @author     Alastair Pharo <alastair@catalyst.net.nz>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
 * @copyright  (C) 2006,2007 Catalyst IT Ltd http://catalyst.net.nz
 *
 */

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

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

    public static function menu_items() {
        return array(
Martyn Smith's avatar
Martyn Smith committed
47
48
            array(
                'name' => 'myblogs',
49
                'link' => '',
Martyn Smith's avatar
Martyn Smith committed
50
            )
51
52
        );
    }
53
54
55
56

    public static function get_toplevel_artefact_types() {
        return array('blog');
    }
57
58
59
60
61

    public static function get_cron() {
        return array(
            (object)array(
                'callfunction' => 'clean_post_files',
Richard Mansfield's avatar
Richard Mansfield committed
62
63
                'hour'         => '4',
                'minute'       => '40'
64
65
66
67
68
69
70
71
72
            )
        );
    }

    /**
     * This function cleans out any files that have been uploaded, but which
     * are not associated with a blog, because of an aborted blog creation.
     */
    public static function clean_post_files() {
73

Richard Mansfield's avatar
Richard Mansfield committed
74
75
76
77
78
79
80
81
82
83
84
85
        $bloguploadbase = get_config('dataroot') . ArtefactTypeBlogPost::$blogattachmentroot;
        if (!$basedir = opendir($bloguploadbase)) {
            throw new Exception('Unable to read blog upload directory '.$bloguploadbase);
        }

        $currenttime = time();

        // Read through all the upload session directories
        while (false !== ($sessionupload = readdir($basedir))) {
            if ($sessionupload != "." && $sessionupload != "..") {
                $sessionupload = $bloguploadbase . $sessionupload;
                $subdir = opendir($sessionupload);
86

Richard Mansfield's avatar
Richard Mansfield committed
87
88
89
90
91
92
93
94
95
96
97
98
99
                // Remove all files older than the session timeout plus two hours.
                while (false !== ($uploadfile = readdir($subdir))) {
                    if ($uploadfile != "." && $uploadfile != "..") {
                        $uploadfile = $sessionupload . '/' . $uploadfile;
                        if ($currenttime - filemtime($uploadfile) > get_config('session_timeout') + 7200) {
                            unlink($uploadfile);
                        }
                    }
                }

                closedir($subdir);
                rmdir($sessionupload);
            }
100
        }
Richard Mansfield's avatar
Richard Mansfield committed
101
102

        closedir($basedir);
103
    }
104
105
106
107
108
109
110
}

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

Alastair Pharo's avatar
Alastair Pharo committed
111
112
113
114
115
    /**
     * This constant gives the per-page pagination for listing blogs.
     */
    const pagination = 10;
    
116
117
118
    
    /** 
     * Whether comments are allowed on this blog or not.
Alastair Pharo's avatar
Alastair Pharo committed
119
120
     *
     * @var boolean
121
122
123
124
125
     */
    protected $commentsallowed = false;

    /** 
     * Whether the blog owner will be notified of comments or not.
Alastair Pharo's avatar
Alastair Pharo committed
126
127
     *
     * @var boolean
128
129
130
     */
    protected $commentsnotify = false;

131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
    /**
     * We override the constructor to fetch the extra data.
     *
     * @param integer
     * @param object
     */
    public function __construct($id = 0, $data = null) {
        parent::__construct($id, $data);

        if (!$data && $this->id
            && ($blogdata = get_record('artefact_blog_blog', 'blog', $this->id))) {
            foreach($blogdata as $name => $value) {
                if (property_exists($this, $name)) {
                    $this->$name = $value;
                }
            }
        }
    }
Alastair Pharo's avatar
Alastair Pharo committed
149
150

    /**
151
152
153
     * 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
154
     */
155
    public function commit() {
156
157
158
159
160
161
162
163
164
165
166
167
168
169
        // 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();

        // Reset dirtyness for the time being.
        $this->dirty = true;

Alastair Pharo's avatar
Alastair Pharo committed
170
        $data = (object)array(
171
172
173
174
175
176
177
178
179
180
181
182
183
            'blog'            => $this->get('id'),
            'commentsallowed' => ($this->get('commentsallowed') ? 1 : 0),
            'commentsnotify'  => ($this->get('commentsnotify') ? 1 : 0)
        );

        if ($new) {
            insert_record('artefact_blog_blog', $data);
        }
        else {
            update_record('artefact_blog_blog', $data, 'blog');
        }

        $this->dirty = false;
184
185
    }

Alastair Pharo's avatar
Alastair Pharo committed
186
    /**
187
188
     * This function extends ArtefactType::delete() by deleting blog-specific
     * data.
Alastair Pharo's avatar
Alastair Pharo committed
189
     */
190
    public function delete() {
191
192
193
194
195
196
197
198
199
        if (empty($this->id)) {
            return;
        }

        // Delete the blog-specific data.
        delete_records('artefact_blog_blog', 'blog', $this->id);

        // Delete the artefact and all children.
        parent::delete();
200
201
    }

202
203
204
205
206
207
    /**
     * This function overrides the default functionality for listing children,
     * using a smarty template and tablerenderer stuff.
     *
     * @param array
     * @return string
Alastair Pharo's avatar
Alastair Pharo committed
208
     */
209
210
211
212
213
214
215
216
217
    protected function listchildren($options) {
        // This is because if there are multiple blocks on a page, they need separate
        // js variables.
        $blockid = isset($options['blockid'])
            ? $options['blockid']
            : mt_rand();

        // This uses the above blockid, so needs to be inlcuded after.
        $javascript = require(get_config('docroot') . 'artefact/blog/render/blog_listchildren.js.php');
218

219
220
221
222
223
224
        $smarty = smarty();
        $smarty->assign('artefact', $this);
        $smarty->assign('blockid', $blockid);
        $smarty->assign_by_ref('options', $options);
        $smarty->assign_by_ref('javascript', $javascript);
        return $smarty->fetch('artefact:blog:render/blog_listchildren.tpl');
225
226
    }

227
228
229
230
231
232
233
234
235
236
237
238
239


    protected function listself($options) {
        $smarty = smarty();
        $smarty->assign('title', $this->get('title'));
        if (isset($options['size']) && $options['size']) {
            $smarty->assign('size', $this->count_children() . ' ' . get_string('posts', 'artefact.blog'));
        }
        return $smarty->fetch('artefact:blog:render/blog_listself.tpl');
    }



240
241
242
243
244
245
246
247
248
    /**
     * This function implements the render_full functionality for blogs.
     * Rendering full involves rendering blog posts with render_full, and
     * possibly some other stuff.
     *
     * @param array
     * @return string
     */
    function render_full($options) {
Alastair Pharo's avatar
Alastair Pharo committed
249
250
251
252
253
254
255
256
257
        // This is because if there are multiple blocks on a page, they need separate
        // js variables.
        $blockid = isset($options['blockid'])
            ? $options['blockid']
            : mt_rand();

        // This uses the above blockid, so needs to be inlcuded after.
        $javascript = require(get_config('docroot') . 'artefact/blog/render/blog_renderfull.js.php');
        
258
259
        $smarty = smarty();
        $smarty->assign('artefact', $this);
Alastair Pharo's avatar
Alastair Pharo committed
260
        $smarty->assign('blockid', $blockid);
261
        $smarty->assign_by_ref('options', $options);
Alastair Pharo's avatar
Alastair Pharo committed
262
        $smarty->assign_by_ref('javascript', $javascript);
263
264
        return $smarty->fetch('artefact:blog:render/blog_renderfull.tpl');
    }
Richard Mansfield's avatar
Richard Mansfield committed
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282

    protected function get_metadata() {
        $data = parent::get_metadata();
        $data['description'] = array('name' => get_string('description'),
                                     'value' => $this->get('description'));
        $data['type']['value'] = get_string($this->get('artefacttype'), 'artefact.blog');
        $data['size'] = array('name' => get_string('size'),
                              'value' => $this->count_children() . ' ' 
                                         . get_string('posts', 'artefact.blog'));
        return $data;
    }

    protected function render_metadata($options) {
        $smarty = smarty();
        $smarty->assign('PROPERTIES', $this->get_metadata());
        return $smarty->fetch('artefact:blog:render/blog_rendermetadata.tpl');
    }

283
                
284
285
286
287
    public function get_icon() {
    }

    public static function get_render_list() {
288
289
290
291
292
293
294
        return array_merge(
            array(
                FORMAT_ARTEFACT_LISTCHILDREN,
                FORMAT_ARTEFACT_RENDERFULL
            ),
            parent::get_render_list()
        );
295
296
    }

Nigel McNie's avatar
Nigel McNie committed
297
    public static function is_singular() {
Penny Leach's avatar
Penny Leach committed
298
299
300
        return false;
    }

Alastair Pharo's avatar
Alastair Pharo committed
301
    public static function collapse_config() {
302
303
    }

Alastair Pharo's avatar
Alastair Pharo committed
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
    /**
     * This function returns a list of the given user's blogs.
     *
     * @param User
     * @return array (count: integer, data: array)
     */
    public static function get_blog_list(User $user, $limit = self::pagination, $offset = 0) {
        ($result = get_records_sql_array("
         SELECT id, title, description
         FROM " . get_config('dbprefix') . "artefact
         WHERE owner = ?
          AND artefacttype = 'blog'
         ORDER BY title
         LIMIT ? OFFSET ?", array($user->get('id'), $limit, $offset)))
            || ($result = array());

        $count = (int)get_field('artefact', 'COUNT(*)', 'owner', $user->get('id'), 'artefacttype', 'blog');

        return array($count, $result);
    }

    /**
     * This function creates a new blog.
     *
     * @param User
     * @param array
     */
Alastair Pharo's avatar
Alastair Pharo committed
331
    public static function new_blog(User $user, array $values) {
Alastair Pharo's avatar
Alastair Pharo committed
332
333
334
335
        $artefact = new ArtefactTypeBlog();
        $artefact->set('title', $values['title']);
        $artefact->set('description', $values['description']);
        $artefact->set('owner', $user->get('id'));
336
337
        $artefact->set('commentsallowed', $values['commentsallowed'] ? true : false);
        $artefact->set('commentsnotify', $values['commentsnotify'] ? true : false);
Alastair Pharo's avatar
Alastair Pharo committed
338
        $artefact->commit();
339
    }
Alastair Pharo's avatar
Alastair Pharo committed
340
341
342
343
344
345
346
347
348
349
350
351
352

    /**
     * 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']);
353
354
355
356
        if ($user->get('id') != $artefact->get('owner')) {
            return;
        }
        
Alastair Pharo's avatar
Alastair Pharo committed
357
358
359
360
361
362
        $artefact->set('title', $values['title']);
        $artefact->set('description', $values['description']);
        $artefact->set('commentsallowed', $values['commentsallowed'] ? true : false);
        $artefact->set('commentsnotify', $values['commentsnotify'] ? true : false);
        $artefact->commit();
    }
363
364
365
366
367
368
369
}

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

Alastair Pharo's avatar
Alastair Pharo committed
370
371
372
373
374
    /**
     * This gives the number of blog posts to display at a time.
     */
    const pagination = 10;

375
    /**
Alastair Pharo's avatar
Alastair Pharo committed
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
     * 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);

        if (!$data && $this->id
            && ($bpdata = get_record('artefact_blog_blogpost', 'blogpost', $this->id))) {
            foreach($bpdata as $name => $value) {
                if (property_exists($this, $name)) {
                    $this->$name = $value;
                }
            }
        }
    }

    /**
     * This function extends ArtefactType::commit() by adding additional data
     * into the artefact_blog_blogpost table.
404
     */
405
    public function commit() {
Alastair Pharo's avatar
Alastair Pharo committed
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
        if (empty($this->dirty)) {
            return;
        }

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

        $this->dirty = false;
429
430
    }

431
    /**
Alastair Pharo's avatar
Alastair Pharo committed
432
433
     * This function extends ArtefactType::delete() by also deleting anything
     * that's in blogpost.
434
     */
435
    public function delete() {
Alastair Pharo's avatar
Alastair Pharo committed
436
437
438
        if (empty($this->id)) {
            return;
        }
439

Martyn Smith's avatar
Martyn Smith committed
440
        delete_records('artefact_blog_blogpost_file', 'blogpost', $this->id);
Alastair Pharo's avatar
Alastair Pharo committed
441
442
443
444
        delete_records('artefact_blog_blogpost', 'blogpost', $this->id);
      
        parent::delete();
    }
445
446
447
448
449
450
451
452
453
454
  
    /**
     * This function displays the blogpost in listself mode.  We're overriding the
     * default, which is to simply display the title, so we can include more
     * data, and use a smarty template.
     *
     * @param array
     */
    protected function listself($options) {
        $smarty = smarty();
455
456
457
458
459
460
        $smarty->assign('title', $this->get('title'));
        if (isset($options['size']) && $options['size']) {
            $smarty->assign('size', $this->count_attachments() . ' ' 
                                    . get_string('attachments', 'artefact.blog'));
        }
        return $smarty->fetch('artefact:blog:render/blog_listself.tpl');
461
462
463
464
465
466
467
468
469
470
    }

    /**
     * This function displays the blogpost in renderfull mode.
     *
     * @param array
     */
    protected function render_full($options) {
        $smarty = smarty();
        $smarty->assign('artefact', $this);
471
        $smarty->assign('creationtime', format_date($this->ctime));
472
        return $smarty->fetch('artefact:blog:render/blogpost_renderfull.tpl');
473
474
    }

Richard Mansfield's avatar
Richard Mansfield committed
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500

    protected function count_attachments() {
        return count_records('artefact_blog_blogpost_file', 'blogpost', $this->get('id'));
    }


    protected function get_metadata() {
        $data = parent::get_metadata();
        unset($data['description']);
        unset($data['size']);
        $data['type']['value'] = get_string($this->get('artefacttype'), 'artefact.blog');
        $data['attachments'] = array('name' => get_string('attachments', 'artefact.blog'),
                                     'value' => $this->count_attachments() . ' ' 
                                               . get_string('files', 'artefact.file'));
        return $data;
    }

                
    protected function render_metadata($options) {
        $smarty = smarty();
        $smarty->assign('PROPERTIES', $this->get_metadata());
        return $smarty->fetch('artefact:blog:render/blog_rendermetadata.tpl');
    }



501
502
503
504
    public function get_icon() {
    }

    public static function get_render_list() {
505
506
507
508
509
510
511
        return array_merge(
            array(
                FORMAT_ARTEFACT_LISTSELF,
                FORMAT_ARTEFACT_RENDERFULL
            ),
            parent::get_render_list()
        );
512
513
    }

Nigel McNie's avatar
Nigel McNie committed
514
    public static function is_singular() {
Penny Leach's avatar
Penny Leach committed
515
516
517
        return false;
    }

Alastair Pharo's avatar
Alastair Pharo committed
518
    public static function collapse_config() {
519
520
    }

Alastair Pharo's avatar
Alastair Pharo committed
521
522
523
524
525
526
527
528
529
    /**
     * 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) {
530
531
        $prefix = get_config('dbprefix');
        ($result = get_records_sql_assoc("
Alastair Pharo's avatar
Alastair Pharo committed
532
         SELECT a.id, a.title, a.description, a.ctime, a.mtime, bp.published
533
534
         FROM " . $prefix . "artefact a
          LEFT OUTER JOIN " . $prefix . "artefact_blog_blogpost bp
Alastair Pharo's avatar
Alastair Pharo committed
535
536
537
538
           ON a.id = bp.blogpost
         WHERE a.parent = ?
          AND a.artefacttype = 'blogpost'
          AND a.owner = ?
539
         ORDER BY bp.published ASC, a.ctime DESC
Alastair Pharo's avatar
Alastair Pharo committed
540
541
542
543
544
545
546
547
         LIMIT ? OFFSET ?;", array(
            $id,
            $user->get('id'),
            $limit,
            $offset
        )))
            || ($result = array());

548
549
550
551
        $count = (int)get_field('artefact', 'COUNT(*)', 'owner', $user->get('id'), 
                                'artefacttype', 'blogpost', 'parent', $id);

        // Get the attached files.
552
        if (count($result) > 0) {
553
554
555
556
557
558
559
560
561
562
563
564
565
            $idlist = implode(', ', array_map(create_function('$a', 'return $a->id;'), $result));
            $files = get_records_sql_array('
               SELECT
                  bf.blogpost, bf.file, a.artefacttype, a.title, a.description
               FROM ' . $prefix . 'artefact_blog_blogpost_file bf
                  INNER JOIN ' . $prefix . 'artefact a ON bf.file = a.id
               WHERE bf.blogpost IN (' . $idlist . ')', '');
            if ($files) {
                foreach ($files as $file) {
                    $result[$file->blogpost]->files[] = $file;
                }
            }
        }
Alastair Pharo's avatar
Alastair Pharo committed
566

567
        return array($count, array_values($result));
Alastair Pharo's avatar
Alastair Pharo committed
568
569
    }

570
571
572
573
574
575
576
577
    /** 
     * This function returns a list of rendered blog posts.
     *
     * @param integer
     * @param integer
     * @param integer
     * @param integer
     */
578
    public static function render_posts($format, $options, $id, $limit = self::pagination, $offset = 0) {
Alastair Pharo's avatar
Alastair Pharo committed
579
        ($postids = get_records_sql_array("
580
581
582
583
584
585
586
         SELECT a.id
         FROM " . get_config('dbprefix') . "artefact a
          LEFT OUTER JOIN " . get_config('dbprefix') . "artefact_blog_blogpost bp
           ON a.id = bp.blogpost
         WHERE a.parent = ?
          AND bp.published = 1
         ORDER BY a.ctime DESC
Alastair Pharo's avatar
Alastair Pharo committed
587
588
         LIMIT ? OFFSET ?;", array($id, $limit, $offset)))
            || ($postids = array());
589
590
591
592
593
594

        $posts = array();
        foreach($postids as $postid) {
            $blogpost = new ArtefactTypeBlogPost($postid->id);
            $posts[] = array(
                'id' => $postid->id,
595
                'content' => $blogpost->render($format, (array) $options)
596
597
598
            );
        }

Alastair Pharo's avatar
Alastair Pharo committed
599
600
601
602
603
604
605
        $count = (int)get_field_sql("
         SELECT COUNT(*)
         FROM " . get_config('dbprefix') . "artefact a
          LEFT OUTER JOIN " . get_config('dbprefix') . "artefact_blog_blogpost bp
           ON a.id = bp.blogpost
         WHERE a.parent = ?
          AND bp.published = 1", array($id));
606
607
608
609

        return array($count, $posts);
    }

Alastair Pharo's avatar
Alastair Pharo committed
610
611
612
613
614
615
616
617
618
619
    /**
     * 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
620
        $artefact->set('published', $values['published']);
Alastair Pharo's avatar
Alastair Pharo committed
621
        $artefact->set('owner', $user->get('id'));
622
        $artefact->set('parent', $values['parent']);
Alastair Pharo's avatar
Alastair Pharo committed
623
        $artefact->commit();
624
        return true;
625
    }
Alastair Pharo's avatar
Alastair Pharo committed
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645

    /** 
     * 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']);
        $artefact->commit();
        return true;
    }

646
647
648
    // Where to store temporary blog post files under dataroot
    static $blogattachmentroot = 'artefact/blog/uploads/';

649
650
651
652
653
654
655

    public static function get_temp_file_path($createid, $uploadnumber) {
        return get_config('dataroot') . self::$blogattachmentroot 
            . session_id() . $createid . '/' . $uploadnumber;
    }


656
657
658
659
660
661
662
663
    /**
     * Returns the size of a temporary attachment
     */
    public static function temp_attachment_size($createid, $uploadnumber) {
        return filesize(self::get_temp_file_path($createid, $uploadnumber));
    }


664
665
666
667
    /** 
     * This function saves an uploaded file to a temporary directory in dataroot
     *
     */
668
    public static function save_attachment_temporary($inputname, $dirname, $filename) {
669
670
        require_once('uploadmanager.php');
        $um = new upload_manager($inputname);
671
672
673
674
675
676
677
        $result = new StdClass;
        $tempdir = self::$blogattachmentroot . $dirname;
        $result->error = $um->process_file_upload($tempdir, $filename);
        $tempfile = $tempdir . '/' . $filename;
        safe_require('artefact', 'file');
        $result->type = ArtefactTypeFile::detect_artefact_type($tempfile);
        return $result;
678
679
680
    }


681
682
683
684
    /**
     * Save a temporary uploaded file to the myfiles area.
     */
    public function save_attachment($directory, $filename, $title, $description) {
685
686
687
688
689
690
691

        // Create the blogfiles folder if it doesn't exist yet.
        $blogfilesid = self::blogfiles_folder_id();
        if (!$blogfilesid) {
            return false;
        }

692
693
694
695
696
697
698
        global $USER;

        safe_require('artefact', 'file');

        $data = new StdClass;
        $data->title = $title;
        $data->description = $description;
Richard Mansfield's avatar
Richard Mansfield committed
699
700
        $data->owner = $USER->get('id');
        $data->adminfiles = 0; // No admin blogs yet...
701
        $data->parent = $blogfilesid;
Richard Mansfield's avatar
Richard Mansfield committed
702
703
        
        $path = self::$blogattachmentroot . $directory . '/' . $filename;
704

Richard Mansfield's avatar
Richard Mansfield committed
705
        if (!$fileid = ArtefactTypeFile::save_file($path, $data)) {
706
707
            return false;
        }
Richard Mansfield's avatar
Richard Mansfield committed
708
            
709
710
711
712
713
        $data = new StdClass;
        $data->blogpost = $this->id;
        $data->file = $fileid;
        insert_record('artefact_blog_blogpost_file', $data);

714
        return $fileid;
715
716
717
718
719
720
721
722
723
    }

    public static function blogfiles_folder_id() {
        $name = get_string('blogfilesdirname', 'artefact.blog');
        $description = get_string('blogfilesdirdescription', 'artefact.blog');
        safe_require('artefact', 'file');
        return ArtefactTypeFolder::get_folder_id($name, $description);
    }

Alastair Pharo's avatar
Alastair Pharo committed
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
    /**
     * 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;
    }
747
748
749
750
751
752
753
754
755
756
757
758
759
760

    /**
     * This function returns a list of files attached to a post to use
     * when displaying or editing a blog post
     *
     * @return array
     */
    public function get_attached_files() {
        $prefix = get_config('dbprefix');
        return get_records_sql_array('SELECT a.id, a.artefacttype, a.title, a.description 
            FROM ' . $prefix . 'artefact_blog_blogpost_file f
            INNER JOIN ' . $prefix . 'artefact a ON a.id = f.file
            WHERE f.blogpost = ' . $this->id, '');
    }
761
762

    
763
    
764
}
765
766

?>