* @link http://status.net/
*/
-class BookmarkPlugin extends Plugin
+class BookmarkPlugin extends MicroAppPlugin
{
- 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
// 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),
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;
- }
-
- /**
- * When a notice is deleted, delete the related Bookmark
- *
- * @param Notice $notice Notice being deleted
- *
- * @return boolean hook value
- */
-
- function onNoticeDeleteRelated($notice)
- {
- $nb = Bookmark::getByNotice($notice);
-
- if (!empty($nb)) {
- $nb->delete();
- }
-
return true;
}
function onEndShowStyles($action)
{
- $action->cssLink('plugins/Bookmark/bookmark.css');
+ $action->cssLink($this->path('bookmark.css'));
return true;
}
case 'ShowbookmarkAction':
case 'NewbookmarkAction':
case 'BookmarkpopupAction':
+ case 'NoticebyurlAction':
+ case 'ImportdeliciousAction':
include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
return false;
case 'Bookmark':
array('action' => 'newbookmark'),
array('id' => '[0-9]+'));
- $m->connect('main/bookmark/popup', array('action' => 'bookmarkpopup'));
-
- $m->connect('bookmark/:user/:created/:crc32',
- array('action' => 'showbookmark'),
- array('user' => '[0-9]+',
- 'created' => '[0-9]{14}',
- 'crc32' => '[0-9a-f]{8}'));
-
- return true;
- }
-
- /**
- * Output the HTML for a bookmark in a list
- *
- * @param NoticeListItem $nli The list item being shown.
- *
- * @return boolean hook value
- */
-
- function onStartShowNoticeItem($nli)
- {
- $nb = Bookmark::getByNotice($nli->notice);
-
- if (!empty($nb)) {
-
- $out = $nli->out;
- $notice = $nli->notice;
- $profile = $nli->profile;
-
- $atts = $notice->attachments();
-
- if (count($atts) < 1) {
- // Something wrong; let default code deal with it.
- return true;
- }
+ $m->connect('main/bookmark/popup',
+ array('action' => 'bookmarkpopup'));
- $att = $atts[0];
+ $m->connect('main/bookmark/import',
+ array('action' => 'importdelicious'));
- // 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),
- $nb->title);
- $out->elementEnd('h3');
- }
-
- $out->elementStart('ul', array('class' => 'bookmark_tags'));
-
- // Replies look like "for:" tags
-
- $replies = $nli->notice->getReplies();
-
- if (!empty($replies)) {
- foreach ($replies as $reply) {
- $other = Profile::staticGet('id', $reply);
- $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(' ');
- }
- }
-
- $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(' ');
- }
-
- $out->elementEnd('ul');
-
- $out->element('p',
- array('class' => 'bookmark_description'),
- $nb->description);
-
- if (common_config('attachments', 'show_thumbs')) {
- $al = new InlineAttachmentList($notice, $out);
- $al->show();
- }
-
- $out->elementStart('p', array('style' => 'float: left'));
-
- $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(' ');
- $out->element('a', array('href' => $profile->profileurl,
- 'title' => $profile->getBestName()),
- $profile->nickname);
-
- $nli->showNoticeLink();
- $nli->showNoticeSource();
- $nli->showNoticeLocation();
- $nli->showContext();
- $nli->showRepeat();
-
- $out->elementEnd('p');
+ $m->connect('bookmark/:id',
+ array('action' => 'showbookmark'),
+ array('id' => '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'));
- $nli->showNoticeOptions();
+ $m->connect('notice/by-url/:id',
+ array('action' => 'noticebyurl'),
+ array('id' => '[0-9]+'));
- return false;
- }
return true;
}
- /**
- * Render a notice as a Bookmark object
- *
- * @param Notice $notice Notice to render
- * @param ActivityObject &$object Empty object to fill
- *
- * @return boolean hook value
- */
-
- function onStartActivityObjectFromNotice($notice, &$object)
- {
- common_log(LOG_INFO,
- "Checking {$notice->uri} to see if it's a bookmark.");
-
- $nb = Bookmark::getByNotice($notice);
-
- if (!empty($nb)) {
-
- common_log(LOG_INFO,
- "Formatting notice {$notice->uri} as a bookmark.");
-
- $object->id = $notice->uri;
- $object->type = ActivityObject::BOOKMARK;
- $object->title = $nb->title;
- $object->summary = $nb->description;
- $object->link = $notice->bestUrl();
-
- // Attributes of the URL
-
- $attachments = $notice->attachments();
-
- if (count($attachments) != 1) {
- throw new ServerException(_('Bookmark notice with the '.
- 'wrong number of attachments.'));
- }
-
- $target = $attachments[0];
-
- $attrs = array('rel' => 'related',
- 'href' => $target->url);
-
- if (!empty($target->title)) {
- $attrs['title'] = $target->title;
- }
-
- $object->extra[] = array('link', $attrs, null);
-
- // Attributes of the thumbnail, if any
-
- $thumbnail = $target->getThumbnail();
-
- if (!empty($thumbnail)) {
- $tattrs = array('rel' => 'preview',
- 'href' => $thumbnail->url);
-
- if (!empty($thumbnail->width)) {
- $tattrs['media:width'] = $thumbnail->width;
- }
-
- if (!empty($thumbnail->height)) {
- $tattrs['media:height'] = $thumbnail->height;
- }
-
- $object->extra[] = array('link', $attrs, null);
- }
-
- return false;
- }
-
- return true;
- }
/**
* Add our two queue handlers to the queue manager
return true;
}
+
+
/**
- * Handle a posted bookmark from PuSH
+ * Show a link to our delicious import page on profile settings form
*
- * @param Activity $activity activity to handle
- * @param Ostatus_profile $oprofile Profile for the feed
+ * @param Action $action Profile settings action being shown
*
* @return boolean hook value
*/
- function onStartHandleFeedEntryWithProfile($activity, $oprofile) {
-
- common_log(LOG_INFO, "BookmarkPlugin called for new feed entry.");
-
- if (self::_isPostBookmark($activity)) {
-
- common_log(LOG_INFO, "Importing activity {$activity->id} as a bookmark.");
-
- $author = $oprofile->checkAuthorship($activity);
-
- if (empty($author)) {
- throw new ClientException(_('Can\'t get author for activity.'));
- }
-
- self::_postRemoteBookmark($author,
- $activity);
-
- return false;
+ 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;
}
/**
- * Handle a posted bookmark from Salmon
+ * Output our CSS class for bookmark notice list elements
*
- * @param Activity $activity activity to handle
- * @param mixed $target user or group targeted
+ * @param NoticeListItem $nli The item being shown
*
* @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;
- }
-
- function onStartAtomPubNewActivity(&$activity, $user, &$notice)
+ function onStartOpenNoticeListItemElement($nli)
{
- if (self::_isPostBookmark($activity)) {
- $options = array('source' => 'atompub');
- $notice = self::_postBookmark($user->getProfile(), $activity, $options);
+ $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;
}
- static private function _postRemoteBookmark(Ostatus_profile $author, Activity $activity)
+ /**
+ * 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];
return self::_postBookmark($author->localProfile(), $activity, $options);
}
- static private function _postBookmark(Profile $profile, Activity $activity, $options=array())
+ /**
+ * 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);
+ }
+
+ function types()
+ {
+ return array(ActivityObject::BOOKMARK);
+ }
+
+ /**
+ * When a notice is deleted, delete the related Bookmark
+ *
+ * @param Notice $notice Notice being deleted
+ *
+ * @return boolean hook value
+ */
+
+ function deleteRelated($notice)
+ {
+ $nb = Bookmark::getByNotice($notice);
+
+ if (!empty($nb)) {
+ $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 array $options Options to pass to bookmark-saving code
+ *
+ * @return Notice resulting notice
+ */
+
+ function saveNoticeFromActivity($activity, $profile, $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];
$replies = $activity->context->attention;
- $options['groups'] = array();
+ $options['groups'] = array();
$options['replies'] = array();
foreach ($replies as $replyURI) {
$options);
}
- static private function _isPostBookmark($activity)
+ function activityObjectFromNotice($notice)
{
- return ($activity->verb == ActivityVerb::POST &&
- $activity->objects[0]->type == ActivityObject::BOOKMARK);
+ assert($this->isMyNotice($notice));
+
+ common_log(LOG_INFO,
+ "Formatting notice {$notice->uri} as a bookmark.");
+
+ $object = new ActivityObject();
+
+ $object->id = $notice->uri;
+ $object->type = ActivityObject::BOOKMARK;
+ $object->title = $nb->title;
+ $object->summary = $nb->description;
+ $object->link = $notice->bestUrl();
+
+ // Attributes of the URL
+
+ $attachments = $notice->attachments();
+
+ if (count($attachments) != 1) {
+ throw new ServerException(_('Bookmark notice with the '.
+ 'wrong number of attachments.'));
+ }
+
+ $target = $attachments[0];
+
+ $attrs = array('rel' => 'related',
+ 'href' => $target->url);
+
+ if (!empty($target->title)) {
+ $attrs['title'] = $target->title;
+ }
+
+ $object->extra[] = array('link', $attrs, null);
+
+ // Attributes of the thumbnail, if any
+
+ $thumbnail = $target->getThumbnail();
+
+ if (!empty($thumbnail)) {
+ $tattrs = array('rel' => 'preview',
+ 'href' => $thumbnail->url);
+
+ if (!empty($thumbnail->width)) {
+ $tattrs['media:width'] = $thumbnail->width;
+ }
+
+ if (!empty($thumbnail->height)) {
+ $tattrs['media:height'] = $thumbnail->height;
+ }
+
+ $object->extra[] = array('link', $attrs, null);
+ }
+
+ 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)
+ {
+ $nb = Bookmark::getByNotice($notice);
+
+ $profile = $notice->getProfile();
+
+ $atts = $notice->attachments();
+
+ if (count($atts) < 1) {
+ // Something wrong; let default code deal with it.
+ throw new Exception("That can't be right.");
+ }
+
+ $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);
+ $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(' '); // 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 BookmarkForm($out);
+ }
+
+ function tag()
+ {
+ return 'bookmark';
+ }
+
+ function appTitle()
+ {
+ return _m('Bookmark');
+ }
+}
projects / quix0rs-gnu-social.git / blobdiff