src/api/sipe-core.h

   1 /**
   2  * @file sipe-core.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  * Backend -> SIPE Core API - functions called by backend 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 interrupted by another thread calling
  34  * sipe_core_xxx() while the first thread has entered the SIPE core through
  35  * a sipe_core_xxx() function.
  36  *
  37  ***************** !!! IMPORTANT NOTE FOR BACKEND CODERS !!! *****************
  38  */
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 /**
  45  * Transport type
  46  */
  47 #define SIPE_TRANSPORT_AUTO 0
  48 #define SIPE_TRANSPORT_TLS  1
  49 #define SIPE_TRANSPORT_TCP  2
  50
  51 /**
  52  * Transport connection (public part)
  53  *
  54  * The receiver in the backend fills "buffer". The backend has to zero
  55  * terminate the buffer before calling the processing function in the core.
  56  *
  57  * The processing function in the core can remove content from the buffer.
  58  * It has to update buffer_used accordingly.
  59  *
  60  */
  61 struct sipe_transport_connection {
  62         gpointer user_data;
  63         gchar *buffer;
  64         gsize buffer_used;        /* 0 < buffer_used < buffer_length */
  65         gsize buffer_length;      /* read-only */
  66         guint type;               /* read-only */
  67         guint client_port;        /* read-only */
  68 };
  69
  70 /**
  71  * Opaque data type for chat session
  72  */
  73 struct sipe_chat_session;
  74
  75 /**
  76  * File transport (public part)
  77  */
  78 struct sipe_file_transfer {
  79         struct sipe_backend_file_transfer *backend_private;
  80 };
  81
  82 /**
  83  * Opaque data type for backend private data.
  84  * The backend is responsible to allocate and free it.
  85  */
  86 struct sipe_backend_private;
  87
  88 /**
  89  * Flags
  90  */
  91 #define SIPE_CORE_FLAG_KRB5    0x00000001 /* user enabled Kerberos 5     */
  92 #define SIPE_CORE_FLAG_SSO     0x00000002 /* user enabled Single-Sign On */
  93 #define SIPE_CORE_FLAG_TLS_DSK 0x00000004 /* user enabled TLS-DSK        */
  94
  95 #define SIPE_CORE_FLAG_IS(flag)    \
  96         ((sipe_public->flags & SIPE_CORE_FLAG_ ## flag) == SIPE_CORE_FLAG_ ## flag)
  97 #define SIPE_CORE_FLAG_SET(flag)   \
  98         (sipe_public->flags |= SIPE_CORE_FLAG_ ## flag)
  99 #define SIPE_CORE_FLAG_UNSET(flag) \
 100         (sipe_public->flags &= ~SIPE_CORE_FLAG_ ## flag)
 101
 102 /**
 103  * Public part of the Sipe data structure
 104  *
 105  * This part contains the information needed by the core and the backend.
 106  */
 107 struct sipe_core_public {
 108         /**
 109          * This points to the private data for the backend.
 110          * The backend is responsible to allocate and free it.
 111          */
 112         struct sipe_backend_private *backend_private;
 113
 114         /* flags (see above) */
 115         guint32 flags;
 116
 117         /* user information */
 118         gchar *sip_name;
 119         gchar *sip_domain;
 120
 121         /* server information */
 122         guint keepalive_timeout;
 123 };
 124
 125 /**
 126  * Initialize & destroy functions for the SIPE core
 127  * Should be called on loading and unloading of the plugin.
 128  */
 129 void sipe_core_init(const char *locale_dir);
 130 void sipe_core_destroy(void);
 131
 132 /** Utility functions exported by the core to backends ***********************/
 133 gboolean sipe_strequal(const gchar *left, const gchar *right);
 134
 135 GSList *
 136 sipe_utils_nameval_add(GSList *list, const gchar *name, const gchar *value);
 137
 138 const gchar *
 139 sipe_utils_nameval_find(const GSList *list, const gchar *name);
 140
 141 const gchar *
 142 sipe_utils_nameval_find_instance(const GSList *list, const gchar *name, int which);
 143
 144 void
 145 sipe_utils_nameval_free(GSList *list);
 146
 147 gchar *sip_uri_from_name(const gchar *name);
 148 gchar *sip_uri_if_valid(const gchar *string);
 149
 150 /*****************************************************************************/
 151
 152 /**
 153  * Other functions (need to be sorted once structure becomes clear.
 154  */
 155
 156 /* Get translated about string. Must be g_free'd(). */
 157 gchar *sipe_core_about(void);
 158
 159 /* Execute a scheduled action */
 160 void sipe_core_schedule_execute(gpointer data);
 161
 162 /* menu actions */
 163 void sipe_core_update_calendar(struct sipe_core_public *sipe_public);
 164 void sipe_core_reset_status(struct sipe_core_public *sipe_public);
 165
 166 /* access levels */
 167 void sipe_core_change_access_level_from_container(struct sipe_core_public *sipe_public,
 168                                                   gpointer parameter);
 169 void sipe_core_change_access_level_for_domain(struct sipe_core_public *sipe_public,
 170                                               const gchar *domain,
 171                                               guint index);
 172
 173 /**
 174  * Activity
 175  *   - core:    maps this to OCS protocol values
 176  *              maps this to translated descriptions
 177  *   - backend: maps this to backend status values
 178  *              backend token string can be used as "ID" in protocol
 179  *
 180  * This is passed back-and-forth and therefore defined as list, not as enum.
 181  * Can be used as array index
 182  */
 183 #define SIPE_ACTIVITY_UNSET        0
 184 #define SIPE_ACTIVITY_AVAILABLE    1
 185 #define SIPE_ACTIVITY_ONLINE       2
 186 #define SIPE_ACTIVITY_INACTIVE     3
 187 #define SIPE_ACTIVITY_BUSY         4
 188 #define SIPE_ACTIVITY_BUSYIDLE     5
 189 #define SIPE_ACTIVITY_DND          6
 190 #define SIPE_ACTIVITY_BRB          7
 191 #define SIPE_ACTIVITY_AWAY         8
 192 #define SIPE_ACTIVITY_LUNCH        9
 193 #define SIPE_ACTIVITY_INVISIBLE   10
 194 #define SIPE_ACTIVITY_OFFLINE     11
 195 #define SIPE_ACTIVITY_ON_PHONE    12
 196 #define SIPE_ACTIVITY_IN_CONF     13
 197 #define SIPE_ACTIVITY_IN_MEETING  14
 198 #define SIPE_ACTIVITY_OOF         15
 199 #define SIPE_ACTIVITY_URGENT_ONLY 16
 200 #define SIPE_ACTIVITY_NUM_TYPES   17 /* use to define array size */
 201
 202 const gchar *sipe_core_activity_description(guint type);
 203
 204 /* buddy actions */
 205 /**
 206  * Get status text for buddy.
 207  *
 208  * @param sipe_public Sipe core public data structure.
 209  * @param uri         SIP URI of the buddy
 210  * @param activity    activity value for buddy
 211  * @param status_text backend-specific buddy status text for activity.
 212  *
 213  * @return HTML status text for the buddy or NULL. Must be g_free()'d.
 214  */
 215 gchar *sipe_core_buddy_status(struct sipe_core_public *sipe_public,
 216                               const gchar *uri,
 217                               guint activity,
 218                               const gchar *status_text);
 219
 220 void sipe_core_buddy_got_status(struct sipe_core_public *sipe_public,
 221                                 const gchar *uri,
 222                                 guint activity);
 223
 224 /**
 225  * Trigger generation of buddy information label/text pairs
 226  *
 227  * @param sipe_public Sipe core public data structure.
 228  * @param uri         SIP URI of the buddy
 229  * @param status_text backend-specific buddy status text for ID.
 230  * @param is_online   backend considers buddy to be online.
 231  * @param tooltip     opaque backend identifier for tooltip info. This is the
 232  *                    parameter given to @c sipe_backend_buddy_tooltip_add()
 233  */
 234 struct sipe_backend_buddy_tooltip;
 235 void sipe_core_buddy_tooltip_info(struct sipe_core_public *sipe_public,
 236                                   const gchar *uri,
 237                                   const gchar *status_name,
 238                                   gboolean is_online,
 239                                   struct sipe_backend_buddy_tooltip *tooltip);
 240
 241 /**
 242  * Add a buddy
 243  *
 244  * @param sipe_public Sipe core public data structure
 245  * @param uri         SIP URI of the buddy
 246  * @param group_name  backend-specific group name
 247  */
 248 void sipe_core_buddy_add(struct sipe_core_public *sipe_public,
 249                          const gchar *uri,
 250                          const gchar *group_name);
 251
 252 /**
 253  * Remove a buddy
 254  *
 255  * @param sipe_public Sipe core public data structure
 256  * @param uri         SIP URI of the buddy
 257  * @param group_name  backend-specific group name
 258  */
 259 void sipe_core_buddy_remove(struct sipe_core_public *sipe_public,
 260                             const gchar *uri,
 261                             const gchar *group_name);
 262
 263 void sipe_core_contact_allow_deny(struct sipe_core_public *sipe_public,
 264                                   const gchar *who,
 265                                   gboolean allow);
 266 void sipe_core_group_set_alias(struct sipe_core_public *sipe_public,
 267                                const gchar *who,
 268                                const gchar *alias);
 269
 270 /**
 271  * Setup core data
 272  */
 273 struct sipe_core_public *sipe_core_allocate(const gchar *signin_name,
 274                                             const gchar *login_domain,
 275                                             const gchar *login_account,
 276                                             const gchar *password,
 277                                             const gchar *email,
 278                                             const gchar *email_url,
 279                                             const gchar **errmsg);
 280 void sipe_core_deallocate(struct sipe_core_public *sipe_public);
 281
 282 /**
 283  * Connect to SIP server
 284  */
 285 void sipe_core_transport_sip_connect(struct sipe_core_public *sipe_public,
 286                                      guint transport,
 287                                      const gchar *server,
 288                                      const gchar *port);
 289 void sipe_core_transport_sip_keepalive(struct sipe_core_public *sipe_public);
 290
 291 /**
 292  * Invite to chat
 293  */
 294 void sipe_core_chat_invite(struct sipe_core_public *sipe_public,
 295                            struct sipe_chat_session *chat_session,
 296                            const char *name);
 297
 298 /**
 299  * Rejoin a chat after connection re-establishment
 300  */
 301 void sipe_core_chat_rejoin(struct sipe_core_public *sipe_public,
 302                            struct sipe_chat_session *chat_session);
 303
 304 /**
 305  * Leave a chat
 306  */
 307 void sipe_core_chat_leave(struct sipe_core_public *sipe_public,
 308                           struct sipe_chat_session *chat_session);
 309
 310 /**
 311  * Send message to chat
 312  */
 313 void sipe_core_chat_send(struct sipe_core_public *sipe_public,
 314                          struct sipe_chat_session *chat_session,
 315                          const char *what);
 316
 317 /**
 318  * Check chat lock status
 319  */
 320 typedef enum {
 321         SIPE_CHAT_LOCK_STATUS_NOT_ALLOWED = 0,
 322         SIPE_CHAT_LOCK_STATUS_UNLOCKED,
 323         SIPE_CHAT_LOCK_STATUS_LOCKED
 324 } sipe_chat_lock_status;
 325 sipe_chat_lock_status sipe_core_chat_lock_status(struct sipe_core_public *sipe_public,
 326                                                  struct sipe_chat_session *chat_session);
 327
 328 /**
 329  * Lock chat
 330  */
 331 void sipe_core_chat_modify_lock(struct sipe_core_public *sipe_public,
 332                                 struct sipe_chat_session *chat_session,
 333                                 const gboolean locked);
 334
 335 /**
 336  * Create new session with Focus URI
 337  *
 338  * @param sipe_public (in) SIPE core data.
 339  * @param focus_uri (in) focus URI string
 340  *
 341  * @return new SIP session
 342  */
 343 struct sip_session *
 344 sipe_core_conf_create(struct sipe_core_public *sipe_public,
 345                       const gchar *focus_uri);
 346
 347 /* buddy menu callback: parameter == chat_session */
 348 void sipe_core_conf_make_leader(struct sipe_core_public *sipe_public,
 349                                 gpointer parameter,
 350                                 const gchar *buddy_name);
 351 void sipe_core_conf_remove_from(struct sipe_core_public *sipe_public,
 352                                 gpointer parameter,
 353                                 const gchar *buddy_name);
 354
 355 /* call control (CSTA) */
 356 void sipe_core_buddy_make_call(struct sipe_core_public *sipe_public,
 357                                const gchar *phone);
 358
 359 /* media */
 360 void sipe_core_media_initiate_call(struct sipe_core_public *sipe_public,
 361                                    const char *participant,
 362                                    gboolean with_video);
 363 /**
 364  * Connects to a conference call specified by given chat session
 365  *
 366  * @param sipe_public (in) SIPE core data.
 367  * @param chat_session (in) chat session structure
 368  */
 369 void sipe_core_media_connect_conference(struct sipe_core_public *sipe_public,
 370                                         struct sipe_chat_session *chat_session);
 371
 372 /**
 373  * Checks whether there is a media call in progress
 374  *
 375  * @param sipe_public (in) SIPE core data.
 376  *
 377  * @return @c TRUE if media call is in progress
 378  */
 379 gboolean sipe_core_media_in_call(struct sipe_core_public *sipe_public);
 380
 381 /**
 382  * Checks voice quality by making a call to the test service
 383  *
 384  * @param sipe_public (in) SIPE core data.
 385  */
 386 void sipe_core_media_test_call(struct sipe_core_public *sipe_public);
 387
 388 /* file transfer */
 389 struct sipe_file_transfer *sipe_core_ft_allocate(struct sipe_core_public *sipe_public);
 390 void sipe_core_ft_deallocate(struct sipe_file_transfer *ft);
 391 void sipe_core_ft_cancel(struct sipe_file_transfer *ft);
 392 void sipe_core_ft_incoming_init(struct sipe_file_transfer *ft);
 393 void sipe_core_ft_outgoing_init(struct sipe_file_transfer *ft,
 394                                 const gchar *filename, gsize size,
 395                                 const gchar *who);
 396
 397 void sipe_core_tftp_incoming_start(struct sipe_file_transfer *ft,
 398                                    gsize total_size);
 399 gboolean sipe_core_tftp_incoming_stop(struct sipe_file_transfer *ft);
 400 void sipe_core_tftp_outgoing_start(struct sipe_file_transfer *ft,
 401                                    gsize total_size);
 402 gboolean sipe_core_tftp_outgoing_stop(struct sipe_file_transfer *ft);
 403 gssize sipe_core_tftp_read(struct sipe_file_transfer *ft, guchar **buffer,
 404                            gsize bytes_remaining, gsize bytes_available);
 405 gssize sipe_core_tftp_write(struct sipe_file_transfer *ft, const guchar *buffer,
 406                             gsize size);
 407 /* group chat */
 408 gboolean sipe_core_groupchat_query_rooms(struct sipe_core_public *sipe_public);
 409 void sipe_core_groupchat_join(struct sipe_core_public *sipe_public,
 410                               const gchar *uri);
 411
 412 /* IM */
 413 void sipe_core_im_send(struct sipe_core_public *sipe_public,
 414                        const gchar *who,
 415                        const gchar *what);
 416 void sipe_core_im_close(struct sipe_core_public *sipe_public,
 417                         const gchar *who);
 418
 419 /* user */
 420 void sipe_core_user_feedback_typing(struct sipe_core_public *sipe_public,
 421                                     const gchar *to);
 422
 423 void sipe_core_user_ask_cb(gpointer key, gboolean accepted);
 424
 425 /* groups */
 426 void sipe_core_group_rename(struct sipe_core_public *sipe_public,
 427                             const gchar *old_name,
 428                             const gchar *new_name);
 429
 430 void sipe_core_group_remove(struct sipe_core_public *sipe_public,
 431                             const gchar *name);
 432
 433 /* buddies */
 434 void sipe_core_buddy_group(struct sipe_core_public *sipe_public,
 435                            const gchar *who,
 436                            const gchar *old_group_name,
 437                            const gchar *new_group_name);
 438
 439 struct sipe_backend_search_token;
 440 void sipe_core_buddy_search(struct sipe_core_public *sipe_public,
 441                             struct sipe_backend_search_token *token,
 442                             const gchar *given_name,
 443                             const gchar *surname,
 444                             const gchar *email,
 445                             const gchar *company,
 446                             const gchar *country);
 447
 448 void sipe_core_buddy_get_info(struct sipe_core_public *sipe_public,
 449                               const gchar *who);
 450
 451 void sipe_core_buddy_new_chat(struct sipe_core_public *sipe_public,
 452                               const gchar *who);
 453 void sipe_core_buddy_send_email(struct sipe_core_public *sipe_public,
 454                                 const gchar *who);
 455
 456 struct sipe_backend_buddy_menu;
 457 struct sipe_backend_buddy_menu *sipe_core_buddy_create_menu(struct sipe_core_public *sipe_public,
 458                                                             const gchar *buddy_name,
 459                                                             struct sipe_backend_buddy_menu *menu);
 460
 461 void sipe_core_buddy_menu_free(struct sipe_core_public *sipe_public);
 462
 463 /* status */
 464 void sipe_core_status_set(struct sipe_core_public *sipe_public,
 465                           guint activity,
 466                           const gchar *note);
 467 void sipe_core_status_idle(struct sipe_core_public *sipe_public);
 468
 469 #ifdef __cplusplus
 470 }
 471 #endif
 472
 473 /*
 474   Local Variables:
 475   mode: c
 476   c-file-style: "bsd"
 477   indent-tabs-mode: t
 478   tab-width: 8
 479   End:
 480 */