source: perlconfig.c @ f9df2f0

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