lib/uuid.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * UUID generation
   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  UUID
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2010 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     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * UUID generation
  39  *
  40  * @category  General
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2010 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47
  48 class UUID
  49 {
  50     const REGEX = '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}';
  51     protected $str = null;
  52
  53     /**
  54      * Constructor for a UUID
  55      *
  56      * Uses gen() to create a new UUID
  57      */
  58
  59     function __construct()
  60     {
  61         $this->str = self::gen();
  62     }
  63
  64     /**
  65      * For serializing to a string
  66      *
  67      * @return string version of self
  68      */
  69
  70     function __toString()
  71     {
  72         return $this->str;
  73     }
  74
  75     /**
  76      * For serializing to a string
  77      *
  78      * @return string version of self
  79      */
  80
  81     function getString()
  82     {
  83         return $this->str;
  84     }
  85
  86     /**
  87      * Generate a new UUID
  88      *
  89      * @return 36-char v4 (random-ish) UUID
  90      */
  91
  92     static function gen()
  93     {
  94         return sprintf('%s-%s-%04x-%04x-%s',
  95                        // 32 bits for "time_low"
  96                        common_good_rand(4),
  97                        // 16 bits for "time_mid"
  98                        common_good_rand(2),
  99                        // 16 bits for "time_hi_and_version",
 100                        // four most significant bits holds version number 4
 101                        (hexdec(common_good_rand(2)) & 0x0fff) | 0x4000,
 102                        // 16 bits, 8 bits for "clk_seq_hi_res",
 103                        // 8 bits for "clk_seq_low",
 104                        // two most significant bits holds zero and one
 105                        // for variant DCE1.1
 106                        (hexdec(common_good_rand(2)) & 0x3fff) | 0x8000,
 107                        // 48 bits for "node"
 108                        common_good_rand(6));
 109     }
 110 }