plugins/Directory/DirectoryPlugin.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Adds a user directory
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Plugin
  24  * @package   StatusNet
  25  * @author    Zach Copely <zach@status.net>
  26  * @copyright 2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     exit(1);
  33 }
  34
  35 /**
  36  * Directory plugin main class
  37  *
  38  * @category  Plugin
  39  * @package   StatusNet
  40  * @author    Zach Copley <zach@status.net>
  41  * @copyright 2011 StatusNet, Inc.
  42  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  43  * @link      http://status.net/
  44  */
  45 class DirectoryPlugin extends Plugin
  46 {
  47     private $dir = null;
  48
  49     /**
  50      * Initializer for this plugin
  51      *
  52      * @return boolean hook value; true means continue processing,
  53      *         false means stop.
  54      */
  55     function initialize()
  56     {
  57         return true;
  58     }
  59
  60     /**
  61      * Cleanup for this plugin.
  62      *
  63      * @return boolean hook value; true means continue processing,
  64      *         false means stop.
  65      */
  66     function cleanup()
  67     {
  68         return true;
  69     }
  70
  71     /**
  72      * Map URLs to actions
  73      *
  74      * @param URLMapper $m path-to-action mapper
  75      *
  76      * @return boolean hook value; true means continue processing,
  77      *         false means stop.
  78      */
  79     public function onRouterInitialized(URLMapper $m)
  80     {
  81
  82         $m->connect(
  83             'directory/users/:filter/sort_by/:sort/reverse/:reverse',
  84             array('action' => 'userdirectory'),
  85             array('filter' => '[0-9a-zA-Z]|(0-9)'),
  86             array('sort' => '[a-z]+'),
  87             array('reverse' => '[0-9]')
  88         );
  89
  90         $m->connect(
  91             'directory/users/:filter/sort_by/:sort',
  92             array('action' => 'userdirectory'),
  93             array('filter' => '[0-9a-zA-Z]|(0-9)'),
  94             array('sort' => '[a-z]+')
  95         );
  96
  97
  98         $m->connect(
  99             'directory/users/:filter',
 100             array('action' => 'userdirectory'),
 101             array('filter' => '[0-9a-zA-Z]|(0-9)')
 102         );
 103
 104         $m->connect(
 105             'directory/users/sort_by/:sort/reverse/:reverse',
 106             array('action' => 'userdirectory'),
 107             array('sort' => '[a-z]+'),
 108             array('reverse' => '[0-9]')
 109         );
 110
 111         $m->connect(
 112             'directory/users/sort_by/:sort',
 113             array('action' => 'userdirectory'),
 114             array('sort' => '[a-z]+')
 115         );
 116
 117         $m->connect(
 118             'directory/users',
 119             array('action' => 'userdirectory')
 120         );
 121
 122         $m->connect(
 123             'groups/:filter',
 124             array('action' => 'groupdirectory'),
 125             array('filter' => '[0-9a-zA-Z]|(0-9)')
 126         );
 127
 128         $m->connect(
 129             'groups',
 130             array('action' => 'groupdirectory')
 131         );
 132
 133         $m->connect(
 134             'groups/all',
 135             array('action' => 'groupdirectory')
 136         );
 137
 138
 139         return true;
 140     }
 141
 142     /**
 143      * Hijack the routing (URL -> Action) for the normal directory page
 144      * and substitute our group directory action
 145      *
 146      * @param string $path     path to connect
 147      * @param array  $defaults path defaults
 148      * @param array  $rules    path rules
 149      * @param array  $result   unused
 150      *
 151      * @return boolean hook return
 152      */
 153     function onStartConnectPath(&$path, &$defaults, &$rules, &$result)
 154     {
 155         if (in_array($path, array('group', 'group/', 'groups', 'groups/'))) {
 156             $defaults['action'] = 'groupdirectory';
 157             return true;
 158         }
 159         return true;
 160     }
 161
 162     // The following three function are to replace the existing groups
 163     // list page with the directory plugin's group directory page
 164
 165     /**
 166      * Hijack the mapping (Action -> URL) and return the URL to our
 167      * group directory page instead of the normal groups page
 168      *
 169      * @param Action    $action     action to find a path for
 170      * @param array     $params     parameters to pass to the action
 171      * @param string    $fragment   any url fragement
 172      * @param boolean   $addSession whether to add session variable
 173      * @param string    $url        resulting URL to local resource
 174      *
 175      * @return string the local URL
 176      */
 177     function onEndLocalURL(&$action, &$params, &$fragment, &$addSession, &$url) {
 178         if (in_array($action, array('group', 'group/', 'groups', 'groups/'))) {
 179                 $url = common_local_url('groupdirectory');
 180         }
 181         return true;
 182     }
 183
 184     /**
 185      * Link in a styelsheet for the onboarding actions
 186      *
 187      * @param Action $action Action being shown
 188      *
 189      * @return boolean hook flag
 190      */
 191     public function onEndShowStylesheets(Action $action)
 192     {
 193         if (in_array(
 194             $action->trimmed('action'),
 195             array('userdirectory', 'groupdirectory'))
 196         ) {
 197             $action->cssLink($this->path('css/directory.css'));
 198         }
 199
 200         return true;
 201     }
 202
 203     /**
 204      * Fool the public nav into thinking it's on the regular
 205      * group page when it's actually on our injected group
 206      * directory page. This way "Groups" gets hilighted when
 207      * when we're on the groups directory page.
 208      *
 209      * @param type $action the current action
 210      *
 211      * @return boolean hook flag
 212      */
 213     function onStartPublicGroupNav($action)
 214     {
 215         if ($action->trimmed('action') == 'groupdirectory') {
 216             $action->actionName = 'groups';
 217         }
 218         return true;
 219     }
 220
 221     /**
 222      * Modify the public local nav to add a link to the user directory
 223      *
 224      * @param Action $action The current action handler. Use this to
 225      *                       do any output.
 226      *
 227      * @return boolean hook value; true means continue processing,
 228      *         false means stop.
 229      *
 230      * @see Action
 231      */
 232     function onEndPublicGroupNav($nav)
 233     {
 234         // XXX: Maybe this should go under search instead?
 235
 236         $actionName = $nav->action->trimmed('action');
 237
 238         $nav->out->menuItem(
 239             common_local_url('userdirectory'),
 240             // TRANS: Menu item text for user directory.
 241             _m('MENU','People'),
 242             // TRANS: Menu item title for user directory.
 243             _m('People.'),
 244             $actionName == 'userdirectory',
 245             'nav_directory'
 246         );
 247
 248         return true;
 249     }
 250
 251     /*
 252      * Version info
 253      */
 254     function onPluginVersion(array &$versions)
 255     {
 256         $versions[] = array(
 257             'name' => 'Directory',
 258             'version' => GNUSOCIAL_VERSION,
 259             'author' => 'Zach Copley',
 260             'homepage' => 'http://status.net/wiki/Plugin:Directory',
 261             // TRANS: Plugin description.
 262             'rawdescription' => _m('Add a user directory.')
 263         );
 264
 265         return true;
 266     }
 267 }