res_parking: Apply ringing role option on swap with a channel that rings
[asterisk/asterisk.git] / res / parking / res_parking.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Jonathan Rose <jrose@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 /*! \file
20  *
21  * \brief Call Parking Resource Internal API
22  *
23  * \author Jonathan Rose <jrose@digium.com>
24  */
25
26 #include "asterisk/pbx.h"
27 #include "asterisk/bridging.h"
28 #include "asterisk/parking.h"
29 #include "asterisk/stasis_channels.h"
30
31 #define DEFAULT_PARKING_LOT "default"
32 #define DEFAULT_PARKING_EXTEN "700"
33 #define BASE_REGISTRAR "res_parking"
34 #define PARK_DIAL_CONTEXT "park-dial"
35
36 enum park_call_resolution {
37         PARK_UNSET = 0,         /*! Nothing set a resolution. This should never be observed in practice. */
38         PARK_ABANDON,           /*! The channel for the parked call hung up */
39         PARK_TIMEOUT,           /*! The parked call stayed parked until the parking lot timeout was reached and was removed */
40         PARK_FORCED,            /*! The parked call was forcibly terminated by an unusual means in Asterisk */
41         PARK_ANSWERED,          /*! The parked call was retrieved successfully */
42 };
43
44 enum parked_call_feature_options {
45         OPT_PARKEDPLAY = 0,
46         OPT_PARKEDTRANSFERS,
47         OPT_PARKEDREPARKING,
48         OPT_PARKEDHANGUP,
49         OPT_PARKEDRECORDING,
50 };
51
52 enum parking_lot_modes {
53         PARKINGLOT_NORMAL = 0,          /*! The parking lot is configured normally and can accept new calls. Disable on reload if the config isn't replaced.
54                                          *  valid transitions: PARKINGLOT_DISABLED */
55         PARKINGLOT_DYNAMIC,             /*! The parking lot is a dynamically created parking lot. It can be parked to at any time. Disabled on last parked call leaving.
56                                          *  valid transitions: PARKINGLOT_DISABLED */
57         PARKINGLOT_DISABLED,            /*! The parking lot is no longer linked to a parking lot in configuration. It can no longer be parked to.
58                                          *  and it can not be parked to. This mode has no transitions. */
59 };
60
61 struct parking_lot_cfg {
62         int parking_start;                        /*!< First space in the parking lot */
63         int parking_stop;                         /*!< Last space in the parking lot */
64
65         unsigned int parkingtime;                 /*!< Analogous to parkingtime config option */
66         unsigned int comebackdialtime;            /*!< Analogous to comebackdialtime config option */
67         unsigned int parkfindnext;                /*!< Analogous to parkfindnext config option */
68         unsigned int parkext_exclusive;           /*!< Analogous to parkext_exclusive config option */
69         unsigned int parkaddhints;                /*!< Analogous to parkaddhints config option */
70         unsigned int comebacktoorigin;            /*!< Analogous to comebacktoorigin config option */
71         int parkedplay;                           /*!< Analogous to parkedplay config option */
72         int parkedcalltransfers;                  /*!< Analogous to parkedcalltransfers config option */
73         int parkedcallreparking;                  /*!< Analogous to parkedcallreparking config option */
74         int parkedcallhangup;                     /*!< Analogous to parkedcallhangup config option */
75         int parkedcallrecording;                  /*!< Analogous to parkedcallrecording config option */
76
77         AST_DECLARE_STRING_FIELDS(
78                 AST_STRING_FIELD(name);               /*!< Name of the parking lot configuration object */
79                 AST_STRING_FIELD(registrar);          /*!< Which registrar the lot uses if it isn't the default registrar */
80                 AST_STRING_FIELD(mohclass);           /*!< Analogous to mohclass config option */
81                 AST_STRING_FIELD(parkext);            /*!< Analogous to parkext config option */
82                 AST_STRING_FIELD(parking_con);        /*!< Analogous to context config option */
83                 AST_STRING_FIELD(comebackcontext);    /*!< Analogous to comebackcontext config option */
84                 AST_STRING_FIELD(courtesytone);       /*!< Analogous to courtesytone config option */
85         );
86 };
87
88 struct parking_lot {
89         int next_space;                           /*!< When using parkfindnext, which space we should start searching from next time we park */
90         struct ast_bridge *parking_bridge;        /*!< Bridged where parked calls will rest until they are answered or otherwise leave */
91         struct ao2_container *parked_users;       /*!< List of parked users rigidly ordered by their parking space */
92         struct parking_lot_cfg *cfg;              /*!< Reference to configuration object for the parking lot */
93         enum parking_lot_modes mode;              /*!< Whether a parking lot is operational, being reconfigured, primed for deletion, or dynamically created. */
94         int disable_mark;                         /*!< On reload, disable this parking lot if it doesn't receive a new configuration. */
95
96         AST_DECLARE_STRING_FIELDS(
97                 AST_STRING_FIELD(name);               /*!< Name of the parking lot object */
98         );
99 };
100
101 struct parked_user {
102         struct ast_channel *chan;                 /*!< Parked channel */
103         struct ast_channel_snapshot *retriever;   /*!< Snapshot of the channel that retrieves a parked call */
104         struct timeval start;                     /*!< When the call was parked */
105         int parking_space;                        /*!< Which parking space is used */
106         char comeback[AST_MAX_CONTEXT];           /*!< Where to go on parking timeout */
107         char *parker_dial_string;                 /*!< dialstring to call back with comebacktoorigin. Used timeout extension generation and call control */
108         unsigned int time_limit;                  /*!< How long this specific channel may remain in the parking lot before timing out */
109         struct parking_lot *lot;                  /*!< Which parking lot the user is parked to */
110         enum park_call_resolution resolution;     /*!< How did the parking session end? If the call is in a bridge, lock parked_user before checking/setting */
111 };
112
113 /*!
114  * \since 12.0.0
115  * \brief If a parking lot exists in the parking lot list already, update its status to match the provided
116  *        configuration and return a reference return a reference to it. Otherwise, create a parking lot
117  *        struct based on a parking lot configuration and return a reference to the new one.
118  *
119  * \param cfg The configuration being used as a reference to build the parking lot from.
120  * \param dynamic non-zero if creating a dynamic parking lot with this. Don't replace existing parking lots. Ever.
121  *
122  * \retval A reference to the new parking lot
123  * \retval NULL if it was not found and could not be be allocated
124  *
125  * \note The parking lot will need to be unreffed if it ever falls out of scope
126  * \note The parking lot will automatically be added to the parking lot container if needed as part of this process
127  */
128 struct parking_lot *parking_lot_build_or_update(struct parking_lot_cfg *cfg, int dynamic);
129
130 /*!
131  * \since 12.0.0
132  * \brief Remove a parking lot from the usable lists if it is no longer involved in any calls and no configuration currently claims it
133  *
134  * \param lot Which parking lot is being checked for elimination
135  *
136  * \retval 0 if the parking lot was removed
137  * \retval -1 if the parking lot wasn't removed.
138  *
139  * \note This should generally be called when something is happening that could cause a parking lot to die such as a call being unparked or
140  *       a parking lot no longer existing in configurations.
141  */
142 int parking_lot_remove_if_unused(struct parking_lot *lot);
143
144 /*!
145  * \since 12.0.0
146  * \brief Create a new parking bridge
147  *
148  * \param bridge_lot Parking lot which the new bridge should be based on
149  *
150  * \retval NULL if the bridge can not be created
151  * \retval Newly created parking bridge
152  */
153 struct ast_bridge *bridge_parking_new(struct parking_lot *bridge_lot);
154
155 /*!
156  * \since 12.0.0
157  * \brief Get a reference to a parking lot's bridge. If it doesn't exist, create it and get a reference.
158  *
159  * \param lot Which parking lot we need the bridge from. This parking lot must be locked before calling this function.
160  *
161  * \retval A reference to the ast_bridge associated with the parking lot
162  * \retval NULL if it didn't already have a bridge and one couldn't be created
163  *
164  * \note This bridge will need to be unreffed if it ever falls out of scope.
165  */
166 struct ast_bridge *parking_lot_get_bridge(struct parking_lot *lot);
167
168 /*!
169  * \since 12.0.0
170  * \brief Get an available parking space within a parking lot.
171  *
172  * \param lot Which parking lot we are getting a space from
173  * \param target_override If there is a specific slot we want, provide it here and we'll start from that position
174  *
175  * \retval -1 if No slot can be found
176  * \retval integer value of parking space selected
177  *
178  * \note lot should be locked before this is called and unlocked only after a parked_user with the space
179  *       returned has been added to the parking lot.
180  */
181 int parking_lot_get_space(struct parking_lot *lot, int target_override);
182
183 /*!
184  * \since 12.0.0
185  * \brief Determine if there is a parked user in a parking space and pull it from the parking lot if there is.
186  *
187  * \param lot Parking lot being pulled from
188  * \param target If < 0   search for the first occupied space in the parking lot
189  *               If >= 0  Only pull from the indicated target
190  *
191  * \retval NULL if no parked user could be pulled from the requested parking lot at the requested parking space
192  * \retval reference to the requested parked user
193  *
194  * \note The parked user will be removed from parking lot as part of this process
195  * \note Remove this reference with ao2_cleanup once it falls out of scope.
196  */
197 struct parked_user *parking_lot_retrieve_parked_user(struct parking_lot *lot, int target);
198
199 /*!
200  * \since 12.0.0
201  * \brief Apply features based on the parking lot feature options
202  *
203  * \param chan Which channel's feature set is being modified
204  * \param lot parking lot which establishes the features used
205  * \param recipient_mode AST_FEATURE_FLAG_BYCALLER if the user is the retriever
206  *                       AST_FEATURE_FLAG_BYCALLEE if the user is the parkee
207  */
208 void parked_call_retrieve_enable_features(struct ast_channel *chan, struct parking_lot *lot, int recipient_mode);
209
210 /*!
211  * \since 12.0.0
212  * \brief Set necessary bridge roles on a channel that is about to enter a parking lot
213  *
214  * \param chan Entering channel
215  * \param lot The parking lot the channel will be entering
216  * \param force_ringing Use ringing instead of music on hold
217  *
218  * \retval 0 on success
219  * \retval non-zero on failure
220  */
221 int parking_channel_set_roles(struct ast_channel *chan, struct parking_lot *lot, int force_ringing);
222
223 /*!
224  * \since 12.0.0
225  * \brief custom callback function for ast_bridge_channel_queue_playfile which plays a parking space
226  *        and optionally hangs up the call afterwards based on the payload in playfile.
227  */
228 void say_parking_space(struct ast_bridge_channel *bridge_channel, const char *payload);
229
230 /*!
231  * \since 12.0.0
232  * \brief Setup timeout interval feature on an ast_bridge_features for parking
233  *
234  * \param features The ast_bridge_features we are establishing the interval hook on
235  * \param user The parked_user receiving the timeout duration limits
236  */
237 void parking_set_duration(struct ast_bridge_features *features, struct parked_user *user);
238
239 /*!
240  * \since 12.0.0
241  * \brief Get a pointer to the parking lot container for purposes such as iteration
242  *
243  * \retval pointer to the parking lot container.
244  */
245 struct ao2_container *get_parking_lot_container(void);
246
247 /*!
248  * \since 12.0.0
249  * \brief Find a parking lot based on its name
250  *
251  * \param lot_name Name of the parking lot sought
252  *
253  * \retval The parking lot if found
254  * \retval NULL if no parking lot with the name specified exists
255  *
256  * \note ao2_cleanup this reference when you are done using it or you'll cause leaks.
257  */
258 struct parking_lot *parking_lot_find_by_name(const char *lot_name);
259
260 /*!
261  * \since 12.0.0
262  * \brief Create a dynamic parking lot
263  *
264  * \param name Dynamic parking lot name to create
265  * \param chan Channel parkee to get dynamic parking lot parameters from
266  *
267  * \retval dynamically created parking lot on success
268  * \retval NULL on error
269  *
270  * \note This should be called only after verifying that the named parking lot doesn't already exist in a non-dynamic way.
271  *       The parking lots container should be locked before verifying and remain locked until after this function is called.
272  */
273 struct parking_lot *parking_create_dynamic_lot(const char *name, struct ast_channel *chan);
274
275 /*!
276  * \since 12.0.0
277  * \brief Find parking lot name from channel
278  *
279  * \param chan The channel we want the parking lot name for
280  *
281  * \retval name of the channel's assigned parking lot if it is defined by the channel in some way
282  * \retval name of the default parking lot if it is not
283  *
284  * \note Channel needs to be locked while the returned string is in use.
285  */
286 const char *find_channel_parking_lot_name(struct ast_channel *chan);
287
288 /*!
289  * \since 12.0.0
290  * \brief Flattens a dial string so that it can be written to/found from PBX extensions
291  *
292  * \param peername unflattened dial string. This will be flattened in place.
293  */
294 void flatten_dial_string(char *dialstring);
295
296 /*!
297  * \since 12.0.0
298  * \brief Set a channel's position in the PBX after timeout using the parking lot settings
299  *
300  * \param pu Parked user who is entering/reentering the PBX
301  * \param lot Parking lot the user was removed from.
302  *
303  * \retval 0 Position set successfully
304  * \retval -1 Failed to set the position
305  */
306 int comeback_goto(struct parked_user *pu, struct parking_lot *lot);
307
308 /*!
309  * \since 12.0.0
310  * \brief Add extensions for a parking lot configuration
311  *
312  * \param lot_cfg parking lot configuration to generate extensions for
313  *
314  * \retval 0 on success
315  * \retval non-zero on failure
316  */
317 int parking_lot_cfg_create_extensions(struct parking_lot_cfg *lot_cfg);
318
319 /*!
320  * \since 12.0.0
321  * \brief Remove extensions belonging to a parking lot configuration
322  *
323  * \param lot_cfg parking lot configuratin to remove extensions from
324  *
325  * \note This will not remove extensions registered non-exclusively even
326  *       if those extensions were registered by lot_cfg. Those are only
327  *       purged on a res_parking module reload.
328  */
329 void parking_lot_cfg_remove_extensions(struct parking_lot_cfg *lot_cfg);
330
331 /*!
332  * \since 12.0.0
333  * \brief Pull a parked user out of its parking lot. Use this when you don't want to use the parked user afterwards.
334  * \param user The parked user being pulled.
335  *
336  * \retval 0 on success
337  * \retval -1 if the user didn't have its parking lot set
338  */
339 int unpark_parked_user(struct parked_user *user);
340
341 /*!
342  * \since 12.0.0
343  * \brief Publish a stasis parked call message for the channel indicating failure to park.
344  *
345  * \param parkee channel belonging to the failed parkee
346  */
347 void publish_parked_call_failure(struct ast_channel *parkee);
348
349 /*!
350  * \since 12.0.0
351  * \brief Publish a stasis parked call message for a given parked user
352  *
353  * \param pu pointer to a parked_user that we are generating the message for
354  * \param event_type What parked call event type is provoking this message
355  */
356 void publish_parked_call(struct parked_user *pu, enum ast_parked_call_event_type event_type);
357
358 /*!
359  * \since 12.0.0
360  * \brief Setup a parked call on a parking bridge without needing to parse appdata
361  *
362  */
363 struct ast_bridge *park_common_setup(struct ast_channel *parkee, struct ast_channel *parker,
364                 const char *lot_name, const char *comeback_override,
365                 int use_ringing, int randomize, int time_limit, int silence_announcements);
366
367 /*!
368  * \since 12.0.0
369  * \brief Function to prepare a channel for parking by determining which parking bridge should
370  *        be used, setting up a park common datastore so that the parking bridge will have access
371  *        to necessary parking information when joining, and applying various bridge roles to the
372  *        channel.
373  *
374  * \param parkee The channel being preparred for parking
375  * \param parker The channel initiating the park; may be the parkee as well. May be NULL.
376  * \param app_data arguments supplied to the Park application. May be NULL.
377  * \param silence_announcements optional pointer to an integer where we want to store the silence option flag
378  *        this value should be initialized to 0 prior to calling park_common_setup.
379  *
380  * \retval reference to a parking bridge if successful
381  * \retval NULL on failure
382  *
383  * \note ao2_cleanup this reference when you are done using it or you'll cause leaks.
384  */
385 struct ast_bridge *park_application_setup(struct ast_channel *parkee, struct ast_channel *parker,
386         const char *app_data, int *silence_announcements);
387
388 struct park_common_datastore {
389         char *parker_uuid;           /*!< Unique ID of the channel parking the call. */
390         char *parker_dial_string;    /*!< Dial string that we would attempt to call when timing out when comebacktoorigin=yes */
391         char *comeback_override;     /*!< Optional goto string for where to send the call after we are done */
392         int randomize;               /*!< Pick a parking space to enter on at random */
393         int time_limit;              /*!< time limit override. -1 values don't override, 0 for unlimited time, >0 for custom time limit in seconds */
394         int silence_announce;        /*!< Used when a call parks itself to keep it from hearing the parked call announcement */
395 };
396
397 /*!
398  * \since 12.0.0
399  * \brief Get a copy of the park_common_datastore from a channel that is being parked
400  *
401  * \param parkee The channel entering parking with the datastore we are checking
402  *
403  * \retval Pointer to a copy of the park common datastore for parkee if it could be cloned. This needs to be free'd with park_common_datastore free.
404  * \retval NULL if the park_common_datastore could not be copied off of the channel.
405  */
406 struct park_common_datastore *get_park_common_datastore_copy(struct ast_channel *parkee);
407
408 /*!
409  * \since 12.0.0
410  * \brief Free a park common datastore struct
411  *
412  * \param datastore The park_common_datastore being free'd. (NULL tolerant)
413  */
414 void park_common_datastore_free(struct park_common_datastore *datastore);
415
416 /*!
417  * \since 12.0.0
418  * \brief Notify metermaids that we've changed an extension
419  *
420  * \param exten Extension of the call parked/unparked
421  * \param context Context of the call parked/unparked
422  * \param state new device state
423  */
424 void parking_notify_metermaids(int exten, const char *context, enum ast_device_state state);
425
426 /*!
427  * \since 12.0.0
428  * \brief Check global configuration to see if dynamic parking is enabled
429  *
430  * \retval 1 if dynamic parking is enabled
431  * \retval 0 if dynamic parking is disabled
432  */
433 int parking_dynamic_lots_enabled(void);
434
435 /*!
436  * \since 12.0.0
437  * \brief Execution function for the parking application
438  *
439  * \param chan ast_channel entering the application
440  * \param data arguments to the application
441  *
442  * \retval 0 the application executed in such a way that the channel should proceed in the dial plan
443  * \retval -1 the channel should no longer proceed through the dial plan
444  *
445  * \note this function should only be used to register the parking application and not generally to park calls.
446  */
447 int park_app_exec(struct ast_channel *chan, const char *data);
448
449 /*!
450  * \since 12.0.0
451  * \brief Execution function for the parked call application
452  *
453  * \param chan ast_channel entering the application
454  * \param data arguments to the application
455  *
456  * \retval 0 the application executed in such a way that the channel should proceed in the dial plan
457  * \retval -1 the channel should no longer proceed through the dial plan
458  */
459 int parked_call_app_exec(struct ast_channel *chan, const char *data);
460
461 /*!
462  * \since 12.0.0
463  * \brief Execution function for the park and retrieve application
464  *
465  * \param chan ast_channel entering the application
466  * \param data arguments to the application
467  *
468  * \retval 0 the application executed in such a way that the channel should proceed in the dial plan
469  * \retval -1 the channel should no longer proceed through the dial plan
470  *
471  * \note this function should only be used to register the park and announce application and not generally to park and announce.
472  */
473 int park_and_announce_app_exec(struct ast_channel *chan, const char *data);
474
475 /*!
476  * \since 12.0.0
477  * \brief Register CLI commands
478  *
479  * \retval 0 if successful
480  * \retval -1 on failure
481  */
482 int load_parking_ui(void);
483
484 /*!
485  * \since 12.0.0
486  * \brief Unregister CLI commands
487  */
488 void unload_parking_ui(void);
489
490 /*!
491  * \since 12.0.0
492  * \brief Register manager actions and setup subscriptions for stasis events
493  */
494 int load_parking_manager(void);
495
496 /*!
497  * \since 12.0.0
498  * \brief Unregister manager actions and remove subscriptions for stasis events
499  */
500 void unload_parking_manager(void);
501
502 /*!
503  * \since 12.0.0
504  * \brief Register bridge features for parking
505  *
506  * \retval 0 on success
507  * \retval -1 on failure
508  */
509 int load_parking_bridge_features(void);
510
511 /*!
512  * \since 12.0.0
513  * \brief Unregister features registered by load_parking_bridge_features
514  */
515 void unload_parking_bridge_features(void);
516
517 /*!
518  * \since 12.0.0
519  * \brief Register Parking devstate handler
520  */
521 int load_parking_devstate(void);
522
523 /*!
524  * \since 12.0.0
525  * \brief Unregister Parking devstate handler
526  */
527 void unload_parking_devstate(void);