2 * @file sipe-core-private.h
6 * Copyright (C) 2010-11 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
23 /* Forward declarations */
25 struct sip_service_data
;
28 struct sipe_certificate
;
29 struct sipe_media_call_private
;
30 struct sipe_groupchat
;
34 * Private part of the Sipe data structure
36 * This part contains the information only needed by the core
38 struct sipe_account_data
; /* to be removed... */
39 struct sipe_core_private
{
41 * The public part is the first item, i.e. a pointer to the
42 * public part can also be used as a pointer to the private part.
44 struct sipe_core_public
public;
46 /* sip-transport.c private data */
47 struct sip_transport
*transport
;
48 const struct sip_service_data
*service_data
;
51 /* Account information */
55 /* SIPE protocol information */
57 gchar
*register_callid
;
59 gchar
*focus_factory_uri
;
61 GSList
*sessions_to_accept
;
63 /* [MS-SIP] deltaNum counters */
64 guint deltanum_contacts
;
65 guint deltanum_acl
; /* setACE (OCS2005 only) */
69 GSList
*our_publication_keys
;
70 GHashTable
*our_publications
;
71 GHashTable
*user_state_publications
;
77 /* Calendar and related stuff */
78 struct sipe_calendar
*calendar
;
81 * 2005 Custom XML piece
83 * Possibly set by other point of presence or just other client at
84 * earlier time. It should be preserved/modified, not overwritten.
85 * This implies subscription to self-contact. Information kept:
91 gchar
*ocs2005_user_states
;
93 /* Scheduling system */
96 /* Active subscriptions */
97 GHashTable
*subscriptions
;
100 struct sipe_media_call_private
*media_call
;
102 * Provides the necessary information on where we can obtain
103 * credentials for the A/V Edge server service.
106 gchar
*media_relay_username
;
107 gchar
*media_relay_password
;
108 GSList
*media_relays
;
111 struct sipe_groupchat
*groupchat
;
113 /* @TODO: move to purple backend when menu code moves */
114 GSList
*blist_menu_containers
;
116 /* For RCC - Remote Call Control */
117 struct sip_csta
*csta
;
119 struct sipe_dns_query
*dns_query
;
121 /* TLS-DSK: Certificates & Web services */
122 struct sipe_certificate
*certificate
;
123 struct sipe_svc
*svc
;
125 /* the original data structure*/
126 struct sipe_account_data
*temporary
;
130 * Flags - stored in sipe_core_public.flags but names not exported
132 /* server is OCS2007+ */
133 #define SIPE_CORE_PRIVATE_FLAG_OCS2007 0x80000000
134 /* we are connected from outside the enterprise network boundary
136 #define SIPE_CORE_PRIVATE_FLAG_REMOTE_USER 0x40000000
137 /* multiple points of presence detected */
138 #define SIPE_CORE_PRIVATE_FLAG_MPOP 0x20000000
139 /* if there is support for batched subscription*/
140 #define SIPE_CORE_PRIVATE_FLAG_BATCHED_SUPPORT 0x10000000
141 /* if note is out-of-office note */
142 #define SIPE_CORE_PRIVATE_FLAG_OOF_NOTE 0x08000000
143 /* whether we published our initial state or not */
144 #define SIPE_CORE_PRIVATE_FLAG_INITIAL_PUBLISH 0x04000000
145 /* whether basic access level is set or not */
146 #define SIPE_CORE_PRIVATE_FLAG_ACCESS_LEVEL_SET 0x02000000
147 /* whether subscribed to buddies presence or not */
148 #define SIPE_CORE_PRIVATE_FLAG_SUBSCRIBED_BUDDIES 0x01000000
150 #define SIPE_CORE_PUBLIC_FLAG_IS(flag) \
151 ((sipe_private->public.flags & SIPE_CORE_FLAG_ ## flag) == SIPE_CORE_FLAG_ ## flag)
152 #define SIPE_CORE_PUBLIC_FLAG_SET(flag) \
153 (sipe_private->public.flags |= SIPE_CORE_FLAG_ ## flag)
154 #define SIPE_CORE_PUBLIC_FLAG_UNSET(flag) \
155 (sipe_private->public.flags &= ~SIPE_CORE_FLAG_ ## flag)
156 #define SIPE_CORE_PRIVATE_FLAG_IS(flag) \
157 ((sipe_private->public.flags & SIPE_CORE_PRIVATE_FLAG_ ## flag) == SIPE_CORE_PRIVATE_FLAG_ ## flag)
158 #define SIPE_CORE_PRIVATE_FLAG_SET(flag) \
159 (sipe_private->public.flags |= SIPE_CORE_PRIVATE_FLAG_ ## flag)
160 #define SIPE_CORE_PRIVATE_FLAG_UNSET(flag) \
161 (sipe_private->public.flags &= ~SIPE_CORE_PRIVATE_FLAG_ ## flag)
163 /* Convenience macros */
164 #define SIPE_CORE_PRIVATE ((struct sipe_core_private *)sipe_public)
165 #define SIPE_CORE_PUBLIC ((struct sipe_core_public *)sipe_private)
167 /* Transition macros */
168 #define SIPE_ACCOUNT_DATA SIPE_CORE_PRIVATE->temporary
169 #define SIPE_ACCOUNT_DATA_PRIVATE sipe_private->temporary
172 * sipe-core internal functions
174 void sipe_core_connection_cleanup(struct sipe_core_private
*sipe_private
);