src/core/sipe-cal.h

   1 /**
   2  * @file sipe-cal.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2010-2013 SIPE Project <http://sipe.sourceforge.net/>
   7  * Copyright (C) 2009 pier11 <pier11@operamail.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  */
  23
  24 /* Forward declarations */
  25 struct sipe_buddy;
  26 struct sipe_core_private;
  27 struct sipe_http_request;
  28 struct sipe_http_session;
  29 struct _sipe_xml;
  30
  31 /* Calendar statuses */
  32 #define SIPE_CAL_FREE       0
  33 #define SIPE_CAL_TENTATIVE  1
  34 #define SIPE_CAL_BUSY       2
  35 #define SIPE_CAL_OOF        3
  36 #define SIPE_CAL_NO_DATA    4
  37
  38 /* Default granularity of FreeBusy data is 15 minutes */
  39 #define SIPE_FREE_BUSY_GRANULARITY_SEC  (15*60)
  40 /* FreeBusy stream duration in seconds. Defaults to 4 days */
  41 #define SIPE_FREE_BUSY_PERIOD_SEC       (4*(24*60*60))
  42
  43 struct sipe_cal_event {
  44         time_t start_time;
  45         time_t end_time;
  46         /* SIPE_CAL_* */
  47         int cal_status;
  48         char *subject;
  49         char *location;
  50         int is_meeting;
  51 };
  52
  53 /** For extracting our Calendar information from
  54   * external sources like Exchange, Lotus Domino.
  55   */
  56 struct sipe_calendar {
  57         struct sipe_core_private *sipe_private;
  58
  59         int state;
  60         char *email;
  61         char *legacy_dn;
  62         int auto_disco_method;
  63         int is_ews_disabled;
  64         int is_domino_disabled;
  65         int is_updated;
  66
  67         char *as_url;
  68         char *oof_url;
  69         char *oab_url;
  70         char *domino_url;
  71
  72         char *oof_state; /* Enabled, Disabled, Scheduled */
  73         char *oof_note;
  74         time_t oof_start;
  75         time_t oof_end;
  76         time_t updated;
  77         gboolean published;
  78
  79         struct sipe_http_session *session;
  80         struct sipe_http_request *request;
  81         gchar *auth_domain;
  82         gchar *auth_user; /* NULL -> use default authentication */
  83         gchar *password;
  84
  85         time_t fb_start;
  86         /* hex form */
  87         char *free_busy;
  88         char *working_hours_xml_str;
  89         GSList *cal_events;
  90 };
  91
  92 void
  93 sipe_cal_event_free(struct sipe_cal_event* cal_event);
  94
  95 void
  96 sipe_cal_events_free(GSList *cal_events);
  97
  98 void
  99 sipe_cal_calendar_free(struct sipe_calendar *cal);
 100
 101 gboolean
 102 sipe_cal_calendar_init(struct sipe_core_private *sipe_private,
 103                        gboolean *has_url);
 104
 105 /**
 106  * Returns hash of Calendar Event for comparison.
 107  *
 108  * Must be g_free()'d after use.
 109  */
 110 char *
 111 sipe_cal_event_hash(struct sipe_cal_event* event);
 112
 113 /**
 114  * Describes Calendar event in human readable form.
 115  *
 116  * Must be g_free()'d after use.
 117  */
 118 char *
 119 sipe_cal_event_describe(struct sipe_cal_event* cal_event);
 120
 121 /**
 122  * Converts struct tm to Epoch time_t considering timezone.
 123  *
 124  * @param tz as defined for TZ environment variable.
 125  *
 126  * Reference: see timegm(3) - Linux man page
 127  */
 128 time_t
 129 sipe_mktime_tz(struct tm *tm,
 130                const char* tz);
 131
 132 /**
 133  * Converts hex representation of freebusy string as
 134  * returned by Exchange Web Services to
 135  * condenced and base64 encoded form
 136  *
 137  * Must be g_free()'d after use.
 138  */
 139 char *
 140 sipe_cal_get_freebusy_base64(const char* freebusy_hex);
 141
 142 /** Contains buddy's working hours information */
 143 struct sipe_cal_working_hours;
 144
 145 /**
 146  * Parses Working Hours from passed XML piece
 147  * and creates/fills struct sipe_cal_working_hours in struct sipe_buddy
 148  */
 149 void
 150 sipe_cal_parse_working_hours(const struct _sipe_xml *xn_working_hours,
 151                              struct sipe_buddy *buddy);
 152
 153 /**
 154  * Frees struct sipe_cal_working_hours
 155  */
 156 void
 157 sipe_cal_free_working_hours(struct sipe_cal_working_hours *wh);
 158
 159 /**
 160  * Returns user calendar information in text form.
 161  * Example: "Currently Busy. Free at 13:00"
 162  */
 163 char *
 164 sipe_cal_get_description(struct sipe_buddy *buddy);
 165
 166 /**
 167  * Returns calendar status SIPE_CAL_* at time specified.
 168  * Returns SIPE_CAL_NO_DATA if no calendar data availible.
 169  *
 170  * @param since (out)   Returns beginning time of the status.
 171  */
 172 int
 173 sipe_cal_get_status(struct sipe_buddy *buddy,
 174                     time_t time_in_question,
 175                     time_t *since);
 176
 177 /**
 178  * Returns calendar event at time in question.
 179  * If conflict, takes last event in the following
 180  * priority order: OOF, Busy, Tentative.
 181  */
 182 struct sipe_cal_event*
 183 sipe_cal_get_event(GSList *cal_events,
 184                    time_t time_in_question);
 185
 186 /**
 187  * Publish presence information
 188  */
 189 void sipe_cal_presence_publish(struct sipe_core_private *sipe_private,
 190                                gboolean do_publish_calendar);
 191
 192 /**
 193  * Schedule calendar update
 194  */
 195 void sipe_cal_delayed_calendar_update(struct sipe_core_private *sipe_private);
 196
 197 /**
 198  * Set authentication for HTTP request
 199  */
 200 void sipe_cal_http_authentication(struct sipe_calendar *cal);