dd14f963a086876594de536ce37cca5ff8b960f1
[asterisk/asterisk.git] / include / asterisk / calendar.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2008 - 2009, Digium, Inc.
5  *
6  * Terry Wilson <twilson@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 #ifndef _ASTERISK_CALENDAR_H
20 #define _ASTERISK_CALENDAR_H
21
22 #include "asterisk.h"
23 #include "asterisk/stringfields.h"
24 #include "asterisk/config.h"
25 #include "asterisk/linkedlists.h"
26 #include "asterisk/lock.h"
27
28 /*! \file calendar.h
29  * \brief A general API for managing calendar events with Asterisk
30  *
31  * \author Terry Wilson <twilson@digium.com>
32  *
33  * \note This API implements an abstraction for handling different calendaring
34  * technologies in Asterisk. The services provided by the API are a dialplan
35  * function to query whether or not a calendar is busy at the present time, a
36  * adialplan function to query specific information about events in a time range,
37  * a devicestate provider, and notification of calendar events through execution
38  * of dialplan apps or dialplan logic at a specific context and extension.  The
39  * information available through the CALENDAR_EVENT() dialplan function are:
40  *
41  *   SUMMARY, DESCRIPTION, ORGANIZER, LOCATION
42  *   CALENDAR, UID, START, END, and BUSYSTATE
43  *
44  * BUSYSTATE can have the values 0 (free), 1 (tentatively busy), or 2 (busy)
45  *
46  * Usage
47  * All calendaring configuration data is located in calendar.conf and is only read
48  * directly by the Calendaring API. Each calendar technology resource must register
49  * a load_calendar callback which will be passed an ast_calendar_load_data structure.
50  * The load_calendar callback function should then set the values it needs from this
51  * cfg, load the calendar data, and then loop updating the calendar data and events
52  * baesd on the refresh interval in the ast_calendar object.  Each call to
53  * the load_calendar callback will be will run in its own thread.
54  *
55  * Updating events involves creating an astobj2 container of new events and passing
56  * it to the API through ast_calendar_merge_events.
57  *
58  * Calendar technology resource modules must also register an unref_calendar callback
59  * which will only be called when the resource module calls ast_calendar_unregister()
60  * to unregister that module's calendar type (usually done in module_unload())
61  */
62
63 extern struct ast_config *ast_calendar_config;
64
65 struct ast_calendar;
66 struct ast_calendar_event;
67
68 /*! \brief Individual calendaring technology data */
69 struct ast_calendar_tech {
70         const char *type;
71         const char *description;
72         const char *module;
73         int (* is_busy)(struct ast_calendar *calendar); /*!< Override default busy determination */
74         void *(* load_calendar)(void *data);   /*!< Create private structure, add calendar events, etc. */
75         void *(* unref_calendar)(void *obj);   /*!< Function to be called to free the private structure */
76         int (* write_event)(struct ast_calendar_event *event);  /*!< Function for writing an event to the calendar */
77         AST_LIST_ENTRY(ast_calendar_tech) list;
78 };
79
80 enum ast_calendar_busy_state {
81         AST_CALENDAR_BS_FREE = 0,
82         AST_CALENDAR_BS_BUSY_TENTATIVE,
83         AST_CALENDAR_BS_BUSY,
84 };
85
86 struct ast_calendar_attendee {
87         char *data;
88         AST_LIST_ENTRY(ast_calendar_attendee) next;
89 };
90
91 /* \brief Calendar events */
92 struct ast_calendar_event {
93         AST_DECLARE_STRING_FIELDS(
94                 AST_STRING_FIELD(summary);
95                 AST_STRING_FIELD(description);
96                 AST_STRING_FIELD(organizer);
97                 AST_STRING_FIELD(location);
98                 AST_STRING_FIELD(uid);
99         );
100         struct ast_calendar *owner;   /*!< The calendar that owns this event */
101         time_t start;        /*!< Start of event (UTC) */
102         time_t end;          /*!< End of event (UTC) */
103         time_t alarm;        /*!< Time for event notification */
104         enum ast_calendar_busy_state busy_state;  /*!< The busy status of the event */
105         int notify_sched;    /*!< The sched for event notification */
106         int bs_start_sched;  /*!< The sched for changing the device state at the start of an event */
107         int bs_end_sched;    /*!< The sched for changing the device state at the end of an event */
108         AST_LIST_HEAD_NOLOCK(attendees, ast_calendar_attendee) attendees;
109 };
110
111 /*! \brief Asterisk calendar structure */
112 struct ast_calendar {
113         const struct ast_calendar_tech *tech;
114         void *tech_pvt;
115         AST_DECLARE_STRING_FIELDS(
116                 AST_STRING_FIELD(name);                         /*!< Name from config file [name] */
117                 AST_STRING_FIELD(notify_channel);       /*!< Channel to use for notification */
118                 AST_STRING_FIELD(notify_context);       /*!< Optional context to execute from for notification */
119                 AST_STRING_FIELD(notify_extension);     /*!< Optional extension to execute from for notification */
120                 AST_STRING_FIELD(notify_app);           /*!< Optional dialplan app to execute for notification */
121                 AST_STRING_FIELD(notify_appdata);       /*!< Optional arguments for dialplan app */
122         );
123         int autoreminder;    /*!< If set, override any calendar_tech specific notification times and use this time (in mins) */
124         int notify_waittime; /*!< Maxiumum time to allow for a notification attempt */
125         int refresh;         /*!< When to refresh the calendar events */
126         int timeframe;       /*!< Span (in mins) of calendar data to pull with each request */
127         pthread_t thread;    /*!< The thread that the calendar is loaded/updated in */
128         ast_cond_t unload;
129         int unloading:1;
130         int pending_deletion:1;
131         struct ao2_container *events;  /*!< The events that are known at this time */
132 };
133
134 /*! \brief Register a new calendar technology
135  *
136  * \param tech calendar technology to register
137  *
138  * \retval 0 success
139  * \retval -1 failure
140  */
141 int ast_calendar_register(struct ast_calendar_tech *tech);
142
143 /*! \brief Unregister a new calendar technology
144  *
145  * \param tech calendar technology to unregister
146  *
147  * \retval 0 success
148  * \retva -1 failure
149  */
150 void ast_calendar_unregister(struct ast_calendar_tech *tech);
151
152 /*! \brief Allocate an astobj2 ast_calendar_event object
153  *
154  * \param cal calendar to allocate an event for
155  *
156  * \return a new, initialized calendar event
157  */
158 struct ast_calendar_event *ast_calendar_event_alloc(struct ast_calendar *cal);
159
160 /*! \brief Allocate an astobj2 container for ast_calendar_event objects
161  *
162  * \return a new event container
163  */
164 struct ao2_container *ast_calendar_event_container_alloc(void);
165
166 /*! \brief Add an event to the list of events for a calendar
167  *
168  * \param cal calendar containing the events to be merged
169  * \param new_events an oa2 container of events to be merged into cal->events
170  */
171 void ast_calendar_merge_events(struct ast_calendar *cal, struct ao2_container *new_events);
172
173 /*! \brief Unreference an ast_calendar_event 
174  *
175  * \param event event to unref
176  *
177  * \return NULL
178  */
179 struct ast_calendar_event *ast_calendar_unref_event(struct ast_calendar_event *event);
180
181 /*! \brief Remove all events from calendar 
182  *
183  * \param cal calendar whose events need to be cleared
184  */
185 void ast_calendar_clear_events(struct ast_calendar *cal);
186
187 #endif /* _ASTERISK_CALENDAR_H */