* @link http://status.net/
*/
-if (!defined('STATUSNET')) {
- exit(1);
-}
+if (!defined('GNUSOCIAL')) { exit(1); }
/**
* Bookmark plugin main class
{
$schema = Schema::get();
- // For storing user-submitted flags on profiles
-
- $schema->ensureTable('bookmark',
- array(new ColumnDef('id',
- 'char',
- 36,
- false,
- 'PRI'),
- new ColumnDef('profile_id',
- 'integer',
- null,
- false,
- 'MUL'),
- new ColumnDef('url',
- 'varchar',
- 255,
- false,
- 'MUL'),
- new ColumnDef('title',
- 'varchar',
- 255),
- new ColumnDef('description',
- 'text'),
- new ColumnDef('uri',
- 'varchar',
- 255,
- false,
- 'UNI'),
- new ColumnDef('created',
- 'datetime',
- null,
- false,
- 'MUL')));
+ $schema->ensureTable('bookmark', Bookmark::schemaDef());
return true;
}
*/
function onEndShowStyles($action)
{
- $action->cssLink($this->path('bookmark.css'));
+ $action->cssLink($this->path('css/bookmark.css'));
return true;
}
$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
*
- * @param Net_URL_Mapper $m path-to-action mapper
+ * @param URLMapper $m path-to-action mapper
*
* @return boolean hook value; true means continue processing, false means stop.
*/
- function onRouterInitialized($m)
+ public function onRouterInitialized(URLMapper $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]+'));
*
* @return value
*/
- function onPluginVersion(&$versions)
+ function onPluginVersion(array &$versions)
{
$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;
}
}
/**
- * Output our CSS class for bookmark notice list elements
+ * Modify the default menu to link to our custom action
*
- * @param NoticeListItem $nli The item being shown
+ * 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.
*
- * @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;
- $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;
- }
- return true;
- }
-
- /**
- * Save a remote bookmark (from Salmon or PuSH)
- *
- * @param Ostatus_profile $author Author of the bookmark
- * @param Activity $activity Activity to save
+ * The Action class provides a rich set of events to hook, as well as output
+ * methods.
*
- * @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);
- }
-
- /**
- * Test if an activity represents posting a bookmark
+ * @param Action $action The current action handler. Use this to
+ * do any output.
*
- * @param Activity $activity Activity to test
+ * @return boolean hook value; true means continue processing, false means stop.
*
- * @return true if it's a Post of a Bookmark, else false
+ * @see Action
*/
- static private function _isPostBookmark($activity)
+ function onEndPersonalGroupNav(Menu $menu, Profile $target, Profile $scoped=null)
{
- return ($activity->verb == ActivityVerb::POST &&
- $activity->objects[0]->type == ActivityObject::BOOKMARK);
+ $menu->menuItem(common_local_url('bookmarks', array('nickname' => $target->getNickname())),
+ // 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;
}
function types()
*
* @return boolean hook value
*/
- function deleteRelated($notice)
+ function deleteRelated(Notice $notice)
{
- $nb = Bookmark::getByNotice($notice);
-
- if (!empty($nb)) {
- $nb->delete();
+ try {
+ $nb = Bookmark::fromStored($notice);
+ } catch (NoResultException $e) {
+ throw new AlreadyFulfilledException('Bookmark already gone when deleting: '.$e->getMessage());
}
-
+ $nb->delete();
+
return true;
}
* Save a bookmark from an activity
*
* @param Activity $activity Activity to save
- * @param Profile $profile Profile to use as author
+ * @param Profile $actor Profile to use as author
* @param array $options Options to pass to bookmark-saving code
*
* @return Notice resulting notice
*/
- function saveNoticeFromActivity($activity, $profile, $options=array())
+ protected function saveObjectFromActivity(Activity $activity, Notice $stored, array $options=array())
{
- $bookmark = $activity->objects[0];
+ $actobj = $activity->objects[0];
- $relLinkEls = ActivityUtils::getLinks($bookmark->element, 'related');
+ $relLinkEls = ActivityUtils::getLinks($actobj->element, 'related');
- if (count($relLinkEls) < 1) {
+ if (count($relLinkEls) !== 1) {
// TRANS: Client exception thrown when a bookmark is formatted incorrectly.
- throw new ClientException(_m('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.");
- }
-
- $linkEl = $relLinkEls[0];
-
- $url = $linkEl->getAttribute('href');
-
- $tags = array();
-
- foreach ($activity->categories as $category) {
- $tags[] = common_canonical_tag($category->term);
- }
-
- if (!empty($activity->time)) {
- $options['created'] = common_sql_date($activity->time);
- }
-
- // Fill in location if available
-
- $location = $activity->context->location;
-
- if ($location) {
- $options['lat'] = $location->lat;
- $options['lon'] = $location->lon;
- if ($location->location_id) {
- $options['location_ns'] = $location->location_ns;
- $options['location_id'] = $location->location_id;
- }
- }
-
- $replies = $activity->context->attention;
-
- $options['groups'] = array();
- $options['replies'] = array();
-
- foreach ($replies as $replyURI) {
- $other = Profile::fromURI($replyURI);
- if (!empty($other)) {
- $options['replies'][] = $replyURI;
- } else {
- $group = User_group::staticGet('uri', $replyURI);
- if (!empty($group)) {
- $options['groups'][] = $replyURI;
- }
- }
+ throw new ClientException(sprintf(_m('Expected exactly 1 link rel=related in a Bookmark, got %1$d.'), count($relLinkEls)));
}
- // Maintain direct reply associations
- // @fixme what about conversation ID?
-
- if (!empty($activity->context->replyToID)) {
- $orig = Notice::staticGet('uri',
- $activity->context->replyToID);
- if (!empty($orig)) {
- $options['reply_to'] = $orig->id;
- }
- }
-
- return Bookmark::saveNew($profile,
- $bookmark->title,
- $url,
- $tags,
- $bookmark->summary,
- $options);
+ return Bookmark::addNew($stored,
+ $actobj->title,
+ $relLinkEls[0]->getAttribute('href'),
+ $actobj->summary);
}
- function activityObjectFromNotice($notice)
+ function activityObjectFromNotice(Notice $notice)
{
assert($this->isMyNotice($notice));
"Formatting notice {$notice->uri} as a bookmark.");
$object = new ActivityObject();
- $nb = Bookmark::getByNotice($notice);
+ $nb = Bookmark::fromStored($notice);
$object->id = $notice->uri;
$object->type = ActivityObject::BOOKMARK;
- $object->title = $nb->title;
- $object->summary = $nb->description;
- $object->link = $notice->bestUrl();
+ $object->title = $nb->getTitle();
+ $object->summary = $nb->getDescription();
+ $object->link = $notice->getUrl();
// Attributes of the URL
$target = $attachments[0];
$attrs = array('rel' => 'related',
- 'href' => $target->url);
+ 'href' => $target->getUrl());
if (!empty($target->title)) {
$attrs['title'] = $target->title;
// Attributes of the thumbnail, if any
- $thumbnail = $target->getThumbnail();
-
- if (!empty($thumbnail)) {
+ try {
+ $thumbnail = $target->getThumbnail();
$tattrs = array('rel' => 'preview',
- 'href' => $thumbnail->url);
+ 'href' => $thumbnail->getUrl());
if (!empty($thumbnail->width)) {
$tattrs['media:width'] = $thumbnail->width;
$tattrs['media:height'] = $thumbnail->height;
}
- $object->extra[] = array('link', $attrs, null);
+ $object->extra[] = array('link', $tattrs, null);
+ } catch (UnsupportedMediaException $e) {
+ // No image thumbnail metadata available
}
return $object;
}
- /**
- * @fixme WARNING WARNING WARNING this opens a 'div' that is apparently closed by MicroAppPlugin
- * @fixme that's probably wrong?
- *
- * @param Notice $notice
- * @param HTMLOutputter $out
- */
- function showNotice($notice, $out)
+ function entryForm($out)
{
- $nb = Bookmark::getByNotice($notice);
+ return new InitialBookmarkForm($out);
+ }
- $profile = $notice->getProfile();
+ function tag()
+ {
+ return 'bookmark';
+ }
+
+ function appTitle()
+ {
+ // 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::getByPK(array('uri' => $obj->id));
+
+ $out['displayName'] = $bm->getTitle();
+ $out['targetUrl'] = $bm->getUrl();
+
+ return true;
+ }
- $atts = $notice->attachments();
+ protected function showNoticeItemNotice(NoticeListItem $nli)
+ {
+ $nli->out->elementStart('div', 'entry-title');
+ $nli->showAuthor();
+ $nli->showContent();
+ $nli->out->elementEnd('div');
+ }
+
+ public function getDescription()
+ {
+ return $this->description;
+ }
- 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));
+ public function getTitle()
+ {
+ return $this->title;
+ }
+
+ public function getUrl()
+ {
+ if (empty($this->url)) {
+ throw new InvalidUrlException($this->url);
}
+ return $this->url;
+ }
+
+ protected function showNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
+ {
+ $nb = Bookmark::fromStored($stored);
- $att = $atts[0];
+ $profile = $stored->getProfile();
- // XXX: only show the bookmark URL for non-single-page stuff
+ // Whether to nofollow
+ $attrs = array('href' => $nb->getUrl(), 'class' => 'bookmark-title');
- if ($out instanceof ShowbookmarkAction) {
+ $nf = common_config('nofollow', 'external');
+
+ if ($nf == 'never' || ($nf == 'sometimes' and $out instanceof ShowstreamAction)) {
+ $attrs['rel'] = 'external';
} 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());
+ $attrs['rel'] = 'nofollow external';
}
+ $out->elementStart('h3');
+ $out->element('a', $attrs, $nb->title);
+ $out->elementEnd('h3');
+
// Replies look like "for:" tags
+ $replies = $stored->getReplies();
+ $tags = $stored->getTags();
- $replies = $notice->getReplies();
- $tags = $notice->getTags();
+ if (!empty($nb->description)) {
+ $out->element('p',
+ array('class' => 'bookmark-description'),
+ $nb->description);
+ }
if (!empty($replies) || !empty($tags)) {
$out->elementStart('ul', array('class' => 'bookmark-tags'));
foreach ($replies as $reply) {
- $other = Profile::staticGet('id', $reply);
+ $other = Profile::getKV('id', $reply);
if (!empty($other)) {
$out->elementStart('li');
$out->element('a', array('rel' => 'tag',
}
foreach ($tags as $tag) {
- $out->elementStart('li');
- $out->element('a',
- array('rel' => 'tag',
- 'href' => Notice_tag::url($tag)),
- $tag);
- $out->elementEnd('li');
- $out->text(' ');
+ $tag = trim($tag);
+ if (!empty($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(' '); // avoid 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');
- }
-
- function entryForm($out)
- {
- return new InitialBookmarkForm($out);
- }
-
- function tag()
- {
- return 'bookmark';
- }
-
- function appTitle()
- {
- // TRANS: Application title.
- return _m('TITLE','Bookmark');
}
}
projects / quix0rs-gnu-social.git / blobdiff