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