]> code.citadel.org Git - citadel.git/blobdiff - webcit/calendar_tools.c
converted comments to get caught by doxygen
[citadel.git] / webcit / calendar_tools.c
index 546badb3e53913fc23d09822fde9ce675ec36057..be8e16f98f45f4dc66c02e5f520230d6a0778713 100644 (file)
@@ -1,41 +1,42 @@
 /*
  * $Id$
- *
- *
  */
-
-#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>
+/**
+ * \defgroup MiscCal Miscellaneous functions which handle calendar components.
+ */
+/*@{*/
 #include "webcit.h"
 #include "webserver.h"
 
-char *months[] = {
-       "January", "February", "March", "April", "May", "June", "July",
-       "August", "September", "October", "November", "December"
+/* \todo FIXME ... this needs to be internationalized */
+/** Month Strings. */
+char *months[] = { 
+       "January",
+       "February",
+       "March",
+       "April",
+       "May",
+       "June",
+       "July",
+       "August",
+       "September",
+       "October",
+       "November",
+       "December"
 };
 
-char *days[] = {
-       "Sunday", "Monday", "Tuesday", "Wednesday",
-       "Thursday", "Friday", "Saturday"
+/** Day Strings */
+char *days[] = { 
+       "Sunday",
+       "Monday",
+       "Tuesday",
+       "Wednesday",
+       "Thursday",
+       "Friday",
+       "Saturday"
 };
 
+/** Hour strings */
 char *hourname[] = {
        "12am", "1am", "2am", "3am", "4am", "5am", "6am",
        "7am", "8am", "9am", "10am", "11am", "12pm",
@@ -45,7 +46,8 @@ char *hourname[] = {
 
 #ifdef WEBCIT_WITH_CALENDAR_SERVICE
 
-/*
+/**
+ * \brief display and edit date/time
  * The display_icaltimetype_as_webform() and icaltime_from_webform() functions
  * handle the display and editing of date/time properties in web pages.  The
  * first one converts an icaltimetype into valid HTML markup -- a series of form
@@ -56,34 +58,43 @@ char *hourname[] = {
  * property (for example, a start and end time) by ensuring the field names are
  * unique within the form.
  *
- * NOTE: These functions assume that the icaltimetype being edited is in UTC, and
+ * \todo NOTE: These functions assume that the icaltimetype being edited is in UTC, and
  * will convert to/from local time for editing.  "local" in this case is assumed
  * to be the time zone in which the WebCit server is running.  A future improvement
  * might be to allow the user to specify his/her timezone.
+ * \param t the time we want to parse
+ * \param prefix ???? \todo
  */
 
 
 void display_icaltimetype_as_webform(struct icaltimetype *t, char *prefix) {
        int i;
-
        time_t now;
        struct tm tm_now;
        int this_year;
-
        time_t tt;
        struct tm tm;
-
        const int span = 10;
+       int all_day_event = 0;
+       char calhourformat[16];
+
+       get_preference("calhourformat", calhourformat, sizeof calhourformat);
 
        now = time(NULL);
-       memcpy(&tm_now, localtime(&now), sizeof(struct tm));
+       localtime_r(&now, &tm_now);
        this_year = tm_now.tm_year + 1900;
 
        if (t == NULL) return;
+       if (t->is_date) all_day_event = 1;
        tt = icaltime_as_timet(*t);
-       memcpy(&tm, localtime(&tt), sizeof(struct tm));
+       if (all_day_event) {
+               gmtime_r(&tt, &tm);
+       }
+       else {
+               localtime_r(&tt, &tm);
+       }
 
-       wprintf("Month: ");
+       wprintf(_("Month: "));
        wprintf("<SELECT NAME=\"%s_month\" SIZE=\"1\">\n", prefix);
        for (i=0; i<=11; ++i) {
                wprintf("<OPTION %s VALUE=\"%d\">%s</OPTION>\n",
@@ -94,7 +105,7 @@ void display_icaltimetype_as_webform(struct icaltimetype *t, char *prefix) {
        }
        wprintf("</SELECT>\n");
 
-       wprintf("Day: ");
+       wprintf(_("Day: "));
        wprintf("<SELECT NAME=\"%s_day\" SIZE=\"1\">\n", prefix);
        for (i=1; i<=31; ++i) {
                wprintf("<OPTION %s VALUE=\"%d\">%d</OPTION>\n",
@@ -104,7 +115,7 @@ void display_icaltimetype_as_webform(struct icaltimetype *t, char *prefix) {
        }
        wprintf("</SELECT>\n");
 
-       wprintf("Year: ");
+       wprintf(_("Year: "));
        wprintf("<SELECT NAME=\"%s_year\" SIZE=\"1\">\n", prefix);
        if ((this_year - t->year) > span) {
                wprintf("<OPTION SELECTED VALUE=\"%d\">%d</OPTION>\n",
@@ -122,17 +133,27 @@ void display_icaltimetype_as_webform(struct icaltimetype *t, char *prefix) {
        }
        wprintf("</SELECT>\n");
 
-       wprintf("Hour: ");
+       wprintf(_("Hour: "));
        wprintf("<SELECT NAME=\"%s_hour\" SIZE=\"1\">\n", prefix);
        for (i=0; i<=23; ++i) {
-               wprintf("<OPTION %s VALUE=\"%d\">%s</OPTION>\n",
-                       ((tm.tm_hour == i) ? "SELECTED" : ""),
-                       i, hourname[i]
-               );
+
+               if (!strcasecmp(calhourformat, "24")) {
+                       wprintf("<OPTION %s VALUE=\"%d\">%d</OPTION>\n",
+                               ((tm.tm_hour == i) ? "SELECTED" : ""),
+                               i, i
+                       );
+               }
+               else {
+                       wprintf("<OPTION %s VALUE=\"%d\">%s</OPTION>\n",
+                               ((tm.tm_hour == i) ? "SELECTED" : ""),
+                               i, hourname[i]
+                       );
+               }
+
        }
        wprintf("</SELECT>\n");
 
-       wprintf("Minute: ");
+       wprintf(_("Minute: "));
        wprintf("<SELECT NAME=\"%s_minute\" SIZE=\"1\">\n", prefix);
        for (i=0; i<=59; ++i) {
                if ( (i % 5 == 0) || (tm.tm_min == i) ) {
@@ -145,49 +166,63 @@ void display_icaltimetype_as_webform(struct icaltimetype *t, char *prefix) {
        wprintf("</SELECT>\n");
 }
 
+/**
+ *\brief Get time from form
+ * get the time back from the user and convert it into internal structs.
+ * \param t our time element
+ * \param prefix whats that\todo ????
+ */
+void icaltime_from_webform(struct icaltimetype *t, char *prefix) {
+       char vname[32];
+        time_t tt;
+        struct tm tm;
+       struct icaltimetype t2;
+
+        tt = time(NULL);
+        localtime_r(&tt, &tm);
+
+        sprintf(vname, "%s_month", prefix);     tm.tm_mon = atoi(bstr(vname)) - 1;
+        sprintf(vname, "%s_day", prefix);       tm.tm_mday = atoi(bstr(vname));
+        sprintf(vname, "%s_year", prefix);      tm.tm_year = atoi(bstr(vname)) - 1900;
+        sprintf(vname, "%s_hour", prefix);      tm.tm_hour = atoi(bstr(vname));
+        sprintf(vname, "%s_minute", prefix);    tm.tm_min = atoi(bstr(vname));
+
+        tt = mktime(&tm);
+        t2 = icaltime_from_timet(tt, 0);
+       memcpy(t, &t2, sizeof(struct icaltimetype));
+}
 
-struct icaltimetype icaltime_from_webform(char *prefix) {
-       struct icaltimetype t;
-       time_t tt;
-       struct tm tm;
-       char vname[SIZ];
+/**
+ *\brief Get time from form
+ * get the time back from the user and convert it into internal structs.
+ * \param t our time element
+ * \param prefix whats that\todo ????
+ */
 
-       tt = time(NULL);
-       memcpy(&tm, localtime(&tt), sizeof(struct tm));
+void icaltime_from_webform_dateonly(struct icaltimetype *t, char *prefix) {
+       char vname[32];
 
-       sprintf(vname, "%s_month", prefix);     tm.tm_mon = atoi(bstr(vname)) - 1;
-       sprintf(vname, "%s_day", prefix);       tm.tm_mday = atoi(bstr(vname));
-       sprintf(vname, "%s_year", prefix);      tm.tm_year = atoi(bstr(vname)) - 1900;
-       sprintf(vname, "%s_hour", prefix);      tm.tm_hour = atoi(bstr(vname));
-       sprintf(vname, "%s_minute", prefix);    tm.tm_min = atoi(bstr(vname));
+       memset(t, 0, sizeof(struct icaltimetype));
 
-       tt = mktime(&tm);
-       t = icaltime_from_timet(tt, 0);
-       t = icaltime_normalize(t);
-       return(t);
+        sprintf(vname, "%s_month", prefix);     t->month = atoi(bstr(vname));
+        sprintf(vname, "%s_day", prefix);       t->day = atoi(bstr(vname));
+        sprintf(vname, "%s_year", prefix);      t->year = atoi(bstr(vname));
+       t->is_utc = 1;
+       t->is_date = 1;
 }
 
 
-/*
- * Generae a new, globally unique UID parameter for a calendar object.
- */
-void generate_new_uid(char *buf) {
-       static int seq = 0;
-
-       sprintf(buf, "%ld-%d@%s",
-               (long)time(NULL),
-               (seq++),
-               serv_info.serv_fqdn);
-}
-
-/*
+/**
+ * \brief Render PAPSTAT
  * Render a PARTSTAT parameter as a string (and put it in parentheses)
+ * \param buf the string to put it to
+ * \param attendee the attendee to textify
  */
 void partstat_as_string(char *buf, icalproperty *attendee) {
        icalparameter *partstat_param;
        icalparameter_partstat partstat;
 
-       strcpy(buf, "(status unknown)");
+       strcpy(buf, _("(status unknown)"));
 
        partstat_param = icalproperty_get_first_parameter(
                                attendee,
@@ -203,69 +238,81 @@ void partstat_as_string(char *buf, icalproperty *attendee) {
                        strcpy(buf, "(x)");
                        break;
                case ICAL_PARTSTAT_NEEDSACTION:
-                       strcpy(buf, "(needs action)");
+                       strcpy(buf, _("(needs action)"));
                        break;
                case ICAL_PARTSTAT_ACCEPTED:
-                       strcpy(buf, "(accepted)");
+                       strcpy(buf, _("(accepted)"));
                        break;
                case ICAL_PARTSTAT_DECLINED:
-                       strcpy(buf, "(declined)");
+                       strcpy(buf, _("(declined)"));
                        break;
                case ICAL_PARTSTAT_TENTATIVE:
-                       strcpy(buf, "(tenative)");
+                       strcpy(buf, _("(tenative)"));
                        break;
                case ICAL_PARTSTAT_DELEGATED:
-                       strcpy(buf, "(delegated)");
+                       strcpy(buf, _("(delegated)"));
                        break;
                case ICAL_PARTSTAT_COMPLETED:
-                       strcpy(buf, "(completed)");
+                       strcpy(buf, _("(completed)"));
                        break;
                case ICAL_PARTSTAT_INPROCESS:
-                       strcpy(buf, "(in process)");
+                       strcpy(buf, _("(in process)"));
                        break;
                case ICAL_PARTSTAT_NONE:
-                       strcpy(buf, "(none)");
+                       strcpy(buf, _("(none)"));
                        break;
        }
 }
 
 
-/*
+/**
+ * \brief embedd
  * Utility function to encapsulate a subcomponent into a full VCALENDAR
+ * \param subcomp the component to encapsulate
+ * \returns the meta object ???
  */
 icalcomponent *ical_encapsulate_subcomponent(icalcomponent *subcomp) {
        icalcomponent *encaps;
 
-       /* If we're already looking at a full VCALENDAR component,
+       /* lprintf(9, "ical_encapsulate_subcomponent() called\n"); */
+
+       if (subcomp == NULL) {
+               lprintf(3, "ERROR: called with NULL argument!\n");
+               return NULL;
+       }
+
+       /**
+        * If we're already looking at a full VCALENDAR component,
         * don't bother ... just return itself.
         */
        if (icalcomponent_isa(subcomp) == ICAL_VCALENDAR_COMPONENT) {
                return subcomp;
        }
 
-       /* Encapsulate the VEVENT component into a complete VCALENDAR */
+       /** Encapsulate the VEVENT component into a complete VCALENDAR */
        encaps = icalcomponent_new(ICAL_VCALENDAR_COMPONENT);
        if (encaps == NULL) {
-               lprintf(3, "Error at %s:%d - could not allocate component!\n",
+               lprintf(3, "%s:%d: Error - could not allocate component!\n",
                        __FILE__, __LINE__);
                return NULL;
        }
 
-       /* Set the Product ID */
+       /** Set the Product ID */
        icalcomponent_add_property(encaps, icalproperty_new_prodid(PRODID));
 
-       /* Set the Version Number */
+       /** Set the Version Number */
        icalcomponent_add_property(encaps, icalproperty_new_version("2.0"));
 
-       /* Encapsulate the subcomponent inside */
+       /** Encapsulate the subcomponent inside */
+       /* lprintf(9, "Doing the encapsulation\n"); */
        icalcomponent_add_component(encaps, subcomp);
 
-       /* Convert all timestamps to UTC so we don't have to deal with
+       /** Convert all timestamps to UTC so we don't have to deal with
         * stupid VTIMEZONE crap.
         */
        ical_dezonify(encaps);
 
-       /* Return the object we just created. */
+       /** Return the object we just created. */
        return(encaps);
 }
 
@@ -273,3 +320,4 @@ icalcomponent *ical_encapsulate_subcomponent(icalcomponent *subcomp) {
 
 
 #endif
+/*@}*/