lib/microid.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Microid class
   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  ID
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2008 StatusNet, Inc.
  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 /**
  35  * A class for microids
  36  *
  37  * @category ID
  38  * @package  StatusNet
  39  * @author   Evan Prodromou <evan@status.net>
  40  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  41  * @link     http://status.net/
  42  * @see      http://microid.org/
  43  */
  44
  45 class Microid
  46 {
  47     /** Agent part of the ID. */
  48
  49     var $agent = null;
  50
  51     /** Resource part of the ID. */
  52
  53     var $resource = null;
  54
  55     /**
  56      * Constructor
  57      *
  58      * @param string $agent    Agent of the ID
  59      * @param string $resource Resource part
  60      */
  61
  62     function __construct($agent, $resource)
  63     {
  64         $this->agent    = $agent;
  65         $this->resource = $resource;
  66
  67     }
  68
  69     /**
  70      * Generate a MicroID string
  71      *
  72      * @return string MicroID for agent and resource
  73      */
  74
  75     function toString()
  76     {
  77         $agent_proto    = $this->_getProto($this->agent);
  78         $resource_proto = $this->_getProto($this->resource);
  79
  80         return $agent_proto.'+'.$resource_proto.':sha1:'.
  81           sha1(sha1($this->agent).sha1($this->resource));
  82     }
  83
  84     /**
  85      * Utility for getting the protocol part of a URI
  86      *
  87      * @param string $uri URI to parse
  88      *
  89      * @return string scheme part of the URI
  90      */
  91
  92     function _getProto($uri)
  93     {
  94         $colon = strpos($uri, ':');
  95         return substr($uri, 0, $colon);
  96     }
  97 }