source: perlconfig.c @ caac19d

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