plugins/Bookmark/BookmarkPlugin.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * A plugin to enable social-bookmarking functionality
   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  SocialBookmark
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2010 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     exit(1);
  33 }
  34
  35 /**
  36  * Bookmark plugin main class
  37  *
  38  * @category  Bookmark
  39  * @package   StatusNet
  40  * @author    Brion Vibber <brionv@status.net>
  41  * @author    Evan Prodromou <evan@status.net>
  42  * @copyright 2010 StatusNet, Inc.
  43  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  44  * @link      http://status.net/
  45  */
  46 class BookmarkPlugin extends MicroAppPlugin
  47 {
  48     const VERSION         = '0.1';
  49     const IMPORTDELICIOUS = 'BookmarkPlugin:IMPORTDELICIOUS';
  50
  51     /**
  52      * Authorization for importing delicious bookmarks
  53      *
  54      * By default, everyone can import bookmarks except silenced people.
  55      *
  56      * @param Profile $profile Person whose rights to check
  57      * @param string  $right   Right to check; const value
  58      * @param boolean &$result Result of the check, writeable
  59      *
  60      * @return boolean hook value
  61      */
  62     function onUserRightsCheck($profile, $right, &$result)
  63     {
  64         if ($right == self::IMPORTDELICIOUS) {
  65             $result = !$profile->isSilenced();
  66             return false;
  67         }
  68         return true;
  69     }
  70
  71     /**
  72      * Database schema setup
  73      *
  74      * @see Schema
  75      * @see ColumnDef
  76      *
  77      * @return boolean hook value; true means continue processing, false means stop.
  78      */
  79     function onCheckSchema()
  80     {
  81         $schema = Schema::get();
  82
  83         $schema->ensureTable('bookmark', Bookmark::schemaDef());
  84
  85         return true;
  86     }
  87
  88     /**
  89      * Show the CSS necessary for this plugin
  90      *
  91      * @param Action $action the action being run
  92      *
  93      * @return boolean hook value
  94      */
  95     function onEndShowStyles($action)
  96     {
  97         $action->cssLink($this->path('bookmark.css'));
  98         return true;
  99     }
 100
 101     function onEndShowScripts($action)
 102     {
 103         $action->script($this->path('js/bookmark.js'));
 104         return true;
 105     }
 106
 107     /**
 108      * Map URLs to actions
 109      *
 110      * @param Net_URL_Mapper $m path-to-action mapper
 111      *
 112      * @return boolean hook value; true means continue processing, false means stop.
 113      */
 114     function onRouterInitialized($m)
 115     {
 116         if (common_config('singleuser', 'enabled')) {
 117             $nickname = User::singleUserNickname();
 118             $m->connect('bookmarks',
 119                         array('action' => 'bookmarks', 'nickname' => $nickname));
 120             $m->connect('bookmarks/rss',
 121                         array('action' => 'bookmarksrss', 'nickname' => $nickname));
 122         } else {
 123             $m->connect(':nickname/bookmarks',
 124                         array('action' => 'bookmarks'),
 125                         array('nickname' => Nickname::DISPLAY_FMT));
 126             $m->connect(':nickname/bookmarks/rss',
 127                         array('action' => 'bookmarksrss'),
 128                         array('nickname' => Nickname::DISPLAY_FMT));
 129         }
 130
 131         $m->connect('api/bookmarks/:id.:format',
 132                     array('action' => 'ApiTimelineBookmarks',
 133                           'id' => Nickname::INPUT_FMT,
 134                           'format' => '(xml|json|rss|atom|as)'));
 135
 136         $m->connect('main/bookmark/new',
 137                     array('action' => 'newbookmark'),
 138                     array('id' => '[0-9]+'));
 139
 140         $m->connect('main/bookmark/popup',
 141                     array('action' => 'bookmarkpopup'));
 142
 143         $m->connect('main/bookmark/import',
 144                     array('action' => 'importdelicious'));
 145
 146         $m->connect('main/bookmark/forurl',
 147                     array('action' => 'bookmarkforurl'));
 148
 149         $m->connect('bookmark/:id',
 150                     array('action' => 'showbookmark'),
 151                     array('id' => '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'));
 152
 153         $m->connect('notice/by-url/:id',
 154                     array('action' => 'noticebyurl'),
 155                     array('id' => '[0-9]+'));
 156
 157         return true;
 158     }
 159
 160
 161     /**
 162      * Add our two queue handlers to the queue manager
 163      *
 164      * @param QueueManager $qm current queue manager
 165      *
 166      * @return boolean hook value
 167      */
 168     function onEndInitializeQueueManager($qm)
 169     {
 170         $qm->connect('dlcsback', 'DeliciousBackupImporter');
 171         $qm->connect('dlcsbkmk', 'DeliciousBookmarkImporter');
 172         return true;
 173     }
 174
 175     /**
 176      * Plugin version data
 177      *
 178      * @param array &$versions array of version data
 179      *
 180      * @return value
 181      */
 182     function onPluginVersion(&$versions)
 183     {
 184         $versions[] = array('name' => 'Bookmark',
 185                             'version' => self::VERSION,
 186                             'author' => 'Evan Prodromou, Stephane Berube, Jean Baptiste Favre',
 187                             'homepage' => 'http://status.net/wiki/Plugin:Bookmark',
 188                             'description' =>
 189                             // TRANS: Plugin description.
 190                             _m('Simple extension for supporting bookmarks. ') .
 191                             'BookmarkList feature has been developped by Stephane Berube. ' .
 192                             'Integration has been done by Jean Baptiste Favre.');
 193         return true;
 194     }
 195
 196     /**
 197      * Load our document if requested
 198      *
 199      * @param string &$title  Title to fetch
 200      * @param string &$output HTML to output
 201      *
 202      * @return boolean hook value
 203      */
 204     function onStartLoadDoc(&$title, &$output)
 205     {
 206         if ($title == 'bookmarklet') {
 207             $filename = INSTALLDIR.'/plugins/Bookmark/bookmarklet';
 208
 209             $c      = file_get_contents($filename);
 210             $output = common_markup_to_html($c);
 211             return false; // success!
 212         }
 213
 214         return true;
 215     }
 216
 217     /**
 218      * Show a link to our delicious import page on profile settings form
 219      *
 220      * @param Action $action Profile settings action being shown
 221      *
 222      * @return boolean hook value
 223      */
 224     function onEndProfileSettingsActions($action)
 225     {
 226         $user = common_current_user();
 227
 228         if (!empty($user) && $user->hasRight(self::IMPORTDELICIOUS)) {
 229             $action->elementStart('li');
 230             $action->element('a',
 231                              array('href' => common_local_url('importdelicious')),
 232                              // TRANS: Link text in proile leading to import form.
 233                              _m('Import del.icio.us bookmarks'));
 234             $action->elementEnd('li');
 235         }
 236
 237         return true;
 238     }
 239
 240     /**
 241      * Output our CSS class for bookmark notice list elements
 242      *
 243      * @param NoticeListItem $nli The item being shown
 244      *
 245      * @return boolean hook value
 246      */
 247
 248     function onStartOpenNoticeListItemElement($nli)
 249     {
 250         if (!$this->isMyNotice($nli->notice)) {
 251                 return true;
 252         }
 253
 254         $nb = Bookmark::getByNotice($nli->notice);
 255
 256         if (empty($nb)) {
 257                 $this->log(LOG_INFO, "Notice {$nli->notice->id} has bookmark class but no matching Bookmark record.");
 258                 return true;
 259         }
 260
 261             $id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id;
 262             $class = 'hentry notice bookmark';
 263             if ($nli->notice->scope != 0 && $nli->notice->scope != 1) {
 264                 $class .= ' limited-scope';
 265             }
 266             $nli->out->elementStart('li', array('class' => $class,
 267                                                 'id' => 'notice-' . $id));
 268
 269             Event::handle('EndOpenNoticeListItemElement', array($nli));
 270             return false;
 271     }
 272
 273     /**
 274      * Modify the default menu to link to our custom action
 275      *
 276      * Using event handlers, it's possible to modify the default UI for pages
 277      * almost without limit. In this method, we add a menu item to the default
 278      * primary menu for the interface to link to our action.
 279      *
 280      * The Action class provides a rich set of events to hook, as well as output
 281      * methods.
 282      *
 283      * @param Action $action The current action handler. Use this to
 284      * do any output.
 285      *
 286      * @return boolean hook value; true means continue processing, false means stop.
 287      *
 288      * @see Action
 289      */
 290     function onEndPersonalGroupNav($action)
 291     {
 292         $this->user = common_current_user();
 293
 294         if (!$this->user) {
 295             // TRANS: Client error displayed when trying to display bookmarks for a non-existing user.
 296             $this->clientError(_('No such user.'));
 297         }
 298
 299         $action->menuItem(common_local_url('bookmarks', array('nickname' => $this->user->nickname)),
 300                           // TRANS: Menu item in sample plugin.
 301                           _m('Bookmarks'),
 302                           // TRANS: Menu item title in sample plugin.
 303                           _m('A list of your bookmarks'), false, 'nav_timeline_bookmarks');
 304         return true;
 305     }
 306
 307     /**
 308      * Save a remote bookmark (from Salmon or PuSH)
 309      *
 310      * @param Ostatus_profile $author   Author of the bookmark
 311      * @param Activity        $activity Activity to save
 312      *
 313      * @return Notice resulting notice.
 314      */
 315     static private function _postRemoteBookmark(Ostatus_profile $author,
 316                                                 Activity $activity)
 317     {
 318         $bookmark = $activity->objects[0];
 319
 320         $options = array('uri' => $bookmark->id,
 321                          'url' => $bookmark->link,
 322                          'is_local' => Notice::REMOTE,
 323                          'source' => 'ostatus');
 324
 325         return self::_postBookmark($author->localProfile(), $activity, $options);
 326     }
 327
 328     /**
 329      * Test if an activity represents posting a bookmark
 330      *
 331      * @param Activity $activity Activity to test
 332      *
 333      * @return true if it's a Post of a Bookmark, else false
 334      */
 335     static private function _isPostBookmark($activity)
 336     {
 337         return ($activity->verb == ActivityVerb::POST &&
 338                 $activity->objects[0]->type == ActivityObject::BOOKMARK);
 339     }
 340
 341     function types()
 342     {
 343         return array(ActivityObject::BOOKMARK);
 344     }
 345
 346     /**
 347      * When a notice is deleted, delete the related Bookmark
 348      *
 349      * @param Notice $notice Notice being deleted
 350      *
 351      * @return boolean hook value
 352      */
 353     function deleteRelated($notice)
 354     {
 355         if ($this->isMyNotice($notice)) {
 356
 357                 $nb = Bookmark::getByNotice($notice);
 358
 359                 if (!empty($nb)) {
 360                 $nb->delete();
 361                 }
 362         }
 363
 364         return true;
 365     }
 366
 367     /**
 368      * Save a bookmark from an activity
 369      *
 370      * @param Activity $activity Activity to save
 371      * @param Profile  $profile  Profile to use as author
 372      * @param array    $options  Options to pass to bookmark-saving code
 373      *
 374      * @return Notice resulting notice
 375      */
 376     function saveNoticeFromActivity($activity, $profile, $options=array())
 377     {
 378         $bookmark = $activity->objects[0];
 379
 380         $relLinkEls = ActivityUtils::getLinks($bookmark->element, 'related');
 381
 382         if (count($relLinkEls) < 1) {
 383             // TRANS: Client exception thrown when a bookmark is formatted incorrectly.
 384             throw new ClientException(_m('Expected exactly 1 link '.
 385                                         'rel=related in a Bookmark.'));
 386         }
 387
 388         if (count($relLinkEls) > 1) {
 389             common_log(LOG_WARNING,
 390                        "Got too many link rel=related in a Bookmark.");
 391         }
 392
 393         $linkEl = $relLinkEls[0];
 394
 395         $url = $linkEl->getAttribute('href');
 396
 397         $tags = array();
 398
 399         foreach ($activity->categories as $category) {
 400             $tags[] = common_canonical_tag($category->term);
 401         }
 402
 403         if (!empty($activity->time)) {
 404             $options['created'] = common_sql_date($activity->time);
 405         }
 406
 407         // Fill in location if available
 408
 409         $location = $activity->context->location;
 410
 411         if ($location) {
 412             $options['lat'] = $location->lat;
 413             $options['lon'] = $location->lon;
 414             if ($location->location_id) {
 415                 $options['location_ns'] = $location->location_ns;
 416                 $options['location_id'] = $location->location_id;
 417             }
 418         }
 419
 420         $options['groups']  = array();
 421         $options['replies'] = array();  // TODO: context->attention
 422
 423         foreach ($activity->context->attention as $attnUrl=>$type) {
 424             $other = Profile::fromURI($attnUrl);
 425             if ($other instanceof Profile) {
 426                 $options['replies'][] = $attnUrl;
 427             } else {
 428                 // Maybe we can get rid of this since every User_group got a Profile?
 429                 // TODO: Make sure the above replies get sorted properly for groups (or handled afterwards)
 430                 $group = User_group::getKV('uri', $attnUrl);
 431                 if ($group instanceof User_group) {
 432                     $options['groups'][] = $attnUrl;
 433                 }
 434             }
 435         }
 436
 437         // Maintain direct reply associations
 438         // @fixme what about conversation ID?
 439
 440         if (!empty($activity->context->replyToID)) {
 441             $orig = Notice::getKV('uri',
 442                                       $activity->context->replyToID);
 443             if (!empty($orig)) {
 444                 $options['reply_to'] = $orig->id;
 445             }
 446         }
 447
 448         return Bookmark::saveNew($profile,
 449                                  $bookmark->title,
 450                                  $url,
 451                                  $tags,
 452                                  $bookmark->summary,
 453                                  $options);
 454     }
 455
 456     function activityObjectFromNotice($notice)
 457     {
 458         assert($this->isMyNotice($notice));
 459
 460         common_log(LOG_INFO,
 461                    "Formatting notice {$notice->uri} as a bookmark.");
 462
 463         $object = new ActivityObject();
 464         $nb = Bookmark::getByNotice($notice);
 465
 466         $object->id      = $notice->uri;
 467         $object->type    = ActivityObject::BOOKMARK;
 468         $object->title   = $nb->title;
 469         $object->summary = $nb->description;
 470         $object->link    = $notice->bestUrl();
 471
 472         // Attributes of the URL
 473
 474         $attachments = $notice->attachments();
 475
 476         if (count($attachments) != 1) {
 477             // TRANS: Server exception thrown when a bookmark has multiple attachments.
 478             throw new ServerException(_m('Bookmark notice with the '.
 479                                         'wrong number of attachments.'));
 480         }
 481
 482         $target = $attachments[0];
 483
 484         $attrs = array('rel' => 'related',
 485                        'href' => $target->url);
 486
 487         if (!empty($target->title)) {
 488             $attrs['title'] = $target->title;
 489         }
 490
 491         $object->extra[] = array('link', $attrs, null);
 492
 493         // Attributes of the thumbnail, if any
 494
 495         $thumbnail = $target->getThumbnail();
 496
 497         if (!empty($thumbnail)) {
 498             $tattrs = array('rel' => 'preview',
 499                             'href' => $thumbnail->url);
 500
 501             if (!empty($thumbnail->width)) {
 502                 $tattrs['media:width'] = $thumbnail->width;
 503             }
 504
 505             if (!empty($thumbnail->height)) {
 506                 $tattrs['media:height'] = $thumbnail->height;
 507             }
 508
 509             $object->extra[] = array('link', $attrs, null);
 510         }
 511
 512         return $object;
 513     }
 514
 515     /**
 516      * Given a notice list item, returns an adapter specific
 517      * to this plugin.
 518      *
 519      * @param NoticeListItem $nli item to adapt
 520      *
 521      * @return NoticeListItemAdapter adapter or null
 522      */
 523     function adaptNoticeListItem($nli)
 524     {
 525         return new BookmarkListItem($nli);
 526     }
 527
 528     function entryForm($out)
 529     {
 530         return new InitialBookmarkForm($out);
 531     }
 532
 533     function tag()
 534     {
 535         return 'bookmark';
 536     }
 537
 538     function appTitle()
 539     {
 540         // TRANS: Application title.
 541         return _m('TITLE','Bookmark');
 542     }
 543
 544     function onEndUpgrade()
 545     {
 546         // Version 0.9.x of the plugin didn't stamp notices
 547         // with verb and object-type (for obvious reasons). Update
 548         // those notices here.
 549
 550         $notice = new Notice();
 551
 552         $notice->whereAdd('exists (select uri from bookmark where bookmark.uri = notice.uri)');
 553         $notice->whereAdd('((object_type is null) or (object_type = "' .ActivityObject::NOTE.'"))');
 554
 555         $notice->find();
 556
 557         while ($notice->fetch()) {
 558             $original = clone($notice);
 559             $notice->verb        = ActivityVerb::POST;
 560             $notice->object_type = ActivityObject::BOOKMARK;
 561             $notice->update($original);
 562         }
 563     }
 564
 565     public function activityObjectOutputJson(ActivityObject $obj, array &$out)
 566     {
 567         assert($obj->type == ActivityObject::BOOKMARK);
 568
 569         $bm = Bookmark::getKV('uri', $obj->id);
 570
 571         if (empty($bm)) {
 572             throw new ServerException("Unknown bookmark: " . $obj->id);
 573         }
 574
 575         $out['displayName'] = $bm->title;
 576         $out['targetUrl']   = $bm->url;
 577
 578         return true;
 579     }
 580 }