/usr/share/php/Net/SmartIRC/irccommands.php is in php-net-smartirc 1.1.7-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 | <?php
/**
* $Id$
* $Revision$
* $Author$
* $Date$
*
* Copyright (c) 2002-2004 Mirco Bauer <meebey@meebey.net> <http://www.meebey.net>
*
* Full LGPL License: <http://www.gnu.org/licenses/lgpl.txt>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
abstract class Net_SmartIRC_irccommands
{
/**
* sends a new message
*
* Sends a message to a channel or user.
*
* @see DOCUMENTATION
* @param integer $type specifies the type, like QUERY/ACTION or CTCP see 'Message Types'
* @param string $destination can be a user or channel
* @param mixed $messagearray the message
* @param integer $priority the priority level of the message
* @return boolean|Net_SmartIRC
* @api
*/
public function message($type, $destination, $messagearray,
$priority = SMARTIRC_MEDIUM
) {
if (!is_array($messagearray)) {
$messagearray = array($messagearray);
}
switch ($type) {
case SMARTIRC_TYPE_CHANNEL:
case SMARTIRC_TYPE_QUERY:
foreach ($messagearray as $message) {
$this->send('PRIVMSG '.$destination.' :'.$message, $priority);
}
break;
case SMARTIRC_TYPE_ACTION:
foreach ($messagearray as $message) {
$this->send('PRIVMSG '.$destination.' :'.chr(1).'ACTION '
.$message.chr(1), $priority
);
}
break;
case SMARTIRC_TYPE_NOTICE:
foreach ($messagearray as $message) {
$this->send('NOTICE '.$destination.' :'.$message, $priority);
}
break;
case SMARTIRC_TYPE_CTCP: // backwards compatibilty
case SMARTIRC_TYPE_CTCP_REPLY:
foreach ($messagearray as $message) {
$this->send('NOTICE '.$destination.' :'.chr(1).$message
.chr(1), $priority
);
}
break;
case SMARTIRC_TYPE_CTCP_REQUEST:
foreach ($messagearray as $message) {
$this->send('PRIVMSG '.$destination.' :'.chr(1).$message
.chr(1), $priority
);
}
break;
default:
return false;
}
return $this;
}
// <IRC methods>
/**
* Joins one or more IRC channels with an optional key.
*
* @param mixed $channelarray
* @param string $key
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function join($channelarray, $key = null, $priority = SMARTIRC_MEDIUM)
{
if (!is_array($channelarray)) {
$channelarray = array($channelarray);
}
$channellist = implode(',', $channelarray);
if ($key !== null) {
foreach ($channelarray as $idx => $value) {
$this->send('JOIN '.$value.' '.$key, $priority);
}
} else {
foreach ($channelarray as $idx => $value) {
$this->send('JOIN '.$value, $priority);
}
}
return $this;
}
/**
* parts from one or more IRC channels with an optional reason
*
* @param mixed $channelarray
* @param string $reason
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function part($channelarray, $reason = null,
$priority = SMARTIRC_MEDIUM
) {
if (!is_array($channelarray)) {
$channelarray = array($channelarray);
}
$channellist = implode(',', $channelarray);
if ($reason !== null) {
$this->send('PART '.$channellist.' :'.$reason, $priority);
} else {
$this->send('PART '.$channellist, $priority);
}
return $this;
}
/**
* Kicks one or more user from an IRC channel with an optional reason.
*
* @param string $channel
* @param mixed $nicknamearray
* @param string $reason
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function kick($channel, $nicknamearray, $reason = null,
$priority = SMARTIRC_MEDIUM
) {
if (!is_array($nicknamearray)) {
$nicknamearray = array($nicknamearray);
}
$nicknamelist = implode(',', $nicknamearray);
if ($reason !== null) {
$this->send('KICK '.$channel.' '.$nicknamelist.' :'.$reason, $priority);
} else {
$this->send('KICK '.$channel.' '.$nicknamelist, $priority);
}
return $this;
}
/**
* gets a list of one ore more channels
*
* Requests a full channellist if $channelarray is not given.
* (use it with care, usualy its a looooong list)
*
* @param mixed $channelarray
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function getList($channelarray = null, $priority = SMARTIRC_MEDIUM)
{
if ($channelarray !== null) {
if (!is_array($channelarray)) {
$channelarray = array($channelarray);
}
$channellist = implode(',', $channelarray);
$this->send('LIST '.$channellist, $priority);
} else {
$this->send('LIST', $priority);
}
return $this;
}
/**
* requests all nicknames of one or more channels
*
* The requested nickname list also includes op and voice state
*
* @param mixed $channelarray
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function names($channelarray = null, $priority = SMARTIRC_MEDIUM)
{
if ($channelarray !== null) {
if (!is_array($channelarray)) {
$channelarray = array($channelarray);
}
$channellist = implode(',', $channelarray);
$this->send('NAMES '.$channellist, $priority);
} else {
$this->send('NAMES', $priority);
}
return $this;
}
/**
* sets a new topic of a channel
*
* @param string $channel
* @param string $newtopic
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function setTopic($channel, $newtopic, $priority = SMARTIRC_MEDIUM)
{
$this->send('TOPIC '.$channel.' :'.$newtopic, $priority);
return $this;
}
/**
* gets the topic of a channel
*
* @param string $channel
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function getTopic($channel, $priority = SMARTIRC_MEDIUM)
{
$this->send('TOPIC '.$channel, $priority);
return $this;
}
/**
* sets or gets the mode of an user or channel
*
* Changes/requests the mode of the given target.
*
* @param string $target the target, can be an user (only yourself) or a channel
* @param string $newmode the new mode like +mt
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function mode($target, $newmode = null, $priority = SMARTIRC_MEDIUM)
{
if ($newmode !== null) {
$this->send('MODE '.$target.' '.$newmode, $priority);
} else {
$this->send('MODE '.$target, $priority);
}
return $this;
}
/**
* founders an user in the given channel
*
* @param string $channel
* @param string $nickname
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function founder($channel, $nickname, $priority = SMARTIRC_MEDIUM)
{
return $this->mode($channel, '+q '.$nickname, $priority);
}
/**
* defounders an user in the given channel
*
* @param string $channel
* @param string $nickname
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function defounder($channel, $nickname, $priority = SMARTIRC_MEDIUM)
{
return $this->mode($channel, '-q '.$nickname, $priority);
}
/**
* admins an user in the given channel
*
* @param string $channel
* @param string $nickname
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function admin($channel, $nickname, $priority = SMARTIRC_MEDIUM)
{
return $this->mode($channel, '+a '.$nickname, $priority);
}
/**
* deadmins an user in the given channel
*
* @param string $channel
* @param string $nickname
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function deadmin($channel, $nickname, $priority = SMARTIRC_MEDIUM)
{
return $this->mode($channel, '-a '.$nickname, $priority);
}
/**
* ops an user in the given channel
*
* @param string $channel
* @param string $nickname
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function op($channel, $nickname, $priority = SMARTIRC_MEDIUM)
{
return $this->mode($channel, '+o '.$nickname, $priority);
}
/**
* deops an user in the given channel
*
* @param string $channel
* @param string $nickname
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function deop($channel, $nickname, $priority = SMARTIRC_MEDIUM)
{
return $this->mode($channel, '-o '.$nickname, $priority);
}
/**
* hops an user in the given channel
*
* @param string $channel
* @param string $nickname
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function hop($channel, $nickname, $priority = SMARTIRC_MEDIUM)
{
return $this->mode($channel, '+h '.$nickname, $priority);
}
/**
* dehops an user in the given channel
*
* @param string $channel
* @param string $nickname
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function dehop($channel, $nickname, $priority = SMARTIRC_MEDIUM)
{
return $this->mode($channel, '-h '.$nickname, $priority);
}
/**
* voice a user in the given channel
*
* @param string $channel
* @param string $nickname
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function voice($channel, $nickname, $priority = SMARTIRC_MEDIUM)
{
return $this->mode($channel, '+v '.$nickname, $priority);
}
/**
* devoice a user in the given channel
*
* @param string $channel
* @param string $nickname
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function devoice($channel, $nickname, $priority = SMARTIRC_MEDIUM)
{
return $this->mode($channel, '-v '.$nickname, $priority);
}
/**
* bans a hostmask for the given channel or requests the current banlist
*
* The banlist will be requested if no hostmask is specified
*
* @param string $channel
* @param string $hostmask
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function ban($channel, $hostmask = null, $priority = SMARTIRC_MEDIUM)
{
if ($hostmask !== null) {
$this->mode($channel, '+b '.$hostmask, $priority);
} else {
$this->mode($channel, 'b', $priority);
}
return $this;
}
/**
* unbans a hostmask on the given channel
*
* @param string $channel
* @param string $hostmask
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function unban($channel, $hostmask, $priority = SMARTIRC_MEDIUM)
{
return $this->mode($channel, '-b '.$hostmask, $priority);
}
/**
* invites a user to the specified channel
*
* @param string $nickname
* @param string $channel
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function invite($nickname, $channel, $priority = SMARTIRC_MEDIUM)
{
return $this->send('INVITE '.$nickname.' '.$channel, $priority);
}
/**
* changes the own nickname
*
* Trys to set a new nickname, nickcollisions are handled.
*
* @param string $newnick
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function changeNick($newnick, $priority = SMARTIRC_MEDIUM)
{
$this->_nick = $newnick;
return $this->send('NICK '.$newnick, $priority);
}
/**
* requests a 'WHO' from the specified target
*
* @param string $target
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function who($target, $priority = SMARTIRC_MEDIUM)
{
return $this->send('WHO '.$target, $priority);
}
/**
* requests a 'WHOIS' from the specified target
*
* @param string $target
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function whois($target, $priority = SMARTIRC_MEDIUM)
{
return $this->send('WHOIS '.$target, $priority);
}
/**
* requests a 'WHOWAS' from the specified target
* (if he left the IRC network)
*
* @param string $target
* @param integer $priority message priority, default is SMARTIRC_MEDIUM
* @return Net_SmartIRC
* @api
*/
public function whowas($target, $priority = SMARTIRC_MEDIUM)
{
return $this->send('WHOWAS '.$target, $priority);
}
/**
* sends QUIT to IRC server and disconnects
*
* @param string $quitmessage optional quitmessage
* @param integer $priority message priority, default is SMARTIRC_CRITICAL
* @return Net_SmartIRC
* @api
*/
public function quit($quitmessage = null, $priority = SMARTIRC_CRITICAL)
{
if ($quitmessage !== null) {
$this->send('QUIT :'.$quitmessage, $priority);
} else {
$this->send('QUIT', $priority);
}
return $this->disconnect(true);
}
}
|