src/core/sipe-core-private.h

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