src/core/sipe.h

   1 /**
   2  * @file sipe.h
   3  *
   4  *****************************************************************************
   5  *** !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! ***
   6  ***                                                                       ***
   7  ***                      THIS INTERFACE IS DEPECRATED                     ***
   8  ***                                                                       ***
   9  ***                    DO NOT INCLUDE IT IN ANY NEW CODE                  ***
  10  ***                                                                       ***
  11  *** !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! ***
  12  *****************************************************************************
  13  *
  14  * pidgin-sipe
  15  *
  16  * Copyright (C) 2010-11 SIPE Project <http://sipe.sourceforge.net/>
  17  * Copyright (C) 2008 Novell, Inc.
  18  * Copyright (C) 2007 Anibal Avelar <avelar@gmail.com>
  19  * Copyright (C) 2005 Thomas Butter <butter@uni-mannheim.de>
  20  *
  21  * This program is free software; you can redistribute it and/or modify
  22  * it under the terms of the GNU General Public License as published by
  23  * the Free Software Foundation; either version 2 of the License, or
  24  * (at your option) any later version.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program; if not, write to the Free Software
  33  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  34  */
  35
  36 /*
  37  * Interface dependencies:
  38  *
  39  * <time.h>
  40  * <glib.h>
  41  */
  42
  43 /* Forward declarations */
  44 struct sipmsg;
  45 struct _PurpleAccount;
  46 struct _PurpleConnection;
  47 struct sipe_core_private;
  48 struct transaction;
  49 struct transaction_payload;
  50
  51 /** MS-PRES publication */
  52 struct sipe_publication {
  53         gchar *category;
  54         guint instance;
  55         guint container;
  56         guint version;
  57         /** for 'state' category */
  58         int availability;
  59         /** for 'state:calendarState' category */
  60         char *cal_event_hash;
  61         /** for 'note' category */
  62         gchar *note;
  63         /** for 'calendarData' category; 300(Team) container */
  64         char *working_hours_xml_str;
  65         char *fb_start_str;
  66         char *free_busy_base64;
  67 };
  68
  69 struct sipe_account_data {
  70         struct _PurpleConnection *gc;
  71         gchar *authdomain;
  72         gchar *authuser;
  73         gchar *password;
  74         /** Allowed server events to subscribe. From register OK response. */
  75         GSList *allow_events;
  76         struct sip_csta *csta; /* For RCC - Remote Call Control */
  77         gboolean subscribed_buddies; /* whether subscribed to buddies presence */
  78         gboolean access_level_set; /* whether basic access level set */
  79         gboolean initial_state_published; /* whether we published our initial state */
  80         GSList *our_publication_keys;           /* [MS-PRES] */
  81         GHashTable *our_publications;           /* [MS-PRES] */
  82         GHashTable *user_state_publications;    /* [MS-PRES] */
  83         int presence_method_version;
  84         time_t do_not_publish[SIPE_ACTIVITY_NUM_TYPES];
  85         gchar *status;
  86         gboolean is_oof_note;
  87         gchar *note;
  88         time_t note_since;
  89         time_t idle_switch;
  90         gboolean batched_support; /*if there is support for batched subscription*/
  91         GSList *containers; /* MS-PRES containers */
  92         struct _PurpleAccount *account;
  93         gchar *regcallid;
  94         struct sipe_calendar *cal;
  95         gchar *email;
  96         /** 2005 Custom XML piece.
  97          * Possibly set by other point of presence or just other client at earlier time.
  98          * It should be preserved/modified, not overwritten. This implies subscription
  99          * to self-contasct.
 100          * This XML keeps OC2005:
 101          * - User note
 102          * - OOF flag
 103          * - User status
 104          */
 105         gchar *user_states;
 106 };
 107
 108 /**
 109  * For 2005-
 110  */
 111 void
 112 send_presence_soap(struct sipe_core_private *sipe_private,
 113                    gboolean do_publish_calendar);
 114
 115 /**
 116  * THE BIG SPLIT - temporary interfaces
 117  *
 118  * Previously private functions in sipe.c that are
 119  *  - waiting to be factored out to an appropriate module
 120  *  - are needed by the already created new modules
 121  */
 122
 123 /* ??? module */
 124 void sipe_connection_cleanup(struct sipe_core_private *sipe_private);
 125 void sipe_buddy_free_all(struct sipe_core_private *sipe_private);
 126 #ifdef _SIPE_NEED_ACTIVITIES
 127 /* need to improve or reduce visibilty of this interface */
 128 const gchar *sipe_activity_to_token(sipe_activity);
 129 #endif
 130 void sipe_set_initial_status(struct sipe_core_private *sipe_private);
 131 void sipe_set_invisible_status(struct sipe_core_private *sipe_private);
 132 int sipe_get_availability_by_status(const gchar *sipe_status_id,
 133                                     gchar **activity_token);
 134 const gchar *sipe_get_status_by_availability(int avail,
 135                                              gchar **activity);
 136 void send_presence_status(struct sipe_core_private *sipe_private,
 137                           gpointer unused);
 138 gboolean sipe_is_user_state(struct sipe_core_private *sipe_private);
 139 void sipe_update_user_info(struct sipe_core_private *sipe_private,
 140                            const char *uri,
 141                            sipe_buddy_info_fields propkey,
 142                            char *property_value);
 143
 144 /* this should be in backend? */
 145 void sipe_backend_account_status_and_note(struct sipe_core_private *sipe_private,
 146                                           const gchar *status_id);
 147
 148 /* sipe-utils? */
 149 const gchar *sipe_get_no_sip_uri(const gchar *sip_uri);
 150
 151 /**
 152  * referenced by sipe-notify.c - start
 153  *
 154  * all of these should be moved to sipe-notify.c
 155  */
 156 void process_incoming_notify_msrtc(struct sipe_core_private *sipe_private,
 157                                    const gchar *data,
 158                                    unsigned len);
 159 void process_incoming_notify_rlmi(struct sipe_core_private *sipe_private,
 160                                   const gchar *data,
 161                                   unsigned len);
 162 void process_incoming_notify_pidf(struct sipe_core_private *sipe_private,
 163                                   const gchar *data,
 164                                   unsigned len);
 165 void sipe_sched_calendar_status_update(struct sipe_core_private *sipe_private,
 166                                        time_t calculate_from);
 167 /* referenced by sipe-notify.c - end */
 168
 169
 170 /*** THE BIG SPLIT END ***/