gnu-social/plugins/Bookmark/BookmarkPlugin.php

448 lines
14 KiB
PHP
Raw Permalink Normal View History

<?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';
2010-12-29 22:16:15 +00:00
/**
* 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;
}
2010-12-21 15:13:20 +00:00
/**
* 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());
2010-12-21 15:13:20 +00:00
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'));
2010-12-21 15:13:20 +00:00
return true;
}
function onEndShowScripts($action)
{
$action->script($this->path('js/bookmark.js'));
return true;
}
2010-12-21 15:13:20 +00:00
/**
* Map URLs to actions
*
* @param URLMapper $m path-to-action mapper
2010-12-21 15:13:20 +00:00
*
* @return boolean hook value; true means continue processing, false means stop.
*/
public function onRouterInitialized(URLMapper $m)
2010-12-21 15:13:20 +00:00
{
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)']);
2010-12-21 15:13:20 +00:00
$m->connect('main/bookmark/new',
['action' => 'newbookmark']);
2010-12-21 15:13:20 +00:00
$m->connect('main/bookmark/popup',
['action' => 'bookmarkpopup']);
$m->connect('main/bookmark/import',
['action' => 'importdelicious']);
2011-04-15 04:44:01 +01:00
$m->connect('main/bookmark/forurl',
['action' => 'bookmarkforurl']);
2011-04-15 04:44:01 +01:00
$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]+']);
2010-12-21 15:13:20 +00:00
return true;
}
2010-12-21 19:46:31 +00:00
/**
* Add our two queue handlers to the queue manager
*
* @param QueueManager $qm current queue manager
*
2010-12-21 19:46:31 +00:00
* @return boolean hook value
*/
function onEndInitializeQueueManager($qm)
{
$qm->connect('dlcsback', 'DeliciousBackupImporter');
$qm->connect('dlcsbkmk', 'DeliciousBookmarkImporter');
return true;
}
2010-12-21 15:13:20 +00:00
/**
* Plugin version data
*
* @param array &$versions array of version data
*
2010-12-21 15:13:20 +00:00
* @return value
*/
public function onPluginVersion(array &$versions): bool
2010-12-21 15:13:20 +00:00
{
2011-04-13 20:26:47 +01:00
$versions[] = array('name' => 'Bookmark',
'version' => self::PLUGIN_VERSION,
2015-10-12 08:47:30 +01:00
'author' => 'Evan Prodromou, Stephane Berube, Jean Baptiste Favre, Mikael Nordfeldth',
'homepage' => GNUSOCIAL_ENGINE_URL,
2011-04-13 20:26:47 +01:00
'description' =>
// TRANS: Plugin description.
2015-10-12 08:47:30 +01:00
_m('Plugin for posting bookmarks. ') .
'BookmarkList feature has been developped by Stephane Berube. ' .
'Integration has been done by Jean Baptiste Favre.');
2010-12-21 15:13:20 +00:00
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;
}
2010-12-23 17:42:42 +00:00
2010-12-29 22:16:15 +00:00
/**
* 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;
}
2010-12-29 22:16:15 +00:00
/**
* Save a bookmark from an activity
*
* @param Activity $activity Activity to save
* @param Profile $actor Profile to use as author
2010-12-29 22:16:15 +00:00
* @param array $options Options to pass to bookmark-saving code
*
* @return Notice resulting notice
*/
protected function saveObjectFromActivity(Activity $activity, Notice $stored, array $options=array())
2010-12-28 06:09:29 +00:00
{
return Bookmark::saveActivityObject($activity->objects[0], $stored);
2010-12-23 17:42:42 +00:00
}
2010-12-28 06:09:29 +00:00
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)
{
2011-04-15 04:44:01 +01:00
return new InitialBookmarkForm($out);
}
function tag()
{
return 'bookmark';
}
function appTitle()
{
// TRANS: Application title.
return _m('TITLE','Bookmark');
}
2011-09-15 22:06:05 +01:00
function onEndUpgrade()
{
2016-03-29 11:13:23 +01:00
printfnq('Making sure Bookmark notices have correct verb and object_type...');
2011-09-15 22:06:05 +01:00
// 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'));
2016-03-29 11:55:50 +01:00
$notice->whereAdd('object_type IS NULL OR object_type = '.$notice->_quote(ActivityObject::NOTE));
2011-09-15 22:06:05 +01:00
$notice->find();
while ($notice->fetch()) {
$original = clone($notice);
$notice->verb = ActivityVerb::POST;
$notice->object_type = ActivityObject::BOOKMARK;
$notice->update($original);
}
2016-03-29 11:13:23 +01:00
printfnq("DONE.\n");
2011-09-15 22:06:05 +01:00
}
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');
2015-10-12 17:28:32 +01:00
$out->element('a', $attrs, $nb->getTitle());
$out->elementEnd('h3');
// Replies look like "for:" tags
$replies = $stored->getReplies();
$tags = $stored->getTags();
2015-01-16 22:28:07 +00:00
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) {
2015-10-12 17:28:32 +01:00
$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');
}
}
}