plugins/Blog/classes/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 = ActivityObject::ARTICLE;
  63
  64     static function schemaDef()
  65     {
  66         return array(
  67             'description' => 'lite blog entry',
  68             'fields' => array(
  69                 'id' => array('type' => 'char',
  70                               'length' => 36,
  71                               'not null' => true,
  72                               'description' => 'Unique ID (UUID)'),
  73                 'profile_id' => array('type' => 'int',
  74                                       'not null' => true,
  75                                       'description' => 'Author profile ID'),
  76                 'title' => array('type' => 'varchar',
  77                                  'length' => 255,
  78                                  'description' => 'title of the entry'),
  79                 'summary' => array('type' => 'text',
  80                                    'description' => 'initial summary'),
  81                 'content' => array('type' => 'text',
  82                                    'description' => 'HTML content of the entry'),
  83                 'uri' => array('type' => 'varchar',
  84                                'length' => 255,
  85                                'description' => 'URI (probably http://) for this entry'),
  86                 'url' => array('type' => 'varchar',
  87                                'length' => 255,
  88                                'description' => 'URL (probably http://) for this entry'),
  89                 'created' => array('type' => 'datetime',
  90                                    'not null' => true,
  91                                    'description' => 'date this record was created'),
  92                 'modified' => array('type' => 'datetime',
  93                                     'not null' => true,
  94                                     'description' => 'date this record was created'),
  95             ),
  96             'primary key' => array('id'),
  97             'unique keys' => array(
  98                 'blog_entry_uri_key' => array('uri'),
  99             ),
 100             'foreign keys' => array(
 101                 'blog_entry_profile_id_fkey' => array('profile', array('profile_id' => 'id')),
 102             ),
 103             'indexes' => array(
 104                 'blog_entry_created_idx' => array('created')
 105             ),
 106         );
 107     }
 108
 109     static function saveNew($profile, $title, $content, $options=null)
 110     {
 111         if (is_null($options)) {
 112             $options = array();
 113         }
 114
 115         $be             = new Blog_entry();
 116         $be->id         = (string) new UUID();
 117         $be->profile_id = $profile->id;
 118         $be->title      = $title; // Note: not HTML-protected
 119         $be->content    = self::purify($content);
 120
 121         if (array_key_exists('summary', $options)) {
 122             $be->summary = self::purify($options['summary']);
 123         } else {
 124             // Already purified
 125             $be->summary = self::summarize($be->content);
 126         }
 127
 128         // Don't save an identical summary
 129
 130         if ($be->summary == $be->content) {
 131             $be->summary = null;
 132         }
 133
 134         $url = common_local_url('showblogentry', array('id' => $be->id));
 135
 136         if (!array_key_exists('uri', $options)) {
 137             $options['uri'] = $url;
 138         }
 139
 140         $be->uri = $options['uri'];
 141
 142         if (!array_key_exists('url', $options)) {
 143             $options['url'] = $url;
 144         }
 145
 146         $be->url = $options['url'];
 147
 148         if (!array_key_exists('created', $options)) {
 149             $be->created = common_sql_now();
 150         }
 151
 152         $be->created = $options['created'];
 153
 154         $be->modified = common_sql_now();
 155
 156         $be->insert();
 157
 158         // Use user's preferences for short URLs, if possible
 159
 160         try {
 161             $user = $profile->isLocal()
 162                         ? $profile->getUser()
 163                         : null;
 164             $shortUrl = File_redirection::makeShort($url, $user);
 165         } catch (Exception $e) {
 166             // Don't let this stop us.
 167             $shortUrl = $url;
 168         }
 169
 170         // XXX: this might be too long.
 171
 172         if (!empty($be->summary)) {
 173             $options['rendered'] = $be->summary . ' ' .
 174                 XMLStringer::estring('a', array('href' => $url,
 175                                                 'class' => 'blog-entry'),
 176                                      _('More...'));
 177             $text = html_entity_decode(strip_tags($be->summary), ENT_QUOTES, 'UTF-8');
 178         } else {
 179             $options['rendered'] = $be->content;
 180             $text = html_entity_decode(strip_tags($be->content), ENT_QUOTES, 'UTF-8');
 181         }
 182
 183
 184         if (Notice::contentTooLong($text)) {
 185             $text = substr($text, 0, Notice::maxContent() - mb_strlen($shortUrl) - 2) .
 186                 '… ' . $shortUrl;
 187         }
 188
 189         // Override this no matter what.
 190
 191         $options['object_type'] = self::TYPE;
 192
 193         $source = array_key_exists('source', $options) ?
 194                                     $options['source'] : 'web';
 195
 196         $saved = Notice::saveNew($profile->id, $text, $source, $options);
 197
 198         return $saved;
 199     }
 200
 201     /**
 202      * Summarize the contents of a blog post
 203      *
 204      * We take the first div or paragraph of the blog post if there's a hit;
 205      * Otherwise we take the whole thing.
 206      *
 207      * @param string $html HTML of full content
 208      */
 209     static function summarize($html)
 210     {
 211         if (preg_match('#<p>.*?</p>#s', $html, $matches)) {
 212             return $matches[0];
 213         } else if (preg_match('#<div>.*?</div>#s', $html, $matches)) {
 214             return $matches[0];
 215         } else {
 216             return $html;
 217         }
 218     }
 219
 220     static function fromNotice($notice)
 221     {
 222         return Blog_entry::getKV('uri', $notice->uri);
 223     }
 224
 225     function getNotice()
 226     {
 227         return Notice::getKV('uri', $this->uri);
 228     }
 229
 230     function asActivityObject()
 231     {
 232         $obj = new ActivityObject();
 233
 234         $obj->id      = $this->uri;
 235         $obj->type    = self::TYPE;
 236         $obj->title   = $this->title;
 237         $obj->summary = $this->summary;
 238         $obj->content = $this->content;
 239         $obj->link    = $this->url;
 240
 241         return $obj;
 242     }
 243
 244     /**
 245      * Clean up input HTML
 246      */
 247     static function purify($html)
 248     {
 249         require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
 250
 251         $config = array('safe' => 1,
 252                         'deny_attribute' => 'id,style,on*');
 253         $pure = htmLawed($html, $config);
 254
 255         return $pure;
 256     }
 257 }