]> code.citadel.org Git - citadel.git/blobdiff - webcit/availability.c
converted comments to get caught by doxygen
[citadel.git] / webcit / availability.c
index 8fa41bf7f3532160311856424df15a882cb0c432..f02fb325e9e2ff3fe16f3fb6d24de5d810e006f9 100644 (file)
@@ -1,40 +1,27 @@
 /*
  * $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 <ctype.h>
-#include <stdlib.h>
-#include <unistd.h>
-#include <stdio.h>
-#include <fcntl.h>
-#include <signal.h>
-#include <sys/types.h>
-#include <sys/wait.h>
-#include <sys/socket.h>
-#include <limits.h>
-#include <netinet/in.h>
-#include <netdb.h>
-#include <string.h>
-#include <pwd.h>
-#include <errno.h>
-#include <stdarg.h>
-#include <pthread.h>
-#include <signal.h>
-#include <time.h>
 #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];
@@ -42,7 +29,7 @@ icalcomponent *get_freebusy_for_user(char *who) {
        icalcomponent *fb = NULL;
 
        serv_printf("ICAL freebusy|%s", who);
-       serv_gets(buf);
+       serv_getln(buf, sizeof buf);
        if (buf[0] == '1') {
                serialized_fb = read_server_text();
        }
@@ -57,16 +44,84 @@ icalcomponent *get_freebusy_for_user(char *who) {
                return NULL;
        }
 
-       return fb;
+       return(fb);
+}
+
+
+
+
+/**
+ * \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,
+                       struct icaltimetype t1end,
+                       struct icaltimetype t2start,
+                       struct icaltimetype t2end
+) {
+
+       if (icaltime_is_null_time(t1start)) return(0);
+       if (icaltime_is_null_time(t2start)) return(0);
+
+       /** First, check for all-day events */
+       if (t1start.is_date) {
+               if (!icaltime_compare_date_only(t1start, t2start)) {
+                       return(1);
+               }
+               if (!icaltime_is_null_time(t2end)) {
+                       if (!icaltime_compare_date_only(t1start, t2end)) {
+                               return(1);
+                       }
+               }
+       }
+
+       if (t2start.is_date) {
+               if (!icaltime_compare_date_only(t2start, t1start)) {
+                       return(1);
+               }
+               if (!icaltime_is_null_time(t1end)) {
+                       if (!icaltime_compare_date_only(t2start, t1end)) {
+                               return(1);
+                       }
+               }
+       }
+
+       /** Now check for overlaps using date *and* 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 (icaltime_compare(t1end, t2start) <= 0) return(0);
+
+       /** If event 2 ends before event 1 starts, we're also ok. */
+       if (icaltime_compare(t2end, t1start) <= 0) return(0);
+
+       /** 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,
@@ -76,18 +131,21 @@ void check_individual_attendee(char *attendee_string,
        icalcomponent *fbc = NULL;
        icalcomponent *fb = NULL;
        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");
+       strcpy(annotation, _("availability unknown"));
 
        fbc = get_freebusy_for_user(attendee_string);
        if (fbc == NULL) {
                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) {
@@ -97,16 +155,21 @@ void check_individual_attendee(char *attendee_string,
                fb = fbc;
        }
 
-       /* Iterate through all FREEBUSY's looking for conflicts. */
+       /** Iterate through all FREEBUSY's looking for conflicts. */
        if (fb != NULL) {
 
-               strcpy(annotation, "free");
+               strcpy(annotation, _("free"));
 
                for (thisfb = icalcomponent_get_first_property(fb, ICAL_FREEBUSY_PROPERTY);
                    thisfb != NULL;
                    thisfb = icalcomponent_get_next_property(fb, ICAL_FREEBUSY_PROPERTY) ) {
-       
-                       /* FIXME ... do the check */
+
+                       /** Do the check */
+                       period = icalproperty_get_freebusy(thisfb);
+                       if (ical_ctdl_is_overlap(period.start, period.end,
+                          event_start, event_end)) {
+                               strcpy(annotation, _("BUSY"));
+                       }
 
                }
        }
@@ -116,9 +179,12 @@ void check_individual_attendee(char *attendee_string,
 
 
 
-/*
+
+/**
+ * \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;
@@ -134,7 +200,8 @@ void check_attendee_availability(icalcomponent *vevent) {
                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
@@ -150,7 +217,9 @@ void check_attendee_availability(icalcomponent *vevent) {
                return;
        }
 
-       /*
+       ical_dezonify(vevent);          /**< Convert everything to UTC */
+
+       /**
         * Learn the start and end times.
         */
        dtstart_p = icalcomponent_get_first_property(vevent, ICAL_DTSTART_PROPERTY);
@@ -159,7 +228,7 @@ void check_attendee_availability(icalcomponent *vevent) {
        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);
@@ -169,7 +238,7 @@ void check_attendee_availability(icalcomponent *vevent) {
                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);
 
@@ -177,7 +246,7 @@ void check_attendee_availability(icalcomponent *vevent) {
                                                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);
@@ -189,3 +258,5 @@ void check_attendee_availability(icalcomponent *vevent) {
 
 
 #endif /* WEBCIT_WITH_CALENDAR_SERVICE */
+
+/** @} */