lib/taguri.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Utility for creating new tag: URIs
   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  URI
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2010 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Mint tag: URIs
  36  *
  37  * tag: URIs are unique identifiers according to http://tools.ietf.org/html/rfc4151.
  38  *
  39  * We use them for creating URIs for things that can't be HTTP retrieved.
  40  *
  41  * @category URI
  42  * @package  StatusNet
  43  * @author   Evan Prodromou <evan@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
  45  * @link     http://status.net/
  46  */
  47
  48 class TagURI
  49 {
  50     /**
  51      * Return the base part of a tag URI
  52      *
  53      * Note: use mint() instead.
  54      *
  55      * @return string Tag URI base to use
  56      */
  57
  58     static function base()
  59     {
  60         $base = common_config('integration', 'taguri');
  61
  62         if (empty($base)) {
  63
  64             $base = common_config('site', 'server').','.date('Y-m-d');
  65
  66             $pathPart = trim(common_config('site', 'path'), '/');
  67
  68             if (!empty($pathPart)) {
  69                 $base .= ':'.str_replace('/', ':', $pathPart);
  70             }
  71         }
  72
  73         return $base;
  74     }
  75
  76     /**
  77      * Make a new tag URI
  78      *
  79      * Builds the proper base and creates all the parts
  80      *
  81      * @return string minted URI
  82      */
  83
  84     static function mint()
  85     {
  86         $base = self::base();
  87
  88         $args = func_get_args();
  89
  90         $format = array_shift($args);
  91
  92         $extra = vsprintf($format, $args);
  93
  94         return 'tag:'.$base.':'.$extra;
  95     }
  96 }