src/sipe-utils.h

   1 /**
   2  * @file sipe-utils.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2009 SIPE Project <http://sipe.sourceforge.net/>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 /**
  24  * Returns epid value.
  25  * Uses cache.
  26  */
  27 gchar *
  28 get_epid(struct sipe_account_data *sip);
  29
  30 /**
  31  * Generate Call ID
  32  *
  33  * @return Call ID. Must be g_free()'d.
  34  */
  35 gchar *gencallid(void);
  36
  37 /**
  38  * Generate Tag
  39  *
  40  * @return Tag. Must be g_free()'d.
  41  */
  42 gchar *gentag(void);
  43
  44 /**
  45  * Generate conference-id
  46  * 32 characters long. Value space is restricted to printable ASCII characters
  47  *
  48  * Ex.: 8386E6AEAAA41E4AA6627BA76D43B6D1
  49  *
  50  * @return conference-id. Must be g_free()'d.
  51  */
  52 gchar *genconfid(void);
  53
  54 /**
  55  * Returns instance value for particular publication type.
  56  * It should be consistent for the same endpoint
  57  * but different between distinct endpoints.
  58  *
  59  * See defined constants for keys patterned SIPE_PUB_*
  60  */
  61 guint
  62 sipe_get_pub_instance(struct sipe_account_data *sip,
  63                       const char *publication_key);
  64
  65 /**
  66  * Get contact information from SIPE account
  67  *
  68  * @param sip (in) SIPE account
  69  *
  70  * @return Contact. Must be g_free()'d.
  71  */
  72 gchar *get_contact(const struct sipe_account_data *sip);
  73
  74 /**
  75  * Parses URI from SIP header
  76  *
  77  * @param hdr (in) To/From header
  78  *
  79  * @return URI with sip: prefix. Must be g_free()'d.
  80  */
  81 gchar *parse_from(const gchar *hdr);
  82
  83 /**
  84  * Parses CSeq from SIP header
  85  *
  86  * @param hdr (in) CSeqm header
  87  *
  88  * @return int type CSeq value (i.e. without method).
  89  */
  90 int parse_cseq(const gchar *hdr);
  91
  92 /**
  93  * Create sip: URI from name
  94  *
  95  * @param name (in)
  96  *
  97  * @return URI with sip: prefix. Must be g_free()'d.
  98  */
  99 gchar *sip_uri_from_name(const gchar *name);
 100
 101 /**
 102  * Create sip: URI from SIP account user name
 103  *
 104  * @param sip (in) SIP account data
 105  *
 106  * @return URI with sip: prefix. Must be g_free()'d.
 107  */
 108 #define sip_uri_self(sip) (sip_uri_from_name(sip->username))
 109
 110 /**
 111  * Create sip: URI from name or sip: URI
 112  *
 113  * @param string (in) name or sip: URI
 114  *
 115  * @return URI with sip: prefix. Must be g_free()'d.
 116  */
 117 gchar *sip_uri(const gchar *string);
 118
 119 /**
 120  * Tries to figure out if contact alias which stored locally
 121  * is just SIP URI, not a proper display name or local alias.
 122  *
 123  * @param uri SIP URI with 'sip:' prefix.
 124  * @param alias as returned by purple.
 125  */
 126 gboolean
 127 sipe_is_bad_alias(const char *uri,
 128                   const char *alias);
 129
 130 /**
 131  * Find a XML node from the parent with the specified path
 132  *
 133  * @param parent (in) XML node to start search from
 134  * @param ...    (in) Names of the descendant nodes
 135  *
 136  * @return descendant XML node
 137  */
 138 xmlnode * xmlnode_get_descendant(const xmlnode *parent, ...);
 139
 140 /**
 141  * For glib < 2.8 compatibility
 142  */
 143 char *sipe_get_host_name(void);
 144
 145 /**
 146  * Strip white space from the beginning and end of a string
 147  *
 148  * @param b string to be trimmed (may be modified)
 149  *
 150  * @return trimmed string
 151  */
 152 char *trim(char *b);
 153
 154 /**
 155  * Checks if provided string is empty - NULL, zero size or just series of white spaces.
 156  * Doesn't modify input string.
 157  */
 158 gboolean
 159 is_empty(const char *st);