src/core/sipe-core-private.h

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