calendar.h File Reference

A general API for managing calendar events with Asterisk. More...

#include "asterisk.h"
#include "asterisk/stringfields.h"
#include "asterisk/config.h"
#include "asterisk/linkedlists.h"
#include "asterisk/lock.h"
#include "asterisk/dial.h"

Include dependency graph for calendar.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ast_calendar
	Asterisk calendar structure. More...
struct	ast_calendar_attendee
struct	ast_calendar_event
struct	ast_calendar_event::attendees
struct	ast_calendar_tech
	Individual calendaring technology data. More...
Enumerations
enum	ast_calendar_busy_state { AST_CALENDAR_BS_FREE = 0, AST_CALENDAR_BS_BUSY_TENTATIVE, AST_CALENDAR_BS_BUSY }
Functions
void	ast_calendar_clear_events (struct ast_calendar *cal)
	Remove all events from calendar.
struct ast_config *	ast_calendar_config_acquire (void)
	Grab and lock pointer to the calendar config (read only).
void	ast_calendar_config_release (void)
	Release the calendar config.
struct ast_calendar_event *	ast_calendar_event_alloc (struct ast_calendar *cal)
	Allocate an astobj2 ast_calendar_event object.
struct ao2_container *	ast_calendar_event_container_alloc (void)
	Allocate an astobj2 container for ast_calendar_event objects.
void	ast_calendar_merge_events (struct ast_calendar *cal, struct ao2_container *new_events)
	Add an event to the list of events for a calendar.
int	ast_calendar_register (struct ast_calendar_tech *tech)
	Register a new calendar technology.
struct ast_calendar_event *	ast_calendar_unref_event (struct ast_calendar_event *event)
	Unreference an ast_calendar_event.
void	ast_calendar_unregister (struct ast_calendar_tech *tech)
	Unregister a new calendar technology.

---

Detailed Description

A general API for managing calendar events with Asterisk.

Author:

Terry Wilson <twilson@digium.com>

Note:

This API implements an abstraction for handling different calendaring technologies in Asterisk. The services provided by the API are a dialplan function to query whether or not a calendar is busy at the present time, a adialplan function to query specific information about events in a time range, a devicestate provider, and notification of calendar events through execution of dialplan apps or dialplan logic at a specific context and extension. The information available through the CALENDAR_EVENT() dialplan function are:

SUMMARY, DESCRIPTION, ORGANIZER, LOCATION CALENDAR, UID, START, END, and BUSYSTATE

BUSYSTATE can have the values 0 (free), 1 (tentatively busy), or 2 (busy)

Usage All calendaring configuration data is located in calendar.conf and is only read directly by the Calendaring API. Each calendar technology resource must register a load_calendar callback which will be passed an ast_calendar_load_data structure. The load_calendar callback function should then set the values it needs from this cfg, load the calendar data, and then loop updating the calendar data and events baesd on the refresh interval in the ast_calendar object. Each call to the load_calendar callback will be will run in its own thread.

Updating events involves creating an astobj2 container of new events and passing it to the API through ast_calendar_merge_events.

Calendar technology resource modules must also register an unref_calendar callback which will only be called when the resource module calls ast_calendar_unregister() to unregister that module's calendar type (usually done in module_unload())

Definition in file calendar.h.

---

Enumeration Type Documentation

enum ast_calendar_busy_state

Enumerator:

AST_CALENDAR_BS_FREE
AST_CALENDAR_BS_BUSY_TENTATIVE
AST_CALENDAR_BS_BUSY

Definition at line 79 of file calendar.h.

                             {
   AST_CALENDAR_BS_FREE = 0,
   AST_CALENDAR_BS_BUSY_TENTATIVE,
   AST_CALENDAR_BS_BUSY,
};

---

Function Documentation

void ast_calendar_clear_events

(

struct ast_calendar *

cal

)

Remove all events from calendar.

Parameters:

cal

calendar whose events need to be cleared

Definition at line 626 of file res_calendar.c.

References ao2_callback, ast_debug, clear_events_cb(), ast_calendar::events, ast_calendar::name, OBJ_MULTIPLE, OBJ_NODATA, and OBJ_UNLINK.

Referenced by calendar_destructor().

{
   ast_debug(3, "Clearing all events for calendar %s\n", cal->name);

   ao2_callback(cal->events, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, clear_events_cb, NULL);
}

struct ast_config* ast_calendar_config_acquire

(

void

)

[read]

Grab and lock pointer to the calendar config (read only).

Note:

ast_calendar_config_release must be called when finished with the pointer

Returns:

the parsed calendar config

Definition at line 249 of file res_calendar.c.

References ast_rwlock_rdlock, and ast_rwlock_unlock.

Referenced by caldav_load_calendar(), ewscal_load_calendar(), exchangecal_load_calendar(), and ical_load_calendar().

{
   ast_rwlock_rdlock(&config_lock);

   if (!calendar_config) {
      ast_rwlock_unlock(&config_lock);
      return NULL;
   }

   return calendar_config;
}

void ast_calendar_config_release

(

void

)

Release the calendar config.

Definition at line 261 of file res_calendar.c.

References ast_rwlock_unlock, and config_lock.

Referenced by caldav_load_calendar(), ewscal_load_calendar(), exchangecal_load_calendar(), and ical_load_calendar().

{
   ast_rwlock_unlock(&config_lock);
}

struct ast_calendar_event* ast_calendar_event_alloc

(

struct ast_calendar *

cal

)

[read]

Allocate an astobj2 ast_calendar_event object.

Parameters:

cal

calendar to allocate an event for

Returns:

a new, initialized calendar event

Definition at line 633 of file res_calendar.c.

References ao2_alloc, ast_calendar_unref_event(), AST_LIST_HEAD_INIT_NOLOCK, ast_string_field_init, ast_calendar_event::attendees, calendar_event_destructor(), and evententry::event.

Referenced by caldav_add_event(), calendar_write_exec(), icalendar_add_event(), parse_tag(), and startelm().

{
   struct ast_calendar_event *event;
   if (!(event = ao2_alloc(sizeof(*event), calendar_event_destructor))) {
      return NULL;
   }

   if (ast_string_field_init(event, 32)) {
      event = ast_calendar_unref_event(event);
      return NULL;
   }

   event->owner = cal;
   event->notify_sched = -1;
   event->bs_start_sched = -1;
   event->bs_end_sched = -1;

   AST_LIST_HEAD_INIT_NOLOCK(&event->attendees);

   return event;
}

struct ao2_container* ast_calendar_event_container_alloc

(

void

)

[read]

Allocate an astobj2 container for ast_calendar_event objects.

Returns:

a new event container

Definition at line 655 of file res_calendar.c.

References ao2_container_alloc, CALENDAR_BUCKETS, event_cmp_fn(), and event_hash_fn().

Referenced by caldav_load_calendar(), ewscal_load_calendar(), exchangecal_load_calendar(), and ical_load_calendar().

{
   return ao2_container_alloc(CALENDAR_BUCKETS, event_hash_fn, event_cmp_fn);
}

void ast_calendar_merge_events	(	struct ast_calendar *	cal,
		struct ao2_container *	new_events
	)

Add an event to the list of events for a calendar.

Parameters:

	cal	calendar containing the events to be merged
	new_events	an oa2 container of events to be merged into cal->events

Definition at line 1005 of file res_calendar.c.

References add_new_event_cb(), ao2_callback, ast_calendar::events, merge_events_cb(), OBJ_MULTIPLE, OBJ_NODATA, and OBJ_UNLINK.

Referenced by endelm(), icalendar_update_events(), startelm(), update_caldav(), and update_exchangecal().

{
   /* Loop through all events attached to the calendar.  If there is a matching new event
    * merge its data over and handle any schedule changes that need to be made.  Then remove
    * the new_event from new_events so that we are left with only new_events that we can add later. */
   ao2_callback(cal->events, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, merge_events_cb, new_events);

   /* Now, we should only have completely new events in new_events.  Loop through and add them */
   ao2_callback(new_events, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, add_new_event_cb, cal->events);
}

int ast_calendar_register

(

struct ast_calendar_tech *

tech

)

Register a new calendar technology.

Parameters:

tech

calendar technology to register

Return values:

	0	success
	-1	failure

Definition at line 522 of file res_calendar.c.

References AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_log(), ast_verb, ast_calendar_tech::description, evententry::list, load_tech_calendars(), LOG_WARNING, and ast_calendar_tech::type.

Referenced by load_module().

{
   struct ast_calendar_tech *iter;

   AST_LIST_LOCK(&techs);
   AST_LIST_TRAVERSE(&techs, iter, list) {
      if(!strcasecmp(tech->type, iter->type)) {
         ast_log(LOG_WARNING, "Already have a handler for calendar type '%s'\n", tech->type);
         AST_LIST_UNLOCK(&techs);
         return -1;
      }
   }
   AST_LIST_INSERT_HEAD(&techs, tech, list);
   AST_LIST_UNLOCK(&techs);

   ast_verb(2, "Registered calendar type '%s' (%s)\n", tech->type, tech->description);

   return load_tech_calendars(tech);
}

struct ast_calendar_event* ast_calendar_unref_event

(

struct ast_calendar_event *

event

)

[read]

Unreference an ast_calendar_event.

Parameters:

event

event to unref

Returns:

NULL

Definition at line 312 of file res_calendar.c.

References ao2_ref.

Referenced by ast_calendar_event_alloc(), caldav_add_event(), calendar_devstate_change(), calendar_query_exec(), calendar_write_exec(), do_notify(), endelm(), event_notification_destroy(), handle_show_calendar(), icalendar_add_event(), merge_events_cb(), and parse_tag().

{
   ao2_ref(event, -1);
   return NULL;
}

void ast_calendar_unregister

(

struct ast_calendar_tech *

tech

)

Unregister a new calendar technology.

Parameters:

tech

calendar technology to unregister

Return values:

	0	success
	-1	failure

Definition at line 554 of file res_calendar.c.

References ao2_callback, AST_LIST_LOCK, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_LIST_UNLOCK, ast_verb, evententry::list, match_caltech_cb(), OBJ_MULTIPLE, OBJ_NODATA, OBJ_UNLINK, and ast_calendar_tech::type.

Referenced by load_tech_calendars(), and unload_module().

{
   struct ast_calendar_tech *iter;

   AST_LIST_LOCK(&techs);
   AST_LIST_TRAVERSE_SAFE_BEGIN(&techs, iter, list) {
      if (iter != tech) {
         continue;
      }

      ao2_callback(calendars, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, match_caltech_cb, tech);

      AST_LIST_REMOVE_CURRENT(list);
      ast_verb(2, "Unregistered calendar type '%s'\n", tech->type);
      break;
   }
   AST_LIST_TRAVERSE_SAFE_END;
   AST_LIST_UNLOCK(&techs);

}