123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448 |
- <?php
- /**
- * StatusNet - the distributed open-source microblogging tool
- * Copyright (C) 2010, StatusNet, Inc.
- *
- * A plugin to enable social-bookmarking functionality
- *
- * PHP version 5
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
- * @category SocialBookmark
- * @package StatusNet
- * @author Evan Prodromou <evan@status.net>
- * @copyright 2010 StatusNet, Inc.
- * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
- * @link http://status.net/
- */
- if (!defined('GNUSOCIAL')) { exit(1); }
- /**
- * Bookmark plugin main class
- *
- * @category Bookmark
- * @package StatusNet
- * @author Brion Vibber <brionv@status.net>
- * @author Evan Prodromou <evan@status.net>
- * @copyright 2010 StatusNet, Inc.
- * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
- * @link http://status.net/
- */
- class BookmarkPlugin extends MicroAppPlugin
- {
- const PLUGIN_VERSION = '0.1.0';
- 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
- *
- * @see Schema
- * @see ColumnDef
- *
- * @return boolean hook value; true means continue processing, false means stop.
- */
- function onCheckSchema()
- {
- $schema = Schema::get();
- $schema->ensureTable('bookmark', Bookmark::schemaDef());
- return true;
- }
- /**
- * Show the CSS necessary for this plugin
- *
- * @param Action $action the action being run
- *
- * @return boolean hook value
- */
- function onEndShowStyles($action)
- {
- $action->cssLink($this->path('css/bookmark.css'));
- return true;
- }
- function onEndShowScripts($action)
- {
- $action->script($this->path('js/bookmark.js'));
- return true;
- }
- /**
- * Map URLs to actions
- *
- * @param URLMapper $m path-to-action mapper
- *
- * @return boolean hook value; true means continue processing, false means stop.
- */
- public function onRouterInitialized(URLMapper $m)
- {
- if (common_config('singleuser', 'enabled')) {
- $nickname = User::singleUserNickname();
- $m->connect('bookmarks',
- ['action' => 'bookmarks',
- 'nickname' => $nickname]);
- $m->connect('bookmarks/rss',
- ['action' => 'bookmarksrss',
- 'nickname' => $nickname]);
- } else {
- $m->connect(':nickname/bookmarks',
- ['action' => 'bookmarks'],
- ['nickname' => Nickname::DISPLAY_FMT]);
- $m->connect(':nickname/bookmarks/rss',
- ['action' => 'bookmarksrss'],
- ['nickname' => Nickname::DISPLAY_FMT]);
- }
- $m->connect('api/bookmarks/:id.:format',
- ['action' => 'ApiTimelineBookmarks'],
- ['id' => Nickname::INPUT_FMT,
- 'format' => '(xml|json|rss|atom|as)']);
- $m->connect('main/bookmark/new',
- ['action' => 'newbookmark']);
- $m->connect('main/bookmark/popup',
- ['action' => 'bookmarkpopup']);
- $m->connect('main/bookmark/import',
- ['action' => 'importdelicious']);
- $m->connect('main/bookmark/forurl',
- ['action' => 'bookmarkforurl']);
- $m->connect('bookmark/:id',
- ['action' => 'showbookmark'],
- ['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',
- ['action' => 'noticebyurl'],
- ['id' => '[0-9]+']);
- return true;
- }
- /**
- * Add our two queue handlers to the queue manager
- *
- * @param QueueManager $qm current queue manager
- *
- * @return boolean hook value
- */
- function onEndInitializeQueueManager($qm)
- {
- $qm->connect('dlcsback', 'DeliciousBackupImporter');
- $qm->connect('dlcsbkmk', 'DeliciousBookmarkImporter');
- return true;
- }
- /**
- * Plugin version data
- *
- * @param array &$versions array of version data
- *
- * @return value
- */
- public function onPluginVersion(array &$versions): bool
- {
- $versions[] = array('name' => 'Bookmark',
- 'version' => self::PLUGIN_VERSION,
- 'author' => 'Evan Prodromou, Stephane Berube, Jean Baptiste Favre, Mikael Nordfeldth',
- 'homepage' => GNUSOCIAL_ENGINE_URL,
- 'description' =>
- // TRANS: Plugin description.
- _m('Plugin for posting bookmarks. ') .
- 'BookmarkList feature has been developped by Stephane Berube. ' .
- 'Integration has been done by Jean Baptiste Favre.');
- return true;
- }
- /**
- * Load our document if requested
- *
- * @param string &$title Title to fetch
- * @param string &$output HTML to output
- *
- * @return boolean hook value
- */
- function onStartLoadDoc(&$title, &$output)
- {
- if ($title == 'bookmarklet') {
- $filename = INSTALLDIR.'/plugins/Bookmark/bookmarklet';
- $c = file_get_contents($filename);
- $output = common_markup_to_html($c);
- return false; // success!
- }
- 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')),
- // TRANS: Link text in proile leading to import form.
- _m('Import del.icio.us bookmarks'));
- $action->elementEnd('li');
- }
- return true;
- }
- /**
- * 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(Menu $menu, Profile $target, Profile $scoped=null)
- {
- $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 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 $notice)
- {
- 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 $actor Profile to use as author
- * @param array $options Options to pass to bookmark-saving code
- *
- * @return Notice resulting notice
- */
- protected function saveObjectFromActivity(Activity $activity, Notice $stored, array $options=array())
- {
- return Bookmark::saveActivityObject($activity->objects[0], $stored);
- }
- public function onEndNoticeAsActivity(Notice $stored, Activity $act, Profile $scoped=null)
- {
- if (!$this->isMyNotice($stored)) {
- return true;
- }
- $this->extendActivity($stored, $act, $scoped);
- return false;
- }
- public function extendActivity(Notice $stored, Activity $act, Profile $scoped=null)
- {
- /*$hashtags = array();
- $taglinks = array();
- foreach ($tags as $tag) {
- $hashtags[] = '#'.$tag;
- $attrs = array('href' => Notice_tag::url($tag),
- 'rel' => $tag,
- 'class' => 'tag');
- $taglinks[] = XMLStringer::estring('a', $attrs, $tag);
- }*/
- }
- function activityObjectFromNotice(Notice $notice)
- {
- return Bookmark::fromStored($notice)->asActivityObject();
- }
- function entryForm($out)
- {
- return new InitialBookmarkForm($out);
- }
- function tag()
- {
- return 'bookmark';
- }
- function appTitle()
- {
- // TRANS: Application title.
- return _m('TITLE','Bookmark');
- }
- function onEndUpgrade()
- {
- printfnq('Making sure Bookmark notices have correct verb and object_type...');
- // 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->joinAdd(array('uri', 'bookmark:uri'));
- $notice->whereAdd('object_type IS NULL OR object_type = '.$notice->_quote(ActivityObject::NOTE));
- $notice->find();
- while ($notice->fetch()) {
- $original = clone($notice);
- $notice->verb = ActivityVerb::POST;
- $notice->object_type = ActivityObject::BOOKMARK;
- $notice->update($original);
- }
- printfnq("DONE.\n");
- }
- 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;
- }
- protected function showNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
- {
- $nb = Bookmark::fromStored($stored);
- // Whether to nofollow
- $attrs = array('href' => $nb->getUrl(), 'class' => 'bookmark-title');
- $nf = common_config('nofollow', 'external');
- if ($nf == 'never' || ($nf == 'sometimes' and $out instanceof ShowstreamAction)) {
- $attrs['rel'] = 'external';
- } else {
- $attrs['rel'] = 'nofollow external';
- }
- $out->elementStart('h3');
- $out->element('a', $attrs, $nb->getTitle());
- $out->elementEnd('h3');
- // Replies look like "for:" tags
- $replies = $stored->getReplies();
- $tags = $stored->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::getByPK($reply);
- $out->elementStart('li');
- $out->element('a', array('rel' => 'tag',
- 'href' => $other->getUrl(),
- 'title' => $other->getBestName()),
- sprintf('for:%s', $other->getNickname()));
- $out->elementEnd('li');
- $out->text(' ');
- }
- foreach ($tags as $tag) {
- $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');
- }
- }
- }
|