src/core/sipmsg.h

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