src/api/sipe-backend.h

   1 /**
   2  * @file sipe-backend.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2010-12 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  *
  25  * SIPE Core -> Backend API - functions called by SIPE core code
  26  *
  27  ***************** !!! IMPORTANT NOTE FOR BACKEND CODERS !!! *****************
  28  *
  29  *            The SIPE core assumes atomicity and is *NOT* thread-safe.
  30  *
  31  * It *does not* protect any of its data structures or code paths with locks!
  32  *
  33  * In no circumstances it must be possible that a sipe_core_xxx() function can
  34  * be entered through another thread while the first thread has entered the
  35  * backend specific code through a sipe_backend_xxx() function.
  36  *
  37  ***************** !!! IMPORTANT NOTE FOR BACKEND CODERS !!! *****************
  38  */
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 /* Forward declarations */
  45 struct sipe_backend_chat_session;
  46 struct sipe_chat_session;
  47 struct sipe_core_public;
  48 struct sipe_transport_connection;
  49 struct sipe_file_transfer;
  50 struct sipe_media_call;
  51 struct sipe_media;
  52
  53 /** MISC. STUFF **************************************************************/
  54 /**
  55  * Get the version of the backend suitable for e.g. UserAgent
  56  *
  57  * @return backend version string. Will be g_free()'d.by the core.
  58  */
  59 gchar *sipe_backend_version(void);
  60
  61 /** DEBUGGING ****************************************************************/
  62
  63 typedef enum {
  64         SIPE_DEBUG_LEVEL_INFO,
  65         SIPE_DEBUG_LEVEL_WARNING,
  66         SIPE_DEBUG_LEVEL_ERROR,
  67         SIPE_DEBUG_LEVEL_FATAL,
  68 }  sipe_debug_level;
  69
  70 /**
  71  * Output debug information without formatting
  72  *
  73  * Shouldn't be used directly. Instead use SIPE_DEBUG_xxx() macros
  74  *
  75  * @param level  debug level
  76  * @param msg    debug message "\n" will be automatically appended.
  77  */
  78 void sipe_backend_debug_literal(sipe_debug_level level,
  79                                 const gchar *msg);
  80
  81 /**
  82  * Output debug information
  83  *
  84  * Shouldn't be used directly. Instead use SIPE_DEBUG_xxx() macros
  85  *
  86  * @param level  debug level
  87  * @param format format string. "\n" will be automatically appended.
  88  */
  89 void sipe_backend_debug(sipe_debug_level level,
  90                         const gchar *format,
  91                         ...) G_GNUC_PRINTF(2, 3);
  92
  93 /* Convenience macros */
  94 #define SIPE_DEBUG_INFO(fmt, ...)        sipe_backend_debug(SIPE_DEBUG_LEVEL_INFO,    fmt, __VA_ARGS__)
  95 #define SIPE_DEBUG_INFO_NOFORMAT(msg)    sipe_backend_debug_literal(SIPE_DEBUG_LEVEL_INFO,    msg)
  96 #define SIPE_DEBUG_WARNING(fmt, ...)     sipe_backend_debug(SIPE_DEBUG_LEVEL_WARNING, fmt, __VA_ARGS__)
  97 #define SIPE_DEBUG_WARNING_NOFORMAT(msg) sipe_backend_debug_literal(SIPE_DEBUG_LEVEL_WARNING, msg)
  98 #define SIPE_DEBUG_ERROR(fmt, ...)       sipe_backend_debug(SIPE_DEBUG_LEVEL_ERROR,   fmt, __VA_ARGS__)
  99 #define SIPE_DEBUG_ERROR_NOFORMAT(msg)   sipe_backend_debug_literal(SIPE_DEBUG_LEVEL_ERROR,   msg)
 100 #define SIPE_DEBUG_FATAL(fmt, ...)       sipe_backend_debug(SIPE_DEBUG_LEVEL_FATAL,   fmt, __VA_ARGS__)
 101 #define SIPE_DEBUG_FATAL_NOFORMAT(msg)   sipe_backend_debug_literal(SIPE_DEBUG_LEVEL_FATAL,   msg)
 102
 103 /**
 104  * Check backend debugging status
 105  *
 106  * @return TRUE if debugging is enabled
 107  */
 108 gboolean sipe_backend_debug_enabled(void);
 109
 110 /** CHAT *********************************************************************/
 111
 112 void sipe_backend_chat_session_destroy(struct sipe_backend_chat_session *session);
 113 void sipe_backend_chat_add(struct sipe_backend_chat_session *backend_session,
 114                            const gchar *uri,
 115                            gboolean is_new);
 116 void sipe_backend_chat_close(struct sipe_backend_chat_session *backend_session);
 117
 118 /**
 119  * Joined a new chat
 120  */
 121 struct sipe_backend_chat_session *sipe_backend_chat_create(struct sipe_core_public *sipe_public,
 122                                                            struct sipe_chat_session *session,
 123                                                            const gchar *title,
 124                                                            const gchar *nick);
 125 gboolean sipe_backend_chat_find(struct sipe_backend_chat_session *backend_session,
 126                                 const gchar *uri);
 127 gboolean sipe_backend_chat_is_operator(struct sipe_backend_chat_session *backend_session,
 128                                        const gchar *uri);
 129 void sipe_backend_chat_message(struct sipe_core_public *sipe_public,
 130                                struct sipe_backend_chat_session *backend_session,
 131                                const gchar *from,
 132                                const gchar *html);
 133 void sipe_backend_chat_operator(struct sipe_backend_chat_session *backend_session,
 134                                 const gchar *uri);
 135
 136 /**
 137  * Rejoin an existing chat window after connection re-establishment
 138  */
 139 void sipe_backend_chat_rejoin(struct sipe_core_public *sipe_public,
 140                               struct sipe_backend_chat_session *backend_session,
 141                               const gchar *nick,
 142                               const gchar *title);
 143
 144 /**
 145  * Core has completed connection re-establishment.
 146  * Should call sipe_core_chat_rejoin() for existing chats.
 147  */
 148 void sipe_backend_chat_rejoin_all(struct sipe_core_public *sipe_public);
 149 void sipe_backend_chat_remove(struct sipe_backend_chat_session *backend_session,
 150                               const gchar *uri);
 151
 152 /**
 153  * Move chat window to the front. Will be called when
 154  * a user tries to join an already joined chat again.
 155  */
 156 void sipe_backend_chat_show(struct sipe_backend_chat_session *backend_session);
 157 void sipe_backend_chat_topic(struct sipe_backend_chat_session *backend_session,
 158                              const gchar *topic);
 159
 160 /** CONNECTION ***************************************************************/
 161
 162 void sipe_backend_connection_completed(struct sipe_core_public *sipe_public);
 163
 164 typedef enum {
 165   SIPE_CONNECTION_ERROR_NETWORK = 0,
 166   SIPE_CONNECTION_ERROR_INVALID_USERNAME,
 167   SIPE_CONNECTION_ERROR_INVALID_SETTINGS,
 168   SIPE_CONNECTION_ERROR_AUTHENTICATION_FAILED,
 169   SIPE_CONNECTION_ERROR_AUTHENTICATION_IMPOSSIBLE,
 170   SIPE_CONNECTION_ERROR_LAST
 171 } sipe_connection_error;
 172 void sipe_backend_connection_error(struct sipe_core_public *sipe_public,
 173                                    sipe_connection_error error,
 174                                    const gchar *msg);
 175
 176 gboolean sipe_backend_connection_is_disconnecting(struct sipe_core_public *sipe_public);
 177 gboolean sipe_backend_connection_is_valid(struct sipe_core_public *sipe_public);
 178
 179 /** DNS QUERY ****************************************************************/
 180
 181 typedef void (*sipe_dns_resolved_cb)(gpointer data, const gchar *hostname, guint port);
 182
 183 struct sipe_dns_query *sipe_backend_dns_query_srv(struct sipe_core_public *sipe_public,
 184                                                   const gchar *protocol,
 185                                                   const gchar *transport,
 186                                                   const gchar *domain,
 187                                                   sipe_dns_resolved_cb callback,
 188                                                   gpointer data);
 189
 190 struct sipe_dns_query *sipe_backend_dns_query_a(struct sipe_core_public *sipe_public,
 191                                                 const gchar *hostname,
 192                                                 guint port,
 193                                                 sipe_dns_resolved_cb callback,
 194                                                 gpointer data);
 195
 196 void sipe_backend_dns_query_cancel(struct sipe_dns_query *query);
 197
 198 /** FILE TRANSFER ************************************************************/
 199
 200 struct sipe_backend_fd;
 201
 202 void sipe_backend_ft_error(struct sipe_file_transfer *ft,
 203                            const gchar *errmsg);
 204 const gchar *sipe_backend_ft_get_error(struct sipe_file_transfer *ft);
 205 void sipe_backend_ft_deallocate(struct sipe_file_transfer *ft);
 206
 207 /**
 208  * Try to read up to @c size bytes from file transfer connection
 209  *
 210  * @param ft   file transfer data.
 211  * @param data buffer to read data into.
 212  * @param size buffer size in bytes.
 213  *
 214  * @return number of bytes read or negative on failure.
 215  *         EAGAIN should return 0 bytes read.
 216  */
 217 gssize sipe_backend_ft_read(struct sipe_file_transfer *ft,
 218                             guchar *data,
 219                             gsize size);
 220
 221 /**
 222  * Try to write up to @c size bytes to file transfer connection
 223  *
 224  * @param ft   file transfer data.
 225  * @param data data to write
 226  * @param size buffer size in bytes.
 227  *
 228  * @return number of bytes read or negative on failure.
 229  *         EAGAIN should return 0 bytes written.
 230  */
 231 gssize sipe_backend_ft_write(struct sipe_file_transfer *ft,
 232                              const guchar *data,
 233                              gsize size);
 234
 235
 236 void sipe_backend_ft_cancel_local(struct sipe_file_transfer *ft);
 237 void sipe_backend_ft_cancel_remote(struct sipe_file_transfer *ft);
 238
 239 void sipe_backend_ft_incoming(struct sipe_core_public *sipe_public,
 240                               struct sipe_file_transfer *ft,
 241                               const gchar *who,
 242                               const gchar *file_name,
 243                               gsize file_size);
 244 /**
 245  * Begins file transfer with remote peer.
 246  *
 247  * You can provide either opened file descriptor to use for read/write operations
 248  * or ip address and port where the backend should connect.
 249  *
 250  * @param ft   file transfer data
 251  * @param fd   opaque file descriptor pointer or NULL if ip and port are used
 252  * @param ip   ip address to connect of NULL when file descriptor is used
 253  * @param port port to connect or 0 when file descriptor is used
 254  */
 255 void sipe_backend_ft_start(struct sipe_file_transfer *ft,
 256                            struct sipe_backend_fd *fd,
 257                            const char* ip, unsigned port);
 258
 259 /**
 260  * Check whether file transfer is incoming or outgoing
 261  *
 262  * @param ft file transfer data
 263  * @return @c TRUE if @c ft is incoming, otherwise @c FALSE
 264  */
 265 gboolean sipe_backend_ft_is_incoming(struct sipe_file_transfer *ft);
 266
 267 /** GROUP CHAT ***************************************************************/
 268
 269 #define SIPE_GROUPCHAT_ROOM_FILEPOST 0x00000001
 270 #define SIPE_GROUPCHAT_ROOM_INVITE   0x00000002
 271 #define SIPE_GROUPCHAT_ROOM_LOGGED   0x00000004
 272 #define SIPE_GROUPCHAT_ROOM_PRIVATE  0x00000008
 273
 274 /**
 275  * Add a room found through room query
 276  *
 277  * @param uri         room URI
 278  * @param name        human readable name for room
 279  * @param description room description
 280  * @param users       number of users in the room
 281  * @param flags       SIPE_GROUPCHAT_ROOM_* flags
 282  */
 283 void sipe_backend_groupchat_room_add(struct sipe_core_public *sipe_public,
 284                                      const gchar *uri,
 285                                      const gchar *name,
 286                                      const gchar *description,
 287                                      guint users,
 288                                      guint32 flags);
 289
 290 /**
 291  * Terminate room query
 292  */
 293 void sipe_backend_groupchat_room_terminate(struct sipe_core_public *sipe_public);
 294
 295 /** IM ***********************************************************************/
 296
 297 void sipe_backend_im_message(struct sipe_core_public *sipe_public,
 298                              const gchar *from,
 299                              const gchar *html);
 300 void sipe_backend_im_topic(struct sipe_core_public *sipe_public,
 301                            const gchar *with,
 302                            const gchar *topic);
 303
 304 /** MARKUP *******************************************************************/
 305
 306 gchar *sipe_backend_markup_css_property(const gchar *style,
 307                                         const gchar *option);
 308 gchar *sipe_backend_markup_strip_html(const gchar *html);
 309
 310 /** MEDIA ********************************************************************/
 311
 312 typedef enum {
 313         SIPE_ICE_NO_ICE,
 314         SIPE_ICE_DRAFT_6,
 315         SIPE_ICE_RFC_5245
 316 } SipeIceVersion;
 317
 318 typedef enum {
 319         SIPE_CANDIDATE_TYPE_ANY,
 320         SIPE_CANDIDATE_TYPE_HOST,
 321         SIPE_CANDIDATE_TYPE_RELAY,
 322         SIPE_CANDIDATE_TYPE_SRFLX,
 323         SIPE_CANDIDATE_TYPE_PRFLX
 324 } SipeCandidateType;
 325
 326 typedef enum {
 327         SIPE_COMPONENT_NONE = 0,
 328         SIPE_COMPONENT_RTP  = 1,
 329         SIPE_COMPONENT_RTCP = 2
 330 } SipeComponentType;
 331
 332 typedef enum {
 333         SIPE_MEDIA_AUDIO,
 334         SIPE_MEDIA_VIDEO
 335 } SipeMediaType;
 336
 337 typedef enum {
 338         SIPE_NETWORK_PROTOCOL_TCP_ACTIVE,
 339         SIPE_NETWORK_PROTOCOL_TCP_PASSIVE,
 340         SIPE_NETWORK_PROTOCOL_UDP
 341 } SipeNetworkProtocol;
 342
 343 struct sipe_media_call;
 344 struct sipe_backend_media;
 345 struct sipe_backend_codec;
 346 struct sipe_backend_candidate;
 347 struct sipe_backend_stream;
 348 struct sipe_backend_media_relays;
 349
 350 struct sipe_media_call {
 351         struct sipe_backend_media *backend_private;
 352
 353         void (*stream_initialized_cb)(struct sipe_media_call *,
 354                                       struct sipe_backend_stream *);
 355         void (*media_end_cb)(struct sipe_media_call *);
 356         void (*call_accept_cb)(struct sipe_media_call *, gboolean local);
 357         void (*call_reject_cb)(struct sipe_media_call *, gboolean local);
 358         void (*call_hold_cb)  (struct sipe_media_call *, gboolean local,
 359                                gboolean state);
 360         void (*call_hangup_cb)(struct sipe_media_call *, gboolean local);
 361         void (*error_cb)(struct sipe_media_call *, gchar *message);
 362 };
 363
 364 struct sipe_media_relay {
 365         gchar                 *hostname;
 366         guint                  udp_port;
 367         guint                  tcp_port;
 368         struct sipe_dns_query *dns_query;
 369 };
 370
 371 /* Media handling */
 372 struct sipe_backend_media *sipe_backend_media_new(struct sipe_core_public *sipe_public,
 373                                                   struct sipe_media_call *call,
 374                                                   const gchar *participant,
 375                                                   gboolean initiator);
 376 void sipe_backend_media_free(struct sipe_backend_media *media);
 377
 378 void sipe_backend_media_set_cname(struct sipe_backend_media *media, gchar *cname);
 379
 380 struct sipe_backend_media_relays * sipe_backend_media_relays_convert(GSList *media_relays,
 381                                                                      gchar *username,
 382                                                                      gchar *password);
 383 void sipe_backend_media_relays_free(struct sipe_backend_media_relays *media_relays);
 384
 385 struct sipe_backend_stream *sipe_backend_media_add_stream(struct sipe_backend_media *media,
 386                                                           const gchar *id,
 387                                                           const gchar *participant,
 388                                                           SipeMediaType type,
 389                                                           SipeIceVersion ice_version,
 390                                                           gboolean initiator,
 391                                                           struct sipe_backend_media_relays *media_relays);
 392 void sipe_backend_media_remove_stream(struct sipe_backend_media *media,
 393                                       struct sipe_backend_stream *stream);
 394 GSList *sipe_backend_media_get_streams(struct sipe_backend_media *media);
 395 struct sipe_backend_stream *sipe_backend_media_get_stream_by_id(struct sipe_backend_media *media,
 396                                                                 const gchar *id);
 397 void sipe_backend_media_add_remote_candidates(struct sipe_backend_media *media,
 398                                               struct sipe_backend_stream *stream,
 399                                               GList *candidates);
 400 gboolean sipe_backend_media_is_initiator(struct sipe_backend_media *media,
 401                                          struct sipe_backend_stream *stream);
 402 gboolean sipe_backend_media_accepted(struct sipe_backend_media *media);
 403 gboolean sipe_backend_stream_initialized(struct sipe_backend_media *media,
 404                                          struct sipe_backend_stream *stream);
 405 GList *sipe_backend_media_get_active_local_candidates(struct sipe_backend_media *media,
 406                                                       struct sipe_backend_stream *stream);
 407 GList *sipe_backend_media_get_active_remote_candidates(struct sipe_backend_media *media,
 408                                                        struct sipe_backend_stream *stream);
 409
 410 /* Stream handling */
 411 const gchar *sipe_backend_stream_get_id(struct sipe_backend_stream *stream);
 412 SipeMediaType sipe_backend_stream_get_type(struct sipe_backend_stream *stream);
 413 void sipe_backend_stream_hold(struct sipe_backend_media *media,
 414                               struct sipe_backend_stream *stream,
 415                               gboolean local);
 416 void sipe_backend_stream_unhold(struct sipe_backend_media *media,
 417                                 struct sipe_backend_stream *stream,
 418                                 gboolean local);
 419 gboolean sipe_backend_stream_is_held(struct sipe_backend_stream *stream);
 420
 421 /* Codec handling */
 422 struct sipe_backend_codec *sipe_backend_codec_new(int id,
 423                                                   const char *name,
 424                                                   SipeMediaType type, guint clock_rate);
 425 void sipe_backend_codec_free(struct sipe_backend_codec *codec);
 426 int sipe_backend_codec_get_id(struct sipe_backend_codec *codec);
 427 /**
 428  * @return codec name. Will be g_free'd() by the core.
 429  */
 430 gchar *sipe_backend_codec_get_name(struct sipe_backend_codec *codec);
 431 guint sipe_backend_codec_get_clock_rate(struct sipe_backend_codec *codec);
 432 void sipe_backend_codec_add_optional_parameter(struct sipe_backend_codec *codec,
 433                                                const gchar *name,
 434                                                const gchar *value);
 435 GList *sipe_backend_codec_get_optional_parameters(struct sipe_backend_codec *codec);
 436 gboolean sipe_backend_set_remote_codecs(struct sipe_backend_media *media,
 437                                         struct sipe_backend_stream *stream,
 438                                         GList *codecs);
 439 GList* sipe_backend_get_local_codecs(struct sipe_backend_media *media,
 440                                      struct sipe_backend_stream *stream);
 441
 442 /* Candidate handling */
 443 struct sipe_backend_candidate * sipe_backend_candidate_new(const gchar *foundation,
 444                                                            SipeComponentType component,
 445                                                            SipeCandidateType type,
 446                                                            SipeNetworkProtocol proto,
 447                                                            const gchar *ip, guint port,
 448                                                            const gchar *username,
 449                                                            const gchar *password);
 450 void sipe_backend_candidate_free(struct sipe_backend_candidate *candidate);
 451 /**
 452  * @return user name. Will be g_free'd() by the core.
 453  */
 454 gchar *sipe_backend_candidate_get_username(struct sipe_backend_candidate *candidate);
 455 /**
 456  * @return password. Will be g_free'd() by the core.
 457  */
 458 gchar *sipe_backend_candidate_get_password(struct sipe_backend_candidate *candidate);
 459 /**
 460  * @return foundation. Will be g_free'd() by the core.
 461  */
 462 gchar *sipe_backend_candidate_get_foundation(struct sipe_backend_candidate *candidate);
 463 /**
 464  * @return IP address string. Will be g_free'd() by the core.
 465  */
 466 gchar *sipe_backend_candidate_get_ip(struct sipe_backend_candidate *candidate);
 467 guint sipe_backend_candidate_get_port(struct sipe_backend_candidate *candidate);
 468 /**
 469  * @return IP address string. Will be g_free'd() by the core.
 470  */
 471 gchar *sipe_backend_candidate_get_base_ip(struct sipe_backend_candidate *candidate);
 472 guint sipe_backend_candidate_get_base_port(struct sipe_backend_candidate *candidate);
 473 guint32 sipe_backend_candidate_get_priority(struct sipe_backend_candidate *candidate);
 474 void sipe_backend_candidate_set_priority(struct sipe_backend_candidate *candidate, guint32 priority);
 475 SipeComponentType sipe_backend_candidate_get_component_type(struct sipe_backend_candidate *candidate);
 476 SipeCandidateType sipe_backend_candidate_get_type(struct sipe_backend_candidate *candidate);
 477 SipeNetworkProtocol sipe_backend_candidate_get_protocol(struct sipe_backend_candidate *candidate);
 478 GList* sipe_backend_get_local_candidates(struct sipe_backend_media *media,
 479                                          struct sipe_backend_stream *stream);
 480 void sipe_backend_media_accept(struct sipe_backend_media *media, gboolean local);
 481 void sipe_backend_media_hangup(struct sipe_backend_media *media, gboolean local);
 482 void sipe_backend_media_reject(struct sipe_backend_media *media, gboolean local);
 483
 484 /** NETWORK ******************************************************************/
 485
 486 const gchar *sipe_backend_network_ip_address(struct sipe_core_public *sipe_public);
 487
 488 struct sipe_backend_listendata;
 489
 490 typedef void (*sipe_listen_start_cb)(unsigned short port, gpointer data);
 491 typedef void (*sipe_client_connected_cb)(struct sipe_backend_fd *fd, gpointer data);
 492
 493 struct sipe_backend_listendata *
 494 sipe_backend_network_listen_range(unsigned short port_min,
 495                                   unsigned short port_max,
 496                                   sipe_listen_start_cb listen_cb,
 497                                   sipe_client_connected_cb connect_cb,
 498                                   gpointer data);
 499 void sipe_backend_network_listen_cancel(struct sipe_backend_listendata *ldata);
 500
 501 gboolean sipe_backend_fd_is_valid(struct sipe_backend_fd *fd);
 502 void sipe_backend_fd_free(struct sipe_backend_fd *fd);
 503
 504 /** NOTIFICATIONS *************************************************************/
 505
 506 void sipe_backend_notify_message_error(struct sipe_core_public *sipe_public,
 507                                        struct sipe_backend_chat_session *backend_session,
 508                                        const gchar *who,
 509                                        const gchar *message);
 510 void sipe_backend_notify_message_info(struct sipe_core_public *sipe_public,
 511                                       struct sipe_backend_chat_session *backend_session,
 512                                       const gchar *who,
 513                                       const gchar *message);
 514
 515 /**
 516  * @param msg  error message. Maybe @NULL
 517  */
 518 void sipe_backend_notify_error(struct sipe_core_public *sipe_public,
 519                                const gchar *title,
 520                                const gchar *msg);
 521
 522 /** SCHEDULE *****************************************************************/
 523
 524 gpointer sipe_backend_schedule_seconds(struct sipe_core_public *sipe_public,
 525                                        guint timeout,
 526                                        gpointer data);
 527 gpointer sipe_backend_schedule_mseconds(struct sipe_core_public *sipe_public,
 528                                         guint timeout,
 529                                         gpointer data);
 530 void sipe_backend_schedule_cancel(struct sipe_core_public *sipe_public,
 531                                   gpointer data);
 532
 533 /** SEARCH *******************************************************************/
 534
 535 struct sipe_backend_search_results;
 536 struct sipe_backend_search_token;
 537
 538 void sipe_backend_search_failed(struct sipe_core_public *sipe_public,
 539                                 struct sipe_backend_search_token *token,
 540                                 const gchar *msg);
 541 struct sipe_backend_search_results *sipe_backend_search_results_start(struct sipe_core_public *sipe_public,
 542                                                                       struct sipe_backend_search_token *token);
 543 void sipe_backend_search_results_add(struct sipe_core_public *sipe_public,
 544                                      struct sipe_backend_search_results *results,
 545                                      const gchar *uri,
 546                                      const gchar *name,
 547                                      const gchar *company,
 548                                      const gchar *country,
 549                                      const gchar *email);
 550 void sipe_backend_search_results_finalize(struct sipe_core_public *sipe_public,
 551                                           struct sipe_backend_search_results *results,
 552                                           const gchar *description,
 553                                           gboolean more);
 554
 555 /** SETTINGS *****************************************************************/
 556
 557 typedef enum {
 558   SIPE_SETTING_EMAIL_URL = 0,
 559   SIPE_SETTING_EMAIL_LOGIN,
 560   SIPE_SETTING_EMAIL_PASSWORD,
 561   SIPE_SETTING_GROUPCHAT_USER,
 562   SIPE_SETTING_USER_AGENT,
 563   SIPE_SETTING_LAST
 564 } sipe_setting;
 565 const gchar *sipe_backend_setting(struct sipe_core_public *sipe_public,
 566                                   sipe_setting type);
 567
 568 /** STATUS *******************************************************************/
 569
 570 guint sipe_backend_status(struct sipe_core_public *sipe_public);
 571 gboolean sipe_backend_status_changed(struct sipe_core_public *sipe_public,
 572                                      guint activity,
 573                                      const gchar *message);
 574 void sipe_backend_status_and_note(struct sipe_core_public *sipe_public,
 575                                   guint activity,
 576                                   const gchar *message);
 577
 578 /** TRANSPORT ****************************************************************/
 579
 580 typedef void transport_connected_cb(struct sipe_transport_connection *conn);
 581 typedef void transport_input_cb(struct sipe_transport_connection *conn);
 582 typedef void transport_error_cb(struct sipe_transport_connection *conn,
 583                                 const gchar *msg);
 584
 585 typedef struct {
 586         guint type;
 587         const gchar *server_name;
 588         guint server_port;
 589         gpointer user_data;
 590         transport_connected_cb *connected;
 591         transport_input_cb *input;
 592         transport_error_cb *error;
 593 } sipe_connect_setup;
 594 struct sipe_transport_connection *sipe_backend_transport_connect(struct sipe_core_public *sipe_public,
 595                                                                  const sipe_connect_setup *setup);
 596 void sipe_backend_transport_disconnect(struct sipe_transport_connection *conn);
 597 void sipe_backend_transport_message(struct sipe_transport_connection *conn,
 598                                     const gchar *buffer);
 599 void sipe_backend_transport_flush(struct sipe_transport_connection *conn);
 600
 601 /** USER *********************************************************************/
 602
 603 void sipe_backend_user_feedback_typing(struct sipe_core_public *sipe_public,
 604                                        const gchar *from);
 605 void sipe_backend_user_feedback_typing_stop(struct sipe_core_public *sipe_public,
 606                                             const gchar *from);
 607
 608 /**
 609  * Present a query that is to be accepted or declined by the user
 610  *
 611  * @param sipe_public   The handle representing the protocol instance
 612  * @param message       Text of the query to be shown to user
 613  * @param accept_label  Label to be displayed on UI control that accepts query
 614  * @param decline_label Label to be displayed on UI control that declines query
 615  * @param key           Opaque handle uniquely identifying the query. Backend
 616  *                      should store it for the case SIPE core requests the
 617  *                      query to be closed prematurely.
 618  */
 619 void sipe_backend_user_ask(struct sipe_core_public *sipe_public,
 620                            const gchar *message,
 621                            const gchar *accept_label,
 622                            const gchar *decline_label,
 623                            gpointer key);
 624
 625 /**
 626  * Closes the pending user query
 627  *
 628  * @param key Opaque handle uniquely identifying the query.
 629  */
 630 void sipe_backend_user_close_ask(gpointer key);
 631
 632 /** BUDDIES ******************************************************************/
 633
 634 /*
 635  * sipe_backend_buddy_get/set_string(): properties a buddy can have
 636  * sipe_backend_buddy_info_add():       mapped, e.g. to a string label
 637  */
 638 typedef enum
 639 {
 640         SIPE_BUDDY_INFO_DISPLAY_NAME = 0,
 641         SIPE_BUDDY_INFO_JOB_TITLE,
 642         SIPE_BUDDY_INFO_CITY,
 643         SIPE_BUDDY_INFO_STATE,
 644         SIPE_BUDDY_INFO_OFFICE,
 645         SIPE_BUDDY_INFO_DEPARTMENT,
 646         SIPE_BUDDY_INFO_COUNTRY,
 647         SIPE_BUDDY_INFO_WORK_PHONE,
 648         SIPE_BUDDY_INFO_WORK_PHONE_DISPLAY,
 649         SIPE_BUDDY_INFO_COMPANY,
 650         SIPE_BUDDY_INFO_EMAIL,
 651         SIPE_BUDDY_INFO_SITE,
 652         SIPE_BUDDY_INFO_ZIPCODE,
 653         SIPE_BUDDY_INFO_STREET,
 654         SIPE_BUDDY_INFO_MOBILE_PHONE,
 655         SIPE_BUDDY_INFO_MOBILE_PHONE_DISPLAY,
 656         SIPE_BUDDY_INFO_HOME_PHONE,
 657         SIPE_BUDDY_INFO_HOME_PHONE_DISPLAY,
 658         SIPE_BUDDY_INFO_OTHER_PHONE,
 659         SIPE_BUDDY_INFO_OTHER_PHONE_DISPLAY,
 660         SIPE_BUDDY_INFO_CUSTOM1_PHONE,
 661         SIPE_BUDDY_INFO_CUSTOM1_PHONE_DISPLAY,
 662         SIPE_BUDDY_INFO_ALIAS,  /* only for sipe_backend_buddy_info_add() */
 663         SIPE_BUDDY_INFO_DEVICE, /* only for sipe_backend_buddy_info_add() */
 664 } sipe_buddy_info_fields;
 665
 666 /* Opaque token */
 667 typedef void* sipe_backend_buddy;
 668
 669 /**
 670  * Find a buddy in the given group of the buddy list, or anywhere on the
 671  * list if @group_name is empty
 672  *
 673  * @param sipe_public The handle representing the protocol instance making the call
 674  * @param buddy_name The name of the buddy
 675  * @param group_name The name of the group to look in, or NULL for any group
 676  * @return opaque handle to the buddy, or NULL if no buddy found
 677  */
 678 sipe_backend_buddy sipe_backend_buddy_find(struct sipe_core_public *sipe_public,
 679                                            const gchar *buddy_name,
 680                                            const gchar *group_name);
 681
 682 /*
 683  * Find all named buddies in the given group of the buddy list, or anywhere on the
 684  * list if @group_name is empty; or all buddies if @name is empty
 685  *
 686  * @param sipe_public The handle representing the protocol instance making the call
 687  * @param name The name of the buddy
 688  * @param group_name The name of the group to look in, or NULL for any group
 689  * @return GSList of opaque handles to the buddies
 690  */
 691 GSList* sipe_backend_buddy_find_all(struct sipe_core_public *sipe_public,
 692                                     const gchar *buddy_name,
 693                                     const gchar *group_name);
 694
 695 /**
 696  * Gets the name of a contact.
 697  *
 698  * @param sipe_public The handle representing the protocol instance making the call
 699  * @param who The opaque handle to the contact as found by find_buddy
 700  * @return The name. Must be freed.
 701  */
 702 gchar* sipe_backend_buddy_get_name(struct sipe_core_public *sipe_public,
 703                                    const sipe_backend_buddy who);
 704
 705 /**
 706  * Gets the alias for a contact.
 707  *
 708  * @param sipe_public The handle representing the protocol instance making the call
 709  * @param who The opaque handle to the contact as found by find_buddy
 710  * @return The alias. Must be gfree'd.
 711  */
 712 gchar* sipe_backend_buddy_get_alias(struct sipe_core_public *sipe_public,
 713                                     const sipe_backend_buddy who);
 714
 715 /**
 716  * Gets the server alias for a contact.
 717  *
 718  * @param sipe_public The handle representing the protocol instance making the call
 719  * @param who The opaque handle to the contact as found by find_buddy
 720  * @return The alias. Must be freed.
 721  */
 722 gchar* sipe_backend_buddy_get_server_alias(struct sipe_core_public *sipe_public,
 723                                            const sipe_backend_buddy who);
 724
 725 /**
 726  * Gets the local alias for a contact
 727  *
 728  * @param sipe_public The handle representing the protocol instance making the call
 729  * @param uri         the budyy name
 730  *
 731  * @return the alias. Must be @g_free()'d.
 732  */
 733 gchar *sipe_backend_buddy_get_local_alias(struct sipe_core_public *sipe_public,
 734                                           const sipe_backend_buddy who);
 735
 736 /**
 737  * Gets the name of the group a contact belongs to.
 738  *
 739  * @param sipe_public The handle representing the protocol instance making the call
 740  * @param who The opaque handle to the contact as found by find_buddy
 741  * @return The name. Must be freed.
 742  */
 743 gchar* sipe_backend_buddy_get_group_name(struct sipe_core_public *sipe_public,
 744                                          const sipe_backend_buddy who);
 745
 746 /**
 747  * Called to retrieve a buddy-specific setting.
 748  *
 749  * @param sipe_public The handle representing the protocol instance making the call
 750  * @param buddy The handle representing the buddy
 751  * @param key The name of the setting
 752  * @return The value of the setting. Must be freed.
 753  */
 754 gchar* sipe_backend_buddy_get_string(struct sipe_core_public *sipe_public,
 755                                      sipe_backend_buddy buddy,
 756                                      const sipe_buddy_info_fields key);
 757
 758 /**
 759  * Called to set a buddy-specific setting.
 760  *
 761  * @param sipe_public The handle representing the protocol instance making the call
 762  * @param buddy The handle representing the buddy
 763  * @param key The name of the setting
 764  * @param val The value to set
 765  */
 766 void sipe_backend_buddy_set_string(struct sipe_core_public *sipe_public,
 767                                    sipe_backend_buddy buddy,
 768                                    const sipe_buddy_info_fields key,
 769                                    const gchar *val);
 770
 771 /**
 772  * Called after one ore more buddy-specific settings have been updated.
 773  *
 774  * Can be used by the backend to trigger an UI update event
 775  *
 776  * @param sipe_public The handle representing the protocol instance making the call
 777  * @param uri         SIP URI of the contact
 778  */
 779 void sipe_backend_buddy_refresh_properties(struct sipe_core_public *sipe_public,
 780                                            const gchar *uri);
 781
 782 /**
 783  * Get the status token for a contact
 784  *
 785  * @param sipe_public The handle representing the protocol instance making the call
 786  * @param uri         SIP URI of the contact
 787  *
 788  * @return activity
 789  */
 790 guint sipe_backend_buddy_get_status(struct sipe_core_public *sipe_public,
 791                                     const gchar *uri);
 792
 793 /**
 794  * Sets the alias for a contact.
 795  *
 796  * @param sipe_public The handle representing the protocol instance making the call
 797  * @param who The opaque handle to the contact as found by find_buddy
 798  * @param alias The location where the alias will be put
 799  * case. FALSE if the buddy was not found. The value of alias will not be changed.
 800  */
 801 void sipe_backend_buddy_set_alias(struct sipe_core_public *sipe_public,
 802                                   const sipe_backend_buddy who,
 803                                   const gchar *alias);
 804
 805 /**
 806  * Sets the server alias for a contact.
 807  *
 808  * @param sipe_public The handle representing the protocol instance making the call
 809  * @param who The opaque handle to the contact as found by find_buddy
 810  * @param alias The server alias of the contact
 811  */
 812 void sipe_backend_buddy_set_server_alias(struct sipe_core_public *sipe_public,
 813                                          const sipe_backend_buddy who,
 814                                          const gchar *alias);
 815
 816 /**
 817  * Start processing buddy list
 818  *
 819  * Will be called every time we receive a buddy list in roaming contacts
 820  *
 821  * @param sipe_public The handle representing the protocol instance making the call
 822  */
 823 void sipe_backend_buddy_list_processing_start(struct sipe_core_public *sipe_public);
 824
 825 /**
 826  * Finished processing buddy list
 827  *
 828  * Will be called every time we receive a buddy list in roaming contacts
 829  *
 830  * @param sipe_public The handle representing the protocol instance making the call
 831  */
 832 void sipe_backend_buddy_list_processing_finish(struct sipe_core_public *sipe_public);
 833
 834 /**
 835  * Add a contact to the buddy list
 836  *
 837  * @param sipe_public The handle representing the protocol instance making the call
 838  * @param name The name of the contact
 839  * @param alias The alias of the contact
 840  * @param groupname The name of the group to add this contact to
 841  * @return A handle to the newly created buddy
 842  */
 843 sipe_backend_buddy sipe_backend_buddy_add(struct sipe_core_public *sipe_public,
 844                                           const gchar *name,
 845                                           const gchar *alias,
 846                                           const gchar *groupname);
 847
 848 /**
 849  * Remove a contact from the buddy list
 850  *
 851  * @param sipe_public The handle representing the protocol instance making the call
 852  * @param who The opaque handle to the contact as found by find_buddy
 853  */
 854 void sipe_backend_buddy_remove(struct sipe_core_public *sipe_public,
 855                                const sipe_backend_buddy who);
 856
 857 /**
 858  * Notifies the user that a remote user has wants to add the local user to his
 859  * or her buddy list and requires authorization to do so.
 860  *
 861  * @param sipe_public The handle representing the protocol instance making the call
 862  * @param who The name of the user that added this account
 863  * @param alias The optional alias of the remote user
 864  * @param on_list True if the user is already in our list
 865  * @param auth_cb The callback called when the local user accepts
 866  * @param deny_cb The callback called when the local user rejects
 867  * @param data Data to be passed back to the above callbacks
 868  */
 869 typedef void (*sipe_backend_buddy_request_authorization_cb)(void *);
 870
 871 void sipe_backend_buddy_request_add(struct sipe_core_public *sipe_public,
 872                                     const gchar *who,
 873                                     const gchar *alias);
 874
 875 void sipe_backend_buddy_request_authorization(struct sipe_core_public *sipe_public,
 876                                               const gchar *who,
 877                                               const gchar *alias,
 878                                               gboolean on_list,
 879                                               sipe_backend_buddy_request_authorization_cb auth_cb,
 880                                               sipe_backend_buddy_request_authorization_cb deny_cb,
 881                                               gpointer data);
 882
 883 gboolean sipe_backend_buddy_is_blocked(struct sipe_core_public *sipe_public,
 884                                        const gchar *who);
 885
 886 void sipe_backend_buddy_set_blocked_status(struct sipe_core_public *sipe_public,
 887                                            const gchar *who,
 888                                            gboolean blocked);
 889
 890 void sipe_backend_buddy_set_status(struct sipe_core_public *sipe_public,
 891                                    const gchar *who,
 892                                    guint activity);
 893
 894 /**
 895  * Checks whether backend has a capability to use buddy photos. If this function
 896  * returns @c FALSE, SIPE core will not attempt to download the photos from
 897  * server to save bandwidth.
 898  *
 899  * @return @c TRUE if backend is photo capable, otherwise @FALSE
 900  */
 901 gboolean sipe_backend_uses_photo(void);
 902
 903 /**
 904  * Gives backend a photo image associated with a SIP URI. Backend has ownership
 905  * of the data and must free it when not needed.
 906  *
 907  * @param sipe_public The handle representing the protocol instance making the call
 908  * @param who The name of the user whose photo is being set
 909  * @param image_data The photo image data, must be g_free()'d by backend
 910  * @param image_len Size of the image in Bytes
 911  * @param photo_hash A data checksum provided by the server
 912  */
 913 void sipe_backend_buddy_set_photo(struct sipe_core_public *sipe_public,
 914                                   const gchar *who,
 915                                   gpointer image_data,
 916                                   gsize image_len,
 917                                   const gchar *photo_hash);
 918
 919 /**
 920  * Retrieves a photo hash stored together with image data by
 921  * @c sipe_backend_buddy_set_photo. Value is used by the core to detect photo
 922  * file changes on server.
 923  *
 924  * @param sipe_public The handle representing the protocol instance making the call
 925  * @param who The name of the user whose photo hash to retrieve
 926  * @return a photo hash (may be NULL)
 927  */
 928 const gchar *sipe_backend_buddy_get_photo_hash(struct sipe_core_public *sipe_public,
 929                                                const gchar *who);
 930
 931 /**
 932  * Called when a new internal group is about to be added. If this returns FALSE,
 933  * the group will not be added.
 934  *
 935  * @param sipe_public The handle representing the protocol instance making the call
 936  * @param group_name  The group being added
 937  * @return TRUE if everything is ok, FALSE if the group should not be added
 938  */
 939 gboolean sipe_backend_buddy_group_add(struct sipe_core_public *sipe_public,
 940                                       const gchar *group_name);
 941
 942 /**
 943  * Called when a new internal group has been renamed
 944  *
 945  * @param sipe_public The handle representing the protocol instance making the call
 946  * @param old_name old name of the group
 947  * @param new_name new name of the group
 948  * @return TRUE if the group was found and renamed
 949  */
 950 gboolean sipe_backend_buddy_group_rename(struct sipe_core_public *sipe_public,
 951                                          const gchar *old_name,
 952                                          const gchar *new_name);
 953
 954 /**
 955  * Called when a new internal group should be deleted
 956  *
 957  * NOTE: this will only be called on empty groups.
 958  *
 959  * @param sipe_public The handle representing the protocol instance making the call
 960  * @param group_name  The group that should be removed
 961  */
 962 void sipe_backend_buddy_group_remove(struct sipe_core_public *sipe_public,
 963                                      const gchar *group_name);
 964
 965 /**
 966  * Present requested buddy information to the user
 967  */
 968 struct sipe_backend_buddy_info;
 969 struct sipe_backend_buddy_info *sipe_backend_buddy_info_start(struct sipe_core_public *sipe_public);
 970 void sipe_backend_buddy_info_add(struct sipe_core_public *sipe_public,
 971                                  struct sipe_backend_buddy_info *info,
 972                                  sipe_buddy_info_fields key,
 973                                  const gchar *value);
 974 void sipe_backend_buddy_info_break(struct sipe_core_public *sipe_public,
 975                                    struct sipe_backend_buddy_info *info);
 976 void sipe_backend_buddy_info_finalize(struct sipe_core_public *sipe_public,
 977                                       struct sipe_backend_buddy_info *info,
 978                                       const gchar *uri);
 979
 980 struct sipe_backend_buddy_tooltip;
 981 void sipe_backend_buddy_tooltip_add(struct sipe_core_public *sipe_public,
 982                                     struct sipe_backend_buddy_tooltip *tooltip,
 983                                     const gchar *description,
 984                                     const gchar *value);
 985
 986 /**
 987  * Buddy menu creation
 988  */
 989 enum sipe_buddy_menu_type {
 990         SIPE_BUDDY_MENU_MAKE_CHAT_LEADER = 0,
 991         SIPE_BUDDY_MENU_REMOVE_FROM_CHAT,
 992         SIPE_BUDDY_MENU_INVITE_TO_CHAT,
 993         SIPE_BUDDY_MENU_NEW_CHAT,
 994         SIPE_BUDDY_MENU_MAKE_CALL,
 995         SIPE_BUDDY_MENU_SEND_EMAIL,
 996         SIPE_BUDDY_MENU_ACCESS_LEVEL_HELP,
 997         SIPE_BUDDY_MENU_CHANGE_ACCESS_LEVEL,
 998         SIPE_BUDDY_MENU_ADD_NEW_DOMAIN,
 999         SIPE_BUDDY_MENU_TYPES
1000 };
1001
1002 struct sipe_backend_buddy_menu *sipe_backend_buddy_menu_start(struct sipe_core_public *sipe_public);
1003 struct sipe_backend_buddy_menu *sipe_backend_buddy_menu_add(struct sipe_core_public *sipe_public,
1004                                                             struct sipe_backend_buddy_menu *menu,
1005                                                             const gchar *label,
1006                                                             enum sipe_buddy_menu_type type,
1007                                                             gpointer parameter);
1008 struct sipe_backend_buddy_menu *sipe_backend_buddy_menu_separator(struct sipe_core_public *sipe_public,
1009                                                                   struct sipe_backend_buddy_menu *menu,
1010                                                                   const gchar *label);
1011 struct sipe_backend_buddy_menu *sipe_backend_buddy_sub_menu_add(struct sipe_core_public *sipe_public,
1012                                                                 struct sipe_backend_buddy_menu *menu,
1013                                                                 const gchar *label,
1014                                                                 struct sipe_backend_buddy_menu *sub);
1015
1016 #ifdef __cplusplus
1017 }
1018 #endif
1019
1020 /*
1021   Local Variables:
1022   mode: c
1023   c-file-style: "bsd"
1024   indent-tabs-mode: t
1025   tab-width: 8
1026   End:
1027 */