source: owl.c @ 6772d19

release-1.7release-1.8release-1.9
Last change on this file since 6772d19 was e488ec5, checked in by Nelson Elhage <nelhage@mit.edu>, 11 years ago
Merge branch 'security'
  • Property mode set to 100644
File size: 17.3 KB
Line 
1/*  Copyright (c) 2006-2010 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
35#define STDIN 0
36
37owl_global g;
38
39typedef struct _owl_options {
40  bool load_initial_subs;
41  char *configfile;
42  char *tty;
43  char *confdir;
44  bool debug;
45  bool rm_debug;
46} owl_options;
47
48void usage(void)
49{
50  fprintf(stderr, "Barnowl version %s\n", OWL_VERSION_STRING);
51  fprintf(stderr, "Usage: barnowl [-n] [-d] [-D] [-v] [-h] [-c <configfile>] [-s <confdir>] [-t <ttyname>]\n");
52  fprintf(stderr, "  -n,--no-subs        don't load zephyr subscriptions\n");
53  fprintf(stderr, "  -d,--debug          enable debugging\n");
54  fprintf(stderr, "  -D,--remove-debug   enable debugging and delete previous debug file\n");
55  fprintf(stderr, "  -v,--version        print the Barnowl version number and exit\n");
56  fprintf(stderr, "  -h,--help           print this help message\n");
57  fprintf(stderr, "  -c,--config-file    specify an alternate config file\n");
58  fprintf(stderr, "  -s,--config-dir     specify an alternate config dir (default ~/.owl)\n");
59  fprintf(stderr, "  -t,--tty            set the tty name\n");
60}
61
62/* TODO: free owl_options after init is done? */
63void owl_parse_options(int argc, char *argv[], owl_options *opts) {
64  static const struct option long_options[] = {
65    { "no-subs",         0, 0, 'n' },
66    { "config-file",     1, 0, 'c' },
67    { "config-dir",      1, 0, 's' },
68    { "tty",             1, 0, 't' },
69    { "debug",           0, 0, 'd' },
70    { "remove-debug",    0, 0, 'D' },
71    { "version",         0, 0, 'v' },
72    { "help",            0, 0, 'h' },
73    { NULL, 0, NULL, 0}
74  };
75  char c;
76
77  while((c = getopt_long(argc, argv, "nc:t:s:dDvh",
78                         long_options, NULL)) != -1) {
79    switch(c) {
80    case 'n':
81      opts->load_initial_subs = 0;
82      break;
83    case 'c':
84      opts->configfile = owl_strdup(optarg);
85      break;
86    case 's':
87      opts->confdir = owl_strdup(optarg);
88      break;
89    case 't':
90      opts->tty = owl_strdup(optarg);
91      break;
92    case 'D':
93      opts->rm_debug = 1;
94      /* fallthrough */
95    case 'd':
96      opts->debug = 1;
97      break;
98    case 'v':
99      printf("This is barnowl version %s\n", OWL_VERSION_STRING);
100      exit(0);
101    case 'h':
102    default:
103      usage();
104      exit(1);
105    }
106  }
107}
108
109void owl_start_color(void) {
110  start_color();
111#ifdef HAVE_USE_DEFAULT_COLORS
112  use_default_colors();
113#endif
114
115  /* define simple color pairs */
116  if (has_colors() && COLOR_PAIRS>=8) {
117    int bg = COLOR_BLACK;
118#ifdef HAVE_USE_DEFAULT_COLORS
119    bg = -1;
120#endif
121    init_pair(OWL_COLOR_BLACK,   COLOR_BLACK,   bg);
122    init_pair(OWL_COLOR_RED,     COLOR_RED,     bg);
123    init_pair(OWL_COLOR_GREEN,   COLOR_GREEN,   bg);
124    init_pair(OWL_COLOR_YELLOW,  COLOR_YELLOW,  bg);
125    init_pair(OWL_COLOR_BLUE,    COLOR_BLUE,    bg);
126    init_pair(OWL_COLOR_MAGENTA, COLOR_MAGENTA, bg);
127    init_pair(OWL_COLOR_CYAN,    COLOR_CYAN,    bg);
128    init_pair(OWL_COLOR_WHITE,   COLOR_WHITE,   bg);
129  }
130}
131
132void owl_start_curses(void) {
133  struct termios tio;
134  /* save initial terminal settings */
135  tcgetattr(0, owl_global_get_startup_tio(&g));
136
137  tcgetattr(0, &tio);
138  tio.c_iflag &= ~(ISTRIP|IEXTEN);
139  tio.c_cc[VQUIT] = fpathconf(STDIN, _PC_VDISABLE);
140  tio.c_cc[VSUSP] = fpathconf(STDIN, _PC_VDISABLE);
141  tcsetattr(0, TCSAFLUSH, &tio);
142
143  /* screen init */
144  initscr();
145  cbreak();
146  noecho();
147
148  owl_start_color();
149}
150
151
152/*
153 * Process a new message passed to us on the message queue from some
154 * protocol. This includes adding it to the message list, updating the
155 * view and scrolling if appropriate, logging it, and so on.
156 *
157 * Either a pointer is kept to the message internally, or it is freed
158 * if unneeded. The caller no longer ``owns'' the message's memory.
159 *
160 * Returns 1 if the message was added to the message list, and 0 if it
161 * was ignored due to user settings or otherwise.
162 */
163int owl_process_message(owl_message *m) {
164  const owl_filter *f;
165  /* if this message it on the puntlist, nuke it and continue */
166  if (owl_global_message_is_puntable(&g, m)) {
167    owl_message_delete(m);
168    return 0;
169  }
170
171  /*  login or logout that should be ignored? */
172  if (owl_global_is_ignorelogins(&g)
173      && owl_message_is_loginout(m)) {
174    owl_message_delete(m);
175    return 0;
176  }
177
178  if (!owl_global_is_displayoutgoing(&g)
179      && owl_message_is_direction_out(m)) {
180    owl_message_delete(m);
181    return 0;
182  }
183
184  /* add it to the global list */
185  owl_messagelist_append_element(owl_global_get_msglist(&g), m);
186  /* add it to any necessary views; right now there's only the current view */
187  owl_view_consider_message(owl_global_get_current_view(&g), m);
188
189  if(owl_message_is_direction_in(m)) {
190    /* let perl know about it*/
191    owl_perlconfig_getmsg(m, NULL);
192
193    /* do we need to autoreply? */
194    if (owl_global_is_zaway(&g) && !owl_message_get_attribute_value(m, "isauto")) {
195      if (owl_message_is_type_zephyr(m)) {
196        owl_zephyr_zaway(m);
197      } else if (owl_message_is_type_aim(m)) {
198        if (owl_message_is_private(m)) {
199          owl_function_send_aimawymsg(owl_message_get_sender(m), owl_global_get_zaway_msg(&g));
200        }
201      }
202    }
203
204    /* ring the bell if it's a personal */
205    if (!strcmp(owl_global_get_personalbell(&g), "on")) {
206      if (!owl_message_is_loginout(m) &&
207          !owl_message_is_mail(m) &&
208          owl_message_is_personal(m)) {
209        owl_function_beep();
210      }
211    } else if (!strcmp(owl_global_get_personalbell(&g), "off")) {
212      /* do nothing */
213    } else {
214      f=owl_global_get_filter(&g, owl_global_get_personalbell(&g));
215      if (f && owl_filter_message_match(f, m)) {
216        owl_function_beep();
217      }
218    }
219
220    /* if it matches the alert filter, do the alert action */
221    f=owl_global_get_filter(&g, owl_global_get_alert_filter(&g));
222    if (f && owl_filter_message_match(f, m)) {
223      owl_function_command(owl_global_get_alert_action(&g));
224    }
225
226    /* if it's a zephyr login or logout, update the zbuddylist */
227    if (owl_message_is_type_zephyr(m) && owl_message_is_loginout(m)) {
228      if (owl_message_is_login(m)) {
229        owl_zbuddylist_adduser(owl_global_get_zephyr_buddylist(&g), owl_message_get_sender(m));
230      } else if (owl_message_is_logout(m)) {
231        owl_zbuddylist_deluser(owl_global_get_zephyr_buddylist(&g), owl_message_get_sender(m));
232      } else {
233        owl_function_error("Internal error: received login notice that is neither login nor logout");
234      }
235    }
236  }
237
238  /* let perl know about it */
239  owl_perlconfig_newmsg(m, NULL);
240  /* log the message if we need to */
241  owl_log_message(m);
242  /* redraw the sepbar; TODO: don't violate layering */
243  owl_global_sepbar_dirty(&g);
244
245  return 1;
246}
247
248/*
249 * Process any new messages we have waiting in the message queue.
250 * Returns 1 if any messages were added to the message list, and 0 otherwise.
251 */
252int owl_process_messages(owl_ps_action *d, void *p)
253{
254  int newmsgs=0;
255  int followlast = owl_global_should_followlast(&g);
256  owl_message *m;
257
258  /* Grab incoming messages. */
259  while (owl_global_messagequeue_pending(&g)) {
260    m = owl_global_messagequeue_popmsg(&g);
261    if (owl_process_message(m))
262      newmsgs = 1;
263  }
264
265  if (newmsgs) {
266    /* follow the last message if we're supposed to */
267    if (followlast)
268      owl_function_lastmsg_noredisplay();
269
270    /* do the newmsgproc thing */
271    owl_function_do_newmsgproc();
272
273    /* redisplay if necessary */
274    /* this should be optimized to not run if the new messages won't be displayed */
275    owl_mainwin_redisplay(owl_global_get_mainwin(&g));
276  }
277  return newmsgs;
278}
279
280void owl_process_input(const owl_io_dispatch *d, void *data)
281{
282  owl_input j;
283
284  while (1) {
285    j.ch = wgetch(g.input_pad);
286    if (j.ch == ERR) return;
287
288    j.uch = '\0';
289    if (j.ch >= KEY_MIN && j.ch <= KEY_MAX) {
290      /* This is a curses control character. */
291    }
292    else if (j.ch > 0x7f && j.ch < 0xfe) {
293      /* Pull in a full utf-8 character. */
294      int bytes, i;
295      char utf8buf[7];
296      memset(utf8buf, '\0', 7);
297     
298      utf8buf[0] = j.ch;
299     
300      if ((j.ch & 0xc0) && (~j.ch & 0x20)) bytes = 2;
301      else if ((j.ch & 0xe0) && (~j.ch & 0x10)) bytes = 3;
302      else if ((j.ch & 0xf0) && (~j.ch & 0x08)) bytes = 4;
303      else if ((j.ch & 0xf8) && (~j.ch & 0x04)) bytes = 5;
304      else if ((j.ch & 0xfc) && (~j.ch & 0x02)) bytes = 6;
305      else bytes = 1;
306     
307      for (i = 1; i < bytes; i++) {
308        int tmp = wgetch(g.input_pad);
309        /* If what we got was not a byte, or not a continuation byte */
310        if (tmp > 0xff || !(tmp & 0x80 && ~tmp & 0x40)) {
311          /* ill-formed UTF-8 code unit subsequence, put back the
312             char we just got. */
313          ungetch(tmp);
314          j.ch = ERR;
315          break;
316        }
317        utf8buf[i] = tmp;
318      }
319     
320      if (j.ch != ERR) {
321        if (g_utf8_validate(utf8buf, -1, NULL)) {
322          j.uch = g_utf8_get_char(utf8buf);
323        }
324        else {
325          j.ch = ERR;
326        }
327      }
328    }
329    else if (j.ch <= 0x7f) {
330      j.uch = j.ch;
331    }
332
333    owl_process_input_char(j);
334  }
335}
336
337void sig_handler(int sig, siginfo_t *si, void *data)
338{
339  if (sig==SIGWINCH) {
340    /* we can't inturrupt a malloc here, so it just sets a flag
341     * schedulding a resize for later
342     */
343    owl_function_resize();
344  } else if (sig==SIGPIPE || sig==SIGCHLD) {
345    /* Set a flag and some info that we got the sigpipe
346     * so we can record that we got it and why... */
347    owl_global_set_errsignal(&g, sig, si);
348  } else if (sig==SIGTERM || sig==SIGHUP) {
349    owl_function_quit();
350  }
351}
352
353void sigint_handler(int sig, siginfo_t *si, void *data)
354{
355  owl_global_set_interrupted(&g);
356}
357
358void owl_register_signal_handlers(void) {
359  struct sigaction sigact;
360
361  /* signal handler */
362  /*sigact.sa_handler=sig_handler;*/
363  sigact.sa_sigaction=sig_handler;
364  sigemptyset(&sigact.sa_mask);
365  sigact.sa_flags=SA_SIGINFO;
366  sigaction(SIGWINCH, &sigact, NULL);
367  sigaction(SIGALRM, &sigact, NULL);
368  sigaction(SIGPIPE, &sigact, NULL);
369  sigaction(SIGTERM, &sigact, NULL);
370  sigaction(SIGHUP, &sigact, NULL);
371
372  sigact.sa_sigaction=sigint_handler;
373  sigaction(SIGINT, &sigact, NULL);
374}
375
376#if OWL_STDERR_REDIR
377
378/* Replaces stderr with a pipe so that we can read from it.
379 * Returns the fd of the pipe from which stderr can be read. */
380int stderr_replace(void)
381{
382  int pipefds[2];
383  if (0 != pipe(pipefds)) {
384    perror("pipe");
385    owl_function_debugmsg("stderr_replace: pipe FAILED\n");
386    return -1;
387  }
388    owl_function_debugmsg("stderr_replace: pipe: %d,%d\n", pipefds[0], pipefds[1]);
389  if (-1 == dup2(pipefds[1], 2 /*stderr*/)) {
390    owl_function_debugmsg("stderr_replace: dup2 FAILED (%s)\n", strerror(errno));
391    perror("dup2");
392    return -1;
393  }
394  return pipefds[0];
395}
396
397/* Sends stderr (read from rfd) messages to the error console */
398void stderr_redirect_handler(const owl_io_dispatch *d, void *data)
399{
400  int navail, bread;
401  char buf[4096];
402  int rfd = d->fd;
403  char *err;
404
405  if (rfd<0) return;
406  if (-1 == ioctl(rfd, FIONREAD, &navail)) {
407    return;
408  }
409  /*owl_function_debugmsg("stderr_redirect: navail = %d\n", navail);*/
410  if (navail <= 0) return;
411  if (navail > sizeof(buf)-1) {
412    navail = sizeof(buf)-1;
413  }
414  bread = read(rfd, buf, navail);
415  if (buf[navail-1] != '\0') {
416    buf[navail] = '\0';
417  }
418
419  err = owl_sprintf("[stderr]\n%s", buf);
420
421  owl_function_log_err(err);
422  owl_free(err);
423}
424
425#endif /* OWL_STDERR_REDIR */
426
427static int owl_refresh_pre_select_action(owl_ps_action *a, void *data)
428{
429  /* if a resize has been scheduled, deal with it */
430  owl_global_check_resize(&g);
431  /* update the terminal if we need to */
432  owl_window_redraw_scheduled();
433  return 0;
434}
435
436
437int main(int argc, char **argv, char **env)
438{
439  int argcsave;
440  const char *const *argvsave;
441  char *perlout, *perlerr;
442  const owl_style *s;
443  const char *dir;
444  owl_options opts;
445
446  if (!GLIB_CHECK_VERSION (2, 12, 0))
447    g_error ("GLib version 2.12.0 or above is needed.");
448
449  argcsave=argc;
450  argvsave=strs(argv);
451
452  setlocale(LC_ALL, "");
453
454  memset(&opts, 0, sizeof opts);
455  opts.load_initial_subs = 1;
456  owl_parse_options(argc, argv, &opts);
457  g.load_initial_subs = opts.load_initial_subs;
458
459  owl_register_signal_handlers();
460  owl_start_curses();
461
462  /* owl global init */
463  owl_global_init(&g);
464  if (opts.rm_debug) unlink(OWL_DEBUG_FILE);
465  if (opts.debug) owl_global_set_debug_on(&g);
466  if (opts.confdir) owl_global_set_confdir(&g, opts.confdir);
467  owl_function_debugmsg("startup: first available debugging message");
468  owl_global_set_startupargs(&g, argcsave, argvsave);
469  owl_global_set_haveaim(&g);
470
471  /* register STDIN dispatch; throw away return, we won't need it */
472  owl_select_add_io_dispatch(STDIN, OWL_IO_READ, &owl_process_input, NULL, NULL);
473  owl_zephyr_initialize();
474
475#if OWL_STDERR_REDIR
476  /* Do this only after we've started curses up... */
477  owl_function_debugmsg("startup: doing stderr redirection");
478  owl_select_add_io_dispatch(stderr_replace(), OWL_IO_READ, &stderr_redirect_handler, NULL, NULL);
479#endif
480
481  /* create the owl directory, in case it does not exist */
482  owl_function_debugmsg("startup: creating owl directory, if not present");
483  dir=owl_global_get_confdir(&g);
484  mkdir(dir, S_IRWXU);
485
486  /* set the tty, either from the command line, or by figuring it out */
487  owl_function_debugmsg("startup: setting tty name");
488  if (opts.tty) {
489    owl_global_set_tty(&g, opts.tty);
490  } else {
491    char *tty = owl_util_get_default_tty();
492    owl_global_set_tty(&g, tty);
493    owl_free(tty);
494  }
495
496  /* Initialize perl */
497  owl_function_debugmsg("startup: processing config file");
498
499  owl_global_pop_context(&g);
500  owl_global_push_context(&g, OWL_CTX_READCONFIG, NULL, NULL, NULL);
501
502  perlerr=owl_perlconfig_initperl(opts.configfile, &argc, &argv, &env);
503  if (perlerr) {
504    endwin();
505    fprintf(stderr, "Internal perl error: %s\n", perlerr);
506    fflush(stderr);
507    printf("Internal perl error: %s\n", perlerr);
508    fflush(stdout);
509    exit(1);
510  }
511
512  owl_global_complete_setup(&g);
513
514  owl_global_setup_default_filters(&g);
515
516  /* set the current view */
517  owl_function_debugmsg("startup: setting the current view");
518  owl_view_create(owl_global_get_current_view(&g), "main",
519                  owl_global_get_filter(&g, "all"),
520                  owl_global_get_style_by_name(&g, "default"));
521
522  /* AIM init */
523  owl_function_debugmsg("startup: doing AIM initialization");
524  owl_aim_init();
525
526  /* execute the startup function in the configfile */
527  owl_function_debugmsg("startup: executing perl startup, if applicable");
528  perlout = owl_perlconfig_execute("BarnOwl::Hooks::_startup();");
529  if (perlout) owl_free(perlout);
530
531  /* welcome message */
532  owl_function_debugmsg("startup: creating splash message");
533  owl_function_adminmsg("",
534    "-----------------------------------------------------------------------\n"
535    "Welcome to barnowl version " OWL_VERSION_STRING ".  Press 'h' for on-line help.\n"
536    "To see a quick introduction, type ':show quickstart'.                  \n"
537    "                                                                       \n"
538    "BarnOwl is free software. Type ':show license' for more                \n"
539    "information.                                                     ^ ^   \n"
540    "                                                                 OvO   \n"
541    "Please report any bugs or suggestions to bug-barnowl@mit.edu    (   )  \n"
542    "-----------------------------------------------------------------m-m---\n"
543  );
544
545  /* process the startup file */
546  owl_function_debugmsg("startup: processing startup file");
547  owl_function_source(NULL);
548
549  /* Set the default style */
550  owl_function_debugmsg("startup: setting startup and default style");
551  if (0 != strcmp(owl_global_get_default_style(&g), "__unspecified__")) {
552    /* the style was set by the user: leave it alone */
553  } else {
554    owl_global_set_default_style(&g, "default");
555  }
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_READCONFIG|OWL_CTX_RECV, NULL, "recv", NULL);
568
569  owl_select_add_pre_select_action(owl_refresh_pre_select_action, NULL, NULL);
570  owl_select_add_pre_select_action(owl_process_messages, NULL, NULL);
571
572  owl_function_debugmsg("startup: entering main loop");
573  /* main loop */
574  while (1) {
575    /* select on FDs we know about. */
576    owl_select();
577
578    /* Log any error signals */
579    {
580      siginfo_t si;
581      int signum;
582      if ((signum = owl_global_get_errsignal_and_clear(&g, &si)) > 0) {
583        owl_function_error("Got unexpected signal: %d %s  (code: %d band: %ld  errno: %d)",
584                           signum, signum==SIGPIPE?"SIGPIPE":"SIG????",
585                           si.si_code, si.si_band, si.si_errno);
586      }
587    }
588
589  }
590}
Note: See TracBrowser for help on using the repository browser.