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 (*candidates_prepared_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_candidates_prepared(struct sipe_backend_media *media);
 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 SipeMediaType sipe_backend_stream_get_type(struct sipe_backend_stream *stream);
 412 void sipe_backend_stream_hold(struct sipe_backend_media *media,
 413                               struct sipe_backend_stream *stream,
 414                               gboolean local);
 415 void sipe_backend_stream_unhold(struct sipe_backend_media *media,
 416                                 struct sipe_backend_stream *stream,
 417                                 gboolean local);
 418 gboolean sipe_backend_stream_is_held(struct sipe_backend_stream *stream);
 419
 420 /* Codec handling */
 421 struct sipe_backend_codec *sipe_backend_codec_new(int id,
 422                                                   const char *name,
 423                                                   SipeMediaType type, guint clock_rate);
 424 void sipe_backend_codec_free(struct sipe_backend_codec *codec);
 425 int sipe_backend_codec_get_id(struct sipe_backend_codec *codec);
 426 /**
 427  * @return codec name. Will be g_free'd() by the core.
 428  */
 429 gchar *sipe_backend_codec_get_name(struct sipe_backend_codec *codec);
 430 guint sipe_backend_codec_get_clock_rate(struct sipe_backend_codec *codec);
 431 void sipe_backend_codec_add_optional_parameter(struct sipe_backend_codec *codec,
 432                                                const gchar *name,
 433                                                const gchar *value);
 434 GList *sipe_backend_codec_get_optional_parameters(struct sipe_backend_codec *codec);
 435 gboolean sipe_backend_set_remote_codecs(struct sipe_backend_media *media,
 436                                         struct sipe_backend_stream *stream,
 437                                         GList *codecs);
 438 GList* sipe_backend_get_local_codecs(struct sipe_backend_media *media,
 439                                      struct sipe_backend_stream *stream);
 440
 441 /* Candidate handling */
 442 struct sipe_backend_candidate * sipe_backend_candidate_new(const gchar *foundation,
 443                                                            SipeComponentType component,
 444                                                            SipeCandidateType type,
 445                                                            SipeNetworkProtocol proto,
 446                                                            const gchar *ip, guint port,
 447                                                            const gchar *username,
 448                                                            const gchar *password);
 449 void sipe_backend_candidate_free(struct sipe_backend_candidate *candidate);
 450 /**
 451  * @return user name. Will be g_free'd() by the core.
 452  */
 453 gchar *sipe_backend_candidate_get_username(struct sipe_backend_candidate *candidate);
 454 /**
 455  * @return password. Will be g_free'd() by the core.
 456  */
 457 gchar *sipe_backend_candidate_get_password(struct sipe_backend_candidate *candidate);
 458 /**
 459  * @return foundation. Will be g_free'd() by the core.
 460  */
 461 gchar *sipe_backend_candidate_get_foundation(struct sipe_backend_candidate *candidate);
 462 /**
 463  * @return IP address string. Will be g_free'd() by the core.
 464  */
 465 gchar *sipe_backend_candidate_get_ip(struct sipe_backend_candidate *candidate);
 466 guint sipe_backend_candidate_get_port(struct sipe_backend_candidate *candidate);
 467 /**
 468  * @return IP address string. Will be g_free'd() by the core.
 469  */
 470 gchar *sipe_backend_candidate_get_base_ip(struct sipe_backend_candidate *candidate);
 471 guint sipe_backend_candidate_get_base_port(struct sipe_backend_candidate *candidate);
 472 guint32 sipe_backend_candidate_get_priority(struct sipe_backend_candidate *candidate);
 473 void sipe_backend_candidate_set_priority(struct sipe_backend_candidate *candidate, guint32 priority);
 474 SipeComponentType sipe_backend_candidate_get_component_type(struct sipe_backend_candidate *candidate);
 475 SipeCandidateType sipe_backend_candidate_get_type(struct sipe_backend_candidate *candidate);
 476 SipeNetworkProtocol sipe_backend_candidate_get_protocol(struct sipe_backend_candidate *candidate);
 477 GList* sipe_backend_get_local_candidates(struct sipe_backend_media *media,
 478                                          struct sipe_backend_stream *stream);
 479 void sipe_backend_media_accept(struct sipe_backend_media *media, gboolean local);
 480 void sipe_backend_media_hangup(struct sipe_backend_media *media, gboolean local);
 481 void sipe_backend_media_reject(struct sipe_backend_media *media, gboolean local);
 482
 483 /** NETWORK ******************************************************************/
 484
 485 const gchar *sipe_backend_network_ip_address(struct sipe_core_public *sipe_public);
 486
 487 struct sipe_backend_listendata;
 488
 489 typedef void (*sipe_listen_start_cb)(unsigned short port, gpointer data);
 490 typedef void (*sipe_client_connected_cb)(struct sipe_backend_fd *fd, gpointer data);
 491
 492 struct sipe_backend_listendata *
 493 sipe_backend_network_listen_range(unsigned short port_min,
 494                                   unsigned short port_max,
 495                                   sipe_listen_start_cb listen_cb,
 496                                   sipe_client_connected_cb connect_cb,
 497                                   gpointer data);
 498 void sipe_backend_network_listen_cancel(struct sipe_backend_listendata *ldata);
 499
 500 gboolean sipe_backend_fd_is_valid(struct sipe_backend_fd *fd);
 501 void sipe_backend_fd_free(struct sipe_backend_fd *fd);
 502
 503 /** NOTIFICATIONS *************************************************************/
 504
 505 void sipe_backend_notify_message_error(struct sipe_core_public *sipe_public,
 506                                        struct sipe_backend_chat_session *backend_session,
 507                                        const gchar *who,
 508                                        const gchar *message);
 509 void sipe_backend_notify_message_info(struct sipe_core_public *sipe_public,
 510                                       struct sipe_backend_chat_session *backend_session,
 511                                       const gchar *who,
 512                                       const gchar *message);
 513
 514 /**
 515  * @param msg  error message. Maybe @NULL
 516  */
 517 void sipe_backend_notify_error(struct sipe_core_public *sipe_public,
 518                                const gchar *title,
 519                                const gchar *msg);
 520
 521 /** SCHEDULE *****************************************************************/
 522
 523 gpointer sipe_backend_schedule_seconds(struct sipe_core_public *sipe_public,
 524                                        guint timeout,
 525                                        gpointer data);
 526 gpointer sipe_backend_schedule_mseconds(struct sipe_core_public *sipe_public,
 527                                         guint timeout,
 528                                         gpointer data);
 529 void sipe_backend_schedule_cancel(struct sipe_core_public *sipe_public,
 530                                   gpointer data);
 531
 532 /** SEARCH *******************************************************************/
 533
 534 struct sipe_backend_search_results;
 535 struct sipe_backend_search_token;
 536
 537 void sipe_backend_search_failed(struct sipe_core_public *sipe_public,
 538                                 struct sipe_backend_search_token *token,
 539                                 const gchar *msg);
 540 struct sipe_backend_search_results *sipe_backend_search_results_start(struct sipe_core_public *sipe_public,
 541                                                                       struct sipe_backend_search_token *token);
 542 void sipe_backend_search_results_add(struct sipe_core_public *sipe_public,
 543                                      struct sipe_backend_search_results *results,
 544                                      const gchar *uri,
 545                                      const gchar *name,
 546                                      const gchar *company,
 547                                      const gchar *country,
 548                                      const gchar *email);
 549 void sipe_backend_search_results_finalize(struct sipe_core_public *sipe_public,
 550                                           struct sipe_backend_search_results *results,
 551                                           const gchar *description,
 552                                           gboolean more);
 553
 554 /** SETTINGS *****************************************************************/
 555
 556 typedef enum {
 557   SIPE_SETTING_EMAIL_URL = 0,
 558   SIPE_SETTING_EMAIL_LOGIN,
 559   SIPE_SETTING_EMAIL_PASSWORD,
 560   SIPE_SETTING_GROUPCHAT_USER,
 561   SIPE_SETTING_USER_AGENT,
 562   SIPE_SETTING_LAST
 563 } sipe_setting;
 564 const gchar *sipe_backend_setting(struct sipe_core_public *sipe_public,
 565                                   sipe_setting type);
 566
 567 /** STATUS *******************************************************************/
 568
 569 guint sipe_backend_status(struct sipe_core_public *sipe_public);
 570 gboolean sipe_backend_status_changed(struct sipe_core_public *sipe_public,
 571                                      guint activity,
 572                                      const gchar *message);
 573 void sipe_backend_status_and_note(struct sipe_core_public *sipe_public,
 574                                   guint activity,
 575                                   const gchar *message);
 576
 577 /** TRANSPORT ****************************************************************/
 578
 579 typedef void transport_connected_cb(struct sipe_transport_connection *conn);
 580 typedef void transport_input_cb(struct sipe_transport_connection *conn);
 581 typedef void transport_error_cb(struct sipe_transport_connection *conn,
 582                                 const gchar *msg);
 583
 584 typedef struct {
 585         guint type;
 586         const gchar *server_name;
 587         guint server_port;
 588         gpointer user_data;
 589         transport_connected_cb *connected;
 590         transport_input_cb *input;
 591         transport_error_cb *error;
 592 } sipe_connect_setup;
 593 struct sipe_transport_connection *sipe_backend_transport_connect(struct sipe_core_public *sipe_public,
 594                                                                  const sipe_connect_setup *setup);
 595 void sipe_backend_transport_disconnect(struct sipe_transport_connection *conn);
 596 void sipe_backend_transport_message(struct sipe_transport_connection *conn,
 597                                     const gchar *buffer);
 598 void sipe_backend_transport_flush(struct sipe_transport_connection *conn);
 599
 600 /** USER *********************************************************************/
 601
 602 void sipe_backend_user_feedback_typing(struct sipe_core_public *sipe_public,
 603                                        const gchar *from);
 604 void sipe_backend_user_feedback_typing_stop(struct sipe_core_public *sipe_public,
 605                                             const gchar *from);
 606
 607 /**
 608  * Present a query that is to be accepted or declined by the user
 609  *
 610  * @param sipe_public   The handle representing the protocol instance
 611  * @param message       Text of the query to be shown to user
 612  * @param accept_label  Label to be displayed on UI control that accepts query
 613  * @param decline_label Label to be displayed on UI control that declines query
 614  * @param key           Opaque handle uniquely identifying the query. Backend
 615  *                      should store it for the case SIPE core requests the
 616  *                      query to be closed prematurely.
 617  */
 618 void sipe_backend_user_ask(struct sipe_core_public *sipe_public,
 619                            const gchar *message,
 620                            const gchar *accept_label,
 621                            const gchar *decline_label,
 622                            gpointer key);
 623
 624 /**
 625  * Closes the pending user query
 626  *
 627  * @param key Opaque handle uniquely identifying the query.
 628  */
 629 void sipe_backend_user_close_ask(gpointer key);
 630
 631 /** BUDDIES ******************************************************************/
 632
 633 /*
 634  * sipe_backend_buddy_get/set_string(): properties a buddy can have
 635  * sipe_backend_buddy_info_add():       mapped, e.g. to a string label
 636  */
 637 typedef enum
 638 {
 639         SIPE_BUDDY_INFO_DISPLAY_NAME = 0,
 640         SIPE_BUDDY_INFO_JOB_TITLE,
 641         SIPE_BUDDY_INFO_CITY,
 642         SIPE_BUDDY_INFO_STATE,
 643         SIPE_BUDDY_INFO_OFFICE,
 644         SIPE_BUDDY_INFO_DEPARTMENT,
 645         SIPE_BUDDY_INFO_COUNTRY,
 646         SIPE_BUDDY_INFO_WORK_PHONE,
 647         SIPE_BUDDY_INFO_WORK_PHONE_DISPLAY,
 648         SIPE_BUDDY_INFO_COMPANY,
 649         SIPE_BUDDY_INFO_EMAIL,
 650         SIPE_BUDDY_INFO_SITE,
 651         SIPE_BUDDY_INFO_ZIPCODE,
 652         SIPE_BUDDY_INFO_STREET,
 653         SIPE_BUDDY_INFO_MOBILE_PHONE,
 654         SIPE_BUDDY_INFO_MOBILE_PHONE_DISPLAY,
 655         SIPE_BUDDY_INFO_HOME_PHONE,
 656         SIPE_BUDDY_INFO_HOME_PHONE_DISPLAY,
 657         SIPE_BUDDY_INFO_OTHER_PHONE,
 658         SIPE_BUDDY_INFO_OTHER_PHONE_DISPLAY,
 659         SIPE_BUDDY_INFO_CUSTOM1_PHONE,
 660         SIPE_BUDDY_INFO_CUSTOM1_PHONE_DISPLAY,
 661         SIPE_BUDDY_INFO_ALIAS,  /* only for sipe_backend_buddy_info_add() */
 662         SIPE_BUDDY_INFO_DEVICE, /* only for sipe_backend_buddy_info_add() */
 663 } sipe_buddy_info_fields;
 664
 665 /* Opaque token */
 666 typedef void* sipe_backend_buddy;
 667
 668 /**
 669  * Find a buddy in the given group of the buddy list, or anywhere on the
 670  * list if @group_name is empty
 671  *
 672  * @param sipe_public The handle representing the protocol instance making the call
 673  * @param buddy_name The name of the buddy
 674  * @param group_name The name of the group to look in, or NULL for any group
 675  * @return opaque handle to the buddy, or NULL if no buddy found
 676  */
 677 sipe_backend_buddy sipe_backend_buddy_find(struct sipe_core_public *sipe_public,
 678                                            const gchar *buddy_name,
 679                                            const gchar *group_name);
 680
 681 /*
 682  * Find all named buddies in the given group of the buddy list, or anywhere on the
 683  * list if @group_name is empty; or all buddies if @name is empty
 684  *
 685  * @param sipe_public The handle representing the protocol instance making the call
 686  * @param name The name of the buddy
 687  * @param group_name The name of the group to look in, or NULL for any group
 688  * @return GSList of opaque handles to the buddies
 689  */
 690 GSList* sipe_backend_buddy_find_all(struct sipe_core_public *sipe_public,
 691                                     const gchar *buddy_name,
 692                                     const gchar *group_name);
 693
 694 /**
 695  * Gets the name of a contact.
 696  *
 697  * @param sipe_public The handle representing the protocol instance making the call
 698  * @param who The opaque handle to the contact as found by find_buddy
 699  * @return The name. Must be freed.
 700  */
 701 gchar* sipe_backend_buddy_get_name(struct sipe_core_public *sipe_public,
 702                                    const sipe_backend_buddy who);
 703
 704 /**
 705  * Gets the alias for a contact.
 706  *
 707  * @param sipe_public The handle representing the protocol instance making the call
 708  * @param who The opaque handle to the contact as found by find_buddy
 709  * @return The alias. Must be gfree'd.
 710  */
 711 gchar* sipe_backend_buddy_get_alias(struct sipe_core_public *sipe_public,
 712                                     const sipe_backend_buddy who);
 713
 714 /**
 715  * Gets the server alias for a contact.
 716  *
 717  * @param sipe_public The handle representing the protocol instance making the call
 718  * @param who The opaque handle to the contact as found by find_buddy
 719  * @return The alias. Must be freed.
 720  */
 721 gchar* sipe_backend_buddy_get_server_alias(struct sipe_core_public *sipe_public,
 722                                            const sipe_backend_buddy who);
 723
 724 /**
 725  * Gets the local alias for a contact
 726  *
 727  * @param sipe_public The handle representing the protocol instance making the call
 728  * @param uri         the budyy name
 729  *
 730  * @return the alias. Must be @g_free()'d.
 731  */
 732 gchar *sipe_backend_buddy_get_local_alias(struct sipe_core_public *sipe_public,
 733                                           const sipe_backend_buddy who);
 734
 735 /**
 736  * Gets the name of the group a contact belongs to.
 737  *
 738  * @param sipe_public The handle representing the protocol instance making the call
 739  * @param who The opaque handle to the contact as found by find_buddy
 740  * @return The name. Must be freed.
 741  */
 742 gchar* sipe_backend_buddy_get_group_name(struct sipe_core_public *sipe_public,
 743                                          const sipe_backend_buddy who);
 744
 745 /**
 746  * Called to retrieve a buddy-specific setting.
 747  *
 748  * @param sipe_public The handle representing the protocol instance making the call
 749  * @param buddy The handle representing the buddy
 750  * @param key The name of the setting
 751  * @return The value of the setting. Must be freed.
 752  */
 753 gchar* sipe_backend_buddy_get_string(struct sipe_core_public *sipe_public,
 754                                      sipe_backend_buddy buddy,
 755                                      const sipe_buddy_info_fields key);
 756
 757 /**
 758  * Called to set a buddy-specific setting.
 759  *
 760  * @param sipe_public The handle representing the protocol instance making the call
 761  * @param buddy The handle representing the buddy
 762  * @param key The name of the setting
 763  * @param val The value to set
 764  */
 765 void sipe_backend_buddy_set_string(struct sipe_core_public *sipe_public,
 766                                    sipe_backend_buddy buddy,
 767                                    const sipe_buddy_info_fields key,
 768                                    const gchar *val);
 769
 770 /**
 771  * Get the status token for a contact
 772  *
 773  * @param sipe_public The handle representing the protocol instance making the call
 774  * @param uri         SIP URI of the contact
 775  *
 776  * @return activity
 777  */
 778 guint sipe_backend_buddy_get_status(struct sipe_core_public *sipe_public,
 779                                     const gchar *uri);
 780
 781 /**
 782  * Sets the alias for a contact.
 783  *
 784  * @param sipe_public The handle representing the protocol instance making the call
 785  * @param who The opaque handle to the contact as found by find_buddy
 786  * @param alias The location where the alias will be put
 787  * case. FALSE if the buddy was not found. The value of alias will not be changed.
 788  */
 789 void sipe_backend_buddy_set_alias(struct sipe_core_public *sipe_public,
 790                                   const sipe_backend_buddy who,
 791                                   const gchar *alias);
 792
 793 /**
 794  * Sets the server 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 server alias of the contact
 799  */
 800 void sipe_backend_buddy_set_server_alias(struct sipe_core_public *sipe_public,
 801                                          const sipe_backend_buddy who,
 802                                          const gchar *alias);
 803
 804 /**
 805  * Start processing buddy list
 806  *
 807  * Will be called every time we receive a buddy list in roaming contacts
 808  *
 809  * @param sipe_public The handle representing the protocol instance making the call
 810  */
 811 void sipe_backend_buddy_list_processing_start(struct sipe_core_public *sipe_public);
 812
 813 /**
 814  * Finished processing buddy list
 815  *
 816  * Will be called every time we receive a buddy list in roaming contacts
 817  *
 818  * @param sipe_public The handle representing the protocol instance making the call
 819  */
 820 void sipe_backend_buddy_list_processing_finish(struct sipe_core_public *sipe_public);
 821
 822 /**
 823  * Add a contact to the buddy list
 824  *
 825  * @param sipe_public The handle representing the protocol instance making the call
 826  * @param name The name of the contact
 827  * @param alias The alias of the contact
 828  * @param groupname The name of the group to add this contact to
 829  * @return A handle to the newly created buddy
 830  */
 831 sipe_backend_buddy sipe_backend_buddy_add(struct sipe_core_public *sipe_public,
 832                                           const gchar *name,
 833                                           const gchar *alias,
 834                                           const gchar *groupname);
 835
 836 /**
 837  * Remove a contact from the buddy list
 838  *
 839  * @param sipe_public The handle representing the protocol instance making the call
 840  * @param who The opaque handle to the contact as found by find_buddy
 841  */
 842 void sipe_backend_buddy_remove(struct sipe_core_public *sipe_public,
 843                                const sipe_backend_buddy who);
 844
 845 /**
 846  * Notifies the user that a remote user has wants to add the local user to his
 847  * or her buddy list and requires authorization to do so.
 848  *
 849  * @param sipe_public The handle representing the protocol instance making the call
 850  * @param who The name of the user that added this account
 851  * @param alias The optional alias of the remote user
 852  * @param on_list True if the user is already in our list
 853  * @param auth_cb The callback called when the local user accepts
 854  * @param deny_cb The callback called when the local user rejects
 855  * @param data Data to be passed back to the above callbacks
 856  */
 857 typedef void (*sipe_backend_buddy_request_authorization_cb)(void *);
 858
 859 void sipe_backend_buddy_request_add(struct sipe_core_public *sipe_public,
 860                                     const gchar *who,
 861                                     const gchar *alias);
 862
 863 void sipe_backend_buddy_request_authorization(struct sipe_core_public *sipe_public,
 864                                               const gchar *who,
 865                                               const gchar *alias,
 866                                               gboolean on_list,
 867                                               sipe_backend_buddy_request_authorization_cb auth_cb,
 868                                               sipe_backend_buddy_request_authorization_cb deny_cb,
 869                                               gpointer data);
 870
 871 gboolean sipe_backend_buddy_is_blocked(struct sipe_core_public *sipe_public,
 872                                        const gchar *who);
 873
 874 void sipe_backend_buddy_set_blocked_status(struct sipe_core_public *sipe_public,
 875                                            const gchar *who,
 876                                            gboolean blocked);
 877
 878 void sipe_backend_buddy_set_status(struct sipe_core_public *sipe_public,
 879                                    const gchar *who,
 880                                    guint activity);
 881
 882 /**
 883  * Gives backend a photo image associated with a SIP URI. Backend has ownership
 884  * of the data and must free it when not needed.
 885  *
 886  * @param sipe_public The handle representing the protocol instance making the call
 887  * @param who The name of the user whose photo is being set
 888  * @param image_data The photo image data, must be g_free()'d by backend
 889  * @param image_len Size of the image in Bytes
 890  * @param photo_hash A data checksum provided by the server
 891  */
 892 void sipe_backend_buddy_set_photo(struct sipe_core_public *sipe_public,
 893                                   const gchar *who,
 894                                   gpointer image_data,
 895                                   gsize image_len,
 896                                   const gchar *photo_hash);
 897
 898 /**
 899  * Retrieves a photo hash stored together with image data by
 900  * @c sipe_backend_buddy_set_photo. Value is used by the core to detect photo
 901  * file changes on server.
 902  *
 903  * @param sipe_public The handle representing the protocol instance making the call
 904  * @param who The name of the user whose photo hash to retrieve
 905  * @return a photo hash (may be NULL)
 906  */
 907 const gchar *sipe_backend_buddy_get_photo_hash(struct sipe_core_public *sipe_public,
 908                                                const gchar *who);
 909
 910 /**
 911  * Called when a new internal group is about to be added. If this returns FALSE,
 912  * the group will not be added.
 913  *
 914  * @param sipe_public The handle representing the protocol instance making the call
 915  * @param group The group being added
 916  * @return TRUE if everything is ok, FALSE if the group should not be added
 917  */
 918 gboolean sipe_backend_buddy_group_add(struct sipe_core_public *sipe_public,
 919                                       const gchar *group_name);
 920
 921 /**
 922  * Called when a new internal group has been renamed
 923  *
 924  * @param sipe_public The handle representing the protocol instance making the call
 925  * @param old_name old name of the group
 926  * @param new_name new name of the group
 927  * @return TRUE if the group was found and renamed
 928  */
 929 gboolean sipe_backend_buddy_group_rename(struct sipe_core_public *sipe_public,
 930                                          const gchar *old_name,
 931                                          const gchar *new_name);
 932
 933 /**
 934  * Present requested buddy information to the user
 935  */
 936 struct sipe_backend_buddy_info;
 937 struct sipe_backend_buddy_info *sipe_backend_buddy_info_start(struct sipe_core_public *sipe_public);
 938 void sipe_backend_buddy_info_add(struct sipe_core_public *sipe_public,
 939                                  struct sipe_backend_buddy_info *info,
 940                                  sipe_buddy_info_fields key,
 941                                  const gchar *value);
 942 void sipe_backend_buddy_info_break(struct sipe_core_public *sipe_public,
 943                                    struct sipe_backend_buddy_info *info);
 944 void sipe_backend_buddy_info_finalize(struct sipe_core_public *sipe_public,
 945                                       struct sipe_backend_buddy_info *info,
 946                                       const gchar *uri);
 947
 948 struct sipe_backend_buddy_tooltip;
 949 void sipe_backend_buddy_tooltip_add(struct sipe_core_public *sipe_public,
 950                                     struct sipe_backend_buddy_tooltip *tooltip,
 951                                     const gchar *description,
 952                                     const gchar *value);
 953
 954 /**
 955  * Buddy menu creation
 956  */
 957 enum sipe_buddy_menu_type {
 958         SIPE_BUDDY_MENU_MAKE_CHAT_LEADER = 0,
 959         SIPE_BUDDY_MENU_REMOVE_FROM_CHAT,
 960         SIPE_BUDDY_MENU_INVITE_TO_CHAT,
 961         SIPE_BUDDY_MENU_NEW_CHAT,
 962         SIPE_BUDDY_MENU_MAKE_CALL,
 963         SIPE_BUDDY_MENU_SEND_EMAIL,
 964         SIPE_BUDDY_MENU_ACCESS_LEVEL_HELP,
 965         SIPE_BUDDY_MENU_CHANGE_ACCESS_LEVEL,
 966         SIPE_BUDDY_MENU_ADD_NEW_DOMAIN,
 967         SIPE_BUDDY_MENU_TYPES
 968 };
 969
 970 struct sipe_backend_buddy_menu *sipe_backend_buddy_menu_start(struct sipe_core_public *sipe_public);
 971 struct sipe_backend_buddy_menu *sipe_backend_buddy_menu_add(struct sipe_core_public *sipe_public,
 972                                                             struct sipe_backend_buddy_menu *menu,
 973                                                             const gchar *label,
 974                                                             enum sipe_buddy_menu_type type,
 975                                                             gpointer parameter);
 976 struct sipe_backend_buddy_menu *sipe_backend_buddy_menu_separator(struct sipe_core_public *sipe_public,
 977                                                                   struct sipe_backend_buddy_menu *menu,
 978                                                                   const gchar *label);
 979 struct sipe_backend_buddy_menu *sipe_backend_buddy_sub_menu_add(struct sipe_core_public *sipe_public,
 980                                                                 struct sipe_backend_buddy_menu *menu,
 981                                                                 const gchar *label,
 982                                                                 struct sipe_backend_buddy_menu *sub);
 983
 984 #ifdef __cplusplus
 985 }
 986 #endif
 987
 988 /*
 989   Local Variables:
 990   mode: c
 991   c-file-style: "bsd"
 992   indent-tabs-mode: t
 993   tab-width: 8
 994   End:
 995 */