[f1e629d] | 1 | # $Id$ |
---|
| 2 | # |
---|
| 3 | # This is all linked into the binary and evaluated when perl starts up... |
---|
| 4 | # |
---|
| 5 | ##################################################################### |
---|
| 6 | ##################################################################### |
---|
[b6c067a] | 7 | # XXX NOTE: This file is sourced before almost any barnowl |
---|
| 8 | # architecture is loaded. This means, for example, that it cannot |
---|
[0337203] | 9 | # execute any owl commands. Any code that needs to do so should live |
---|
| 10 | # in BarnOwl::Hooks::_startup |
---|
[f1e629d] | 11 | |
---|
[c681337] | 12 | use strict; |
---|
| 13 | use warnings; |
---|
| 14 | |
---|
[8203afd] | 15 | package BarnOwl; |
---|
[f1e629d] | 16 | |
---|
[74fc22a] | 17 | =head1 NAME |
---|
| 18 | |
---|
| 19 | BarnOwl |
---|
| 20 | |
---|
| 21 | =head1 DESCRIPTION |
---|
| 22 | |
---|
| 23 | The BarnOwl module contains the core of BarnOwl's perl |
---|
| 24 | bindings. Source in this module is also run at startup to bootstrap |
---|
| 25 | barnowl by defining things like the default style. |
---|
| 26 | |
---|
| 27 | =for NOTE |
---|
| 28 | These following functions are defined in perlglue.xs. Keep the |
---|
| 29 | documentation here in sync with the user-visible commands defined |
---|
| 30 | there! |
---|
| 31 | |
---|
| 32 | =head2 command STRING |
---|
| 33 | |
---|
| 34 | Executes a BarnOwl command in the same manner as if the user had |
---|
| 35 | executed it at the BarnOwl command prompt. If the command returns a |
---|
| 36 | value, return it as a string, otherwise return undef. |
---|
| 37 | |
---|
| 38 | =head2 getcurmsg |
---|
| 39 | |
---|
| 40 | Returns the current message as a C<BarnOwl::Message> subclass, or |
---|
| 41 | undef if there is no message selected |
---|
| 42 | |
---|
| 43 | =head2 getnumcols |
---|
| 44 | |
---|
| 45 | Returns the width of the display window BarnOwl is currently using |
---|
| 46 | |
---|
| 47 | =head2 getidletime |
---|
| 48 | |
---|
| 49 | Returns the length of time since the user has pressed a key, in |
---|
| 50 | seconds. |
---|
| 51 | |
---|
| 52 | =head2 zephyr_getrealm |
---|
| 53 | |
---|
| 54 | Returns the zephyr realm barnowl is running in |
---|
| 55 | |
---|
| 56 | =head2 zephyr_getsender |
---|
| 57 | |
---|
| 58 | Returns the fully-qualified name of the zephyr sender barnowl is |
---|
| 59 | running as, e.g. C<nelhage@ATHENA.MIT.EDU> |
---|
| 60 | |
---|
| 61 | =head2 zephyr_zwrite COMMAND MESSAGE |
---|
| 62 | |
---|
| 63 | Sends a zephyr programmatically. C<COMMAND> should be a C<zwrite> |
---|
| 64 | command line, and C<MESSAGE> is the zephyr body to send. |
---|
| 65 | |
---|
| 66 | =head2 ztext_stylestrip STRING |
---|
| 67 | |
---|
| 68 | Strips zephyr formatting from a string and returns the result |
---|
| 69 | |
---|
[acb13bb] | 70 | =head2 zephyr_getsubs |
---|
| 71 | |
---|
| 72 | Returns the list of subscription triples <class,instance,recipient>, |
---|
| 73 | separated by newlines. |
---|
| 74 | |
---|
[74fc22a] | 75 | =head2 queue_message MESSAGE |
---|
| 76 | |
---|
| 77 | Enqueue a message in the BarnOwl message list, logging it and |
---|
| 78 | processing it appropriately. C<MESSAGE> should be an instance of |
---|
| 79 | BarnOwl::Message or a subclass. |
---|
| 80 | |
---|
| 81 | =head2 admin_message HEADER BODY |
---|
| 82 | |
---|
| 83 | Display a BarnOwl B<Admin> message, with the given header and body. |
---|
| 84 | |
---|
| 85 | =head2 start_question PROMPT CALLBACK |
---|
| 86 | |
---|
| 87 | Displays C<PROMPT> on the screen and lets the user enter a line of |
---|
| 88 | text, and calls C<CALLBACK>, which must be a perl subroutine |
---|
| 89 | reference, with the text the user entered |
---|
| 90 | |
---|
| 91 | =head2 start_password PROMPT CALLBACK |
---|
| 92 | |
---|
| 93 | Like C<start_question>, but echoes the user's input as C<*>s when they |
---|
| 94 | input. |
---|
| 95 | |
---|
[9815e2e] | 96 | =head2 start_edit_win PROMPT CALLBACK |
---|
[74fc22a] | 97 | |
---|
| 98 | Like C<start_question>, but displays C<PROMPT> on a line of its own |
---|
| 99 | and opens the editwin. If the user cancels the edit win, C<CALLBACK> |
---|
| 100 | is not invoked. |
---|
| 101 | |
---|
| 102 | =head2 get_data_dir |
---|
| 103 | |
---|
| 104 | Returns the BarnOwl system data directory, where system libraries and |
---|
| 105 | modules are stored |
---|
| 106 | |
---|
| 107 | =head2 get_config_dir |
---|
| 108 | |
---|
| 109 | Returns the BarnOwl user configuration directory, where user modules |
---|
| 110 | and configuration are stored (by default, C<$HOME/.owl>) |
---|
| 111 | |
---|
| 112 | =head2 popless_text TEXT |
---|
| 113 | |
---|
| 114 | Show a popup window containing the given C<TEXT> |
---|
| 115 | |
---|
| 116 | =head2 popless_ztext TEXT |
---|
| 117 | |
---|
| 118 | Show a popup window containing the provided zephyr-formatted C<TEXT> |
---|
| 119 | |
---|
| 120 | =head2 error STRING |
---|
| 121 | |
---|
| 122 | Reports an error and log it in `show errors'. Note that in any |
---|
| 123 | callback or hook called in perl code from BarnOwl, a C<die> will be |
---|
| 124 | caught and passed to C<error>. |
---|
| 125 | |
---|
| 126 | =head2 getnumcolors |
---|
| 127 | |
---|
| 128 | Returns the number of colors this BarnOwl is capable of displaying |
---|
| 129 | |
---|
[b07d8c8] | 130 | =head2 add_dispatch FD CALLBACK |
---|
| 131 | |
---|
| 132 | Adds a file descriptor to C<BarnOwl>'s internal C<select()> |
---|
| 133 | loop. C<CALLBACK> will be invoked whenever data is available to be |
---|
| 134 | read from C<FD>. |
---|
| 135 | |
---|
| 136 | =head2 remove_dispatch FD |
---|
| 137 | |
---|
| 138 | Remove a file descriptor previously registered via C<add_dispatch> |
---|
| 139 | |
---|
[0eaa488] | 140 | =head2 create_style NAME OBJECT |
---|
| 141 | |
---|
| 142 | Creates a new barnowl style with the given NAME defined by the given |
---|
| 143 | object. The object must have a C<description> method which returns a |
---|
| 144 | string description of the style, and a and C<format_message> method |
---|
| 145 | which accepts a C<BarnOwl::Message> object and returns a string that |
---|
| 146 | is the result of formatting the message for display. |
---|
| 147 | |
---|
[74fc22a] | 148 | =cut |
---|
| 149 | |
---|
| 150 | |
---|
[8862725] | 151 | BEGIN { |
---|
[f1e629d] | 152 | # bootstrap in C bindings and glue |
---|
[8203afd] | 153 | *owl:: = \*BarnOwl::; |
---|
| 154 | bootstrap BarnOwl 1.2; |
---|
[8862725] | 155 | }; |
---|
| 156 | |
---|
[b363d83] | 157 | use lib(get_data_dir() . "/lib"); |
---|
| 158 | use lib(get_config_dir() . "/lib"); |
---|
[8862725] | 159 | |
---|
[b363d83] | 160 | # perlconfig.c will set this to the value of the -c command-line |
---|
| 161 | # switch, if present. |
---|
[00f9a7d] | 162 | our $configfile; |
---|
| 163 | |
---|
[2e3b9c2] | 164 | if(!$configfile && -f $ENV{HOME} . "/.barnowlconf") { |
---|
| 165 | $configfile = $ENV{HOME} . "/.barnowlconf"; |
---|
| 166 | } |
---|
| 167 | $configfile ||= $ENV{HOME}."/.owlconf"; |
---|
[d03091c] | 168 | |
---|
[186cdc4] | 169 | # populate global variable space for legacy owlconf files |
---|
[f1e629d] | 170 | sub _receive_msg_legacy_wrap { |
---|
| 171 | my ($m) = @_; |
---|
| 172 | $m->legacy_populate_global(); |
---|
[0337203] | 173 | return &BarnOwl::Hooks::_receive_msg($m); |
---|
[f1e629d] | 174 | } |
---|
| 175 | |
---|
[74fc22a] | 176 | =head2 AUTOLOAD |
---|
| 177 | |
---|
| 178 | BarnOwl.pm has a C<AUTOLOAD> method that translates unused names in |
---|
| 179 | the BarnOwl:: namespace to a call to BarnOwl::command() with that |
---|
| 180 | command. Underscores are also translated to C<->s, so you can do |
---|
| 181 | e.g. C<BarnOwl::start_command()> and it will be translated into |
---|
| 182 | C<start-command>. |
---|
| 183 | |
---|
| 184 | So, if you're looking for functionality that you can't find in the |
---|
| 185 | perl interface, check C<:show commands> or C<commands.c> in the |
---|
| 186 | BarnOwl source tree -- there's a good chance it exists as a BarnOwl |
---|
| 187 | command. |
---|
| 188 | |
---|
| 189 | =head3 BUGS |
---|
| 190 | |
---|
| 191 | There are horrible quoting issues here. The AUTOLOAD simple joins your |
---|
| 192 | commands with spaces and passes them unmodified to C<::command> |
---|
| 193 | |
---|
| 194 | =cut |
---|
| 195 | |
---|
[8203afd] | 196 | # make BarnOwl::<command>("foo") be aliases to BarnOwl::command("<command> foo"); |
---|
[f1e629d] | 197 | sub AUTOLOAD { |
---|
[c681337] | 198 | our $AUTOLOAD; |
---|
[f1e629d] | 199 | my $called = $AUTOLOAD; |
---|
| 200 | $called =~ s/.*:://; |
---|
[e7ac2b6] | 201 | $called =~ s/_/-/g; |
---|
[8203afd] | 202 | return &BarnOwl::command("$called ".join(" ",@_)); |
---|
[f1e629d] | 203 | } |
---|
| 204 | |
---|
[6922edd] | 205 | =head2 new_command NAME FUNC [{ARGS}] |
---|
| 206 | |
---|
| 207 | Add a new owl command. When owl executes the command NAME, FUNC will |
---|
| 208 | be called with the arguments passed to the command, with NAME as the |
---|
| 209 | first argument. |
---|
| 210 | |
---|
| 211 | ARGS should be a hashref containing any or all of C<summary>, |
---|
[74fc22a] | 212 | C<usage>, or C<description> keys: |
---|
| 213 | |
---|
| 214 | =over 4 |
---|
| 215 | |
---|
| 216 | =item summary |
---|
| 217 | |
---|
| 218 | A one-line summary of the purpose of the command |
---|
| 219 | |
---|
| 220 | =item usage |
---|
| 221 | |
---|
| 222 | A one-line usage synopsis, showing available options and syntax |
---|
| 223 | |
---|
| 224 | =item description |
---|
| 225 | |
---|
| 226 | A longer description of the syntax and semantics of the command, |
---|
| 227 | explaining usage and options |
---|
| 228 | |
---|
| 229 | =back |
---|
[6922edd] | 230 | |
---|
| 231 | =cut |
---|
| 232 | |
---|
| 233 | sub new_command { |
---|
| 234 | my $name = shift; |
---|
| 235 | my $func = shift; |
---|
| 236 | my $args = shift || {}; |
---|
| 237 | my %args = ( |
---|
[8757122] | 238 | summary => "", |
---|
| 239 | usage => "", |
---|
| 240 | description => "", |
---|
[6922edd] | 241 | %{$args} |
---|
| 242 | ); |
---|
| 243 | |
---|
[25cccdc] | 244 | BarnOwl::Internal::new_command($name, $func, $args{summary}, $args{usage}, $args{description}); |
---|
[6922edd] | 245 | } |
---|
| 246 | |
---|
[cd57601] | 247 | =head2 new_variable_int NAME [{ARGS}] |
---|
| 248 | |
---|
| 249 | =head2 new_variable_bool NAME [{ARGS}] |
---|
| 250 | |
---|
| 251 | =head2 new_variable_string NAME [{ARGS}] |
---|
| 252 | |
---|
| 253 | Add a new owl variable, either an int, a bool, or a string, with the |
---|
| 254 | specified name. |
---|
| 255 | |
---|
| 256 | ARGS can optionally contain the following keys: |
---|
| 257 | |
---|
| 258 | =over 4 |
---|
| 259 | |
---|
| 260 | =item default |
---|
| 261 | |
---|
| 262 | The default and initial value for the variable |
---|
| 263 | |
---|
| 264 | =item summary |
---|
| 265 | |
---|
| 266 | A one-line summary of the variable's purpose |
---|
| 267 | |
---|
| 268 | =item description |
---|
| 269 | |
---|
| 270 | A longer description of the function of the variable |
---|
| 271 | |
---|
| 272 | =back |
---|
| 273 | |
---|
| 274 | =cut |
---|
| 275 | |
---|
[a695a68] | 276 | sub new_variable_int { |
---|
[25cccdc] | 277 | unshift @_, \&BarnOwl::Internal::new_variable_int, 0; |
---|
[a695a68] | 278 | goto \&_new_variable; |
---|
| 279 | } |
---|
| 280 | |
---|
| 281 | sub new_variable_bool { |
---|
[25cccdc] | 282 | unshift @_, \&BarnOwl::Internal::new_variable_bool, 0; |
---|
[a695a68] | 283 | goto \&_new_variable; |
---|
| 284 | } |
---|
| 285 | |
---|
| 286 | sub new_variable_string { |
---|
[25cccdc] | 287 | unshift @_, \&BarnOwl::Internal::new_variable_string, ""; |
---|
[a695a68] | 288 | goto \&_new_variable; |
---|
| 289 | } |
---|
| 290 | |
---|
| 291 | sub _new_variable { |
---|
| 292 | my $func = shift; |
---|
| 293 | my $default_default = shift; |
---|
| 294 | my $name = shift; |
---|
| 295 | my $args = shift || {}; |
---|
| 296 | my %args = ( |
---|
| 297 | summary => "", |
---|
| 298 | description => "", |
---|
| 299 | default => $default_default, |
---|
| 300 | %{$args}); |
---|
| 301 | $func->($name, $args{default}, $args{summary}, $args{description}); |
---|
| 302 | } |
---|
| 303 | |
---|
[5b75e8b] | 304 | =head2 quote STRING |
---|
| 305 | |
---|
| 306 | Return a version of STRING fully quoted to survive processing by |
---|
| 307 | BarnOwl's command parser. |
---|
| 308 | |
---|
| 309 | =cut |
---|
| 310 | |
---|
| 311 | sub quote { |
---|
| 312 | my $str = shift; |
---|
[740d5f7] | 313 | return "''" if $str eq ''; |
---|
| 314 | if ($str !~ /['" ]/) { |
---|
[5b75e8b] | 315 | return "$str"; |
---|
| 316 | } |
---|
| 317 | if ($str !~ /'/) { |
---|
| 318 | return "'$str'"; |
---|
| 319 | } |
---|
| 320 | $str =~ s/"/"'"'"/g; |
---|
| 321 | return '"' . $str . '"'; |
---|
| 322 | } |
---|
| 323 | |
---|
[f1e629d] | 324 | ##################################################################### |
---|
| 325 | ##################################################################### |
---|
| 326 | |
---|
[8203afd] | 327 | package BarnOwl::Message; |
---|
[f1e629d] | 328 | |
---|
[dd16bdd] | 329 | sub new { |
---|
| 330 | my $class = shift; |
---|
| 331 | my %args = (@_); |
---|
| 332 | if($class eq __PACKAGE__ && $args{type}) { |
---|
[8203afd] | 333 | $class = "BarnOwl::Message::" . ucfirst $args{type}; |
---|
[dd16bdd] | 334 | } |
---|
| 335 | return bless {%args}, $class; |
---|
| 336 | } |
---|
| 337 | |
---|
[f1e629d] | 338 | sub type { return shift->{"type"}; } |
---|
| 339 | sub direction { return shift->{"direction"}; } |
---|
| 340 | sub time { return shift->{"time"}; } |
---|
| 341 | sub id { return shift->{"id"}; } |
---|
| 342 | sub body { return shift->{"body"}; } |
---|
| 343 | sub sender { return shift->{"sender"}; } |
---|
| 344 | sub recipient { return shift->{"recipient"}; } |
---|
| 345 | sub login { return shift->{"login"}; } |
---|
[216c734] | 346 | sub is_private { return shift->{"private"}; } |
---|
[f1e629d] | 347 | |
---|
| 348 | sub is_login { return shift->login eq "login"; } |
---|
| 349 | sub is_logout { return shift->login eq "logout"; } |
---|
| 350 | sub is_loginout { my $m=shift; return ($m->is_login or $m->is_logout); } |
---|
| 351 | sub is_incoming { return (shift->{"direction"} eq "in"); } |
---|
| 352 | sub is_outgoing { return (shift->{"direction"} eq "out"); } |
---|
| 353 | |
---|
| 354 | sub is_deleted { return shift->{"deleted"}; } |
---|
| 355 | |
---|
| 356 | sub is_admin { return (shift->{"type"} eq "admin"); } |
---|
| 357 | sub is_generic { return (shift->{"type"} eq "generic"); } |
---|
[421c8ef7] | 358 | sub is_zephyr { return (shift->{"type"} eq "zephyr"); } |
---|
[467aa16] | 359 | sub is_aim { return (shift->{"type"} eq "AIM"); } |
---|
[dd16bdd] | 360 | sub is_jabber { return (shift->{"type"} eq "jabber"); } |
---|
[421c8ef7] | 361 | sub is_icq { return (shift->{"type"} eq "icq"); } |
---|
| 362 | sub is_yahoo { return (shift->{"type"} eq "yahoo"); } |
---|
| 363 | sub is_msn { return (shift->{"type"} eq "msn"); } |
---|
| 364 | sub is_loopback { return (shift->{"type"} eq "loopback"); } |
---|
[f1e629d] | 365 | |
---|
| 366 | # These are overridden by appropriate message types |
---|
| 367 | sub is_ping { return 0; } |
---|
| 368 | sub is_mail { return 0; } |
---|
[3c9012b] | 369 | sub is_personal { return shift->is_private; } |
---|
[f1e629d] | 370 | sub class { return undef; } |
---|
| 371 | sub instance { return undef; } |
---|
| 372 | sub realm { return undef; } |
---|
| 373 | sub opcode { return undef; } |
---|
| 374 | sub header { return undef; } |
---|
| 375 | sub host { return undef; } |
---|
| 376 | sub hostname { return undef; } |
---|
| 377 | sub auth { return undef; } |
---|
| 378 | sub fields { return undef; } |
---|
| 379 | sub zsig { return undef; } |
---|
| 380 | sub zwriteline { return undef; } |
---|
[87c6ef1] | 381 | sub login_host { return undef; } |
---|
| 382 | sub login_tty { return undef; } |
---|
[f1e629d] | 383 | |
---|
[57cf4f9] | 384 | # This is for back-compat with old messages that set these properties |
---|
| 385 | # New protocol implementations are encourages to user override these |
---|
| 386 | # methods. |
---|
| 387 | sub replycmd { return shift->{replycmd}}; |
---|
| 388 | sub replysendercmd { return shift->{replysendercmd}}; |
---|
| 389 | |
---|
[ae47efb] | 390 | sub pretty_sender { return shift->sender; } |
---|
| 391 | sub pretty_recipient { return shift->recipient; } |
---|
[f1e629d] | 392 | |
---|
[dfaa47d] | 393 | # Override if you want a context (instance, network, etc.) on personals |
---|
| 394 | sub personal_context { return ""; } |
---|
| 395 | |
---|
[f1e629d] | 396 | sub delete { |
---|
| 397 | my ($m) = @_; |
---|
[8203afd] | 398 | &BarnOwl::command("delete --id ".$m->id); |
---|
[f1e629d] | 399 | } |
---|
| 400 | |
---|
| 401 | sub undelete { |
---|
| 402 | my ($m) = @_; |
---|
[8203afd] | 403 | &BarnOwl::command("undelete --id ".$m->id); |
---|
[f1e629d] | 404 | } |
---|
| 405 | |
---|
| 406 | # Serializes the message into something similar to the zwgc->vt format |
---|
| 407 | sub serialize { |
---|
| 408 | my ($this) = @_; |
---|
| 409 | my $s; |
---|
| 410 | for my $f (keys %$this) { |
---|
| 411 | my $val = $this->{$f}; |
---|
| 412 | if (ref($val) eq "ARRAY") { |
---|
| 413 | for my $i (0..@$val-1) { |
---|
| 414 | my $aval; |
---|
| 415 | $aval = $val->[$i]; |
---|
| 416 | $aval =~ s/\n/\n$f.$i: /g; |
---|
[186cdc4] | 417 | $s .= "$f.$i: $aval\n"; |
---|
[f1e629d] | 418 | } |
---|
| 419 | } else { |
---|
| 420 | $val =~ s/\n/\n$f: /g; |
---|
| 421 | $s .= "$f: $val\n"; |
---|
| 422 | } |
---|
| 423 | } |
---|
| 424 | return $s; |
---|
| 425 | } |
---|
| 426 | |
---|
| 427 | # Populate the annoying legacy global variables |
---|
| 428 | sub legacy_populate_global { |
---|
| 429 | my ($m) = @_; |
---|
[8203afd] | 430 | $BarnOwl::direction = $m->direction ; |
---|
| 431 | $BarnOwl::type = $m->type ; |
---|
| 432 | $BarnOwl::id = $m->id ; |
---|
| 433 | $BarnOwl::class = $m->class ; |
---|
| 434 | $BarnOwl::instance = $m->instance ; |
---|
| 435 | $BarnOwl::recipient = $m->recipient ; |
---|
| 436 | $BarnOwl::sender = $m->sender ; |
---|
| 437 | $BarnOwl::realm = $m->realm ; |
---|
| 438 | $BarnOwl::opcode = $m->opcode ; |
---|
| 439 | $BarnOwl::zsig = $m->zsig ; |
---|
| 440 | $BarnOwl::msg = $m->body ; |
---|
| 441 | $BarnOwl::time = $m->time ; |
---|
| 442 | $BarnOwl::host = $m->host ; |
---|
| 443 | $BarnOwl::login = $m->login ; |
---|
| 444 | $BarnOwl::auth = $m->auth ; |
---|
[f1e629d] | 445 | if ($m->fields) { |
---|
[8203afd] | 446 | @BarnOwl::fields = @{$m->fields}; |
---|
[f1e629d] | 447 | @main::fields = @{$m->fields}; |
---|
| 448 | } else { |
---|
[8203afd] | 449 | @BarnOwl::fields = undef; |
---|
[f1e629d] | 450 | @main::fields = undef; |
---|
| 451 | } |
---|
| 452 | } |
---|
| 453 | |
---|
[25729b2] | 454 | sub smartfilter { |
---|
[0337203] | 455 | die("smartfilter not supported for this message\n"); |
---|
[25729b2] | 456 | } |
---|
| 457 | |
---|
[6e6ded7] | 458 | # Display fields -- overridden by subclasses when needed |
---|
| 459 | sub login_type {""} |
---|
| 460 | sub login_extra {""} |
---|
| 461 | sub long_sender {""} |
---|
| 462 | |
---|
| 463 | # The context in which a non-personal message was sent, e.g. a chat or |
---|
| 464 | # class |
---|
| 465 | sub context {""} |
---|
| 466 | |
---|
| 467 | # Some indicator of context *within* $self->context. e.g. the zephyr |
---|
| 468 | # instance |
---|
| 469 | sub subcontext {""} |
---|
| 470 | |
---|
[f1e629d] | 471 | ##################################################################### |
---|
| 472 | ##################################################################### |
---|
| 473 | |
---|
[8203afd] | 474 | package BarnOwl::Message::Admin; |
---|
[f1e629d] | 475 | |
---|
[8203afd] | 476 | use base qw( BarnOwl::Message ); |
---|
[f1e629d] | 477 | |
---|
| 478 | sub header { return shift->{"header"}; } |
---|
| 479 | |
---|
| 480 | ##################################################################### |
---|
| 481 | ##################################################################### |
---|
| 482 | |
---|
[8203afd] | 483 | package BarnOwl::Message::Generic; |
---|
[f1e629d] | 484 | |
---|
[8203afd] | 485 | use base qw( BarnOwl::Message ); |
---|
[f1e629d] | 486 | |
---|
| 487 | ##################################################################### |
---|
| 488 | ##################################################################### |
---|
| 489 | |
---|
[186cdc4] | 490 | package BarnOwl::Message::Loopback; |
---|
| 491 | |
---|
| 492 | use base qw( BarnOwl::Message ); |
---|
| 493 | |
---|
[cb06a43] | 494 | # all loopback messages are private |
---|
| 495 | sub is_private { |
---|
[186cdc4] | 496 | return 1; |
---|
| 497 | } |
---|
| 498 | |
---|
[740d5f7] | 499 | sub replycmd {return 'loopwrite';} |
---|
| 500 | sub replysendercmd {return 'loopwrite';} |
---|
| 501 | |
---|
[186cdc4] | 502 | ##################################################################### |
---|
| 503 | ##################################################################### |
---|
| 504 | |
---|
[8203afd] | 505 | package BarnOwl::Message::AIM; |
---|
[f1e629d] | 506 | |
---|
[8203afd] | 507 | use base qw( BarnOwl::Message ); |
---|
[f1e629d] | 508 | |
---|
[cb06a43] | 509 | # all non-loginout AIM messages are private for now... |
---|
| 510 | sub is_private { |
---|
[f1e629d] | 511 | return !(shift->is_loginout); |
---|
| 512 | } |
---|
| 513 | |
---|
[740d5f7] | 514 | sub replycmd { |
---|
| 515 | my $self = shift; |
---|
| 516 | if ($self->is_incoming) { |
---|
| 517 | return "aimwrite " . BarnOwl::quote($self->sender); |
---|
| 518 | } else { |
---|
| 519 | return "aimwrite " . BarnOwl::quote($self->recipient); |
---|
| 520 | } |
---|
| 521 | } |
---|
| 522 | |
---|
| 523 | sub replysendercmd { |
---|
| 524 | return shift->replycmd; |
---|
| 525 | } |
---|
| 526 | |
---|
[f1e629d] | 527 | ##################################################################### |
---|
| 528 | ##################################################################### |
---|
| 529 | |
---|
[8203afd] | 530 | package BarnOwl::Message::Zephyr; |
---|
[f1e629d] | 531 | |
---|
[740d5f7] | 532 | use constant WEBZEPHYR_PRINCIPAL => "daemon.webzephyr"; |
---|
| 533 | use constant WEBZEPHYR_CLASS => "webzephyr"; |
---|
| 534 | use constant WEBZEPHYR_OPCODE => "webzephyr"; |
---|
| 535 | |
---|
[8203afd] | 536 | use base qw( BarnOwl::Message ); |
---|
[f1e629d] | 537 | |
---|
[740d5f7] | 538 | sub strip_realm { |
---|
| 539 | my $sender = shift; |
---|
| 540 | my $realm = BarnOwl::zephyr_getrealm(); |
---|
| 541 | $sender =~ s/\@$realm$//; |
---|
| 542 | return $sender; |
---|
| 543 | } |
---|
| 544 | |
---|
[6e6ded7] | 545 | sub login_type { |
---|
| 546 | return (shift->zsig eq "") ? "(PSEUDO)" : ""; |
---|
| 547 | } |
---|
| 548 | |
---|
| 549 | sub login_extra { |
---|
| 550 | my $m = shift; |
---|
| 551 | return undef if (!$m->is_loginout); |
---|
| 552 | my $s = lc($m->host); |
---|
| 553 | $s .= " " . $m->login_tty if defined $m->login_tty; |
---|
| 554 | return $s; |
---|
| 555 | } |
---|
| 556 | |
---|
| 557 | sub long_sender { |
---|
| 558 | my $m = shift; |
---|
| 559 | return $m->zsig; |
---|
| 560 | } |
---|
| 561 | |
---|
| 562 | sub context { |
---|
| 563 | return shift->class; |
---|
| 564 | } |
---|
| 565 | |
---|
| 566 | sub subcontext { |
---|
| 567 | return shift->instance; |
---|
| 568 | } |
---|
| 569 | |
---|
[186cdc4] | 570 | sub login_tty { |
---|
[f1e629d] | 571 | my ($m) = @_; |
---|
| 572 | return undef if (!$m->is_loginout); |
---|
| 573 | return $m->fields->[2]; |
---|
| 574 | } |
---|
| 575 | |
---|
[186cdc4] | 576 | sub login_host { |
---|
[f1e629d] | 577 | my ($m) = @_; |
---|
| 578 | return undef if (!$m->is_loginout); |
---|
| 579 | return $m->fields->[0]; |
---|
| 580 | } |
---|
| 581 | |
---|
| 582 | sub zwriteline { return shift->{"zwriteline"}; } |
---|
| 583 | |
---|
| 584 | sub is_ping { return (lc(shift->opcode) eq "ping"); } |
---|
| 585 | |
---|
[186cdc4] | 586 | sub is_personal { |
---|
[f1e629d] | 587 | my ($m) = @_; |
---|
| 588 | return ((lc($m->class) eq "message") |
---|
| 589 | && $m->is_private); |
---|
| 590 | } |
---|
| 591 | |
---|
[186cdc4] | 592 | sub is_mail { |
---|
[f1e629d] | 593 | my ($m) = @_; |
---|
| 594 | return ((lc($m->class) eq "mail") && $m->is_private); |
---|
| 595 | } |
---|
| 596 | |
---|
| 597 | sub pretty_sender { |
---|
| 598 | my ($m) = @_; |
---|
[740d5f7] | 599 | return strip_realm($m->sender); |
---|
[f1e629d] | 600 | } |
---|
| 601 | |
---|
[ae47efb] | 602 | sub pretty_recipient { |
---|
| 603 | my ($m) = @_; |
---|
[740d5f7] | 604 | return strip_realm($m->recipient); |
---|
[ae47efb] | 605 | } |
---|
| 606 | |
---|
[dfaa47d] | 607 | sub personal_context { |
---|
| 608 | my ($m) = @_; |
---|
| 609 | if (lc($m->instance) eq "personal") { |
---|
| 610 | return ""; |
---|
| 611 | } else { |
---|
| 612 | return "-i " . $m->instance; |
---|
| 613 | } |
---|
| 614 | } |
---|
| 615 | |
---|
[f1e629d] | 616 | # These are arguably zephyr-specific |
---|
| 617 | sub class { return shift->{"class"}; } |
---|
| 618 | sub instance { return shift->{"instance"}; } |
---|
| 619 | sub realm { return shift->{"realm"}; } |
---|
| 620 | sub opcode { return shift->{"opcode"}; } |
---|
| 621 | sub host { return shift->{"hostname"}; } |
---|
| 622 | sub hostname { return shift->{"hostname"}; } |
---|
| 623 | sub header { return shift->{"header"}; } |
---|
| 624 | sub auth { return shift->{"auth"}; } |
---|
| 625 | sub fields { return shift->{"fields"}; } |
---|
| 626 | sub zsig { return shift->{"zsig"}; } |
---|
| 627 | |
---|
[740d5f7] | 628 | sub zephyr_cc { |
---|
| 629 | my $self = shift; |
---|
| 630 | return $1 if $self->body =~ /^\s*cc:\s+([^\n]+)/i; |
---|
| 631 | return undef; |
---|
| 632 | } |
---|
| 633 | |
---|
| 634 | sub replycmd { |
---|
| 635 | my $self = shift; |
---|
| 636 | my $sender = shift; |
---|
| 637 | $sender = 0 unless defined $sender; |
---|
| 638 | my ($class, $instance, $to, $cc); |
---|
| 639 | if($self->is_outgoing) { |
---|
| 640 | return $self->{zwriteline}; |
---|
| 641 | } |
---|
| 642 | |
---|
| 643 | if($sender && $self->opcode eq WEBZEPHYR_OPCODE) { |
---|
| 644 | $class = WEBZEPHYR_CLASS; |
---|
[ca53b77] | 645 | $instance = $self->pretty_sender; |
---|
[2b6de9d] | 646 | $instance =~ s/-webzephyr$//; |
---|
[740d5f7] | 647 | $to = WEBZEPHYR_PRINCIPAL; |
---|
| 648 | } elsif($self->class eq WEBZEPHYR_CLASS |
---|
| 649 | && $self->is_loginout) { |
---|
| 650 | $class = WEBZEPHYR_CLASS; |
---|
| 651 | $instance = $self->instance; |
---|
| 652 | $to = WEBZEPHYR_PRINCIPAL; |
---|
[f0f919d] | 653 | } elsif($self->is_loginout) { |
---|
| 654 | $class = 'MESSAGE'; |
---|
| 655 | $instance = 'PERSONAL'; |
---|
| 656 | $to = $self->sender; |
---|
| 657 | } elsif($sender && !$self->is_private) { |
---|
| 658 | # Possible future feature: (Optionally?) include the class and/or |
---|
| 659 | # instance of the message being replied to in the instance of the |
---|
| 660 | # outgoing personal reply |
---|
[740d5f7] | 661 | $class = 'MESSAGE'; |
---|
| 662 | $instance = 'PERSONAL'; |
---|
| 663 | $to = $self->sender; |
---|
| 664 | } else { |
---|
| 665 | $class = $self->class; |
---|
| 666 | $instance = $self->instance; |
---|
| 667 | $to = $self->recipient; |
---|
| 668 | $cc = $self->zephyr_cc(); |
---|
| 669 | if($to eq '*' || $to eq '') { |
---|
| 670 | $to = ''; |
---|
| 671 | } elsif($to !~ /^@/) { |
---|
| 672 | $to = $self->sender; |
---|
| 673 | } |
---|
| 674 | } |
---|
| 675 | |
---|
| 676 | my $cmd; |
---|
| 677 | if(lc $self->opcode eq 'crypt') { |
---|
| 678 | $cmd = 'zcrypt'; |
---|
| 679 | } else { |
---|
| 680 | $cmd = 'zwrite'; |
---|
| 681 | } |
---|
| 682 | |
---|
| 683 | if (lc $class ne 'message') { |
---|
[ca53b77] | 684 | $cmd .= " -c " . BarnOwl::quote($class); |
---|
[740d5f7] | 685 | } |
---|
| 686 | if (lc $instance ne 'personal') { |
---|
[ca53b77] | 687 | $cmd .= " -i " . BarnOwl::quote($instance); |
---|
[740d5f7] | 688 | } |
---|
| 689 | if ($to ne '') { |
---|
| 690 | $to = strip_realm($to); |
---|
| 691 | if (defined $cc) { |
---|
| 692 | my @cc = grep /^[^-]/, ($to, split /\s+/, $cc); |
---|
| 693 | my %cc = map {$_ => 1} @cc; |
---|
| 694 | delete $cc{strip_realm(BarnOwl::zephyr_getsender())}; |
---|
| 695 | @cc = keys %cc; |
---|
| 696 | $cmd .= " -C " . join(" ", @cc); |
---|
| 697 | } else { |
---|
| 698 | if(BarnOwl::getvar('smartstrip') eq 'on') { |
---|
| 699 | $to = BarnOwl::zephyr_smartstrip_user($to); |
---|
| 700 | } |
---|
| 701 | $cmd .= " $to"; |
---|
| 702 | } |
---|
| 703 | } |
---|
| 704 | return $cmd; |
---|
| 705 | } |
---|
| 706 | |
---|
| 707 | sub replysendercmd { |
---|
| 708 | my $self = shift; |
---|
| 709 | return $self->replycmd(1); |
---|
| 710 | } |
---|
| 711 | |
---|
| 712 | ##################################################################### |
---|
[f1e629d] | 713 | ##################################################################### |
---|
| 714 | ##################################################################### |
---|
[7e470da] | 715 | |
---|
[0337203] | 716 | package BarnOwl::Hook; |
---|
[7e470da] | 717 | |
---|
[1a64de6] | 718 | =head1 BarnOwl::Hook |
---|
| 719 | |
---|
| 720 | =head1 DESCRIPTION |
---|
| 721 | |
---|
| 722 | A C<BarnOwl::Hook> represents a list of functions to be triggered on |
---|
| 723 | some event. C<BarnOwl> exports a default set of these (see |
---|
| 724 | C<BarnOwl::Hooks>), but can also be created and used by module code. |
---|
| 725 | |
---|
| 726 | =head2 new |
---|
| 727 | |
---|
| 728 | Creates a new Hook object |
---|
| 729 | |
---|
| 730 | =cut |
---|
| 731 | |
---|
[0337203] | 732 | sub new { |
---|
| 733 | my $class = shift; |
---|
| 734 | return bless [], $class; |
---|
| 735 | } |
---|
[7e470da] | 736 | |
---|
[1a64de6] | 737 | =head2 run [ARGS] |
---|
| 738 | |
---|
| 739 | Calls each of the functions registered with this hook with the given |
---|
| 740 | arguments. |
---|
| 741 | |
---|
| 742 | =cut |
---|
| 743 | |
---|
[0337203] | 744 | sub run { |
---|
| 745 | my $self = shift; |
---|
| 746 | my @args = @_; |
---|
[167044b] | 747 | return map {$self->_run($_,@args)} @$self; |
---|
| 748 | } |
---|
| 749 | |
---|
| 750 | sub _run { |
---|
| 751 | my $self = shift; |
---|
| 752 | my $fn = shift; |
---|
| 753 | my @args = @_; |
---|
| 754 | no strict 'refs'; |
---|
| 755 | return $fn->(@args); |
---|
[7e470da] | 756 | } |
---|
[0337203] | 757 | |
---|
[1a64de6] | 758 | =head2 add SUBREF |
---|
| 759 | |
---|
| 760 | Registers a given subroutine with this hook |
---|
| 761 | |
---|
| 762 | =cut |
---|
| 763 | |
---|
[0337203] | 764 | sub add { |
---|
| 765 | my $self = shift; |
---|
| 766 | my $func = shift; |
---|
[167044b] | 767 | die("Not a coderef!") unless ref($func) eq 'CODE' || !ref($func); |
---|
| 768 | return if grep {$_ eq $func} @$self; |
---|
[0337203] | 769 | push @$self, $func; |
---|
[7e470da] | 770 | } |
---|
| 771 | |
---|
[1a64de6] | 772 | =head2 clear |
---|
| 773 | |
---|
| 774 | Remove all functions registered with this hook. |
---|
| 775 | |
---|
| 776 | =cut |
---|
| 777 | |
---|
[0337203] | 778 | sub clear { |
---|
| 779 | my $self = shift; |
---|
| 780 | @$self = (); |
---|
[7e470da] | 781 | } |
---|
| 782 | |
---|
[0337203] | 783 | package BarnOwl::Hooks; |
---|
[7e470da] | 784 | |
---|
[1a64de6] | 785 | =head1 BarnOwl::Hooks |
---|
| 786 | |
---|
| 787 | =head1 DESCRIPTION |
---|
| 788 | |
---|
| 789 | C<BarnOwl::Hooks> exports a set of C<BarnOwl::Hook> objects made |
---|
| 790 | available by BarnOwl internally. |
---|
| 791 | |
---|
| 792 | =head2 USAGE |
---|
| 793 | |
---|
| 794 | Modules wishing to respond to events in BarnOwl should register |
---|
| 795 | functions with these hooks. |
---|
| 796 | |
---|
| 797 | =head2 EXPORTS |
---|
| 798 | |
---|
| 799 | None by default. Either import the hooks you need explicitly, or refer |
---|
| 800 | to them with fully-qualified names. Available hooks are: |
---|
| 801 | |
---|
| 802 | =over 4 |
---|
| 803 | |
---|
| 804 | =item $startup |
---|
| 805 | |
---|
| 806 | Called on BarnOwl startup, and whenever modules are |
---|
| 807 | reloaded. Functions registered with the C<$startup> hook get a true |
---|
| 808 | argument if this is a reload, and false if this is a true startup |
---|
| 809 | |
---|
| 810 | =item $shutdown |
---|
| 811 | |
---|
| 812 | Called before BarnOwl shutdown |
---|
| 813 | |
---|
| 814 | =item $receiveMessage |
---|
| 815 | |
---|
[e9708d2] | 816 | Called with a C<BarnOwl::Message> object every time BarnOwl receives a |
---|
| 817 | new incoming message. |
---|
| 818 | |
---|
| 819 | =item $newMessage |
---|
| 820 | |
---|
| 821 | Called with a C<BarnOwl::Message> object every time BarnOwl appends |
---|
| 822 | I<any> new message to the message list. |
---|
[1a64de6] | 823 | |
---|
| 824 | =item $mainLoop |
---|
| 825 | |
---|
[b07d8c8] | 826 | Called on every pass through the C<BarnOwl> main loop. This is |
---|
| 827 | guaranteed to be called at least once/sec and may be called more |
---|
| 828 | frequently. |
---|
[1a64de6] | 829 | |
---|
| 830 | =item $getBuddyList |
---|
| 831 | |
---|
| 832 | Called to display buddy lists for all protocol handlers. The result |
---|
| 833 | from every function registered with this hook will be appended and |
---|
| 834 | displayed in a popup window, with zephyr formatting parsed. |
---|
| 835 | |
---|
[799b60e] | 836 | =item $getQuickstart |
---|
| 837 | |
---|
| 838 | Called by :show quickstart to display 2-5 lines of help on how to |
---|
| 839 | start using the protocol. The result from every function registered |
---|
| 840 | with this hook will be appended and displayed in an admin message, |
---|
| 841 | with zephyr formatting parsed. The format should be |
---|
| 842 | "@b(Protocol:)\nSome text.\nMore text.\n" |
---|
| 843 | |
---|
[1a64de6] | 844 | =back |
---|
| 845 | |
---|
| 846 | =cut |
---|
| 847 | |
---|
[0337203] | 848 | use Exporter; |
---|
| 849 | |
---|
| 850 | our @EXPORT_OK = qw($startup $shutdown |
---|
[0f9eca7] | 851 | $receiveMessage $newMessage |
---|
[799b60e] | 852 | $mainLoop $getBuddyList |
---|
| 853 | $getQuickstart); |
---|
[0337203] | 854 | |
---|
| 855 | our %EXPORT_TAGS = (all => [@EXPORT_OK]); |
---|
| 856 | |
---|
| 857 | our $startup = BarnOwl::Hook->new; |
---|
| 858 | our $shutdown = BarnOwl::Hook->new; |
---|
| 859 | our $receiveMessage = BarnOwl::Hook->new; |
---|
[0f9eca7] | 860 | our $newMessage = BarnOwl::Hook->new; |
---|
[0337203] | 861 | our $mainLoop = BarnOwl::Hook->new; |
---|
| 862 | our $getBuddyList = BarnOwl::Hook->new; |
---|
[799b60e] | 863 | our $getQuickstart = BarnOwl::Hook->new; |
---|
[0337203] | 864 | |
---|
| 865 | # Internal startup/shutdown routines called by the C code |
---|
[7e470da] | 866 | |
---|
[2650a10] | 867 | sub _load_perl_commands { |
---|
| 868 | # Load builtin perl commands |
---|
| 869 | BarnOwl::new_command(style => \&BarnOwl::Style::style_command, |
---|
| 870 | { |
---|
| 871 | summary => "creates a new style", |
---|
| 872 | usage => "style <name> perl <function_name>", |
---|
| 873 | description => |
---|
| 874 | "A style named <name> will be created that will\n" . |
---|
| 875 | "format messages using the perl function <function_name>.\n\n" . |
---|
| 876 | "SEE ALSO: show styles, view -s, filter -s\n\n" . |
---|
| 877 | "DEPRECATED in favor of BarnOwl::create_style(NAME, OBJECT)", |
---|
| 878 | }); |
---|
| 879 | } |
---|
| 880 | |
---|
[b6c067a] | 881 | sub _load_owlconf { |
---|
| 882 | # load the config file |
---|
| 883 | if ( -r $BarnOwl::configfile ) { |
---|
| 884 | undef $@; |
---|
[e8bc8ac] | 885 | package main; |
---|
[b6c067a] | 886 | do $BarnOwl::configfile; |
---|
[e2257be] | 887 | if($@) { |
---|
| 888 | BarnOwl::error("In startup: $@\n"); |
---|
| 889 | return; |
---|
| 890 | } |
---|
[e8bc8ac] | 891 | package BarnOwl; |
---|
[39dc159] | 892 | if(*BarnOwl::format_msg{CODE}) { |
---|
| 893 | # if the config defines a legacy formatting function, add 'perl' as a style |
---|
[b67ab6b] | 894 | BarnOwl::create_style("perl", BarnOwl::Style::Legacy->new( |
---|
| 895 | "BarnOwl::format_msg", |
---|
| 896 | "User-defined perl style that calls BarnOwl::format_msg" |
---|
| 897 | . " with legacy global variable support", |
---|
| 898 | 1)); |
---|
| 899 | BarnOwl::set("-q default_style perl"); |
---|
[39dc159] | 900 | } |
---|
[b6c067a] | 901 | } |
---|
| 902 | } |
---|
| 903 | |
---|
[b0c8011] | 904 | # These are the internal hooks called by the barnowl C code, which |
---|
| 905 | # take care of dispatching to the appropriate perl hooks, and deal |
---|
| 906 | # with compatibility by calling the old, fixed-name hooks. |
---|
| 907 | |
---|
[0337203] | 908 | sub _startup { |
---|
[2650a10] | 909 | _load_perl_commands(); |
---|
[0337203] | 910 | _load_owlconf(); |
---|
[8203afd] | 911 | |
---|
[0337203] | 912 | if(eval {require BarnOwl::ModuleLoader}) { |
---|
| 913 | eval { |
---|
| 914 | BarnOwl::ModuleLoader->load_all; |
---|
| 915 | }; |
---|
[f6b319c] | 916 | BarnOwl::error("$@") if $@; |
---|
| 917 | |
---|
[0337203] | 918 | } else { |
---|
| 919 | BarnOwl::error("Can't load BarnOwl::ModuleLoader, loadable module support disabled:\n$@"); |
---|
| 920 | } |
---|
| 921 | |
---|
[836e6263] | 922 | $startup->run(0); |
---|
[8203afd] | 923 | BarnOwl::startup() if *BarnOwl::startup{CODE}; |
---|
| 924 | } |
---|
| 925 | |
---|
[0337203] | 926 | sub _shutdown { |
---|
| 927 | $shutdown->run; |
---|
| 928 | |
---|
[8203afd] | 929 | BarnOwl::shutdown() if *BarnOwl::shutdown{CODE}; |
---|
| 930 | } |
---|
| 931 | |
---|
[0337203] | 932 | sub _receive_msg { |
---|
[7e470da] | 933 | my $m = shift; |
---|
[0337203] | 934 | |
---|
| 935 | $receiveMessage->run($m); |
---|
| 936 | |
---|
[8203afd] | 937 | BarnOwl::receive_msg($m) if *BarnOwl::receive_msg{CODE}; |
---|
[7e470da] | 938 | } |
---|
| 939 | |
---|
[0f9eca7] | 940 | sub _new_msg { |
---|
| 941 | my $m = shift; |
---|
| 942 | |
---|
| 943 | $newMessage->run($m); |
---|
| 944 | |
---|
| 945 | BarnOwl::new_msg($m) if *BarnOwl::new_msg{CODE}; |
---|
| 946 | } |
---|
| 947 | |
---|
[0337203] | 948 | sub _mainloop_hook { |
---|
| 949 | $mainLoop->run; |
---|
| 950 | BarnOwl::mainloop_hook() if *BarnOwl::mainloop_hook{CODE}; |
---|
| 951 | } |
---|
[7e470da] | 952 | |
---|
[0337203] | 953 | sub _get_blist { |
---|
| 954 | return join("\n", $getBuddyList->run); |
---|
[7e470da] | 955 | } |
---|
[dd16bdd] | 956 | |
---|
[799b60e] | 957 | sub _get_quickstart { |
---|
| 958 | return join("\n", $getQuickstart->run); |
---|
| 959 | } |
---|
| 960 | |
---|
[b6c067a] | 961 | ################################################################################ |
---|
| 962 | # Built-in perl styles |
---|
| 963 | ################################################################################ |
---|
| 964 | package BarnOwl::Style::Default; |
---|
| 965 | ################################################################################ |
---|
| 966 | # Branching point for various formatting functions in this style. |
---|
| 967 | ################################################################################ |
---|
[426735d] | 968 | sub format_message |
---|
[b6c067a] | 969 | { |
---|
[864ed35] | 970 | my $self = shift; |
---|
[811ad93] | 971 | my $m = shift; |
---|
| 972 | my $fmt; |
---|
[b6c067a] | 973 | |
---|
[6e6ded7] | 974 | if ( $m->is_loginout) { |
---|
[811ad93] | 975 | $fmt = $self->format_login($m); |
---|
[18fb3d4f] | 976 | } elsif($m->is_ping && $m->is_personal) { |
---|
[811ad93] | 977 | $fmt = $self->format_ping($m); |
---|
[6e6ded7] | 978 | } elsif($m->is_admin) { |
---|
[811ad93] | 979 | $fmt = $self->format_admin($m); |
---|
[6e6ded7] | 980 | } else { |
---|
[811ad93] | 981 | $fmt = $self->format_chat($m); |
---|
[b6c067a] | 982 | } |
---|
[811ad93] | 983 | $fmt = BarnOwl::Style::boldify($fmt) if $self->should_bold($m); |
---|
| 984 | return $fmt; |
---|
| 985 | } |
---|
| 986 | |
---|
| 987 | sub should_bold { |
---|
| 988 | my $self = shift; |
---|
| 989 | my $m = shift; |
---|
| 990 | return $m->is_personal && $m->direction eq "in"; |
---|
[b6c067a] | 991 | } |
---|
| 992 | |
---|
[864ed35] | 993 | sub description {"Default style";} |
---|
| 994 | |
---|
[b67ab6b] | 995 | BarnOwl::create_style("default", "BarnOwl::Style::Default"); |
---|
[b6c067a] | 996 | |
---|
| 997 | ################################################################################ |
---|
| 998 | |
---|
[426735d] | 999 | sub format_time { |
---|
[6b3878b] | 1000 | my $self = shift; |
---|
[6e6ded7] | 1001 | my $m = shift; |
---|
[b6c067a] | 1002 | my ($time) = $m->time =~ /(\d\d:\d\d)/; |
---|
[6e6ded7] | 1003 | return $time; |
---|
[b6c067a] | 1004 | } |
---|
| 1005 | |
---|
[426735d] | 1006 | sub format_login { |
---|
[864ed35] | 1007 | my $self = shift; |
---|
[b6c067a] | 1008 | my $m = shift; |
---|
[6e6ded7] | 1009 | return sprintf( |
---|
| 1010 | '@b<%s%s> for @b(%s) (%s) %s', |
---|
| 1011 | uc( $m->login ), |
---|
| 1012 | $m->login_type, |
---|
| 1013 | $m->pretty_sender, |
---|
| 1014 | $m->login_extra, |
---|
[426735d] | 1015 | $self->format_time($m) |
---|
[6e6ded7] | 1016 | ); |
---|
[b6c067a] | 1017 | } |
---|
| 1018 | |
---|
[864ed35] | 1019 | sub format_ping { |
---|
| 1020 | my $self = shift; |
---|
| 1021 | my $m = shift; |
---|
[2017d07] | 1022 | return "\@b(PING) from \@b(" . $m->pretty_sender . ")"; |
---|
[864ed35] | 1023 | } |
---|
| 1024 | |
---|
| 1025 | sub format_admin { |
---|
| 1026 | my $self = shift; |
---|
| 1027 | my $m = shift; |
---|
[811ad93] | 1028 | return "\@bold(OWL ADMIN)\n" . $self->indent_body($m); |
---|
[864ed35] | 1029 | } |
---|
| 1030 | |
---|
[426735d] | 1031 | sub format_chat { |
---|
[864ed35] | 1032 | my $self = shift; |
---|
[b6c067a] | 1033 | my $m = shift; |
---|
[811ad93] | 1034 | my $header = $self->chat_header($m); |
---|
| 1035 | return $header . "\n". $self->indent_body($m); |
---|
| 1036 | } |
---|
| 1037 | |
---|
| 1038 | sub chat_header { |
---|
| 1039 | my $self = shift; |
---|
| 1040 | my $m = shift; |
---|
[6e6ded7] | 1041 | my $header; |
---|
| 1042 | if ( $m->is_personal ) { |
---|
[dfaa47d] | 1043 | my $personal_context = $m->personal_context; |
---|
| 1044 | $personal_context = ' [' . $personal_context . ']' if $personal_context; |
---|
| 1045 | |
---|
[6e6ded7] | 1046 | if ( $m->direction eq "out" ) { |
---|
[dfaa47d] | 1047 | $header = ucfirst $m->type . $personal_context . " sent to " . $m->pretty_recipient; |
---|
[6e6ded7] | 1048 | } else { |
---|
[dfaa47d] | 1049 | $header = ucfirst $m->type . $personal_context . " from " . $m->pretty_sender; |
---|
[6e6ded7] | 1050 | } |
---|
| 1051 | } else { |
---|
| 1052 | $header = $m->context; |
---|
[37dd88c] | 1053 | if(defined $m->subcontext) { |
---|
[c39999f] | 1054 | $header .= ' / ' . $m->subcontext; |
---|
[6e6ded7] | 1055 | } |
---|
[c39999f] | 1056 | $header .= ' / @b{' . $m->pretty_sender . '}'; |
---|
[6e6ded7] | 1057 | } |
---|
[b6c067a] | 1058 | |
---|
[b51d257] | 1059 | if($m->opcode) { |
---|
| 1060 | $header .= " [" . $m->opcode . "]"; |
---|
| 1061 | } |
---|
[426735d] | 1062 | $header .= " " . $self->format_time($m); |
---|
[811ad93] | 1063 | $header .= $self->format_sender($m); |
---|
| 1064 | return $header; |
---|
| 1065 | } |
---|
| 1066 | |
---|
| 1067 | sub format_sender { |
---|
| 1068 | my $self = shift; |
---|
| 1069 | my $m = shift; |
---|
[0449730] | 1070 | my $sender = $m->long_sender; |
---|
| 1071 | $sender =~ s/\n.*$//s; |
---|
[19aeff4] | 1072 | if (BarnOwl::getvar('colorztext') eq 'on') { |
---|
| 1073 | return " (" . $sender . '@color[default]' . ")"; |
---|
| 1074 | } else { |
---|
| 1075 | return " ($sender)"; |
---|
| 1076 | } |
---|
[b6c067a] | 1077 | } |
---|
| 1078 | |
---|
[426735d] | 1079 | sub indent_body |
---|
[b6c067a] | 1080 | { |
---|
[811ad93] | 1081 | my $self = shift; |
---|
[b6c067a] | 1082 | my $m = shift; |
---|
[186cdc4] | 1083 | |
---|
[b6c067a] | 1084 | my $body = $m->body; |
---|
[f6b319c] | 1085 | if ($m->{should_wordwrap}) { |
---|
[7743955] | 1086 | $body = BarnOwl::wordwrap($body, BarnOwl::getnumcols()-9); |
---|
[f6b319c] | 1087 | } |
---|
[186cdc4] | 1088 | # replace newline followed by anything with |
---|
[b6c067a] | 1089 | # newline plus four spaces and that thing. |
---|
| 1090 | $body =~ s/\n(.)/\n $1/g; |
---|
[f2d72128] | 1091 | # Trim trailing newlines. |
---|
| 1092 | $body =~ s/\n*$//; |
---|
[b6c067a] | 1093 | return " ".$body; |
---|
| 1094 | } |
---|
| 1095 | |
---|
[864ed35] | 1096 | package BarnOwl::Style::Basic; |
---|
| 1097 | our @ISA=qw(BarnOwl::Style::Default); |
---|
| 1098 | |
---|
| 1099 | sub description {"Compatability alias for the default style";} |
---|
| 1100 | |
---|
[b67ab6b] | 1101 | BarnOwl::create_style("basic", "BarnOwl::Style::Basic"); |
---|
[864ed35] | 1102 | |
---|
[f2d72128] | 1103 | package BarnOwl::Style::OneLine; |
---|
[811ad93] | 1104 | # Inherit format_message to dispatch |
---|
| 1105 | our @ISA = qw(BarnOwl::Style::Default); |
---|
[f2d72128] | 1106 | |
---|
[811ad93] | 1107 | use constant BASE_FORMAT => '%s %-13.13s %-11.11s %-12.12s '; |
---|
[f2d72128] | 1108 | |
---|
[864ed35] | 1109 | sub description {"Formats for one-line-per-message"} |
---|
| 1110 | |
---|
[b67ab6b] | 1111 | BarnOwl::create_style("oneline", "BarnOwl::Style::OneLine"); |
---|
[f2d72128] | 1112 | |
---|
| 1113 | ################################################################################ |
---|
| 1114 | |
---|
[5008e51] | 1115 | sub maybe { |
---|
| 1116 | my $thing = shift; |
---|
| 1117 | return defined($thing) ? $thing : ""; |
---|
| 1118 | } |
---|
| 1119 | |
---|
[426735d] | 1120 | sub format_login { |
---|
[864ed35] | 1121 | my $self = shift; |
---|
[f2d72128] | 1122 | my $m = shift; |
---|
| 1123 | return sprintf( |
---|
| 1124 | BASE_FORMAT, |
---|
| 1125 | '<', |
---|
| 1126 | $m->type, |
---|
| 1127 | uc( $m->login ), |
---|
| 1128 | $m->pretty_sender) |
---|
| 1129 | . ($m->login_extra ? "at ".$m->login_extra : ''); |
---|
| 1130 | } |
---|
| 1131 | |
---|
[426735d] | 1132 | sub format_ping { |
---|
[2017d07] | 1133 | my $self = shift; |
---|
[f2d72128] | 1134 | my $m = shift; |
---|
| 1135 | return sprintf( |
---|
| 1136 | BASE_FORMAT, |
---|
| 1137 | '<', |
---|
| 1138 | $m->type, |
---|
| 1139 | 'PING', |
---|
| 1140 | $m->pretty_sender) |
---|
| 1141 | } |
---|
| 1142 | |
---|
[426735d] | 1143 | sub format_chat |
---|
[f2d72128] | 1144 | { |
---|
[864ed35] | 1145 | my $self = shift; |
---|
[f2d72128] | 1146 | my $m = shift; |
---|
| 1147 | my $dir = lc($m->{direction}); |
---|
| 1148 | my $dirsym = '-'; |
---|
| 1149 | if ($dir eq 'in') { |
---|
| 1150 | $dirsym = '<'; |
---|
| 1151 | } |
---|
| 1152 | elsif ($dir eq 'out') { |
---|
| 1153 | $dirsym = '>'; |
---|
| 1154 | } |
---|
| 1155 | |
---|
| 1156 | my $line; |
---|
| 1157 | if ($m->is_personal) { |
---|
| 1158 | $line= sprintf(BASE_FORMAT, |
---|
[811ad93] | 1159 | $dirsym, |
---|
| 1160 | $m->type, |
---|
| 1161 | '', |
---|
| 1162 | ($dir eq 'out' |
---|
| 1163 | ? $m->pretty_recipient |
---|
| 1164 | : $m->pretty_sender)); |
---|
[f2d72128] | 1165 | } |
---|
| 1166 | else { |
---|
| 1167 | $line = sprintf(BASE_FORMAT, |
---|
[811ad93] | 1168 | $dirsym, |
---|
[5008e51] | 1169 | maybe($m->context), |
---|
| 1170 | maybe($m->subcontext), |
---|
[811ad93] | 1171 | ($dir eq 'out' |
---|
| 1172 | ? $m->pretty_recipient |
---|
| 1173 | : $m->pretty_sender)); |
---|
[f2d72128] | 1174 | } |
---|
| 1175 | |
---|
| 1176 | my $body = $m->{body}; |
---|
| 1177 | $body =~ tr/\n/ /; |
---|
| 1178 | $line .= $body; |
---|
| 1179 | return $line; |
---|
| 1180 | } |
---|
| 1181 | |
---|
[811ad93] | 1182 | # Format owl admin messages |
---|
[426735d] | 1183 | sub format_admin |
---|
[f2d72128] | 1184 | { |
---|
[864ed35] | 1185 | my $self = shift; |
---|
[f2d72128] | 1186 | my $m = shift; |
---|
[811ad93] | 1187 | my $line = sprintf(BASE_FORMAT, '<', 'ADMIN', '', ''); |
---|
[f2d72128] | 1188 | my $body = $m->{body}; |
---|
| 1189 | $body =~ tr/\n/ /; |
---|
| 1190 | return $line.$body; |
---|
| 1191 | } |
---|
[b6c067a] | 1192 | |
---|
| 1193 | package BarnOwl::Style; |
---|
| 1194 | |
---|
| 1195 | # This takes a zephyr to be displayed and modifies it to be displayed |
---|
| 1196 | # entirely in bold. |
---|
[426735d] | 1197 | sub boldify |
---|
[b6c067a] | 1198 | { |
---|
| 1199 | local $_ = shift; |
---|
| 1200 | if ( !(/\)/) ) { |
---|
| 1201 | return '@b(' . $_ . ')'; |
---|
| 1202 | } elsif ( !(/\>/) ) { |
---|
| 1203 | return '@b<' . $_ . '>'; |
---|
| 1204 | } elsif ( !(/\}/) ) { |
---|
| 1205 | return '@b{' . $_ . '}'; |
---|
| 1206 | } elsif ( !(/\]/) ) { |
---|
| 1207 | return '@b[' . $_ . ']'; |
---|
| 1208 | } else { |
---|
| 1209 | my $txt = "\@b($_"; |
---|
| 1210 | $txt =~ s/\)/\)\@b\[\)\]\@b\(/g; |
---|
| 1211 | return $txt . ')'; |
---|
| 1212 | } |
---|
| 1213 | } |
---|
| 1214 | |
---|
[2650a10] | 1215 | sub style_command { |
---|
| 1216 | my $command = shift; |
---|
| 1217 | if(scalar @_ != 3 || $_[1] ne 'perl') { |
---|
| 1218 | die("Usage: style <name> perl <function>\n"); |
---|
| 1219 | } |
---|
| 1220 | my $name = shift; |
---|
| 1221 | my $perl = shift; |
---|
| 1222 | my $fn = shift; |
---|
| 1223 | { |
---|
[b441079] | 1224 | # For historical reasons, assume unqualified references are |
---|
| 1225 | # in main:: |
---|
| 1226 | package main; |
---|
[2650a10] | 1227 | no strict 'refs'; |
---|
| 1228 | unless(*{$fn}{CODE}) { |
---|
| 1229 | die("Unable to create style '$name': no perl function '$fn'\n"); |
---|
| 1230 | } |
---|
| 1231 | } |
---|
| 1232 | BarnOwl::create_style($name, BarnOwl::Style::Legacy->new($fn)); |
---|
| 1233 | } |
---|
| 1234 | |
---|
[b67ab6b] | 1235 | package BarnOwl::Style::Legacy; |
---|
| 1236 | |
---|
| 1237 | sub new { |
---|
| 1238 | my $class = shift; |
---|
| 1239 | my $func = shift; |
---|
| 1240 | my $desc = shift; |
---|
| 1241 | my $useglobals = shift; |
---|
| 1242 | $useglobals = 0 unless defined($useglobals); |
---|
| 1243 | return bless {function => $func, |
---|
| 1244 | description => $desc, |
---|
| 1245 | useglobals => $useglobals}, $class; |
---|
| 1246 | } |
---|
| 1247 | |
---|
[2650a10] | 1248 | sub description { |
---|
| 1249 | my $self = shift; |
---|
| 1250 | return $self->{description} || |
---|
| 1251 | ("User-defined perl style that calls " . $self->{function}); |
---|
| 1252 | }; |
---|
[b67ab6b] | 1253 | |
---|
| 1254 | sub format_message { |
---|
| 1255 | my $self = shift; |
---|
| 1256 | if($self->{useglobals}) { |
---|
| 1257 | $_[0]->legacy_populate_global(); |
---|
| 1258 | } |
---|
[b441079] | 1259 | { |
---|
| 1260 | package main; |
---|
| 1261 | no strict 'refs'; |
---|
| 1262 | goto \&{$self->{function}}; |
---|
| 1263 | } |
---|
[b67ab6b] | 1264 | } |
---|
| 1265 | |
---|
[1631825] | 1266 | package BarnOwl::Timer; |
---|
| 1267 | |
---|
| 1268 | sub new { |
---|
| 1269 | my $class = shift; |
---|
| 1270 | my $args = shift; |
---|
| 1271 | |
---|
| 1272 | my $cb = $args->{cb}; |
---|
| 1273 | die("Invalid callback pased to BarnOwl::Timer\n") unless ref($cb) eq 'CODE'; |
---|
| 1274 | |
---|
| 1275 | my $self = {cb => $cb}; |
---|
| 1276 | |
---|
| 1277 | bless($self, $class); |
---|
| 1278 | |
---|
| 1279 | $self->{timer} = BarnOwl::Internal::add_timer($args->{after} || 0, |
---|
| 1280 | $args->{interval} || 0, |
---|
| 1281 | $self); |
---|
| 1282 | return $self; |
---|
| 1283 | } |
---|
| 1284 | |
---|
| 1285 | sub do_callback { |
---|
| 1286 | my $self = shift; |
---|
| 1287 | $self->{cb}->($self); |
---|
| 1288 | } |
---|
| 1289 | |
---|
| 1290 | sub DESTROY { |
---|
| 1291 | my $self = shift; |
---|
| 1292 | if(defined($self->{timer})) { |
---|
| 1293 | BarnOwl::Internal::remove_timer($self->{timer}); |
---|
| 1294 | } |
---|
| 1295 | } |
---|
| 1296 | |
---|
[b6c067a] | 1297 | |
---|
[f1e629d] | 1298 | # switch to package main when we're done |
---|
| 1299 | package main; |
---|
[0337203] | 1300 | |
---|
| 1301 | # Shove a bunch of fake entries into @INC so modules can use or |
---|
| 1302 | # require them without choking |
---|
| 1303 | $::INC{$_} = 1 for (qw(BarnOwl.pm BarnOwl/Hooks.pm |
---|
| 1304 | BarnOwl/Message.pm BarnOwl/Style.pm)); |
---|
[f1e629d] | 1305 | |
---|
| 1306 | 1; |
---|
[0337203] | 1307 | |
---|