src/core/sipmsg.h

   1 /**
   2  * @file sipmsg.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2010 SIPE Project <http://sipe.sourceforge.net/>
   7  * Copyright (C) 2008 Novell, Inc.
   8  * Copyright (C) 2005, Thomas Butter <butter@uni-mannheim.de>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23  */
  24
  25 /*
  26  * Interface dependencies:
  27  *
  28  * <glib.h>
  29  */
  30
  31 struct sipmsg {
  32         int response; /* 0 means request, otherwise response code */
  33         gchar *method;
  34         gchar *target;
  35         GSList *headers;
  36         GSList *new_headers;
  37         int bodylen;
  38         gchar *body;
  39         gchar *signature;
  40         gchar *rand;
  41         gchar *num;
  42         /*
  43          * Set this flag when you need to keep input message for further processing.
  44          * Such message won't be freed automatically after process_input_message()
  45          * returns.
  46          *
  47          * For example incoming media session invite response can not be sent
  48          * immediately but after interaction with user, who accepts or declines
  49          * the call.
  50          *
  51          * Call sipmsg_free() when the message is not needed anymore.
  52          */
  53         gboolean dont_free;
  54 };
  55
  56 struct sipendpoint {
  57         gchar *contact;
  58         gchar *epid;
  59 };
  60
  61
  62 struct sipmsg *sipmsg_parse_msg(const gchar *msg);
  63 struct sipmsg *sipmsg_parse_header(const gchar *header);
  64 void sipmsg_add_header_now(struct sipmsg *msg, const gchar *name, const gchar *value);
  65 void sipmsg_add_header(struct sipmsg *msg, const gchar *name, const gchar *value);
  66 void sipmsg_add_header_now_pos(struct sipmsg *msg, const gchar *name, const gchar *value, int pos);
  67 void sipmsg_strip_headers(struct sipmsg *msg, const gchar *keepers[]);
  68 void sipmsg_merge_new_headers(struct sipmsg *msg);
  69 void sipmsg_free(struct sipmsg *msg);
  70 GSList *sipmsg_parse_endpoints_header(const gchar *header);
  71 const gchar *sipmsg_find_header(const struct sipmsg *msg, const gchar *name);
  72 const gchar *sipmsg_find_header_instance(const struct sipmsg *msg, const gchar *name, int which);
  73 gchar *sipmsg_find_part_of_header(const char *hdr, const char * before, const char * after, const char * def);
  74 gchar *sipmsg_find_auth_header(struct sipmsg *msg, const gchar *name);
  75 void sipmsg_remove_header_now(struct sipmsg *msg, const gchar *name);
  76 char *sipmsg_to_string(const struct sipmsg *msg);
  77
  78 /**
  79  * Formats message to html if not yet.
  80  * Either - keep as is if text/html, or escape text, or escape text and apply format string if any
  81  *
  82  * @param body in case of 'ms_text_format is Content-Type header' or NULL otherwise
  83  * @param ms_text_format either ms-text-format ot Content-Type header.
  84  *
  85  * Allocates memory. Must be feed when done.
  86  */
  87 gchar *get_html_message(const gchar *ms_text_format, const gchar *body);
  88
  89 /**
  90  * Parses headers-like 'msgr' attribute of INVITE's 'ms_text_format' header.
  91  * Then retrieves value of 'X-MMS-IM-Format'.
  92
  93  * 'msgr' typically looks like:
  94  * X-MMS-IM-Format: FN=Microsoft%20Sans%20Serif; EF=BI; CO=800000; CS=0; PF=22
  95  */
  96 gchar *sipmsg_get_x_mms_im_format(gchar *msgr);
  97
  98 /**
  99  * Returns UTF-16LE/'modified base64' encoded X-MMS-IM-Format
 100  * based on input x_mms_im_format.
 101  */
 102 gchar *sipmsg_get_msgr_string(gchar *x_mms_im_format);
 103
 104 /**
 105  * Translates X-MMS-IM format to HTML presentation.
 106  */
 107 gchar *sipmsg_apply_x_mms_im_format(const char *x_mms_im_format, gchar *body);
 108
 109 #define sipe_parse_html            msn_import_html
 110 /**
 111  * Parses the Purple message formatting (html) into the MSN format.
 112  *
 113  * @param html                  The html message to format.
 114  * @param attributes    The returned attributes string.
 115  * @param message               The returned message string.
 116  *
 117  * @return The new message.
 118  */
 119 void sipe_parse_html(const char *html, char **attributes, char **message);
 120
 121 void msn_parse_format(const char *mime, char **pre_ret, char **post_ret);
 122 void msn_import_html(const char *html, char **attributes, char **message);