[ee183be] | 1 | use strict; |
---|
| 2 | use warnings; |
---|
| 3 | |
---|
| 4 | package BarnOwl; |
---|
| 5 | |
---|
[2be605a] | 6 | use base qw(Exporter); |
---|
[b303ba2] | 7 | our @EXPORT_OK = qw(command getcurmsg getnumcols getnumlines getidletime |
---|
[ecd4edf] | 8 | register_idle_watcher unregister_idle_watcher |
---|
[2be605a] | 9 | zephyr_getsender zephyr_getrealm zephyr_zwrite |
---|
| 10 | zephyr_stylestrip zephyr_smartstrip_user zephyr_getsubs |
---|
| 11 | queue_message admin_message |
---|
[e89ec48] | 12 | start_edit |
---|
[2be605a] | 13 | start_question start_password start_edit_win |
---|
| 14 | get_data_dir get_config_dir popless_text popless_ztext |
---|
[eede1bf] | 15 | error debug |
---|
[2be605a] | 16 | create_style getnumcolors wordwrap |
---|
[1ced34f] | 17 | message_matches_filter |
---|
[a619eda] | 18 | get_variable_info |
---|
[ffc4df6] | 19 | add_dispatch remove_dispatch |
---|
| 20 | add_io_dispatch remove_io_dispatch |
---|
[2be605a] | 21 | new_command |
---|
| 22 | new_variable_int new_variable_bool new_variable_string |
---|
[e26abb6] | 23 | new_variable_enum |
---|
[4df918b] | 24 | quote redisplay); |
---|
[2be605a] | 25 | our %EXPORT_TAGS = (all => \@EXPORT_OK); |
---|
| 26 | |
---|
[fd8dfe7] | 27 | BEGIN { |
---|
| 28 | # bootstrap in C bindings and glue |
---|
| 29 | *owl:: = \*BarnOwl::; |
---|
| 30 | bootstrap BarnOwl 1.2; |
---|
| 31 | }; |
---|
| 32 | |
---|
| 33 | use lib(get_data_dir() . "/lib"); |
---|
| 34 | use lib(get_config_dir() . "/lib"); |
---|
| 35 | |
---|
[9179fd7] | 36 | use Glib; |
---|
| 37 | use AnyEvent; |
---|
| 38 | |
---|
[fd8dfe7] | 39 | use BarnOwl::Hook; |
---|
| 40 | use BarnOwl::Hooks; |
---|
[eea7bed4] | 41 | use BarnOwl::Logging; |
---|
[fd8dfe7] | 42 | use BarnOwl::Message; |
---|
| 43 | use BarnOwl::Style; |
---|
[df569c5] | 44 | use BarnOwl::Zephyr; |
---|
[fd8dfe7] | 45 | use BarnOwl::Timer; |
---|
[cf26b72] | 46 | use BarnOwl::Editwin; |
---|
[8eac1a5] | 47 | use BarnOwl::Completion; |
---|
[b30c256] | 48 | use BarnOwl::Help; |
---|
[9d6e37c] | 49 | use BarnOwl::DeferredLogging; |
---|
[fd8dfe7] | 50 | |
---|
[6700c605] | 51 | use List::Util qw(max); |
---|
[ecd4edf] | 52 | use Tie::RefHash; |
---|
[6700c605] | 53 | |
---|
[ee183be] | 54 | =head1 NAME |
---|
| 55 | |
---|
| 56 | BarnOwl |
---|
| 57 | |
---|
| 58 | =head1 DESCRIPTION |
---|
| 59 | |
---|
| 60 | The BarnOwl module contains the core of BarnOwl's perl |
---|
| 61 | bindings. Source in this module is also run at startup to bootstrap |
---|
[b8a3e00] | 62 | BarnOwl by defining things like the default style. |
---|
[ee183be] | 63 | |
---|
| 64 | =for NOTE |
---|
| 65 | These following functions are defined in perlglue.xs. Keep the |
---|
| 66 | documentation here in sync with the user-visible commands defined |
---|
| 67 | there! |
---|
| 68 | |
---|
| 69 | =head2 command STRING |
---|
| 70 | |
---|
| 71 | Executes a BarnOwl command in the same manner as if the user had |
---|
| 72 | executed it at the BarnOwl command prompt. If the command returns a |
---|
| 73 | value, return it as a string, otherwise return undef. |
---|
| 74 | |
---|
| 75 | =head2 getcurmsg |
---|
| 76 | |
---|
| 77 | Returns the current message as a C<BarnOwl::Message> subclass, or |
---|
| 78 | undef if there is no message selected |
---|
| 79 | =head2 getnumcols |
---|
| 80 | |
---|
| 81 | Returns the width of the display window BarnOwl is currently using |
---|
| 82 | |
---|
| 83 | =head2 getidletime |
---|
| 84 | |
---|
| 85 | Returns the length of time since the user has pressed a key, in |
---|
| 86 | seconds. |
---|
| 87 | |
---|
| 88 | =head2 zephyr_getrealm |
---|
| 89 | |
---|
[b8a3e00] | 90 | Returns the zephyr realm BarnOwl is running in |
---|
[ee183be] | 91 | |
---|
| 92 | =head2 zephyr_getsender |
---|
| 93 | |
---|
[b8a3e00] | 94 | Returns the fully-qualified name of the zephyr sender BarnOwl is |
---|
[ee183be] | 95 | running as, e.g. C<nelhage@ATHENA.MIT.EDU> |
---|
| 96 | |
---|
| 97 | =head2 zephyr_zwrite COMMAND MESSAGE |
---|
| 98 | |
---|
| 99 | Sends a zephyr programmatically. C<COMMAND> should be a C<zwrite> |
---|
| 100 | command line, and C<MESSAGE> is the zephyr body to send. |
---|
| 101 | |
---|
[374089a] | 102 | =cut |
---|
| 103 | |
---|
| 104 | sub zephyr_zwrite { |
---|
| 105 | my ($command, $message) = @_; |
---|
| 106 | my $ret = BarnOwl::Internal::zephyr_zwrite($command, $message); |
---|
| 107 | die "Error sending zephyr" unless $ret == 0; |
---|
| 108 | } |
---|
| 109 | |
---|
[ee183be] | 110 | =head2 ztext_stylestrip STRING |
---|
| 111 | |
---|
| 112 | Strips zephyr formatting from a string and returns the result |
---|
| 113 | |
---|
| 114 | =head2 zephyr_getsubs |
---|
| 115 | |
---|
| 116 | Returns the list of subscription triples <class,instance,recipient>, |
---|
| 117 | separated by newlines. |
---|
| 118 | |
---|
| 119 | =head2 queue_message MESSAGE |
---|
| 120 | |
---|
| 121 | Enqueue a message in the BarnOwl message list, logging it and |
---|
| 122 | processing it appropriately. C<MESSAGE> should be an instance of |
---|
[e89ec48] | 123 | BarnOwl::Message or a subclass. |
---|
[ee183be] | 124 | |
---|
| 125 | =head2 admin_message HEADER BODY |
---|
| 126 | |
---|
| 127 | Display a BarnOwl B<Admin> message, with the given header and body. |
---|
| 128 | |
---|
[e89ec48] | 129 | =head2 start_edit %ARGS |
---|
[ee183be] | 130 | |
---|
[e89ec48] | 131 | Displays a prompt on the screen and lets the user enter text, |
---|
| 132 | and calls a callback when the editwin is closed. |
---|
[ee183be] | 133 | |
---|
[e89ec48] | 134 | C<%ARGS> must contain the following keys: |
---|
| 135 | |
---|
| 136 | =over 4 |
---|
| 137 | |
---|
| 138 | =item prompt |
---|
| 139 | |
---|
| 140 | The line to display on the screen |
---|
| 141 | |
---|
| 142 | =item type |
---|
| 143 | |
---|
| 144 | One of: |
---|
| 145 | |
---|
| 146 | =over 4 |
---|
| 147 | |
---|
| 148 | =item edit_win |
---|
| 149 | |
---|
| 150 | Displays the prompt on a line of its own and opens the edit_win. |
---|
| 151 | |
---|
| 152 | =item question |
---|
| 153 | |
---|
| 154 | Displays prompt on the screen and lets the user enter a line of |
---|
| 155 | text. |
---|
| 156 | |
---|
| 157 | =item password |
---|
[ee183be] | 158 | |
---|
[e89ec48] | 159 | Like question, but echoes the user's input as C<*>s when they |
---|
[ee183be] | 160 | input. |
---|
| 161 | |
---|
[e89ec48] | 162 | =back |
---|
| 163 | |
---|
| 164 | =item callback |
---|
| 165 | |
---|
| 166 | A Perl subroutine that is called when the user closes the edit_win. |
---|
[7803326] | 167 | C<CALLBACK> gets called with two parameters: the text the user entered, |
---|
| 168 | and a C<SUCCESS> boolean parameter which is false if the user canceled |
---|
| 169 | the edit_win and true otherwise. |
---|
[e89ec48] | 170 | |
---|
| 171 | =back |
---|
| 172 | |
---|
| 173 | =head2 start_question PROMPT CALLBACK |
---|
| 174 | |
---|
| 175 | =head2 start_password PROMPT CALLBACK |
---|
| 176 | |
---|
[ee183be] | 177 | =head2 start_edit_win PROMPT CALLBACK |
---|
| 178 | |
---|
[7803326] | 179 | Roughly equivalent to C<start_edit> called with the appropriate parameters. |
---|
| 180 | C<CALLBACK> is only called on success, for compatibility. |
---|
| 181 | |
---|
| 182 | These are deprecated wrappers around L<BarnOwl::start_edit>, and should not |
---|
| 183 | be uesd in new code. |
---|
[e89ec48] | 184 | |
---|
| 185 | =cut |
---|
| 186 | |
---|
| 187 | sub start_edit { |
---|
| 188 | my %args = (@_); |
---|
| 189 | BarnOwl::Internal::start_edit($args{type}, $args{prompt}, $args{callback}); |
---|
| 190 | } |
---|
| 191 | |
---|
| 192 | sub start_question { |
---|
| 193 | my ($prompt, $callback) = @_; |
---|
[7803326] | 194 | BarnOwl::start_edit(type => 'question', prompt => $prompt, callback => sub { |
---|
| 195 | my ($text, $success) = @_; |
---|
| 196 | $callback->($text) if $success; |
---|
| 197 | }); |
---|
[e89ec48] | 198 | } |
---|
| 199 | |
---|
| 200 | sub start_password { |
---|
| 201 | my ($prompt, $callback) = @_; |
---|
[7803326] | 202 | BarnOwl::start_edit(type => 'password', prompt => $prompt, callback => sub { |
---|
| 203 | my ($text, $success) = @_; |
---|
| 204 | $callback->($text) if $success; |
---|
| 205 | }); |
---|
[e89ec48] | 206 | } |
---|
| 207 | |
---|
| 208 | sub start_edit_win { |
---|
| 209 | my ($prompt, $callback) = @_; |
---|
[7803326] | 210 | BarnOwl::start_edit(type => 'edit_win', prompt => $prompt, callback => sub { |
---|
| 211 | my ($text, $success) = @_; |
---|
| 212 | $callback->($text) if $success; |
---|
| 213 | }); |
---|
[e89ec48] | 214 | } |
---|
[ee183be] | 215 | |
---|
| 216 | =head2 get_data_dir |
---|
| 217 | |
---|
| 218 | Returns the BarnOwl system data directory, where system libraries and |
---|
| 219 | modules are stored |
---|
| 220 | |
---|
| 221 | =head2 get_config_dir |
---|
| 222 | |
---|
| 223 | Returns the BarnOwl user configuration directory, where user modules |
---|
| 224 | and configuration are stored (by default, C<$HOME/.owl>) |
---|
| 225 | |
---|
| 226 | =head2 popless_text TEXT |
---|
| 227 | |
---|
| 228 | Show a popup window containing the given C<TEXT> |
---|
| 229 | |
---|
| 230 | =head2 popless_ztext TEXT |
---|
| 231 | |
---|
| 232 | Show a popup window containing the provided zephyr-formatted C<TEXT> |
---|
| 233 | |
---|
| 234 | =head2 error STRING |
---|
| 235 | |
---|
| 236 | Reports an error and log it in `show errors'. Note that in any |
---|
| 237 | callback or hook called in perl code from BarnOwl, a C<die> will be |
---|
| 238 | caught and passed to C<error>. |
---|
| 239 | |
---|
[eede1bf] | 240 | =head2 debug STRING |
---|
| 241 | |
---|
| 242 | Logs a debugging message to BarnOwl's debug log |
---|
| 243 | |
---|
[ee183be] | 244 | =head2 getnumcolors |
---|
| 245 | |
---|
| 246 | Returns the number of colors this BarnOwl is capable of displaying |
---|
| 247 | |
---|
[1ced34f] | 248 | =head2 message_matches_filter MESSAGE FILTER_NAME [QUIET = 0] |
---|
| 249 | |
---|
| 250 | Returns 1 if C<FILTER_NAME> is the name of a valid filter, and |
---|
| 251 | C<MESSAGE> matches that filter. Returns 0 otherwise. If |
---|
| 252 | C<QUIET> is false, this method displays an error message if |
---|
| 253 | if C<FILTER_NAME> does not name a valid filter. |
---|
| 254 | |
---|
[a619eda] | 255 | =head2 get_variable_info VARIABLE_NAME |
---|
| 256 | |
---|
| 257 | Returns a hash with the following keys, describing the variable named: |
---|
| 258 | |
---|
| 259 | =over |
---|
| 260 | |
---|
| 261 | =item name |
---|
| 262 | |
---|
| 263 | =item description |
---|
| 264 | |
---|
| 265 | =item summary |
---|
| 266 | |
---|
| 267 | =item validsettings |
---|
| 268 | |
---|
| 269 | =item takes_on_off |
---|
| 270 | |
---|
| 271 | =back |
---|
| 272 | |
---|
| 273 | Fails if C<VARIABLE_NAME> does not name a valid variable. |
---|
| 274 | |
---|
[ee183be] | 275 | =head2 add_dispatch FD CALLBACK |
---|
| 276 | |
---|
| 277 | Adds a file descriptor to C<BarnOwl>'s internal C<select()> |
---|
| 278 | loop. C<CALLBACK> will be invoked whenever data is available to be |
---|
| 279 | read from C<FD>. |
---|
| 280 | |
---|
[bcde7926] | 281 | C<add_dispatch> has been deprecated in favor of C<AnyEvent>, and is |
---|
| 282 | now a wrapper for C<add_io_dispatch> called with C<mode> set to |
---|
| 283 | C<'r'>. |
---|
[ffc4df6] | 284 | |
---|
| 285 | =cut |
---|
| 286 | |
---|
| 287 | sub add_dispatch { |
---|
| 288 | my $fd = shift; |
---|
| 289 | my $cb = shift; |
---|
| 290 | add_io_dispatch($fd, 'r', $cb); |
---|
| 291 | } |
---|
| 292 | |
---|
[ee183be] | 293 | =head2 remove_dispatch FD |
---|
| 294 | |
---|
| 295 | Remove a file descriptor previously registered via C<add_dispatch> |
---|
| 296 | |
---|
[bcde7926] | 297 | C<remove_dispatch> has been deprecated in favor of C<AnyEvent>. |
---|
[ffc4df6] | 298 | |
---|
| 299 | =cut |
---|
| 300 | |
---|
| 301 | *remove_dispatch = \&remove_io_dispatch; |
---|
| 302 | |
---|
| 303 | =head2 add_io_dispatch FD MODE CB |
---|
| 304 | |
---|
| 305 | Adds a file descriptor to C<BarnOwl>'s internal C<select()> |
---|
| 306 | loop. <MODE> can be 'r', 'w', or 'rw'. C<CALLBACK> will be invoked |
---|
| 307 | whenever C<FD> becomes ready, as specified by <MODE>. |
---|
| 308 | |
---|
| 309 | Only one callback can be registered per FD. If a new callback is |
---|
| 310 | registered, the old one is removed. |
---|
| 311 | |
---|
[bcde7926] | 312 | C<add_io_dispatch> has been deprecated in favor of C<AnyEvent>. |
---|
| 313 | |
---|
[ffc4df6] | 314 | =cut |
---|
| 315 | |
---|
[bcde7926] | 316 | our %_io_dispatches; |
---|
| 317 | |
---|
[ffc4df6] | 318 | sub add_io_dispatch { |
---|
| 319 | my $fd = shift; |
---|
| 320 | my $modeStr = shift; |
---|
| 321 | my $cb = shift; |
---|
[bcde7926] | 322 | my @modes; |
---|
| 323 | |
---|
| 324 | push @modes, 'r' if $modeStr =~ /r/i; # Read |
---|
| 325 | push @modes, 'w' if $modeStr =~ /w/i; # Write |
---|
| 326 | if (@modes) { |
---|
| 327 | BarnOwl::remove_io_dispatch($fd); |
---|
| 328 | for my $mode (@modes) { |
---|
| 329 | push @{$_io_dispatches{$fd}}, AnyEvent->io(fh => $fd, |
---|
| 330 | poll => $mode, |
---|
| 331 | cb => $cb); |
---|
| 332 | } |
---|
[ffc4df6] | 333 | } else { |
---|
| 334 | die("Invalid I/O Dispatch mode: $modeStr"); |
---|
| 335 | } |
---|
| 336 | } |
---|
| 337 | |
---|
| 338 | =head2 remove_io_dispatch FD |
---|
| 339 | |
---|
| 340 | Remove a file descriptor previously registered via C<add_io_dispatch> |
---|
| 341 | |
---|
[bcde7926] | 342 | C<remove_io_dispatch> has been deprecated in favor of C<AnyEvent>. |
---|
| 343 | |
---|
| 344 | =cut |
---|
| 345 | |
---|
| 346 | sub remove_io_dispatch { |
---|
| 347 | my $fd = shift; |
---|
| 348 | undef $_ foreach @{$_io_dispatches{$fd}}; |
---|
| 349 | delete $_io_dispatches{$fd}; |
---|
| 350 | } |
---|
| 351 | |
---|
[ee183be] | 352 | =head2 create_style NAME OBJECT |
---|
| 353 | |
---|
[b8a3e00] | 354 | Creates a new BarnOwl style with the given NAME defined by the given |
---|
[ee183be] | 355 | object. The object must have a C<description> method which returns a |
---|
| 356 | string description of the style, and a and C<format_message> method |
---|
| 357 | which accepts a C<BarnOwl::Message> object and returns a string that |
---|
| 358 | is the result of formatting the message for display. |
---|
| 359 | |
---|
[4df918b] | 360 | =head2 redisplay |
---|
| 361 | |
---|
| 362 | Redraw all of the messages on screen. This is useful if you've just |
---|
| 363 | changed how a style renders messages. |
---|
| 364 | |
---|
[ee183be] | 365 | =cut |
---|
| 366 | |
---|
| 367 | # perlconfig.c will set this to the value of the -c command-line |
---|
| 368 | # switch, if present. |
---|
| 369 | our $configfile; |
---|
| 370 | |
---|
[d7bcff8] | 371 | our @all_commands; |
---|
| 372 | |
---|
[8135737] | 373 | if(!$configfile) { |
---|
| 374 | if (-f get_config_dir() . "/init.pl") { |
---|
| 375 | $configfile = get_config_dir() . "/init.pl"; |
---|
| 376 | } elsif (-f $ENV{HOME} . "/.barnowlconf") { |
---|
| 377 | $configfile = $ENV{HOME} . "/.barnowlconf"; |
---|
| 378 | } else { |
---|
| 379 | $configfile = $ENV{HOME}."/.owlconf"; |
---|
| 380 | } |
---|
[ee183be] | 381 | } |
---|
| 382 | |
---|
| 383 | # populate global variable space for legacy owlconf files |
---|
| 384 | sub _receive_msg_legacy_wrap { |
---|
| 385 | my ($m) = @_; |
---|
| 386 | $m->legacy_populate_global(); |
---|
| 387 | return &BarnOwl::Hooks::_receive_msg($m); |
---|
| 388 | } |
---|
| 389 | |
---|
| 390 | =head2 new_command NAME FUNC [{ARGS}] |
---|
| 391 | |
---|
| 392 | Add a new owl command. When owl executes the command NAME, FUNC will |
---|
| 393 | be called with the arguments passed to the command, with NAME as the |
---|
| 394 | first argument. |
---|
| 395 | |
---|
| 396 | ARGS should be a hashref containing any or all of C<summary>, |
---|
| 397 | C<usage>, or C<description> keys: |
---|
| 398 | |
---|
| 399 | =over 4 |
---|
| 400 | |
---|
| 401 | =item summary |
---|
| 402 | |
---|
| 403 | A one-line summary of the purpose of the command |
---|
| 404 | |
---|
| 405 | =item usage |
---|
| 406 | |
---|
| 407 | A one-line usage synopsis, showing available options and syntax |
---|
| 408 | |
---|
| 409 | =item description |
---|
| 410 | |
---|
| 411 | A longer description of the syntax and semantics of the command, |
---|
| 412 | explaining usage and options |
---|
| 413 | |
---|
| 414 | =back |
---|
| 415 | |
---|
| 416 | =cut |
---|
| 417 | |
---|
| 418 | sub new_command { |
---|
| 419 | my $name = shift; |
---|
| 420 | my $func = shift; |
---|
| 421 | my $args = shift || {}; |
---|
| 422 | my %args = ( |
---|
| 423 | summary => "", |
---|
| 424 | usage => "", |
---|
| 425 | description => "", |
---|
| 426 | %{$args} |
---|
| 427 | ); |
---|
| 428 | |
---|
| 429 | BarnOwl::Internal::new_command($name, $func, $args{summary}, $args{usage}, $args{description}); |
---|
| 430 | } |
---|
| 431 | |
---|
| 432 | =head2 new_variable_int NAME [{ARGS}] |
---|
| 433 | |
---|
| 434 | =head2 new_variable_bool NAME [{ARGS}] |
---|
| 435 | |
---|
| 436 | =head2 new_variable_string NAME [{ARGS}] |
---|
| 437 | |
---|
[e26abb6] | 438 | =head2 new_variable_enum NAME [{ARGS}] |
---|
| 439 | |
---|
| 440 | Add a new owl variable, either an int, a bool, a string, or an enum with the |
---|
[ee183be] | 441 | specified name. |
---|
| 442 | |
---|
[e26abb6] | 443 | For new_variable_enum, ARGS is required to contain a validsettings key pointing |
---|
| 444 | to an array reference. For all four, it can optionally contain the following |
---|
| 445 | keys: |
---|
[ee183be] | 446 | |
---|
| 447 | =over 4 |
---|
| 448 | |
---|
| 449 | =item default |
---|
| 450 | |
---|
| 451 | The default and initial value for the variable |
---|
| 452 | |
---|
| 453 | =item summary |
---|
| 454 | |
---|
| 455 | A one-line summary of the variable's purpose |
---|
| 456 | |
---|
| 457 | =item description |
---|
| 458 | |
---|
| 459 | A longer description of the function of the variable |
---|
| 460 | |
---|
| 461 | =back |
---|
| 462 | |
---|
[104a4eb] | 463 | In addition, new_variable_string optionally accepts a string validsettings |
---|
| 464 | parameter, in case people want to set it to "<path>". |
---|
| 465 | |
---|
[ee183be] | 466 | =cut |
---|
| 467 | |
---|
| 468 | sub new_variable_int { |
---|
[523146b] | 469 | my ($name, $args) = @_; |
---|
| 470 | my $storage = defined($args->{default}) ? $args->{default} : 0; |
---|
| 471 | BarnOwl::new_variable_full($name, { |
---|
| 472 | %{$args}, |
---|
| 473 | get_tostring => sub { "$storage" }, |
---|
| 474 | set_fromstring => sub { |
---|
[4953c44] | 475 | die "Expected integer" unless $_[0] =~ /^-?[0-9]+$/; |
---|
[523146b] | 476 | $storage = 0 + $_[0]; |
---|
| 477 | }, |
---|
| 478 | validsettings => "<int>", |
---|
| 479 | takes_on_off => 0, |
---|
| 480 | }); |
---|
[ee183be] | 481 | } |
---|
| 482 | |
---|
| 483 | sub new_variable_bool { |
---|
[523146b] | 484 | my ($name, $args) = @_; |
---|
| 485 | my $storage = defined($args->{default}) ? $args->{default} : 0; |
---|
| 486 | BarnOwl::new_variable_full($name, { |
---|
| 487 | %{$args}, |
---|
| 488 | get_tostring => sub { $storage ? "on" : "off" }, |
---|
| 489 | set_fromstring => sub { |
---|
[4953c44] | 490 | die "Valid settings are on/off" unless $_[0] eq "on" || $_[0] eq "off"; |
---|
[523146b] | 491 | $storage = $_[0] eq "on"; |
---|
| 492 | }, |
---|
| 493 | validsettings => "on,off", |
---|
| 494 | takes_on_off => 1, |
---|
| 495 | }); |
---|
[ee183be] | 496 | } |
---|
| 497 | |
---|
| 498 | sub new_variable_string { |
---|
[523146b] | 499 | my ($name, $args) = @_; |
---|
| 500 | my $storage = defined($args->{default}) ? $args->{default} : ""; |
---|
| 501 | BarnOwl::new_variable_full($name, { |
---|
[104a4eb] | 502 | # Allow people to override this one if they /reaaally/ want to for |
---|
| 503 | # some reason. Though we still reserve the right to interpret this |
---|
| 504 | # value in interesting ways for tab-completion purposes. |
---|
| 505 | validsettings => "<string>", |
---|
[523146b] | 506 | %{$args}, |
---|
| 507 | get_tostring => sub { $storage }, |
---|
[4953c44] | 508 | set_fromstring => sub { $storage = $_[0]; }, |
---|
[523146b] | 509 | takes_on_off => 0, |
---|
| 510 | }); |
---|
[ee183be] | 511 | } |
---|
| 512 | |
---|
[e26abb6] | 513 | sub new_variable_enum { |
---|
| 514 | my ($name, $args) = @_; |
---|
| 515 | |
---|
| 516 | # Gather the valid settings. |
---|
| 517 | die "validsettings is required" unless defined($args->{validsettings}); |
---|
| 518 | my %valid; |
---|
| 519 | map { $valid{$_} = 1 } @{$args->{validsettings}}; |
---|
| 520 | |
---|
| 521 | my $storage = (defined($args->{default}) ? |
---|
| 522 | $args->{default} : |
---|
| 523 | $args->{validsettings}->[0]); |
---|
| 524 | BarnOwl::new_variable_full($name, { |
---|
| 525 | %{$args}, |
---|
| 526 | get_tostring => sub { $storage }, |
---|
| 527 | set_fromstring => sub { |
---|
[4953c44] | 528 | die "Invalid input" unless $valid{$_[0]}; |
---|
[e26abb6] | 529 | $storage = $_[0]; |
---|
| 530 | }, |
---|
| 531 | validsettings => join(",", @{$args->{validsettings}}) |
---|
| 532 | }); |
---|
| 533 | } |
---|
| 534 | |
---|
[523146b] | 535 | =head2 new_variable_full NAME {ARGS} |
---|
| 536 | |
---|
| 537 | Create a variable, in full generality. The keyword arguments have types below: |
---|
| 538 | |
---|
| 539 | get_tostring : () -> string |
---|
| 540 | set_fromstring : string -> int |
---|
| 541 | -- optional -- |
---|
| 542 | summary : string |
---|
| 543 | description : string |
---|
| 544 | validsettings : string |
---|
| 545 | takes_on_off : int |
---|
[69f74c2] | 546 | |
---|
[523146b] | 547 | The get/set functions are required. Note that the caller manages storage for the |
---|
| 548 | variable. get_tostring/set_fromstring both convert AND store the value. |
---|
[4953c44] | 549 | set_fromstring dies on failure. |
---|
[523146b] | 550 | |
---|
| 551 | If the variable takes parameters 'on' and 'off' (i.e. is boolean-looking), set |
---|
| 552 | takes_on_off to 1. This makes :set VAR and :unset VAR work. set_fromstring will |
---|
| 553 | be called with those arguments. |
---|
| 554 | |
---|
| 555 | =cut |
---|
| 556 | |
---|
| 557 | sub new_variable_full { |
---|
[ee183be] | 558 | my $name = shift; |
---|
| 559 | my $args = shift || {}; |
---|
| 560 | my %args = ( |
---|
[523146b] | 561 | summary => "", |
---|
[ee183be] | 562 | description => "", |
---|
[523146b] | 563 | takes_on_off => 0, |
---|
| 564 | validsettings => "<string>", |
---|
[ee183be] | 565 | %{$args}); |
---|
[69f74c2] | 566 | |
---|
[523146b] | 567 | die "get_tostring required" unless $args{get_tostring}; |
---|
| 568 | die "set_fromstring required" unless $args{set_fromstring}; |
---|
[69f74c2] | 569 | |
---|
[523146b] | 570 | # Strip off the bogus dummy argument. Aargh perl-Glib. |
---|
| 571 | my $get_tostring_fn = sub { $args{get_tostring}->() }; |
---|
[69f74c2] | 572 | my $set_fromstring_fn = sub { |
---|
[523146b] | 573 | my ($dummy, $val) = @_; |
---|
[4953c44] | 574 | # Translate from user-supplied die-on-failure callback to expected |
---|
| 575 | # non-zero on error. Less of a nuisance than interacting with ERRSV. |
---|
| 576 | eval { $args{set_fromstring}->($val) }; |
---|
| 577 | # TODO: Consider changing B::I::new_variable to expect string|NULL with |
---|
| 578 | # string as the error message. That can then be translated to a GError in |
---|
| 579 | # owl_variable_set_fromstring. For now the string is ignored. |
---|
| 580 | return ($@ ? -1 : 0); |
---|
[69f74c2] | 581 | }; |
---|
| 582 | |
---|
[523146b] | 583 | BarnOwl::Internal::new_variable($name, $args{summary}, $args{description}, $args{validsettings}, |
---|
| 584 | $args{takes_on_off}, $get_tostring_fn, $set_fromstring_fn, undef); |
---|
[ee183be] | 585 | } |
---|
| 586 | |
---|
[fc92e6e2] | 587 | =head2 quote LIST |
---|
[ee183be] | 588 | |
---|
[fc92e6e2] | 589 | Quotes each of the strings in LIST and returns a string that will be |
---|
| 590 | correctly decoded to LIST by the BarnOwl command parser. For example: |
---|
| 591 | |
---|
| 592 | quote('zwrite', 'andersk', '-m', 'Hello, world!') |
---|
| 593 | # returns "zwrite andersk -m 'Hello, world!'" |
---|
[ee183be] | 594 | |
---|
| 595 | =cut |
---|
| 596 | |
---|
| 597 | sub quote { |
---|
[fc92e6e2] | 598 | my @quoted; |
---|
| 599 | for my $str (@_) { |
---|
| 600 | if ($str eq '') { |
---|
| 601 | push @quoted, "''"; |
---|
[ef4700c] | 602 | } elsif ($str !~ /['" \n\t]/) { |
---|
[fc92e6e2] | 603 | push @quoted, "$str"; |
---|
| 604 | } elsif ($str !~ /'/) { |
---|
| 605 | push @quoted, "'$str'"; |
---|
| 606 | } else { |
---|
| 607 | (my $qstr = $str) =~ s/"/"'"'"/g; |
---|
| 608 | push @quoted, '"' . $qstr . '"'; |
---|
| 609 | } |
---|
[ee183be] | 610 | } |
---|
[fc92e6e2] | 611 | return join(' ', @quoted); |
---|
[ee183be] | 612 | } |
---|
| 613 | |
---|
[22b54a7] | 614 | =head2 Modify filters by appending text |
---|
| 615 | |
---|
| 616 | =cut |
---|
| 617 | |
---|
[cff58b4] | 618 | sub register_builtin_commands { |
---|
[0b2afba] | 619 | # Filter modification |
---|
[cff58b4] | 620 | BarnOwl::new_command("filterappend", |
---|
| 621 | sub { filter_append_helper('appending', '', @_); }, |
---|
| 622 | { |
---|
| 623 | summary => "append '<text>' to filter", |
---|
| 624 | usage => "filterappend <filter> <text>", |
---|
| 625 | }); |
---|
| 626 | |
---|
| 627 | BarnOwl::new_command("filterand", |
---|
| 628 | sub { filter_append_helper('and-ing', 'and', @_); }, |
---|
| 629 | { |
---|
| 630 | summary => "append 'and <text>' to filter", |
---|
| 631 | usage => "filterand <filter> <text>", |
---|
| 632 | }); |
---|
| 633 | |
---|
| 634 | BarnOwl::new_command("filteror", |
---|
| 635 | sub { filter_append_helper('or-ing', 'or', @_); }, |
---|
| 636 | { |
---|
| 637 | summary => "append 'or <text>' to filter", |
---|
| 638 | usage => "filteror <filter> <text>", |
---|
| 639 | }); |
---|
| 640 | |
---|
[0b2afba] | 641 | # Date formatting |
---|
| 642 | BarnOwl::new_command("showdate", |
---|
| 643 | sub { BarnOwl::time_format('showdate', '%Y-%m-%d %H:%M'); }, |
---|
| 644 | { |
---|
| 645 | summary => "Show date in timestamps for supporting styles.", |
---|
| 646 | usage => "showdate", |
---|
| 647 | }); |
---|
| 648 | |
---|
| 649 | BarnOwl::new_command("hidedate", |
---|
| 650 | sub { BarnOwl::time_format('hidedate', '%H:%M'); }, |
---|
| 651 | { |
---|
| 652 | summary => "Don't show date in timestamps for supporting styles.", |
---|
| 653 | usage => "hidedate", |
---|
| 654 | }); |
---|
| 655 | |
---|
| 656 | BarnOwl::new_command("timeformat", |
---|
| 657 | \&BarnOwl::time_format, |
---|
| 658 | { |
---|
| 659 | summary => "Set the format for timestamps and re-display messages", |
---|
| 660 | usage => "timeformat <format>", |
---|
| 661 | }); |
---|
| 662 | |
---|
[6700c605] | 663 | # Receive window scrolling |
---|
| 664 | BarnOwl::new_command("recv:shiftleft", |
---|
| 665 | \&BarnOwl::recv_shift_left, |
---|
| 666 | { |
---|
| 667 | summary => "scrolls receive window to the left", |
---|
| 668 | usage => "recv:shiftleft [<amount>]", |
---|
| 669 | description => <<END_DESCR |
---|
| 670 | By default, scroll left by 10 columns. Passing no arguments or 0 activates this default behavior. |
---|
| 671 | Otherwise, scroll by the number of columns specified as the argument. |
---|
| 672 | END_DESCR |
---|
| 673 | }); |
---|
| 674 | |
---|
| 675 | BarnOwl::new_command("recv:shiftright", |
---|
| 676 | \&BarnOwl::recv_shift_right, |
---|
| 677 | { |
---|
| 678 | summary => "scrolls receive window to the right", |
---|
| 679 | usage => "recv:shiftright [<amount>]", |
---|
| 680 | description => <<END_DESCR |
---|
| 681 | By default, scroll right by 10 columns. Passing no arguments or 0 activates this default behavior. |
---|
| 682 | Otherwise, scroll by the number of columns specified as the argument. |
---|
| 683 | END_DESCR |
---|
| 684 | }); |
---|
| 685 | |
---|
[cff58b4] | 686 | } |
---|
| 687 | |
---|
| 688 | $BarnOwl::Hooks::startup->add("BarnOwl::register_builtin_commands"); |
---|
[22b54a7] | 689 | |
---|
| 690 | =head3 filter_append_helper ACTION SEP FUNC FILTER APPEND_TEXT |
---|
| 691 | |
---|
| 692 | Helper to append to filters. |
---|
| 693 | |
---|
| 694 | =cut |
---|
| 695 | |
---|
| 696 | sub filter_append_helper |
---|
| 697 | { |
---|
| 698 | my $action = shift; |
---|
| 699 | my $sep = shift; |
---|
| 700 | my $func = shift; |
---|
| 701 | my $filter = shift; |
---|
| 702 | my @append = @_; |
---|
| 703 | my $oldfilter = BarnOwl::getfilter($filter); |
---|
| 704 | chomp $oldfilter; |
---|
[0b5168d] | 705 | my $newfilter = "$oldfilter $sep " . quote(@append); |
---|
| 706 | my $msgtext = "To filter " . quote($filter) . " $action\n" . quote(@append) . "\nto get\n$newfilter"; |
---|
[22b54a7] | 707 | if (BarnOwl::getvar('showfilterchange') eq 'on') { |
---|
| 708 | BarnOwl::admin_message("Filter", $msgtext); |
---|
| 709 | } |
---|
[1b9a163] | 710 | set_filter($filter, $newfilter); |
---|
[22b54a7] | 711 | return; |
---|
| 712 | } |
---|
| 713 | BarnOwl::new_variable_bool("showfilterchange", |
---|
| 714 | { default => 1, |
---|
| 715 | summary => 'Show modifications to filters by filterappend and friends.'}); |
---|
[ee183be] | 716 | |
---|
[1b9a163] | 717 | sub set_filter |
---|
| 718 | { |
---|
| 719 | my $filtername = shift; |
---|
| 720 | my $filtertext = shift; |
---|
| 721 | my $cmd = 'filter ' . BarnOwl::quote($filtername) . ' ' . $filtertext; |
---|
| 722 | BarnOwl::command($cmd); |
---|
| 723 | } |
---|
| 724 | |
---|
[0b2afba] | 725 | =head3 time_format FORMAT |
---|
| 726 | |
---|
| 727 | Set the format for displaying times (variable timeformat) and redisplay |
---|
| 728 | messages. |
---|
| 729 | |
---|
| 730 | =cut |
---|
| 731 | |
---|
[d694c55] | 732 | my $timeformat = '%H:%M'; |
---|
[0b2afba] | 733 | |
---|
| 734 | sub time_format |
---|
| 735 | { |
---|
| 736 | my $function = shift; |
---|
| 737 | my $format = shift; |
---|
| 738 | if(!$format) |
---|
| 739 | { |
---|
| 740 | return $timeformat; |
---|
| 741 | } |
---|
| 742 | if(shift) |
---|
| 743 | { |
---|
| 744 | return "Wrong number of arguments for command"; |
---|
| 745 | } |
---|
| 746 | $timeformat = $format; |
---|
| 747 | redisplay(); |
---|
| 748 | } |
---|
| 749 | |
---|
[6700c605] | 750 | =head3 Receive window scrolling |
---|
| 751 | |
---|
| 752 | Permit scrolling the receive window left or right by arbitrary |
---|
| 753 | amounts (with a default of 10 characters). |
---|
| 754 | |
---|
| 755 | =cut |
---|
| 756 | |
---|
| 757 | sub recv_shift_left |
---|
| 758 | { |
---|
| 759 | my $func = shift; |
---|
| 760 | my $delta = shift; |
---|
[365950b] | 761 | $delta = 10 unless defined($delta) && int($delta) > 0; |
---|
[6700c605] | 762 | my $shift = BarnOwl::recv_getshift(); |
---|
| 763 | if($shift > 0) { |
---|
| 764 | BarnOwl::recv_setshift(max(0, $shift-$delta)); |
---|
| 765 | } else { |
---|
| 766 | return "Already full left"; |
---|
| 767 | } |
---|
| 768 | } |
---|
| 769 | |
---|
| 770 | sub recv_shift_right |
---|
| 771 | { |
---|
| 772 | my $func = shift; |
---|
| 773 | my $delta = shift; |
---|
[675a998] | 774 | $delta = 10 unless defined($delta) && int($delta) > 0; |
---|
[6700c605] | 775 | my $shift = BarnOwl::recv_getshift(); |
---|
| 776 | BarnOwl::recv_setshift($shift+$delta); |
---|
| 777 | } |
---|
| 778 | |
---|
[de3f641] | 779 | =head3 default_zephyr_signature |
---|
| 780 | |
---|
| 781 | Compute the default zephyr signature. |
---|
| 782 | |
---|
| 783 | =cut |
---|
| 784 | |
---|
| 785 | sub default_zephyr_signature |
---|
| 786 | { |
---|
[77c87b2] | 787 | my $zsig = getvar('zsig'); |
---|
[785ee77] | 788 | if (!defined($zsig) || $zsig eq '') { |
---|
| 789 | my $zsigproc = getvar('zsigproc'); |
---|
| 790 | if (defined($zsigproc) && $zsigproc ne '') { |
---|
[3c428d4] | 791 | $zsig = `$zsigproc`; |
---|
| 792 | } elsif (!defined($zsig = get_zephyr_variable('zwrite-signature'))) { |
---|
| 793 | $zsig = ((getpwuid($<))[6]); |
---|
| 794 | $zsig =~ s/,.*//; |
---|
| 795 | } |
---|
[de3f641] | 796 | } |
---|
[77c87b2] | 797 | chomp($zsig); |
---|
| 798 | return $zsig; |
---|
[de3f641] | 799 | } |
---|
| 800 | |
---|
[b120bd3] | 801 | =head3 random_zephyr_signature |
---|
| 802 | |
---|
| 803 | Retrieve a random line from ~/.zsigs (except those beginning with '#') |
---|
| 804 | and use it as the zephyr signature. |
---|
| 805 | |
---|
| 806 | =cut |
---|
| 807 | |
---|
| 808 | sub random_zephyr_signature |
---|
| 809 | { |
---|
| 810 | my $zsigfile = "$ENV{'HOME'}/.zsigs"; |
---|
| 811 | open my $file, '<', $zsigfile or die "Error opening file $zsigfile: $!"; |
---|
| 812 | my @lines = grep !(/^#/ || /^\s*$/), <$file>; |
---|
| 813 | close $file; |
---|
| 814 | return '' if !@lines; |
---|
| 815 | my $zsig = "$lines[int(rand(scalar @lines))]"; |
---|
| 816 | chomp $zsig; |
---|
| 817 | return $zsig; |
---|
| 818 | } |
---|
| 819 | |
---|
[ecd4edf] | 820 | =head3 register_idle_watcher %ARGS |
---|
| 821 | |
---|
| 822 | Call a callback whenever the amount of time the user becomes idle or comes |
---|
| 823 | back from being idle. |
---|
| 824 | |
---|
| 825 | You must include the following parameters: |
---|
| 826 | |
---|
| 827 | =over 4 |
---|
| 828 | |
---|
| 829 | =item name |
---|
| 830 | |
---|
| 831 | The name given to the idle watcher |
---|
| 832 | |
---|
| 833 | =item after |
---|
| 834 | |
---|
| 835 | How long the user must be idle, in seconds, before the callback is called. |
---|
| 836 | If the value is too small, you may have spurious or inaccurate calls. |
---|
| 837 | (The current lower limit is about 1 second.) |
---|
| 838 | |
---|
| 839 | =item callback |
---|
| 840 | |
---|
| 841 | The Perl subroutine that gets called when the user has been idle for C<AFTER> |
---|
| 842 | seconds, or comes back from being idle. The subroutine is passed one parameter, |
---|
| 843 | which is true if the user is currently idle, and false otherwise. |
---|
| 844 | |
---|
| 845 | =back |
---|
| 846 | |
---|
| 847 | This method returns a unique identifier which may be passed to |
---|
| 848 | L<BarnOwl::unregister_idle_watcher>. |
---|
| 849 | |
---|
| 850 | =cut |
---|
| 851 | |
---|
| 852 | =head3 unregister_idle_watcher UNIQUE_ID [...] |
---|
| 853 | |
---|
| 854 | Removed and returns the idle watcher specified by C<UNIQUE_ID>. |
---|
| 855 | You may specify multiple unique ids. |
---|
| 856 | |
---|
| 857 | =cut |
---|
| 858 | |
---|
| 859 | my %idle_watchers; |
---|
| 860 | tie %idle_watchers, 'Tie::RefHash'; |
---|
| 861 | |
---|
| 862 | $BarnOwl::Hooks::wakeup->add(sub { |
---|
| 863 | foreach my $idle_watcher (values %idle_watchers) { |
---|
| 864 | _wakeup_idle_watcher($idle_watcher); |
---|
| 865 | } |
---|
| 866 | }); |
---|
| 867 | |
---|
| 868 | sub _wakeup_idle_watcher { |
---|
| 869 | my ($idle_watcher, $offset) = @_; |
---|
| 870 | $offset = 0 unless defined $offset; |
---|
| 871 | # go unidle |
---|
| 872 | $idle_watcher->{idle_timer}->stop if $idle_watcher->{idle_timer}; |
---|
| 873 | undef $idle_watcher->{idle_timer}; |
---|
| 874 | $idle_watcher->{callback}->(0) if $idle_watcher->{is_idle}; |
---|
| 875 | $idle_watcher->{is_idle} = 0; |
---|
| 876 | |
---|
| 877 | # queue going idle |
---|
| 878 | $idle_watcher->{idle_timer} = BarnOwl::Timer->new({ |
---|
| 879 | name => $idle_watcher->{name}, |
---|
| 880 | after => $idle_watcher->{after} - $offset, |
---|
| 881 | cb => sub { |
---|
| 882 | $idle_watcher->{is_idle} = 1; |
---|
| 883 | $idle_watcher->{callback}->(1); |
---|
| 884 | } |
---|
| 885 | }); |
---|
| 886 | } |
---|
| 887 | |
---|
| 888 | sub register_idle_watcher { |
---|
| 889 | my %args = (@_); |
---|
| 890 | $idle_watchers{\%args} = \%args; |
---|
| 891 | _wakeup_idle_watcher(\%args, BarnOwl::getidletime); # make sure to queue up the idle/unidle events from this idle watcher |
---|
| 892 | return \%args; |
---|
| 893 | } |
---|
| 894 | |
---|
| 895 | sub unregister_idle_watcher { |
---|
| 896 | my ($id) = @_; |
---|
| 897 | $idle_watchers{$id}->{idle_timer}->stop if $idle_watchers{$id}->{idle_timer}; |
---|
| 898 | return delete $idle_watchers{$id}; |
---|
| 899 | } |
---|
| 900 | |
---|
[7589f0a] | 901 | # Stub for owl::startup / BarnOwl::startup, so it isn't bound to the |
---|
| 902 | # startup command. This may be redefined in a user's configfile. |
---|
| 903 | sub startup |
---|
| 904 | { |
---|
| 905 | } |
---|
| 906 | |
---|
[ee183be] | 907 | 1; |
---|