src/core/sipe-core-private.h

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