src/api/sipe-core.h

   1 /**
   2  * @file sipe-core.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2010-11 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  * Activity
  46  *   - core:    maps this to OCS protocol values
  47  *   - backend: maps this to backend status values
  48  */
  49 typedef enum
  50 {
  51         SIPE_ACTIVITY_UNSET = 0,
  52         SIPE_ACTIVITY_ONLINE,
  53         SIPE_ACTIVITY_INACTIVE,
  54         SIPE_ACTIVITY_BUSY,
  55         SIPE_ACTIVITY_BUSYIDLE,
  56         SIPE_ACTIVITY_DND,
  57         SIPE_ACTIVITY_BRB,
  58         SIPE_ACTIVITY_AWAY,
  59         SIPE_ACTIVITY_LUNCH,
  60         SIPE_ACTIVITY_OFFLINE,
  61         SIPE_ACTIVITY_ON_PHONE,
  62         SIPE_ACTIVITY_IN_CONF,
  63         SIPE_ACTIVITY_IN_MEETING,
  64         SIPE_ACTIVITY_OOF,
  65         SIPE_ACTIVITY_URGENT_ONLY,
  66         SIPE_ACTIVITY_NUM_TYPES
  67 } sipe_activity;
  68
  69 /**
  70  * Transport type
  71  */
  72 #define SIPE_TRANSPORT_AUTO 0
  73 #define SIPE_TRANSPORT_TLS  1
  74 #define SIPE_TRANSPORT_TCP  2
  75
  76 /**
  77  * Transport connection (public part)
  78  *
  79  * The receiver in the backend fills "buffer". The backend has to zero
  80  * terminate the buffer before calling the processing function in the core.
  81  *
  82  * The processing function in the core can remove content from the buffer.
  83  * It has to update buffer_used accordingly.
  84  *
  85  */
  86 struct sipe_transport_connection {
  87         gpointer user_data;
  88         gchar *buffer;
  89         gsize buffer_used;        /* 0 < buffer_used < buffer_length */
  90         gsize buffer_length;      /* read-only */
  91         guint type;               /* read-only */
  92         guint client_port;        /* read-only */
  93 };
  94
  95 /**
  96  * Opaque data type for chat session
  97  */
  98 struct sipe_chat_session;
  99
 100 /**
 101  * File transport (public part)
 102  */
 103 struct sipe_file_transfer {
 104         struct sipe_backend_file_transfer *backend_private;
 105 };
 106
 107 /**
 108  * Opaque data type for backend private data.
 109  * The backend is responsible to allocate and free it.
 110  */
 111 struct sipe_backend_private;
 112
 113 /**
 114  * Flags
 115  */
 116 #define SIPE_CORE_FLAG_KRB5 0x00000001 /* user enabled Kerberos 5     */
 117 #define SIPE_CORE_FLAG_SSO  0x00000002 /* user enabled Single-Sign On */
 118
 119 #define SIPE_CORE_FLAG_IS(flag)    \
 120         ((sipe_public->flags & SIPE_CORE_FLAG_ ## flag) == SIPE_CORE_FLAG_ ## flag)
 121 #define SIPE_CORE_FLAG_SET(flag)   \
 122         (sipe_public->flags |= SIPE_CORE_FLAG_ ## flag)
 123 #define SIPE_CORE_FLAG_UNSET(flag) \
 124         (sipe_public->flags &= ~SIPE_CORE_FLAG_ ## flag)
 125
 126 /**
 127  * Public part of the Sipe data structure
 128  *
 129  * This part contains the information needed by the core and the backend.
 130  */
 131 struct sipe_core_public {
 132         /**
 133          * This points to the private data for the backend.
 134          * The backend is responsible to allocate and free it.
 135          */
 136         struct sipe_backend_private *backend_private;
 137
 138         /* flags (see above) */
 139         guint32 flags;
 140
 141         /* user information */
 142         gchar *sip_name;
 143         gchar *sip_domain;
 144
 145         /* server information */
 146         guint keepalive_timeout;
 147 };
 148
 149 /**
 150  * Initialize & destroy functions for the SIPE core
 151  * Should be called on loading and unloading of the plugin.
 152  */
 153 void sipe_core_init(const char *locale_dir);
 154 void sipe_core_destroy(void);
 155
 156 /** Utility functions exported by the core to backends ***********************/
 157 gboolean sipe_strequal(const gchar *left, const gchar *right);
 158
 159 GSList *
 160 sipe_utils_nameval_add(GSList *list, const gchar *name, const gchar *value);
 161
 162 const gchar *
 163 sipe_utils_nameval_find(const GSList *list, const gchar *name);
 164
 165 const gchar *
 166 sipe_utils_nameval_find_instance(const GSList *list, const gchar *name, int which);
 167
 168 void
 169 sipe_utils_nameval_free(GSList *list);
 170
 171 /*****************************************************************************/
 172
 173 /**
 174  * Other functions (need to be sorted once structure becomes clear.
 175  */
 176
 177 /* Get translated about string. Must be g_free'd(). */
 178 gchar *sipe_core_about(void);
 179
 180 /* Execute a scheduled action */
 181 void sipe_core_schedule_execute(gpointer data);
 182
 183 /* menu actions */
 184 void sipe_core_update_calendar(struct sipe_core_public *sipe_public);
 185 void sipe_core_reset_status(struct sipe_core_public *sipe_public);
 186
 187 /* buddy actions */
 188 /**
 189  * Get status text for buddy.
 190  *
 191  * @param sipe_public Sipe core public data structure.
 192  * @param name        backend-specific buddy name.
 193  * @param activity    activity value for buddy
 194  * @param status_text backend-specific buddy status text for activity.
 195  *
 196  * @return HTML status text for the buddy or NULL. Must be g_free()'d.
 197  */
 198 gchar *sipe_core_buddy_status(struct sipe_core_public *sipe_public,
 199                               const gchar *name,
 200                               const sipe_activity activity,
 201                               const gchar *status_text);
 202
 203 void sipe_core_buddy_got_status(struct sipe_core_public *sipe_public,
 204                                 const gchar* uri,
 205                                 const gchar *status_id);
 206
 207 /**
 208  * Return a list with buddy information label/text pairs
 209  *
 210  * @param sipe_public Sipe core public data structure.
 211  * @param name        backend-specific buddy name.
 212  * @param status_text backend-specific buddy status text for ID.
 213  * @param is_online   backend considers buddy to be online.
 214  *
 215  * @return GSList of struct sipe_buddy_info or NULL. Must be freed by caller.
 216  */
 217 struct sipe_buddy_info {    /* must be g_free()'d */
 218         const gchar *label;
 219         gchar *text;        /* must be g_free()'d */
 220 };
 221 GSList *sipe_core_buddy_info(struct sipe_core_public *sipe_public,
 222                              const gchar *name,
 223                              const gchar *status_name,
 224                              gboolean is_online);
 225
 226 void sipe_core_contact_allow_deny(struct sipe_core_public *sipe_public,
 227                                   const gchar *who, gboolean allow);
 228 void sipe_core_group_set_user(struct sipe_core_public *sipe_public,
 229                               const gchar * who);
 230
 231 /**
 232  * Setup core data
 233  */
 234 struct sipe_core_public *sipe_core_allocate(const gchar *signin_name,
 235                                             const gchar *login_domain,
 236                                             const gchar *login_account,
 237                                             const gchar *password,
 238                                             const gchar *email,
 239                                             const gchar *email_url,
 240                                             const gchar **errmsg);
 241 void sipe_core_deallocate(struct sipe_core_public *sipe_public);
 242
 243 /**
 244  * Connect to SIP server
 245  */
 246 void sipe_core_transport_sip_connect(struct sipe_core_public *sipe_public,
 247                                      guint transport,
 248                                      const gchar *server,
 249                                      const gchar *port);
 250 void sipe_core_transport_sip_keepalive(struct sipe_core_public *sipe_public);
 251
 252 /**
 253  * Invite to chat
 254  */
 255 void sipe_core_chat_invite(struct sipe_core_public *sipe_public,
 256                            struct sipe_chat_session *chat_session,
 257                            const char *name);
 258
 259 /**
 260  * Rejoin a chat after connection re-establishment
 261  */
 262 void sipe_core_chat_rejoin(struct sipe_core_public *sipe_public,
 263                            struct sipe_chat_session *chat_session);
 264
 265 /**
 266  * Leave a chat
 267  */
 268 void sipe_core_chat_leave(struct sipe_core_public *sipe_public,
 269                           struct sipe_chat_session *chat_session);
 270
 271 /**
 272  * Send message to chat
 273  */
 274 void sipe_core_chat_send(struct sipe_core_public *sipe_public,
 275                          struct sipe_chat_session *chat_session,
 276                          const char *what);
 277
 278 /**
 279  * Check chat lock status
 280  */
 281 typedef enum {
 282         SIPE_CHAT_LOCK_STATUS_NOT_ALLOWED = 0,
 283         SIPE_CHAT_LOCK_STATUS_UNLOCKED,
 284         SIPE_CHAT_LOCK_STATUS_LOCKED
 285 } sipe_chat_lock_status;
 286 sipe_chat_lock_status sipe_core_chat_lock_status(struct sipe_core_public *sipe_public,
 287                                                  struct sipe_chat_session *chat_session);
 288
 289 /**
 290  * Lock chat
 291  */
 292 void sipe_core_chat_modify_lock(struct sipe_core_public *sipe_public,
 293                                 struct sipe_chat_session *chat_session,
 294                                 const gboolean locked);
 295
 296 /* media */
 297 void sipe_core_media_initiate_call(struct sipe_core_public *sipe_public,
 298                                    const char *participant,
 299                                    gboolean with_video);
 300 /**
 301  * Connects to a conference call specified by given focus URI
 302  *
 303  * @param sipe_private (in) SIPE core data.
 304  * @param chat (in) sipe_chat structure
 305  */
 306 void sipe_core_media_connect_conference(struct sipe_core_public *sipe_public,
 307                                         struct sipe_chat_session *chat_session);
 308
 309 /**
 310  * Checks whether there is a media call in progress
 311  *
 312  * @param sipe_public (in) SIPE core data.
 313  *
 314  * @return @c TRUE if media call is in progress
 315  */
 316 gboolean sipe_core_media_in_call(struct sipe_core_public *sipe_public);
 317
 318 /* file transfer */
 319 struct sipe_file_transfer *sipe_core_ft_allocate(struct sipe_core_public *sipe_public);
 320 void sipe_core_ft_deallocate(struct sipe_file_transfer *ft);
 321 void sipe_core_ft_cancel(struct sipe_file_transfer *ft);
 322 void sipe_core_ft_incoming_init(struct sipe_file_transfer *ft);
 323 void sipe_core_ft_incoming_accept(struct sipe_file_transfer *ft,
 324                                   const gchar *who,
 325                                   unsigned short port);
 326 void sipe_core_ft_outgoing_init(struct sipe_file_transfer *ft,
 327                                 const gchar *filename, gsize size,
 328                                 const gchar *who);
 329
 330 void sipe_core_tftp_incoming_start(struct sipe_file_transfer *ft,
 331                                    gsize total_size);
 332 gboolean sipe_core_tftp_incoming_stop(struct sipe_file_transfer *ft);
 333 void sipe_core_tftp_outgoing_start(struct sipe_file_transfer *ft,
 334                                    gsize total_size);
 335 gboolean sipe_core_tftp_outgoing_stop(struct sipe_file_transfer *ft);
 336 gssize sipe_core_tftp_read(struct sipe_file_transfer *ft, guchar **buffer,
 337                            gsize bytes_remaining, gsize bytes_available);
 338 gssize sipe_core_tftp_write(struct sipe_file_transfer *ft, const guchar *buffer,
 339                             gsize size);
 340 /* group chat */
 341 gboolean sipe_core_groupchat_query_rooms(struct sipe_core_public *sipe_public);
 342 void sipe_core_groupchat_join(struct sipe_core_public *sipe_public,
 343                               const gchar *uri);
 344
 345 /* IM */
 346 void sipe_core_im_send(struct sipe_core_public *sipe_public,
 347                        const gchar *who,
 348                        const gchar *what);
 349
 350 /* user */
 351 void sipe_core_user_feedback_typing(struct sipe_core_public *sipe_public,
 352                                     const gchar *to);
 353
 354 #ifdef __cplusplus
 355 }
 356 #endif
 357
 358 /*
 359   Local Variables:
 360   mode: c
 361   c-file-style: "bsd"
 362   indent-tabs-mode: t
 363   tab-width: 8
 364   End:
 365 */