webcit/calendar_tools.c

   1 /*
   2  * $Id$
   3  *
   4  * Miscellaneous functions which handle calendar components.
   5  */
   6
   7 #include "webcit.h"
   8 #include "webserver.h"
   9 #include "time.h"
  10
  11 /* Hour strings */
  12 char *hourname[] = {
  13         "12am", "1am", "2am", "3am", "4am", "5am", "6am",
  14         "7am", "8am", "9am", "10am", "11am", "12pm",
  15         "1pm", "2pm", "3pm", "4pm", "5pm", "6pm",
  16         "7pm", "8pm", "9pm", "10pm", "11pm"
  17 };
  18
  19 /*
  20  * The display_icaltimetype_as_webform() and icaltime_from_webform() functions
  21  * handle the display and editing of date/time properties in web pages.  The
  22  * first one converts an icaltimetype into valid HTML markup -- a series of form
  23  * fields for editing the date and time.  When the user submits the form, the
  24  * results can be fed back into the second function, which turns it back into
  25  * an icaltimetype.  The "prefix" string required by both functions is prepended
  26  * to all field names.  This allows a form to contain more than one date/time
  27  * property (for example, a start and end time) by ensuring the field names are
  28  * unique within the form.
  29  *
  30  * NOTE: These functions assume that the icaltimetype being edited is in UTC, and
  31  * will convert to/from local time for editing.  "local" in this case is assumed
  32  * to be the time zone in which the WebCit server is running.  A future improvement
  33  * might be to allow the user to specify his/her timezone.
  34  */
  35
  36 void display_icaltimetype_as_webform(struct icaltimetype *t, char *prefix, int date_only) {
  37         int i;
  38         time_t now;
  39         struct tm tm_now;
  40         int this_year;
  41         time_t tt;
  42         struct tm tm;
  43         int all_day_event = 0;
  44         int time_format;
  45         char timebuf[32];
  46
  47         time_format = get_time_format_cached ();
  48
  49         now = time(NULL);
  50         localtime_r(&now, &tm_now);
  51         this_year = tm_now.tm_year + 1900;
  52
  53         if (t == NULL) return;
  54         if (t->is_date) all_day_event = 1;
  55         tt = icaltime_as_timet(*t);
  56         if (all_day_event) {
  57                 gmtime_r(&tt, &tm);
  58         }
  59         else {
  60                 localtime_r(&tt, &tm);
  61         }
  62
  63         wprintf("<input type=\"text\" name=\"");
  64         wprintf(prefix);
  65         wprintf("\" id=\"");
  66         wprintf(prefix);
  67         wprintf("\" size=\"10\" maxlength=\"10\" value=\"");
  68         wc_strftime(timebuf, 32, "%Y-%m-%d", &tm);
  69         wprintf(timebuf);
  70         wprintf("\">");
  71
  72         StrBufAppendPrintf(WC->trailing_javascript, "attachDatePicker('");
  73         StrBufAppendPrintf(WC->trailing_javascript, prefix);
  74         StrBufAppendPrintf(WC->trailing_javascript, "', '%s');\n", get_selected_language());
  75
  76         /* If we're editing a date only, we still generate the time boxes, but we hide them.
  77          * This keeps the data model consistent.
  78          */
  79         if (date_only) {
  80                 wprintf("<div style=\"display:none\">");
  81         }
  82
  83         wprintf(_("Hour: "));
  84         wprintf("<SELECT NAME=\"%s_hour\" SIZE=\"1\">\n", prefix);
  85         for (i=0; i<=23; ++i) {
  86
  87                 if (time_format == WC_TIMEFORMAT_24) {
  88                         wprintf("<OPTION %s VALUE=\"%d\">%d</OPTION>\n",
  89                                 ((tm.tm_hour == i) ? "SELECTED" : ""),
  90                                 i, i
  91                                 );
  92                 }
  93                 else {
  94                         wprintf("<OPTION %s VALUE=\"%d\">%s</OPTION>\n",
  95                                 ((tm.tm_hour == i) ? "SELECTED" : ""),
  96                                 i, hourname[i]
  97                                 );
  98                 }
  99
 100         }
 101         wprintf("</SELECT>\n");
 102
 103         wprintf(_("Minute: "));
 104         wprintf("<SELECT NAME=\"%s_minute\" SIZE=\"1\">\n", prefix);
 105         for (i=0; i<=59; ++i) {
 106                 if ( (i % 5 == 0) || (tm.tm_min == i) ) {
 107                         wprintf("<OPTION %s VALUE=\"%d\">:%02d</OPTION>\n",
 108                                 ((tm.tm_min == i) ? "SELECTED" : ""),
 109                                 i, i
 110                                 );
 111                 }
 112         }
 113         wprintf("</SELECT>\n");
 114
 115         if (date_only) {
 116                 wprintf("</div>");
 117         }
 118 }
 119
 120 /*
 121  * Get date/time from a web form and convert it into an icaltimetype struct.
 122  */
 123 void icaltime_from_webform(struct icaltimetype *t, char *prefix) {
 124         char vname[32];
 125
 126         if (!t) return;
 127
 128         /* Stuff with zero values */
 129         memset(t, 0, sizeof(struct icaltimetype));
 130
 131         /* Get the year/month/date all in one shot -- it will be in ISO YYYY-MM-DD format */
 132         sscanf((char*)BSTR(prefix), "%04d-%02d-%02d", &t->year, &t->month, &t->day);
 133
 134         /* hour */
 135         sprintf(vname, "%s_hour", prefix);
 136         t->hour = IBSTR(vname);
 137
 138         /* minute */
 139         sprintf(vname, "%s_minute", prefix);
 140         t->minute = IBSTR(vname);
 141
 142         /* time zone is set to the default zone for this server */
 143         t->is_utc = 0;
 144         t->is_date = 0;
 145         t->zone = get_default_icaltimezone();
 146 }
 147
 148
 149 /*
 150  * Get date (no time) from a web form and convert it into an icaltimetype struct.
 151  */
 152 void icaltime_from_webform_dateonly(struct icaltimetype *t, char *prefix) {
 153         if (!t) return;
 154
 155         /* Stuff with zero values */
 156         memset(t, 0, sizeof(struct icaltimetype));
 157
 158         /* Get the year/month/date all in one shot -- it will be in ISO YYYY-MM-DD format */
 159         sscanf((char*)BSTR(prefix), "%04d-%02d-%02d", &t->year, &t->month, &t->day);
 160
 161         /* time zone is set to the default zone for this server */
 162         t->is_utc = 1;
 163         t->is_date = 1;
 164 }
 165
 166
 167 /*
 168  * Render a PARTSTAT parameter as a string (and put it in parentheses)
 169  */
 170 void partstat_as_string(char *buf, icalproperty *attendee) {
 171         icalparameter *partstat_param;
 172         icalparameter_partstat partstat;
 173
 174         strcpy(buf, _("(status unknown)"));
 175
 176         partstat_param = icalproperty_get_first_parameter(
 177                 attendee,
 178                 ICAL_PARTSTAT_PARAMETER
 179                 );
 180         if (partstat_param == NULL) {
 181                 return;
 182         }
 183
 184         partstat = icalparameter_get_partstat(partstat_param);
 185         switch(partstat) {
 186         case ICAL_PARTSTAT_X:
 187                 strcpy(buf, "(x)");
 188                 break;
 189         case ICAL_PARTSTAT_NEEDSACTION:
 190                 strcpy(buf, _("(needs action)"));
 191                 break;
 192         case ICAL_PARTSTAT_ACCEPTED:
 193                 strcpy(buf, _("(accepted)"));
 194                 break;
 195         case ICAL_PARTSTAT_DECLINED:
 196                 strcpy(buf, _("(declined)"));
 197                 break;
 198         case ICAL_PARTSTAT_TENTATIVE:
 199                 strcpy(buf, _("(tenative)"));
 200                 break;
 201         case ICAL_PARTSTAT_DELEGATED:
 202                 strcpy(buf, _("(delegated)"));
 203                 break;
 204         case ICAL_PARTSTAT_COMPLETED:
 205                 strcpy(buf, _("(completed)"));
 206                 break;
 207         case ICAL_PARTSTAT_INPROCESS:
 208                 strcpy(buf, _("(in process)"));
 209                 break;
 210         case ICAL_PARTSTAT_NONE:
 211                 strcpy(buf, _("(none)"));
 212                 break;
 213         }
 214 }
 215
 216 /*
 217  * Utility function to encapsulate a subcomponent into a full VCALENDAR.
 218  *
 219  * We also scan for any date/time properties that reference timezones, and attach
 220  * those timezones along with the supplied subcomponent.  (Increase the size of the array if you need to.)
 221  *
 222  * Note: if you change anything here, change it in Citadel server's ical_send_out_invitations() too.
 223  */
 224 icalcomponent *ical_encapsulate_subcomponent(icalcomponent *subcomp) {
 225         icalcomponent *encaps;
 226         icalproperty *p;
 227         struct icaltimetype t;
 228         const icaltimezone *attached_zones[5] = { NULL, NULL, NULL, NULL, NULL };
 229         int i;
 230         const icaltimezone *z;
 231         int num_zones_attached = 0;
 232         int zone_already_attached;
 233
 234         if (subcomp == NULL) {
 235                 lprintf(3, "ERROR: ical_encapsulate_subcomponent() called with NULL argument\n");
 236                 return NULL;
 237         }
 238
 239         /*
 240          * If we're already looking at a full VCALENDAR component, this is probably an error.
 241          */
 242         if (icalcomponent_isa(subcomp) == ICAL_VCALENDAR_COMPONENT) {
 243                 lprintf(3, "ERROR: component sent to ical_encapsulate_subcomponent() already top level\n");
 244                 return subcomp;
 245         }
 246
 247         /* search for... */
 248         for (p = icalcomponent_get_first_property(subcomp, ICAL_ANY_PROPERTY);
 249              p != NULL;
 250              p = icalcomponent_get_next_property(subcomp, ICAL_ANY_PROPERTY))
 251         {
 252                 if ( (icalproperty_isa(p) == ICAL_COMPLETED_PROPERTY)
 253                   || (icalproperty_isa(p) == ICAL_CREATED_PROPERTY)
 254                   || (icalproperty_isa(p) == ICAL_DATEMAX_PROPERTY)
 255                   || (icalproperty_isa(p) == ICAL_DATEMIN_PROPERTY)
 256                   || (icalproperty_isa(p) == ICAL_DTEND_PROPERTY)
 257                   || (icalproperty_isa(p) == ICAL_DTSTAMP_PROPERTY)
 258                   || (icalproperty_isa(p) == ICAL_DTSTART_PROPERTY)
 259                   || (icalproperty_isa(p) == ICAL_DUE_PROPERTY)
 260                   || (icalproperty_isa(p) == ICAL_EXDATE_PROPERTY)
 261                   || (icalproperty_isa(p) == ICAL_LASTMODIFIED_PROPERTY)
 262                   || (icalproperty_isa(p) == ICAL_MAXDATE_PROPERTY)
 263                   || (icalproperty_isa(p) == ICAL_MINDATE_PROPERTY)
 264                   || (icalproperty_isa(p) == ICAL_RECURRENCEID_PROPERTY)
 265                 ) {
 266                         t = icalproperty_get_dtstart(p);        /*/ it's safe to use dtstart for all of them */
 267                         if ((icaltime_is_valid_time(t)) && (z=icaltime_get_timezone(t), z)) {
 268
 269                                 zone_already_attached = 0;
 270                                 for (i=0; i<5; ++i) {
 271                                         if (z == attached_zones[i]) {
 272                                                 ++zone_already_attached;
 273                                                 lprintf(9, "zone already attached!!\n");
 274                                         }
 275                                 }
 276                                 if ((!zone_already_attached) && (num_zones_attached < 5)) {
 277                                         lprintf(9, "attaching zone %d!\n", num_zones_attached);
 278                                         attached_zones[num_zones_attached++] = z;
 279                                 }
 280
 281                                 icalproperty_set_parameter(p,
 282                                         icalparameter_new_tzid(icaltimezone_get_tzid((icaltimezone *)z))
 283                                 );
 284                         }
 285                 }
 286         }
 287
 288         /* Encapsulate the VEVENT component into a complete VCALENDAR */
 289         encaps = icalcomponent_new(ICAL_VCALENDAR_COMPONENT);
 290         if (encaps == NULL) {
 291                 lprintf(3, "ERROR: ical_encapsulate_subcomponent() could not allocate component\n");
 292                 return NULL;
 293         }
 294
 295         /* Set the Product ID */
 296         icalcomponent_add_property(encaps, icalproperty_new_prodid(PRODID));
 297
 298         /* Set the Version Number */
 299         icalcomponent_add_property(encaps, icalproperty_new_version("2.0"));
 300
 301         /* Attach any timezones we need */
 302         if (num_zones_attached > 0) for (i=0; i<num_zones_attached; ++i) {
 303                 icalcomponent *zc;
 304                 zc = icalcomponent_new_clone(icaltimezone_get_component((icaltimezone *)attached_zones[i]));
 305                 icalcomponent_add_component(encaps, zc);
 306         }
 307
 308         /* Encapsulate the subcomponent inside */
 309         icalcomponent_add_component(encaps, subcomp);
 310
 311         /* Return the object we just created. */
 312         return(encaps);
 313 }