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      * Load related modules when needed
  73      *
  74      * @param string $cls Name of the class to be loaded
  75      *
  76      * @return boolean hook value; true means continue processing,
  77      *         false means stop.
  78      */
  79     function onAutoload($cls)
  80     {
  81         // common_debug("class = $cls");
  82
  83         $dir = dirname(__FILE__);
  84
  85         switch ($cls)
  86         {
  87         case 'UserdirectoryAction':
  88         case 'GroupdirectoryAction':
  89             include_once $dir
  90                 . '/actions/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
  91             return false;
  92         case 'AlphaNav':
  93             include_once $dir
  94                 . '/lib/' . strtolower($cls) . '.php';
  95             return false;
  96         case 'SortableSubscriptionList':
  97         case 'SortableGroupList':
  98             include_once $dir
  99                 . '/lib/' . strtolower($cls) . '.php';
 100             return false;
 101         default:
 102             return true;
 103         }
 104     }
 105
 106     /**
 107      * Map URLs to actions
 108      *
 109      * @param Net_URL_Mapper $m path-to-action mapper
 110      *
 111      * @return boolean hook value; true means continue processing,
 112      *         false means stop.
 113      */
 114     function onRouterInitialized($m)
 115     {
 116
 117         $m->connect(
 118             'directory/users',
 119             array('action' => 'userdirectory'),
 120             array('filter' => 'all')
 121         );
 122
 123         $m->connect(
 124             'directory/users/:filter',
 125             array('action' => 'userdirectory'),
 126             array('filter' => '([0-9a-zA-Z_]{1,64}|0-9)')
 127         );
 128
 129         $m->connect(
 130             'groups/:filter',
 131             array('action' => 'groupdirectory'),
 132             array('filter' => '([0-9a-zA-Z_]{1,64}|0-9)')
 133         );
 134
 135         return true;
 136     }
 137
 138     /**
 139      * Hijack the routing (URL -> Action) for the normal directory page
 140      * and substitute our group directory action
 141      *
 142      * @param string $path     path to connect
 143      * @param array  $defaults path defaults
 144      * @param array  $rules    path rules
 145      * @param array  $result   unused
 146      *
 147      * @return boolean hook return
 148      */
 149     function onStartConnectPath(&$path, &$defaults, &$rules, &$result)
 150     {
 151         if (in_array($path, array('group', 'group/', 'groups', 'groups/'))) {
 152             $defaults['action'] = 'groupdirectory';
 153             return true;
 154         }
 155         return true;
 156     }
 157
 158     // The following three function are to replace the existing groups
 159     // list page with the directory plugin's group directory page
 160
 161     /**
 162      * Hijack the mapping (Action -> URL) and return the URL to our
 163      * group directory page instead of the normal groups page
 164      *
 165      * @param Action    $action     action to find a path for
 166      * @param array     $params     parameters to pass to the action
 167      * @param string    $fragment   any url fragement
 168      * @param boolean   $addSession whether to add session variable
 169      * @param string    $url        resulting URL to local resource
 170      *
 171      * @return string the local URL
 172      */
 173     function onEndLocalURL(&$action, &$params, &$fragment, &$addSession, &$url) {
 174         if (in_array($action, array('group', 'group/', 'groups', 'groups/'))) {
 175                 $url = common_local_url('groupdirectory');
 176         }
 177         return true;
 178     }
 179
 180     /**
 181      * Link in a styelsheet for the onboarding actions
 182      *
 183      * @param Action $action Action being shown
 184      *
 185      * @return boolean hook flag
 186      */
 187     function onEndShowStatusNetStyles($action)
 188     {
 189         if (in_array(
 190             $action->trimmed('action'),
 191             array('userdirectory', 'groupdirectory'))
 192         ) {
 193             $action->cssLink($this->path('css/directory.css'));
 194         }
 195
 196         return true;
 197     }
 198
 199     /**
 200      * Fool the public nav into thinking it's on the regular
 201      * group page when it's actually on our injected group
 202      * directory page. This way "Groups" gets hilighted when
 203      * when we're on the groups directory page.
 204      *
 205      * @param type $action the current action
 206      *
 207      * @return boolean hook flag
 208      */
 209     function onStartPublicGroupNav($action)
 210     {
 211         if ($action->trimmed('action') == 'groupdirectory') {
 212             $action->actionName = 'groups';
 213         }
 214         return true;
 215     }
 216
 217     /**
 218      * Modify the public local nav to add a link to the user directory
 219      *
 220      * @param Action $action The current action handler. Use this to
 221      *                       do any output.
 222      *
 223      * @return boolean hook value; true means continue processing,
 224      *         false means stop.
 225      *
 226      * @see Action
 227      */
 228     function onEndPublicGroupNav($nav)
 229     {
 230         // XXX: Maybe this should go under search instead?
 231
 232         $actionName = $nav->action->trimmed('action');
 233
 234         $nav->out->menuItem(
 235             common_local_url('userdirectory'),
 236             // TRANS: Menu item text for user directory.
 237             _m('MENU','Directory'),
 238             // TRANS: Menu item title for user directory.
 239             _m('User Directory.'),
 240             $actionName == 'userdirectory',
 241             'nav_directory'
 242         );
 243
 244         return true;
 245     }
 246
 247     /*
 248      * Version info
 249      */
 250     function onPluginVersion(&$versions)
 251     {
 252         $versions[] = array(
 253             'name' => 'Directory',
 254             'version' => STATUSNET_VERSION,
 255             'author' => 'Zach Copley',
 256             'homepage' => 'http://status.net/wiki/Plugin:Directory',
 257             // TRANS: Plugin description.
 258             'rawdescription' => _m('Add a user directory.')
 259         );
 260
 261         return true;
 262     }
 263 }