plugins/perl/lib/Xchat.pod

   1 =head1 X-Chat 2 Perl Interface
   2
   3 =head2 Introduction
   4
   5 This is the new Perl interface for X-Chat 2.  However, due to changes in
   6 xchat's plugin code you will need xchat 2.0.8 or above to load this.  Scripts
   7 written using the old interface will continue to work. If there are any
   8 problems, questions, comments or suggestions please email them to the address
   9 on the bottom of this page.
  10
  11 =head2 Constants
  12
  13 =head3 Priorities
  14
  15 =over 3
  16
  17 =item *
  18 C<Xchat::PRI_HIGHEST>
  19
  20 =item *
  21 C<Xchat::PRI_HIGH>
  22
  23 =item *
  24 C<Xchat::PRI_NORM>
  25
  26 =item *
  27 C<Xchat::PRI_LOW>
  28
  29 =item *
  30 C<Xchat::PRI_LOWEST>
  31
  32 =back
  33
  34 =head3 Return values
  35
  36 =over 3
  37
  38 =item *
  39 C<Xchat::EAT_NONE>     - pass the event along
  40
  41 =item *
  42 C<Xchat::EAT_XCHAT>    - don't let xchat see this event
  43
  44 =item *
  45 C<Xchat::EAT_PLUGIN>   - don't let other scripts and plugins see this event but xchat will still see it
  46
  47 =item *
  48 C<Xchat::EAT_ALL>      - don't let anything else see this event
  49
  50 =back
  51
  52 =head4 Timer and fd hooks
  53
  54 =over 3
  55
  56 =item *
  57 C<Xchat::KEEP>         - keep the timer going or hook watching the handle
  58
  59 =item *
  60 C<Xchat::REMOVE>       - remove the timer or hook watching the handle
  61
  62 =back
  63
  64 =head3 hook_fd flags
  65
  66 =over 3
  67
  68 =item *
  69 C<Xchat::FD_READ>                       - invoke the callback when the handle is ready for reading
  70
  71 =item *
  72 C<Xchat::FD_WRITE>              - invoke the callback when the handle is ready for writing
  73
  74 =item *
  75 C<Xchat::FD_EXCEPTION>  - invoke the callback if an exception occurs
  76
  77 =item *
  78 C<Xchat::FD_NOTSOCKET>  - indicate that the handle being hooked is not a socket
  79
  80 =back
  81
  82 =head2 Functions
  83
  84 =head3 C<Xchat::register( $name, $version, [$description,[$callback]] )>
  85
  86 =over 3
  87
  88 =item *
  89 C<$name>             -  The name of this script
  90
  91 =item *
  92 C<$version>          -  This script's version
  93
  94 =item *
  95 C<$description>   -  A description for this script
  96
  97 =item *
  98 C<$callback>      -  This is a function that will be called when the is script
  99                      unloaded. This can be either a reference to a
 100                      function or an anonymous sub reference.
 101
 102 =back
 103
 104 This is the first thing to call in every script.
 105
 106 =head3 C<Xchat::hook_server( $message, $callback, [\%options] )>
 107
 108 =head3 C<Xchat::hook_command( $command, $callback, [\%options] )>
 109
 110 =head3 C<Xchat::hook_print( $event,$callback, [\%options] )>
 111
 112 =head3 C<Xchat::hook_timer( $timeout,$callback, [\%options | $data] )>
 113
 114 =head3 C<Xchat::hook_fd( $handle, $callback, [ \%options ] )>
 115
 116 These functions can be to intercept various events.
 117 hook_server can be used to intercept any incoming message from the IRC server.
 118 hook_command can be used to intercept any command, if the command doesn't currently exist then a new one is created.
 119 hook_print can be used to intercept any of the events listed in Setttings-E<gt>Advanced-E<gt>Text Events
 120 hook_timer can be used to create a new timer
 121
 122
 123 =over 3
 124
 125 =item *
 126 C<$message>       -  server message to hook such as PRIVMSG
 127
 128 =item *
 129 C<$command>       -  command to intercept, without the leading /
 130
 131 =item *
 132 C<$event>      -  one of the events listed in Settings-E<gt>Advanced-E<gt>Text Events
 133
 134 =item *
 135 C<$timeout>       -  timeout in milliseconds
 136
 137 =item *
 138 C<$handle>     - the I/O handle you want to monitor with hook_fd. This must be something that has a fileno. See perldoc -f fileno or L<fileno|http://perldoc.perl.org/functions/fileno.html>
 139
 140 =item *
 141 C<$callback>   -  callback function, this is called whenever
 142                   the hooked event is trigged, the following are
 143                   the conditions that will trigger the different hooks.
 144                   This can be either a reference to a
 145                   function or an anonymous sub reference.
 146
 147 =item *
 148 \%options   -  a hash reference containing addional options for the hooks
 149
 150 =back
 151
 152 Valid keys for \%options:
 153
 154 =begin html
 155
 156 <table border="1">
 157
 158    <tr>
 159    <td>data</td>  <td>Additional data that is to be associated with the<br />
 160                   hook. For timer hooks this value can be provided either as<br />
 161                   <code>Xchat::hook_timer( $timeout, $cb,{data=&gt;$data})</code><br />
 162                   or <code>Xchat::hook_timer( $timeout, $cb, $data )</code>.<br />
 163                   However, this means that hook_timer cannot be provided<br />
 164                   with a hash reference containing data as a key.<br />
 165
 166                   example:<br />
 167                   my $options = { data =&gt; [@arrayOfStuff] };<br />
 168                   Xchat::hook_timer( $timeout, $cb, $options );<br />
 169                   <br />
 170                   In this example, the timer's data will be<br />
 171                   [@arrayOfStuff] and not { data =&gt; [@arrayOfStuff] }<br />
 172                   <br />
 173                   This key is valid for all of the hook functions.<br />
 174                   <br />
 175                   Default is undef.<br />
 176                   </td>
 177    </tr>
 178
 179    <tr>
 180       <td>priority</td> <td>Sets the priority for the hook.<br />
 181                         It can be set to one of the
 182                         <code>Xchat::PRI_*</code> constants.<br />
 183                         <br />
 184                         This key only applies to server, command
 185                         and print hooks.<br />
 186                         <br />
 187                         Default is <code>Xchat::PRI_NORM</code>.
 188                         </td>
 189
 190    </tr>
 191
 192    <tr>
 193       <td>help_text</td>   <td>Text displayed for /help $command.<br />
 194                            <br />
 195                            This key only applies to command hooks.<br />
 196                            <br />
 197                            Default is "".
 198                            </td>
 199    </tr>
 200
 201    <tr>
 202       <td>flags</td>   <td>Specify the flags for a fd hook.<br />
 203                        <br />
 204                        See <a href="#hook_fd_flags">hook fd flags</a> section for valid values.<br />
 205                        <br />
 206                        On Windows if the handle is a pipe you specify<br />
 207                        Xchat::FD_NOTSOCKET in addition to any other flags you might be using.<br />
 208                        <br />
 209                        This key only applies to fd hooks.<br />
 210                        Default is Xchat::FD_READ
 211                            </td>
 212    </tr>
 213
 214 </table>
 215
 216 =end html
 217
 218 =head4 When callbacks are invoked
 219
 220 Each of the hooks will be triggered at different times depending on the type
 221 of hook.
 222
 223 =begin html
 224
 225 <table border="1">
 226
 227    <tr style="background-color: #dddddd">
 228       <td>Hook Type</td>   <td>When the callback will be invoked</td>
 229    </tr>
 230
 231    <tr>
 232       <td>server hooks</td>   <td>a <code>$message</code> message is
 233                               received from the server
 234                               </td>
 235    </tr>
 236
 237    <tr>
 238       <td>command hooks</td>  <td>the <code>$command</code> command is
 239                               executed, either by the user or from a script
 240                               </td>
 241    </tr>
 242
 243    <tr>
 244       <td>print hooks</td> <td>X-Chat is about to print the message for the
 245                            <code>$event</code> event
 246                            </td>
 247    </tr>
 248
 249    <tr>
 250       <td>timer hooks</td> <td>called every <code>$timeout</code> milliseconds
 251                            (1000 millisecond is 1 second)<br />
 252                            the callback will be executed in the same context where
 253                            the hook_timer was called, if the context no longer exists
 254                            then it will execute in a random context
 255                            </td>
 256    </tr>
 257
 258    <tr>
 259       <td>fd hooks</td> <td>depends on the flags that were passed to hook_fd<br />
 260                         See <a href="#hook_fd_flags">hook_fd flags</a> section.
 261                         </td>
 262    </tr>
 263 </table>
 264
 265 =end html
 266
 267
 268 The value return from these hook functions can be passed to C<Xchat::unhook>
 269 to remove the hook.
 270
 271 =head4 Callback Arguments
 272
 273 All callback functions will receive their arguments in C<@_> like every
 274 other Perl subroutine.
 275
 276 =begin html
 277
 278 <p>
 279 Server and command callbacks<br />
 280 <br />
 281 <code>$_[0]</code>   -  array reference containing the IRC message or command and
 282 arguments broken into words<br />
 283 example:<br />
 284 /command arg1 arg2 arg3<br />
 285 <code>$_[0][0]</code> -  command<br />
 286 <code>$_[0][1]</code> -  arg1<br />
 287 <code>$_[0][2]</code> -  arg2<br />
 288 <code>$_[0][3]</code> -  arg3<br />
 289 <br />
 290 <code>$_[1]</code>   -  array reference containing the Nth word to the last word<br />
 291 example:<br />
 292 /command arg1 arg2 arg3<br />
 293 <code>$_[1][0]</code>   -  command arg1 arg2 arg3<br />
 294 <code>$_[1][1]</code>   -  arg1 arg2 arg3<br />
 295 <code>$_[1][2]</code>   -  arg2 arg3<br />
 296 <code>$_[1][3]</code>   -  arg3<br />
 297 <br />
 298 <code>$_[2]</code>   -  the data that was passed to the hook function<br />
 299 <br />
 300 Print callbacks<br />
 301 <br />
 302 <code>$_[0]</code>   -  array reference containing the values for the
 303                         text event see Settings-&gt;Advanced-&gt;Text Events<br />
 304 <code>$_[1]</code>   -  the data that was passed to the hook function<br />
 305 <br />
 306 Timer callbacks<br />
 307 <br />
 308 <code>$_[0]</code>   -  the data that was passed to the hook function<br />
 309 <br />
 310
 311 fd callbacks<br />
 312 <br />
 313 <code>$_[0]</code>   -  the handle that was passed to hook_fd<br />
 314 <code>$_[1]</code>   -  flags indicating why the callback was called<br />
 315 <code>$_[2]</code>   -  the data that was passed to the hook function<br />
 316 </p>
 317
 318 =end html
 319
 320 =head4 Callback return values
 321
 322 All server, command and print  callbacks should return one of
 323 the C<Xchat::EAT_*> constants.
 324 Timer callbacks can return Xchat::REMOVE to remove
 325 the timer or Xchat::KEEP to keep it going
 326
 327 =head4 Miscellaneous Hook Related Information
 328
 329 For server hooks, if C<$message> is "RAW LINE" then C<$cb> will be called for
 330 every IRC message than X-Chat receives.
 331
 332 For command hooks if C<$command> is "" then C<$cb> will be called for
 333 messages entered by the user that is not a command.
 334
 335 For print hooks besides those events listed in
 336 Settings-E<gt>Advanced-E<gt>Text Events, these additional events can be used.
 337
 338 =begin html
 339
 340 <table border="1">
 341
 342    <tr style="background-color: #dddddd">
 343       <td>Event</td> <td>Description</td>
 344    </tr>
 345
 346    <tr>
 347       <td>"Open Context"</td> <td>a new context is created</td>
 348    </tr>
 349
 350    <tr>
 351       <td>"Close Context"</td>   <td>a context has been close</td>
 352    </tr>
 353
 354    <tr>
 355       <td>"Focus Tab"</td> <td>when a tab is brought to the front</td>
 356    </tr>
 357
 358    <tr>
 359       <td>"Focus Window"</td> <td>when a top level window is focused or the
 360                               main tab window is focused by the window manager
 361                               </td>
 362    </tr>
 363
 364    <tr>
 365       <td>"DCC Chat Text"</td>   <td>when text from a DCC Chat arrives.
 366                                  <code>$_[0]</code> will have these values<br />
 367                                  <br />
 368                                  <code>$_[0][0]</code>   -  Address<br />
 369                                  <code>$_[0][1]</code>   -  Port<br />
 370                                  <code>$_[0][2]</code>   -  Nick<br />
 371                                  <code>$_[0][3]</code>   -  Message<br />
 372                                  </td>
 373    </tr>
 374
 375    <tr>
 376       <td>"Key Press"</td> <td>used for intercepting key presses<br />
 377                         $_[0][0] - key value<br />
 378                         $_[0][1] - state bitfield, 1 - shift, 4 - control, 8 - alt<br />
 379                         $_[0][2] - string version of the key which might be empty for unprintable keys<br />
 380                         $_[0][3] - length of the string in $_[0][2]<br />
 381                 </td>
 382    </tr>
 383 </table>
 384
 385 =end html
 386
 387 =head3 C<Xchat::unhook( $hook )>
 388
 389 =over 3
 390
 391 =item *
 392 C<$hook>    -  the hook that was previously returned by one of the C<Xchat::hook_*> functions
 393
 394 =back
 395
 396
 397 This function is used to removed a hook previously added with one of
 398 the C<Xchat::hook_*> functions
 399
 400 It returns the data that was passed to the C<Xchat::hook_*> function when
 401 the hook was added
 402
 403
 404 =head3 C<Xchat::print( $text | \@lines, [$channel,[$server]] )>
 405
 406 =over 3
 407
 408 =item *
 409 C<$text>    -  the text to print
 410
 411 =item *
 412 C<\@lines>  -  array reference containing lines of text to be printed
 413                all the elements will be joined together before printing
 414
 415 =item *
 416 C<$channel> -  channel or tab with the given name where C<$text>
 417                will be printed
 418
 419 =item *
 420 C<$server>  -  specifies that the text will be printed in a channel or tab
 421                that is associated with C<$server>
 422
 423 =back
 424
 425 The first argument can either be a string or an array reference of strings.
 426 Either or both of C<$channel> and C<$server> can be undef.
 427
 428 If called as C<Xchat::print( $text )>, it will always return true.
 429 If called with either the channel or the channel and the server
 430 specified then it will return true if a context is found and
 431 false otherwise. The text will not be printed if the context
 432 is not found.  The meaning of setting C<$channel> or C<$server> to
 433 undef is the same as
 434 L<find_context|xchat_find_context>.
 435
 436
 437 =head3 C<Xchat::printf( $format, LIST )>
 438
 439 =over 3
 440
 441 =item *
 442 C<$format>  -  a format string, see "perldoc -f L<sprintf|http://perldoc.perl.org/functions/sprintf.html>" for further detail
 443
 444 =item *
 445 LIST     -  list of values for the format fields
 446
 447 =back
 448
 449 =head3 C<Xchat::command( $command | \@commands, [$channel,[$server]] )>
 450
 451 =over 3
 452
 453 =item *
 454 C<$command> -  the command to execute, without the leading /
 455
 456 =item *
 457 C<\@commands>  -  array reference containing a list of commands to execute
 458
 459 =item *
 460 C<$channel> -  channel or tab with the given name where C<$command> will be executed
 461
 462 =item *
 463 C<$server>  -  specifies that the command will be executed in a channel or tab that is associated with C<$server>
 464
 465 =back
 466
 467 The first argument can either be a string or an array reference of strings.
 468 Either or both of C<$channel> and C<$server> can be undef.
 469
 470 If called as C<Xchat::command( $command )>, it will always return true.
 471 If called with either the channel or the channel and the server
 472 specified then it will return true if a context is found and false
 473 otherwise. The command will not be executed if the context is not found.
 474 The meaning of setting C<$channel> or C<$server> to undef is the same
 475 as find_context.
 476
 477
 478 =head3 C<Xchat::commandf( $format, LIST )>
 479
 480 =over 3
 481
 482 =item *
 483 C<$format> -  a format string, see "perldoc -f L<sprintf|http://perldoc.perl.org/functions/sprintf.html>" for further detail
 484
 485 =item *
 486 LIST     -  list of values for the format fields
 487
 488 =back
 489
 490 =head3 C<Xchat::find_context( [$channel, [$server]] )>
 491
 492 =over 3
 493
 494 =item *
 495 C<$channel> -  name of a channel
 496
 497 =item *
 498 C<$server>  -  name of a server
 499
 500 =back
 501
 502 Either or both of C<$channel> and $server can be undef. Calling
 503 C<Xchat::find_context()> is the same as calling
 504 C<Xchat::find_context( undef, undef)> and
 505 C<Xchat::find_context( $channel )> is
 506 the same as C<Xchat::find_context( $channel, undef )>.
 507
 508 If C<$server> is undef, find any channel named $channel.
 509 If C<$channel> is undef, find the front most window
 510 or tab named C<$server>.If both $channel and
 511 C<$server> are undef, find the currently focused tab or window.
 512
 513 Return the context found for one of the above situations or undef if such
 514 a context cannot be found.
 515
 516
 517 =head3 C<Xchat::get_context()>
 518
 519 =over 3
 520
 521 =back
 522
 523 Returns the current context.
 524
 525 =head3 C<Xchat::set_context( $context | $channel,[$server] )>
 526
 527 =over 3
 528
 529 =item *
 530 C<$context> -  context value as returned from L<get_context|xchat_get_context>,L<find_context|xchat_find_context> or one
 531                of the fields in the list of hashrefs returned by list_get
 532
 533 =item *
 534 C<$channel> -  name of a channel you want to switch context to
 535
 536 =item *
 537 C<$server>  -  name of a server you want to switch context to
 538
 539 =back
 540
 541 See L<find_context|xchat_find_context> for more details on C<$channel> and C<$server>.
 542
 543 Returns true on success, false on failure
 544
 545 =head3 C<Xchat::get_info( $id )>
 546
 547 =over 3
 548
 549 =item *
 550 C<$id>   -  one of the following case sensitive values
 551
 552 =back
 553
 554 =begin html
 555
 556 <table border="1">
 557
 558    <tr style="background-color: #dddddd">
 559       <td>ID</td>
 560       <td>Return value</td>
 561       <td>Associated Command(s)</td>
 562    </tr>
 563
 564    <tr>
 565       <td>away</td>
 566       <td>away reason or undef if you are not away</td>
 567       <td>AWAY, BACK</td>
 568    </tr>
 569
 570    <tr>
 571       <td>channel</td>
 572       <td>current channel name</td>
 573       <td>SETTAB</td>
 574    </tr>
 575
 576    <tr>
 577       <td>charset</td>
 578       <td>character-set used in the current context</td>
 579       <td>CHARSET</td>
 580    </tr>
 581
 582    <tr>
 583       <td>event_text &lt;Event Name&gt;</td> <td>text event format string for &lt;Event name&gt;<br />
 584       Example:
 585    <div class="example">
 586       my $channel_msg_format = Xchat::get_info( "event_text Channel Message" );
 587    </div>
 588    </td>
 589    <td></td>
 590 </tr>
 591 <tr>
 592    <td>host</td>
 593    <td>real hostname of the current server</td>
 594    <td></td>
 595 </tr>
 596
 597 <tr>
 598    <td>id</td>
 599    <td>connection id</td>
 600    <td></td>
 601 </tr>
 602
 603 <tr>
 604    <td>inputbox</td>
 605    <td>contents of the inputbox</td>
 606    <td>SETTEXT</td>
 607 </tr>
 608
 609 <tr>
 610    <td>libdirfs</td>
 611    <td>the system wide directory where xchat will look for plugins.
 612    this string is in the same encoding as the local file system</td>
 613    <td></td>
 614 </tr>
 615
 616 <tr>
 617    <td>modes</td>
 618    <td>the current channels modes or undef if not known</td>
 619    <td>MODE</td>
 620 </tr>
 621
 622 <tr>
 623    <td>network</td>
 624    <td>current network name or undef, this value is taken from the Network List</td>
 625    <td></td>
 626 </tr>
 627
 628 <tr>
 629    <td>nick</td>
 630    <td>current nick</td>
 631    <td>NICK</td>
 632 </tr>
 633
 634 <tr>
 635    <td>nickserv</td>
 636    <td>nickserv password for this network or undef, this value is taken from the Network List</td>
 637    <td></td>
 638 </tr>
 639
 640 <tr>
 641    <td>server</td>   <td>current server name <br />
 642                      (what the server claims to be) undef if not connected
 643                      </td>
 644    <td></td>
 645 </tr>
 646
 647 <tr>
 648    <td>state_cursor</td>
 649    <td>current inputbox cursor position in characters</td>
 650    <td>SETCURSOR</td>
 651 </tr>
 652
 653 <tr>
 654    <td>topic</td>
 655    <td>current channel topic</td>
 656    <td>TOPIC</td>
 657 </tr>
 658
 659 <tr>
 660    <td>version</td>
 661    <td>xchat version number</td>
 662    <td></td>
 663 </tr>
 664
 665 <tr>
 666    <td>win_status</td>
 667    <td>status of the xchat window, possible values are "active", "hidden"
 668    and "normal"</td>
 669    <td>GUI</td>
 670 </tr>
 671
 672 <tr>
 673   <td>win_ptr</td> <td>native window pointer, GtkWindow * on Unix, HWND on Win32.<br />
 674   On Unix if you have the Glib module installed you can use my $window = Glib::Object->new_from_pointer( Xchat::get_info( "win_ptr" ) ); to get a Gtk2::Window object.<br />
 675   Additionally when you have detached tabs, each of the windows will return a different win_ptr for the different Gtk2::Window objects.<br />
 676   See <a href="http://xchat.cvs.sourceforge.net/viewvc/xchat/xchat2/plugins/perl/char_count.pl?view=markup">char_count.pl</a> for a longer example of a script that uses this to show how many characters you currently have in your input box.
 677   </td>
 678   <td></td>
 679 </tr>
 680 <tr>
 681   <td>gtkwin_ptr</td>
 682   <td>similar to win_ptr except it will always be a GtkWindow *</td>
 683   <td></td>
 684 </tr>
 685 <tr>
 686    <td>xchatdir</td> <td>xchat config directory encoded in UTF-8<br />
 687                      examples:<br />
 688                      /home/user/.xchat2<br />
 689                      C:\Documents and Settings\user\Application Data\X-Chat 2
 690                      </td>
 691    <td></td>
 692 </tr>
 693
 694 <tr>
 695    <td>xchatdirfs</td>  <td>same as xchatdir except encoded in the locale file system encoding</td>
 696    <td></td>
 697 </tr>
 698 </table>
 699
 700 <p>This function is used to retrieve certain information about the current
 701 context. If there is an associated command then that command can be used to change the value for a particular ID.</p>
 702
 703 =end html
 704
 705 =head3 C<Xchat::get_prefs( $name )>
 706
 707 =over 3
 708
 709 =item *
 710 C<$name> -  name of a X-Chat setting (available through the /set command)
 711
 712 =back
 713
 714 This function provides a way to retrieve X-Chat's setting information.
 715
 716 Returns C<undef> if there is no setting called called C<$name>.
 717
 718
 719 =head3 C<Xchat::emit_print( $event, LIST )>
 720
 721 =over 3
 722
 723 =item *
 724 C<$event>   -  name from the Event column in Settings-E<gt>Advanced-E<gt>Text Events
 725
 726 =item *
 727 LIST     -  this depends on the Description column on the bottom of Settings-E<gt>Advanced-E<gt>Text Events
 728
 729 =back
 730
 731 This functions is used to generate one of the events listed under
 732 Settings-E<gt>Advanced-E<gt>Text Events
 733
 734 Note: when using this function you MUST return Xchat::EAT_ALL otherwise you will end up with duplicate events.
 735 One is the original and the second is the one you emit.
 736
 737 Returns true on success, false on failure
 738
 739 =head3 C<Xchat::send_modes( $target | \@targets, $sign, $mode, [ $modes_per_line ] )>
 740
 741 =over 3
 742
 743 =item *
 744 C<$target>  -  a single nick to set the mode on
 745
 746 =item *
 747 C<\@targets>   -  an array reference of the nicks to set the mode on
 748
 749 =item *
 750 C<$sign> - the mode sign, either '+' or '-'
 751
 752 =item *
 753 C<$mode> - the mode character such as 'o' and 'v', this can only be one character long
 754
 755 =item *
 756 C<$modes_per_line>   -  an optional argument maximum number of modes to send per at once, pass 0 use the current server's maximum (default)
 757
 758 =back
 759
 760 Send multiple mode changes for the current channel. It may send multiple MODE lines if the request doesn't fit on one.
 761
 762 Example:
 763
 764 =begin html
 765 <div class="example">
 766 <code>
 767 use strict;
 768 use warning;
 769 use Xchat qw(:all);
 770
 771 hook_command( "MODES", sub {
 772    my (undef, $who, $sign, $mode) = @{$_[0]};
 773
 774    my @targets = split /,/, $who;
 775    if( @targets > 1 ) {
 776       send_modes( \@targets, $sign, $mode, 1 );
 777    } else {
 778       send_modes( $who, $sign, $mode );
 779    }
 780
 781    return EAT_XCHAT;
 782 });
 783
 784 </code>
 785 </div>
 786
 787 =end html
 788
 789 =head3 C<Xchat::nickcmp( $nick1, $nick2 )>
 790
 791 =over 3
 792
 793 =item *
 794 C<$nick1, $nick2> -  the two nicks or channel names that are to be compared
 795
 796 =back
 797
 798 The comparsion is based on the current server. Either a RFC1459 compliant
 799 string compare or plain ascii will be using depending on the server. The
 800 comparison is case insensitive.
 801
 802 Returns a number less than, equal to or greater than zero if
 803 C<$nick1> is
 804 found respectively, to be less than, to match, or be greater than
 805 C<$nick2>.
 806
 807
 808 =head3 C<Xchat::get_list( $name )>
 809
 810 =over 3
 811
 812 =item *
 813 C<$name> -  name of the list, one of the following:
 814 "channels", "dcc", "ignore", "notify", "users"
 815
 816 =back
 817
 818 This function will return a list of hash references.  The hash references
 819 will have different keys depend on the list.  An empty list is returned
 820 if there is no such list.
 821
 822 =begin html
 823
 824 <p>"channels"  -  list of channels, querys and their server</p>
 825
 826 <table border="1">
 827
 828    <tr style="background-color: #dddddd">
 829       <td>Key</td>   <td>Description</td>
 830    </tr>
 831
 832    <tr>
 833       <td>channel</td>  <td>tab name</td>
 834    </tr>
 835
 836    <tr>
 837       <td>chantypes</td>
 838       <td>channel types supported by the server, typically "#&amp;"</td>
 839    </tr>
 840
 841    <tr>
 842       <td>context</td>  <td>can be used with set_context</td>
 843    </tr>
 844
 845    <tr>
 846       <td>flags</td> <td>Server Bits:<br />
 847                      0 - Connected<br />
 848                      1 - Connecting<br />
 849                      2 - Away<br />
 850                      3 - EndOfMotd(Login complete)<br />
 851                      4 - Has WHOX<br />
 852                      5 - Has IDMSG (FreeNode)<br />
 853                     <br />
 854                     <p>The following correspond to the /chanopt command</p>
 855                     6  - Hide Join/Part Message (text_hidejoinpart)<br />
 856                     7  - unused (was for color paste)<br />
 857                     8  - Beep on message (alert_beep)<br />
 858                     9  - Blink Tray (alert_tray)<br />
 859                     10 - Blink Task Bar (alert_taskbar)<br />
 860 <p>Example of checking if the current context has Hide Join/Part messages set:</p>
 861 <div class="example">
 862 <code>
 863 if( Xchat::context_info->{flags} &amp; (1 << 6) ) {
 864   Xchat::print( "Hide Join/Part messages is enabled" );
 865 }
 866 </code>
 867 </div>
 868
 869                      </td>
 870    </tr>
 871
 872    <tr>
 873       <td>id</td> <td>Unique server ID </td>
 874    </tr>
 875
 876    <tr>
 877       <td>lag</td>
 878       <td>lag in milliseconds</td>
 879    </tr>
 880
 881    <tr>
 882       <td>maxmodes</td> <td>Maximum modes per line</td>
 883    </tr>
 884
 885    <tr>
 886       <td>network</td>  <td>network name to which this channel belongs</td>
 887    </tr>
 888
 889    <tr>
 890       <td>nickprefixes</td>   <td>Nickname prefixes e.g. "+@"</td>
 891    </tr>
 892
 893    <tr>
 894       <td>nickmodes</td>   <td>Nickname mode chars e.g. "vo"</td>
 895    </tr>
 896
 897    <tr>
 898       <td>queue</td>
 899       <td>number of bytes in the send queue</td>
 900    </tr>
 901
 902    <tr>
 903       <td>server</td>   <td>server name to which this channel belongs</td>
 904    </tr>
 905
 906    <tr>
 907       <td>type</td>  <td>the type of this context<br />
 908                      1 - server<br />
 909                      2 - channel<br />
 910                      3 - dialog<br />
 911                      4 - notices<br />
 912                      5 - server notices<br />
 913                      </td>
 914    </tr>
 915
 916    <tr>
 917       <td>users</td> <td>Number of users in this channel</td>
 918    </tr>
 919 </table>
 920
 921 <p>"dcc"       -  list of DCC file transfers</p>
 922 <table border="1">
 923
 924    <tr style="background-color: #dddddd">
 925       <td>Key</td>   <td>Value</td>
 926    </tr>
 927
 928    <tr>
 929       <td>address32</td>   <td>address of the remote user(ipv4 address)</td>
 930    </tr>
 931
 932    <tr>
 933       <td>cps</td>   <td>bytes per second(speed)</td>
 934    </tr>
 935
 936    <tr>
 937       <td>destfile</td> <td>destination full pathname</td>
 938    </tr>
 939
 940    <tr>
 941       <td>file</td>  <td>file name</td>
 942    </tr>
 943
 944    <tr>
 945       <td>nick</td>
 946       <td>nick of the person this DCC connection is connected to</td>
 947    </tr>
 948
 949    <tr>
 950       <td>port</td>  <td>TCP port number</td>
 951    </tr>
 952
 953    <tr>
 954       <td>pos</td>   <td>bytes sent/received</td>
 955    </tr>
 956
 957    <tr>
 958       <td>poshigh</td>   <td>bytes sent/received, high order 32 bits</td>
 959    </tr>
 960
 961    <tr>
 962       <td>resume</td>   <td>point at which this file was resumed<br />
 963                         (zero if it was not resumed)
 964                         </td>
 965    </tr>
 966
 967    <tr>
 968       <td>resumehigh</td>   <td>point at which this file was resumed, high order 32 bits<br />
 969                         </td>
 970    </tr>
 971
 972    <tr>
 973       <td>size</td>  <td>file size in bytes low order 32 bits</td>
 974    </tr>
 975
 976    <tr>
 977       <td>sizehigh</td> <td>file size in bytes, high order 32 bits (when the files is > 4GB)</td>
 978         </tr>
 979         <tr>
 980       <td>status</td>   <td>DCC Status:<br />
 981                         0 - queued<br />
 982                         1 - active<br />
 983                         2 - failed<br />
 984                         3 - done<br />
 985                         4 - connecting<br />
 986                         5 - aborted
 987                         </td>
 988    </tr>
 989
 990    <tr>
 991       <td>type</td>  <td>DCC Type:<br />
 992                      0 - send<br />
 993                      1 - receive<br />
 994                      2 - chatrecv<br />
 995                      3 - chatsend
 996                      </td>
 997    </tr>
 998
 999 </table>
1000
1001 <p>"ignore"    -  current ignore list</p>
1002 <table border="1">
1003
1004    <tr style="background-color: #dddddd">
1005       <td>Key</td> <td>Value</td>
1006    </tr>
1007
1008    <tr>
1009       <td>mask</td>  <td>ignore mask. e.g: *!*@*.aol.com</td>
1010    </tr>
1011
1012    <tr>
1013       <td>flags</td> <td>Bit field of flags.<br />
1014                      0 - private<br />
1015                      1 - notice<br />
1016                      2 - channel<br />
1017                      3 - ctcp<br />
1018                      4 - invite<br />
1019                      5 - unignore<br />
1020                      6 - nosave<br />
1021                      7 - dcc<br />
1022                      </td>
1023    </tr>
1024
1025 </table>
1026
1027 <p>"notify" - list of people on notify</p>
1028 <table border="1">
1029    <tr style="background-color: #dddddd">
1030       <td>Key</td>   <td>Value</td>
1031    </tr>
1032
1033    <tr>
1034       <td>networks</td>
1035       <td>comma separated list of networks where you will be notfified about this user's online/offline status or undef if you will be notificed on every network you are connected to</td>
1036    </tr>
1037
1038    <tr>
1039       <td>nick</td>  <td>nickname</td>
1040    </tr>
1041
1042    <tr>
1043       <td>flags</td> <td>0 = is online</td>
1044    </tr>
1045
1046    <tr>
1047       <td>on</td> <td>time when user came online</td>
1048    </tr>
1049
1050    <tr>
1051       <td>off</td>   <td>time when user went offline</td>
1052    </tr>
1053
1054    <tr>
1055       <td>seen</td>  <td>time when user was last verified still online</td>
1056    </tr>
1057 </table>
1058
1059 <p>the values indexed by on, off and seen can be passed to localtime
1060 and gmtime, see perldoc -f <a href="http://perldoc.perl.org/functions/localtime.html">localtime</a> and perldoc -f <a href="http://perldoc.perl.org/functions/gmtime.html">gmtime</a> for more
1061 detail</p>
1062
1063 <p>"users"     -  list of users in the current channel</p>
1064 <table border="1">
1065
1066    <tr style="background-color: #dddddd">
1067       <td>Key</td>   <td>Value</td>
1068    </tr>
1069
1070    <tr>
1071       <td>away</td>  <td>away status(boolean)</td>
1072    </tr>
1073
1074    <tr>
1075       <td>lasttalk</td>
1076       <td>last time a user was seen talking, this is the an epoch time(number of seconds since a certain date, that date depends on the OS)</td>
1077    </tr>
1078
1079    <tr>
1080       <td>nick</td>  <td>nick name</td>
1081    </tr>
1082
1083    <tr>
1084       <td>host</td>
1085       <td>host name in the form: user@host or undef if not known</td>
1086    </tr>
1087
1088    <tr>
1089       <td>prefix</td>   <td>prefix character, .e.g: @ or +</td>
1090    </tr>
1091
1092    <tr>
1093       <td>realname</td>
1094        <td>Real name or undef</td>
1095    </tr>
1096
1097    <tr>
1098       <td>selected</td>
1099       <td>selected status in the user list, only works when retrieving the user list of the focused tab. You can use the /USELECT command to select the nicks</td>
1100    </tr>
1101 </table>
1102
1103 <p>"networks"   -       list of networks and the associated settings from network list</p>
1104 <table border="1">
1105
1106    <tr style="background-color: #dddddd">
1107       <td>Key</td>   <td>Value</td>
1108    </tr>
1109
1110         <tr>
1111         <td>autojoins</td> <td>An object with the following methods:<br />
1112                 <table>
1113                         <tr>
1114                                 <td>Method</td>
1115                                 <td>Description</td>
1116                         </tr>
1117
1118                         <tr>
1119                                 <td>channels()</td>
1120                                 <td>returns a list of this networks' autojoin channels in list context, a count of the number autojoin channels in scalar context</td>
1121                         </tr>
1122
1123                         <tr>
1124                                 <td>keys()</td>
1125                                 <td>returns a list of the keys to go with the channels, the order is the same as the channels, if a channel doesn't  have a key, '' will be returned in it's place</td>
1126                         </tr>
1127
1128                         <tr>
1129                                 <td>pairs()</td>
1130                                 <td>a combination of channels() and keys(), returns a list of (channels, keys) pairs. This can be assigned to a hash for a mapping from channel to key.</td>
1131                         </tr>
1132
1133                         <tr>
1134                                 <td>as_hash()</td>
1135                                 <td>return the pairs as a hash reference</td>
1136                         </tr>
1137
1138                         <tr>
1139                                 <td>as_string()</td>
1140                                 <td>the original string that was used to construct this autojoin object, this can be used with the JOIN command to join all the channels in the autojoin list</td>
1141                         </tr>
1142
1143                         <tr>
1144                                 <td>as_array()</td>
1145                                 <td>return an array reference of hash references consisting of the keys "channel" and "key"</td>
1146                         </tr>
1147
1148                         <tr>
1149                                 <td>as_bool()</td>
1150                                 <td>returns true if the network has autojoins and false otherwise</td>
1151                         </tr>
1152                 </table>
1153         </td>
1154         </tr>
1155
1156         <tr>
1157         <td>connect_commands</td> <td>An array reference containing the connect commands for a network. An empty array if there aren't any</td>
1158         </tr>
1159
1160         <tr>
1161         <td>encoding</td> <td>the encoding for the network</td>
1162         </tr>
1163
1164
1165         <tr>
1166                 <td>flags</td>
1167                 <td>
1168                         a hash reference corresponding to the checkboxes in the network edit window
1169                         <table>
1170                                 <tr>
1171                                         <td>allow_invalid</td>
1172                                         <td>true if "Accept invalid SSL certificate" is checked</td>
1173                                 </tr>
1174
1175                                 <tr>
1176                                         <td>autoconnect</td>
1177                                         <td>true if "Auto connect to this network at startup" is checked</td>
1178                                 </tr>
1179
1180                                 <tr>
1181                                         <td>cycle</td>
1182                                         <td>true if "Connect to selected server only" is <strong>NOT</strong> checked</td>
1183                                 </tr>
1184
1185                                 <tr>
1186                                         <td>use_global</td>
1187                                         <td>true if "Use global user information" is checked</td>
1188                                 </tr>
1189
1190                                 <tr>
1191                                         <td>use_proxy</td>
1192                                         <td>true if "Bypass proxy server" is <strong>NOT</strong> checked</td>
1193                                 </tr>
1194
1195                                 <tr>
1196                                         <td>use_ssl</td>
1197                                         <td>true if "Use SSL for all the servers on this network" is checked</td>
1198                                 </tr>
1199                         </table>
1200                 </td>
1201         </tr>
1202
1203
1204         <tr>
1205                 <td>irc_nick1</td>
1206                 <td>Corresponds with the "Nick name" field in the network edit window</td>
1207         </tr>
1208
1209         <tr>
1210                 <td>irc_nick2</td>
1211                 <td>Corresponds with the "Second choice" field in the network edit window</td>
1212         </tr>
1213
1214         <tr>
1215                 <td>irc_real_name</td>
1216                 <td>Corresponds with the "Real name" field in the network edit window</td>
1217         </tr>
1218
1219
1220         <tr>
1221                 <td>irc_user_name</td>
1222                 <td>Corresponds with the "User name" field in the network edit window</td>
1223         </tr>
1224
1225
1226         <tr>
1227                 <td>network</td>
1228                 <td>Name of the network</td>
1229         </tr>
1230
1231         <tr>
1232                 <td>nickserv_password</td>
1233                 <td>Corresponds with the "Nickserv password" field in the network edit window</td>
1234         </tr>
1235
1236         <tr>
1237                 <td>selected</td>
1238                 <td>Index into the list of servers in the "servers" key, this is used if the "cycle" flag is false</td>
1239         </tr>
1240
1241         <tr>
1242                 <td>server_password</td>
1243                 <td>Corresponds with the "Server password" field in the network edit window</td>
1244         </tr>
1245
1246         <tr>
1247                 <td>servers</td>
1248                 <td>An array reference of hash references with a "host" and "port" key. If a port is not specified then 6667 will be used.</td>
1249         </tr>
1250 </table>
1251
1252 =end html
1253
1254 =head3 C<Xchat::user_info( [$nick] )>
1255
1256 =over 3
1257
1258 =item *
1259 C<$nick> -  the nick to look for, if this is not given your own nick will be
1260             used as default
1261
1262 =back
1263
1264 This function is mainly intended to be used as a shortcut for when you need
1265 to retrieve some information about only one user in a channel. Otherwise it
1266 is better to use L<get_list|xchat_get_list>.
1267 If C<$nick> is found a hash reference containing the same keys as those in the
1268 "users" list of L<get_list|xchat_get_list> is returned otherwise undef is returned.
1269 Since it relies on L<get_list|xchat_get_list> this function can only be used in a
1270 channel context.
1271
1272 =head3 C<Xchat::context_info( [$context] )>
1273
1274 =over 3
1275
1276 =item *
1277 C<$context> -  context returned from L<get_context|xchat_get_context>, L<find_context|xchat_find_context> and L<get_list|xchat_get_list>, this is the context that you want infomation about. If this is omitted, it will default to current context.
1278
1279 =back
1280
1281 This function will return the information normally retrieved with L<get_info|xchat_get_info>, except this is for the context that is passed in. The information will be returned in the form of a hash. The keys of the hash are the C<$id> you would normally supply to L<get_info|xchat_get_info> as well as all the keys that are valid for the items in the "channels" list from L<get_list|xchat_get_list>. Use of this function is more efficient than calling get_list( "channels" ) and searching through the result.
1282
1283 =begin html
1284
1285 <p>Example:</p>
1286 <div class="example">
1287 use strict;
1288 use warnings;
1289 use Xchat qw(:all); # imports all the functions documented on this page
1290
1291 register( "User Count", "0.1",
1292    "Print out the number of users on the current channel" );
1293
1294 hook_command( "UCOUNT", \&display_count );
1295
1296 sub display_count {
1297    prnt "There are " . context_info()->{users} . " users in this channel.";
1298    return EAT_XCHAT;
1299 }
1300 </div>
1301
1302 =end html
1303
1304 =head3 C<Xchat::strip_code( $string )>
1305
1306 =over 3
1307
1308 =item *
1309 C<$string>  -  string to remove codes from
1310
1311 =back
1312
1313 This function will remove bold, color, beep, reset, reverse and underline codes from C<$string>. It will also remove ANSI escape codes which might get used by certain terminal based clients. If it is called in void context C<$string> will be modified otherwise a modified copy of C<$string> is returned.
1314
1315 =head2 Examples
1316
1317 =head3 Asynchronous DNS resolution with hook_fd
1318
1319 =begin html
1320
1321 <div class="example">
1322 <code>
1323 use strict;
1324 use warnings;
1325 use Xchat qw(:all);
1326 use Net::DNS;
1327
1328 hook_command( "BGDNS", sub {
1329    my $host = $_[0][1];
1330    my $resolver = Net::DNS::Resolver->new;
1331    my $sock = $resolver->bgsend( $host );
1332
1333    hook_fd( $sock, sub {
1334       my $ready_sock = $_[0];
1335       my $packet = $resolver->bgread( $ready_sock );
1336
1337       if( $packet->authority && (my @answers = $packet->answer ) ) {
1338
1339          if( @answers ) {
1340             prnt "$host:";
1341             my $padding = " " x (length( $host ) + 2);
1342             for my $answer ( @answers ) {
1343                prnt $padding . $answer->rdatastr . ' ' . $answer->type;
1344             }
1345          }
1346       } else {
1347          prnt "Unable to resolve $host";
1348       }
1349
1350       return REMOVE;
1351    },
1352    {
1353       flags => FD_READ,
1354    });
1355
1356    return EAT_XCHAT;
1357 });
1358 </code>
1359 </div>
1360
1361 =end html
1362
1363 =head2 Contact Information
1364
1365 Contact Lian Wan Situ at E<lt>atmcmnky [at] yahoo.comE<gt> for questions, comments and
1366 corrections about this page or the Perl plugin itself.  You can also find me
1367 in #xchat on FreeNode under the nick Khisanth.