plugins/Blog/Blog_entry.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Data structure for blog entries
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Blog
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Data structure for blog entries
  39  *
  40  * @category  Blog
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2011 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47
  48 class Blog_entry extends Managed_DataObject
  49 {
  50     public $__table = 'blog_entry';
  51
  52     public $id; // UUID
  53     public $profile_id; // int
  54     public $title; // varchar(255)
  55     public $summary; // text
  56     public $content; // text
  57     public $uri; // text
  58     public $url; // text
  59     public $created; // datetime
  60     public $modified; // datetime
  61
  62     const TYPE = 'http://activitystrea.ms/schema/1.0/blog-entry';
  63
  64     function staticGet($k, $v=null)
  65     {
  66         return Managed_DataObject::staticGet('blog_entry', $k, $v);
  67     }
  68
  69     static function schemaDef()
  70     {
  71         return array(
  72             'description' => 'lite blog entry',
  73             'fields' => array(
  74                 'id' => array('type' => 'char',
  75                               'length' => 36,
  76                               'not null' => true,
  77                               'description' => 'Unique ID (UUID)'),
  78                 'profile_id' => array('type' => 'int',
  79                                       'not null' => true,
  80                                       'description' => 'Author profile ID'),
  81                 'title' => array('type' => 'varchar',
  82                                  'length' => 255,
  83                                  'description' => 'title of the entry'),
  84                 'summary' => array('type' => 'text',
  85                                    'description' => 'initial summary'),
  86                 'content' => array('type' => 'text',
  87                                    'description' => 'HTML content of the entry'),
  88                 'uri' => array('type' => 'varchar',
  89                                'length' => 255,
  90                                'description' => 'URI (probably http://) for this entry'),
  91                 'url' => array('type' => 'varchar',
  92                                'length' => 255,
  93                                'description' => 'URL (probably http://) for this entry'),
  94                 'created' => array('type' => 'datetime',
  95                                    'not null' => true,
  96                                    'description' => 'date this record was created'),
  97                 'modified' => array('type' => 'datetime',
  98                                     'not null' => true,
  99                                     'description' => 'date this record was created'),
 100             ),
 101             'primary key' => array('id'),
 102             'foreign keys' => array(
 103                 'blog_entry_profile_id_fkey' => array('profile', array('profile_id' => 'id')),
 104             ),
 105             'indexes' => array(
 106                 'blog_entry_created_idx' => array('created'),
 107                 'blog_entry_uri_idx' => array('uri'),
 108             ),
 109         );
 110     }
 111
 112     static function saveNew($profile, $title, $content, $options=null)
 113     {
 114         if (is_null($options)) {
 115             $options = array();
 116         }
 117
 118         $be             = new Blog_entry();
 119         $be->id         = (string) new UUID();
 120         $be->profile_id = $profile->id;
 121         $be->title      = htmlspecialchars($title);
 122         $be->content    = $content;
 123
 124         if (array_key_exists('summary', $options)) {
 125             $be->summary = $options['summary'];
 126         } else {
 127             $be->summary = self::summarize($content);
 128         }
 129
 130         $url = common_local_url('showblogentry', array('id' => $be->id));
 131
 132         if (!array_key_exists('uri', $options)) {
 133             $options['uri'] = $url;
 134         }
 135
 136         $be->uri = $options['uri'];
 137
 138         if (!array_key_exists('url', $options)) {
 139             $options['url'] = $url;
 140         }
 141
 142         $be->url = $options['url'];
 143
 144         if (!array_key_exists('created', $options)) {
 145             $be->created = common_sql_now();
 146         }
 147
 148         $be->created = $options['created'];
 149
 150         $be->modified = common_sql_now();
 151
 152         $be->insert();
 153
 154         // Use user's preferences for short URLs, if possible
 155
 156         try {
 157             $user = $profile->getUser();
 158             $shortUrl = File_redirection::makeShort($url,
 159                                                     empty($user) ? null : $user);
 160         } catch (Exception $e) {
 161             // Don't let this stop us.
 162             $shortUrl = $url;
 163         }
 164
 165         // XXX: this might be too long.
 166
 167         $options['rendered'] = $be->summary . ' ' .
 168             XMLStringer::estring('a', array('href' => $shortUrl,
 169                                             'class' => 'blog-entry'),
 170                                  _('More...'));
 171
 172         $summaryText = html_entity_decode(strip_tags($summary), ENT_QUOTES, 'UTF-8');
 173
 174         if (Notice::contentTooLong($summaryText)) {
 175             $summaryText = substr($summaryText, 0, Notice::maxContent() - mb_strlen($shortUrl) - 2) .
 176                 '… ' . $shortUrl;
 177         }
 178
 179         $content = $summaryText;
 180
 181         // Override this no matter what.
 182
 183         $options['object_type'] = self::TYPE;
 184
 185         $source = array_key_exists('source', $options) ?
 186                                     $options['source'] : 'web';
 187
 188         Notice::saveNew($profile->id, $content, $source, $options);
 189     }
 190
 191     /**
 192      * Summarize the contents of a blog post
 193      *
 194      * We take the first div or paragraph of the blog post if there's a hit;
 195      * Otherwise we take the whole thing.
 196      *
 197      * @param string $html HTML of full content
 198      */
 199     static function summarize($html)
 200     {
 201         if (preg_match('#<p>.*?</p>#s', $html, $matches)) {
 202             return $matches[0];
 203         } else if (preg_match('#<div>.*?</div>#s', $html, $matches)) {
 204             return $matches[0];
 205         } else {
 206             return $html;
 207         }
 208     }
 209
 210     static function fromNotice($notice)
 211     {
 212         return Blog_entry::staticGet('uri', $notice->uri);
 213     }
 214
 215     function getNotice()
 216     {
 217         return Notice::staticGet('uri', $this->uri);
 218     }
 219
 220     function asActivityObject()
 221     {
 222         $obj = new ActivityObject();
 223
 224         $obj->id      = $this->uri;
 225         $obj->type    = self::TYPE;
 226         $obj->title   = $this->title;
 227         $obj->summary = $this->summary;
 228         $obj->content = $this->content;
 229         $obj->link    = $this->url;
 230
 231         return $obj;
 232     }
 233 }