6 * Copyright (C) 2010 SIPE Project <http://sipe.sourceforge.net/>
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.
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.
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
25 * Backend -> SIPE Core API - functions called by backend code
27 ***************** !!! IMPORTANT NOTE FOR BACKEND CODERS !!! *****************
29 * The SIPE core assumes atomicity and is *NOT* thread-safe.
31 * It *does not* protect any of its data structures or code paths with locks!
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.
37 ***************** !!! IMPORTANT NOTE FOR BACKEND CODERS !!! *****************
46 * - core: maps this to OCS protocol values
47 * - backend: maps this to backend status values
51 SIPE_ACTIVITY_UNSET
= 0,
53 SIPE_ACTIVITY_INACTIVE
,
55 SIPE_ACTIVITY_BUSYIDLE
,
60 SIPE_ACTIVITY_OFFLINE
,
61 SIPE_ACTIVITY_ON_PHONE
,
62 SIPE_ACTIVITY_IN_CONF
,
63 SIPE_ACTIVITY_IN_MEETING
,
65 SIPE_ACTIVITY_URGENT_ONLY
,
66 SIPE_ACTIVITY_NUM_TYPES
72 #define SIPE_TRANSPORT_AUTO 0
73 #define SIPE_TRANSPORT_TLS 1
74 #define SIPE_TRANSPORT_TCP 2
77 * Transport connection (public part)
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.
82 * The processing function in the core can remove content from the buffer.
83 * It has to update buffer_used accordingly.
86 struct sipe_transport_connection
{
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 */
96 * Opaque data type for backend private data.
97 * The backend is responsible to allocate and free it.
99 struct sipe_backend_private
;
104 #define SIPE_CORE_FLAG_KRB5 0x00000001 /* user enabled Kerberos 5 */
105 #define SIPE_CORE_FLAG_SSO 0x00000002 /* user enabled Single-Sign On */
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)
115 * Public part of the Sipe data structure
117 * This part contains the information needed by the core and the backend.
119 struct sipe_core_public
{
121 * This points to the private data for the backend.
122 * The backend is responsible to allocate and free it.
124 struct sipe_backend_private
*backend_private
;
126 /* flags (see above) */
129 /* user information */
133 /* server information */
134 guint keepalive_timeout
;
138 * Initialize & destroy functions for the SIPE core
139 * Should be called on loading and unloading of the plugin.
141 void sipe_core_init(void);
142 void sipe_core_destroy(void);
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
);
148 /*****************************************************************************/
151 * Other functions (need to be sorted once structure becomes clear.
154 /* Get translated about string. Must be g_free'd(). */
155 gchar
*sipe_core_about(void);
157 /* Execute a scheduled action */
158 void sipe_core_schedule_execute(gpointer data
);
161 void sipe_core_update_calendar(struct sipe_core_public
*sipe_public
);
162 void sipe_core_reset_status(struct sipe_core_public
*sipe_public
);
166 * Get status text for buddy.
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.
173 * @return HTML status text for the buddy or NULL. Must be g_free()'d.
175 gchar
*sipe_core_buddy_status(struct sipe_core_public
*sipe_public
,
177 const sipe_activity activity
,
178 const gchar
*status_text
);
181 * Return a list with buddy information label/text pairs
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.
188 * @return GSList of struct sipe_buddy_info or NULL. Must be freed by caller.
190 struct sipe_buddy_info
{ /* must be g_free()'d */
192 gchar
*text
; /* must be g_free()'d */
194 GSList
*sipe_core_buddy_info(struct sipe_core_public
*sipe_public
,
196 const gchar
*status_name
,
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
,
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
,
212 const gchar
*email_url
,
213 const gchar
**errmsg
);
214 void sipe_core_deallocate(struct sipe_core_public
*sipe_public
);
217 * Connect to SIP server
219 void sipe_core_transport_sip_connect(struct sipe_core_public
*sipe_public
,
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
);
228 * DNS SRV resolved hook
231 * @param hostname SIP server hostname
232 * @param port SIP server port
234 void sipe_core_dns_resolved(struct sipe_core_public
*sipe_public
,
235 const gchar
*hostname
,
237 void sipe_core_dns_resolve_failure(struct sipe_core_public
*sipe_public
);
242 void sipe_core_chat_create(struct sipe_core_public
*sipe_public
, int id
,