plugins/Bookmark/classes/Bookmark.php

   1 <?php
   2 /**
   3  * Data class to mark notices as bookmarks
   4  *
   5  * PHP version 5
   6  *
   7  * @category Data
   8  * @package  StatusNet
   9  * @author   Evan Prodromou <evan@status.net>
  10  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  11  * @link     http://status.net/
  12  *
  13  * StatusNet - the distributed open-source microblogging tool
  14  * Copyright (C) 2009, StatusNet, Inc.
  15  *
  16  * This program is free software: you can redistribute it and/or modify
  17  * it under the terms of the GNU Affero General Public License as published by
  18  * the Free Software Foundation, either version 3 of the License, or
  19  * (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the
  24  * GNU Affero General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU Affero General Public License
  27  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  28  */
  29
  30 if (!defined('GNUSOCIAL')) { exit(1); }
  31
  32 /**
  33  * For storing the fact that a notice is a bookmark
  34  *
  35  * @category Bookmark
  36  * @package  StatusNet
  37  * @author   Evan Prodromou <evan@status.net>
  38  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  39  * @link     http://status.net/
  40  *
  41  * @see      DB_DataObject
  42  */
  43 class Bookmark extends Managed_DataObject
  44 {
  45     public $__table = 'bookmark'; // table name
  46     public $id;          // char(36) primary_key not_null
  47     public $profile_id;  // int(4) not_null
  48     public $url;         // varchar(191) not_null   not 255 because utf8mb4 takes more space
  49     public $title;       // varchar(191)   not 255 because utf8mb4 takes more space
  50     public $uri;         // varchar(191)   not 255 because utf8mb4 takes more space
  51     public $description; // text
  52     public $created;     // datetime
  53
  54     public static function schemaDef()
  55     {
  56         return array(
  57             'fields' => array(
  58                 'id' => array('type' => 'char',
  59                             'length' => 36,
  60                             'not null' => true),
  61                 'profile_id' => array('type' => 'int', 'not null' => true),
  62                 'uri' => array('type' => 'varchar',
  63                             'length' => 191,
  64                             'not null' => true),
  65                 'url' => array('type' => 'varchar',
  66                             'length' => 191,
  67                             'not null' => true),
  68                 'title' => array('type' => 'varchar', 'length' => 191),
  69                 'description' => array('type' => 'text'),
  70                 'created' => array('type' => 'datetime', 'not null' => true),
  71             ),
  72             'primary key' => array('uri'),
  73             'unique keys' => array(
  74                 'bookmark_id_key' => array('id'),
  75             ),
  76             'foreign keys' => array(
  77                 'bookmark_profile_id_fkey' => array('profile', array('profile_id' => 'id')),
  78                 'bookmark_uri_fkey' => array('notice', array('uri' => 'uri')),
  79             ),
  80             'indexes' => array('bookmark_created_idx' => array('created'),
  81                             'bookmark_url_idx' => array('url'),
  82                             'bookmark_profile_id_idx' => array('profile_id'),
  83             ),
  84         );
  85     }
  86
  87     /**
  88      * Get a bookmark based on a notice
  89      *
  90      * @param   Notice              $stored Notice activity which represents the Bookmark
  91      *
  92      * @return  Bookmark            The found bookmark object.
  93      * @throws  NoResultException   When you don't find it after all.
  94      */
  95     static public function fromStored(Notice $stored)
  96     {
  97         return self::getByPK(array('uri' => $stored->getUri()));
  98     }
  99
 100     public function getStored()
 101     {
 102         return Notice::getByKeys(array('uri' => $this->getUri()));
 103     }
 104
 105     public function getDescription()
 106     {
 107         return $this->description;
 108     }
 109
 110     public function getTitle()
 111     {
 112         return $this->title;
 113     }
 114
 115     public function getUri()
 116     {
 117         return $this->uri;
 118     }
 119
 120     public function getUrl()
 121     {
 122         if (empty($this->url)) {
 123             throw new InvalidUrlException($this->url);
 124         }
 125         return $this->url;
 126     }
 127
 128     /**
 129      * Get the bookmark that a user made for an URL
 130      *
 131      * @param Profile $profile Profile to check for
 132      * @param string  $url     URL to check for
 133      *
 134      * @return Bookmark bookmark found or null
 135      */
 136     static function getByURL(Profile $profile, $url)
 137     {
 138         $nb = new Bookmark();
 139
 140         $nb->profile_id = $profile->getID();
 141         $nb->url        = $url;
 142
 143         if (!$nb->find(true)) {
 144             throw new NoResultException($nb);
 145         }
 146
 147         return $nb;
 148     }
 149
 150     /**
 151      * Store a Bookmark object
 152      *
 153      * @param Profile $profile     To save the bookmark for
 154      * @param string  $title       Title of the bookmark
 155      * @param string  $url         URL of the bookmark
 156      * @param string  $description Description of the bookmark
 157      *
 158      * @return Bookmark the Bookmark object
 159      */
 160     static function saveActivityObject(ActivityObject $actobj, Notice $stored)
 161     {
 162         $url = null;
 163         // each extra element is array('tagname', array('attr'=>'val', ...), 'content')
 164         foreach ($actobj->extra as $extra) {
 165             if ($extra[1]['rel'] !== 'related') {
 166                 continue;
 167             }
 168             if ($url===null && strlen($extra[1]['href'])>0) {
 169                 $url = $extra[1]['href'];
 170             } elseif ($url !== null) {
 171                 // TRANS: Client exception thrown when a bookmark is formatted incorrectly.
 172                 throw new ClientException(sprintf(_m('Expected exactly 1 link rel=related in a Bookmark, got %1$d.'), count($relLinkEls)));
 173             }
 174         }
 175         if (is_null($url)) {
 176             // TRANS: Client exception thrown when a bookmark is formatted incorrectly.
 177             throw new ClientException(sprintf(_m('Expected exactly 1 link rel=related in a Bookmark, got %1$d.'), count($relLinkEls)));
 178         }
 179
 180         if (!strlen($actobj->title)) {
 181             throw new ClientException(_m('You must provide a non-empty title.'));
 182         }
 183         if (!common_valid_http_url($url)) {
 184             throw new ClientException(_m('Only web bookmarks can be posted (HTTP or HTTPS).'));
 185         }
 186
 187         try {
 188             $object = self::getByURL($stored->getProfile(), $url);
 189             throw new ClientException(_m('You have already bookmarked this URL.'));
 190         } catch (NoResultException $e) {
 191             // Alright, so then we have to create it.
 192         }
 193
 194         $nb = new Bookmark();
 195
 196         $nb->id          = UUID::gen();
 197         $nb->uri         = $stored->getUri();
 198         $nb->profile_id  = $stored->getProfile()->getID();
 199         $nb->title       = $actobj->title;
 200         $nb->url         = $url;
 201         $nb->description = $actobj->summary;
 202         $nb->created     = $stored->created;
 203
 204         $result = $nb->insert();
 205         if ($result === false) {
 206             throw new ServerException('Could not insert Bookmark into database!');
 207         }
 208
 209         return $nb;
 210     }
 211
 212     public function asActivityObject()
 213     {
 214         $stored = $this->getStored();
 215
 216         $object = new ActivityObject();
 217         $object->id      = $this->getUri();
 218         $object->type    = ActivityObject::BOOKMARK;
 219         $object->title   = $this->getTitle();
 220         $object->summary = $this->getDescription();
 221         $object->link    = $stored->getUrl();
 222         $object->content = $stored->getRendered();
 223
 224         // Attributes of the URL
 225
 226         $attachments = $stored->attachments();
 227
 228         if (count($attachments) != 1) {
 229             // TRANS: Server exception thrown when a bookmark has multiple attachments.
 230             throw new ServerException(_m('Bookmark notice with the '.
 231                                         'wrong number of attachments.'));
 232         }
 233
 234         $bookmarkedurl = $attachments[0];
 235
 236         $attrs = array('rel' => 'related',
 237                        'href' => $bookmarkedurl->getUrl());
 238
 239         if (!strlen($bookmarkedurl->title)) {
 240             $attrs['title'] = $bookmarkedurl->title;
 241         }
 242
 243         $object->extra[] = array('link', $attrs, null);
 244
 245         // Attributes of the thumbnail, if any
 246
 247         try {
 248             $thumbnail = $bookmarkedurl->getThumbnail();
 249             $tattrs = array('rel' => 'preview',
 250                             'href' => $thumbnail->getUrl());
 251
 252             if (!empty($thumbnail->width)) {
 253                 $tattrs['media:width'] = $thumbnail->width;
 254             }
 255
 256             if (!empty($thumbnail->height)) {
 257                 $tattrs['media:height'] = $thumbnail->height;
 258             }
 259
 260             $object->extra[] = array('link', $tattrs, null);
 261         } catch (UnsupportedMediaException $e) {
 262             // No image thumbnail metadata available
 263         }
 264
 265         return $object;
 266     }
 267
 268     /**
 269      * Save a new notice bookmark
 270      *
 271      * @param Profile $profile     To save the bookmark for
 272      * @param string  $title       Title of the bookmark
 273      * @param string  $url         URL of the bookmark
 274      * @param array   $rawtags     array of tags
 275      * @param string  $description Description of the bookmark
 276      * @param array   $options     Options for the Notice::saveNew()
 277      *
 278      * @return Notice saved notice
 279      */
 280     static function addNew(Profile $actor, $title, $url, array $rawtags, $description, array $options=array())
 281     {
 282         $act        = new Activity();
 283         $act->verb  = ActivityVerb::POST;
 284         $act->time  = time();
 285         $act->actor = $actor->asActivityObject();
 286
 287         $actobj = new ActivityObject();
 288         $actobj->type = ActivityObject::BOOKMARK;
 289         $actobj->title = $title;
 290         $actobj->summary = $description;
 291         $actobj->extra[] = array('link', array('rel'=>'related', 'href'=>$url), null);
 292         $act->objects[] = $actobj;
 293
 294         $act->enclosures[] = $url;
 295
 296         $tags    = array();
 297         $replies = array();
 298
 299         // filter "for:nickname" tags
 300         foreach ($rawtags as $tag) {
 301             if (strtolower(mb_substr($tag, 0, 4)) == 'for:') {
 302                 // skip if done by caller
 303                 if (!array_key_exists('replies', $options)) {
 304                     $nickname = mb_substr($tag, 4);
 305                     $other    = common_relative_profile($actor, $nickname);
 306                     if (!empty($other)) {
 307                         $replies[] = $other->getUri();
 308                     }
 309                 }
 310             } else {
 311                 $tags[] = common_canonical_tag($tag);
 312             }
 313         }
 314
 315         $hashtags = array();
 316         $taglinks = array();
 317
 318         foreach ($tags as $tag) {
 319             $hashtags[] = '#'.$tag;
 320             $attrs      = array('href' => Notice_tag::url($tag),
 321                                 'rel'  => $tag,
 322                                 'class' => 'tag');
 323             $taglinks[] = XMLStringer::estring('a', $attrs, $tag);
 324         }
 325
 326         // Use user's preferences for short URLs, if possible
 327         // FIXME: Should be possible to with the Profile object...
 328         try {
 329             $user = $actor->getUser();
 330             $shortUrl = File_redirection::makeShort($url, empty($user) ? null : $user);
 331         } catch (Exception $e) {
 332             // Don't let this stop us.
 333             $shortUrl = $url;
 334         }
 335
 336         // TRANS: Rendered bookmark content.
 337         // TRANS: %1$s is a URL, %2$s the bookmark title, %3$s is the bookmark description,
 338         // TRANS: %4$s is space separated list of hash tags.
 339         $actobj->content = sprintf(_m('<span class="xfolkentry">'.
 340                                       '<a class="taggedlink" href="%1$s">%2$s</a> '.
 341                                       '<span class="description">%3$s</span> '.
 342                                       '<span class="meta">%4$s</span>'.
 343                                       '</span>'),
 344                                     htmlspecialchars($url),
 345                                     htmlspecialchars($title),
 346                                     htmlspecialchars($description),
 347                                     implode(' ', $taglinks));
 348
 349         foreach ($tags as $term) {
 350             $catEl = new AtomCategory();
 351             $catEl->term = $term;
 352             $activity->categories[] = $catEl;
 353         }
 354
 355         $options = array_merge(array('urls' => array($url),
 356                                      'rendered' => $rendered,
 357                                      'tags' => $tags,
 358                                      'replies' => $replies,
 359                                      'object_type' => ActivityObject::BOOKMARK),
 360                                $options);
 361
 362         return Notice::saveActivity($act, $actor, $options);
 363     }
 364 }