]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/Bookmark/BookmarkPlugin.php
plugins onAutoload now only overloads if necessary (extlibs etc.)
[quix0rs-gnu-social.git] / plugins / Bookmark / BookmarkPlugin.php
index 9d92fd61a3c0fb4d8c065431c18426d7286e3695..6dacdb085e88a167492d50f64893d07ca1b31950 100644 (file)
@@ -135,40 +135,6 @@ class BookmarkPlugin extends MicroAppPlugin
         $action->script($this->path('js/bookmark.js'));
         return true;
     }
-    /**
-     * Load related modules when needed
-     *
-     * @param string $cls Name of the class to be loaded
-     *
-     * @return boolean hook value; true means continue processing, false means stop.
-     */
-    function onAutoload($cls)
-    {
-        $dir = dirname(__FILE__);
-
-        switch ($cls)
-        {
-        case 'ShowbookmarkAction':
-        case 'NewbookmarkAction':
-        case 'BookmarkpopupAction':
-        case 'NoticebyurlAction':
-        case 'BookmarkforurlAction':
-        case 'ImportdeliciousAction':
-            include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
-            return false;
-        case 'Bookmark':
-            include_once $dir.'/'.$cls.'.php';
-            return false;
-        case 'BookmarkForm':
-        case 'InitialBookmarkForm':
-        case 'DeliciousBackupImporter':
-        case 'DeliciousBookmarkImporter':
-            include_once $dir.'/'.strtolower($cls).'.php';
-            return false;
-        default:
-            return true;
-        }
-    }
 
     /**
      * Map URLs to actions
@@ -179,6 +145,26 @@ class BookmarkPlugin extends MicroAppPlugin
      */
     function onRouterInitialized($m)
     {
+        if (common_config('singleuser', 'enabled')) {
+            $nickname = User::singleUserNickname();
+            $m->connect('bookmarks',
+                        array('action' => 'bookmarks', 'nickname' => $nickname));
+            $m->connect('bookmarks/rss',
+                        array('action' => 'bookmarksrss', 'nickname' => $nickname));
+        } else {
+            $m->connect(':nickname/bookmarks',
+                        array('action' => 'bookmarks'),
+                        array('nickname' => Nickname::DISPLAY_FMT));
+            $m->connect(':nickname/bookmarks/rss',
+                        array('action' => 'bookmarksrss'),
+                        array('nickname' => Nickname::DISPLAY_FMT));
+        }
+
+        $m->connect('api/bookmarks/:id.:format',
+                    array('action' => 'ApiTimelineBookmarks',
+                          'id' => Nickname::INPUT_FMT,
+                          'format' => '(xml|json|rss|atom|as)'));
+
         $m->connect('main/bookmark/new',
                     array('action' => 'newbookmark'),
                     array('id' => '[0-9]+'));
@@ -229,11 +215,13 @@ class BookmarkPlugin extends MicroAppPlugin
     {
         $versions[] = array('name' => 'Bookmark',
                             'version' => self::VERSION,
-                            'author' => 'Evan Prodromou',
+                            'author' => 'Evan Prodromou, Stephane Berube, Jean Baptiste Favre',
                             'homepage' => 'http://status.net/wiki/Plugin:Bookmark',
                             'description' =>
                             // TRANS: Plugin description.
-                            _m('Simple extension for supporting bookmarks.'));
+                            _m('Simple extension for supporting bookmarks. ') .
+                            'BookmarkList feature has been developped by Stephane Berube. ' .
+                            'Integration has been done by Jean Baptiste Favre.');
         return true;
     }
 
@@ -291,18 +279,61 @@ class BookmarkPlugin extends MicroAppPlugin
 
     function onStartOpenNoticeListItemElement($nli)
     {
+       if (!$this->isMyNotice($nli->notice)) {
+               return true;
+       }
+       
         $nb = Bookmark::getByNotice($nli->notice);
-        if (!empty($nb)) {
-            $id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id;
-            $class = 'hentry notice bookmark';
-            if ($nli->notice->scope != 0 && $nli->notice->scope != 1) {
-                $class .= ' limited-scope';
-            }
-            $nli->out->elementStart('li', array('class' => $class,
-                                                 'id' => 'notice-' . $id));
-            Event::handle('EndOpenNoticeListItemElement', array($nli));
+        
+        if (empty($nb)) {
+               $this->log(LOG_INFO, "Notice {$nli->notice->id} has bookmark class but no matching Bookmark record.");
+               return true;
+        }
+               
+           $id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id;
+           $class = 'hentry notice bookmark';
+           if ($nli->notice->scope != 0 && $nli->notice->scope != 1) {
+               $class .= ' limited-scope';
+           }
+           $nli->out->elementStart('li', array('class' => $class,
+                                               'id' => 'notice-' . $id));
+                                               
+           Event::handle('EndOpenNoticeListItemElement', array($nli));
+           return false;
+    }
+
+    /**
+     * Modify the default menu to link to our custom action
+     *
+     * Using event handlers, it's possible to modify the default UI for pages
+     * almost without limit. In this method, we add a menu item to the default
+     * primary menu for the interface to link to our action.
+     *
+     * The Action class provides a rich set of events to hook, as well as output
+     * methods.
+     *
+     * @param Action $action The current action handler. Use this to
+     * do any output.
+     *
+     * @return boolean hook value; true means continue processing, false means stop.
+     *
+     * @see Action
+     */
+    function onEndPersonalGroupNav($action)
+    {
+        $this->user = common_current_user();
+
+        if (!$this->user) {
+            // TRANS: Client error displayed when trying to display bookmarks for a non-existing user.
+            $this->clientError(_('No such user.'));
             return false;
         }
+
+        $action->menuItem(common_local_url('bookmarks', array('nickname' => $this->user->nickname)),
+                          // TRANS: Menu item in sample plugin.
+                          _m('Bookmarks'),
+                          // TRANS: Menu item title in sample plugin.
+                          _m('A list of your bookmarks'), false, 'nav_timeline_bookmarks');
         return true;
     }
 
@@ -321,7 +352,7 @@ class BookmarkPlugin extends MicroAppPlugin
 
         $options = array('uri' => $bookmark->id,
                          'url' => $bookmark->link,
-                         'is_local' => Notice::REMOTE_OMB,
+                         'is_local' => Notice::REMOTE,
                          'source' => 'ostatus');
 
         return self::_postBookmark($author->localProfile(), $activity, $options);
@@ -354,12 +385,15 @@ class BookmarkPlugin extends MicroAppPlugin
      */
     function deleteRelated($notice)
     {
-        $nb = Bookmark::getByNotice($notice);
-
-        if (!empty($nb)) {
-            $nb->delete();
-        }
-
+       if ($this->isMyNotice($notice)) {
+               
+               $nb = Bookmark::getByNotice($notice);
+
+               if (!empty($nb)) {
+               $nb->delete();
+               }
+       }
+       
         return true;
     }
 
@@ -426,7 +460,7 @@ class BookmarkPlugin extends MicroAppPlugin
             if (!empty($other)) {
                 $options['replies'][] = $replyURI;
             } else {
-                $group = User_group::staticGet('uri', $replyURI);
+                $group = User_group::getKV('uri', $replyURI);
                 if (!empty($group)) {
                     $options['groups'][] = $replyURI;
                 }
@@ -437,7 +471,7 @@ class BookmarkPlugin extends MicroAppPlugin
         // @fixme what about conversation ID?
 
         if (!empty($activity->context->replyToID)) {
-            $orig = Notice::staticGet('uri',
+            $orig = Notice::getKV('uri',
                                       $activity->context->replyToID);
             if (!empty($orig)) {
                 $options['reply_to'] = $orig->id;
@@ -512,128 +546,16 @@ class BookmarkPlugin extends MicroAppPlugin
     }
 
     /**
-     * @fixme WARNING WARNING WARNING this opens a 'div' that is apparently closed by MicroAppPlugin
-     * @fixme that's probably wrong?
+     * Given a notice list item, returns an adapter specific
+     * to this plugin.
      *
-     * @param Notice $notice
-     * @param HTMLOutputter $out
+     * @param NoticeListItem $nli item to adapt
+     *
+     * @return NoticeListItemAdapter adapter or null
      */
-    function showNotice($notice, $out)
+    function adaptNoticeListItem($nli)
     {
-        $nb = Bookmark::getByNotice($notice);
-
-        $profile = $notice->getProfile();
-
-        $atts = $notice->attachments();
-
-        if (count($atts) < 1) {
-            // Something wrong; let default code deal with it.
-            // TRANS: Exception thrown when a bookmark has no attachments.
-            // TRANS: %1$s is a bookmark ID, %2$s is a notice ID (number).
-            throw new Exception(sprintf(_m('Bookmark %1$s (notice %2$d) has no attachments.'),
-                                        $nb->id,
-                                        $notice->id));
-        }
-
-        $att = $atts[0];
-
-        // 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());
-        }
-
-        // Replies look like "for:" tags
-
-        $replies = $notice->getReplies();
-        $tags = $notice->getTags();
-
-        if (!empty($replies) || !empty($tags)) {
-
-            $out->elementStart('ul', array('class' => 'bookmark-tags'));
-
-            foreach ($replies as $reply) {
-                $other = Profile::staticGet('id', $reply);
-                if (!empty($other)) {
-                    $out->elementStart('li');
-                    $out->element('a', array('rel' => 'tag',
-                                             'href' => $other->profileurl,
-                                             'title' => $other->getBestName()),
-                                  sprintf('for:%s', $other->nickname));
-                    $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');
-        }
-
-        if (!empty($nb->description)) {
-            $out->element('p',
-                          array('class' => 'bookmark-description'),
-                          $nb->description);
-        }
-
-        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('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->raw('&#160;'); // avoid &nbsp; for AJAX XML compatibility
-
-        $out->elementStart('span', 'vcard author'); // hack for belongsOnTimeline; JS needs to be able to find the author
-        $out->element('a',
-                      array('class' => 'url',
-                            'href' => $profile->profileurl,
-                            'title' => $profile->getBestName()),
-                      $profile->nickname);
-        $out->elementEnd('span');
+        return new BookmarkListItem($nli);
     }
 
     function entryForm($out)
@@ -651,4 +573,41 @@ class BookmarkPlugin extends MicroAppPlugin
         // TRANS: Application title.
         return _m('TITLE','Bookmark');
     }
+
+    function onEndUpgrade()
+    {
+        // Version 0.9.x of the plugin didn't stamp notices
+        // with verb and object-type (for obvious reasons). Update
+        // those notices here.
+
+        $notice = new Notice();
+        
+        $notice->whereAdd('exists (select uri from bookmark where bookmark.uri = notice.uri)');
+        $notice->whereAdd('((object_type is null) or (object_type = "' .ActivityObject::NOTE.'"))');
+
+        $notice->find();
+
+        while ($notice->fetch()) {
+            $original = clone($notice);
+            $notice->verb        = ActivityVerb::POST;
+            $notice->object_type = ActivityObject::BOOKMARK;
+            $notice->update($original);
+        }
+    }
+
+    public function activityObjectOutputJson(ActivityObject $obj, array &$out)
+    {
+        assert($obj->type == ActivityObject::BOOKMARK);
+
+        $bm = Bookmark::getKV('uri', $obj->id);
+
+        if (empty($bm)) {
+            throw new ServerException("Unknown bookmark: " . $obj->id);
+        }
+
+        $out['displayName'] = $bm->title;
+        $out['targetUrl']   = $bm->url;
+
+        return true;
+    }
 }