src/api/sipe-core.h

   1 /**
   2  * @file sipe-core.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2010 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 backend private data.
  97  * The backend is responsible to allocate and free it.
  98  */
  99 struct sipe_backend_private;
 100
 101 /**
 102  * Flags
 103  */
 104 #define SIPE_CORE_FLAG_KRB5 0x00000001 /* user enabled Kerberos 5     */
 105 #define SIPE_CORE_FLAG_SSO  0x00000002 /* user enabled Single-Sign On */
 106
 107 #define SIPE_CORE_FLAG_IS(flag)    \
 108         ((sipe_public->flags & SIPE_CORE_FLAG_ ## flag) == SIPE_CORE_FLAG_ ## flag)
 109 #define SIPE_CORE_FLAG_SET(flag)   \
 110         (sipe_public->flags |= SIPE_CORE_FLAG_ ## flag)
 111 #define SIPE_CORE_FLAG_UNSET(flag) \
 112         (sipe_public->flags &= ~SIPE_CORE_FLAG_ ## flag)
 113
 114 /**
 115  * Public part of the Sipe data structure
 116  *
 117  * This part contains the information needed by the core and the backend.
 118  */
 119 struct sipe_core_public {
 120         /**
 121          * This points to the private data for the backend.
 122          * The backend is responsible to allocate and free it.
 123          */
 124         struct sipe_backend_private *backend_private;
 125
 126         /* flags (see above) */
 127         guint32 flags;
 128
 129         /* user information */
 130         gchar *sip_name;
 131         gchar *sip_domain;
 132
 133         /* server information */
 134         guint keepalive_timeout;
 135 };
 136
 137 /**
 138  * Initialize & destroy functions for the SIPE core
 139  * Should be called on loading and unloading of the plugin.
 140  */
 141 void sipe_core_init(void);
 142 void sipe_core_destroy(void);
 143
 144 /** Utility functions exported by the core to backends ***********************/
 145 gboolean sipe_strequal(const gchar *left, const gchar *right);
 146 char *fix_newlines(const char *st);
 147
 148 /*****************************************************************************/
 149
 150 /**
 151  * Other functions (need to be sorted once structure becomes clear.
 152  */
 153
 154 /* Get translated about string. Must be g_free'd(). */
 155 gchar *sipe_core_about(void);
 156
 157 /* Execute a scheduled action */
 158 void sipe_core_schedule_execute(gpointer data);
 159
 160 /* menu actions */
 161 void sipe_core_update_calendar(struct sipe_core_public *sipe_public);
 162 void sipe_core_reset_status(struct sipe_core_public *sipe_public);
 163
 164 /* buddy actions */
 165 /**
 166  * Get status text for buddy.
 167  *
 168  * @param sipe_public Sipe core public data structure.
 169  * @param name        backend-specific buddy name.
 170  * @param activity    activity value for buddy
 171  * @param status_text backend-specific buddy status text for activity.
 172  *
 173  * @return HTML status text for the buddy or NULL. Must be g_free()'d.
 174  */
 175 gchar *sipe_core_buddy_status(struct sipe_core_public *sipe_public,
 176                               const gchar *name,
 177                               const sipe_activity activity,
 178                               const gchar *status_text);
 179
 180 /**
 181  * Return a list with buddy information label/text pairs
 182  *
 183  * @param sipe_public Sipe core public data structure.
 184  * @param name        backend-specific buddy name.
 185  * @param status_text backend-specific buddy status text for ID.
 186  * @param is_online   backend considers buddy to be online.
 187  *
 188  * @return GSList of struct sipe_buddy_info or NULL. Must be freed by caller.
 189  */
 190 struct sipe_buddy_info {    /* must be g_free()'d */
 191         const gchar *label;
 192         gchar *text;        /* must be g_free()'d */
 193 };
 194 GSList *sipe_core_buddy_info(struct sipe_core_public *sipe_public,
 195                              const gchar *name,
 196                              const gchar *status_name,
 197                              gboolean is_online);
 198
 199 void sipe_core_contact_allow_deny(struct sipe_core_public *sipe_public,
 200                                   const gchar *who, gboolean allow);
 201 void sipe_core_group_set_user(struct sipe_core_public *sipe_public,
 202                               const gchar * who);
 203
 204 /**
 205  * Setup core data
 206  */
 207 struct sipe_core_public *sipe_core_allocate(const gchar *signin_name,
 208                                             const gchar *login_domain,
 209                                             const gchar *login_account,
 210                                             const gchar *password,
 211                                             const gchar *email,
 212                                             const gchar *email_url,
 213                                             const gchar **errmsg);
 214 void sipe_core_deallocate(struct sipe_core_public *sipe_public);
 215
 216 /**
 217  * Connect to SIP server
 218  */
 219 void sipe_core_transport_sip_connect(struct sipe_core_public *sipe_public,
 220                                      guint transport,
 221                                      const gchar *server,
 222                                      const gchar *port);
 223 void sipe_core_transport_sip_raw(struct sipe_core_public *sipe_public,
 224                                  const gchar *buffer);
 225 void sipe_core_transport_sip_keepalive(struct sipe_core_public *sipe_public);
 226
 227 /**
 228  * DNS SRV resolved hook
 229  *
 230  * @param sipe_public
 231  * @param hostname    SIP server hostname
 232  * @param port        SIP server port
 233  */
 234 void sipe_core_dns_resolved(struct sipe_core_public *sipe_public,
 235                             const gchar *hostname,
 236                             guint port);
 237 void sipe_core_dns_resolve_failure(struct sipe_core_public *sipe_public);
 238
 239 /**
 240  * Create a new chat
 241  */
 242 void sipe_core_chat_create(struct sipe_core_public *sipe_public, int id,
 243                            const char *name);
 244
 245 #ifdef __cplusplus
 246 }
 247 #endif
 248
 249 /*
 250   Local Variables:
 251   mode: c
 252   c-file-style: "bsd"
 253   indent-tabs-mode: t
 254   tab-width: 8
 255   End:
 256 */