src/core/sipe-cal.h

   1 /**
   2  * @file sipe-cal.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2010 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_xml;
  28
  29 /* Calendar statuses */
  30 #define SIPE_CAL_FREE       0
  31 #define SIPE_CAL_TENTATIVE  1
  32 #define SIPE_CAL_BUSY       2
  33 #define SIPE_CAL_OOF        3
  34 #define SIPE_CAL_NO_DATA    4
  35
  36 /* Default granularity of FreeBusy data is 15 minutes */
  37 #define SIPE_FREE_BUSY_GRANULARITY_SEC  (15*60)
  38 /* FreeBusy stream duration in seconds. Defaults to 4 days */
  39 #define SIPE_FREE_BUSY_PERIOD_SEC       (4*(24*60*60))
  40
  41 struct sipe_cal_event {
  42         time_t start_time;
  43         time_t end_time;
  44         /* SIPE_CAL_* */
  45         int cal_status;
  46         char *subject;
  47         char *location;
  48         int is_meeting;
  49 };
  50
  51 /** For extracting our Calendar information from
  52   * external sources like Exchange, Lotus Domino.
  53   */
  54 struct sipe_calendar {
  55         struct sipe_core_private *sipe_private;
  56
  57         int state;
  58         char *email;
  59         char *legacy_dn;
  60         HttpConnAuth *auth;
  61         int auto_disco_method;
  62         int is_ews_disabled;
  63         int is_domino_disabled;
  64         int is_updated;
  65
  66         char *as_url;
  67         char *oof_url;
  68         char *oab_url;
  69         char *domino_url;
  70
  71         char *oof_state; /* Enabled, Disabled, Scheduled */
  72         char *oof_note;
  73         time_t oof_start;
  74         time_t oof_end;
  75         time_t updated;
  76         gboolean published;
  77
  78         HttpSession *http_session;
  79         HttpConn *http_conn;
  80
  81         time_t fb_start;
  82         /* hex form */
  83         char *free_busy;
  84         char *working_hours_xml_str;
  85         GSList *cal_events;
  86 };
  87
  88 void
  89 sipe_cal_event_free(struct sipe_cal_event* cal_event);
  90
  91 void
  92 sipe_cal_events_free(GSList *cal_events);
  93
  94 void
  95 sipe_cal_calendar_free(struct sipe_calendar *cal);
  96
  97 gboolean
  98 sipe_cal_calendar_init(struct sipe_core_private *sipe_private,
  99                        gboolean *has_url);
 100
 101 /**
 102  * Returns hash of Calendar Event for comparison.
 103  *
 104  * Must be g_free()'d after use.
 105  */
 106 char *
 107 sipe_cal_event_hash(struct sipe_cal_event* event);
 108
 109 /**
 110  * Describes Calendar event in human readable form.
 111  *
 112  * Must be g_free()'d after use.
 113  */
 114 char *
 115 sipe_cal_event_describe(struct sipe_cal_event* cal_event);
 116
 117 /**
 118  * Converts struct tm to Epoch time_t considering timezone.
 119  *
 120  * @param tz as defined for TZ environment variable.
 121  *
 122  * Reference: see timegm(3) - Linux man page
 123  */
 124 time_t
 125 sipe_mktime_tz(struct tm *tm,
 126                const char* tz);
 127
 128 /**
 129  * Converts hex representation of freebusy string as
 130  * returned by Exchange Web Services to
 131  * condenced and base64 encoded form
 132  *
 133  * Must be g_free()'d after use.
 134  */
 135 char *
 136 sipe_cal_get_freebusy_base64(const char* freebusy_hex);
 137
 138 /** Contains buddy's working hours information */
 139 struct sipe_cal_working_hours;
 140
 141 /**
 142  * Parses Working Hours from passed XML piece
 143  * and creates/fills struct sipe_cal_working_hours in struct sipe_buddy
 144  */
 145 void
 146 sipe_cal_parse_working_hours(const struct _sipe_xml *xn_working_hours,
 147                              struct sipe_buddy *buddy);
 148
 149 /**
 150  * Frees struct sipe_cal_working_hours
 151  */
 152 void
 153 sipe_cal_free_working_hours(struct sipe_cal_working_hours *wh);
 154
 155 /**
 156  * Returns user calendar information in text form.
 157  * Example: "Currently Busy. Free at 13:00"
 158  */
 159 char *
 160 sipe_cal_get_description(struct sipe_buddy *buddy);
 161
 162 /**
 163  * Returns calendar status SIPE_CAL_* at time specified.
 164  * Returns SIPE_CAL_NO_DATA if no calendar data availible.
 165  *
 166  * @param since (out)   Returns beginning time of the status.
 167  */
 168 int
 169 sipe_cal_get_status(struct sipe_buddy *buddy,
 170                     time_t time_in_question,
 171                     time_t *since);
 172
 173 /**
 174  * Returns calendar event at time in question.
 175  * If conflict, takes last event in the following
 176  * priority order: OOF, Busy, Tentative.
 177  */
 178 struct sipe_cal_event*
 179 sipe_cal_get_event(GSList *cal_events,
 180                    time_t time_in_question);