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_core_private {
  39         /**
  40          * The public part is the first item, i.e. a pointer to the
  41          * public part can also be used as a pointer to the private part.
  42          */
  43         struct sipe_core_public public;
  44
  45         /* sip-transport.c private data */
  46         struct sip_transport *transport;
  47         const struct sip_service_data *service_data;
  48         guint transport_type;
  49
  50         /* Account information */
  51         gchar *username;
  52         gchar *authdomain;
  53         gchar *authuser;
  54         gchar *password;
  55         gchar *email;
  56
  57         /* SIPE protocol information */
  58         gchar *contact;
  59         gchar *register_callid;
  60         gchar *epid;
  61         gchar *focus_factory_uri;
  62         GSList *sessions;
  63         GSList *sessions_to_accept;
  64         /* from REGISTER response: server events
  65          *  we're allowed to subscribe to
  66          */
  67         GSList *allowed_events;
  68
  69         /* Presence */
  70         gchar *status;
  71         gchar *note;
  72         time_t note_since;
  73         time_t idle_switch;
  74         time_t do_not_publish[SIPE_ACTIVITY_NUM_TYPES];
  75
  76         /* [MS-SIP] deltaNum counters */
  77         guint deltanum_contacts;
  78         guint deltanum_acl;      /* setACE (OCS2005 only) */
  79
  80         /* [MS-PRES] */
  81         GSList *containers;
  82         GSList *our_publication_keys;
  83         GHashTable *our_publications;
  84         GHashTable *user_state_publications;
  85
  86         /* Buddies */
  87         GSList *groups;
  88         GHashTable *buddies;
  89
  90         /* Calendar and related stuff */
  91         struct sipe_calendar *calendar;
  92
  93         /*
  94          * 2005 Custom XML piece
  95          *
  96          * Possibly set by other point of presence or just other client at
  97          * earlier time. It should be preserved/modified, not overwritten.
  98          * This implies subscription to self-contact. Information kept:
  99          *
 100          * - User note
 101          * - OOF flag
 102          * - User status
 103          */
 104         gchar *ocs2005_user_states;
 105
 106         /* Scheduling system */
 107         GSList *timeouts;
 108
 109         /* Active subscriptions */
 110         GHashTable *subscriptions;
 111
 112         /* Voice call */
 113         struct sipe_media_call_private *media_call;
 114         gchar *test_call_bot_uri;
 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         /* buddy menu memory allocation */
 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         /* [MS-DLX] server URI */
 140         gchar *dlx_uri;
 141
 142         /* Addressbook server URI */
 143         gchar *addressbook_uri;
 144 };
 145
 146 /**
 147  * Flags - stored in sipe_core_public.flags but names not exported
 148  */
 149 /* server is OCS2007+ */
 150 #define SIPE_CORE_PRIVATE_FLAG_OCS2007            0x80000000
 151 /* we are connected from outside the enterprise network boundary
 152  * via Edge Server */
 153 #define SIPE_CORE_PRIVATE_FLAG_REMOTE_USER        0x40000000
 154 /* multiple points of presence detected */
 155 #define SIPE_CORE_PRIVATE_FLAG_MPOP               0x20000000
 156 /* if there is support for batched subscription*/
 157 #define SIPE_CORE_PRIVATE_FLAG_BATCHED_SUPPORT    0x10000000
 158 /* if note is out-of-office note */
 159 #define SIPE_CORE_PRIVATE_FLAG_OOF_NOTE           0x08000000
 160 /* whether we published our initial state or not */
 161 #define SIPE_CORE_PRIVATE_FLAG_INITIAL_PUBLISH    0x04000000
 162 /* whether basic access level is set or not */
 163 #define SIPE_CORE_PRIVATE_FLAG_ACCESS_LEVEL_SET   0x02000000
 164 /* whether subscribed to buddies presence or not */
 165 #define SIPE_CORE_PRIVATE_FLAG_SUBSCRIBED_BUDDIES 0x01000000
 166
 167 #define SIPE_CORE_PUBLIC_FLAG_IS(flag)    \
 168         ((sipe_private->public.flags & SIPE_CORE_FLAG_ ## flag) == SIPE_CORE_FLAG_ ## flag)
 169 #define SIPE_CORE_PUBLIC_FLAG_SET(flag)   \
 170         (sipe_private->public.flags |= SIPE_CORE_FLAG_ ## flag)
 171 #define SIPE_CORE_PUBLIC_FLAG_UNSET(flag)                               \
 172         (sipe_private->public.flags &= ~SIPE_CORE_FLAG_ ## flag)
 173 #define SIPE_CORE_PRIVATE_FLAG_IS(flag)    \
 174         ((sipe_private->public.flags & SIPE_CORE_PRIVATE_FLAG_ ## flag) == SIPE_CORE_PRIVATE_FLAG_ ## flag)
 175 #define SIPE_CORE_PRIVATE_FLAG_SET(flag)   \
 176         (sipe_private->public.flags |= SIPE_CORE_PRIVATE_FLAG_ ## flag)
 177 #define SIPE_CORE_PRIVATE_FLAG_UNSET(flag)                              \
 178         (sipe_private->public.flags &= ~SIPE_CORE_PRIVATE_FLAG_ ## flag)
 179
 180 /* Convenience macros */
 181 #define SIPE_CORE_PRIVATE ((struct sipe_core_private *)sipe_public)
 182 #define SIPE_CORE_PUBLIC  ((struct sipe_core_public *)sipe_private)
 183
 184 /**
 185  * sipe-core internal functions
 186  */
 187 void sipe_core_connection_cleanup(struct sipe_core_private *sipe_private);
 188
 189 /*
 190   Local Variables:
 191   mode: c
 192   c-file-style: "bsd"
 193   indent-tabs-mode: t
 194   tab-width: 8
 195   End:
 196 */