src/core/sipmsg.h

   1 /**
   2  * @file sipmsg.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2010-11 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 *responsestr;
  34         gchar *method;
  35         gchar *target;
  36         GSList *headers;
  37         GSList *new_headers;
  38         int bodylen;
  39         gchar *body;
  40         gchar *signature;
  41         gchar *rand;
  42         gchar *num;
  43 };
  44
  45 struct sipendpoint {
  46         gchar *contact;
  47         gchar *epid;
  48 };
  49
  50
  51 struct sipmsg *sipmsg_parse_msg(const gchar *msg);
  52 struct sipmsg *sipmsg_parse_header(const gchar *header);
  53 struct sipmsg *sipmsg_copy(const struct sipmsg *other);
  54 void sipmsg_add_header_now(struct sipmsg *msg, const gchar *name, const gchar *value);
  55 void sipmsg_add_header(struct sipmsg *msg, const gchar *name, const gchar *value);
  56 void sipmsg_add_header_now_pos(struct sipmsg *msg, const gchar *name, const gchar *value, int pos);
  57 void sipmsg_strip_headers(struct sipmsg *msg, const gchar *keepers[]);
  58 void sipmsg_merge_new_headers(struct sipmsg *msg);
  59 void sipmsg_free(struct sipmsg *msg);
  60
  61 /**
  62  * Parses CSeq from SIP message
  63  *
  64  * @param msg (in) SIP message
  65  *
  66  * @return int type CSeq value (i.e. without method).
  67  */
  68 int sipmsg_parse_cseq(struct sipmsg *msg);
  69
  70 GSList *sipmsg_parse_endpoints_header(const gchar *header);
  71 /**
  72  * Parses sip: and tel: URI out of P-Asserted-Identity header from INVITE request.
  73  * You must free the values.
  74  *
  75  * Example headers:
  76  * P-Asserted-Identity: "Cullen Jennings" <sip:fluffy@cisco.com>
  77  * P-Asserted-Identity: tel:+14085264000
  78  * P-Asserted-Identity: "Lunch, Lucas" <sip:llucas@cisco.com>,<tel:+420123456;ext=88463>
  79  *
  80  * @param header (in) P-Asserted-Identity header contents
  81  * @param sip_uri (out) parsed sip: URI or NULL if missing
  82  * @param tel_uri (out) parsed tel: URI or NULL if missing
  83  */
  84 void sipmsg_parse_p_asserted_identity(const gchar *header, gchar **sip_uri,
  85                                       gchar **tel_uri);
  86 const gchar *sipmsg_find_header(const struct sipmsg *msg, const gchar *name);
  87 const gchar *sipmsg_find_header_instance(const struct sipmsg *msg, const gchar *name, int which);
  88 gchar *sipmsg_find_part_of_header(const char *hdr, const char * before, const char * after, const char * def);
  89 gchar *sipmsg_find_auth_header(struct sipmsg *msg, const gchar *name);
  90 void sipmsg_remove_header_now(struct sipmsg *msg, const gchar *name);
  91 char *sipmsg_to_string(const struct sipmsg *msg);
  92
  93 /**
  94  * Formats message to html if not yet.
  95  * Either - keep as is if text/html, or escape text, or escape text and apply format string if any
  96  *
  97  * @param body in case of 'ms_text_format is Content-Type header' or NULL otherwise
  98  * @param ms_text_format either ms-text-format ot Content-Type header.
  99  *
 100  * Allocates memory. Must be feed when done.
 101  */
 102 gchar *get_html_message(const gchar *ms_text_format, const gchar *body);
 103
 104 /**
 105  * Returns UTF-16LE/'modified base64' encoded X-MMS-IM-Format
 106  * based on input x_mms_im_format.
 107  */
 108 gchar *sipmsg_get_msgr_string(gchar *x_mms_im_format);
 109
 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 /**
 122  * Extracts reason string from ms-diagnostics header of SIP message
 123  *
 124  * @param msg SIP message
 125  *
 126  * @return reason string. Must be g_free()'d after use.
 127  */
 128 gchar *sipmsg_get_ms_diagnostics_reason(struct sipmsg *msg);
 129
 130 /**
 131  * Extracts reason string from ms-diagnostics-public header of SIP message
 132  *
 133  * @param msg SIP message
 134  *
 135  * @return reason string. Must be g_free()'d after use.
 136  */
 137 gchar *sipmsg_get_ms_diagnostics_public_reason(struct sipmsg *msg);
 138
 139 /**
 140  * Parses Warning header of SIP message, if present.
 141  *
 142  * @param msg (in) SIP message
 143  * @param reason (out) parsed warning text or NULL if missing. Must be g_free()'d
 144  *               after use.
 145  *
 146  * @return warning code or -1 if warning header is not present in message.
 147  */
 148 int sipmsg_parse_warning(struct sipmsg *msg, gchar **reason);