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             return false;
 298         }
 299
 300         $action->menuItem(common_local_url('bookmarks', array('nickname' => $this->user->nickname)),
 301                           // TRANS: Menu item in sample plugin.
 302                           _m('Bookmarks'),
 303                           // TRANS: Menu item title in sample plugin.
 304                           _m('A list of your bookmarks'), false, 'nav_timeline_bookmarks');
 305         return true;
 306     }
 307
 308     /**
 309      * Save a remote bookmark (from Salmon or PuSH)
 310      *
 311      * @param Ostatus_profile $author   Author of the bookmark
 312      * @param Activity        $activity Activity to save
 313      *
 314      * @return Notice resulting notice.
 315      */
 316     static private function _postRemoteBookmark(Ostatus_profile $author,
 317                                                 Activity $activity)
 318     {
 319         $bookmark = $activity->objects[0];
 320
 321         $options = array('uri' => $bookmark->id,
 322                          'url' => $bookmark->link,
 323                          'is_local' => Notice::REMOTE,
 324                          'source' => 'ostatus');
 325
 326         return self::_postBookmark($author->localProfile(), $activity, $options);
 327     }
 328
 329     /**
 330      * Test if an activity represents posting a bookmark
 331      *
 332      * @param Activity $activity Activity to test
 333      *
 334      * @return true if it's a Post of a Bookmark, else false
 335      */
 336     static private function _isPostBookmark($activity)
 337     {
 338         return ($activity->verb == ActivityVerb::POST &&
 339                 $activity->objects[0]->type == ActivityObject::BOOKMARK);
 340     }
 341
 342     function types()
 343     {
 344         return array(ActivityObject::BOOKMARK);
 345     }
 346
 347     /**
 348      * When a notice is deleted, delete the related Bookmark
 349      *
 350      * @param Notice $notice Notice being deleted
 351      *
 352      * @return boolean hook value
 353      */
 354     function deleteRelated($notice)
 355     {
 356         if ($this->isMyNotice($notice)) {
 357
 358                 $nb = Bookmark::getByNotice($notice);
 359
 360                 if (!empty($nb)) {
 361                 $nb->delete();
 362                 }
 363         }
 364
 365         return true;
 366     }
 367
 368     /**
 369      * Save a bookmark from an activity
 370      *
 371      * @param Activity $activity Activity to save
 372      * @param Profile  $profile  Profile to use as author
 373      * @param array    $options  Options to pass to bookmark-saving code
 374      *
 375      * @return Notice resulting notice
 376      */
 377     function saveNoticeFromActivity($activity, $profile, $options=array())
 378     {
 379         $bookmark = $activity->objects[0];
 380
 381         $relLinkEls = ActivityUtils::getLinks($bookmark->element, 'related');
 382
 383         if (count($relLinkEls) < 1) {
 384             // TRANS: Client exception thrown when a bookmark is formatted incorrectly.
 385             throw new ClientException(_m('Expected exactly 1 link '.
 386                                         'rel=related in a Bookmark.'));
 387         }
 388
 389         if (count($relLinkEls) > 1) {
 390             common_log(LOG_WARNING,
 391                        "Got too many link rel=related in a Bookmark.");
 392         }
 393
 394         $linkEl = $relLinkEls[0];
 395
 396         $url = $linkEl->getAttribute('href');
 397
 398         $tags = array();
 399
 400         foreach ($activity->categories as $category) {
 401             $tags[] = common_canonical_tag($category->term);
 402         }
 403
 404         if (!empty($activity->time)) {
 405             $options['created'] = common_sql_date($activity->time);
 406         }
 407
 408         // Fill in location if available
 409
 410         $location = $activity->context->location;
 411
 412         if ($location) {
 413             $options['lat'] = $location->lat;
 414             $options['lon'] = $location->lon;
 415             if ($location->location_id) {
 416                 $options['location_ns'] = $location->location_ns;
 417                 $options['location_id'] = $location->location_id;
 418             }
 419         }
 420
 421         $options['groups']  = array();
 422         $options['replies'] = array();  // TODO: context->attention
 423
 424         foreach ($activity->context->attention as $attnUrl=>$type) {
 425             $other = Profile::fromURI($attnUrl);
 426             if ($other instanceof Profile) {
 427                 $options['replies'][] = $attnUrl;
 428             } else {
 429                 // Maybe we can get rid of this since every User_group got a Profile?
 430                 // TODO: Make sure the above replies get sorted properly for groups (or handled afterwards)
 431                 $group = User_group::getKV('uri', $attnUrl);
 432                 if ($group instanceof User_group) {
 433                     $options['groups'][] = $attnUrl;
 434                 }
 435             }
 436         }
 437
 438         // Maintain direct reply associations
 439         // @fixme what about conversation ID?
 440
 441         if (!empty($activity->context->replyToID)) {
 442             $orig = Notice::getKV('uri',
 443                                       $activity->context->replyToID);
 444             if (!empty($orig)) {
 445                 $options['reply_to'] = $orig->id;
 446             }
 447         }
 448
 449         return Bookmark::saveNew($profile,
 450                                  $bookmark->title,
 451                                  $url,
 452                                  $tags,
 453                                  $bookmark->summary,
 454                                  $options);
 455     }
 456
 457     function activityObjectFromNotice($notice)
 458     {
 459         assert($this->isMyNotice($notice));
 460
 461         common_log(LOG_INFO,
 462                    "Formatting notice {$notice->uri} as a bookmark.");
 463
 464         $object = new ActivityObject();
 465         $nb = Bookmark::getByNotice($notice);
 466
 467         $object->id      = $notice->uri;
 468         $object->type    = ActivityObject::BOOKMARK;
 469         $object->title   = $nb->title;
 470         $object->summary = $nb->description;
 471         $object->link    = $notice->bestUrl();
 472
 473         // Attributes of the URL
 474
 475         $attachments = $notice->attachments();
 476
 477         if (count($attachments) != 1) {
 478             // TRANS: Server exception thrown when a bookmark has multiple attachments.
 479             throw new ServerException(_m('Bookmark notice with the '.
 480                                         'wrong number of attachments.'));
 481         }
 482
 483         $target = $attachments[0];
 484
 485         $attrs = array('rel' => 'related',
 486                        'href' => $target->url);
 487
 488         if (!empty($target->title)) {
 489             $attrs['title'] = $target->title;
 490         }
 491
 492         $object->extra[] = array('link', $attrs, null);
 493
 494         // Attributes of the thumbnail, if any
 495
 496         $thumbnail = $target->getThumbnail();
 497
 498         if (!empty($thumbnail)) {
 499             $tattrs = array('rel' => 'preview',
 500                             'href' => $thumbnail->url);
 501
 502             if (!empty($thumbnail->width)) {
 503                 $tattrs['media:width'] = $thumbnail->width;
 504             }
 505
 506             if (!empty($thumbnail->height)) {
 507                 $tattrs['media:height'] = $thumbnail->height;
 508             }
 509
 510             $object->extra[] = array('link', $attrs, null);
 511         }
 512
 513         return $object;
 514     }
 515
 516     /**
 517      * Given a notice list item, returns an adapter specific
 518      * to this plugin.
 519      *
 520      * @param NoticeListItem $nli item to adapt
 521      *
 522      * @return NoticeListItemAdapter adapter or null
 523      */
 524     function adaptNoticeListItem($nli)
 525     {
 526         return new BookmarkListItem($nli);
 527     }
 528
 529     function entryForm($out)
 530     {
 531         return new InitialBookmarkForm($out);
 532     }
 533
 534     function tag()
 535     {
 536         return 'bookmark';
 537     }
 538
 539     function appTitle()
 540     {
 541         // TRANS: Application title.
 542         return _m('TITLE','Bookmark');
 543     }
 544
 545     function onEndUpgrade()
 546     {
 547         // Version 0.9.x of the plugin didn't stamp notices
 548         // with verb and object-type (for obvious reasons). Update
 549         // those notices here.
 550
 551         $notice = new Notice();
 552
 553         $notice->whereAdd('exists (select uri from bookmark where bookmark.uri = notice.uri)');
 554         $notice->whereAdd('((object_type is null) or (object_type = "' .ActivityObject::NOTE.'"))');
 555
 556         $notice->find();
 557
 558         while ($notice->fetch()) {
 559             $original = clone($notice);
 560             $notice->verb        = ActivityVerb::POST;
 561             $notice->object_type = ActivityObject::BOOKMARK;
 562             $notice->update($original);
 563         }
 564     }
 565
 566     public function activityObjectOutputJson(ActivityObject $obj, array &$out)
 567     {
 568         assert($obj->type == ActivityObject::BOOKMARK);
 569
 570         $bm = Bookmark::getKV('uri', $obj->id);
 571
 572         if (empty($bm)) {
 573             throw new ServerException("Unknown bookmark: " . $obj->id);
 574         }
 575
 576         $out['displayName'] = $bm->title;
 577         $out['targetUrl']   = $bm->url;
 578
 579         return true;
 580     }
 581 }