src/api/sipe-backend.h

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