source: owl.c

Last change on this file was 441fd42, checked in by Anders Kaseorg <andersk@mit.edu>, 4 years ago
Replace the last few “Barnowl”s with “BarnOwl”s Signed-off-by: Anders Kaseorg <andersk@mit.edu>
  • Property mode set to 100644
File size: 18.8 KB
Line 
1/*  Copyright (c) 2006-2011 The BarnOwl Developers. All rights reserved.
2 *  Copyright (c) 2004 James Kretchmar. All rights reserved.
3 *
4 *  This program is free software. You can redistribute it and/or
5 *  modify under the terms of the Sleepycat License. See the COPYING
6 *  file included with the distribution for more information.
7 */
8
9#include "owl.h"
10#include <stdio.h>
11#include <getopt.h>
12#include <sys/stat.h>
13#include <locale.h>
14#include <unistd.h>
15
16#if OWL_STDERR_REDIR
17#ifdef HAVE_SYS_IOCTL_H
18#include <sys/ioctl.h>
19#endif
20#ifdef HAVE_SYS_FILIO_H
21#include <sys/filio.h>
22#endif
23int stderr_replace(void);
24#endif
25
26owl_global g;
27
28typedef struct _owl_options {
29  bool load_initial_subs;
30  char *configfile;
31  char *tty;
32  char *confdir;
33  bool debug;
34} owl_options;
35
36void usage(FILE *file)
37{
38  fprintf(file, "BarnOwl version %s\n", version);
39  fprintf(file, "Usage: barnowl [-n] [-d] [-D] [-v] [-h] [-c <configfile>] [-s <confdir>] [-t <ttyname>]\n");
40  fprintf(file, "  -n,--no-subs        don't load zephyr subscriptions\n");
41  fprintf(file, "  -d,--debug          enable debugging\n");
42  fprintf(file, "  -v,--version        print the BarnOwl version number and exit\n");
43  fprintf(file, "  -h,--help           print this help message\n");
44  fprintf(file, "  -s,--config-dir     specify an alternate config dir (default ~/.owl)\n");
45  fprintf(file, "  -c,--config-file    specify an alternate config file (default ~/.owl/init.pl)\n");
46  fprintf(file, "  -t,--tty            set the tty name\n");
47}
48
49/* TODO: free owl_options after init is done? */
50void owl_parse_options(int argc, char *argv[], owl_options *opts) {
51  static const struct option long_options[] = {
52    { "no-subs",         0, 0, 'n' },
53    { "config-file",     1, 0, 'c' },
54    { "config-dir",      1, 0, 's' },
55    { "tty",             1, 0, 't' },
56    { "debug",           0, 0, 'd' },
57    { "version",         0, 0, 'v' },
58    { "help",            0, 0, 'h' },
59    { NULL, 0, NULL, 0}
60  };
61  char c;
62
63  while((c = getopt_long(argc, argv, "nc:t:s:dDvh",
64                         long_options, NULL)) != -1) {
65    switch(c) {
66    case 'n':
67      opts->load_initial_subs = 0;
68      break;
69    case 'c':
70      opts->configfile = g_strdup(optarg);
71      break;
72    case 's':
73      opts->confdir = g_strdup(optarg);
74      break;
75    case 't':
76      opts->tty = g_strdup(optarg);
77      break;
78    case 'd':
79      opts->debug = 1;
80      break;
81    case 'v':
82      printf("This is BarnOwl version %s\n", version);
83      exit(0);
84    case 'h':
85      usage(stdout);
86      exit(0);
87    default:
88      usage(stderr);
89      exit(1);
90    }
91  }
92}
93
94void owl_start_color(void) {
95  start_color();
96#ifdef HAVE_USE_DEFAULT_COLORS
97  use_default_colors();
98#endif
99
100  /* define simple color pairs */
101  if (has_colors() && COLOR_PAIRS>=8) {
102    int bg = COLOR_BLACK;
103#ifdef HAVE_USE_DEFAULT_COLORS
104    bg = -1;
105#endif
106    init_pair(OWL_COLOR_BLACK,   COLOR_BLACK,   bg);
107    init_pair(OWL_COLOR_RED,     COLOR_RED,     bg);
108    init_pair(OWL_COLOR_GREEN,   COLOR_GREEN,   bg);
109    init_pair(OWL_COLOR_YELLOW,  COLOR_YELLOW,  bg);
110    init_pair(OWL_COLOR_BLUE,    COLOR_BLUE,    bg);
111    init_pair(OWL_COLOR_MAGENTA, COLOR_MAGENTA, bg);
112    init_pair(OWL_COLOR_CYAN,    COLOR_CYAN,    bg);
113    init_pair(OWL_COLOR_WHITE,   COLOR_WHITE,   bg);
114  }
115}
116
117void owl_start_curses(void) {
118  struct termios tio;
119  /* save initial terminal settings */
120  tcgetattr(STDIN_FILENO, owl_global_get_startup_tio(&g));
121
122  tcgetattr(STDIN_FILENO, &tio);
123  tio.c_iflag &= ~(ISTRIP|IEXTEN);
124  tio.c_cc[VQUIT] = fpathconf(STDIN_FILENO, _PC_VDISABLE);
125  tio.c_cc[VSUSP] = fpathconf(STDIN_FILENO, _PC_VDISABLE);
126  tio.c_cc[VSTART] = fpathconf(STDIN_FILENO, _PC_VDISABLE);
127  tio.c_cc[VSTOP] = fpathconf(STDIN_FILENO, _PC_VDISABLE);
128  tcsetattr(STDIN_FILENO, TCSAFLUSH, &tio);
129
130  /* screen init */
131  initscr();
132  cbreak();
133  noecho();
134
135  owl_start_color();
136}
137
138void owl_shutdown_curses(void) {
139  endwin();
140  /* restore terminal settings */
141  tcsetattr(STDIN_FILENO, TCSAFLUSH, owl_global_get_startup_tio(&g));
142}
143
144/*
145 * Process a new message passed to us on the message queue from some
146 * protocol. This includes adding it to the message list, updating the
147 * view and scrolling if appropriate, logging it, and so on.
148 *
149 * Either a pointer is kept to the message internally, or it is freed
150 * if unneeded. The caller no longer ``owns'' the message's memory.
151 *
152 * Returns 1 if the message was added to the message list, and 0 if it
153 * was ignored due to user settings or otherwise.
154 */
155static int owl_process_message(owl_message *m) {
156  const owl_filter *f;
157  /* if this message it on the puntlist, nuke it and continue */
158  if (owl_global_message_is_puntable(&g, m)) {
159    owl_message_delete(m);
160    return 0;
161  }
162
163  /*  login or logout that should be ignored? */
164  if (owl_global_is_ignorelogins(&g)
165      && owl_message_is_loginout(m)) {
166    owl_message_delete(m);
167    return 0;
168  }
169
170  if (!owl_global_is_displayoutgoing(&g)
171      && owl_message_is_direction_out(m)) {
172    owl_message_delete(m);
173    return 0;
174  }
175
176  /* add it to the global list */
177  owl_messagelist_append_element(owl_global_get_msglist(&g), m);
178  /* add it to any necessary views; right now there's only the current view */
179  owl_view_consider_message(owl_global_get_current_view(&g), m);
180
181  if(owl_message_is_direction_in(m)) {
182    /* let perl know about it*/
183    owl_perlconfig_getmsg(m, NULL);
184
185    /* do we need to autoreply? */
186    if (owl_global_is_zaway(&g) && !owl_message_get_attribute_value(m, "isauto")) {
187      if (owl_message_is_type_zephyr(m)) {
188        owl_zephyr_zaway(m);
189      } else if (owl_message_is_type_aim(m)) {
190        if (owl_message_is_private(m)) {
191          owl_function_send_aimawymsg(owl_message_get_sender(m), owl_global_get_zaway_msg(&g));
192        }
193      }
194    }
195
196    /* ring the bell if it's a personal */
197    if (!strcmp(owl_global_get_personalbell(&g), "on")) {
198      if (!owl_message_is_loginout(m) &&
199          !owl_message_is_mail(m) &&
200          owl_message_is_personal(m)) {
201        owl_function_beep();
202      }
203    } else if (!strcmp(owl_global_get_personalbell(&g), "off")) {
204      /* do nothing */
205    } else {
206      f=owl_global_get_filter(&g, owl_global_get_personalbell(&g));
207      if (f && owl_filter_message_match(f, m)) {
208        owl_function_beep();
209      }
210    }
211
212    /* if it matches the alert filter, do the alert action */
213    f=owl_global_get_filter(&g, owl_global_get_alert_filter(&g));
214    if (f && owl_filter_message_match(f, m)) {
215      owl_function_command_norv(owl_global_get_alert_action(&g));
216    }
217
218    /* if it's a zephyr login or logout, update the zbuddylist */
219    if (owl_message_is_type_zephyr(m) && owl_message_is_loginout(m)) {
220      if (owl_message_is_login(m)) {
221        owl_zbuddylist_adduser(owl_global_get_zephyr_buddylist(&g), owl_message_get_sender(m));
222      } else if (owl_message_is_logout(m)) {
223        owl_zbuddylist_deluser(owl_global_get_zephyr_buddylist(&g), owl_message_get_sender(m));
224      } else {
225        owl_function_error("Internal error: received login notice that is neither login nor logout");
226      }
227    }
228  }
229
230  /* let perl know about it */
231  owl_perlconfig_newmsg(m, NULL);
232  /* log the message if we need to */
233  owl_log_message(m);
234  /* redraw the sepbar; TODO: don't violate layering */
235  owl_global_sepbar_dirty(&g);
236
237  return 1;
238}
239
240static gboolean owl_process_messages_prepare(GSource *source, int *timeout) {
241  *timeout = -1;
242  return owl_global_messagequeue_pending(&g);
243}
244
245static gboolean owl_process_messages_check(GSource *source) {
246  return owl_global_messagequeue_pending(&g);
247}
248
249/*
250 * Process any new messages we have waiting in the message queue.
251 */
252static gboolean owl_process_messages_dispatch(GSource *source, GSourceFunc callback, gpointer user_data) {
253  int newmsgs=0;
254  int followlast = owl_global_should_followlast(&g);
255  owl_message *m;
256
257  /* Grab incoming messages. */
258  while (owl_global_messagequeue_pending(&g)) {
259    m = owl_global_messagequeue_popmsg(&g);
260    if (owl_process_message(m))
261      newmsgs = 1;
262  }
263
264  if (newmsgs) {
265    /* follow the last message if we're supposed to */
266    if (followlast)
267      owl_function_lastmsg();
268
269    /* do the newmsgproc thing */
270    owl_function_do_newmsgproc();
271
272    /* redisplay if necessary */
273    /* this should be optimized to not run if the new messages won't be displayed */
274    owl_mainwin_redisplay(owl_global_get_mainwin(&g));
275  }
276  return TRUE;
277}
278
279static GSourceFuncs owl_process_messages_funcs = {
280  owl_process_messages_prepare,
281  owl_process_messages_check,
282  owl_process_messages_dispatch,
283  NULL
284};
285
286void owl_process_input_char(owl_input j)
287{
288  int ret;
289
290  owl_global_set_lastinputtime(&g, time(NULL));
291  owl_global_wakeup(&g);
292  ret = owl_keyhandler_process(owl_global_get_keyhandler(&g), j);
293  if (ret!=0 && ret!=1) {
294    owl_function_makemsg("Unable to handle keypress");
295  }
296}
297
298gboolean owl_process_input(GIOChannel *source, GIOCondition condition, void *data)
299{
300  owl_global *g = data;
301  owl_input j;
302
303  while (1) {
304    j.ch = wgetch(g->input_pad);
305    if (j.ch == ERR) return TRUE;
306
307    j.uch = '\0';
308    if (j.ch >= KEY_MIN && j.ch <= KEY_MAX) {
309      /* This is a curses control character. */
310    }
311    else if (j.ch > 0x7f && j.ch < 0xfe) {
312      /* Pull in a full utf-8 character. */
313      int bytes, i;
314      char utf8buf[7];
315      memset(utf8buf, '\0', 7);
316     
317      utf8buf[0] = j.ch;
318     
319      if ((j.ch & 0xc0) && (~j.ch & 0x20)) bytes = 2;
320      else if ((j.ch & 0xe0) && (~j.ch & 0x10)) bytes = 3;
321      else if ((j.ch & 0xf0) && (~j.ch & 0x08)) bytes = 4;
322      else if ((j.ch & 0xf8) && (~j.ch & 0x04)) bytes = 5;
323      else if ((j.ch & 0xfc) && (~j.ch & 0x02)) bytes = 6;
324      else bytes = 1;
325     
326      for (i = 1; i < bytes; i++) {
327        int tmp = wgetch(g->input_pad);
328        /* If what we got was not a byte, or not a continuation byte */
329        if (tmp > 0xff || !(tmp & 0x80 && ~tmp & 0x40)) {
330          /* ill-formed UTF-8 code unit subsequence, put back the
331             char we just got. */
332          ungetch(tmp);
333          j.ch = ERR;
334          break;
335        }
336        utf8buf[i] = tmp;
337      }
338     
339      if (j.ch != ERR) {
340        if (g_utf8_validate(utf8buf, -1, NULL)) {
341          j.uch = g_utf8_get_char(utf8buf);
342        }
343        else {
344          j.ch = ERR;
345        }
346      }
347    }
348    else if (j.ch <= 0x7f) {
349      j.uch = j.ch;
350    }
351
352    owl_process_input_char(j);
353  }
354  return TRUE;
355}
356
357static void sig_handler_main_thread(void *data) {
358  int sig = GPOINTER_TO_INT(data);
359
360  owl_function_debugmsg("Got signal %d", sig);
361  if (sig == SIGWINCH) {
362    owl_function_resize();
363  } else if (sig == SIGTERM || sig == SIGHUP) {
364    owl_function_quit();
365  } else if (sig == SIGINT && owl_global_take_interrupt(&g)) {
366    owl_input in;
367    in.ch = in.uch = owl_global_get_startup_tio(&g)->c_cc[VINTR];
368    owl_process_input_char(in);
369  }
370}
371
372static void sig_handler(const siginfo_t *siginfo, void *data) {
373  /* If it was an interrupt, set a flag so we can handle it earlier if
374   * needbe. sig_handler_main_thread will check the flag to make sure
375   * no one else took it. */
376  if (siginfo->si_signo == SIGINT) {
377    owl_global_add_interrupt(&g);
378  }
379  /* Send a message to the main thread. */
380  owl_select_post_task(sig_handler_main_thread,
381                       GINT_TO_POINTER(siginfo->si_signo), 
382                       NULL, g_main_context_default());
383}
384
385#define OR_DIE(s, syscall)       \
386  G_STMT_START {                 \
387    if ((syscall) == -1) {       \
388      perror((s));               \
389      exit(1);                   \
390    }                            \
391  } G_STMT_END
392
393void owl_register_signal_handlers(void) {
394  struct sigaction sig_ignore = { .sa_handler = SIG_IGN };
395  struct sigaction sig_default = { .sa_handler = SIG_DFL };
396  sigset_t sigset;
397  int ret, i;
398  const int reset_signals[] = { SIGABRT, SIGBUS, SIGCHLD, SIGFPE, SIGILL,
399                                SIGQUIT, SIGSEGV, };
400  /* Don't bother resetting watched ones because owl_signal_init will. */
401  const int watch_signals[] = { SIGWINCH, SIGTERM, SIGHUP, SIGINT, };
402
403  /* Sanitize our signals; the mask and dispositions from our parent
404   * aren't really useful. Signal list taken from equivalent code in
405   * Chromium. */
406  OR_DIE("sigemptyset", sigemptyset(&sigset));
407  if ((ret = pthread_sigmask(SIG_SETMASK, &sigset, NULL)) != 0) {
408    errno = ret;
409    perror("pthread_sigmask");
410    exit(1);
411  }
412  for (i = 0; i < G_N_ELEMENTS(reset_signals); i++) {
413    OR_DIE("sigaction", sigaction(reset_signals[i], &sig_default, NULL));
414  }
415
416  /* Turn off SIGPIPE; we check the return value of write. */
417  OR_DIE("sigaction", sigaction(SIGPIPE, &sig_ignore, NULL));
418
419  /* Register some signals with the signal thread. */
420  owl_signal_init(watch_signals, G_N_ELEMENTS(watch_signals),
421                  sig_handler, NULL);
422}
423
424#if OWL_STDERR_REDIR
425
426/* Replaces stderr with a pipe so that we can read from it.
427 * Returns the fd of the pipe from which stderr can be read. */
428int stderr_replace(void)
429{
430  int pipefds[2];
431  if (0 != pipe(pipefds)) {
432    perror("pipe");
433    owl_function_debugmsg("stderr_replace: pipe FAILED");
434    return -1;
435  }
436    owl_function_debugmsg("stderr_replace: pipe: %d,%d", pipefds[0], pipefds[1]);
437  if (-1 == dup2(pipefds[1], STDERR_FILENO)) {
438    owl_function_debugmsg("stderr_replace: dup2 FAILED (%s)", strerror(errno));
439    perror("dup2");
440    return -1;
441  }
442  return pipefds[0];
443}
444
445/* Sends stderr (read from rfd) messages to the error console */
446gboolean stderr_redirect_handler(GIOChannel *source, GIOCondition condition, void *data)
447{
448  int navail, bread;
449  char buf[4096];
450  int rfd = g_io_channel_unix_get_fd(source);
451  char *err;
452
453  /* TODO: Use g_io_channel_read_line? We'd have to be careful about
454   * blocking on the read. */
455
456  if (rfd<0) return TRUE;
457  if (-1 == ioctl(rfd, FIONREAD, &navail)) {
458    return TRUE;
459  }
460  /*owl_function_debugmsg("stderr_redirect: navail = %d\n", navail);*/
461  if (navail <= 0) return TRUE;
462  if (navail > sizeof(buf)-1) {
463    navail = sizeof(buf)-1;
464  }
465  bread = read(rfd, buf, navail);
466  if (bread == -1)
467    return TRUE;
468
469  err = g_strdup_printf("[stderr]\n%.*s", bread, buf);
470
471  owl_function_log_err(err);
472  g_free(err);
473  return TRUE;
474}
475
476#endif /* OWL_STDERR_REDIR */
477
478int main(int argc, char **argv, char **env)
479{
480  int argc_copy;
481  char **argv_copy;
482  char *perlout, *perlerr;
483  const owl_style *s;
484  const char *dir;
485  owl_options opts;
486  GSource *source;
487  GIOChannel *channel;
488
489  argc_copy = argc;
490  argv_copy = g_strdupv(argv);
491
492  setlocale(LC_ALL, "");
493
494  memset(&opts, 0, sizeof opts);
495  opts.load_initial_subs = 1;
496  owl_parse_options(argc, argv, &opts);
497  g.load_initial_subs = opts.load_initial_subs;
498
499  owl_start_curses();
500
501  /* owl global init */
502  owl_global_init(&g);
503  if (opts.debug) owl_global_set_debug_on(&g);
504  if (opts.confdir) owl_global_set_confdir(&g, opts.confdir);
505  owl_function_debugmsg("startup: first available debugging message");
506  owl_global_set_startupargs(&g, argc_copy, argv_copy);
507  g_strfreev(argv_copy);
508  owl_global_set_haveaim(&g);
509
510  owl_register_signal_handlers();
511
512  /* register STDIN dispatch; throw away return, we won't need it */
513  channel = g_io_channel_unix_new(STDIN_FILENO);
514  g_io_add_watch(channel, G_IO_IN | G_IO_HUP | G_IO_ERR, &owl_process_input, &g);
515  g_io_channel_unref(channel);
516  owl_zephyr_initialize();
517
518#if OWL_STDERR_REDIR
519  /* Do this only after we've started curses up... */
520  if (isatty(STDERR_FILENO)) {
521    owl_function_debugmsg("startup: doing stderr redirection");
522    channel = g_io_channel_unix_new(stderr_replace());
523    g_io_add_watch(channel, G_IO_IN | G_IO_HUP | G_IO_ERR, &stderr_redirect_handler, NULL);
524    g_io_channel_unref(channel);
525  }
526#endif
527
528  /* create the owl directory, in case it does not exist */
529  owl_function_debugmsg("startup: creating owl directory, if not present");
530  dir=owl_global_get_confdir(&g);
531  mkdir(dir, S_IRWXU);
532
533  /* set the tty, either from the command line, or by figuring it out */
534  owl_function_debugmsg("startup: setting tty name");
535  if (opts.tty) {
536    owl_global_set_tty(&g, opts.tty);
537  } else {
538    char *tty = owl_util_get_default_tty();
539    owl_global_set_tty(&g, tty);
540    g_free(tty);
541  }
542
543  /* Initialize perl */
544  owl_function_debugmsg("startup: processing config file");
545
546  owl_global_pop_context(&g);
547  owl_global_push_context(&g, OWL_CTX_READCONFIG, NULL, NULL, NULL);
548
549  perlerr=owl_perlconfig_initperl(opts.configfile, &argc, &argv, &env);
550  if (perlerr) {
551    endwin();
552    fprintf(stderr, "Internal perl error: %s\n", perlerr);
553    fflush(stderr);
554    printf("Internal perl error: %s\n", perlerr);
555    fflush(stdout);
556    exit(1);
557  }
558
559  owl_global_complete_setup(&g);
560
561  owl_global_setup_default_filters(&g);
562
563  /* set the current view */
564  owl_function_debugmsg("startup: setting the current view");
565  owl_view_create(owl_global_get_current_view(&g), "main",
566                  owl_global_get_filter(&g, "all"),
567                  owl_global_get_style_by_name(&g, "default"));
568
569  /* AIM init */
570  owl_function_debugmsg("startup: doing AIM initialization");
571  owl_aim_init();
572
573  /* execute the startup function in the configfile */
574  owl_function_debugmsg("startup: executing perl startup, if applicable");
575  perlout = owl_perlconfig_execute("BarnOwl::Hooks::_startup();");
576  g_free(perlout);
577
578  /* welcome message */
579  owl_function_debugmsg("startup: creating splash message");
580  char *welcome = g_strdup_printf(
581    "-----------------------------------------------------------------------\n"
582    "Welcome to BarnOwl version %s.\n"
583    "To see a quick introduction, type ':show quickstart'.                  \n"
584    "Press 'h' for on-line help.                                            \n"
585    "                                                                       \n"
586    "BarnOwl is free software. Type ':show license' for more                \n"
587    "information.                                                     ^ ^   \n"
588    "                                                                 OvO   \n"
589    "Please report any bugs or suggestions to bug-barnowl@mit.edu    (   )  \n"
590    "-----------------------------------------------------------------m-m---\n",
591    version);
592  owl_function_adminmsg("", welcome);
593  g_free(welcome);
594
595  owl_function_debugmsg("startup: setting context interactive");
596
597  owl_global_pop_context(&g);
598  owl_global_push_context(&g, OWL_CTX_INTERACTIVE|OWL_CTX_RECV, NULL, "recv", NULL);
599
600  /* process the startup file */
601  owl_function_debugmsg("startup: processing startup file");
602  owl_function_source(NULL);
603
604  owl_function_debugmsg("startup: set style for the view: %s", owl_global_get_default_style(&g));
605  s = owl_global_get_style_by_name(&g, owl_global_get_default_style(&g));
606  if(s)
607      owl_view_set_style(owl_global_get_current_view(&g), s);
608  else
609      owl_function_error("No such style: %s", owl_global_get_default_style(&g));
610
611  source = owl_window_redraw_source_new();
612  g_source_attach(source, NULL);
613  g_source_unref(source);
614
615  source = g_source_new(&owl_process_messages_funcs, sizeof(GSource));
616  g_source_attach(source, NULL);
617  g_source_unref(source);
618
619  owl_log_init();
620
621  owl_function_debugmsg("startup: entering main loop");
622  owl_select_run_loop();
623
624  /* Shut down everything. */
625  owl_zephyr_shutdown();
626  owl_signal_shutdown();
627  owl_shutdown_curses();
628  owl_log_shutdown();
629  return 0;
630}
Note: See TracBrowser for help on using the repository browser.