forked from GNUsocial/gnu-social
lib/plugin.php now has a parent onAutoload function that finds most common files that are used in plugins (actions, dataobjects, forms, libs etc.) if they are put in the standardised directories ('actions', 'classes', 'forms', 'lib' and perhaps some others in the future).
199 lines
6.2 KiB
PHP
199 lines
6.2 KiB
PHP
<?php
|
|
/**
|
|
* StatusNet - the distributed open-source microblogging tool
|
|
* Copyright (C) 2011, StatusNet, Inc.
|
|
*
|
|
* A plugin to enable local tab subscription
|
|
*
|
|
* 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 TagSubPlugin
|
|
* @package StatusNet
|
|
* @author Brion Vibber <brion@status.net>
|
|
* @copyright 2011 StatusNet, Inc.
|
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
|
|
* @link http://status.net/
|
|
*/
|
|
|
|
if (!defined('STATUSNET')) {
|
|
exit(1);
|
|
}
|
|
|
|
/**
|
|
* TagSub plugin main class
|
|
*
|
|
* @category TagSubPlugin
|
|
* @package StatusNet
|
|
* @author Brion Vibber <brionv@status.net>
|
|
* @copyright 2011 StatusNet, Inc.
|
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
|
|
* @link http://status.net/
|
|
*/
|
|
class TagSubPlugin extends Plugin
|
|
{
|
|
const VERSION = '0.1';
|
|
|
|
/**
|
|
* Database schema setup
|
|
*
|
|
* @see Schema
|
|
*
|
|
* @return boolean hook value; true means continue processing, false means stop.
|
|
*/
|
|
function onCheckSchema()
|
|
{
|
|
$schema = Schema::get();
|
|
$schema->ensureTable('tagsub', TagSub::schemaDef());
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Map URLs to actions
|
|
*
|
|
* @param Net_URL_Mapper $m path-to-action mapper
|
|
*
|
|
* @return boolean hook value; true means continue processing, false means stop.
|
|
*/
|
|
function onRouterInitialized($m)
|
|
{
|
|
$m->connect('tag/:tag/subscribe',
|
|
array('action' => 'tagsub'),
|
|
array('tag' => Router::REGEX_TAG));
|
|
$m->connect('tag/:tag/unsubscribe',
|
|
array('action' => 'tagunsub'),
|
|
array('tag' => Router::REGEX_TAG));
|
|
|
|
$m->connect(':nickname/tag-subscriptions',
|
|
array('action' => 'tagsubs'),
|
|
array('nickname' => Nickname::DISPLAY_FMT));
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Plugin version data
|
|
*
|
|
* @param array &$versions array of version data
|
|
*
|
|
* @return value
|
|
*/
|
|
function onPluginVersion(&$versions)
|
|
{
|
|
$versions[] = array('name' => 'TagSub',
|
|
'version' => self::VERSION,
|
|
'author' => 'Brion Vibber',
|
|
'homepage' => 'http://status.net/wiki/Plugin:TagSub',
|
|
'rawdescription' =>
|
|
// TRANS: Plugin description.
|
|
_m('Plugin to allow following all messages with a given tag.'));
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Hook inbox delivery setup so tag subscribers receive all
|
|
* notices with that tag in their inbox.
|
|
*
|
|
* Currently makes no distinction between local messages and
|
|
* remote ones which happen to come in to the system. Remote
|
|
* notices that don't come in at all won't ever reach this.
|
|
*
|
|
* @param Notice $notice
|
|
* @param array $ni in/out map of profile IDs to inbox constants
|
|
* @return boolean hook result
|
|
*/
|
|
function onStartNoticeWhoGets(Notice $notice, array &$ni)
|
|
{
|
|
foreach ($notice->getTags() as $tag) {
|
|
$tagsub = new TagSub();
|
|
$tagsub->tag = $tag;
|
|
$tagsub->find();
|
|
|
|
while ($tagsub->fetch()) {
|
|
// These constants are currently not actually used, iirc
|
|
$ni[$tagsub->profile_id] = NOTICE_INBOX_SOURCE_SUB;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param TagAction $action
|
|
* @return boolean hook result
|
|
*/
|
|
function onStartTagShowContent(TagAction $action)
|
|
{
|
|
$user = common_current_user();
|
|
if ($user) {
|
|
$tag = $action->trimmed('tag');
|
|
$tagsub = TagSub::pkeyGet(array('tag' => $tag,
|
|
'profile_id' => $user->id));
|
|
if ($tagsub) {
|
|
$form = new TagUnsubForm($action, $tag);
|
|
} else {
|
|
$form = new TagSubForm($action, $tag);
|
|
}
|
|
$action->elementStart('div', 'entity_actions');
|
|
$action->elementStart('ul');
|
|
$action->elementStart('li', 'entity_subscribe');
|
|
$form->show();
|
|
$action->elementEnd('li');
|
|
$action->elementEnd('ul');
|
|
$action->elementEnd('div');
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Menu item for personal subscriptions/groups area
|
|
*
|
|
* @param Widget $widget Widget being executed
|
|
*
|
|
* @return boolean hook return
|
|
*/
|
|
function onEndSubGroupNav($widget)
|
|
{
|
|
$action = $widget->out;
|
|
$action_name = $action->trimmed('action');
|
|
|
|
$action->menuItem(common_local_url('tagsubs', array('nickname' => $action->user->nickname)),
|
|
// TRANS: SubMirror plugin menu item on user settings page.
|
|
_m('MENU', 'Tags'),
|
|
// TRANS: SubMirror plugin tooltip for user settings menu item.
|
|
_m('Configure tag subscriptions'),
|
|
$action_name == 'tagsubs' && $action->arg('nickname') == $action->user->nickname);
|
|
|
|
return true;
|
|
}
|
|
|
|
function onEndDefaultLocalNav($menu, $user)
|
|
{
|
|
$user = common_current_user();
|
|
|
|
if (!empty($user)) {
|
|
|
|
$tags = TagSub::forProfile($user->getProfile());
|
|
|
|
if (!empty($tags) && count($tags) > 0) {
|
|
$tagSubMenu = new TagSubMenu($menu->out, $user, $tags);
|
|
// TRANS: Menu item text for tags submenu.
|
|
$menu->submenu(_m('Tags'), $tagSubMenu);
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
}
|