source: owl.c @ 257b9c4

release-1.8release-1.9
Last change on this file since 257b9c4 was 3535a6e, checked in by David Benjamin <davidben@mit.edu>, 10 years ago
First go at sigwait-based signal handling Instead of relying on pselect and signal masking to listen for signals, which glib doesn't support, we spawn a dedicated signal thread that loops in sigwait. These signals are posted back to the main message loop which may handle them at will. This avoids the need for complex reentrant code and sig_atomic_t. This removes the final pre-select action. SIGINT doesn't quite work right yet because we can no longer take it in the middle of an event loop iteration.
  • Property mode set to 100644
File size: 17.3 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 <stdio.h>
10#include <unistd.h>
11#include <getopt.h>
12#include <stdlib.h>
13#include <string.h>
14#include <signal.h>
15#include <time.h>
16#include <sys/param.h>
17#include <sys/types.h>
18#include <sys/time.h>
19#include <termios.h>
20#include <sys/stat.h>
21#include <locale.h>
22#include "owl.h"
23
24
25#if OWL_STDERR_REDIR
26#ifdef HAVE_SYS_IOCTL_H
27#include <sys/ioctl.h>
28#endif
29#ifdef HAVE_SYS_FILIO_H
30#include <sys/filio.h>
31#endif
32int stderr_replace(void);
33#endif
34
35owl_global g;
36
37typedef struct _owl_options {
38  bool load_initial_subs;
39  char *configfile;
40  char *tty;
41  char *confdir;
42  bool debug;
43  bool rm_debug;
44} owl_options;
45
46void usage(void)
47{
48  fprintf(stderr, "Barnowl version %s\n", OWL_VERSION_STRING);
49  fprintf(stderr, "Usage: barnowl [-n] [-d] [-D] [-v] [-h] [-c <configfile>] [-s <confdir>] [-t <ttyname>]\n");
50  fprintf(stderr, "  -n,--no-subs        don't load zephyr subscriptions\n");
51  fprintf(stderr, "  -d,--debug          enable debugging\n");
52  fprintf(stderr, "  -D,--remove-debug   enable debugging and delete previous debug file\n");
53  fprintf(stderr, "  -v,--version        print the Barnowl version number and exit\n");
54  fprintf(stderr, "  -h,--help           print this help message\n");
55  fprintf(stderr, "  -c,--config-file    specify an alternate config file\n");
56  fprintf(stderr, "  -s,--config-dir     specify an alternate config dir (default ~/.owl)\n");
57  fprintf(stderr, "  -t,--tty            set the tty name\n");
58}
59
60/* TODO: free owl_options after init is done? */
61void owl_parse_options(int argc, char *argv[], owl_options *opts) {
62  static const struct option long_options[] = {
63    { "no-subs",         0, 0, 'n' },
64    { "config-file",     1, 0, 'c' },
65    { "config-dir",      1, 0, 's' },
66    { "tty",             1, 0, 't' },
67    { "debug",           0, 0, 'd' },
68    { "remove-debug",    0, 0, 'D' },
69    { "version",         0, 0, 'v' },
70    { "help",            0, 0, 'h' },
71    { NULL, 0, NULL, 0}
72  };
73  char c;
74
75  while((c = getopt_long(argc, argv, "nc:t:s:dDvh",
76                         long_options, NULL)) != -1) {
77    switch(c) {
78    case 'n':
79      opts->load_initial_subs = 0;
80      break;
81    case 'c':
82      opts->configfile = g_strdup(optarg);
83      break;
84    case 's':
85      opts->confdir = g_strdup(optarg);
86      break;
87    case 't':
88      opts->tty = g_strdup(optarg);
89      break;
90    case 'D':
91      opts->rm_debug = 1;
92      /* fallthrough */
93    case 'd':
94      opts->debug = 1;
95      break;
96    case 'v':
97      printf("This is barnowl version %s\n", OWL_VERSION_STRING);
98      exit(0);
99    case 'h':
100    default:
101      usage();
102      exit(1);
103    }
104  }
105}
106
107void owl_start_color(void) {
108  start_color();
109#ifdef HAVE_USE_DEFAULT_COLORS
110  use_default_colors();
111#endif
112
113  /* define simple color pairs */
114  if (has_colors() && COLOR_PAIRS>=8) {
115    int bg = COLOR_BLACK;
116#ifdef HAVE_USE_DEFAULT_COLORS
117    bg = -1;
118#endif
119    init_pair(OWL_COLOR_BLACK,   COLOR_BLACK,   bg);
120    init_pair(OWL_COLOR_RED,     COLOR_RED,     bg);
121    init_pair(OWL_COLOR_GREEN,   COLOR_GREEN,   bg);
122    init_pair(OWL_COLOR_YELLOW,  COLOR_YELLOW,  bg);
123    init_pair(OWL_COLOR_BLUE,    COLOR_BLUE,    bg);
124    init_pair(OWL_COLOR_MAGENTA, COLOR_MAGENTA, bg);
125    init_pair(OWL_COLOR_CYAN,    COLOR_CYAN,    bg);
126    init_pair(OWL_COLOR_WHITE,   COLOR_WHITE,   bg);
127  }
128}
129
130void owl_start_curses(void) {
131  struct termios tio;
132  /* save initial terminal settings */
133  tcgetattr(STDIN_FILENO, owl_global_get_startup_tio(&g));
134
135  tcgetattr(STDIN_FILENO, &tio);
136  tio.c_iflag &= ~(ISTRIP|IEXTEN);
137  tio.c_cc[VQUIT] = fpathconf(STDIN_FILENO, _PC_VDISABLE);
138  tio.c_cc[VSUSP] = fpathconf(STDIN_FILENO, _PC_VDISABLE);
139  tio.c_cc[VSTART] = fpathconf(STDIN_FILENO, _PC_VDISABLE);
140  tio.c_cc[VSTOP] = fpathconf(STDIN_FILENO, _PC_VDISABLE);
141  tcsetattr(STDIN_FILENO, TCSAFLUSH, &tio);
142
143  /* screen init */
144  initscr();
145  cbreak();
146  noecho();
147
148  owl_start_color();
149}
150
151void owl_shutdown_curses(void) {
152  endwin();
153  /* restore terminal settings */
154  tcsetattr(STDIN_FILENO, TCSAFLUSH, owl_global_get_startup_tio(&g));
155}
156
157/*
158 * Process a new message passed to us on the message queue from some
159 * protocol. This includes adding it to the message list, updating the
160 * view and scrolling if appropriate, logging it, and so on.
161 *
162 * Either a pointer is kept to the message internally, or it is freed
163 * if unneeded. The caller no longer ``owns'' the message's memory.
164 *
165 * Returns 1 if the message was added to the message list, and 0 if it
166 * was ignored due to user settings or otherwise.
167 */
168static int owl_process_message(owl_message *m) {
169  const owl_filter *f;
170  /* if this message it on the puntlist, nuke it and continue */
171  if (owl_global_message_is_puntable(&g, m)) {
172    owl_message_delete(m);
173    return 0;
174  }
175
176  /*  login or logout that should be ignored? */
177  if (owl_global_is_ignorelogins(&g)
178      && owl_message_is_loginout(m)) {
179    owl_message_delete(m);
180    return 0;
181  }
182
183  if (!owl_global_is_displayoutgoing(&g)
184      && owl_message_is_direction_out(m)) {
185    owl_message_delete(m);
186    return 0;
187  }
188
189  /* add it to the global list */
190  owl_messagelist_append_element(owl_global_get_msglist(&g), m);
191  /* add it to any necessary views; right now there's only the current view */
192  owl_view_consider_message(owl_global_get_current_view(&g), m);
193
194  if(owl_message_is_direction_in(m)) {
195    /* let perl know about it*/
196    owl_perlconfig_getmsg(m, NULL);
197
198    /* do we need to autoreply? */
199    if (owl_global_is_zaway(&g) && !owl_message_get_attribute_value(m, "isauto")) {
200      if (owl_message_is_type_zephyr(m)) {
201        owl_zephyr_zaway(m);
202      } else if (owl_message_is_type_aim(m)) {
203        if (owl_message_is_private(m)) {
204          owl_function_send_aimawymsg(owl_message_get_sender(m), owl_global_get_zaway_msg(&g));
205        }
206      }
207    }
208
209    /* ring the bell if it's a personal */
210    if (!strcmp(owl_global_get_personalbell(&g), "on")) {
211      if (!owl_message_is_loginout(m) &&
212          !owl_message_is_mail(m) &&
213          owl_message_is_personal(m)) {
214        owl_function_beep();
215      }
216    } else if (!strcmp(owl_global_get_personalbell(&g), "off")) {
217      /* do nothing */
218    } else {
219      f=owl_global_get_filter(&g, owl_global_get_personalbell(&g));
220      if (f && owl_filter_message_match(f, m)) {
221        owl_function_beep();
222      }
223    }
224
225    /* if it matches the alert filter, do the alert action */
226    f=owl_global_get_filter(&g, owl_global_get_alert_filter(&g));
227    if (f && owl_filter_message_match(f, m)) {
228      owl_function_command_norv(owl_global_get_alert_action(&g));
229    }
230
231    /* if it's a zephyr login or logout, update the zbuddylist */
232    if (owl_message_is_type_zephyr(m) && owl_message_is_loginout(m)) {
233      if (owl_message_is_login(m)) {
234        owl_zbuddylist_adduser(owl_global_get_zephyr_buddylist(&g), owl_message_get_sender(m));
235      } else if (owl_message_is_logout(m)) {
236        owl_zbuddylist_deluser(owl_global_get_zephyr_buddylist(&g), owl_message_get_sender(m));
237      } else {
238        owl_function_error("Internal error: received login notice that is neither login nor logout");
239      }
240    }
241  }
242
243  /* let perl know about it */
244  owl_perlconfig_newmsg(m, NULL);
245  /* log the message if we need to */
246  owl_log_message(m);
247  /* redraw the sepbar; TODO: don't violate layering */
248  owl_global_sepbar_dirty(&g);
249
250  return 1;
251}
252
253static gboolean owl_process_messages_prepare(GSource *source, int *timeout) {
254  *timeout = -1;
255  return owl_global_messagequeue_pending(&g);
256}
257
258static gboolean owl_process_messages_check(GSource *source) {
259  return owl_global_messagequeue_pending(&g);
260}
261
262/*
263 * Process any new messages we have waiting in the message queue.
264 */
265static gboolean owl_process_messages_dispatch(GSource *source, GSourceFunc callback, gpointer user_data) {
266  int newmsgs=0;
267  int followlast = owl_global_should_followlast(&g);
268  owl_message *m;
269
270  /* Grab incoming messages. */
271  while (owl_global_messagequeue_pending(&g)) {
272    m = owl_global_messagequeue_popmsg(&g);
273    if (owl_process_message(m))
274      newmsgs = 1;
275  }
276
277  if (newmsgs) {
278    /* follow the last message if we're supposed to */
279    if (followlast)
280      owl_function_lastmsg_noredisplay();
281
282    /* do the newmsgproc thing */
283    owl_function_do_newmsgproc();
284
285    /* redisplay if necessary */
286    /* this should be optimized to not run if the new messages won't be displayed */
287    owl_mainwin_redisplay(owl_global_get_mainwin(&g));
288  }
289  return TRUE;
290}
291
292static GSourceFuncs owl_process_messages_funcs = {
293  owl_process_messages_prepare,
294  owl_process_messages_check,
295  owl_process_messages_dispatch,
296  NULL
297};
298
299void owl_process_input(const owl_io_dispatch *d, void *data)
300{
301  owl_input j;
302
303  while (1) {
304    j.ch = wgetch(g.input_pad);
305    if (j.ch == ERR) return;
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}
355
356static void sig_handler(int sig, void *data) {
357  owl_function_debugmsg("Got signal %d", sig);
358  /* TODO: These don't need to be re-entrant anymore! */
359  if (sig == SIGWINCH) {
360    /* we can't inturrupt a malloc here, so it just sets a flag
361     * schedulding a resize for later
362     */
363    owl_function_resize();
364  } else if (sig == SIGPIPE || sig == SIGCHLD) {
365    owl_function_error("Got unexpected signal: %d %s",
366                       sig, (sig == SIGPIPE) ? "SIGPIPE" : "SIGCHLD");
367  } else if (sig == SIGTERM || sig == SIGHUP) {
368    owl_function_quit();
369  } else if (sig == SIGINT) {
370    owl_input in;
371    in.ch = in.uch = owl_global_get_startup_tio(&g)->c_cc[VINTR];
372    owl_process_input_char(in);
373  }
374}
375
376void owl_register_signal_handlers(void) {
377  sigset_t sigset;
378
379  sigemptyset(&sigset);
380  sigaddset(&sigset, SIGWINCH);
381  sigaddset(&sigset, SIGALRM);
382  sigaddset(&sigset, SIGPIPE);
383  sigaddset(&sigset, SIGTERM);
384  sigaddset(&sigset, SIGHUP);
385  sigaddset(&sigset, SIGINT);
386
387  owl_signal_init(&sigset, sig_handler, NULL);
388}
389
390#if OWL_STDERR_REDIR
391
392/* Replaces stderr with a pipe so that we can read from it.
393 * Returns the fd of the pipe from which stderr can be read. */
394int stderr_replace(void)
395{
396  int pipefds[2];
397  if (0 != pipe(pipefds)) {
398    perror("pipe");
399    owl_function_debugmsg("stderr_replace: pipe FAILED\n");
400    return -1;
401  }
402    owl_function_debugmsg("stderr_replace: pipe: %d,%d\n", pipefds[0], pipefds[1]);
403  if (-1 == dup2(pipefds[1], 2 /*stderr*/)) {
404    owl_function_debugmsg("stderr_replace: dup2 FAILED (%s)\n", strerror(errno));
405    perror("dup2");
406    return -1;
407  }
408  return pipefds[0];
409}
410
411/* Sends stderr (read from rfd) messages to the error console */
412void stderr_redirect_handler(const owl_io_dispatch *d, void *data)
413{
414  int navail, bread;
415  char buf[4096];
416  int rfd = d->fd;
417  char *err;
418
419  if (rfd<0) return;
420  if (-1 == ioctl(rfd, FIONREAD, &navail)) {
421    return;
422  }
423  /*owl_function_debugmsg("stderr_redirect: navail = %d\n", navail);*/
424  if (navail <= 0) return;
425  if (navail > sizeof(buf)-1) {
426    navail = sizeof(buf)-1;
427  }
428  bread = read(rfd, buf, navail);
429  if (buf[navail-1] != '\0') {
430    buf[navail] = '\0';
431  }
432
433  err = g_strdup_printf("[stderr]\n%s", buf);
434
435  owl_function_log_err(err);
436  g_free(err);
437}
438
439#endif /* OWL_STDERR_REDIR */
440
441int main(int argc, char **argv, char **env)
442{
443  int argc_copy;
444  char **argv_copy;
445  char *perlout, *perlerr;
446  const owl_style *s;
447  const char *dir;
448  owl_options opts;
449  GSource *source;
450
451  if (!GLIB_CHECK_VERSION (2, 12, 0))
452    g_error ("GLib version 2.12.0 or above is needed.");
453
454  argc_copy = argc;
455  argv_copy = g_strdupv(argv);
456
457  setlocale(LC_ALL, "");
458
459  memset(&opts, 0, sizeof opts);
460  opts.load_initial_subs = 1;
461  owl_parse_options(argc, argv, &opts);
462  g.load_initial_subs = opts.load_initial_subs;
463
464  owl_start_curses();
465
466  /* owl global init */
467  owl_global_init(&g);
468  if (opts.rm_debug) unlink(OWL_DEBUG_FILE);
469  if (opts.debug) owl_global_set_debug_on(&g);
470  if (opts.confdir) owl_global_set_confdir(&g, opts.confdir);
471  owl_function_debugmsg("startup: first available debugging message");
472  owl_global_set_startupargs(&g, argc_copy, argv_copy);
473  g_strfreev(argv_copy);
474  owl_global_set_haveaim(&g);
475
476  owl_register_signal_handlers();
477
478  /* register STDIN dispatch; throw away return, we won't need it */
479  owl_select_add_io_dispatch(STDIN_FILENO, OWL_IO_READ, &owl_process_input, NULL, NULL);
480  owl_zephyr_initialize();
481
482#if OWL_STDERR_REDIR
483  /* Do this only after we've started curses up... */
484  owl_function_debugmsg("startup: doing stderr redirection");
485  owl_select_add_io_dispatch(stderr_replace(), OWL_IO_READ, &stderr_redirect_handler, NULL, NULL);
486#endif
487
488  /* create the owl directory, in case it does not exist */
489  owl_function_debugmsg("startup: creating owl directory, if not present");
490  dir=owl_global_get_confdir(&g);
491  mkdir(dir, S_IRWXU);
492
493  /* set the tty, either from the command line, or by figuring it out */
494  owl_function_debugmsg("startup: setting tty name");
495  if (opts.tty) {
496    owl_global_set_tty(&g, opts.tty);
497  } else {
498    char *tty = owl_util_get_default_tty();
499    owl_global_set_tty(&g, tty);
500    g_free(tty);
501  }
502
503  /* Initialize perl */
504  owl_function_debugmsg("startup: processing config file");
505
506  owl_global_pop_context(&g);
507  owl_global_push_context(&g, OWL_CTX_READCONFIG, NULL, NULL, NULL);
508
509  perlerr=owl_perlconfig_initperl(opts.configfile, &argc, &argv, &env);
510  if (perlerr) {
511    endwin();
512    fprintf(stderr, "Internal perl error: %s\n", perlerr);
513    fflush(stderr);
514    printf("Internal perl error: %s\n", perlerr);
515    fflush(stdout);
516    exit(1);
517  }
518
519  owl_global_complete_setup(&g);
520
521  owl_global_setup_default_filters(&g);
522
523  /* set the current view */
524  owl_function_debugmsg("startup: setting the current view");
525  owl_view_create(owl_global_get_current_view(&g), "main",
526                  owl_global_get_filter(&g, "all"),
527                  owl_global_get_style_by_name(&g, "default"));
528
529  /* AIM init */
530  owl_function_debugmsg("startup: doing AIM initialization");
531  owl_aim_init();
532
533  /* execute the startup function in the configfile */
534  owl_function_debugmsg("startup: executing perl startup, if applicable");
535  perlout = owl_perlconfig_execute("BarnOwl::Hooks::_startup();");
536  if (perlout) g_free(perlout);
537
538  /* welcome message */
539  owl_function_debugmsg("startup: creating splash message");
540  owl_function_adminmsg("",
541    "-----------------------------------------------------------------------\n"
542    "Welcome to barnowl version " OWL_VERSION_STRING ".\n"
543    "To see a quick introduction, type ':show quickstart'.                  \n"
544    "Press 'h' for on-line help.                                            \n"
545    "                                                                       \n"
546    "BarnOwl is free software. Type ':show license' for more                \n"
547    "information.                                                     ^ ^   \n"
548    "                                                                 OvO   \n"
549    "Please report any bugs or suggestions to bug-barnowl@mit.edu    (   )  \n"
550    "-----------------------------------------------------------------m-m---\n"
551  );
552
553  /* process the startup file */
554  owl_function_debugmsg("startup: processing startup file");
555  owl_function_source(NULL);
556
557  owl_function_debugmsg("startup: set style for the view: %s", owl_global_get_default_style(&g));
558  s = owl_global_get_style_by_name(&g, owl_global_get_default_style(&g));
559  if(s)
560      owl_view_set_style(owl_global_get_current_view(&g), s);
561  else
562      owl_function_error("No such style: %s", owl_global_get_default_style(&g));
563
564  owl_function_debugmsg("startup: setting context interactive");
565
566  owl_global_pop_context(&g);
567  owl_global_push_context(&g, OWL_CTX_INTERACTIVE|OWL_CTX_RECV, NULL, "recv", NULL);
568
569  source = owl_window_redraw_source_new();
570  g_source_attach(source, NULL);
571  g_source_unref(source);
572
573  source = g_source_new(&owl_process_messages_funcs, sizeof(GSource));
574  g_source_attach(source, NULL);
575  g_source_unref(source);
576
577  owl_function_debugmsg("startup: entering main loop");
578  owl_select_run_loop();
579
580  /* Shut down everything. */
581  owl_zephyr_shutdown();
582  owl_shutdown_curses();
583  return 0;
584}
Note: See TracBrowser for help on using the repository browser.