]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/Bookmark/BookmarkPlugin.php
incorrect name for bookmark plugin
[quix0rs-gnu-social.git] / plugins / Bookmark / BookmarkPlugin.php
index 99cfc1284e199a9494ebf80a0fe87c79ef3118c7..339b03e0561ba988317063a602ea841f97bbc04d 100644 (file)
@@ -46,7 +46,29 @@ if (!defined('STATUSNET')) {
 
 class BookmarkPlugin extends Plugin
 {
-    const VERSION = '0.1';
+    const VERSION         = '0.1';
+    const IMPORTDELICIOUS = 'BookmarkPlugin:IMPORTDELICIOUS';
+
+    /**
+     * Authorization for importing delicious bookmarks
+     *
+     * By default, everyone can import bookmarks except silenced people.
+     *
+     * @param Profile $profile Person whose rights to check
+     * @param string  $right   Right to check; const value
+     * @param boolean &$result Result of the check, writeable
+     *
+     * @return boolean hook value
+     */
+
+    function onUserRightsCheck($profile, $right, &$result)
+    {
+        if ($right == self::IMPORTDELICIOUS) {
+            $result = !$profile->isSilenced();
+            return false;
+        }
+        return true;
+    }
 
     /**
      * Database schema setup
@@ -64,16 +86,21 @@ class BookmarkPlugin extends Plugin
         // For storing user-submitted flags on profiles
 
         $schema->ensureTable('bookmark',
-                             array(new ColumnDef('profile_id',
+                             array(new ColumnDef('id',
+                                                 'char',
+                                                 36,
+                                                 false,
+                                                 'PRI'),
+                                   new ColumnDef('profile_id',
                                                  'integer',
                                                  null,
                                                  false,
-                                                 'PRI'),
+                                                 'MUL'),
                                    new ColumnDef('url',
                                                  'varchar',
                                                  255,
                                                  false,
-                                                 'PRI'),
+                                                 'MUL'),
                                    new ColumnDef('title',
                                                  'varchar',
                                                  255),
@@ -84,26 +111,12 @@ class BookmarkPlugin extends Plugin
                                                  255,
                                                  false,
                                                  'UNI'),
-                                   new ColumnDef('url_crc32',
-                                                 'integer unsigned',
-                                                 null,
-                                                 false,
-                                                 'MUL'),
                                    new ColumnDef('created',
                                                  'datetime',
                                                  null,
                                                  false,
                                                  'MUL')));
 
-        try {
-            $schema->createIndex('bookmark', 
-                                 array('profile_id', 
-                                       'url_crc32'),
-                                 'bookmark_profile_url_idx');
-        } catch (Exception $e) {
-            common_log(LOG_ERR, $e->getMessage());
-        }
-
         return true;
     }
 
@@ -136,7 +149,7 @@ class BookmarkPlugin extends Plugin
 
     function onEndShowStyles($action)
     {
-        $action->cssLink('plugins/Bookmark/bookmark.css');
+        $action->cssLink($this->path('bookmark.css'));
         return true;
     }
 
@@ -157,6 +170,8 @@ class BookmarkPlugin extends Plugin
         case 'ShowbookmarkAction':
         case 'NewbookmarkAction':
         case 'BookmarkpopupAction':
+        case 'NoticebyurlAction':
+        case 'ImportdeliciousAction':
             include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
             return false;
         case 'Bookmark':
@@ -186,13 +201,19 @@ class BookmarkPlugin extends Plugin
                     array('action' => 'newbookmark'),
                     array('id' => '[0-9]+'));
 
-        $m->connect('main/bookmark/popup', array('action' => 'bookmarkpopup'));
+        $m->connect('main/bookmark/popup',
+                    array('action' => 'bookmarkpopup'));
 
-        $m->connect('bookmark/:user/:created/:crc32',
+        $m->connect('main/bookmark/import',
+                    array('action' => 'importdelicious'));
+
+        $m->connect('bookmark/:id',
                     array('action' => 'showbookmark'),
-                    array('user' => '[0-9]+',
-                          'created' => '[0-9]{14}',
-                          'crc32' => '[0-9a-f]{8}'));
+                    array('id' => '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'));
+
+        $m->connect('notice/by-url/:id',
+                    array('action' => 'noticebyurl'),
+                    array('id' => '[0-9]+'));
 
         return true;
     }
@@ -224,19 +245,34 @@ class BookmarkPlugin extends Plugin
 
             $att = $atts[0];
 
-            $out->elementStart('h3');
-            $out->element('a',
-                          array('href' => $att->url),
-                          $nb->title);
-            $out->elementEnd('h3');
+            // XXX: only show the bookmark URL for non-single-page stuff
+
+            if ($out instanceof ShowbookmarkAction) {
+            } else {
+                $out->elementStart('h3');
+                $out->element('a',
+                              array('href' => $att->url,
+                                    'class' => 'bookmark-title entry-title'),
+                              $nb->title);
+                $out->elementEnd('h3');
+
+                $countUrl = common_local_url('noticebyurl',
+                                             array('id' => $att->id));
+
+                $out->element('a', array('class' => 'bookmark-notice-count',
+                                         'href' => $countUrl),
+                              $att->noticeCount());
+            }
 
-            $out->elementStart('ul', array('class' => 'bookmark_tags'));
-            
             // Replies look like "for:" tags
 
             $replies = $nli->notice->getReplies();
+            $tags = $nli->notice->getTags();
 
-            if (!empty($replies)) {
+            if (!empty($replies) || !empty($tags)) {
+
+                $out->elementStart('ul', array('class' => 'bookmark-tags'));
+            
                 foreach ($replies as $reply) {
                     $other = Profile::staticGet('id', $reply);
                     $out->elementStart('li');
@@ -247,42 +283,59 @@ class BookmarkPlugin extends Plugin
                     $out->elementEnd('li');
                     $out->text(' ');
                 }
-            }
 
-            $tags = $nli->notice->getTags();
+                foreach ($tags as $tag) {
+                    $out->elementStart('li');
+                    $out->element('a', 
+                                  array('rel' => 'tag',
+                                        'href' => Notice_tag::url($tag)),
+                                  $tag);
+                    $out->elementEnd('li');
+                    $out->text(' ');
+                }
 
-            foreach ($tags as $tag) {
-                $out->elementStart('li');
-                $out->element('a', 
-                              array('rel' => 'tag',
-                                    'href' => Notice_tag::url($tag)),
-                              $tag);
-                $out->elementEnd('li');
-                $out->text(' ');
+                $out->elementEnd('ul');
             }
 
-            $out->elementEnd('ul');
-
-            $out->element('p',
-                          array('class' => 'bookmark_description'),
-                          $nb->description);
+            if (!empty($nb->description)) {
+                $out->element('p',
+                              array('class' => 'bookmark-description'),
+                              $nb->description);
+            }
 
-            $nli->showNoticeAttachments();
+            if (common_config('attachments', 'show_thumbs')) {
+                $haveThumbs = false;
+                foreach ($atts as $check) {
+                    $thumbnail = File_thumbnail::staticGet('file_id', $check->id);
+                    if (!empty($thumbnail)) {
+                        $haveThumbs = true;
+                        break;
+                    }
+                }
+                if ($haveThumbs) {
+                    $al = new InlineAttachmentList($notice, $out);
+                    $al->show();
+                }
+            }
 
-            $out->elementStart('p', array('style' => 'float: left'));
+            $out->elementStart('div', array('class' => 'bookmark-info entry-content'));
 
             $avatar = $profile->getAvatar(AVATAR_MINI_SIZE);
 
-            $out->element('img', array('src' => ($avatar) ?
-                                       $avatar->displayUrl() :
-                                       Avatar::defaultImage(AVATAR_MINI_SIZE),
-                                       'class' => 'avatar photo bookmark_avatar',
-                                       'width' => AVATAR_MINI_SIZE,
-                                       'height' => AVATAR_MINI_SIZE,
-                                       'alt' => $profile->getBestName()));
+            $out->element('img', 
+                          array('src' => ($avatar) ?
+                                $avatar->displayUrl() :
+                                Avatar::defaultImage(AVATAR_MINI_SIZE),
+                                'class' => 'avatar photo bookmark-avatar',
+                                'width' => AVATAR_MINI_SIZE,
+                                'height' => AVATAR_MINI_SIZE,
+                                'alt' => $profile->getBestName()));
+
             $out->raw(' ');
-            $out->element('a', array('href' => $profile->profileurl,
-                                     'title' => $profile->getBestName()),
+
+            $out->element('a', 
+                          array('href' => $profile->profileurl,
+                                'title' => $profile->getBestName()),
                           $profile->nickname);
 
             $nli->showNoticeLink();
@@ -291,7 +344,7 @@ class BookmarkPlugin extends Plugin
             $nli->showContext();
             $nli->showRepeat();
 
-            $out->elementEnd('p');
+            $out->elementEnd('div');
 
             $nli->showNoticeOptions();
 
@@ -397,7 +450,7 @@ class BookmarkPlugin extends Plugin
 
     function onPluginVersion(&$versions)
     {
-        $versions[] = array('name' => 'Sample',
+        $versions[] = array('name' => 'Bookmark',
                             'version' => self::VERSION,
                             'author' => 'Evan Prodromou',
                             'homepage' => 'http://status.net/wiki/Plugin:Bookmark',
@@ -437,14 +490,14 @@ class BookmarkPlugin extends Plugin
      * @return boolean hook value
      */
 
-    function onStartHandleFeedEntryWithProfile($activity, $oprofile) {
-
+    function onStartHandleFeedEntryWithProfile($activity, $oprofile)
+    {
         common_log(LOG_INFO, "BookmarkPlugin called for new feed entry.");
 
-        if ($activity->verb == ActivityVerb::POST &&
-            $activity->objects[0]->type == ActivityObject::BOOKMARK) {
+        if (self::_isPostBookmark($activity)) {
 
-            common_log(LOG_INFO, "Importing activity {$activity->id} as a bookmark.");
+            common_log(LOG_INFO, 
+                       "Importing activity {$activity->id} as a bookmark.");
 
             $author = $oprofile->checkAuthorship($activity);
 
@@ -461,18 +514,209 @@ class BookmarkPlugin extends Plugin
         return true;
     }
 
-    static private function _postRemoteBookmark(Ostatus_profile $author, Activity $activity)
+    /**
+     * Handle a posted bookmark from Salmon
+     *
+     * @param Activity $activity activity to handle
+     * @param mixed    $target   user or group targeted
+     *
+     * @return boolean hook value
+     */
+
+    function onStartHandleSalmonTarget($activity, $target)
+    {
+        if (self::_isPostBookmark($activity)) {
+
+            $this->log(LOG_INFO, "Checking {$activity->id} as a valid Salmon slap.");
+
+            if ($target instanceof User_group) {
+                $uri = $target->getUri();
+                if (!in_array($uri, $activity->context->attention)) {
+                    throw new ClientException(_("Bookmark not posted ".
+                                                "to this group."));
+                }
+            } else if ($target instanceof User) {
+                $uri      = $target->uri;
+                $original = null;
+                if (!empty($activity->context->replyToID)) {
+                    $original = Notice::staticGet('uri', 
+                                                  $activity->context->replyToID); 
+                }
+                if (!in_array($uri, $activity->context->attention) &&
+                    (empty($original) ||
+                     $original->profile_id != $target->id)) {
+                    throw new ClientException(_("Bookmark not posted ".
+                                                "to this user."));
+                }
+            } else {
+                throw new ServerException(_("Don't know how to handle ".
+                                            "this kind of target."));
+            }
+
+            $author = Ostatus_profile::ensureActivityObjectProfile($activity->actor);
+
+            self::_postRemoteBookmark($author,
+                                      $activity);
+
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Handle bookmark posted via AtomPub
+     *
+     * @param Activity &$activity Activity that was posted
+     * @param User     $user      User that posted it
+     * @param Notice   &$notice   Resulting notice
+     *
+     * @return boolean hook value
+     */
+
+    function onStartAtomPubNewActivity(&$activity, $user, &$notice)
+    {
+        if (self::_isPostBookmark($activity)) {
+            $options = array('source' => 'atompub');
+            $notice  = self::_postBookmark($user->getProfile(),
+                                           $activity,
+                                           $options);
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Handle bookmark imported from a backup file
+     *
+     * @param User           $user     User to import for
+     * @param ActivityObject $author   Original author per import file
+     * @param Activity       $activity Activity to import
+     * @param boolean        $trusted  Is this a trusted user?
+     * @param boolean        &$done    Is this done (success or unrecoverable error)
+     *
+     * @return boolean hook value
+     */
+
+    function onStartImportActivity($user, $author, $activity, $trusted, &$done)
+    {
+        if (self::_isPostBookmark($activity)) {
+
+            $bookmark = $activity->objects[0];
+
+            $this->log(LOG_INFO,
+                       'Importing Bookmark ' . $bookmark->id . 
+                       ' for user ' . $user->nickname);
+
+            $options = array('uri' => $bookmark->id,
+                             'url' => $bookmark->link,
+                             'source' => 'restore');
+
+            $saved = self::_postBookmark($user->getProfile(), $activity, $options);
+
+            if (!empty($saved)) {
+                $done = true;
+            }
+
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Show a link to our delicious import page on profile settings form
+     *
+     * @param Action $action Profile settings action being shown
+     *
+     * @return boolean hook value
+     */
+
+    function onEndProfileSettingsActions($action)
+    {
+        $user = common_current_user();
+        
+        if (!empty($user) && $user->hasRight(self::IMPORTDELICIOUS)) {
+            $action->elementStart('li');
+            $action->element('a',
+                             array('href' => common_local_url('importdelicious')),
+                             _('Import del.icio.us bookmarks'));
+            $action->elementEnd('li');
+        }
+
+        return true;
+    }
+
+    /**
+     * Output our CSS class for bookmark notice list elements
+     *
+     * @param NoticeListItem $nli The item being shown
+     *
+     * @return boolean hook value
+     */
+
+    function onStartOpenNoticeListItemElement($nli)
+    {
+        $nb = Bookmark::getByNotice($nli->notice);
+        if (!empty($nb)) {
+            $id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id;
+            $nli->out->elementStart('li', array('class' => 'hentry notice bookmark',
+                                                 'id' => 'notice-' . $id));
+            Event::handle('EndOpenNoticeListItemElement', array($nli));
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Save a remote bookmark (from Salmon or PuSH)
+     *
+     * @param Ostatus_profile $author   Author of the bookmark
+     * @param Activity        $activity Activity to save
+     *
+     * @return Notice resulting notice.
+     */
+
+    static private function _postRemoteBookmark(Ostatus_profile $author,
+                                                Activity $activity)
+    {
+        $bookmark = $activity->objects[0];
+
+        $options = array('uri' => $bookmark->id,
+                         'url' => $bookmark->link,
+                         'is_local' => Notice::REMOTE_OMB,
+                         'source' => 'ostatus');
+        
+        return self::_postBookmark($author->localProfile(), $activity, $options);
+    }
+
+    /**
+     * Save a bookmark from an activity
+     *
+     * @param Profile  $profile  Profile to use as author
+     * @param Activity $activity Activity to save
+     * @param array    $options  Options to pass to bookmark-saving code
+     *
+     * @return Notice resulting notice
+     */
+
+    static private function _postBookmark(Profile $profile,
+                                          Activity $activity,
+                                          $options=array())
     {
         $bookmark = $activity->objects[0];
 
         $relLinkEls = ActivityUtils::getLinks($bookmark->element, 'related');
 
         if (count($relLinkEls) < 1) {
-            throw new ClientException(_('Expected exactly 1 link rel=related in a Bookmark.'));
+            throw new ClientException(_('Expected exactly 1 link '.
+                                        'rel=related in a Bookmark.'));
         }
 
         if (count($relLinkEls) > 1) {
-            common_log(LOG_WARNING, "Got too many link rel=related in a Bookmark.");
+            common_log(LOG_WARNING,
+                       "Got too many link rel=related in a Bookmark.");
         }
 
         $linkEl = $relLinkEls[0];
@@ -485,11 +729,9 @@ class BookmarkPlugin extends Plugin
             $tags[] = common_canonical_tag($category->term);
         }
 
-        $options = array('uri' => $bookmark->id,
-                         'url' => $bookmark->link,
-                         'created' => common_sql_date($activity->time),
-                         'is_local' => Notice::REMOTE_OMB,
-                         'source' => 'ostatus');
+        if (!empty($activity->time)) {
+            $options['created'] = common_sql_date($activity->time);
+        }
 
         // Fill in location if available
 
@@ -506,12 +748,12 @@ class BookmarkPlugin extends Plugin
 
         $replies = $activity->context->attention;
 
-        $options['groups'] = array();
+        $options['groups']  = array();
         $options['replies'] = array();
 
         foreach ($replies as $replyURI) {
-            $profile = Profile::fromURI($replyURI);
-            if (!empty($profile)) {
+            $other = Profile::fromURI($replyURI);
+            if (!empty($other)) {
                 $options['replies'][] = $replyURI;
             } else {
                 $group = User_group::staticGet('uri', $replyURI);
@@ -532,12 +774,25 @@ class BookmarkPlugin extends Plugin
             }
         }
 
-        Bookmark::saveNew($author->localProfile(),
+        return Bookmark::saveNew($profile,
                                  $bookmark->title,
                                  $url,
                                  $tags,
                                  $bookmark->summary,
                                  $options);
     }
-}
 
+    /**
+     * Test if an activity represents posting a bookmark
+     *
+     * @param Activity $activity Activity to test
+     *
+     * @return true if it's a Post of a Bookmark, else false
+     */
+
+    static private function _isPostBookmark($activity)
+    {
+        return ($activity->verb == ActivityVerb::POST &&
+                $activity->objects[0]->type == ActivityObject::BOOKMARK);
+    }
+}