plugins/AccountManager/AccountManagerPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Plugin to implement the Account Manager specification
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Plugin
  23  * @package   StatusNet
  24  * @author    Craig Andrews <candrews@integralblue.com>
  25  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 class AccountManagerPlugin extends Plugin
  35 {
  36     const PLUGIN_VERSION = '2.0.0';
  37
  38     const AM_REL = 'acct-mgmt';
  39
  40     function __construct()
  41     {
  42         parent::__construct();
  43     }
  44
  45     /**
  46      * Hook for RouterInitialized event.
  47      *
  48      * @param URLMapper $m path-to-action mapper
  49      * @return boolean hook return
  50      */
  51     public function onRouterInitialized(URLMapper $m)
  52     {
  53         // Discovery actions
  54         $m->connect('main/amcd.json',
  55                     array('action' => 'AccountManagementControlDocument'));
  56         $m->connect('main/amsessionstatus',
  57                     array('action' => 'AccountManagementSessionStatus'));
  58         return true;
  59     }
  60
  61     function onStartHostMetaLinks(&$links) {
  62         $links[] = new XML_XRD_Element_Link(AccountManagerPlugin::AM_REL,
  63                         common_local_url('AccountManagementControlDocument'));
  64     }
  65
  66     function onStartShowHTML($action)
  67     {
  68         //Account management discovery link
  69         header('Link: <'.common_local_url('AccountManagementControlDocument').'>; rel="'. AccountManagerPlugin::AM_REL.'"; type="application/json"');
  70
  71         //Account management login status
  72         $cur = common_current_user();
  73         if(empty($cur)) {
  74             header('X-Account-Management-Status: none');
  75         } else {
  76             //TODO it seems " should be escaped in the name and id, but the spec doesn't seem to indicate how to do that
  77             header('X-Account-Management-Status: active; name="' . $cur->nickname . '"; id="' . $cur->nickname . '"');
  78         }
  79     }
  80
  81     function onLoginAction($action, &$login) {
  82         switch ($action)
  83         {
  84          case 'AccountManagementControlDocument':
  85             $login = true;
  86             return false;
  87          default:
  88             return true;
  89         }
  90     }
  91
  92     function onPluginVersion(array &$versions)
  93     {
  94         $versions[] = array('name' => 'AccountManager',
  95                             'version' => self::PLUGIN_VERSION,
  96                             'author' => 'Craig Andrews',
  97                             'homepage' => 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/AccountManager',
  98                             'rawdescription' =>
  99                             // TRANS: Plugin description.
 100                             _m('The Account Manager plugin implements the Account Manager specification.'));
 101         return true;
 102     }
 103 }