source: owl.c @ 7488f27

release-1.8release-1.9
Last change on this file since 7488f27 was 7488f27, checked in by Anders Kaseorg <andersk@mit.edu>, 10 years ago
Use STDIN_FILENO instead of 0 Signed-off-by: Anders Kaseorg <andersk@mit.edu>
  • Property mode set to 100644
File size: 18.0 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 = owl_strdup(optarg);
83      break;
84    case 's':
85      opts->confdir = owl_strdup(optarg);
86      break;
87    case 't':
88      opts->tty = owl_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  tcsetattr(STDIN_FILENO, TCSAFLUSH, &tio);
140
141  /* screen init */
142  initscr();
143  cbreak();
144  noecho();
145
146  owl_start_color();
147}
148
149void owl_shutdown_curses(void) {
150  endwin();
151  /* restore terminal settings */
152  tcsetattr(STDIN_FILENO, TCSAFLUSH, owl_global_get_startup_tio(&g));
153}
154
155/*
156 * Process a new message passed to us on the message queue from some
157 * protocol. This includes adding it to the message list, updating the
158 * view and scrolling if appropriate, logging it, and so on.
159 *
160 * Either a pointer is kept to the message internally, or it is freed
161 * if unneeded. The caller no longer ``owns'' the message's memory.
162 *
163 * Returns 1 if the message was added to the message list, and 0 if it
164 * was ignored due to user settings or otherwise.
165 */
166int owl_process_message(owl_message *m) {
167  const owl_filter *f;
168  /* if this message it on the puntlist, nuke it and continue */
169  if (owl_global_message_is_puntable(&g, m)) {
170    owl_message_delete(m);
171    return 0;
172  }
173
174  /*  login or logout that should be ignored? */
175  if (owl_global_is_ignorelogins(&g)
176      && owl_message_is_loginout(m)) {
177    owl_message_delete(m);
178    return 0;
179  }
180
181  if (!owl_global_is_displayoutgoing(&g)
182      && owl_message_is_direction_out(m)) {
183    owl_message_delete(m);
184    return 0;
185  }
186
187  /* add it to the global list */
188  owl_messagelist_append_element(owl_global_get_msglist(&g), m);
189  /* add it to any necessary views; right now there's only the current view */
190  owl_view_consider_message(owl_global_get_current_view(&g), m);
191
192  if(owl_message_is_direction_in(m)) {
193    /* let perl know about it*/
194    owl_perlconfig_getmsg(m, NULL);
195
196    /* do we need to autoreply? */
197    if (owl_global_is_zaway(&g) && !owl_message_get_attribute_value(m, "isauto")) {
198      if (owl_message_is_type_zephyr(m)) {
199        owl_zephyr_zaway(m);
200      } else if (owl_message_is_type_aim(m)) {
201        if (owl_message_is_private(m)) {
202          owl_function_send_aimawymsg(owl_message_get_sender(m), owl_global_get_zaway_msg(&g));
203        }
204      }
205    }
206
207    /* ring the bell if it's a personal */
208    if (!strcmp(owl_global_get_personalbell(&g), "on")) {
209      if (!owl_message_is_loginout(m) &&
210          !owl_message_is_mail(m) &&
211          owl_message_is_personal(m)) {
212        owl_function_beep();
213      }
214    } else if (!strcmp(owl_global_get_personalbell(&g), "off")) {
215      /* do nothing */
216    } else {
217      f=owl_global_get_filter(&g, owl_global_get_personalbell(&g));
218      if (f && owl_filter_message_match(f, m)) {
219        owl_function_beep();
220      }
221    }
222
223    /* if it matches the alert filter, do the alert action */
224    f=owl_global_get_filter(&g, owl_global_get_alert_filter(&g));
225    if (f && owl_filter_message_match(f, m)) {
226      owl_function_command(owl_global_get_alert_action(&g));
227    }
228
229    /* if it's a zephyr login or logout, update the zbuddylist */
230    if (owl_message_is_type_zephyr(m) && owl_message_is_loginout(m)) {
231      if (owl_message_is_login(m)) {
232        owl_zbuddylist_adduser(owl_global_get_zephyr_buddylist(&g), owl_message_get_sender(m));
233      } else if (owl_message_is_logout(m)) {
234        owl_zbuddylist_deluser(owl_global_get_zephyr_buddylist(&g), owl_message_get_sender(m));
235      } else {
236        owl_function_error("Internal error: received login notice that is neither login nor logout");
237      }
238    }
239  }
240
241  /* let perl know about it */
242  owl_perlconfig_newmsg(m, NULL);
243  /* log the message if we need to */
244  owl_log_message(m);
245  /* redraw the sepbar; TODO: don't violate layering */
246  owl_global_sepbar_dirty(&g);
247
248  return 1;
249}
250
251/*
252 * Process any new messages we have waiting in the message queue.
253 * Returns 1 if any messages were added to the message list, and 0 otherwise.
254 */
255int owl_process_messages(owl_ps_action *d, void *p)
256{
257  int newmsgs=0;
258  int followlast = owl_global_should_followlast(&g);
259  owl_message *m;
260
261  /* Grab incoming messages. */
262  while (owl_global_messagequeue_pending(&g)) {
263    m = owl_global_messagequeue_popmsg(&g);
264    if (owl_process_message(m))
265      newmsgs = 1;
266  }
267
268  if (newmsgs) {
269    /* follow the last message if we're supposed to */
270    if (followlast)
271      owl_function_lastmsg_noredisplay();
272
273    /* do the newmsgproc thing */
274    owl_function_do_newmsgproc();
275
276    /* redisplay if necessary */
277    /* this should be optimized to not run if the new messages won't be displayed */
278    owl_mainwin_redisplay(owl_global_get_mainwin(&g));
279  }
280  return newmsgs;
281}
282
283void owl_process_input(const owl_io_dispatch *d, void *data)
284{
285  owl_input j;
286
287  while (1) {
288    j.ch = wgetch(g.input_pad);
289    if (j.ch == ERR) return;
290
291    j.uch = '\0';
292    if (j.ch >= KEY_MIN && j.ch <= KEY_MAX) {
293      /* This is a curses control character. */
294    }
295    else if (j.ch > 0x7f && j.ch < 0xfe) {
296      /* Pull in a full utf-8 character. */
297      int bytes, i;
298      char utf8buf[7];
299      memset(utf8buf, '\0', 7);
300     
301      utf8buf[0] = j.ch;
302     
303      if ((j.ch & 0xc0) && (~j.ch & 0x20)) bytes = 2;
304      else if ((j.ch & 0xe0) && (~j.ch & 0x10)) bytes = 3;
305      else if ((j.ch & 0xf0) && (~j.ch & 0x08)) bytes = 4;
306      else if ((j.ch & 0xf8) && (~j.ch & 0x04)) bytes = 5;
307      else if ((j.ch & 0xfc) && (~j.ch & 0x02)) bytes = 6;
308      else bytes = 1;
309     
310      for (i = 1; i < bytes; i++) {
311        int tmp = wgetch(g.input_pad);
312        /* If what we got was not a byte, or not a continuation byte */
313        if (tmp > 0xff || !(tmp & 0x80 && ~tmp & 0x40)) {
314          /* ill-formed UTF-8 code unit subsequence, put back the
315             char we just got. */
316          ungetch(tmp);
317          j.ch = ERR;
318          break;
319        }
320        utf8buf[i] = tmp;
321      }
322     
323      if (j.ch != ERR) {
324        if (g_utf8_validate(utf8buf, -1, NULL)) {
325          j.uch = g_utf8_get_char(utf8buf);
326        }
327        else {
328          j.ch = ERR;
329        }
330      }
331    }
332    else if (j.ch <= 0x7f) {
333      j.uch = j.ch;
334    }
335
336    owl_process_input_char(j);
337  }
338}
339
340void sig_handler(int sig, siginfo_t *si, void *data)
341{
342  if (sig==SIGWINCH) {
343    /* we can't inturrupt a malloc here, so it just sets a flag
344     * schedulding a resize for later
345     */
346    owl_function_resize();
347  } else if (sig==SIGPIPE || sig==SIGCHLD) {
348    /* Set a flag and some info that we got the sigpipe
349     * so we can record that we got it and why... */
350    owl_global_set_errsignal(&g, sig, si);
351  } else if (sig==SIGTERM || sig==SIGHUP) {
352    owl_function_quit();
353  }
354}
355
356void sigint_handler(int sig, siginfo_t *si, void *data)
357{
358  owl_global_set_interrupted(&g);
359}
360
361static int owl_errsignal_pre_select_action(owl_ps_action *a, void *data)
362{
363  siginfo_t si;
364  int signum;
365  if ((signum = owl_global_get_errsignal_and_clear(&g, &si)) > 0) {
366    owl_function_error("Got unexpected signal: %d %s  (code: %d band: %ld  errno: %d)",
367        signum, signum==SIGPIPE?"SIGPIPE":"SIG????",
368        si.si_code, si.si_band, si.si_errno);
369  }
370  return 0;
371}
372
373void owl_register_signal_handlers(void) {
374  struct sigaction sigact;
375
376  /* signal handler */
377  /*sigact.sa_handler=sig_handler;*/
378  sigact.sa_sigaction=sig_handler;
379  sigemptyset(&sigact.sa_mask);
380  sigact.sa_flags=SA_SIGINFO;
381  sigaction(SIGWINCH, &sigact, NULL);
382  sigaction(SIGALRM, &sigact, NULL);
383  sigaction(SIGPIPE, &sigact, NULL);
384  sigaction(SIGTERM, &sigact, NULL);
385  sigaction(SIGHUP, &sigact, NULL);
386
387  sigact.sa_sigaction=sigint_handler;
388  sigaction(SIGINT, &sigact, NULL);
389}
390
391#if OWL_STDERR_REDIR
392
393/* Replaces stderr with a pipe so that we can read from it.
394 * Returns the fd of the pipe from which stderr can be read. */
395int stderr_replace(void)
396{
397  int pipefds[2];
398  if (0 != pipe(pipefds)) {
399    perror("pipe");
400    owl_function_debugmsg("stderr_replace: pipe FAILED\n");
401    return -1;
402  }
403    owl_function_debugmsg("stderr_replace: pipe: %d,%d\n", pipefds[0], pipefds[1]);
404  if (-1 == dup2(pipefds[1], 2 /*stderr*/)) {
405    owl_function_debugmsg("stderr_replace: dup2 FAILED (%s)\n", strerror(errno));
406    perror("dup2");
407    return -1;
408  }
409  return pipefds[0];
410}
411
412/* Sends stderr (read from rfd) messages to the error console */
413void stderr_redirect_handler(const owl_io_dispatch *d, void *data)
414{
415  int navail, bread;
416  char buf[4096];
417  int rfd = d->fd;
418  char *err;
419
420  if (rfd<0) return;
421  if (-1 == ioctl(rfd, FIONREAD, &navail)) {
422    return;
423  }
424  /*owl_function_debugmsg("stderr_redirect: navail = %d\n", navail);*/
425  if (navail <= 0) return;
426  if (navail > sizeof(buf)-1) {
427    navail = sizeof(buf)-1;
428  }
429  bread = read(rfd, buf, navail);
430  if (buf[navail-1] != '\0') {
431    buf[navail] = '\0';
432  }
433
434  err = owl_sprintf("[stderr]\n%s", buf);
435
436  owl_function_log_err(err);
437  owl_free(err);
438}
439
440#endif /* OWL_STDERR_REDIR */
441
442static int owl_refresh_pre_select_action(owl_ps_action *a, void *data)
443{
444  owl_colorpair_mgr *cpmgr;
445
446  /* if a resize has been scheduled, deal with it */
447  owl_global_check_resize(&g);
448  /* update the terminal if we need to */
449  owl_window_redraw_scheduled();
450  /* On colorpair shortage, reset and redraw /everything/. NOTE: if
451   * the current screen uses too many colorpairs, this draws
452   * everything twice. But this is unlikely; COLOR_PAIRS is 64 with
453   * 8+1 colors, and 256^2 with 256+1 colors. (+1 for default.) */
454  cpmgr = owl_global_get_colorpair_mgr(&g);
455  if (cpmgr->overflow) {
456    owl_function_debugmsg("colorpairs: color shortage; reset pairs and redraw. COLOR_PAIRS = %d", COLOR_PAIRS);
457    owl_fmtext_reset_colorpairs(cpmgr);
458    owl_function_full_redisplay();
459    owl_window_redraw_scheduled();
460  }
461  return 0;
462}
463
464
465int main(int argc, char **argv, char **env)
466{
467  int argc_copy;
468  char **argv_copy;
469  char *perlout, *perlerr;
470  const owl_style *s;
471  const char *dir;
472  owl_options opts;
473
474  if (!GLIB_CHECK_VERSION (2, 12, 0))
475    g_error ("GLib version 2.12.0 or above is needed.");
476
477  argc_copy = argc;
478  argv_copy = g_strdupv(argv);
479
480  setlocale(LC_ALL, "");
481
482  memset(&opts, 0, sizeof opts);
483  opts.load_initial_subs = 1;
484  owl_parse_options(argc, argv, &opts);
485  g.load_initial_subs = opts.load_initial_subs;
486
487  owl_register_signal_handlers();
488  owl_start_curses();
489
490  /* owl global init */
491  owl_global_init(&g);
492  if (opts.rm_debug) unlink(OWL_DEBUG_FILE);
493  if (opts.debug) owl_global_set_debug_on(&g);
494  if (opts.confdir) owl_global_set_confdir(&g, opts.confdir);
495  owl_function_debugmsg("startup: first available debugging message");
496  owl_global_set_startupargs(&g, argc_copy, argv_copy);
497  g_strfreev(argv_copy);
498  owl_global_set_haveaim(&g);
499
500  /* register STDIN dispatch; throw away return, we won't need it */
501  owl_select_add_io_dispatch(STDIN_FILENO, OWL_IO_READ, &owl_process_input, NULL, NULL);
502  owl_zephyr_initialize();
503
504#if OWL_STDERR_REDIR
505  /* Do this only after we've started curses up... */
506  owl_function_debugmsg("startup: doing stderr redirection");
507  owl_select_add_io_dispatch(stderr_replace(), OWL_IO_READ, &stderr_redirect_handler, NULL, NULL);
508#endif
509
510  /* create the owl directory, in case it does not exist */
511  owl_function_debugmsg("startup: creating owl directory, if not present");
512  dir=owl_global_get_confdir(&g);
513  mkdir(dir, S_IRWXU);
514
515  /* set the tty, either from the command line, or by figuring it out */
516  owl_function_debugmsg("startup: setting tty name");
517  if (opts.tty) {
518    owl_global_set_tty(&g, opts.tty);
519  } else {
520    char *tty = owl_util_get_default_tty();
521    owl_global_set_tty(&g, tty);
522    owl_free(tty);
523  }
524
525  /* Initialize perl */
526  owl_function_debugmsg("startup: processing config file");
527
528  owl_global_pop_context(&g);
529  owl_global_push_context(&g, OWL_CTX_READCONFIG, NULL, NULL, NULL);
530
531  perlerr=owl_perlconfig_initperl(opts.configfile, &argc, &argv, &env);
532  if (perlerr) {
533    endwin();
534    fprintf(stderr, "Internal perl error: %s\n", perlerr);
535    fflush(stderr);
536    printf("Internal perl error: %s\n", perlerr);
537    fflush(stdout);
538    exit(1);
539  }
540
541  owl_global_complete_setup(&g);
542
543  owl_global_setup_default_filters(&g);
544
545  /* set the current view */
546  owl_function_debugmsg("startup: setting the current view");
547  owl_view_create(owl_global_get_current_view(&g), "main",
548                  owl_global_get_filter(&g, "all"),
549                  owl_global_get_style_by_name(&g, "default"));
550
551  /* AIM init */
552  owl_function_debugmsg("startup: doing AIM initialization");
553  owl_aim_init();
554
555  /* execute the startup function in the configfile */
556  owl_function_debugmsg("startup: executing perl startup, if applicable");
557  perlout = owl_perlconfig_execute("BarnOwl::Hooks::_startup();");
558  if (perlout) owl_free(perlout);
559
560  /* welcome message */
561  owl_function_debugmsg("startup: creating splash message");
562  owl_function_adminmsg("",
563    "-----------------------------------------------------------------------\n"
564    "Welcome to barnowl version " OWL_VERSION_STRING ".\n"
565    "To see a quick introduction, type ':show quickstart'.                  \n"
566    "Press 'h' for on-line help.                                            \n"
567    "                                                                       \n"
568    "BarnOwl is free software. Type ':show license' for more                \n"
569    "information.                                                     ^ ^   \n"
570    "                                                                 OvO   \n"
571    "Please report any bugs or suggestions to bug-barnowl@mit.edu    (   )  \n"
572    "-----------------------------------------------------------------m-m---\n"
573  );
574
575  /* process the startup file */
576  owl_function_debugmsg("startup: processing startup file");
577  owl_function_source(NULL);
578
579  owl_function_debugmsg("startup: set style for the view: %s", owl_global_get_default_style(&g));
580  s = owl_global_get_style_by_name(&g, owl_global_get_default_style(&g));
581  if(s)
582      owl_view_set_style(owl_global_get_current_view(&g), s);
583  else
584      owl_function_error("No such style: %s", owl_global_get_default_style(&g));
585
586  owl_function_debugmsg("startup: setting context interactive");
587
588  owl_global_pop_context(&g);
589  owl_global_push_context(&g, OWL_CTX_INTERACTIVE|OWL_CTX_RECV, NULL, "recv", NULL);
590
591  owl_select_add_pre_select_action(owl_refresh_pre_select_action, NULL, NULL);
592  owl_select_add_pre_select_action(owl_process_messages, NULL, NULL);
593  owl_select_add_pre_select_action(owl_errsignal_pre_select_action, NULL, NULL);
594
595  owl_function_debugmsg("startup: entering main loop");
596  owl_select_run_loop();
597
598  /* Shut down everything. */
599  owl_zephyr_shutdown();
600  owl_shutdown_curses();
601  return 0;
602}
Note: See TracBrowser for help on using the repository browser.