lib/nickname.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 class Nickname
  21 {
  22     /**
  23      * Regex fragment for pulling a formated nickname *OR* ID number.
  24      * Suitable for router def of 'id' parameters on API actions.
  25      *
  26      * Not guaranteed to be valid after normalization; run the string through
  27      * Nickname::normalize() to get the canonical form, or Nickname::isValid()
  28      * if you just need to check if it's properly formatted.
  29      *
  30      * This, DISPLAY_FMT, and CANONICAL_FMT replace the old NICKNAME_FMT,
  31      * but be aware that these should not be enclosed in []s.
  32      *
  33      * @fixme would prefer to define in reference to the other constants
  34      */
  35     const INPUT_FMT = '(?:[0-9]+|[0-9a-zA-Z_]{1,64})';
  36
  37     /**
  38      * Regex fragment for acceptable user-formatted variant of a nickname.
  39      * This includes some chars such as underscore which will be removed
  40      * from the normalized canonical form, but still must fit within
  41      * field length limits.
  42      *
  43      * Not guaranteed to be valid after normalization; run the string through
  44      * Nickname::normalize() to get the canonical form, or Nickname::isValid()
  45      * if you just need to check if it's properly formatted.
  46      *
  47      * This and CANONICAL_FMT replace the old NICKNAME_FMT, but be aware
  48      * that these should not be enclosed in []s.
  49      */
  50     const DISPLAY_FMT = '[0-9a-zA-Z_]{1,64}';
  51
  52     /**
  53      * Regex fragment for checking a canonical nickname.
  54      *
  55      * Any non-matching string is not a valid canonical/normalized nickname.
  56      * Matching strings are valid and canonical form, but may still be
  57      * unavailable for registration due to blacklisting et.
  58      *
  59      * Only the canonical forms should be stored as keys in the database;
  60      * there are multiple possible denormalized forms for each valid
  61      * canonical-form name.
  62      *
  63      * This and DISPLAY_FMT replace the old NICKNAME_FMT, but be aware
  64      * that these should not be enclosed in []s.
  65      */
  66     const CANONICAL_FMT = '[0-9a-z]{1,64}';
  67
  68     /**
  69      * Maximum number of characters in a canonical-form nickname.
  70      */
  71     const MAX_LEN = 64;
  72
  73     /**
  74      * Nice simple check of whether the given string is a valid input nickname,
  75      * which can be normalized into an internally canonical form.
  76      *
  77      * Note that valid nicknames may be in use or reserved.
  78      *
  79      * @param string $str
  80      * @return boolean
  81      */
  82     public static function isValid($str)
  83     {
  84         try {
  85             self::normalize($str);
  86             return true;
  87         } catch (NicknameException $e) {
  88             return false;
  89         }
  90     }
  91
  92     /**
  93      * Validate an input nickname string, and normalize it to its canonical form.
  94      * The canonical form will be returned, or an exception thrown if invalid.
  95      *
  96      * @param string $str
  97      * @return string Normalized canonical form of $str
  98      *
  99      * @throws NicknameException (base class)
 100      * @throws   NicknameInvalidException
 101      * @throws   NicknameEmptyException
 102      * @throws   NicknameTooLongException
 103      */
 104     public static function normalize($str)
 105     {
 106         $str = trim($str);
 107         $str = str_replace('_', '', $str);
 108         $str = mb_strtolower($str);
 109
 110         $len = mb_strlen($str);
 111         if ($len < 1) {
 112             throw new NicknameEmptyException();
 113         } else if ($len > self::MAX_LEN) {
 114             throw new NicknameTooLongException();
 115         }
 116         if (!self::isCanonical($str)) {
 117             throw new NicknameInvalidException();
 118         }
 119
 120         return $str;
 121     }
 122
 123     /**
 124      * Is the given string a valid canonical nickname form?
 125      *
 126      * @param string $str
 127      * @return boolean
 128      */
 129     public static function isCanonical($str)
 130     {
 131         return preg_match('/^(?:' . self::CANONICAL_FMT . ')$/', $str);
 132     }
 133 }
 134
 135 class NicknameException extends ClientException
 136 {
 137     function __construct($msg=null, $code=400)
 138     {
 139         if ($msg === null) {
 140             $msg = $this->defaultMessage();
 141         }
 142         parent::__construct($msg, $code);
 143     }
 144
 145     /**
 146      * Default localized message for this type of exception.
 147      * @return string
 148      */
 149     protected function defaultMessage()
 150     {
 151         return null;
 152     }
 153 }
 154
 155 class NicknameInvalidException extends NicknameException {
 156     /**
 157      * Default localized message for this type of exception.
 158      * @return string
 159      */
 160     protected function defaultMessage()
 161     {
 162         // TRANS: Validation error in form for registration, profile and group settings, etc.
 163         return _('Nickname must have only lowercase letters and numbers and no spaces.');
 164     }
 165 }
 166
 167 class NicknameEmptyException extends NicknameException
 168 {
 169     /**
 170      * Default localized message for this type of exception.
 171      * @return string
 172      */
 173     protected function defaultMessage()
 174     {
 175         // TRANS: Validation error in form for registration, profile and group settings, etc.
 176         return _('Nickname cannot be empty.');
 177     }
 178 }
 179
 180 class NicknameTooLongException extends NicknameInvalidException
 181 {
 182     /**
 183      * Default localized message for this type of exception.
 184      * @return string
 185      */
 186     protected function defaultMessage()
 187     {
 188         // TRANS: Validation error in form for registration, profile and group settings, etc.
 189         return sprintf(_m('Nickname cannot be more than %d character long.',
 190                           'Nickname cannot be more than %d characters long.',
 191                           Nickname::MAX_LEN),
 192                        Nickname::MAX_LEN);
 193     }
 194 }