/*
* $Id$
+ */
+/**
*
- * Check attendee availability for scheduling a meeting.
- *
+ * \defgroup CalendarAv Check attendee availability for scheduling a meeting.
+ * \todo why doesn't anything of the documentation apear?
*/
+/*@{*/
+
#include "webcit.h"
#include "webserver.h"
-
+/** only available if we have calendaring */
#ifdef WEBCIT_WITH_CALENDAR_SERVICE
-/*
+/**
+ * \brief verify users avaiability
* Utility function to fetch a VFREEBUSY type of thing for
* any specified user.
+ * \param who string of the user to search
*/
icalcomponent *get_freebusy_for_user(char *who) {
char buf[SIZ];
-/*
- * Check to see if two events overlap. Returns nonzero if they do.
+/**
+ * \brief Check if dates are overlapping
+ * Check to see if two events overlap.
* (This function is used in both Citadel and WebCit. If you change it in
* one place, change it in the other. Better yet, put it in a library.)
+ * \param t1start date one start
+ * \param t1end date one end
+ * \param t2start date one start
+ * \param t2end date two end
+ * \returns nonzero if they do.
*/
int ical_ctdl_is_overlap(
struct icaltimetype t1start,
if (icaltime_is_null_time(t1start)) return(0);
if (icaltime_is_null_time(t2start)) return(0);
- /* First, check for all-day events */
+ /** First, check for all-day events */
if (t1start.is_date) {
if (!icaltime_compare_date_only(t1start, t2start)) {
return(1);
}
}
- /* Now check for overlaps using date *and* time. */
+ /** Now check for overlaps using date *and* time. */
- /* First, bail out if either event 1 or event 2 is missing end time. */
+ /** First, bail out if either event 1 or event 2 is missing end time. */
if (icaltime_is_null_time(t1end)) return(0);
if (icaltime_is_null_time(t2end)) return(0);
- /* If event 1 ends before event 2 starts, we're in the clear. */
+ /** If event 1 ends before event 2 starts, we're in the clear. */
if (icaltime_compare(t1end, t2start) <= 0) return(0);
- /* If event 2 ends before event 1 starts, we're also ok. */
+ /** If event 2 ends before event 1 starts, we're also ok. */
if (icaltime_compare(t2end, t1start) <= 0) return(0);
- /* Otherwise, they overlap. */
+ /** Otherwise, they overlap. */
return(1);
}
/*
+ * \brief dig availability on citserver
* Back end function for check_attendee_availability()
* This one checks an individual attendee against a supplied
* event start and end time. All these fields have already been
- * broken out. The result is placed in 'annotation'.
+ * broken out.
+ * \param attendee_string name of the attendee
+ * \param event_start starttime of the event to check
+ * \param event_end endtime of the event to check
+ * \return The result is placed in 'annotation'.
*/
void check_individual_attendee(char *attendee_string,
struct icaltimetype event_start,
icalproperty *thisfb = NULL;
struct icalperiodtype period;
- /* Set to 'unknown' right from the beginning. Unless we learn
+ /**
+ * Set to 'unknown' right from the beginning. Unless we learn
* something else, that's what we'll go with.
*/
strcpy(annotation, _("availability unknown"));
return;
}
- /* Make sure we're looking at a VFREEBUSY by itself. What we're probably
+ /**
+ * Make sure we're looking at a VFREEBUSY by itself. What we're probably
* looking at initially is a VFREEBUSY encapsulated in a VCALENDAR.
*/
if (icalcomponent_isa(fbc) == ICAL_VCALENDAR_COMPONENT) {
fb = fbc;
}
- /* Iterate through all FREEBUSY's looking for conflicts. */
+ /** Iterate through all FREEBUSY's looking for conflicts. */
if (fb != NULL) {
strcpy(annotation, _("free"));
thisfb != NULL;
thisfb = icalcomponent_get_next_property(fb, ICAL_FREEBUSY_PROPERTY) ) {
- /* Do the check */
+ /** Do the check */
period = icalproperty_get_freebusy(thisfb);
if (ical_ctdl_is_overlap(period.start, period.end,
event_start, event_end)) {
-/*
+/**
+ * \brief check attendees availability
* Check the availability of all attendees for an event (when possible)
* and annotate accordingly.
+ * \param vevent the event which should be compared with attendees calendar
*/
void check_attendee_availability(icalcomponent *vevent) {
icalproperty *attendee = NULL;
return;
}
- /* If we're looking at a fully encapsulated VCALENDAR
+ /**
+ * If we're looking at a fully encapsulated VCALENDAR
* rather than a VEVENT component, attempt to use the first
* relevant VEVENT subcomponent. If there is none, the
* NULL returned by icalcomponent_get_first_component() will
return;
}
- ical_dezonify(vevent); /* Convert everything to UTC */
+ ical_dezonify(vevent); /**< Convert everything to UTC */
- /*
+ /**
* Learn the start and end times.
*/
dtstart_p = icalcomponent_get_first_property(vevent, ICAL_DTSTART_PROPERTY);
dtend_p = icalcomponent_get_first_property(vevent, ICAL_DTEND_PROPERTY);
if (dtend_p != NULL) dtend_t = icalproperty_get_dtend(dtend_p);
- /*
+ /**
* Iterate through attendees.
*/
for (attendee = icalcomponent_get_first_property(vevent, ICAL_ATTENDEE_PROPERTY);
strcpy(attendee_string, icalproperty_get_attendee(attendee));
if (!strncasecmp(attendee_string, "MAILTO:", 7)) {
- /* screen name or email address */
+ /** screen name or email address */
strcpy(attendee_string, &attendee_string[7]);
striplt(attendee_string);
dtstart_t, dtend_t,
annotation);
- /* Replace the attendee name with an annotated one. */
+ /** Replace the attendee name with an annotated one. */
snprintf(annotated_attendee_string, sizeof annotated_attendee_string,
"MAILTO:%s (%s)", attendee_string, annotation);
icalproperty_set_attendee(attendee, annotated_attendee_string);
#endif /* WEBCIT_WITH_CALENDAR_SERVICE */
+
+/** @} */
projects / citadel.git / blobdiff