123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203 |
- <?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 PLUGIN_VERSION = '0.1.1';
- /**
- * Database schema setup
- *
- * @return bool hook value; true means continue processing, false means stop.
- * @see Schema
- *
- */
- public function onCheckSchema()
- {
- $schema = Schema::get();
- $schema->ensureTable('tagsub', TagSub::schemaDef());
- 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)
- {
- $m->connect('tag/:tag/subscribe',
- ['action' => 'tagsub'],
- ['tag' => Router::REGEX_TAG]);
- $m->connect('tag/:tag/unsubscribe',
- ['action' => 'tagunsub'],
- ['tag' => Router::REGEX_TAG]);
- $m->connect(':nickname/tag-subscriptions',
- ['action' => 'tagsubs'],
- ['nickname' => Nickname::DISPLAY_FMT]);
- return true;
- }
- /**
- * Plugin version data
- *
- * @param array &$versions array of version data
- *
- * @return bool true hook value
- */
- public function onPluginVersion(array &$versions): bool
- {
- $versions[] = ['name' => 'TagSub',
- 'version' => self::PLUGIN_VERSION,
- 'author' => 'Brion Vibber',
- 'homepage' => GNUSOCIAL_ENGINE_REPO_URL . 'tree/master/plugins/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
- */
- public 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
- */
- public 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
- * @throws Exception
- */
- public 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;
- }
- public function onEndDefaultLocalNav($menu, $user)
- {
- $user = $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;
- }
- }
|