source: perlconfig.c @ 6829afc

release-1.8release-1.9
Last change on this file since 6829afc was 6829afc, checked in by David Benjamin <davidben@mit.edu>, 11 years ago
Define CALLER_OWN macro Replace our exising uses of G_GNUC_WARN_UNUSED_RESULT with it. The old macro is just way too long. This also more clearly specifies the intent.
  • Property mode set to 100644
File size: 13.7 KB
RevLine 
[f1e629d]1#include <stdio.h>
2#include <stdlib.h>
3#include <string.h>
4#include <sys/types.h>
5#include <sys/stat.h>
6#include <errno.h>
[908e388]7#define OWL_PERL
[f1e629d]8#include "owl.h"
9
[8203afd]10extern XS(boot_BarnOwl);
[908e388]11extern XS(boot_DynaLoader);
[af1920fd]12/* extern XS(boot_DBI); */
[f1e629d]13
[5aa33fd]14void owl_perl_xs_init(pTHX) /* noproto */
[c3acb0b]15{
[e19eb97]16  const char *file = __FILE__;
[f1e629d]17  dXSUB_SYS;
18  {
[8203afd]19    newXS("BarnOwl::bootstrap", boot_BarnOwl, file);
[908e388]20    newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
[f1e629d]21  }
22}
23
[d1b1cf6]24
[6829afc]25CALLER_OWN SV *owl_new_sv(const char * str)
[d1b1cf6]26{
27  SV *ret = newSVpv(str, 0);
[68f358c]28  if (is_utf8_string((const U8 *)str, strlen(str))) {
[d1b1cf6]29    SvUTF8_on(ret);
30  } else {
[eea72a1]31    char *escape = owl_escape_highbit(str);
32    owl_function_error("Internal error! Non-UTF-8 string encountered:\n%s", escape);
[ddbbcffa]33    g_free(escape);
[d1b1cf6]34  }
35  return ret;
36}
37
[6829afc]38CALLER_OWN AV *owl_new_av(const owl_list *l, SV *(*to_sv)(const void *))
[e67359b]39{
40  AV *ret;
41  int i;
42  void *element;
43
44  ret = newAV();
45
46  for (i = 0; i < owl_list_get_size(l); i++) {
47    element = owl_list_get_element(l, i);
48    av_push(ret, to_sv(element));
49  }
50
51  return ret;
52}
53
[6829afc]54CALLER_OWN HV *owl_new_hv(const owl_dict *d, SV *(*to_sv)(const void *))
[e7f5970]55{
56  HV *ret;
57  owl_list l;
58  const char *key;
59  void *element;
60  int i;
61
62  ret = newHV();
63
64  /* TODO: add an iterator-like interface to owl_dict */
[f25df21]65  owl_list_create(&l);
[e7f5970]66  owl_dict_get_keys(d, &l);
67  for (i = 0; i < owl_list_get_size(&l); i++) {
68    key = owl_list_get_element(&l, i);
69    element = owl_dict_find_element(d, key);
70    (void)hv_store(ret, key, strlen(key), to_sv(element), 0);
71  }
[ddbbcffa]72  owl_list_cleanup(&l, g_free);
[e7f5970]73
74  return ret;
75}
76
[6829afc]77CALLER_OWN SV *owl_perlconfig_message2hashref(const owl_message *m)
[c3acb0b]78{
[1cc95709]79  HV *h, *stash;
[f1e629d]80  SV *hr;
[e19eb97]81  const char *type;
[fa4562c]82  char *ptr, *utype, *blessas;
[b0430a6]83  int i, j;
[25fb825]84  const owl_pair *pair;
[4542047]85  const owl_filter *wrap;
[f1e629d]86
87  if (!m) return &PL_sv_undef;
[f6b319c]88  wrap = owl_global_get_filter(&g, "wordwrap");
89  if(!wrap) {
90      owl_function_error("wrap filter is not defined");
91      return &PL_sv_undef;
92  }
93
[f1e629d]94  h = newHV();
95
[3ea31b6]96#define MSG2H(h,field) (void)hv_store(h, #field, strlen(#field),        \
[d1b1cf6]97                                      owl_new_sv(owl_message_get_##field(m)), 0)
[f1e629d]98
99  if (owl_message_is_type_zephyr(m)
100      && owl_message_is_direction_in(m)) {
101    /* Handle zephyr-specific fields... */
102    AV *av_zfields;
103
104    av_zfields = newAV();
105    j=owl_zephyr_get_num_fields(owl_message_get_notice(m));
106    for (i=0; i<j; i++) {
[5376a95]107      ptr=owl_zephyr_get_field_as_utf8(owl_message_get_notice(m), i+1);
[d1b1cf6]108      av_push(av_zfields, owl_new_sv(ptr));
[ddbbcffa]109      g_free(ptr);
[f1e629d]110    }
[3ea31b6]111    (void)hv_store(h, "fields", strlen("fields"), newRV_noinc((SV*)av_zfields), 0);
[f1e629d]112
[3ea31b6]113    (void)hv_store(h, "auth", strlen("auth"), 
[d1b1cf6]114                   owl_new_sv(owl_zephyr_get_authstr(owl_message_get_notice(m))),0);
[f1e629d]115  }
116
[421c8ef7]117  j=owl_list_get_size(&(m->attributes));
118  for(i=0; i<j; i++) {
119    pair=owl_list_get_element(&(m->attributes), i);
[3ea31b6]120    (void)hv_store(h, owl_pair_get_key(pair), strlen(owl_pair_get_key(pair)),
[d1b1cf6]121                   owl_new_sv(owl_pair_get_value(pair)),0);
[421c8ef7]122  }
123 
[f1e629d]124  MSG2H(h, type);
125  MSG2H(h, direction);
126  MSG2H(h, class);
127  MSG2H(h, instance);
128  MSG2H(h, sender);
129  MSG2H(h, realm);
130  MSG2H(h, recipient);
131  MSG2H(h, opcode);
132  MSG2H(h, hostname);
133  MSG2H(h, body);
134  MSG2H(h, login);
135  MSG2H(h, zsig);
136  MSG2H(h, zwriteline);
137  if (owl_message_get_header(m)) {
138    MSG2H(h, header); 
139  }
[d1b1cf6]140  (void)hv_store(h, "time", strlen("time"), owl_new_sv(owl_message_get_timestr(m)),0);
[d1ae4a4]141  (void)hv_store(h, "unix_time", strlen("unix_time"), newSViv(m->time), 0);
[3ea31b6]142  (void)hv_store(h, "id", strlen("id"), newSViv(owl_message_get_id(m)),0);
143  (void)hv_store(h, "deleted", strlen("deleted"), newSViv(owl_message_is_delete(m)),0);
144  (void)hv_store(h, "private", strlen("private"), newSViv(owl_message_is_private(m)),0);
145  (void)hv_store(h, "should_wordwrap",
146                 strlen("should_wordwrap"), newSViv(
147                                                    owl_filter_message_match(wrap, m)),0);
[f1e629d]148
[30678ae]149  type = owl_message_get_type(m);
[8fba2ee]150  if(!type || !*type) type = "generic";
[d4927a7]151  utype = g_strdup(type);
[fa4562c]152  utype[0] = toupper(type[0]);
[3472845]153  blessas = g_strdup_printf("BarnOwl::Message::%s", utype);
[f1e629d]154
[19bab8e]155  hr = newRV_noinc((SV*)h);
[1cc95709]156  stash =  gv_stashpv(blessas,0);
157  if(!stash) {
158    owl_function_error("No such class: %s for message type %s", blessas, owl_message_get_type(m));
159    stash = gv_stashpv("BarnOwl::Message", 1);
160  }
161  hr = sv_bless(hr,stash);
[ddbbcffa]162  g_free(utype);
163  g_free(blessas);
[30678ae]164  return hr;
[f1e629d]165}
166
[6829afc]167CALLER_OWN SV *owl_perlconfig_curmessage2hashref(void)
[c3acb0b]168{
[f1e629d]169  int curmsg;
[9e5c9f3]170  const owl_view *v;
[f1e629d]171  v=owl_global_get_current_view(&g);
172  if (owl_view_get_size(v) < 1) {
173    return &PL_sv_undef;
174  }
175  curmsg=owl_global_get_curmsg(&g);
176  return owl_perlconfig_message2hashref(owl_view_get_element(v, curmsg));
177}
178
[30678ae]179/* XXX TODO: Messages should round-trip properly between
180   message2hashref and hashref2message. Currently we lose
181   zephyr-specific properties stored in the ZNotice_t
[87dfeb7]182
183   This has been somewhat addressed, but is still not lossless.
[30678ae]184 */
[6829afc]185CALLER_OWN owl_message *owl_perlconfig_hashref2message(SV *msg)
[30678ae]186{
187  owl_message * m;
188  HE * ent;
[c107129]189  I32 len;
[e19eb97]190  const char *key,*val;
[30678ae]191  HV * hash;
[ad15610]192  struct tm tm;
[30678ae]193
194  hash = (HV*)SvRV(msg);
195
[96828e4]196  m = g_new(owl_message, 1);
[30678ae]197  owl_message_init(m);
198
[c107129]199  hv_iterinit(hash);
[30678ae]200  while((ent = hv_iternext(hash))) {
201    key = hv_iterkey(ent, &len);
202    val = SvPV_nolen(hv_iterval(hash, ent));
203    if(!strcmp(key, "type")) {
204      owl_message_set_type(m, val);
205    } else if(!strcmp(key, "direction")) {
206      owl_message_set_direction(m, owl_message_parse_direction(val));
207    } else if(!strcmp(key, "private")) {
208      SV * v = hv_iterval(hash, ent);
209      if(SvTRUE(v)) {
210        owl_message_set_isprivate(m);
211      }
212    } else if (!strcmp(key, "hostname")) {
213      owl_message_set_hostname(m, val);
214    } else if (!strcmp(key, "zwriteline")) {
215      owl_message_set_zwriteline(m, val);
216    } else if (!strcmp(key, "time")) {
[937a00e9]217      g_free(m->timestr);
[d4927a7]218      m->timestr = g_strdup(val);
[30678ae]219      strptime(val, "%a %b %d %T %Y", &tm);
220      m->time = mktime(&tm);
221    } else {
222      owl_message_set_attribute(m, key, val);
223    }
224  }
225  if(owl_message_is_type_admin(m)) {
226    if(!owl_message_get_attribute_value(m, "adminheader"))
227      owl_message_set_attribute(m, "adminheader", "");
228  }
[87dfeb7]229#ifdef HAVE_LIBZEPHYR
230  if (owl_message_is_type_zephyr(m)) {
231    ZNotice_t *n = &(m->notice);
232    n->z_kind = ACKED;
233    n->z_port = 0;
234    n->z_auth = ZAUTH_NO;
235    n->z_checked_auth = 0;
[712caac]236    n->z_class = zstr(owl_message_get_class(m));
237    n->z_class_inst = zstr(owl_message_get_instance(m));
238    n->z_opcode = zstr(owl_message_get_opcode(m));
239    n->z_sender = zstr(owl_message_get_sender(m));
240    n->z_recipient = zstr(owl_message_get_recipient(m));
241    n->z_default_format = zstr("[zephyr created from perl]");
242    n->z_multinotice = zstr("[zephyr created from perl]");
[87dfeb7]243    n->z_num_other_fields = 0;
[3472845]244    n->z_message = g_strdup_printf("%s%c%s", owl_message_get_zsig(m), '\0', owl_message_get_body(m));
[87dfeb7]245    n->z_message_len = strlen(owl_message_get_zsig(m)) + strlen(owl_message_get_body(m)) + 1;
246  }
247#endif
[30678ae]248  return m;
249}
[f1e629d]250
251/* Calls in a scalar context, passing it a hash reference.
252   If return value is non-null, caller must free. */
[6829afc]253CALLER_OWN char *owl_perlconfig_call_with_message(const char *subname, const owl_message *m)
[c3acb0b]254{
[f1e629d]255  dSP ;
[c4ba74d]256  int count;
[f1e629d]257  SV *msgref, *srv;
[909771e]258  char *out;
[f1e629d]259 
260  ENTER ;
261  SAVETMPS;
262 
263  PUSHMARK(SP) ;
264  msgref = owl_perlconfig_message2hashref(m);
[19bab8e]265  XPUSHs(sv_2mortal(msgref));
[f1e629d]266  PUTBACK ;
267 
[e3068de]268  count = call_pv(subname, G_SCALAR|G_EVAL);
[f1e629d]269 
270  SPAGAIN ;
271
272  if (SvTRUE(ERRSV)) {
[ce6721f]273    owl_function_error("Perl Error: '%s'", SvPV_nolen(ERRSV));
[27c3a93]274    /* and clear the error */
275    sv_setsv (ERRSV, &PL_sv_undef);
[f1e629d]276  }
277
278  if (count != 1) {
279    fprintf(stderr, "bad perl!  no biscuit!  returned wrong count!\n");
280    abort();
281  }
282
283  srv = POPs;
284
285  if (srv) {
[d4927a7]286    out = g_strdup(SvPV_nolen(srv));
[f1e629d]287  } else {
288    out = NULL;
289  }
290 
291  PUTBACK ;
292  FREETMPS ;
293  LEAVE ;
294
295  return out;
296}
297
[25729b2]298
299/* Calls a method on a perl object representing a message.
300   If the return value is non-null, the caller must free it.
301 */
[6829afc]302CALLER_OWN char *owl_perlconfig_message_call_method(const owl_message *m, const char *method, int argc, const char **argv)
[25729b2]303{
304  dSP;
[909771e]305  unsigned int count, i;
[25729b2]306  SV *msgref, *srv;
[909771e]307  char *out;
[25729b2]308
309  msgref = owl_perlconfig_message2hashref(m);
310
311  ENTER;
312  SAVETMPS;
313
314  PUSHMARK(SP);
[19bab8e]315  XPUSHs(sv_2mortal(msgref));
[25729b2]316  for(i=0;i<argc;i++) {
[d1b1cf6]317    XPUSHs(sv_2mortal(owl_new_sv(argv[i])));
[25729b2]318  }
319  PUTBACK;
320
[e3068de]321  count = call_method(method, G_SCALAR|G_EVAL);
[25729b2]322
323  SPAGAIN;
324
325  if(count != 1) {
[f278ff3]326    fprintf(stderr, "perl returned wrong count %u\n", count);
[25729b2]327    abort();
328  }
329
330  if (SvTRUE(ERRSV)) {
[ce6721f]331    owl_function_error("Error: '%s'", SvPV_nolen(ERRSV));
[25729b2]332    /* and clear the error */
333    sv_setsv (ERRSV, &PL_sv_undef);
334  }
335
336  srv = POPs;
337
338  if (srv) {
[d4927a7]339    out = g_strdup(SvPV_nolen(srv));
[25729b2]340  } else {
341    out = NULL;
342  }
343
344  PUTBACK;
345  FREETMPS;
346  LEAVE;
347
348  return out;
349}
350
[d427f08]351/* caller must free result, if not NULL */
[6829afc]352CALLER_OWN char *owl_perlconfig_initperl(const char *file, int *Pargc, char ***Pargv, char ***Penv)
[c3acb0b]353{
[d03091c]354  int ret;
[f1e629d]355  PerlInterpreter *p;
[4e0f545]356  char *err;
[e19eb97]357  const char *args[4] = {"", "-e", "0;", NULL};
[fd8dfe7]358  AV *inc;
359  char *path;
[f1e629d]360
361  /* create and initialize interpreter */
[e8c6d8f]362  PERL_SYS_INIT3(Pargc, Pargv, Penv);
[f1e629d]363  p=perl_alloc();
[4d86e06]364  owl_global_set_perlinterp(&g, p);
[f1e629d]365  perl_construct(p);
366
[5aa33fd]367  PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
368
[f1e629d]369  owl_global_set_no_have_config(&g);
370
[fa4562c]371  ret=perl_parse(p, owl_perl_xs_init, 2, (char **)args, NULL);
[f1e629d]372  if (ret || SvTRUE(ERRSV)) {
[d4927a7]373    err=g_strdup(SvPV_nolen(ERRSV));
[4e0f545]374    sv_setsv(ERRSV, &PL_sv_undef);     /* and clear the error */
375    return(err);
[f1e629d]376  }
377
378  ret=perl_run(p);
379  if (ret || SvTRUE(ERRSV)) {
[d4927a7]380    err=g_strdup(SvPV_nolen(ERRSV));
[4e0f545]381    sv_setsv(ERRSV, &PL_sv_undef);     /* and clear the error */
382    return(err);
[f1e629d]383  }
384
385  owl_global_set_have_config(&g);
386
387  /* create legacy variables */
[c415aca]388  get_sv("BarnOwl::id", TRUE);
389  get_sv("BarnOwl::class", TRUE);
390  get_sv("BarnOwl::instance", TRUE);
391  get_sv("BarnOwl::recipient", TRUE);
392  get_sv("BarnOwl::sender", TRUE);
393  get_sv("BarnOwl::realm", TRUE);
394  get_sv("BarnOwl::opcode", TRUE);
395  get_sv("BarnOwl::zsig", TRUE);
396  get_sv("BarnOwl::msg", TRUE);
397  get_sv("BarnOwl::time", TRUE);
398  get_sv("BarnOwl::host", TRUE);
399  get_av("BarnOwl::fields", TRUE);
[00f9a7d]400
401  if(file) {
[8203afd]402    SV * cfg = get_sv("BarnOwl::configfile", TRUE);
[00f9a7d]403    sv_setpv(cfg, file);
404  }
405
[f2d71cfa]406  sv_setpv(get_sv("BarnOwl::VERSION", TRUE), OWL_VERSION_STRING);
407
[fd8dfe7]408  /* Add the system lib path to @INC */
409  inc = get_av("INC", 0);
[3472845]410  path = g_strdup_printf("%s/lib", owl_get_datadir());
[fd8dfe7]411  av_unshift(inc, 1);
[d1b1cf6]412  av_store(inc, 0, owl_new_sv(path));
[ddbbcffa]413  g_free(path);
[fd8dfe7]414
415  eval_pv("use BarnOwl;", FALSE);
[f1e629d]416
417  if (SvTRUE(ERRSV)) {
[d4927a7]418    err=g_strdup(SvPV_nolen(ERRSV));
[27c3a93]419    sv_setsv (ERRSV, &PL_sv_undef);     /* and clear the error */
[4e0f545]420    return(err);
[f1e629d]421  }
422
423  /* check if we have the formatting function */
[8203afd]424  if (owl_perlconfig_is_function("BarnOwl::format_msg")) {
[f1e629d]425    owl_global_set_config_format(&g, 1);
426  }
427
428  return(NULL);
429}
430
431/* returns whether or not a function exists */
[e19eb97]432int owl_perlconfig_is_function(const char *fn) {
[c415aca]433  if (get_cv(fn, FALSE)) return(1);
[f1e629d]434  else return(0);
435}
436
437/* caller is responsible for freeing returned string */
[6829afc]438CALLER_OWN char *owl_perlconfig_execute(const char *line)
[c3acb0b]439{
[f1e629d]440  STRLEN len;
441  SV *response;
[65b2173]442  char *out;
[f1e629d]443
444  if (!owl_global_have_config(&g)) return NULL;
445
[e0096b7]446  ENTER;
447  SAVETMPS;
[f1e629d]448  /* execute the subroutine */
[c415aca]449  response = eval_pv(line, FALSE);
[f1e629d]450
451  if (SvTRUE(ERRSV)) {
[ce6721f]452    owl_function_error("Perl Error: '%s'", SvPV_nolen(ERRSV));
[27c3a93]453    sv_setsv (ERRSV, &PL_sv_undef);     /* and clear the error */
[f1e629d]454  }
455
[d4927a7]456  out = g_strdup(SvPV(response, len));
[e0096b7]457  FREETMPS;
458  LEAVE;
[f1e629d]459
460  return(out);
461}
462
[c08c70a]463void owl_perlconfig_getmsg(const owl_message *m, const char *subname)
[b67ab6b]464{
465  char *ptr = NULL;
466  if (owl_perlconfig_is_function("BarnOwl::Hooks::_receive_msg")) {
467    ptr = owl_perlconfig_call_with_message(subname?subname
468                                           :"BarnOwl::_receive_msg_legacy_wrap", m);
[f1e629d]469  }
[3b8a563]470  g_free(ptr);
[0f9eca7]471}
472
473/* Called on all new messages; receivemsg is only called on incoming ones */
[c08c70a]474void owl_perlconfig_newmsg(const owl_message *m, const char *subname)
[0f9eca7]475{
476  char *ptr = NULL;
477  if (owl_perlconfig_is_function("BarnOwl::Hooks::_new_msg")) {
478    ptr = owl_perlconfig_call_with_message(subname?subname
479                                           :"BarnOwl::Hooks::_new_msg", m);
480  }
[3b8a563]481  g_free(ptr);
[f1e629d]482}
[6922edd]483
[e19eb97]484void owl_perlconfig_new_command(const char *name)
[eb6cedc]485{
486  dSP;
487
488  ENTER;
489  SAVETMPS;
490
491  PUSHMARK(SP);
[d1b1cf6]492  XPUSHs(sv_2mortal(owl_new_sv(name)));
[eb6cedc]493  PUTBACK;
494
[a9237aa]495  call_pv("BarnOwl::Hooks::_new_command", G_VOID|G_EVAL);
[eb6cedc]496
497  SPAGAIN;
498
499  if(SvTRUE(ERRSV)) {
500    owl_function_error("%s", SvPV_nolen(ERRSV));
501  }
502
503  FREETMPS;
504  LEAVE;
505}
506
[d427f08]507/* caller must free the result */
[6829afc]508CALLER_OWN char *owl_perlconfig_perlcmd(const owl_cmd *cmd, int argc, const char *const *argv)
[6922edd]509{
510  int i, count;
511  char * ret = NULL;
[ad15610]512  SV *rv;
[6922edd]513  dSP;
514
515  ENTER;
516  SAVETMPS;
517
518  PUSHMARK(SP);
519  for(i=0;i<argc;i++) {
[d1b1cf6]520    XPUSHs(sv_2mortal(owl_new_sv(argv[i])));
[6922edd]521  }
522  PUTBACK;
523
524  count = call_sv(cmd->cmd_perl, G_SCALAR|G_EVAL);
525
526  SPAGAIN;
527
528  if(SvTRUE(ERRSV)) {
[ce6721f]529    owl_function_error("%s", SvPV_nolen(ERRSV));
[c4ba74d]530    (void)POPs;
[6922edd]531  } else {
532    if(count != 1)
533      croak("Perl command %s returned more than one value!", cmd->name);
[ad15610]534    rv = POPs;
[6922edd]535    if(SvTRUE(rv)) {
[d4927a7]536      ret = g_strdup(SvPV_nolen(rv));
[6922edd]537    }
538  }
539
540  FREETMPS;
541  LEAVE;
542
543  return ret;
544}
545
[8f2d9bf]546void owl_perlconfig_cmd_cleanup(owl_cmd *cmd)
[6922edd]547{
[ff13a6f]548  SvREFCNT_dec(cmd->cmd_perl);
[6922edd]549}
[db8b00b]550
551void owl_perlconfig_edit_callback(owl_editwin *e)
552{
[4d86e06]553  SV *cb = owl_editwin_get_cbdata(e);
[367fbf3]554  SV *text;
[ad15610]555  dSP;
556
[db8b00b]557  if(cb == NULL) {
558    owl_function_error("Perl callback is NULL!");
[1373d35]559    return;
[db8b00b]560  }
[d1b1cf6]561  text = owl_new_sv(owl_editwin_get_text(e));
[db8b00b]562
563  ENTER;
564  SAVETMPS;
565
566  PUSHMARK(SP);
[367fbf3]567  XPUSHs(sv_2mortal(text));
[db8b00b]568  PUTBACK;
569 
[e3068de]570  call_sv(cb, G_DISCARD|G_EVAL);
[9364a36]571
572  if(SvTRUE(ERRSV)) {
[ce6721f]573    owl_function_error("%s", SvPV_nolen(ERRSV));
[9364a36]574  }
[db8b00b]575
576  FREETMPS;
577  LEAVE;
[1b1cd2c]578}
[db8b00b]579
[1b1cd2c]580void owl_perlconfig_dec_refcnt(void *data)
581{
582  SV *v = data;
583  SvREFCNT_dec(v);
[db8b00b]584}
Note: See TracBrowser for help on using the repository browser.