6 * Copyright (C) 2011 SIPE Project <http://sipe.sourceforge.net/>
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.
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.
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
24 * OCS2005 specific code
32 #include "sipe-common.h"
34 #include "sipe-backend.h"
35 #include "sipe-buddy.h"
37 #include "sipe-core.h"
38 #include "sipe-core-private.h"
40 #include "sipe-ocs2005.h"
41 #include "sipe-ocs2007.h"
42 #include "sipe-schedule.h"
43 #include "sipe-status.h"
44 #include "sipe-utils.h"
48 * 2005-style Activity and Availability.
52 * @param activity 2005 aggregated activity. Ex.: 600
53 * @param availablity 2005 aggregated availablity. Ex.: 300
55 * The values define the starting point of a range
57 #define SIPE_OCS2005_ACTIVITY_UNKNOWN 0
58 #define SIPE_OCS2005_ACTIVITY_AWAY 100
59 #define SIPE_OCS2005_ACTIVITY_LUNCH 150
60 #define SIPE_OCS2005_ACTIVITY_IDLE 200
61 #define SIPE_OCS2005_ACTIVITY_BRB 300
62 #define SIPE_OCS2005_ACTIVITY_AVAILABLE 400 /* user is active */
63 #define SIPE_OCS2005_ACTIVITY_ON_PHONE 500 /* user is participating in a communcation session */
64 #define SIPE_OCS2005_ACTIVITY_BUSY 600
65 #define SIPE_OCS2005_ACTIVITY_AWAY2 700
66 #define SIPE_OCS2005_ACTIVITY_AVAILABLE2 800
68 #define SIPE_OCS2005_AVAILABILITY_OFFLINE 0
69 #define SIPE_OCS2005_AVAILABILITY_MAYBE 100
70 #define SIPE_OCS2005_AVAILABILITY_ONLINE 300
71 static guint
sipe_ocs2005_activity_from_status(struct sipe_core_private
*sipe_private
)
73 const gchar
*status
= sipe_private
->status
;
75 if (sipe_strequal(status
, sipe_status_activity_to_token(SIPE_ACTIVITY_AWAY
))) {
76 return(SIPE_OCS2005_ACTIVITY_AWAY
);
77 /*} else if (sipe_strequal(status, sipe_status_activity_to_token(SIPE_ACTIVITY_LUNCH))) {
78 return(SIPE_OCS2005_ACTIVITY_LUNCH); */
79 } else if (sipe_strequal(status
, sipe_status_activity_to_token(SIPE_ACTIVITY_BRB
))) {
80 return(SIPE_OCS2005_ACTIVITY_BRB
);
81 } else if (sipe_strequal(status
, sipe_status_activity_to_token(SIPE_ACTIVITY_AVAILABLE
))) {
82 return(SIPE_OCS2005_ACTIVITY_AVAILABLE
);
83 /*} else if (sipe_strequal(status, sipe_status_activity_to_token(SIPE_ACTIVITY_ON_PHONE))) {
84 return(SIPE_OCS2005_ACTIVITY_ON_PHONE); */
85 } else if (sipe_strequal(status
, sipe_status_activity_to_token(SIPE_ACTIVITY_BUSY
)) ||
86 sipe_strequal(status
, sipe_status_activity_to_token(SIPE_ACTIVITY_DND
))) {
87 return(SIPE_OCS2005_ACTIVITY_BUSY
);
88 } else if (sipe_strequal(status
, sipe_status_activity_to_token(SIPE_ACTIVITY_INVISIBLE
)) ||
89 sipe_strequal(status
, sipe_status_activity_to_token(SIPE_ACTIVITY_OFFLINE
))) {
90 return(SIPE_OCS2005_ACTIVITY_AWAY
);
92 return(SIPE_OCS2005_ACTIVITY_AVAILABLE
);
96 static guint
sipe_ocs2005_availability_from_status(struct sipe_core_private
*sipe_private
)
98 const gchar
*status
= sipe_private
->status
;
100 if (sipe_strequal(status
, sipe_status_activity_to_token(SIPE_ACTIVITY_INVISIBLE
)) ||
101 sipe_strequal(status
, sipe_status_activity_to_token(SIPE_ACTIVITY_OFFLINE
)))
102 return(SIPE_OCS2005_AVAILABILITY_OFFLINE
);
104 return(SIPE_OCS2005_AVAILABILITY_ONLINE
);
107 const gchar
*sipe_ocs2005_status_from_activity_availability(guint activity
,
112 if (availability
< SIPE_OCS2005_AVAILABILITY_MAYBE
) {
113 type
= SIPE_ACTIVITY_OFFLINE
;
114 } else if (activity
< SIPE_OCS2005_ACTIVITY_LUNCH
) {
115 type
= SIPE_ACTIVITY_AWAY
;
116 } else if (activity
< SIPE_OCS2005_ACTIVITY_IDLE
) {
117 //type = SIPE_ACTIVITY_LUNCH;
118 type
= SIPE_ACTIVITY_AWAY
;
119 } else if (activity
< SIPE_OCS2005_ACTIVITY_BRB
) {
120 //type = SIPE_ACTIVITY_IDLE;
121 type
= SIPE_ACTIVITY_AWAY
;
122 } else if (activity
< SIPE_OCS2005_ACTIVITY_AVAILABLE
) {
123 type
= SIPE_ACTIVITY_BRB
;
124 } else if (activity
< SIPE_OCS2005_ACTIVITY_ON_PHONE
) {
125 type
= SIPE_ACTIVITY_AVAILABLE
;
126 } else if (activity
< SIPE_OCS2005_ACTIVITY_BUSY
) {
127 //type = SIPE_ACTIVITY_ON_PHONE;
128 type
= SIPE_ACTIVITY_BUSY
;
129 } else if (activity
< SIPE_OCS2005_ACTIVITY_AWAY2
) {
130 type
= SIPE_ACTIVITY_BUSY
;
131 } else if (activity
< SIPE_OCS2005_ACTIVITY_AVAILABLE2
) {
132 type
= SIPE_ACTIVITY_AWAY
;
134 type
= SIPE_ACTIVITY_AVAILABLE
;
137 return(sipe_status_activity_to_token(type
));
140 const gchar
*sipe_ocs2005_activity_description(guint activity
)
142 if ((activity
>= SIPE_OCS2005_ACTIVITY_LUNCH
) &&
143 (activity
< SIPE_OCS2005_ACTIVITY_IDLE
)) {
144 return(sipe_core_activity_description(SIPE_ACTIVITY_LUNCH
));
145 } else if ((activity
>= SIPE_OCS2005_ACTIVITY_IDLE
) &&
146 (activity
< SIPE_OCS2005_ACTIVITY_BRB
)) {
147 return(sipe_core_activity_description(SIPE_ACTIVITY_INACTIVE
));
148 } else if ((activity
>= SIPE_OCS2005_ACTIVITY_ON_PHONE
) &&
149 (activity
< SIPE_OCS2005_ACTIVITY_BUSY
)) {
150 return(sipe_core_activity_description(SIPE_ACTIVITY_ON_PHONE
));
156 void sipe_ocs2005_user_info_has_updated(struct sipe_core_private
*sipe_private
,
157 const sipe_xml
*xn_userinfo
)
159 const sipe_xml
*xn_states
;
161 g_free(sipe_private
->ocs2005_user_states
);
162 sipe_private
->ocs2005_user_states
= NULL
;
163 if ((xn_states
= sipe_xml_child(xn_userinfo
, "states")) != NULL
) {
164 gchar
*orig
= sipe_private
->ocs2005_user_states
= sipe_xml_stringify(xn_states
);
166 /* this is a hack-around to remove added newline after inner element,
167 * state in this case, where it shouldn't be.
168 * After several use of sipe_xml_stringify, amount of added newlines
169 * grows significantly.
172 gchar c
, *stripped
= orig
;
173 while ((c
= *orig
++)) {
174 if ((c
!= '\n') /* && (c != '\r') */) {
182 /* Publish initial state if not yet.
183 * Assuming this happens on initial responce to self subscription
184 * so we've already updated our UserInfo.
186 if (!SIPE_CORE_PRIVATE_FLAG_IS(INITIAL_PUBLISH
)) {
187 sipe_ocs2005_presence_publish(sipe_private
, FALSE
);
189 sipe_cal_delayed_calendar_update(sipe_private
);
193 static gboolean
sipe_is_user_available(struct sipe_core_private
*sipe_private
)
195 return(sipe_strequal(sipe_private
->status
,
196 sipe_status_activity_to_token(SIPE_ACTIVITY_AVAILABLE
)));
201 * OCS2005 presence XML messages
203 * Calendar publication entry
205 * @param legacy_dn (%s) Ex.: /o=EXCHANGE/ou=BTUK02/cn=Recipients/cn=AHHBTT
206 * @param fb_start_time_str (%s) Ex.: 2009-12-06T17:15:00Z
207 * @param free_busy_base64 (%s) Ex.: AAAAAAAAAAAAAAAAA......
209 #define SIPE_SOAP_SET_PRESENCE_CALENDAR \
210 "<calendarInfo xmlns=\"http://schemas.microsoft.com/2002/09/sip/presence\" mailboxId=\"%s\" startTime=\"%s\" granularity=\"PT15M\">%s</calendarInfo>"
213 * Note publication entry
215 * @param note (%s) Ex.: Working from home
217 #define SIPE_SOAP_SET_PRESENCE_NOTE_XML "<note>%s</note>"
220 * Note's OOF publication entry
222 #define SIPE_SOAP_SET_PRESENCE_OOF_XML "<oof></oof>"
225 * States publication entry for User State
227 * @param avail (%d) Availability 2007-style. Ex.: 9500
228 * @param since_time_str (%s) Ex.: 2010-01-13T10:30:05Z
229 * @param device_id (%s) epid. Ex.: 4c77e6ec72
230 * @param activity_token (%s) Ex.: do-not-disturb
232 #define SIPE_SOAP_SET_PRESENCE_STATES \
234 "<state avail=\"%d\" since=\"%s\" validWith=\"any-device\" deviceId=\"%s\" set=\"manual\" xsi:type=\"userState\">%s</state>"\
238 * Presentity publication entry.
240 * @param uri (%s) SIP URI without 'sip:' prefix. Ex.: fox@atlanta.local
241 * @param aggr_availability (%d) Ex.: 300
242 * @param aggr_activity (%d) Ex.: 600
243 * @param host_name (%s) Uppercased. Ex.: ATLANTA
244 * @param note_xml_str (%s) XML string as SIPE_SOAP_SET_PRESENCE_NOTE_XML
245 * @param oof_xml_str (%s) XML string as SIPE_SOAP_SET_PRESENCE_OOF_XML
246 * @param states_xml_str (%s) XML string as SIPE_SOAP_SET_PRESENCE_STATES
247 * @param calendar_info_xml_str (%s) XML string as SIPE_SOAP_SET_PRESENCE_CALENDAR
248 * @param device_id (%s) epid. Ex.: 4c77e6ec72
249 * @param since_time_str (%s) Ex.: 2010-01-13T10:30:05Z
250 * @param since_time_str (%s) Ex.: 2010-01-13T10:30:05Z
251 * @param user_input (%s) active, idle
253 #define SIPE_SOAP_SET_PRESENCE \
255 " xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\"" \
256 " xmlns:m=\"http://schemas.microsoft.com/winrtc/2002/11/sip\"" \
260 "<m:presentity xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" m:uri=\"sip:%s\">"\
261 "<m:availability m:aggregate=\"%d\"/>"\
262 "<m:activity m:aggregate=\"%d\"/>"\
263 "<deviceName xmlns=\"http://schemas.microsoft.com/2002/09/sip/presence\" name=\"%s\"/>"\
264 "<rtc:devicedata xmlns:rtc=\"http://schemas.microsoft.com/winrtc/2002/11/sip\" namespace=\"rtcService\">"\
265 "<![CDATA[<caps><renders_gif/><renders_isf/></caps>]]></rtc:devicedata>"\
266 "<userInfo xmlns=\"http://schemas.microsoft.com/2002/09/sip/presence\">"\
271 "<device xmlns=\"http://schemas.microsoft.com/2002/09/sip/presence\" deviceId=\"%s\" since=\"%s\" >"\
272 "<userInput since=\"%s\" >%s</userInput>"\
279 static void send_presence_soap(struct sipe_core_private
*sipe_private
,
280 gboolean do_publish_calendar
,
281 gboolean do_reset_status
)
283 struct sipe_calendar
* cal
= sipe_private
->calendar
;
287 gchar
*res_note
= NULL
;
288 gchar
*res_oof
= NULL
;
289 const gchar
*note_pub
= NULL
;
290 gchar
*states
= NULL
;
291 gchar
*calendar_data
= NULL
;
292 gchar
*epid
= get_epid(sipe_private
);
293 gchar
*from
= sip_uri_self(sipe_private
);
294 time_t now
= time(NULL
);
295 gchar
*since_time_str
= sipe_utils_time_to_str(now
);
296 const gchar
*oof_note
= cal
? sipe_ews_get_oof_note(cal
) : NULL
;
297 const char *user_input
;
298 gboolean pub_oof
= cal
&& oof_note
&& (!sipe_private
->note
|| cal
->updated
> sipe_private
->note_since
);
300 if (oof_note
&& sipe_private
->note
) {
301 SIPE_DEBUG_INFO("cal->oof_start : %s", asctime(localtime(&(cal
->oof_start
))));
302 SIPE_DEBUG_INFO("sipe_private->note_since : %s", asctime(localtime(&(sipe_private
->note_since
))));
305 SIPE_DEBUG_INFO("sipe_private->note : %s", sipe_private
->note
? sipe_private
->note
: "");
307 if (!SIPE_CORE_PRIVATE_FLAG_IS(INITIAL_PUBLISH
) ||
309 sipe_status_set_activity(sipe_private
, SIPE_ACTIVITY_AVAILABLE
);
314 res_oof
= SIPE_SOAP_SET_PRESENCE_OOF_XML
;
315 cal
->published
= TRUE
;
316 } else if (sipe_private
->note
) {
317 if (SIPE_CORE_PRIVATE_FLAG_IS(OOF_NOTE
) &&
318 !oof_note
) { /* stale OOF note, as it's not present in cal already */
319 g_free(sipe_private
->note
);
320 sipe_private
->note
= NULL
;
321 SIPE_CORE_PRIVATE_FLAG_UNSET(OOF_NOTE
);
322 sipe_private
->note_since
= 0;
324 note_pub
= sipe_private
->note
;
325 res_oof
= SIPE_CORE_PRIVATE_FLAG_IS(OOF_NOTE
) ? SIPE_SOAP_SET_PRESENCE_OOF_XML
: "";
331 /* to protocol internal plain text format */
332 tmp
= sipe_backend_markup_strip_html(note_pub
);
333 res_note
= g_markup_printf_escaped(SIPE_SOAP_SET_PRESENCE_NOTE_XML
, tmp
);
338 if (!do_reset_status
) {
339 if (sipe_status_changed_by_user(sipe_private
) &&
340 !do_publish_calendar
&&
341 SIPE_CORE_PRIVATE_FLAG_IS(INITIAL_PUBLISH
)) {
342 const gchar
*activity_token
;
343 int avail_2007
= sipe_ocs2007_availability_from_status(sipe_private
->status
,
346 states
= g_strdup_printf(SIPE_SOAP_SET_PRESENCE_STATES
,
352 else /* preserve existing publication */
354 if (sipe_private
->ocs2005_user_states
) {
355 states
= g_strdup(sipe_private
->ocs2005_user_states
);
359 /* do nothing - then User state will be erased */
361 SIPE_CORE_PRIVATE_FLAG_SET(INITIAL_PUBLISH
);
364 if (cal
&& (!is_empty(cal
->legacy_dn
) || !is_empty(cal
->email
)) && cal
->fb_start
&& !is_empty(cal
->free_busy
))
366 char *fb_start_str
= sipe_utils_time_to_str(cal
->fb_start
);
367 char *free_busy_base64
= sipe_cal_get_freebusy_base64(cal
->free_busy
);
368 calendar_data
= g_strdup_printf(SIPE_SOAP_SET_PRESENCE_CALENDAR
,
369 !is_empty(cal
->legacy_dn
) ? cal
->legacy_dn
: cal
->email
,
372 g_free(fb_start_str
);
373 g_free(free_busy_base64
);
376 user_input
= (sipe_status_changed_by_user(sipe_private
) ||
377 sipe_is_user_available(sipe_private
)) ?
381 body
= g_strdup_printf(SIPE_SOAP_SET_PRESENCE
,
382 sipe_private
->username
,
383 sipe_ocs2005_availability_from_status(sipe_private
),
384 sipe_ocs2005_activity_from_status(sipe_private
),
385 (tmp
= g_ascii_strup(g_get_host_name(), -1)),
386 res_note
? res_note
: "",
387 res_oof
? res_oof
: "",
388 states
? states
: "",
389 calendar_data
? calendar_data
: "",
398 g_free(calendar_data
);
399 g_free(since_time_str
);
402 sip_soap_raw_request_cb(sipe_private
, from
, body
, NULL
, NULL
);
407 void sipe_ocs2005_presence_publish(struct sipe_core_private
*sipe_private
,
408 gboolean do_publish_calendar
)
410 send_presence_soap(sipe_private
, do_publish_calendar
, FALSE
);
413 void sipe_ocs2005_reset_status(struct sipe_core_private
*sipe_private
)
415 send_presence_soap(sipe_private
, FALSE
, TRUE
);
418 void sipe_ocs2005_apply_calendar_status(struct sipe_core_private
*sipe_private
,
419 struct sipe_buddy
*sbuddy
,
420 const char *status_id
)
422 time_t cal_avail_since
;
423 int cal_status
= sipe_cal_get_status(sbuddy
, time(NULL
), &cal_avail_since
);
429 if (cal_status
< SIPE_CAL_NO_DATA
) {
430 SIPE_DEBUG_INFO("sipe_apply_calendar_status: cal_status : %d for %s", cal_status
, sbuddy
->name
);
431 SIPE_DEBUG_INFO("sipe_apply_calendar_status: cal_avail_since : %s", asctime(localtime(&cal_avail_since
)));
434 /* scheduled Cal update call */
436 status_id
= sbuddy
->last_non_cal_status_id
;
437 g_free(sbuddy
->activity
);
438 sbuddy
->activity
= g_strdup(sbuddy
->last_non_cal_activity
);
442 SIPE_DEBUG_INFO("sipe_apply_calendar_status: status_id is NULL for %s, exiting.",
443 sbuddy
->name
? sbuddy
->name
: "" );
447 /* adjust to calendar status */
448 if (cal_status
!= SIPE_CAL_NO_DATA
) {
449 SIPE_DEBUG_INFO("sipe_apply_calendar_status: user_avail_since: %s", asctime(localtime(&sbuddy
->user_avail_since
)));
451 if ((cal_status
== SIPE_CAL_BUSY
) &&
452 (cal_avail_since
> sbuddy
->user_avail_since
) &&
453 sipe_ocs2007_status_is_busy(status_id
)) {
454 status_id
= sipe_status_activity_to_token(SIPE_ACTIVITY_BUSY
);
455 g_free(sbuddy
->activity
);
456 sbuddy
->activity
= g_strdup(sipe_core_activity_description(SIPE_ACTIVITY_IN_MEETING
));
458 avail
= sipe_ocs2007_availability_from_status(status_id
, NULL
);
460 SIPE_DEBUG_INFO("sipe_apply_calendar_status: activity_since : %s", asctime(localtime(&sbuddy
->activity_since
)));
461 if (cal_avail_since
> sbuddy
->activity_since
) {
462 if ((cal_status
== SIPE_CAL_OOF
) &&
463 sipe_ocs2007_availability_is_away(avail
)) {
464 g_free(sbuddy
->activity
);
465 sbuddy
->activity
= g_strdup(sipe_core_activity_description(SIPE_ACTIVITY_OOF
));
470 /* then set status_id actually */
471 SIPE_DEBUG_INFO("sipe_apply_calendar_status: to %s for %s", status_id
, sbuddy
->name
? sbuddy
->name
: "" );
472 sipe_backend_buddy_set_status(SIPE_CORE_PUBLIC
, sbuddy
->name
,
473 sipe_status_token_to_activity(status_id
));
475 /* set our account state to the one in roaming (including calendar info) */
476 self_uri
= sip_uri_self(sipe_private
);
477 if (SIPE_CORE_PRIVATE_FLAG_IS(INITIAL_PUBLISH
) &&
478 sipe_strcase_equal(sbuddy
->name
, self_uri
)) {
479 if (sipe_strequal(status_id
, sipe_status_activity_to_token(SIPE_ACTIVITY_OFFLINE
))) {
480 /* do not let offline status switch us off */
481 status_id
= sipe_status_activity_to_token(SIPE_ACTIVITY_INVISIBLE
);
484 sipe_status_and_note(sipe_private
, status_id
);
489 static void update_calendar_status_cb(SIPE_UNUSED_PARAMETER
char *name
,
490 struct sipe_buddy
*sbuddy
,
491 struct sipe_core_private
*sipe_private
)
493 sipe_ocs2005_apply_calendar_status(sipe_private
, sbuddy
, NULL
);
497 * Updates contact's status
498 * based on their calendar information.
500 static void update_calendar_status(struct sipe_core_private
*sipe_private
,
501 SIPE_UNUSED_PARAMETER
void *unused
)
503 SIPE_DEBUG_INFO_NOFORMAT("update_calendar_status() started.");
504 g_hash_table_foreach(sipe_private
->buddies
,
505 (GHFunc
)update_calendar_status_cb
,
508 /* repeat scheduling */
509 sipe_ocs2005_schedule_status_update(sipe_private
,
510 time(NULL
) + 3 * 60 /* 3 min */);
514 * Schedules process of contacts' status update
515 * based on their calendar information.
516 * Should be scheduled to the beginning of every
517 * 15 min interval, like:
518 * 13:00, 13:15, 13:30, 13:45, etc.
520 void sipe_ocs2005_schedule_status_update(struct sipe_core_private
*sipe_private
,
521 time_t calculate_from
)
523 #define SCHEDULE_INTERVAL 15 * 60 /* 15 min */
525 /* start of the beginning of closest 15 min interval. */
526 time_t next_start
= (calculate_from
/ SCHEDULE_INTERVAL
+ 1) * SCHEDULE_INTERVAL
;
528 SIPE_DEBUG_INFO("sipe_ocs2005_schedule_status_update: calculate_from time: %s",
529 asctime(localtime(&calculate_from
)));
530 SIPE_DEBUG_INFO("sipe_ocs2005_schedule_status_update: next start time : %s",
531 asctime(localtime(&next_start
)));
533 sipe_schedule_seconds(sipe_private
,
534 "<+2005-cal-status>",
536 next_start
- time(NULL
),
537 update_calendar_status
,