libgcal-dev 0.9.6-3.1 / usr / include / libgcal / gcal.h

/*
  Copyright (c) 2008 Instituto Nokia de Tecnologia
  All rights reserved.

  Redistribution and use in source and binary forms, with or without modification,
  are permitted provided that the following conditions are met:

  * Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
  * Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
  * Neither the name of the INdT nor the names of its contributors
  may be used to endorse or promote products derived from this software
  without specific prior written permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  POSSIBILITY OF SUCH DAMAGE.
*/
/**
 * @file   gcal.h
 * @author Adenilson Cavalcanti da Silva <adenilson.silva@indt.org.br>
 * @date   Mon Mar  3 20:15:09 2008
 *
 * @brief  libgcal header file.
 *
 * This defines the public functions.
 *
 */
#ifndef __GCAL_LIB__
#define __GCAL_LIB__

/* For size_t */
#include <stdlib.h>

/** Set gcal Google service mode */
typedef enum { GCALENDAR, GCONTACT } gservice;

/** Flag to control if deleted entries will be retrieved or not
 * (for while, google only implements that for 'contacts').
 * Calendar deleted entries will *always* be returned with
 * 'eventStatus' set to 'cancelled'.
 *
 */
typedef enum { HIDE, SHOW } display_deleted_entries;

/** Upload (being POST or PUT) definition option.
 *
 * Its used to set behavior in \ref up_entry function.
 */
typedef enum {
	/** Code for HTTP POST. */
	POST,
	/** Code for HTTP PUT */
	PUT } HTTP_CMD;

/** Really weird timestamp from RFC 3339 is
 * 1937-01-01T12:00:27.87+00:20
 * so 30 bytes is enough to have milisecond precision
 * in worst case.
 */
static const size_t TIMESTAMP_MAX_SIZE = 30;

/** Minimal timestamp size is
 * 1937-01-01T12:00:27.87Z
 */
static const size_t TIMESTAMP_SIZE = 23;


/** Library structure. It holds resources (curl, buffer, etc).
 */
struct gcal_resource;

/** Library structure, represents each calendar event entry.
 */
struct gcal_event;

/** Library structure, represents common data for a google entry (being
 * calendar or contact). It has: id, updated, title, edit_uri.
 */
struct gcal_entry;

/** An opaque type for gcal object.
 */
typedef struct gcal_resource * gcal_t;


/** Library structure destructor (use it free its internal resources properly).
 */
void gcal_destroy(struct gcal_resource *gcal_obj);

/** Internal use function, cleans up the internal buffer.
 *
 * \todo move it to a distinct internal module.
 *
 * @param gcal_obj Library resource structure pointer.
 */
void clean_buffer(struct gcal_resource *gcal_obj);


/** Library structure constructor, the user can only have pointers to the
 * library \ref gcal_resource structure.
 *
 * Concerning google service type, it defaults to google calendar. You can
 * change it using \ref gcal_set_service.
 *
 * @param mode Service that libgcal will handle (for while, GCALENDAR
 * and GCONTACT).
 *
 * @return A pointer to a newly created object or NULL.
 */
struct gcal_resource *gcal_construct(gservice mode);

/** Sets the google service that user wants to authenticate.
 *
 * For while, only calendar (cl) and contacts (cp) are supported.
 *
 * @param gcalobj Pointer to a library resource structure \ref gcal_resource.
 *
 * @param mode Service type, see \ref gservice.
 *
 * @return 0 for success, -1 otherwise.
 */
int gcal_set_service(struct gcal_resource *gcalobj, gservice mode);


/** Gets from google an authentication token, using the 'ClientLogin' service.
 *
 * Use it before getting/setting google calendar events. If you are behind of
 * a network proxy, its import to use \ref gcal_set_proxy *before* to set
 * the proxy (or all network connections will hang and timeout).
 *
 * @param gcalobj Pointer to a library resource structure \ref gcal_resource
 *
 * @param user The user google login account.
 *
 * @param password User password in plain text
 *                 \todo think in a way to encrypt password
 *
 * @return Returns 0 on success, -1 otherwise.
 */
int gcal_get_authentication(struct gcal_resource *gcalobj,
			    char *user, char *password);


/** Dumps events from default calendar to internal buffer.
 * \todo Let the library user select which calendar he/she wants
 * to get the events. See \ref gcal_calendar_list.
 *
 * @param gcalobj Pointer to a \ref gcal_resource structure, which has
 *                 previously got the authentication using
 *                 \ref gcal_get_authentication.
 *
 * @param gdata_version Version of Data API.
 *
 * @return Returns 0 on success, -1 otherwise.
 */
int gcal_dump(struct gcal_resource *gcalobj, const char *gdata_version);

/** Get a list of users calendars (gcalendar supports multiple calendars
 * besides the default calendar).
 *
 * I think it would be a good idea to let the library user decide which
 * calendar to get the events. See too \ref gcal_dump.
 *
 * \todo Parse the Atom feed and provide easy access to the calendar lists.
 *
 * @param gcalobj Pointer to a \ref gcal_resource structure, which has
 *                 previously got the authentication using
 *                 \ref gcal_get_authentication.
 *
 * @return Returns 0 on success, -1 otherwise.
 */
int gcal_calendar_list(struct gcal_resource *gcalobj);


/** Return the number of event entries a calendar has (you should
 * had got the atom stream before, using \ref gcal_dump).
 *
 * @param gcalobj Pointer to a \ref gcal_resource structure, which has
 *                 previously got the authentication using
 *                 \ref gcal_get_authentication.
 *
 * @return -1 on error, any number >= 0 otherwise.
 */
int gcal_entry_number(struct gcal_resource *gcalobj);


/** Extracts from the atom stream the calendar event entries (you should
 * had got the atom stream before, using \ref gcal_dump).
 *
 * Pay attention that it returns a vector of structures that must be destroyed
 * using \ref gcal_destroy_entries.
 *
 * Since atom XML feeds can get huge, as soon the function creates entries
 * vector and copies the data from the internal \ref gcal_resource buffer,
 * it will free its internal buffer to save memory.
 *
 *
 * @param gcalobj Pointer to a \ref gcal_resource structure, which has
 *                 previously got the authentication using
 *                 \ref gcal_get_authentication.
 *
 * @param length Pointer to an unsigned int, it will have the vector length.
 *
 * @return A pointer on sucess, NULL otherwise.
 */
struct gcal_event *gcal_get_entries(struct gcal_resource *gcalobj,
				    size_t *length);


/** Always use this to set calendar event structure to a sane state.
 *
 * You were warned...
 *
 * @param entry A pointer to a \ref gcal_event.
 */
void gcal_init_event(struct gcal_event *entry);


/** Cleanup memory of 1 entry structure pointer.
 *
 *
 * @param entry A pointer to a \ref gcal_event.
 */
void gcal_destroy_entry(struct gcal_event *entry);


/** Generic HTTP GET function.
 *
 * Used when getting entries in a feed (or other data that requires
 * an authenticated GET).
 *
 * @param gcalobj Pointer to a \ref gcal_resource structure, which has
 *                 previously got the authentication using
 *                 \ref gcal_get_authentication.
 *
 * @param url URL string.
 *
 * @param cb_download Callback used for writing downloaded data. Must
 * be of type: size_t()(void *, size_t, size_t, void*)
 *
 * @param gdata_version Version of Data API.
 *
 * @return 0 for success, -1 for error.
 */
int get_follow_redirection(struct gcal_resource *gcalobj, const char *url,
			   void *cb_download, const char *gdata_version);


/** Cleanup the memory of a vector of calendar entries created using
 * \ref gcal_get_entries.
 *
 * @param entries A pointer to a vector of \ref gcal_event structure.
 *
 * @param length The vector length.
 */
void gcal_destroy_entries(struct gcal_event *entries, size_t length);

/** Posts data to a server URL and checks its result.
 *
 * I'm not sure if this one should be here, since it is a more an internal
 * function (but I need to share it with 'contacts' too).
 *
 * \todo move it to a distinct internal module.
 * @param gcalobj Pointer to a \ref gcal_resource structure, which has
 *                 previously got the authentication using
 *                 \ref gcal_get_authentication.
 *
 * @param url The server URL.
 * @param header First header part.
 * @param header2 Second header part (can be NULL).
 * @param header3 Third header part (can be NULL).
 * @param header4 Third header part (can be NULL). Used for ETag (Google Data
 * API 2.0)
 * @param post_data The data to post (can be NULL).
 * @param length The data length (can be zero).
 * @param expected_answer The expected answer code, see GCAL_DEFAULT_ANSWER and
 * friends.
 *
 * @return -1 on error, 0 on success.
 */
int http_post(struct gcal_resource *gcalobj, const char *url,
	      char *header, char *header2, char *header3,
	      char *header4,
	      char *post_data, unsigned int length,
	      const int expected_answer,
	      const char *gdata_version);


/** Uploads an entry (calendar or contact) to a server URL
 *
 * Used by \ref gcal_create_event, \ref gcal_create_contact,
 * \ref gcal_edit_event.
 *
 *
 * @param data2post A pointer to string, it will be the body to be posted.
 *
 * @param length The data length (can be zero).
 *
 * @param gcalobj Pointer to a \ref gcal_resource structure, which has
 *                 previously got the authentication using
 *                 \ref gcal_get_authentication.
 *
 * @param url_server The URL of server (one for calendar and other for
 * contacts).
 *
 * @param etag Google Data API 2.0 requires an Etag in HTTP header for some
 * operations.
 *
 * @param up_mode If the upload of data will be using PUT or POST (internally
 * it uses 'http_put' and \ref 'http_post').
 *
 * @param content_type The content type, to use default (application/atom+xml)
 * pass NULL.
 *
 * @param expected_code The expected return code from server (200, 201, etc.)
 * See GCAL_DEFAULT_ANSWER and friends.
 *
 * @return -1 on error, 0 on success.
 */
int up_entry(char *data2post, unsigned int m_length,
	     struct gcal_resource *gcalobj,
	     const char *url_server, char *etag,
	     HTTP_CMD up_mode, char *content_type,
	     int expected_code);


/** Creates an new calendar event.
 *
 * You need to first succeed to get an authorization token using
 * \ref gcal_get_authentication.
 *
 * @param gcalobj Pointer to a \ref gcal_resource structure, which has
 *                 previously got the authentication using
 *                 \ref gcal_get_authentication.
 *
 * @param entries A pointer to an calendar entry event (see \ref gcal_event).
 *
 * @param updated Pass a pointer to a \ref gcal_event structure if you
 * wish to access the newly created contact (i.e. access fields like
 * edit_uri and id). If you don't need it, just pass NULL.
 *
 * @return -1 on error, 0 on success, -2 if operation went correctly but
 * cannot return 'updated' entry.
 */
int gcal_create_event(struct gcal_resource *gcalobj,
		      struct gcal_event *entries,
		      struct gcal_event *updated);

/** Deletes a calendar event.
 *
 * You need to first succeed to get an authorization token using
 * \ref gcal_get_authentication.
 *
 * @param gcalobj Pointer to a \ref gcal_resource structure, which has
 *                 previously got the authentication using
 *                 \ref gcal_get_authentication.
 *
 * @param entry A pointer to one calendar entry event (see \ref gcal_event).
 *
 * @return -1 on error, 0 on success.
 */
int gcal_delete_event(struct gcal_resource *gcalobj,
		      struct gcal_event *entry);


/** Edits a calendar event.
 *
 * It requires the presence of field 'edit_uri' in entry pointer structure
 * (see \ref gcal_event).
 *
 *
 * @param gcalobj Pointer to a \ref gcal_resource structure, which has
 *                 previously got the authentication using
 *                 \ref gcal_get_authentication.
 *
 * @param entry A pointer to an calendar entry event.
 *
 * @param updated Pass a pointer to a \ref gcal_event structure if you
 * wish to access the newly created contact (i.e. access fields like
 * edit_uri and id). If you don't need it, just pass NULL.
 *
 * @return -1 on error, 0 on success, -2 if operation went correctly but
 * cannot return 'updated' entry.
 */
int gcal_edit_event(struct gcal_resource *gcalobj,
		    struct gcal_event *entry,
		    struct gcal_event *updated);



/** Provides access to internal buffer (e.g. to access the raw Atom stream).
 *
 * Pay attention that you *must not* mess with its memory, since when deleting
 * the gcal_resource pointer with \ref gcal_destroy the memory pointed will
 * be freed.
 *
 * @param gcalobj Pointer to a \ref gcal_resource structure, which has
 *                 previously got the authentication using
 *                 \ref gcal_get_authentication.
 *
 * @return A pointer to internal gcal_resource buffer.
 */
char *gcal_access_buffer(struct gcal_resource *gcalobj);

/** Function to get the current timestamp (RFC3339) with milisecond
 * precision.
 *
 * @param timestamp A pointer to a buffer to where to write the timestamp.
 *
 * @param length The buffer length.
 *
 * @param atimezone A timezone string in format: +/-hh:mm:ss. It will be
 * appended to the output timestamp.
 *
 * @return 0 for success, -1 for failure.
 */
int get_mili_timestamp(char *timestamp, size_t length, char *atimezone);


/** Returns all entries (being calendar or contacts) that are newer
 * than a timestamp.
 *
 * Use it to get updated entries.
 *
 * @param gcalobj  Pointer to a \ref gcal_resource structure, which has
 *                 previously got the authentication using
 *                 \ref gcal_get_authentication.
 *
 * @param timestamp A timestamp in RFC 3339 format yyyy-mm-ddThh:mm:ss
 *(if NULL, this function will use current day, with time set to 06:00AM).
 *
 * @param gdata_version Version of Data API.
 *
 * @return -1 on error, 0 on success.
 */
int gcal_query_updated(struct gcal_resource *gcalobj, char *timestamp,
		const char *gdata_version);

/** Set a timezone, following the RFC 3339 format +/-hh:mm.
 *
 * The structure copy the string with the timezone.
 *
 * @param gcalobj Pointer to a \ref gcal_resource structure, which has
 *                 previously got the authentication using
 *                 \ref gcal_get_authentication.
 *
 * @param atimezone A pointer to string with the timezone (e.g. for Helsinki
 * which is +2GMT it would be "+02:00").
 *
 * @return -1 on error, 0 on success.
 */
int gcal_set_timezone(struct gcal_resource *gcalobj, char *atimezone);

/** Sets gcal XML store mode.
 *
 * Use it if you wish to store the RAW google XML entry data inside
 * each entry object.
 *
 * @param gcalobj Pointer to a \ref gcal_resource structure, which has
 *                 previously got the authentication using
 *                 \ref gcal_get_authentication.
 *
 * @param flag 0 for not store, 1 to activate store mode.
 */
void gcal_set_store_xml(struct gcal_resource *gcalobj, char flag);

/** Sets network proxy.
 *
 * Use it if you are behind a network proxy and can't directly access
 * the google server.
 *
 * @param gcalobj Pointer to a \ref gcal_resource structure, which has
 *                 previously got the authentication using
 *                 \ref gcal_get_authentication.
 *
 * @param proxy A null terminated string, must have the hostname (or IP)
 * and can have the user+password too (e.g. "user+password@10.10.1.1:8080" or
 * simply "http://hostname:port". Remark: I only tested it with
 * a proxy that doesn't require authentication.
 *
 */
void gcal_set_proxy(struct gcal_resource *gcalobj, char *proxy);

/** Define the location that results should be returned for queries.
 *
 * Use it to set your current location, otherwise the configured city for
 * the user account is used.
 * The structure copy the string with the timezone.
 *
 * @param gcalobj Pointer to a \ref gcal_resource structure, which has
 *                 previously got the authentication using
 *                 \ref gcal_get_authentication.
 *
 * @param location A pointer to string with the location (e.g. "America/Manaus",
 * "Europe/Helsinki", "America/Los_Angeles'). It must not has empty spaces on
 * it.
 *
 * @return -1 on error, 0 on success.
 */
int gcal_set_location(struct gcal_resource *gcalobj, char *location);

/** Use this to set if deleted entries should be returned or not. Pay attention
 * that this is implemented only for google contacts (google calendar entries
 * doesn't have this query parameter).
 *
 * @param gcalobj Pointer to a \ref gcal_resource structure, which has
 *                 previously got the authentication using
 *                 \ref gcal_get_authentication.
 *
 * @param opt Option parameter, enable (SHOW) or not (HIDE) retrieving of
 * deleted entries (see \ref display_deleted_entries).
 */
void gcal_deleted(struct gcal_resource *gcalobj, display_deleted_entries opt);


/** Generic query function, use it to do a query to google services.
 *
 * You can pass a query with multiple parameters, but in just one string.
 *
 * ATTENTION: querying by name will not work, since its not implemented in
 * google contacts. It will give HTTP 403 error.
 *
 * @param gcalobj Pointer to a \ref gcal_resource structure, which has
 *                 previously got the authentication using
 *                 \ref gcal_get_authentication.
 *
 * @param parameters A string with the query e.g. for calendar
 * gcal_query(gcal, "ctz=America/Los_Angeles&author=Joe");
 *
 * And for contacts:
 * gcal_query(gcal, "updated-min=2008-06-20T06:00:00Z&"
 *                  "alt=atom&max-results=500&showdeleted=true");
 *
 * @param gdata_version Version of Data API.
 *
 * @return -1 on error, 0 on success.
 */
int gcal_query(struct gcal_resource *gcalobj, const char *parameters,
		const char *gdata_version);


/* Common fields between calendar and contacts are
 * of type 'gcal_entry'
 */

/** Access to entry ID.
 *
 * Each google entry (event/contact) has a unique ID, you can access
 * it using this function.
 *
 * @param entry A data entry pointer, see \ref gcal_entry.
 *
 * @return A pointer to internal field (*dont* try to free it!).
 */
char *gcal_get_id(struct gcal_entry *entry);

/** Access to last updated timestamp of an entry.
 *
 * When an operation (being add/edit/delete) is done in an entry, the timestamp
 * of it is recorded). You can access it using this function.
 *
 * @param entry A data entry pointer, see \ref gcal_entry.
 *
 * @return A pointer to internal field (*dont* try to free it!).
 */
char *gcal_get_updated(struct gcal_entry *entry);

/** Access entry title.
 *
 * Each entry has a title, being contacts (the contact name) or event
 * (meeting title).
 *
 * @param entry A data entry pointer, see \ref gcal_entry.
 *
 * @return A pointer to internal field (*dont* try to free it!).
 */
char *gcal_get_title(struct gcal_entry *entry);

/** Access edit url.
 *
 * Each entry has an edit url (which is the combination of ID + cookie).
 * This edit url is required to do operations (edit/delete) and changes
 * each time an operation is done.
 *
 * @param entry A data entry pointer, see \ref gcal_entry.
 *
 * @return A pointer to internal field (*dont* try to free it!).
 */
char *gcal_get_url(struct gcal_entry *entry);

/** Access ETag.
 *
 * Each entry has an ETag (Google Data API 2.0).
 * This etag is required to do operations (edit/delete) and changes
 * each time an operation is done.
 *
 * @param entry A data entry pointer, see \ref gcal_entry.
 *
 * @return A pointer to internal field (*dont* try to free it!).
 */
char *gcal_get_etag(struct gcal_entry *entry);

/** Access raw XML.
 *
 * Even if some fields are parsed from atom stream and directly accessable
 * from entry objects, its possible to access the RAW representation of the
 * whole entry using this function.
 *
 * @param entry A data entry pointer, see \ref gcal_entry.
 *
 * @return A pointer to internal field (*dont* try to free it!).
 */
char *gcal_get_xml(struct gcal_entry *entry);

/** Entry status (deleted: 1, not: 0).
 *
 * When an entry is deleted, there is a way to known it, being specific for
 * the entry type. Events have the gd:eventStatus equal to
 * "blah#event.cancelled".
 *
 * Contacts will have a new field (gd:deleted).
 *
 * @param entry A data entry pointer, see \ref gcal_entry.
 *
 * @return 1 for deleted, 0 for not deleted, -1 for error case (f the event
 * object is invalid).
 */
char gcal_get_deleted(struct gcal_entry *entry);

/** Global cleanup (use only at end of program)
 *
 * Cleans up any global variables that the library may use (which currently
 * it doesn't use), as well as calls libxml2's xmlCleanupParser().
 *
 * Rationale: if the linked application is also using libxml and xmlCleanuParser
 * is called from within libgcal, it will at very best mess up with the
 * other code. Special thanks for Chris Frey for finding this bug and
 * fixing.
 */
void gcal_final_cleanup();

#endif