1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
<?php
/**
* Phergie
*
* PHP version 5
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.
* It is also available through the world-wide-web at this URL:
* http://phergie.org/license
*
* @category Phergie
* @package Phergie
* @author Phergie Development Team <team@phergie.org>
* @copyright 2008-2010 Phergie Development Team (http://phergie.org)
* @license http://phergie.org/license New BSD License
* @link http://pear.phergie.org/package/Phergie
*/
/**
* Data structure for a hostmask.
*
* @category Phergie
* @package Phergie
* @author Phergie Development Team <team@phergie.org>
* @license http://phergie.org/license New BSD License
* @link http://pear.phergie.org/package/Phergie
*/
class Phergie_Hostmask
{
/**
* Host
*
* @var string
*/
protected $host;
/**
* Nick
*
* @var string
*/
protected $nick;
/**
* Username
*
* @var string
*/
protected $username;
/**
* Regular expression used to parse a hostmask
*
* @var string
*/
protected static $regex = '/^([^!@]+)!(?:[ni]=)?([^@]+)@([^ ]+)/';
/**
* Constructor to initialize components of the hostmask.
*
* @param string $nick Nick component
* @param string $username Username component
* @param string $host Host component
*
* @return void
*/
public function __construct($nick, $username, $host)
{
$this->nick = $nick;
$this->username = $username;
$this->host = $host;
}
/**
* Returns whether a given string appears to be a valid hostmask.
*
* @param string $string Alleged hostmask string
*
* @return bool TRUE if the string appears to be a valid hostmask, FALSE
* otherwise
*/
public static function isValid($string)
{
return (preg_match(self::$regex, $string) > 0);
}
/**
* Parses a string containing the entire hostmask into a new instance of
* this class.
*
* @param string $hostmask Entire hostmask including the nick, username,
* and host components
*
* @return Phergie_Hostmask New instance populated with data parsed from
* the provided hostmask string
* @throws Phergie_Hostmask_Exception
*/
public static function fromString($hostmask)
{
if (preg_match(self::$regex, $hostmask, $match)) {
list(, $nick, $username, $host) = $match;
return new self($nick, $username, $host);
}
throw new Phergie_Hostmask_Exception(
'Invalid hostmask specified: "' . $hostmask . '"',
Phergie_Hostmask_Exception::ERR_INVALID_HOSTMASK
);
}
/**
* Sets the hostname.
*
* @param string $host Hostname
*
* @return Phergie_Hostmask Provides a fluent interface
*/
public function setHost($host)
{
$this->host = $host;
return $this;
}
/**
* Returns the hostname.
*
* @return string
*/
public function getHost()
{
return $this->host;
}
/**
* Sets the username of the user.
*
* @param string $username Username
*
* @return Phergie_Hostmask Provides a fluent interface
*/
public function setUsername($username)
{
$this->username = $username;
return $this;
}
/**
* Returns the username of the user.
*
* @return string
*/
public function getUsername()
{
return $this->username;
}
/**
* Sets the nick of the user.
*
* @param string $nick User nick
*
* @return Phergie_Hostmask Provides a fluent interface
*/
public function setNick($nick)
{
$this->nick = $nick;
return $this;
}
/**
* Returns the nick of the user.
*
* @return string
*/
public function getNick()
{
return $this->nick;
}
/**
* Returns the hostmask for the originating server or user.
*
* @return string
*/
public function __toString()
{
return $this->nick . '!' . $this->username . '@' . $this->host;
}
/**
* Returns whether a given hostmask matches a given pattern.
*
* @param string $pattern Pattern using conventions of a ban mask where
* represents a wildcard
* @param string $hostmask Optional hostmask to match against, if not
* the current hostmask instance
*
* @return bool TRUE if the hostmask matches the pattern, FALSE otherwise
* @link http://irchelp.org/irchelp/rfc/chapter4.html#c4_2_3 Examples
*/
public function matches($pattern, $hostmask = null)
{
if (!$hostmask) {
$hostmask = (string) $this;
}
$pattern = str_replace('*', '.*', $pattern);
return (preg_match('#^' . $pattern . '$#', $hostmask) > 0);
}
}
|
