src/core/sipe-utils.h

   1 /**
   2  * @file sipe-utils.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2009-2013 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  * Interface dependencies:
  25  *
  26  * <time.h>
  27  * <glib.h>
  28  */
  29
  30 /* Forward declarations */
  31 struct sipe_core_private;
  32 struct sipe_transport_connection;
  33
  34 /* Our publication type keys. OCS 2007+
  35  * Format: SIPE_PUB_{Category}[_{SubSategory}]
  36  */
  37 /**
  38  * device
  39  * -
  40  *
  41  * -
  42  * Unique to the device.
  43  */
  44 #define SIPE_PUB_DEVICE         0
  45 /**
  46  * state
  47  * Machine state
  48  *
  49  * Availability, activity, end-point location, time zone, and device type.
  50  * First hexadecimal digit is 0x3; remaining seven hexadecimal digits are unique per device.
  51  */
  52 #define SIPE_PUB_STATE_MACHINE  3
  53 /**
  54  * state
  55  * User state
  56  *
  57  * Availability and activity.
  58  * 0x20000000
  59  */
  60 #define SIPE_PUB_STATE_USER     2
  61 /**
  62  * state
  63  * Calendar state
  64  *
  65  * Availability, activity, meeting subject, and meeting location.
  66  * First hexadecimal digit is 0x4; remaining seven hexadecimal digits are unique per device.
  67  */
  68 #define SIPE_PUB_STATE_CALENDAR 4
  69 /**
  70  * state
  71  * Calendar state for an Out of Office meeting
  72  *
  73  * (??)Activity for when a user sets or removes an Out of Office message in Exchange.
  74  * (+)user sets in Outlook for an Out of Office meeting
  75  * First hexadecimal digit is 0x5; remaining seven hexadecimal digits are unique per device.
  76  */
  77 #define SIPE_PUB_STATE_CALENDAR_OOF     5
  78 /**
  79  * state
  80  * RCC Phone State
  81  *
  82  * Availability and activity for RCC call connect/disconnect or participant count changes from 0 to 2, 2 to N, N to 2, 2 to 0.
  83  * First hexadecimal digit is 0x7; remaining seven hexadecimal digits are unique per device.
  84  */
  85 #define SIPE_PUB_STATE_PHONE_RCC        7
  86 /**
  87  * state
  88  * VOIP Phone State
  89  *
  90  * Availability and activity for VOIP call connect/disconnect or participant count changes from 0 to 2, 2 to N, N to 2, 2 to 0.
  91  * First hexadecimal digit is 0x8; remaining seven hexadecimal digits uniquely define the SIP URI and device.
  92  */
  93 #define SIPE_PUB_STATE_PHONE_VOIP       8
  94 /**
  95  * calendarData
  96  * Free/busy data
  97  *
  98  * Start time, granularity, and free/busy data.
  99  * First hexadecimal digit is 0x4; last seven hexadecimal digits uniquely define the calendar.
 100  */
 101 #define SIPE_PUB_CALENDAR_DATA  400
 102 /**
 103  * note
 104  * Out of Office note
 105  *
 106  * Out of Office note that a user sets in Outlook using the Out of Office assistant.
 107  * First hexadecimal digit is 0x4; last seven hexadecimal digits uniquely define the calendar.
 108  */
 109 #define SIPE_PUB_NOTE_OOF       400
 110
 111 /**
 112  * Returns epid value.
 113  *
 114  * @param sipe_private (in) SIPE core private data
 115  *
 116  * @return epid. Must be g_free()'d.
 117  */
 118 gchar *
 119 get_epid(struct sipe_core_private *sipe_private);
 120
 121 /**
 122  * Returns UUID value.
 123  *
 124  * @param sipe_private (in) SIPE core private data
 125  *
 126  * @return uuid. Must be g_free()'d.
 127  */
 128 gchar *
 129 get_uuid(struct sipe_core_private *sipe_private);
 130
 131 /**
 132  * Generate Call ID
 133  *
 134  * @return Call ID. Must be g_free()'d.
 135  */
 136 gchar *gencallid(void);
 137
 138 /**
 139  * Generate Tag
 140  *
 141  * @return Tag. Must be g_free()'d.
 142  */
 143 gchar *gentag(void);
 144
 145 /**
 146  * Generate conference-id
 147  * 32 characters long. Value space is restricted to printable ASCII characters
 148  *
 149  * Ex.: 8386E6AEAAA41E4AA6627BA76D43B6D1
 150  *
 151  * @return conference-id. Must be g_free()'d.
 152  */
 153 gchar *genconfid(void);
 154
 155 /**
 156  * Returns instance value for particular publication type.
 157  * It should be consistent for the same endpoint
 158  * but different between distinct endpoints.
 159  *
 160  * See defined constants for keys patterned SIPE_PUB_*
 161  */
 162 guint
 163 sipe_get_pub_instance(struct sipe_core_private *sipe_private,
 164                       int publication_key);
 165
 166 /**
 167  * Get contact information from SIPE account
 168  *
 169  * @param sipe_private (in) SIPE core private data
 170  *
 171  * @return Contact. Must be g_free()'d.
 172  */
 173 gchar *get_contact(const struct sipe_core_private *sipe_private);
 174
 175 /**
 176  * Parses URI from SIP header
 177  *
 178  * @param hdr (in) To/From header
 179  *
 180  * @return URI with sip: prefix. Must be g_free()'d.
 181  */
 182 gchar *parse_from(const gchar *hdr);
 183
 184 /**
 185  * Create sip: URI from name
 186  *
 187  * @param name (in)
 188  *
 189  * @return URI with sip: prefix. Must be g_free()'d.
 190  */
 191 gchar *sip_uri_from_name(const gchar *name);
 192
 193 /**
 194  * Create sip: URI from SIP account user name
 195  *
 196  * @param sipe_private (in) SIPE core private data
 197  *
 198  * @return URI with sip: prefix. Must be g_free()'d.
 199  */
 200 #define sip_uri_self(sipe_private) (sip_uri_from_name(sipe_private->username))
 201
 202 /**
 203  * Create sip: URI from name or sip: URI
 204  *
 205  * @param string (in) name or sip: URI
 206  *
 207  * @return URI with sip: prefix. Must be g_free()'d.
 208  */
 209 gchar *sip_uri(const gchar *string);
 210
 211 /**
 212  * Create sip: URI from name or sip: URI. Checks for invalid characters
 213  *
 214  * @param string (in) name or sip: URI
 215  *
 216  * @return URI with sip: prefix. Returns NULL if @c string contains invalid
 217  *         characters. Must be g_free()'d.
 218  */
 219 gchar *sip_uri_if_valid(const gchar *string);
 220
 221 /**
 222  * Returns pointer to URI without sip: prefix if any (doesn't allocate memory)
 223  *
 224  * @param sip_uri SIP URI possibly with sip: prefix. Example: sip:first.last@hq.company.com
 225  *
 226  * @return pointer to URL without sip: prefix. Coresponding example: first.last@hq.company.com
 227  */
 228 const gchar *sipe_get_no_sip_uri(const gchar *sip_uri);
 229
 230 /**
 231  * Tries to figure out if contact alias which stored locally
 232  * is just SIP URI, not a proper display name or local alias.
 233  *
 234  * @param uri SIP URI with 'sip:' prefix.
 235  * @param alias as returned by purple.
 236  */
 237 gboolean
 238 sipe_is_bad_alias(const char *uri,
 239                   const char *alias);
 240
 241 /**
 242  * Checks if provided string is empty - NULL, zero size or just series of white spaces.
 243  * Doesn't modify input string.
 244  */
 245 gboolean
 246 is_empty(const char *st);
 247
 248 /** Returns newly allocated string. Must be g_free()'d */
 249 char *
 250 replace(const char *st,
 251         const char *search,
 252         const char *replace);
 253
 254 /**
 255  * Message debugging
 256  *
 257  * @param type    message type description (SIP or HTTP).
 258  * @param header  message header
 259  * @param body    message body or NULL
 260  * @param sending TRUE if outgoing message
 261  */
 262 void sipe_utils_message_debug(const gchar *type,
 263                               const gchar *header,
 264                               const gchar *body,
 265                               gboolean sending);
 266
 267 /**
 268  * Tests two strings for equality.
 269  *
 270  * Unlike strcmp(), this function will not crash if one or both of the
 271  * strings are @c NULL.
 272  *
 273  * Same as purple_strequal (defined only for 2.6) to maintain
 274  * our backward compatibility.
 275  *
 276  * @param left  A string
 277  * @param right A string to compare with left
 278  *
 279  * @return @c TRUE if the strings are the same, else @c FALSE.
 280  *
 281  */
 282 gboolean sipe_strequal(const gchar *left, const gchar *right);
 283
 284 /**
 285  * Tests two strings for equality, ignoring the case
 286  *
 287  * Same as glib @c g_ascii_strcasecmp() but works correctly for @c NULL
 288  * pointers too. Plus it doesn't complain loudly about them...
 289  *
 290  * @param left  A string
 291  * @param right A string to compare with left
 292  *
 293  * @return @c TRUE if the strings are the same, else @c FALSE.
 294  *
 295  */
 296 gboolean sipe_strcase_equal(const gchar *left, const gchar *right);
 297
 298 /**
 299  * Compares two strings
 300  *
 301  * Unlike strcmp(), this function will not crash if one or both of the
 302  * strings are @c NULL.
 303  *
 304  * Same as g_strcmp0 (defined only for >= 2.16) to maintain
 305  * our backward compatibility. The declaration is compatible to
 306  * @c GCompareFunc.
 307  *
 308  * @param a A string
 309  * @param b A string to compare with a
 310  *
 311  * @return negative value if a < b; zero if a = b; positive value if a > b.
 312  *
 313  */
 314 gint sipe_strcompare(gconstpointer a, gconstpointer b);
 315
 316 /**
 317  * Parses a timestamp in ISO8601 format and returns a time_t.
 318  * Assumes UTC if no timezone specified
 319  *
 320  * @param timestamp The timestamp
 321  */
 322 time_t
 323 sipe_utils_str_to_time(const gchar *timestamp);
 324
 325 /**
 326  * Converts time_t to ISO8601 string.
 327  * Timezone is UTC.
 328  *
 329  * Must be g_free()'d after use.
 330  *
 331  * Example: 2010-02-03T23:59:59Z
 332  */
 333 gchar *
 334 sipe_utils_time_to_str(time_t timestamp);
 335
 336 struct sipnameval {
 337         gchar *name;
 338         gchar *value;
 339 };
 340
 341 /**
 342  * Parses string of hex digits to buffer.
 343  * Allocates memory.
 344  *
 345  * @param hex_str (in)  string of hex digits to convert.
 346  * @param buff (out)    newly allocated buffer. Must be g_free()'d after use.
 347  *
 348  * @return              size of newly allocated buffer
 349  */
 350 size_t
 351 hex_str_to_buff(const char *hex_str, guint8 **buff);
 352
 353 /**
 354  * Composes hex string out of provided buffer.
 355  * Allocates memory.
 356  *
 357  * @param buff          input buffer
 358  * @param buff_len      length of buffer
 359  *
 360  * @result              newly allocated hex string representing buffer. Must be g_free()'d after use.
 361  */
 362 char *
 363 buff_to_hex_str(const guint8 *buff, const size_t buff_len);
 364
 365 /**
 366  * Creates name-value pairs from given lines and appends them to @c list
 367  *
 368  * Lines must be in format 'name [delimiter] value'
 369  *
 370  * @param list      a list of @c sipnameval structures
 371  * @param lines     array of strings in format 'name: value'
 372  * @param delimiter sequence of characters between name and value
 373  *
 374  * @return @c FALSE if any of @c lines has incorrect format, @c TRUE otherwise
 375  */
 376 gboolean
 377 sipe_utils_parse_lines(GSList **list, gchar **lines, gchar *delimiter);
 378
 379 /**
 380  * Adds a name-value pair to @c list
 381  *
 382  * @param list  a list of @c sipnameval structures
 383  * @param name  attribute's name
 384  * @param value value of attribute @c name
 385  *
 386  * @return the new start of the GSList
 387  */
 388 GSList *
 389 sipe_utils_nameval_add(GSList *list, const gchar *name, const gchar *value);
 390
 391 /**
 392  * Finds a value of attribute @c name in @c list
 393  *
 394  * @param list a list of @c sipnameval structures
 395  * @param name attribute to find
 396  *
 397  * @return value of @c name or NULL if @c name is not found
 398  */
 399 const gchar *
 400 sipe_utils_nameval_find(const GSList *list, const gchar *name);
 401
 402 /**
 403  * Returns @c which occurrence of attribute @c name in @c list
 404  *
 405  * @c which is zero based, so 0 means first occurrence of @c name in @c list.
 406  *
 407  * @param list  a list of @c sipnameval structures
 408  * @param name  attribute to find
 409  * @param which specifies occurrence of @name in @c list
 410  *
 411  * @return value of @c name or NULL if @c name is not found
 412  */
 413 const gchar *
 414 sipe_utils_nameval_find_instance(const GSList *list, const gchar *name, int which);
 415
 416 /**
 417  * Frees memory allocated by @c list
 418  *
 419  * @param list a list of @c sipnameval structures
 420  */
 421 void
 422 sipe_utils_nameval_free(GSList *list);
 423
 424 /**
 425  * Given a string, this replaces one substring with another
 426  * and returns a newly allocated string.
 427  *
 428  * @param string      the string from which to replace stuff.
 429  * @param delimiter   the substring you want replaced.
 430  * @param replacement the substring you want as replacement.
 431  *
 432  * @return string with the substitution or NULL. Must be g_free()'d after use.
 433  */
 434 gchar *sipe_utils_str_replace(const gchar *string,
 435                               const gchar *delimiter,
 436                               const gchar *replacement);
 437
 438 /**
 439  * Remove read characters from transport buffer
 440  *
 441  * @param conn   the transport connection
 442  * @param unread pointer to the first character in the buffer
 443  */
 444 void sipe_utils_shrink_buffer(struct sipe_transport_connection *conn,
 445                               const gchar *unread);
 446 /**
 447  * Checks whether given IP address belongs to private block as defined in RFC1918
 448  *
 449  * @param ip IPv4 address in "X.X.X.X" format
 450  * @return @c TRUE if address is private
 451  */
 452 gboolean sipe_utils_ip_is_private(const char *ip);
 453
 454 /**
 455  * Generate presence key
 456  *
 457  * @param uri presence URI
 458  *
 459  * @return key string. Must be g_free()'d after use.
 460  */
 461 gchar *sipe_utils_presence_key(const gchar *uri);
 462
 463 /**
 464  * Decodes a URI into a plain string.
 465  *
 466  * @param string the string to translate.
 467  *
 468  * @return the resulting string. Must be g_free()'d after use.
 469  */
 470 gchar *sipe_utils_uri_unescape(const gchar *string);
 471
 472 /**
 473  * Inserts in item in the list only if the value isn't already in that list
 474  *
 475  * @param list    a singly linked list
 476  * @param data    the item to insert. Will not be copied.
 477  * @param func    function to use to compare the values
 478  * @param destroy if @c NULL call to destroy @c data if is already on list
 479  *
 480  * @return the new list head
 481  */
 482 GSList *sipe_utils_slist_insert_unique_sorted(GSList *list,
 483                                               gpointer data,
 484                                               GCompareFunc func,
 485                                               GDestroyNotify destroy);
 486
 487 /**
 488  * Same as @c g_slist_free_full() which is only defined for >= 2.28
 489  *
 490  * @param list a singly linked list
 491  * @param free function to free list data
 492  */
 493 void sipe_utils_slist_free_full(GSList *list,
 494                                 GDestroyNotify free);