src/core/sipe-core-private.h

   1 /**
   2  * @file sipe-core-private.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2010-2017 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 /* Forward declarations */
  24 struct sip_address_data;
  25 struct sip_csta;
  26 struct sip_service_data;
  27 struct sip_transport;
  28 struct sipe_buddies;
  29 struct sipe_calendar;
  30 struct sipe_certificate;
  31 struct sipe_ews_autodiscover;
  32 struct sipe_groupchat;
  33 struct sipe_groups;
  34 struct sipe_http;
  35 struct sipe_http_request;
  36 struct sipe_lync_autodiscover;
  37 struct sipe_media_call_private;
  38 struct sipe_svc;
  39 struct sipe_ucs;
  40 struct sipe_webticket;
  41
  42 /**
  43  * Private part of the Sipe data structure
  44  *
  45  * This part contains the information only needed by the core
  46  */
  47 struct sipe_core_private {
  48         /**
  49          * The public part is the first item, i.e. a pointer to the
  50          * public part can also be used as a pointer to the private part.
  51          */
  52         struct sipe_core_public public;
  53
  54         /* sip-transport.c private data */
  55         struct sip_transport *transport;
  56         GSList *lync_autodiscover_servers;           /* Lync autodiscover */
  57         const struct sip_service_data *service_data; /* autodiscovery SRV records */
  58         const struct sip_address_data *address_data; /* autodiscovery A records */
  59         guint transport_type;
  60         guint authentication_type;
  61
  62         /* Account information */
  63         gchar *username;
  64         gchar *authuser;   /* NULL when SSO is enabled */
  65         gchar *password;   /* NULL when SSO is enabled */
  66         gchar *email;
  67         gchar *email_authuser;   /* NULL -> use default authentication */
  68         gchar *email_password;
  69
  70         /* SIPE protocol information */
  71         gchar *contact;
  72         gchar *register_callid;
  73         gchar *focus_factory_uri;
  74         GSList *sessions;
  75         GSList *sessions_to_accept;
  76         /* from REGISTER response: server events
  77          *  we're allowed to subscribe to
  78          */
  79         GSList *allowed_events;
  80
  81         /* Presence */
  82         gchar *status;
  83         gchar *note;
  84         time_t note_since;
  85         gboolean status_set_by_user;
  86
  87         /* [MS-SIP] deltaNum counters */
  88         guint deltanum_contacts;
  89         guint deltanum_acl;      /* setACE (OCS2005 only) */
  90
  91         /* [MS-PRES] */
  92         GSList *containers;
  93         GSList *our_publication_keys;
  94         GHashTable *our_publications;
  95         GHashTable *user_state_publications;
  96
  97         /* Buddies */
  98         struct sipe_groups *groups;
  99         struct sipe_buddies *buddies;
 100
 101         /* Calendar and related stuff */
 102         struct sipe_calendar *calendar;
 103
 104         /* EWS autodiscover */
 105         struct sipe_ews_autodiscover *ews_autodiscover;
 106
 107         /* Lync autodiscover */
 108         struct sipe_lync_autodiscover *lync_autodiscover;
 109
 110         /*
 111          * 2005 Custom XML piece
 112          *
 113          * Possibly set by other point of presence or just other client at
 114          * earlier time. It should be preserved/modified, not overwritten.
 115          * This implies subscription to self-contact. Information kept:
 116          *
 117          * - User note
 118          * - OOF flag
 119          * - User status
 120          */
 121         gchar *ocs2005_user_states;
 122
 123         /* Scheduling system */
 124         GSList *timeouts;
 125
 126         /* Active subscriptions */
 127         GHashTable *subscriptions;
 128
 129         /* Voice call */
 130         GHashTable *media_calls;
 131         gchar *test_call_bot_uri;
 132         gchar *uc_line_uri;
 133         /**
 134          *  Provides the necessary information on where we can obtain
 135          *  credentials for the A/V Edge server service.
 136          */
 137         gchar *mras_uri;
 138         gchar *media_relay_username;
 139         gchar *media_relay_password;
 140         GSList *media_relays;
 141         SipeEncryptionPolicy server_av_encryption_policy;
 142
 143         /* Group chat */
 144         struct sipe_groupchat *groupchat;
 145         gchar *persistentChatPool_uri;
 146
 147         /* buddy menu memory allocation */
 148         GSList *blist_menu_containers;
 149
 150         /* For RCC - Remote Call Control */
 151         struct sip_csta *csta;
 152
 153         struct sipe_dns_query *dns_query;
 154
 155         /* HTTP service */
 156         struct sipe_http *http;
 157
 158         /* TLS-DSK: Certificates & Web services */
 159         struct sipe_certificate *certificate;
 160         struct sipe_webticket *webticket;
 161         struct sipe_svc *svc;
 162
 163         /* Unified Contact Store */
 164         struct sipe_ucs *ucs;
 165
 166         /* [MS-DLX] server URI */
 167         gchar *dlx_uri;
 168
 169         /* Addressbook server URI */
 170         gchar *addressbook_uri;
 171
 172         /* [MS-CONFPRO] CCCP request ID counter */
 173         guint cccp_request_id;
 174
 175         guint ms_filetransfer_request_id;
 176
 177         GSList *conf_mcu_types;
 178
 179         /* Dial-in conferencing phone numbers for different regions */
 180         GHashTable *access_numbers;
 181         const gchar *default_access_number;
 182
 183         /* Port ranges to use for media connections. Zero means any port. */
 184         guint min_media_port;
 185         guint max_media_port;
 186         guint min_audio_port;
 187         guint max_audio_port;
 188         guint min_video_port;
 189         guint max_video_port;
 190         guint min_appsharing_port;
 191         guint max_appsharing_port;
 192         guint min_filetransfer_port;
 193         guint max_filetransfer_port;
 194 };
 195
 196 /**
 197  * Flags - stored in sipe_core_public.flags but names not exported
 198  */
 199 /* server is OCS2007+ */
 200 #define SIPE_CORE_PRIVATE_FLAG_OCS2007            0x80000000
 201 /* we are connected from outside the enterprise network boundary
 202  * via Edge Server */
 203 #define SIPE_CORE_PRIVATE_FLAG_REMOTE_USER        0x40000000
 204 /* multiple points of presence detected */
 205 #define SIPE_CORE_PRIVATE_FLAG_MPOP               0x20000000
 206 /* if there is support for batched subscription*/
 207 #define SIPE_CORE_PRIVATE_FLAG_BATCHED_SUPPORT    0x10000000
 208 /* if note is out-of-office note */
 209 #define SIPE_CORE_PRIVATE_FLAG_OOF_NOTE           0x08000000
 210 /* whether we published our initial state or not */
 211 #define SIPE_CORE_PRIVATE_FLAG_INITIAL_PUBLISH    0x04000000
 212 /* whether basic access level is set or not */
 213 #define SIPE_CORE_PRIVATE_FLAG_ACCESS_LEVEL_SET   0x02000000
 214 /* whether subscribed to buddies presence or not */
 215 #define SIPE_CORE_PRIVATE_FLAG_SUBSCRIBED_BUDDIES 0x01000000
 216 /* user enabled Single-Sign On */
 217 #define SIPE_CORE_PRIVATE_FLAG_SSO                0x00800000
 218 /* server is Lync 2013+ */
 219 #define SIPE_CORE_PRIVATE_FLAG_LYNC2013           0x00400000
 220 /* server is Skype for Business (RTC/6.0 +) */
 221 #define SIPE_CORE_PRIVATE_FLAG_SFB                0x00200000
 222
 223 #define SIPE_CORE_PUBLIC_FLAG_IS(flag)    \
 224         ((sipe_private->public.flags & SIPE_CORE_FLAG_ ## flag) == SIPE_CORE_FLAG_ ## flag)
 225 #define SIPE_CORE_PUBLIC_FLAG_SET(flag)   \
 226         (sipe_private->public.flags |= SIPE_CORE_FLAG_ ## flag)
 227 #define SIPE_CORE_PUBLIC_FLAG_UNSET(flag)                               \
 228         (sipe_private->public.flags &= ~SIPE_CORE_FLAG_ ## flag)
 229 #define SIPE_CORE_PRIVATE_FLAG_IS(flag)    \
 230         ((sipe_private->public.flags & SIPE_CORE_PRIVATE_FLAG_ ## flag) == SIPE_CORE_PRIVATE_FLAG_ ## flag)
 231 #define SIPE_CORE_PRIVATE_FLAG_SET(flag)   \
 232         (sipe_private->public.flags |= SIPE_CORE_PRIVATE_FLAG_ ## flag)
 233 #define SIPE_CORE_PRIVATE_FLAG_UNSET(flag)                              \
 234         (sipe_private->public.flags &= ~SIPE_CORE_PRIVATE_FLAG_ ## flag)
 235
 236 /* Convenience macros */
 237 #define SIPE_CORE_PRIVATE ((struct sipe_core_private *)sipe_public)
 238 #define SIPE_CORE_PUBLIC  ((struct sipe_core_public *)sipe_private)
 239
 240 /**
 241  * sipe-core internal functions
 242  */
 243 void sipe_core_backend_initialized(struct sipe_core_private *sipe_private,
 244                                    guint authentication);
 245 void sipe_core_connection_cleanup(struct sipe_core_private *sipe_private);
 246 void sipe_core_email_authentication(struct sipe_core_private *sipe_private,
 247                                     struct sipe_http_request *request);
 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 */