path: root/calendar/gui/comp-util.c

/*
 * Evolution calendar - Utilities for manipulating ECalComponent objects
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with the program; if not, see <http://www.gnu.org/licenses/>  
 *
 *
 * Authors:
 *      Federico Mena-Quintero <federico@ximian.com>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <string.h>
#include <time.h>
#include "calendar-config.h"
#include "comp-util.h"
#include "dialogs/delete-comp.h"
#include <libecal/e-cal-component.h>
#include "e-util/e-categories-config.h"



/**
 * cal_comp_util_add_exdate:
 * @comp: A calendar component object.
 * @itt: Time for the exception.
 *
 * Adds an exception date to the current list of EXDATE properties in a calendar
 * component object.
 **/
void
cal_comp_util_add_exdate (ECalComponent *comp, time_t t, icaltimezone *zone)
{
    GSList *list;
    ECalComponentDateTime *cdt;

    g_return_if_fail (comp != NULL);
    g_return_if_fail (E_IS_CAL_COMPONENT (comp));

    e_cal_component_get_exdate_list (comp, &list);

    cdt = g_new (ECalComponentDateTime, 1);
    cdt->value = g_new (struct icaltimetype, 1);
    *cdt->value = icaltime_from_timet_with_zone (t, FALSE, zone);
    cdt->tzid = g_strdup (icaltimezone_get_tzid (zone));

    list = g_slist_append (list, cdt);
    e_cal_component_set_exdate_list (comp, list);
    e_cal_component_free_exdate_list (list);
}



/* Returns TRUE if the TZIDs are equivalent, i.e. both NULL or the same. */
static gboolean
e_cal_component_compare_tzid (const char *tzid1, const char *tzid2)
{
    gboolean retval = TRUE;

    if (tzid1) {
        if (!tzid2 || strcmp (tzid1, tzid2))
            retval = FALSE;
    } else {
        if (tzid2)
            retval = FALSE;
    }

    return retval;
}

/**
 * cal_comp_util_compare_event_timezones:
 * @comp: A calendar component object.
 * @client: A #ECal.
 *
 * Checks if the component uses the given timezone for both the start and
 * the end time, or if the UTC offsets of the start and end times are the same
 * as in the given zone.
 *
 * Returns: TRUE if the component's start and end time are at the same UTC
 * offset in the given timezone.
 **/
gboolean
cal_comp_util_compare_event_timezones (ECalComponent *comp,
                       ECal *client,
                       icaltimezone *zone)
{
    ECalComponentDateTime start_datetime, end_datetime;
    const char *tzid;
    gboolean retval = FALSE;
    icaltimezone *start_zone, *end_zone;
    int offset1, offset2;

    tzid = icaltimezone_get_tzid (zone);

    e_cal_component_get_dtstart (comp, &start_datetime);
    e_cal_component_get_dtend (comp, &end_datetime);

    /* If either the DTSTART or the DTEND is a DATE value, we return TRUE.
       Maybe if one was a DATE-TIME we should check that, but that should
       not happen often. */
    if ((start_datetime.value && start_datetime.value->is_date)
        || (end_datetime.value && end_datetime.value->is_date)) {
        retval = TRUE;
        goto out;
    }

    /* If the event uses UTC for DTSTART & DTEND, return TRUE. Outlook
       will send single events as UTC, so we don't want to mark all of
       these. */
    if ((!start_datetime.value || start_datetime.value->is_utc)
        && (!end_datetime.value || end_datetime.value->is_utc)) {
        retval = TRUE;
        goto out;
    }

    /* If the event uses floating time for DTSTART & DTEND, return TRUE.
       Imported vCalendar files will use floating times, so we don't want
       to mark all of these. */
    if (!start_datetime.tzid && !end_datetime.tzid) {
        retval = TRUE;
        goto out;
    }

    /* FIXME: DURATION may be used instead. */
    if (e_cal_component_compare_tzid (tzid, start_datetime.tzid)
        && e_cal_component_compare_tzid (tzid, end_datetime.tzid)) {
        /* If both TZIDs are the same as the given zone's TZID, then
           we know the timezones are the same so we return TRUE. */
        retval = TRUE;
    } else {
        /* If the TZIDs differ, we have to compare the UTC offsets
           of the start and end times, using their own timezones and
           the given timezone. */
        if (!e_cal_get_timezone (client, start_datetime.tzid,
                          &start_zone, NULL))
            goto out;

        if (start_datetime.value) {
            offset1 = icaltimezone_get_utc_offset (start_zone,
                                   start_datetime.value,
                                   NULL);
            offset2 = icaltimezone_get_utc_offset (zone,
                                   start_datetime.value,
                                   NULL);
            if (offset1 != offset2)
                goto out;
        }

        if (!e_cal_get_timezone (client, end_datetime.tzid,
                          &end_zone, NULL))
            goto out;

        if (end_datetime.value) {
            offset1 = icaltimezone_get_utc_offset (end_zone,
                                   end_datetime.value,
                                   NULL);
            offset2 = icaltimezone_get_utc_offset (zone,
                                   end_datetime.value,
                                   NULL);
            if (offset1 != offset2)
                goto out;
        }

        retval = TRUE;
    }

 out:

    e_cal_component_free_datetime (&start_datetime);
    e_cal_component_free_datetime (&end_datetime);

    return retval;
}

/**
 * cal_comp_confirm_delete_empty_comp:
 * @comp: A calendar component.
 * @client: Calendar client where the component purportedly lives.
 * @widget: Widget to be used as the basis for UTF8 conversion.
 *
 * Assumming a calendar component with an empty SUMMARY property (as per
 * string_is_empty()), asks whether the user wants to delete it based on
 * whether the appointment is on the calendar server or not.  If the
 * component is on the server, this function will present a confirmation
 * dialog and delete the component if the user tells it to.  If the component
 * is not on the server it will just return TRUE.
 *
 * Return value: A result code indicating whether the component
 * was not on the server and is to be deleted locally, whether it
 * was on the server and the user deleted it, or whether the
 * user cancelled the deletion.
 **/
gboolean
cal_comp_is_on_server (ECalComponent *comp, ECal *client)
{
    const char *uid;
    char *rid = NULL;
    icalcomponent *icalcomp;
    GError *error = NULL;

    g_return_val_if_fail (comp != NULL, FALSE);
    g_return_val_if_fail (E_IS_CAL_COMPONENT (comp), FALSE);
    g_return_val_if_fail (client != NULL, FALSE);
    g_return_val_if_fail (E_IS_CAL (client), FALSE);

    /* See if the component is on the server.  If it is not, then it likely
     * means that the appointment is new, only in the day view, and we
     * haven't added it yet to the server.  In that case, we don't need to
     * confirm and we can just delete the event.  Otherwise, we ask
     * the user.
     */
    e_cal_component_get_uid (comp, &uid);

    /*TODO We should not be checking for this here. But since e_cal_util_construct_instance does not
      create the instances of all day events, so we dafault to old behaviour */
    if (e_cal_get_static_capability (client, CAL_STATIC_CAPABILITY_RECURRENCES_NO_MASTER)) {
        rid = e_cal_component_get_recurid_as_string (comp);
    }

    if (e_cal_get_object (client, uid, rid, &icalcomp, &error)) {
        icalcomponent_free (icalcomp);
        g_free (rid);

        return TRUE;
    }

    if (error->code != E_CALENDAR_STATUS_OBJECT_NOT_FOUND)
        g_warning (G_STRLOC ": %s", error->message);

    g_clear_error (&error);
    g_free (rid);

    return FALSE;
}

/**
 * is_icalcomp_on_the_server:
 * same as @cal_comp_is_on_server, only the component parameter is icalcomponent, not the ECalComponent.
 **/
gboolean
is_icalcomp_on_the_server (icalcomponent *icalcomp, ECal *client)
{
    gboolean on_server;
    ECalComponent *comp;

    if (!icalcomp || !client || !icalcomponent_get_uid (icalcomp))
        return FALSE;

    comp = e_cal_component_new ();
    e_cal_component_set_icalcomponent (comp, icalcomponent_new_clone (icalcomp));

    on_server = cal_comp_is_on_server (comp, client);

    g_object_unref (comp);

    return on_server;
}

/**
 * cal_comp_event_new_with_defaults:
 *
 * Creates a new VEVENT component and adds any default alarms to it as set in
 * the program's configuration values.
 *
 * Return value: A newly-created calendar component.
 **/
ECalComponent *
cal_comp_event_new_with_defaults (ECal *client)
{
    icalcomponent *icalcomp;
    ECalComponent *comp;
    int interval;
    CalUnits units;
    ECalComponentAlarm *alarm;
    icalproperty *icalprop;
    ECalComponentAlarmTrigger trigger;

    if (!e_cal_get_default_object (client, &icalcomp, NULL))
        icalcomp = icalcomponent_new (ICAL_VEVENT_COMPONENT);

    comp = e_cal_component_new ();
    if (!e_cal_component_set_icalcomponent (comp, icalcomp)) {
        icalcomponent_free (icalcomp);

        e_cal_component_set_new_vtype (comp, E_CAL_COMPONENT_EVENT);
    }

    if (!calendar_config_get_use_default_reminder ())
        return comp;

    interval = calendar_config_get_default_reminder_interval ();
    units = calendar_config_get_default_reminder_units ();

    alarm = e_cal_component_alarm_new ();

    /* We don't set the description of the alarm; we'll copy it from the
     * summary when it gets committed to the server. For that, we add a
     * X-EVOLUTION-NEEDS-DESCRIPTION property to the alarm's component.
     */
    icalcomp = e_cal_component_alarm_get_icalcomponent (alarm);
    icalprop = icalproperty_new_x ("1");
    icalproperty_set_x_name (icalprop, "X-EVOLUTION-NEEDS-DESCRIPTION");
    icalcomponent_add_property (icalcomp, icalprop);

    e_cal_component_alarm_set_action (alarm, E_CAL_COMPONENT_ALARM_DISPLAY);

    trigger.type = E_CAL_COMPONENT_ALARM_TRIGGER_RELATIVE_START;

    memset (&trigger.u.rel_duration, 0, sizeof (trigger.u.rel_duration));

    trigger.u.rel_duration.is_neg = TRUE;

    switch (units) {
    case CAL_MINUTES:
        trigger.u.rel_duration.minutes = interval;
        break;

    case CAL_HOURS:
        trigger.u.rel_duration.hours = interval;
        break;

    case CAL_DAYS:
        trigger.u.rel_duration.days = interval;
        break;

    default:
        g_warning ("wrong units %d\n", units);
    }

    e_cal_component_alarm_set_trigger (alarm, trigger);

    e_cal_component_add_alarm (comp, alarm);
    e_cal_component_alarm_free (alarm);

    return comp;
}

ECalComponent *
cal_comp_event_new_with_current_time (ECal *client, gboolean all_day)
{
    ECalComponent *comp;
    struct icaltimetype itt;
    ECalComponentDateTime dt;
    icaltimezone *zone;

    comp = cal_comp_event_new_with_defaults (client);

    g_return_val_if_fail (comp, NULL);

    zone = calendar_config_get_icaltimezone ();
    if (all_day) {
        itt = icaltime_from_timet_with_zone (time (NULL), 1, zone);

        dt.value = &itt;
        dt.tzid = icaltimezone_get_tzid (zone);

        e_cal_component_set_dtstart (comp, &dt);
        e_cal_component_set_dtend (comp, &dt);
    } else {
        itt = icaltime_current_time_with_zone (zone);
        icaltime_adjust (&itt, 0, 1, -itt.minute, -itt.second);

        dt.value = &itt;
        dt.tzid = icaltimezone_get_tzid (zone);

        e_cal_component_set_dtstart (comp, &dt);
        icaltime_adjust (&itt, 0, 1, 0, 0);
        e_cal_component_set_dtend (comp, &dt);
    }

    return comp;
}

ECalComponent *
cal_comp_task_new_with_defaults (ECal *client)
{
    ECalComponent *comp;
    icalcomponent *icalcomp;

    if (!e_cal_get_default_object (client, &icalcomp, NULL))
        icalcomp = icalcomponent_new (ICAL_VTODO_COMPONENT);

    comp = e_cal_component_new ();
    if (!e_cal_component_set_icalcomponent (comp, icalcomp)) {
        icalcomponent_free (icalcomp);

        e_cal_component_set_new_vtype (comp, E_CAL_COMPONENT_TODO);
    }

    return comp;
}

ECalComponent *
cal_comp_memo_new_with_defaults (ECal *client)
{
    ECalComponent *comp;
    icalcomponent *icalcomp;

    if (!e_cal_get_default_object (client, &icalcomp, NULL))
        icalcomp = icalcomponent_new (ICAL_VJOURNAL_COMPONENT);

    comp = e_cal_component_new ();
    if (!e_cal_component_set_icalcomponent (comp, icalcomp)) {
        icalcomponent_free (icalcomp);

        e_cal_component_set_new_vtype (comp, E_CAL_COMPONENT_JOURNAL);
    }

    return comp;
}

/**
 * cal_comp_util_get_n_icons:
 * @comp: A calendar component object.
 *
 * Get the number of icons owned by the component.
 *
 * Returns: the number of icons owned by the component.
 **/
gint
cal_comp_util_get_n_icons (ECalComponent *comp)
{
    GSList *categories_list, *elem;
    gint num_icons = 0;

    g_return_val_if_fail (comp != NULL, 0);
    g_return_val_if_fail (E_IS_CAL_COMPONENT (comp), 0);

    e_cal_component_get_categories_list (comp, &categories_list);
    for (elem = categories_list; elem; elem = elem->next) {
        char *category;
        GdkPixmap *pixmap = NULL;
        GdkBitmap *mask = NULL;

        category = (char *) elem->data;
        if (e_categories_config_get_icon_for (category, &pixmap, &mask)) {
            num_icons++;
            g_object_unref (pixmap);
            if (mask)
                g_object_unref (mask);
        }
    }
    e_cal_component_free_categories_list (categories_list);

    return num_icons;
}

/**
 * cal_comp_selection_set_string_list
 * Stores list of strings into selection target data.
 * Use @ref cal_comp_selection_get_string_list to get this list from target data.
 *
 * @param data Selection data, where to put list of strings.
 * @param str_list List of strings. (Each element is of type const gchar *.)
 **/
void
cal_comp_selection_set_string_list (GtkSelectionData *data, GSList *str_list)
{
    /* format is "str1\0str2\0...strN\0" */
    GSList *p;
    GByteArray *array;

    g_return_if_fail (data != NULL);

    if (!str_list)
        return;

    array = g_byte_array_new ();
    for (p = str_list; p; p = p->next) {
        const guint8 *c = p->data;

        if (c)
            g_byte_array_append (array, c, strlen ((const char *) c) + 1);
    }

    gtk_selection_data_set (data, data->target, 8, array->data, array->len);
    g_byte_array_free (array, TRUE);
}

/**
 * cal_comp_selection_get_string_list
 * Converts data from selection to list of strings. Data should be assigned
 * to selection data with @ref cal_comp_selection_set_string_list.
 * Each string in newly created list should be freed by g_free.
 * List itself should be freed by g_slist_free.
 *
 * @param data Selection data, where to put list of strings.
 * @return Newly allocated GSList of strings.
 **/
GSList *
cal_comp_selection_get_string_list (GtkSelectionData *data)
{
    /* format is "str1\0str2\0...strN\0" */
    char *inptr, *inend;
    GSList *list;

    g_return_val_if_fail (data != NULL, NULL);

    list = NULL;
    inptr = (char *)data->data;
    inend = (char *)(data->data + data->length);

    while (inptr < inend) {
        char *start = inptr;

        while (inptr < inend && *inptr)
            inptr++;

        list = g_slist_prepend (list, g_strndup (start, inptr - start));

        inptr++;
    }

    return list;
}

static void
datetime_to_zone (ECal *client, ECalComponentDateTime *date, const char *tzid)
{
    icaltimezone *from, *to;

    g_return_if_fail (date != NULL);

    if (date->tzid == NULL || tzid == NULL ||
        date->tzid == tzid || g_str_equal (date->tzid, tzid))
        return;

    from = icaltimezone_get_builtin_timezone_from_tzid (date->tzid);
    if (!from) {
        if (!e_cal_get_timezone (client, date->tzid, &from, NULL))
            g_warning ("%s: Could not get timezone from server: %s", G_STRFUNC, date->tzid ? date->tzid : "");
    }

    to = icaltimezone_get_builtin_timezone_from_tzid (tzid);
    if (!to) {
        /* do not check failure here, maybe the zone is not available there */
        e_cal_get_timezone (client, tzid, &to, NULL);
    }

    icaltimezone_convert_time (date->value, from, to);
    date->tzid = tzid;
}

/**
 * cal_comp_set_dtstart_with_oldzone:
 * Changes 'dtstart' of the component, but converts time to the old timezone.
 * @param client ECal structure, to retrieve timezone from, when required.
 * @param comp Component, where make the change.
 * @param pdate Value, to change to.
 **/
void
cal_comp_set_dtstart_with_oldzone (ECal *client, ECalComponent *comp, const ECalComponentDateTime *pdate)
{
    ECalComponentDateTime olddate, date;

    g_return_if_fail (comp != NULL);
    g_return_if_fail (pdate != NULL);

    e_cal_component_get_dtstart (comp, &olddate);

    date = *pdate;

    datetime_to_zone (client, &date, olddate.tzid);
    e_cal_component_set_dtstart (comp, &date);

    e_cal_component_free_datetime (&olddate);
}

/**
 * cal_comp_set_dtend_with_oldzone:
 * Changes 'dtend' of the component, but converts time to the old timezone.
 * @param client ECal structure, to retrieve timezone from, when required.
 * @param comp Component, where make the change.
 * @param pdate Value, to change to.
 **/
void
cal_comp_set_dtend_with_oldzone (ECal *client, ECalComponent *comp, const ECalComponentDateTime *pdate)
{
    ECalComponentDateTime olddate, date;

    g_return_if_fail (comp != NULL);
    g_return_if_fail (pdate != NULL);

    e_cal_component_get_dtend (comp, &olddate);

    date = *pdate;

    datetime_to_zone (client, &date, olddate.tzid);
    e_cal_component_set_dtend (comp, &date);

    e_cal_component_free_datetime (&olddate);
}