source: perlconfig.c

Last change on this file was 09530e6, checked in by Anders Kaseorg <andersk@mit.edu>, 7 years ago
owl_perlconfig_hashref2message: Don’t pass uninitialized tm_isdst to mktime strptime doesn’t initialize tm_isdst, so mktime was offsetting the time by ±1 hour depending on uninitialized memory. Initializing tm_isdst to a negative value causes it to guess. It will still guess incorrectly during one hour of every year, but at least now the behavior is defined. (Discovered by valgrind.) Signed-off-by: Anders Kaseorg <andersk@mit.edu>
  • Property mode set to 100644
File size: 15.1 KB
Line 
1#define OWL_PERL
2#include "owl.h"
3#include <stdio.h>
4
5extern XS(boot_BarnOwl);
6extern XS(boot_DynaLoader);
7/* extern XS(boot_DBI); */
8
9void owl_perl_xs_init(pTHX) /* noproto */
10{
11  const char *file = __FILE__;
12  dXSUB_SYS;
13  {
14    newXS("BarnOwl::bootstrap", boot_BarnOwl, file);
15    newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
16  }
17}
18
19
20CALLER_OWN SV *owl_new_sv(const char * str)
21{
22  SV *ret = newSVpv(str, 0);
23  if (is_utf8_string((const U8 *)str, strlen(str))) {
24    SvUTF8_on(ret);
25  } else {
26    char *escape = owl_escape_highbit(str);
27    owl_function_error("Internal error! Non-UTF-8 string encountered:\n%s", escape);
28    g_free(escape);
29  }
30  return ret;
31}
32
33CALLER_OWN AV *owl_new_av(const GPtrArray *l, SV *(*to_sv)(const void *))
34{
35  AV *ret;
36  int i;
37  void *element;
38
39  ret = newAV();
40
41  for (i = 0; i < l->len; i++) {
42    element = l->pdata[i];
43    av_push(ret, to_sv(element));
44  }
45
46  return ret;
47}
48
49CALLER_OWN HV *owl_new_hv(const owl_dict *d, SV *(*to_sv)(const void *))
50{
51  HV *ret;
52  GPtrArray *keys;
53  const char *key;
54  void *element;
55  int i;
56
57  ret = newHV();
58
59  /* TODO: add an iterator-like interface to owl_dict */
60  keys = owl_dict_get_keys(d);
61  for (i = 0; i < keys->len; i++) {
62    key = keys->pdata[i];
63    element = owl_dict_find_element(d, key);
64    (void)hv_store(ret, key, strlen(key), to_sv(element), 0);
65  }
66  owl_ptr_array_free(keys, g_free);
67
68  return ret;
69}
70
71CALLER_OWN SV *owl_perlconfig_message2hashref(const owl_message *m)
72{
73  HV *h, *stash;
74  SV *hr;
75  const char *type;
76  char *ptr, *utype, *blessas;
77  const char *f;
78  int i;
79  const owl_pair *pair;
80  const owl_filter *wrap;
81
82  if (!m) return &PL_sv_undef;
83  wrap = owl_global_get_filter(&g, "wordwrap");
84  if(!wrap) {
85      owl_function_error("wrap filter is not defined");
86      return &PL_sv_undef;
87  }
88
89  h = newHV();
90
91#define MSG2H(h,field) (void)hv_store(h, #field, strlen(#field),        \
92                                      owl_new_sv(owl_message_get_##field(m)), 0)
93
94  if (owl_message_is_type_zephyr(m) && owl_message_is_direction_in(m)) {
95    /* Handle zephyr-specific fields... */
96    AV *av_zfields = newAV();
97    if (owl_message_get_notice(m)) {
98      for (f = owl_zephyr_first_raw_field(owl_message_get_notice(m)); f != NULL;
99           f = owl_zephyr_next_raw_field(owl_message_get_notice(m), f)) {
100        ptr = owl_zephyr_field_as_utf8(owl_message_get_notice(m), f);
101        av_push(av_zfields, owl_new_sv(ptr));
102        g_free(ptr);
103      }
104      (void)hv_store(h, "auth", strlen("auth"),
105                     owl_new_sv(owl_zephyr_get_authstr(owl_message_get_notice(m))), 0);
106    } else {
107      /* Incoming zephyrs without a ZNotice_t are pseudo-logins. To appease
108       * existing styles, put in bogus 'auth' and 'fields' keys. */
109      (void)hv_store(h, "auth", strlen("auth"), owl_new_sv("NO"), 0);
110    }
111    (void)hv_store(h, "fields", strlen("fields"), newRV_noinc((SV*)av_zfields), 0);
112  }
113
114  for (i = 0; i < m->attributes->len; i++) {
115    pair = m->attributes->pdata[i];
116    (void)hv_store(h, owl_pair_get_key(pair), strlen(owl_pair_get_key(pair)),
117                   owl_new_sv(owl_pair_get_value(pair)),0);
118  }
119 
120  MSG2H(h, type);
121  MSG2H(h, direction);
122  MSG2H(h, class);
123  MSG2H(h, instance);
124  MSG2H(h, sender);
125  MSG2H(h, realm);
126  MSG2H(h, recipient);
127  MSG2H(h, opcode);
128  MSG2H(h, hostname);
129  MSG2H(h, body);
130  MSG2H(h, login);
131  MSG2H(h, zsig);
132  MSG2H(h, zwriteline);
133  if (owl_message_get_header(m)) {
134    MSG2H(h, header); 
135  }
136  (void)hv_store(h, "time", strlen("time"), owl_new_sv(owl_message_get_timestr(m)),0);
137  (void)hv_store(h, "unix_time", strlen("unix_time"), newSViv(m->time), 0);
138  (void)hv_store(h, "id", strlen("id"), newSViv(owl_message_get_id(m)),0);
139  (void)hv_store(h, "deleted", strlen("deleted"), newSViv(owl_message_is_delete(m)),0);
140  (void)hv_store(h, "private", strlen("private"), newSViv(owl_message_is_private(m)),0);
141  (void)hv_store(h, "should_wordwrap",
142                 strlen("should_wordwrap"), newSViv(
143                                                    owl_filter_message_match(wrap, m)),0);
144
145  type = owl_message_get_type(m);
146  if(!type || !*type) type = "generic";
147  utype = g_strdup(type);
148  utype[0] = toupper(type[0]);
149  blessas = g_strdup_printf("BarnOwl::Message::%s", utype);
150
151  hr = newRV_noinc((SV*)h);
152  stash =  gv_stashpv(blessas,0);
153  if(!stash) {
154    owl_function_error("No such class: %s for message type %s", blessas, owl_message_get_type(m));
155    stash = gv_stashpv("BarnOwl::Message", 1);
156  }
157  hr = sv_bless(hr,stash);
158  g_free(utype);
159  g_free(blessas);
160  return hr;
161}
162
163CALLER_OWN SV *owl_perlconfig_curmessage2hashref(void)
164{
165  int curmsg;
166  const owl_view *v;
167  v=owl_global_get_current_view(&g);
168  if (owl_view_get_size(v) < 1) {
169    return &PL_sv_undef;
170  }
171  curmsg=owl_global_get_curmsg(&g);
172  return owl_perlconfig_message2hashref(owl_view_get_element(v, curmsg));
173}
174
175/* XXX TODO: Messages should round-trip properly between
176   message2hashref and hashref2message. Currently we lose
177   zephyr-specific properties stored in the ZNotice_t
178 */
179CALLER_OWN owl_message *owl_perlconfig_hashref2message(SV *msg)
180{
181  owl_message * m;
182  HE * ent;
183  I32 len;
184  const char *key,*val;
185  HV * hash;
186  struct tm tm;
187
188  hash = (HV*)SvRV(msg);
189
190  m = g_slice_new(owl_message);
191  owl_message_init(m);
192
193  hv_iterinit(hash);
194  while((ent = hv_iternext(hash))) {
195    key = hv_iterkey(ent, &len);
196    val = SvPV_nolen(hv_iterval(hash, ent));
197    if(!strcmp(key, "type")) {
198      owl_message_set_type(m, val);
199    } else if(!strcmp(key, "direction")) {
200      owl_message_set_direction(m, owl_message_parse_direction(val));
201    } else if(!strcmp(key, "private")) {
202      SV * v = hv_iterval(hash, ent);
203      if(SvTRUE(v)) {
204        owl_message_set_isprivate(m);
205      }
206    } else if (!strcmp(key, "hostname")) {
207      owl_message_set_hostname(m, val);
208    } else if (!strcmp(key, "zwriteline")) {
209      owl_message_set_zwriteline(m, val);
210    } else if (!strcmp(key, "time")) {
211      g_free(m->timestr);
212      m->timestr = g_strdup(val);
213      // FIXME: Daylight saving time will be guessed wrongly one hour per year!
214      tm.tm_isdst = -1;
215      strptime(val, "%a %b %d %T %Y", &tm);
216      m->time = mktime(&tm);
217    } else {
218      owl_message_set_attribute(m, key, val);
219    }
220  }
221  if(owl_message_is_type_admin(m)) {
222    if(!owl_message_get_attribute_value(m, "adminheader"))
223      owl_message_set_attribute(m, "adminheader", "");
224  }
225  return m;
226}
227
228/* Calls in a scalar context, passing it a hash reference.
229   If return value is non-null, caller must free. */
230CALLER_OWN char *owl_perlconfig_call_with_message(const char *subname, const owl_message *m)
231{
232  SV *msgref, *rv;
233  char *out = NULL;
234
235  msgref = owl_perlconfig_message2hashref(m);
236
237  OWL_PERL_CALL((call_pv(subname, G_SCALAR|G_EVAL))
238                ,
239                XPUSHs(sv_2mortal(msgref));
240                ,
241                "Perl Error: '%s'"
242                ,
243                false
244                ,
245                false
246                ,
247                rv = POPs;
248                if (rv && SvPOK(rv))
249                  out = g_strdup(SvPV_nolen(rv));
250                );
251  return out;
252}
253
254
255/* Calls a method on a perl object representing a message.
256   If the return value is non-null, the caller must free it.
257 */
258CALLER_OWN char *owl_perlconfig_message_call_method(const owl_message *m, const char *method, int argc, const char **argv)
259{
260  SV *msgref, *rv;
261  char *out = NULL;
262  int i;
263
264  msgref = owl_perlconfig_message2hashref(m);
265
266  OWL_PERL_CALL(call_method(method, G_SCALAR|G_EVAL)
267                ,
268                XPUSHs(sv_2mortal(msgref));
269                OWL_PERL_PUSH_ARGS(i, argc, argv);
270                ,
271                "Perl Error: '%s'"
272                ,
273                false
274                ,
275                false
276                ,
277                rv = POPs;
278                if (rv && SvPOK(rv))
279                  out = g_strdup(SvPV_nolen(rv));
280                );
281  return out;
282}
283
284/* caller must free result, if not NULL */
285CALLER_OWN char *owl_perlconfig_initperl(const char *file, int *Pargc, char ***Pargv, char ***Penv)
286{
287  int ret;
288  PerlInterpreter *p;
289  char *err;
290  const char *args[4] = {"", "-e", "0;", NULL};
291  const char *dlerr;
292  AV *inc;
293  char *path;
294
295  /* create and initialize interpreter */
296  PERL_SYS_INIT3(Pargc, Pargv, Penv);
297  p=perl_alloc();
298  owl_global_set_perlinterp(&g, p);
299  perl_construct(p);
300
301  PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
302
303  owl_global_set_no_have_config(&g);
304
305  ret=perl_parse(p, owl_perl_xs_init, 2, (char **)args, NULL);
306  if (ret || SvTRUE(ERRSV)) {
307    err=g_strdup(SvPV_nolen(ERRSV));
308    sv_setsv(ERRSV, &PL_sv_undef);     /* and clear the error */
309    return(err);
310  }
311
312  ret=perl_run(p);
313  if (ret || SvTRUE(ERRSV)) {
314    err=g_strdup(SvPV_nolen(ERRSV));
315    sv_setsv(ERRSV, &PL_sv_undef);     /* and clear the error */
316    return(err);
317  }
318
319  owl_global_set_have_config(&g);
320
321  /* create legacy variables */
322  get_sv("BarnOwl::id", TRUE);
323  get_sv("BarnOwl::class", TRUE);
324  get_sv("BarnOwl::instance", TRUE);
325  get_sv("BarnOwl::recipient", TRUE);
326  get_sv("BarnOwl::sender", TRUE);
327  get_sv("BarnOwl::realm", TRUE);
328  get_sv("BarnOwl::opcode", TRUE);
329  get_sv("BarnOwl::zsig", TRUE);
330  get_sv("BarnOwl::msg", TRUE);
331  get_sv("BarnOwl::time", TRUE);
332  get_sv("BarnOwl::host", TRUE);
333  get_av("BarnOwl::fields", TRUE);
334
335  if(file) {
336    SV * cfg = get_sv("BarnOwl::configfile", TRUE);
337    sv_setpv(cfg, file);
338  }
339
340  sv_setpv(get_sv("BarnOwl::VERSION", TRUE), version);
341
342  /* Add the system lib path to @INC */
343  inc = get_av("INC", 0);
344  path = g_build_filename(owl_get_datadir(), "lib", NULL);
345  av_unshift(inc, 1);
346  av_store(inc, 0, owl_new_sv(path));
347  g_free(path);
348
349  /* Load up perl-Glib. */
350  eval_pv("use Glib;", FALSE);
351
352  /* Now, before BarnOwl tries to use them, get the relevant function pointers out. */
353  dlerr = owl_closure_init();
354  if (dlerr) {
355    return g_strdup(dlerr);
356  }
357
358  /* And now it's safe to import BarnOwl. */
359  eval_pv("use BarnOwl;", FALSE);
360
361  if (SvTRUE(ERRSV)) {
362    err=g_strdup(SvPV_nolen(ERRSV));
363    sv_setsv (ERRSV, &PL_sv_undef);     /* and clear the error */
364    return(err);
365  }
366
367  /* check if we have the formatting function */
368  if (owl_perlconfig_is_function("BarnOwl::format_msg")) {
369    owl_global_set_config_format(&g, 1);
370  }
371
372  return(NULL);
373}
374
375/* returns whether or not a function exists */
376int owl_perlconfig_is_function(const char *fn) {
377  if (get_cv(fn, FALSE)) return(1);
378  else return(0);
379}
380
381/* caller is responsible for freeing returned string */
382CALLER_OWN char *owl_perlconfig_execute(const char *line)
383{
384  STRLEN len;
385  SV *response;
386  char *out;
387
388  if (!owl_global_have_config(&g)) return NULL;
389
390  ENTER;
391  SAVETMPS;
392  /* execute the subroutine */
393  response = eval_pv(line, FALSE);
394
395  if (SvTRUE(ERRSV)) {
396    owl_function_error("Perl Error: '%s'", SvPV_nolen(ERRSV));
397    sv_setsv (ERRSV, &PL_sv_undef);     /* and clear the error */
398  }
399
400  out = g_strdup(SvPV(response, len));
401  FREETMPS;
402  LEAVE;
403
404  return(out);
405}
406
407void owl_perlconfig_getmsg(const owl_message *m, const char *subname)
408{
409  char *ptr = NULL;
410  if (owl_perlconfig_is_function("BarnOwl::Hooks::_receive_msg")) {
411    ptr = owl_perlconfig_call_with_message(subname?subname
412                                           :"BarnOwl::_receive_msg_legacy_wrap", m);
413  }
414  g_free(ptr);
415}
416
417/* Called on all new messages; receivemsg is only called on incoming ones */
418void owl_perlconfig_newmsg(const owl_message *m, const char *subname)
419{
420  char *ptr = NULL;
421  if (owl_perlconfig_is_function("BarnOwl::Hooks::_new_msg")) {
422    ptr = owl_perlconfig_call_with_message(subname?subname
423                                           :"BarnOwl::Hooks::_new_msg", m);
424  }
425  g_free(ptr);
426}
427
428void owl_perlconfig_new_command(const char *name)
429{
430  OWL_PERL_CALL(call_pv("BarnOwl::Hooks::_new_command", G_VOID|G_EVAL);
431                ,
432                XPUSHs(sv_2mortal(owl_new_sv(name)));
433                ,
434                "Perl Error: '%s'"
435                ,
436                false
437                ,
438                true
439                ,
440                );
441}
442
443CALLER_OWN char *owl_perlconfig_perl_call(const char *method, int argc, const char *const *argv)
444{
445  SV *rv;
446  char *out = NULL;
447  int i;
448  OWL_PERL_CALL(call_pv(method, G_SCALAR|G_EVAL)
449                ,
450                OWL_PERL_PUSH_ARGS(i, argc, argv);
451                ,
452                "Perl Error: '%s'"
453                ,
454                false
455                ,
456                false
457                ,
458                rv = POPs;
459                if (rv && SvPOK(rv))
460                  out = g_strdup(SvPV_nolen(rv));
461                );
462  return out;
463}
464
465int owl_perlconfig_perl_call_int(const char *method, int argc, const char *const *argv)
466{
467  SV *rv;
468  int ret = -1;
469  int i;
470  OWL_PERL_CALL(call_pv(method, G_SCALAR|G_EVAL)
471                ,
472                OWL_PERL_PUSH_ARGS(i, argc, argv);
473                ,
474                "Perl Error: '%s'"
475                ,
476                false
477                ,
478                false
479                ,
480                rv = POPs;
481                if (rv && SvIOK(rv))
482                  ret = SvIV(rv);
483                );
484  return ret;
485}
486
487bool owl_perlconfig_perl_call_bool(const char *method, int argc, const char *const *argv)
488{
489  SV *rv;
490  bool ret = false;
491  int i;
492  OWL_PERL_CALL(call_pv(method, G_SCALAR|G_EVAL)
493                ,
494                OWL_PERL_PUSH_ARGS(i, argc, argv);
495                ,
496                "Perl Error: '%s'"
497                ,
498                false
499                ,
500                false
501                ,
502                rv = POPs;
503                if (rv)
504                  ret = SvTRUE(rv);
505                );
506  return ret;
507}
508
509void owl_perlconfig_perl_call_norv(const char *method, int argc, const char *const *argv)
510{
511  int i;
512  OWL_PERL_CALL(call_pv(method, G_DISCARD|G_EVAL)
513                ,
514                OWL_PERL_PUSH_ARGS(i, argc, argv);
515                ,
516                "Perl Error: '%s'"
517                ,
518                false
519                ,
520                true
521                ,
522                );
523}
524
525/* caller must free the result */
526CALLER_OWN char *owl_perlconfig_perlcmd(const owl_cmd *cmd, int argc, const char *const *argv)
527{
528  int i;
529  SV* rv;
530  char *out = NULL;
531
532  OWL_PERL_CALL(call_sv(cmd->cmd_perl, G_SCALAR|G_EVAL)
533                ,
534                OWL_PERL_PUSH_ARGS(i, argc, argv);
535                ,
536                "Perl Error: '%s'"
537                ,
538                false
539                ,
540                false
541                ,
542                rv = POPs;
543                if (rv && SvPOK(rv))
544                  out = g_strdup(SvPV_nolen(rv));
545                );
546  return out;
547}
548
549void owl_perlconfig_cmd_cleanup(owl_cmd *cmd)
550{
551  SvREFCNT_dec(cmd->cmd_perl);
552}
553
554void owl_perlconfig_edit_callback(owl_editwin *e, bool success)
555{
556  SV *cb = owl_editwin_get_cbdata(e);
557  SV *text = owl_new_sv(owl_editwin_get_text(e));
558
559  if (cb == NULL) {
560    owl_function_error("Perl callback is NULL!");
561    return;
562  }
563
564  OWL_PERL_CALL(call_sv(cb, G_DISCARD|G_EVAL)
565                ,
566                XPUSHs(sv_2mortal(text));
567                XPUSHs(sv_2mortal(newSViv(success)));
568                ,
569                "Perl Error: '%s'"
570                ,
571                false
572                ,
573                true
574                ,
575                );
576}
577
578void owl_perlconfig_dec_refcnt(void *data)
579{
580  SV *v = data;
581  SvREFCNT_dec(v);
582}
Note: See TracBrowser for help on using the repository browser.