sv.h 2.37 KB
#ifndef SV_H
#define SV_H

#include <mailutils/mailbox.h>
#include <mailutils/address.h>
#include <mailutils/registrar.h>

#include "sieve_interface.h"

#include "svfield.h"

#include "sieve.h"

/** sieve context structures

The object relationship diagram is this, with the names in ""
being the argument name when the contexts are provided as
arguments to callback functions.

  sieve_execute_script()  --> sv_msg_ctx_t, "mc"

       |
       |
       V

  sieve_script_t  --->  sv_script_ctx_t, "sc"

       |
       |
       V

  sieve_interp_t  --->  sv_interp_ctx_t, "ic"


*/

typedef struct sv_interp_ctx_t
{
  /* The sieve interpreter for our context. */
  sieve_interp_t *interp;

  /* Callback functions. */
  sv_parse_error_t   parse_error;
  sv_execute_error_t execute_error;
  sv_action_log_t    action_log;

} sv_interp_ctx_t;

typedef struct sv_script_ctx_t
{
  /* The file the script was parsed from. */
  char* file;

  /* The sieve script for our context. */
  sieve_script_t* script;

  /* The sieve interpreter context for our script. */
  sv_interp_ctx_t* ic;

} sv_script_ctx_t;

typedef struct sv_msg_ctx_t
{
  /* The mailutils return code - the real error. */
  int rc;

  /* The field cache. */
  int cache_filled;
  sv_field_cache_t cache;

  sv_script_ctx_t* sc;

  message_t msg;

  /* Ticket for use by mailbox URLs for implicit authentication. */
  ticket_t ticket;

  mu_debug_t debug;

  /* Flags controlling execution of script. */
  int svflags;

  /* The uid of the message, for debug output. */
  size_t uid;
} sv_msg_ctx_t;


/*
  svcb.c: sieve callbacks
*/

int sv_register_callbacks (sieve_interp_t * i);

/*
  sv?.c: sv print wrappers

  These should call print callbacks supplied by the user of the mailutils
  sieve implementation.
*/

extern void sv_printv (sv_interp_ctx_t* ic, int level, const char *fmt, va_list ap);
extern void sv_print (sv_interp_ctx_t* ic, int level, const char* fmt, ...);

/*
  svutil.c: utility functions and mailutil wrapper functions
*/

/* Converts a mailutils errno to the equivalent sieve return code. */

extern int sv_mu_errno_to_rc (int eno);

extern int sv_mu_debug_print (mu_debug_t d, const char *fmt, va_list ap);

extern int sv_mu_mark_deleted (message_t msg);

extern int sv_mu_copy_debug_level (const mailbox_t from, mailbox_t to);

extern int sv_mu_save_to (const char *toname, message_t msg, ticket_t ticket, mu_debug_t debug);

#endif