Replace most uses of ast_register_atexit with ast_register_cleanup.
[asterisk/asterisk.git] / main / ccss.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2010, Digium, Inc.
5  *
6  * Mark Michelson <mmichelson@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  * \brief Call Completion Supplementary Services implementation
21  * \author Mark Michelson <mmichelson@digium.com>
22  */
23
24 /*! \li \ref ccss.c uses the configuration file \ref ccss.conf
25  * \addtogroup configuration_file Configuration Files
26  */
27
28 /*!
29  * \page ccss.conf ccss.conf
30  * \verbinclude ccss.conf.sample
31  */
32
33 /*** MODULEINFO
34         <support_level>core</support_level>
35  ***/
36
37 #include "asterisk.h"
38
39 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
40
41 #include "asterisk/astobj2.h"
42 #include "asterisk/strings.h"
43 #include "asterisk/ccss.h"
44 #include "asterisk/channel.h"
45 #include "asterisk/pbx.h"
46 #include "asterisk/utils.h"
47 #include "asterisk/taskprocessor.h"
48 #include "asterisk/devicestate.h"
49 #include "asterisk/module.h"
50 #include "asterisk/app.h"
51 #include "asterisk/cli.h"
52 #include "asterisk/manager.h"
53 #include "asterisk/causes.h"
54 #include "asterisk/stasis_system.h"
55 #include "asterisk/format_cache.h"
56
57 /*** DOCUMENTATION
58         <application name="CallCompletionRequest" language="en_US">
59                 <synopsis>
60                         Request call completion service for previous call
61                 </synopsis>
62                 <syntax />
63                 <description>
64                         <para>Request call completion service for a previously failed
65                         call attempt.</para>
66                         <para>This application sets the following channel variables:</para>
67                         <variablelist>
68                                 <variable name="CC_REQUEST_RESULT">
69                                         <para>This is the returned status of the request.</para>
70                                         <value name="SUCCESS" />
71                                         <value name="FAIL" />
72                                 </variable>
73                                 <variable name="CC_REQUEST_REASON">
74                                         <para>This is the reason the request failed.</para>
75                                         <value name="NO_CORE_INSTANCE" />
76                                         <value name="NOT_GENERIC" />
77                                         <value name="TOO_MANY_REQUESTS" />
78                                         <value name="UNSPECIFIED" />
79                                 </variable>
80                         </variablelist>
81                 </description>
82         </application>
83         <application name="CallCompletionCancel" language="en_US">
84                 <synopsis>
85                         Cancel call completion service
86                 </synopsis>
87                 <syntax />
88                 <description>
89                         <para>Cancel a Call Completion Request.</para>
90                         <para>This application sets the following channel variables:</para>
91                         <variablelist>
92                                 <variable name="CC_CANCEL_RESULT">
93                                         <para>This is the returned status of the cancel.</para>
94                                         <value name="SUCCESS" />
95                                         <value name="FAIL" />
96                                 </variable>
97                                 <variable name="CC_CANCEL_REASON">
98                                         <para>This is the reason the cancel failed.</para>
99                                         <value name="NO_CORE_INSTANCE" />
100                                         <value name="NOT_GENERIC" />
101                                         <value name="UNSPECIFIED" />
102                                 </variable>
103                         </variablelist>
104                 </description>
105         </application>
106  ***/
107
108 /* These are some file-scoped variables. It would be
109  * nice to define them closer to their first usage, but since
110  * they are used in many places throughout the file, defining
111  * them here at the top is easiest.
112  */
113
114 /*!
115  * The ast_sched_context used for all generic CC timeouts
116  */
117 static struct ast_sched_context *cc_sched_context;
118 /*!
119  * Counter used to create core IDs for CC calls. Each new
120  * core ID is created by atomically adding 1 to the core_id_counter
121  */
122 static int core_id_counter;
123 /*!
124  * Taskprocessor from which all CC agent and monitor callbacks
125  * are called.
126  */
127 static struct ast_taskprocessor *cc_core_taskprocessor;
128 /*!
129  * Name printed on all CC log messages.
130  */
131 static const char *CC_LOGGER_LEVEL_NAME = "CC";
132 /*!
133  * Logger level registered by the CC core.
134  */
135 static int cc_logger_level;
136 /*!
137  * Parsed configuration value for cc_max_requests
138  */
139 static unsigned int global_cc_max_requests;
140 /*!
141  * The current number of CC requests in the system
142  */
143 static int cc_request_count;
144
145 static inline void *cc_ref(void *obj, const char *debug)
146 {
147         ao2_t_ref(obj, +1, debug);
148         return obj;
149 }
150
151 static inline void *cc_unref(void *obj, const char *debug)
152 {
153         ao2_t_ref(obj, -1, debug);
154         return NULL;
155 }
156
157 /*!
158  * \since 1.8
159  * \internal
160  * \brief A structure for holding the configuration parameters
161  * relating to CCSS
162  */
163 struct ast_cc_config_params {
164         enum ast_cc_agent_policies cc_agent_policy;
165         enum ast_cc_monitor_policies cc_monitor_policy;
166         unsigned int cc_offer_timer;
167         unsigned int ccnr_available_timer;
168         unsigned int ccbs_available_timer;
169         unsigned int cc_recall_timer;
170         unsigned int cc_max_agents;
171         unsigned int cc_max_monitors;
172         char cc_callback_macro[AST_MAX_EXTENSION];
173         char cc_callback_sub[AST_MAX_EXTENSION];
174         char cc_agent_dialstring[AST_MAX_EXTENSION];
175 };
176
177 /*!
178  * \since 1.8
179  * \brief The states used in the CCSS core state machine
180  *
181  * For more information, see doc/CCSS_architecture.pdf
182  */
183 enum cc_state {
184         /*! Entered when it is determined that CCSS may be used for the call */
185         CC_AVAILABLE,
186         /*! Entered when a CCSS agent has offered CCSS to a caller */
187         CC_CALLER_OFFERED,
188         /*! Entered when a CCSS agent confirms that a caller has
189          * requested CCSS */
190         CC_CALLER_REQUESTED,
191         /*! Entered when a CCSS monitor confirms acknowledgment of an
192          * outbound CCSS request */
193         CC_ACTIVE,
194         /*! Entered when a CCSS monitor alerts the core that the called party
195          * has become available */
196         CC_CALLEE_READY,
197         /*! Entered when a CCSS agent alerts the core that the calling party
198          * may not be recalled because he is unavailable
199          */
200         CC_CALLER_BUSY,
201         /*! Entered when a CCSS agent alerts the core that the calling party
202          * is attempting to recall the called party
203          */
204         CC_RECALLING,
205         /*! Entered when an application alerts the core that the calling party's
206          * recall attempt has had a call progress response indicated
207          */
208         CC_COMPLETE,
209         /*! Entered any time that something goes wrong during the process, thus
210          * resulting in the failure of the attempted CCSS transaction. Note also
211          * that cancellations of CC are treated as failures.
212          */
213         CC_FAILED,
214 };
215
216 /*!
217  * \brief The payload for an AST_CONTROL_CC frame
218  *
219  * \details
220  * This contains all the necessary data regarding
221  * a called device so that the CC core will be able
222  * to allocate the proper monitoring resources.
223  */
224 struct cc_control_payload {
225         /*!
226          * \brief The type of monitor to allocate.
227          *
228          * \details
229          * The type of monitor to allocate. This is a string which corresponds
230          * to a set of monitor callbacks registered. Examples include "generic"
231          * and "SIP"
232          *
233          * \note This really should be an array of characters in case this payload
234          * is sent accross an IAX2 link.  However, this would not make too much sense
235          * given this type may not be recognized by the other end.
236          * Protection may be necessary to prevent it from being transmitted.
237          *
238          * In addition the following other problems are also possible:
239          * 1) Endian issues with the integers/enums stored in the config_params.
240          * 2) Alignment padding issues for the element types.
241          */
242         const char *monitor_type;
243         /*!
244          * \brief Private data allocated by the callee
245          *
246          * \details
247          * All channel drivers that monitor endpoints will need to allocate
248          * data that is not usable by the CC core. In most cases, some or all
249          * of this data is allocated at the time that the channel driver offers
250          * CC to the caller. There are many opportunities for failures to occur
251          * between when a channel driver offers CC and when a monitor is actually
252          * allocated to watch the endpoint. For this reason, the channel driver
253          * must give the core a pointer to the private data that was allocated so
254          * that the core can call back into the channel driver to destroy it if
255          * a failure occurs. If no private data has been allocated at the time that
256          * CC is offered, then it is perfectly acceptable to pass NULL for this
257          * field.
258          */
259         void *private_data;
260         /*!
261          * \brief Service offered by the endpoint
262          *
263          * \details
264          * This indicates the type of call completion service offered by the
265          * endpoint. This data is not crucial to the machinations of the CC core,
266          * but it is helpful for debugging purposes.
267          */
268         enum ast_cc_service_type service;
269         /*!
270          * \brief Configuration parameters used by this endpoint
271          *
272          * \details
273          * Each time an endpoint offers call completion, it must provide its call
274          * completion configuration parameters. This is because settings may be different
275          * depending on the circumstances.
276          */
277         struct ast_cc_config_params config_params;
278         /*!
279          * \brief ID of parent extension
280          *
281          * \details
282          * This is the only datum that the CC core derives on its own and is not
283          * provided by the offerer of CC. This provides the core with information on
284          * which extension monitor is the most immediate parent of this device.
285          */
286         int parent_interface_id;
287         /*!
288          * \brief Name of device to be monitored
289          *
290          * \details
291          * The device name by which this monitored endpoint will be referred in the
292          * CC core. It is highly recommended that this device name is derived by using
293          * the function ast_channel_get_device_name.
294          */
295         char device_name[AST_CHANNEL_NAME];
296         /*!
297          * \brief Recall dialstring
298          *
299          * \details
300          * Certain channel drivers (DAHDI in particular) will require that a special
301          * dialstring be used to indicate that the outgoing call is to interpreted as
302          * a CC recall. If the channel driver has such a requirement, then this is
303          * where that special recall dialstring is placed. If no special dialstring
304          * is to be used, then the channel driver must provide the original dialstring
305          * used to call this endpoint.
306          */
307         char dialstring[AST_CHANNEL_NAME];
308 };
309
310 /*!
311  * \brief The "tree" of interfaces that is dialed.
312  *
313  * \details
314  * Though this is a linked list, it is logically treated
315  * as a tree of monitors. Each monitor has an id and a parent_id
316  * associated with it. The id is a unique ID for that monitor, and
317  * the parent_id is the unique ID of the monitor's parent in the
318  * tree. The tree is structured such that all of a parent's children
319  * will appear after the parent in the tree. However, it cannot be
320  * guaranteed exactly where after the parent the children are.
321  *
322  * The tree is reference counted since several threads may need
323  * to use it, and it may last beyond the lifetime of a single
324  * thread.
325  */
326 AST_LIST_HEAD(cc_monitor_tree, ast_cc_monitor);
327
328 static const int CC_CORE_INSTANCES_BUCKETS = 17;
329 static struct ao2_container *cc_core_instances;
330
331 struct cc_core_instance {
332         /*!
333          * Unique identifier for this instance of the CC core.
334          */
335         int core_id;
336         /*!
337          * The current state for this instance of the CC core.
338          */
339         enum cc_state current_state;
340         /*!
341          * The CC agent in use for this call
342          */
343         struct ast_cc_agent *agent;
344         /*!
345          * Reference to the monitor tree formed during the initial call
346          */
347         struct cc_monitor_tree *monitors;
348 };
349
350 /*!
351  * \internal
352  * \brief Request that the core change states
353  * \param state The state to which we wish to change
354  * \param core_id The unique identifier for this instance of the CCSS core state machine
355  * \param debug Optional message explaining the reason for the state change
356  * \param ap varargs list
357  * \retval 0 State change successfully queued
358  * \retval -1 Unable to queue state change request
359  */
360 static int __attribute__((format(printf, 3, 0))) cc_request_state_change(enum cc_state state, const int core_id, const char *debug, va_list ap);
361
362 /*!
363  * \internal
364  * \brief create a new instance of the CC core and an agent for the calling channel
365  *
366  * This function will check to make sure that the incoming channel
367  * is allowed to request CC by making sure that the incoming channel
368  * has not exceeded its maximum number of allowed agents.
369  *
370  * Should that check pass, the core instance is created, and then the
371  * agent for the channel.
372  *
373  * \param caller_chan The incoming channel for this particular call
374  * \param called_tree A reference to the tree of called devices. The agent
375  * will gain a reference to this tree as well
376  * \param core_id The core_id that this core_instance will assume
377  * \retval NULL Failed to create the core instance either due to memory allocation
378  * errors or due to the agent count for the caller being too high
379  * \retval non-NULL A reference to the newly created cc_core_instance
380  */
381 static struct cc_core_instance *cc_core_init_instance(struct ast_channel *caller_chan,
382                 struct cc_monitor_tree *called_tree, const int core_id, struct cc_control_payload *cc_data);
383
384 static const struct {
385         enum ast_cc_service_type service;
386         const char *service_string;
387 } cc_service_to_string_map[] = {
388         {AST_CC_NONE, "NONE"},
389         {AST_CC_CCBS, "CCBS"},
390         {AST_CC_CCNR, "CCNR"},
391         {AST_CC_CCNL, "CCNL"},
392 };
393
394 static const struct {
395         enum cc_state state;
396         const char *state_string;
397 } cc_state_to_string_map[] = {
398         {CC_AVAILABLE,          "CC is available"},
399         {CC_CALLER_OFFERED,     "CC offered to caller"},
400         {CC_CALLER_REQUESTED,   "CC requested by caller"},
401         {CC_ACTIVE,             "CC accepted by callee"},
402         {CC_CALLEE_READY,       "Callee has become available"},
403         {CC_CALLER_BUSY,        "Callee was ready, but caller is now unavailable"},
404         {CC_RECALLING,          "Caller is attempting to recall"},
405         {CC_COMPLETE,           "Recall complete"},
406         {CC_FAILED,             "CC has failed"},
407 };
408
409 static const char *cc_state_to_string(enum cc_state state)
410 {
411         return cc_state_to_string_map[state].state_string;
412 }
413
414 static const char *cc_service_to_string(enum ast_cc_service_type service)
415 {
416         return cc_service_to_string_map[service].service_string;
417 }
418
419 static int cc_core_instance_hash_fn(const void *obj, const int flags)
420 {
421         const struct cc_core_instance *core_instance = obj;
422         return core_instance->core_id;
423 }
424
425 static int cc_core_instance_cmp_fn(void *obj, void *arg, int flags)
426 {
427         struct cc_core_instance *core_instance1 = obj;
428         struct cc_core_instance *core_instance2 = arg;
429
430         return core_instance1->core_id == core_instance2->core_id ? CMP_MATCH | CMP_STOP : 0;
431 }
432
433 static struct cc_core_instance *find_cc_core_instance(const int core_id)
434 {
435         struct cc_core_instance finder = {.core_id = core_id,};
436
437         return ao2_t_find(cc_core_instances, &finder, OBJ_POINTER, "Finding a core_instance");
438 }
439
440 struct cc_callback_helper {
441         ao2_callback_fn *function;
442         void *args;
443         const char *type;
444 };
445
446 static int cc_agent_callback_helper(void *obj, void *args, int flags)
447 {
448         struct cc_core_instance *core_instance = obj;
449         struct cc_callback_helper *helper = args;
450
451         if (strcmp(core_instance->agent->callbacks->type, helper->type)) {
452                 return 0;
453         }
454
455         return helper->function(core_instance->agent, helper->args, flags);
456 }
457
458 struct ast_cc_agent *ast_cc_agent_callback(int flags, ao2_callback_fn *function, void *args, const char * const type)
459 {
460         struct cc_callback_helper helper = {.function = function, .args = args, .type = type};
461         struct cc_core_instance *core_instance;
462         if ((core_instance = ao2_t_callback(cc_core_instances, flags, cc_agent_callback_helper, &helper,
463                                         "Calling provided agent callback function"))) {
464                 struct ast_cc_agent *agent = cc_ref(core_instance->agent, "An outside entity needs the agent");
465                 cc_unref(core_instance, "agent callback done with the core_instance");
466                 return agent;
467         }
468         return NULL;
469 }
470
471 enum match_flags {
472         /* Only match agents that have not yet
473          * made a CC request
474          */
475         MATCH_NO_REQUEST = (1 << 0),
476         /* Only match agents that have made
477          * a CC request
478          */
479         MATCH_REQUEST = (1 << 1),
480 };
481
482 /* ao2_callbacks for cc_core_instances */
483
484 /*!
485  * \internal
486  * \brief find a core instance based on its agent
487  *
488  * The match flags tell whether we wish to find core instances
489  * that have a monitor or core instances that do not. Core instances
490  * with no monitor are core instances for which a caller has not yet
491  * requested CC. Core instances with a monitor are ones for which the
492  * caller has requested CC.
493  */
494 static int match_agent(void *obj, void *arg, void *data, int flags)
495 {
496         struct cc_core_instance *core_instance = obj;
497         const char *name = arg;
498         unsigned long match_flags = *(unsigned long *)data;
499         int possible_match = 0;
500
501         if ((match_flags & MATCH_NO_REQUEST) && core_instance->current_state < CC_CALLER_REQUESTED) {
502                 possible_match = 1;
503         }
504
505         if ((match_flags & MATCH_REQUEST) && core_instance->current_state >= CC_CALLER_REQUESTED) {
506                 possible_match = 1;
507         }
508
509         if (!possible_match) {
510                 return 0;
511         }
512
513         if (!strcmp(core_instance->agent->device_name, name)) {
514                 return CMP_MATCH | CMP_STOP;
515         }
516         return 0;
517 }
518
519 struct count_agents_cb_data {
520         int count;
521         int core_id_exception;
522 };
523
524 /*!
525  * \internal
526  * \brief Count the number of agents a specific interface is using
527  *
528  * We're only concerned with the number of agents that have requested
529  * CC, so we restrict our search to core instances which have a non-NULL
530  * monitor pointer
531  */
532 static int count_agents_cb(void *obj, void *arg, void *data, int flags)
533 {
534         struct cc_core_instance *core_instance = obj;
535         const char *name = arg;
536         struct count_agents_cb_data *cb_data = data;
537
538         if (cb_data->core_id_exception == core_instance->core_id) {
539                 ast_log_dynamic_level(cc_logger_level, "Found agent with core_id %d but not counting it toward total\n", core_instance->core_id);
540                 return 0;
541         }
542
543         if (core_instance->current_state >= CC_CALLER_REQUESTED && !strcmp(core_instance->agent->device_name, name)) {
544                 cb_data->count++;
545         }
546         return 0;
547 }
548
549 /* default values mapping from cc_state to ast_dev_state */
550
551 #define CC_AVAILABLE_DEVSTATE_DEFAULT        AST_DEVICE_NOT_INUSE
552 #define CC_CALLER_OFFERED_DEVSTATE_DEFAULT   AST_DEVICE_NOT_INUSE
553 #define CC_CALLER_REQUESTED_DEVSTATE_DEFAULT AST_DEVICE_NOT_INUSE
554 #define CC_ACTIVE_DEVSTATE_DEFAULT           AST_DEVICE_INUSE
555 #define CC_CALLEE_READY_DEVSTATE_DEFAULT     AST_DEVICE_RINGING
556 #define CC_CALLER_BUSY_DEVSTATE_DEFAULT      AST_DEVICE_ONHOLD
557 #define CC_RECALLING_DEVSTATE_DEFAULT        AST_DEVICE_RINGING
558 #define CC_COMPLETE_DEVSTATE_DEFAULT         AST_DEVICE_NOT_INUSE
559 #define CC_FAILED_DEVSTATE_DEFAULT           AST_DEVICE_NOT_INUSE
560
561 /*!
562  * \internal
563  * \brief initialization of defaults for CC_STATE to DEVICE_STATE map
564  */
565 static enum ast_device_state cc_state_to_devstate_map[] = {
566         [CC_AVAILABLE] =        CC_AVAILABLE_DEVSTATE_DEFAULT,
567         [CC_CALLER_OFFERED] =   CC_CALLER_OFFERED_DEVSTATE_DEFAULT,
568         [CC_CALLER_REQUESTED] = CC_CALLER_REQUESTED_DEVSTATE_DEFAULT,
569         [CC_ACTIVE] =           CC_ACTIVE_DEVSTATE_DEFAULT,
570         [CC_CALLEE_READY] =     CC_CALLEE_READY_DEVSTATE_DEFAULT,
571         [CC_CALLER_BUSY] =      CC_CALLER_BUSY_DEVSTATE_DEFAULT,
572         [CC_RECALLING] =        CC_RECALLING_DEVSTATE_DEFAULT,
573         [CC_COMPLETE] =         CC_COMPLETE_DEVSTATE_DEFAULT,
574         [CC_FAILED] =           CC_FAILED_DEVSTATE_DEFAULT,
575 };
576
577 /*!
578  * \internal
579  * \brief lookup the ast_device_state mapped to cc_state
580  *
581  * \param state
582  *
583  * \return the correponding DEVICE STATE from the cc_state_to_devstate_map
584  * when passed an internal state.
585  */
586 static enum ast_device_state cc_state_to_devstate(enum cc_state state)
587 {
588         return cc_state_to_devstate_map[state];
589 }
590
591 /*!
592  * \internal
593  * \brief Callback for devicestate providers
594  *
595  * \details
596  * Initialize with ast_devstate_prov_add() and returns the corresponding
597  * DEVICE STATE based on the current CC_STATE state machine if the requested
598  * device is found and is a generic device. Returns the equivalent of
599  * CC_FAILED, which defaults to NOT_INUSE, if no device is found.  NOT_INUSE would
600  * indicate that there is no presence of any pending call back.
601  */
602 static enum ast_device_state ccss_device_state(const char *device_name)
603 {
604         struct cc_core_instance *core_instance;
605         unsigned long match_flags;
606         enum ast_device_state cc_current_state;
607
608         match_flags = MATCH_NO_REQUEST;
609         core_instance = ao2_t_callback_data(cc_core_instances, 0, match_agent,
610                 (char *) device_name, &match_flags,
611                 "Find Core Instance for ccss_device_state reqeust.");
612         if (!core_instance) {
613                 ast_log_dynamic_level(cc_logger_level,
614                         "Couldn't find a core instance for caller %s\n", device_name);
615                 return cc_state_to_devstate(CC_FAILED);
616         }
617
618         ast_log_dynamic_level(cc_logger_level,
619                 "Core %d: Found core_instance for caller %s in state %s\n",
620                 core_instance->core_id, device_name, cc_state_to_string(core_instance->current_state));
621
622         if (strcmp(core_instance->agent->callbacks->type, "generic")) {
623                 ast_log_dynamic_level(cc_logger_level,
624                         "Core %d: Device State is only for generic agent types.\n",
625                         core_instance->core_id);
626                 cc_unref(core_instance, "Unref core_instance since ccss_device_state was called with native agent");
627                 return cc_state_to_devstate(CC_FAILED);
628         }
629         cc_current_state = cc_state_to_devstate(core_instance->current_state);
630         cc_unref(core_instance, "Unref core_instance done with ccss_device_state");
631         return cc_current_state;
632 }
633
634 /*!
635  * \internal
636  * \brief Notify Device State Changes from CC STATE MACHINE
637  *
638  * \details
639  * Any time a state is changed, we call this function to notify the DEVICE STATE
640  * subsystem of the change so that subscribed phones to any corresponding hints that
641  * are using that state are updated.
642  */
643 static void ccss_notify_device_state_change(const char *device, enum cc_state state)
644 {
645         enum ast_device_state devstate;
646
647         devstate = cc_state_to_devstate(state);
648
649         ast_log_dynamic_level(cc_logger_level,
650                 "Notification of CCSS state change to '%s', device state '%s' for device '%s'\n",
651                 cc_state_to_string(state), ast_devstate2str(devstate), device);
652
653         ast_devstate_changed(devstate, AST_DEVSTATE_CACHABLE, "ccss:%s", device);
654 }
655
656 #define CC_OFFER_TIMER_DEFAULT                  20              /* Seconds */
657 #define CCNR_AVAILABLE_TIMER_DEFAULT    7200    /* Seconds */
658 #define CCBS_AVAILABLE_TIMER_DEFAULT    4800    /* Seconds */
659 #define CC_RECALL_TIMER_DEFAULT                 20              /* Seconds */
660 #define CC_MAX_AGENTS_DEFAULT                   5
661 #define CC_MAX_MONITORS_DEFAULT                 5
662 #define GLOBAL_CC_MAX_REQUESTS_DEFAULT  20
663
664 static const struct ast_cc_config_params cc_default_params = {
665         .cc_agent_policy = AST_CC_AGENT_NEVER,
666         .cc_monitor_policy = AST_CC_MONITOR_NEVER,
667         .cc_offer_timer = CC_OFFER_TIMER_DEFAULT,
668         .ccnr_available_timer = CCNR_AVAILABLE_TIMER_DEFAULT,
669         .ccbs_available_timer = CCBS_AVAILABLE_TIMER_DEFAULT,
670         .cc_recall_timer = CC_RECALL_TIMER_DEFAULT,
671         .cc_max_agents = CC_MAX_AGENTS_DEFAULT,
672         .cc_max_monitors = CC_MAX_MONITORS_DEFAULT,
673         .cc_callback_macro = "",
674         .cc_callback_sub = "",
675         .cc_agent_dialstring = "",
676 };
677
678 void ast_cc_default_config_params(struct ast_cc_config_params *params)
679 {
680         *params = cc_default_params;
681 }
682
683 struct ast_cc_config_params *__ast_cc_config_params_init(const char *file, int line, const char *function)
684 {
685 #if defined(__AST_DEBUG_MALLOC)
686         struct ast_cc_config_params *params = __ast_malloc(sizeof(*params), file, line, function);
687 #else
688         struct ast_cc_config_params *params = ast_malloc(sizeof(*params));
689 #endif
690
691         if (!params) {
692                 return NULL;
693         }
694
695         ast_cc_default_config_params(params);
696         return params;
697 }
698
699 void ast_cc_config_params_destroy(struct ast_cc_config_params *params)
700 {
701         ast_free(params);
702 }
703
704 static enum ast_cc_agent_policies str_to_agent_policy(const char * const value)
705 {
706         if (!strcasecmp(value, "never")) {
707                 return AST_CC_AGENT_NEVER;
708         } else if (!strcasecmp(value, "native")) {
709                 return AST_CC_AGENT_NATIVE;
710         } else if (!strcasecmp(value, "generic")) {
711                 return AST_CC_AGENT_GENERIC;
712         } else {
713                 ast_log(LOG_WARNING, "%s is an invalid value for cc_agent_policy. Switching to 'never'\n", value);
714                 return AST_CC_AGENT_NEVER;
715         }
716 }
717
718 static enum ast_cc_monitor_policies str_to_monitor_policy(const char * const value)
719 {
720         if (!strcasecmp(value, "never")) {
721                 return AST_CC_MONITOR_NEVER;
722         } else if (!strcasecmp(value, "native")) {
723                 return AST_CC_MONITOR_NATIVE;
724         } else if (!strcasecmp(value, "generic")) {
725                 return AST_CC_MONITOR_GENERIC;
726         } else if (!strcasecmp(value, "always")) {
727                 return AST_CC_MONITOR_ALWAYS;
728         } else {
729                 ast_log(LOG_WARNING, "%s is an invalid value for cc_monitor_policy. Switching to 'never'\n", value);
730                 return AST_CC_MONITOR_NEVER;
731         }
732 }
733
734 static const char *agent_policy_to_str(enum ast_cc_agent_policies policy)
735 {
736         switch (policy) {
737         case AST_CC_AGENT_NEVER:
738                 return "never";
739         case AST_CC_AGENT_NATIVE:
740                 return "native";
741         case AST_CC_AGENT_GENERIC:
742                 return "generic";
743         default:
744                 /* This should never happen... */
745                 return "";
746         }
747 }
748
749 static const char *monitor_policy_to_str(enum ast_cc_monitor_policies policy)
750 {
751         switch (policy) {
752         case AST_CC_MONITOR_NEVER:
753                 return "never";
754         case AST_CC_MONITOR_NATIVE:
755                 return "native";
756         case AST_CC_MONITOR_GENERIC:
757                 return "generic";
758         case AST_CC_MONITOR_ALWAYS:
759                 return "always";
760         default:
761                 /* This should never happen... */
762                 return "";
763         }
764 }
765 int ast_cc_get_param(struct ast_cc_config_params *params, const char * const name,
766                 char *buf, size_t buf_len)
767 {
768         const char *value = NULL;
769
770         if (!strcasecmp(name, "cc_callback_macro")) {
771                 value = ast_get_cc_callback_macro(params);
772         } else if (!strcasecmp(name, "cc_callback_sub")) {
773                 value = ast_get_cc_callback_sub(params);
774         } else if (!strcasecmp(name, "cc_agent_policy")) {
775                 value = agent_policy_to_str(ast_get_cc_agent_policy(params));
776         } else if (!strcasecmp(name, "cc_monitor_policy")) {
777                 value = monitor_policy_to_str(ast_get_cc_monitor_policy(params));
778         } else if (!strcasecmp(name, "cc_agent_dialstring")) {
779                 value = ast_get_cc_agent_dialstring(params);
780         }
781         if (value) {
782                 ast_copy_string(buf, value, buf_len);
783                 return 0;
784         }
785
786         /* The rest of these are all ints of some sort and require some
787          * snprintf-itude
788          */
789
790         if (!strcasecmp(name, "cc_offer_timer")) {
791                 snprintf(buf, buf_len, "%u", ast_get_cc_offer_timer(params));
792         } else if (!strcasecmp(name, "ccnr_available_timer")) {
793                 snprintf(buf, buf_len, "%u", ast_get_ccnr_available_timer(params));
794         } else if (!strcasecmp(name, "ccbs_available_timer")) {
795                 snprintf(buf, buf_len, "%u", ast_get_ccbs_available_timer(params));
796         } else if (!strcasecmp(name, "cc_max_agents")) {
797                 snprintf(buf, buf_len, "%u", ast_get_cc_max_agents(params));
798         } else if (!strcasecmp(name, "cc_max_monitors")) {
799                 snprintf(buf, buf_len, "%u", ast_get_cc_max_monitors(params));
800         } else if (!strcasecmp(name, "cc_recall_timer")) {
801                 snprintf(buf, buf_len, "%u", ast_get_cc_recall_timer(params));
802         } else {
803                 ast_log(LOG_WARNING, "%s is not a valid CC parameter. Ignoring.\n", name);
804                 return -1;
805         }
806
807         return 0;
808 }
809
810 int ast_cc_set_param(struct ast_cc_config_params *params, const char * const name,
811                 const char * const value)
812 {
813         unsigned int value_as_uint;
814         if (!strcasecmp(name, "cc_agent_policy")) {
815                 return ast_set_cc_agent_policy(params, str_to_agent_policy(value));
816         } else if (!strcasecmp(name, "cc_monitor_policy")) {
817                 return ast_set_cc_monitor_policy(params, str_to_monitor_policy(value));
818         } else if (!strcasecmp(name, "cc_agent_dialstring")) {
819                 ast_set_cc_agent_dialstring(params, value);
820         } else if (!strcasecmp(name, "cc_callback_macro")) {
821                 ast_set_cc_callback_macro(params, value);
822                 return 0;
823         } else if (!strcasecmp(name, "cc_callback_sub")) {
824                 ast_set_cc_callback_sub(params, value);
825                 return 0;
826         }
827
828         if (!sscanf(value, "%30u", &value_as_uint) == 1) {
829                 return -1;
830         }
831
832         if (!strcasecmp(name, "cc_offer_timer")) {
833                 ast_set_cc_offer_timer(params, value_as_uint);
834         } else if (!strcasecmp(name, "ccnr_available_timer")) {
835                 ast_set_ccnr_available_timer(params, value_as_uint);
836         } else if (!strcasecmp(name, "ccbs_available_timer")) {
837                 ast_set_ccbs_available_timer(params, value_as_uint);
838         } else if (!strcasecmp(name, "cc_max_agents")) {
839                 ast_set_cc_max_agents(params, value_as_uint);
840         } else if (!strcasecmp(name, "cc_max_monitors")) {
841                 ast_set_cc_max_monitors(params, value_as_uint);
842         } else if (!strcasecmp(name, "cc_recall_timer")) {
843                 ast_set_cc_recall_timer(params, value_as_uint);
844         } else {
845                 ast_log(LOG_WARNING, "%s is not a valid CC parameter. Ignoring.\n", name);
846                 return -1;
847         }
848
849         return 0;
850 }
851
852 int ast_cc_is_config_param(const char * const name)
853 {
854         return (!strcasecmp(name, "cc_agent_policy") ||
855                                 !strcasecmp(name, "cc_monitor_policy") ||
856                                 !strcasecmp(name, "cc_offer_timer") ||
857                                 !strcasecmp(name, "ccnr_available_timer") ||
858                                 !strcasecmp(name, "ccbs_available_timer") ||
859                                 !strcasecmp(name, "cc_max_agents") ||
860                                 !strcasecmp(name, "cc_max_monitors") ||
861                                 !strcasecmp(name, "cc_callback_macro") ||
862                                 !strcasecmp(name, "cc_callback_sub") ||
863                                 !strcasecmp(name, "cc_agent_dialstring") ||
864                                 !strcasecmp(name, "cc_recall_timer"));
865 }
866
867 void ast_cc_copy_config_params(struct ast_cc_config_params *dest, const struct ast_cc_config_params *src)
868 {
869         *dest = *src;
870 }
871
872 enum ast_cc_agent_policies ast_get_cc_agent_policy(struct ast_cc_config_params *config)
873 {
874         return config->cc_agent_policy;
875 }
876
877 int ast_set_cc_agent_policy(struct ast_cc_config_params *config, enum ast_cc_agent_policies value)
878 {
879         /* Screw C and its weak type checking for making me have to do this
880          * validation at runtime.
881          */
882         if (value < AST_CC_AGENT_NEVER || value > AST_CC_AGENT_GENERIC) {
883                 return -1;
884         }
885         config->cc_agent_policy = value;
886         return 0;
887 }
888
889 enum ast_cc_monitor_policies ast_get_cc_monitor_policy(struct ast_cc_config_params *config)
890 {
891         return config->cc_monitor_policy;
892 }
893
894 int ast_set_cc_monitor_policy(struct ast_cc_config_params *config, enum ast_cc_monitor_policies value)
895 {
896         /* Screw C and its weak type checking for making me have to do this
897          * validation at runtime.
898          */
899         if (value < AST_CC_MONITOR_NEVER || value > AST_CC_MONITOR_ALWAYS) {
900                 return -1;
901         }
902         config->cc_monitor_policy = value;
903         return 0;
904 }
905
906 unsigned int ast_get_cc_offer_timer(struct ast_cc_config_params *config)
907 {
908         return config->cc_offer_timer;
909 }
910
911 void ast_set_cc_offer_timer(struct ast_cc_config_params *config, unsigned int value)
912 {
913         /* 0 is an unreasonable value for any timer. Stick with the default */
914         if (value == 0) {
915                 ast_log(LOG_WARNING, "0 is an invalid value for cc_offer_timer. Retaining value as %u\n", config->cc_offer_timer);
916                 return;
917         }
918         config->cc_offer_timer = value;
919 }
920
921 unsigned int ast_get_ccnr_available_timer(struct ast_cc_config_params *config)
922 {
923         return config->ccnr_available_timer;
924 }
925
926 void ast_set_ccnr_available_timer(struct ast_cc_config_params *config, unsigned int value)
927 {
928         /* 0 is an unreasonable value for any timer. Stick with the default */
929         if (value == 0) {
930                 ast_log(LOG_WARNING, "0 is an invalid value for ccnr_available_timer. Retaining value as %u\n", config->ccnr_available_timer);
931                 return;
932         }
933         config->ccnr_available_timer = value;
934 }
935
936 unsigned int ast_get_cc_recall_timer(struct ast_cc_config_params *config)
937 {
938         return config->cc_recall_timer;
939 }
940
941 void ast_set_cc_recall_timer(struct ast_cc_config_params *config, unsigned int value)
942 {
943         /* 0 is an unreasonable value for any timer. Stick with the default */
944         if (value == 0) {
945                 ast_log(LOG_WARNING, "0 is an invalid value for ccnr_available_timer. Retaining value as %u\n", config->cc_recall_timer);
946                 return;
947         }
948         config->cc_recall_timer = value;
949 }
950
951 unsigned int ast_get_ccbs_available_timer(struct ast_cc_config_params *config)
952 {
953         return config->ccbs_available_timer;
954 }
955
956 void ast_set_ccbs_available_timer(struct ast_cc_config_params *config, unsigned int value)
957 {
958         /* 0 is an unreasonable value for any timer. Stick with the default */
959         if (value == 0) {
960                 ast_log(LOG_WARNING, "0 is an invalid value for ccbs_available_timer. Retaining value as %u\n", config->ccbs_available_timer);
961                 return;
962         }
963         config->ccbs_available_timer = value;
964 }
965
966 const char *ast_get_cc_agent_dialstring(struct ast_cc_config_params *config)
967 {
968         return config->cc_agent_dialstring;
969 }
970
971 void ast_set_cc_agent_dialstring(struct ast_cc_config_params *config, const char *const value)
972 {
973         if (ast_strlen_zero(value)) {
974                 config->cc_agent_dialstring[0] = '\0';
975         } else {
976                 ast_copy_string(config->cc_agent_dialstring, value, sizeof(config->cc_agent_dialstring));
977         }
978 }
979
980 unsigned int ast_get_cc_max_agents(struct ast_cc_config_params *config)
981 {
982         return config->cc_max_agents;
983 }
984
985 void ast_set_cc_max_agents(struct ast_cc_config_params *config, unsigned int value)
986 {
987         config->cc_max_agents = value;
988 }
989
990 unsigned int ast_get_cc_max_monitors(struct ast_cc_config_params *config)
991 {
992         return config->cc_max_monitors;
993 }
994
995 void ast_set_cc_max_monitors(struct ast_cc_config_params *config, unsigned int value)
996 {
997         config->cc_max_monitors = value;
998 }
999
1000 const char *ast_get_cc_callback_macro(struct ast_cc_config_params *config)
1001 {
1002         return config->cc_callback_macro;
1003 }
1004
1005 const char *ast_get_cc_callback_sub(struct ast_cc_config_params *config)
1006 {
1007         return config->cc_callback_sub;
1008 }
1009
1010 void ast_set_cc_callback_macro(struct ast_cc_config_params *config, const char * const value)
1011 {
1012         ast_log(LOG_WARNING, "Usage of cc_callback_macro is deprecated.  Please use cc_callback_sub instead.\n");
1013         if (ast_strlen_zero(value)) {
1014                 config->cc_callback_macro[0] = '\0';
1015         } else {
1016                 ast_copy_string(config->cc_callback_macro, value, sizeof(config->cc_callback_macro));
1017         }
1018 }
1019
1020 void ast_set_cc_callback_sub(struct ast_cc_config_params *config, const char * const value)
1021 {
1022         if (ast_strlen_zero(value)) {
1023                 config->cc_callback_sub[0] = '\0';
1024         } else {
1025                 ast_copy_string(config->cc_callback_sub, value, sizeof(config->cc_callback_sub));
1026         }
1027 }
1028
1029 static int cc_publish(struct stasis_message_type *message_type, int core_id, struct ast_json *extras)
1030 {
1031         RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
1032         RAII_VAR(struct ast_json_payload *, payload, NULL, ao2_cleanup);
1033         RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
1034
1035         if (!message_type) {
1036                 return -1;
1037         }
1038
1039         blob = ast_json_pack("{s: i}",
1040                 "core_id", core_id);
1041         if (!blob) {
1042                 return -1;
1043         }
1044
1045         if (extras) {
1046                 ast_json_object_update(blob, extras);
1047         }
1048
1049         if (!(payload = ast_json_payload_create(blob))) {
1050                 return -1;
1051         }
1052
1053         if (!(message = stasis_message_create(message_type, payload))) {
1054                 return -1;
1055         }
1056
1057         stasis_publish(ast_system_topic(), message);
1058
1059         return 0;
1060 }
1061
1062 static void cc_publish_available(int core_id, const char *callee, const char *service)
1063 {
1064         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1065
1066         extras = ast_json_pack("{s: s, s: s}",
1067                 "callee", callee,
1068                 "service", service);
1069
1070         cc_publish(ast_cc_available_type(), core_id, extras);
1071 }
1072
1073 static void cc_publish_offertimerstart(int core_id, const char *caller, unsigned int expires)
1074 {
1075         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1076
1077         extras = ast_json_pack("{s: s, s: i}",
1078                 "caller", caller,
1079                 "expires", expires);
1080
1081         cc_publish(ast_cc_offertimerstart_type(), core_id, extras);
1082 }
1083
1084 static void cc_publish_requested(int core_id, const char *caller, const char *callee)
1085 {
1086         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1087
1088         extras = ast_json_pack("{s: s, s: s}",
1089                 "caller", caller,
1090                 "callee", callee);
1091
1092         cc_publish(ast_cc_requested_type(), core_id, extras);
1093 }
1094
1095 static void cc_publish_requestacknowledged(int core_id, const char *caller)
1096 {
1097         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1098
1099         extras = ast_json_pack("{s: s}",
1100                 "caller", caller);
1101
1102         cc_publish(ast_cc_requestacknowledged_type(), core_id, extras);
1103 }
1104
1105 static void cc_publish_callerstopmonitoring(int core_id, const char *caller)
1106 {
1107         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1108
1109         extras = ast_json_pack("{s: s}",
1110                 "caller", caller);
1111
1112         cc_publish(ast_cc_callerstopmonitoring_type(), core_id, extras);
1113 }
1114
1115 static void cc_publish_callerstartmonitoring(int core_id, const char *caller)
1116 {
1117         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1118
1119         extras = ast_json_pack("{s: s}",
1120                 "caller", caller);
1121
1122         cc_publish(ast_cc_callerstartmonitoring_type(), core_id, extras);
1123 }
1124
1125 static void cc_publish_callerrecalling(int core_id, const char *caller)
1126 {
1127         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1128
1129         extras = ast_json_pack("{s: s}",
1130                 "caller", caller);
1131
1132         cc_publish(ast_cc_callerrecalling_type(), core_id, extras);
1133 }
1134
1135 static void cc_publish_recallcomplete(int core_id, const char *caller)
1136 {
1137         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1138
1139         extras = ast_json_pack("{s: s}",
1140                 "caller", caller);
1141
1142         cc_publish(ast_cc_recallcomplete_type(), core_id, extras);
1143 }
1144
1145 static void cc_publish_failure(int core_id, const char *caller, const char *reason)
1146 {
1147         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1148
1149         extras = ast_json_pack("{s: s, s: s}",
1150                 "caller", caller,
1151                 "reason", reason);
1152
1153         cc_publish(ast_cc_failure_type(), core_id, extras);
1154 }
1155
1156 static void cc_publish_monitorfailed(int core_id, const char *callee)
1157 {
1158         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1159
1160         extras = ast_json_pack("{s: s}",
1161                 "callee", callee);
1162
1163         cc_publish(ast_cc_monitorfailed_type(), core_id, extras);
1164 }
1165
1166 struct cc_monitor_backend {
1167         AST_LIST_ENTRY(cc_monitor_backend) next;
1168         const struct ast_cc_monitor_callbacks *callbacks;
1169 };
1170
1171 AST_RWLIST_HEAD_STATIC(cc_monitor_backends, cc_monitor_backend);
1172
1173 int ast_cc_monitor_register(const struct ast_cc_monitor_callbacks *callbacks)
1174 {
1175         struct cc_monitor_backend *backend = ast_calloc(1, sizeof(*backend));
1176
1177         if (!backend) {
1178                 return -1;
1179         }
1180
1181         backend->callbacks = callbacks;
1182
1183         AST_RWLIST_WRLOCK(&cc_monitor_backends);
1184         AST_RWLIST_INSERT_TAIL(&cc_monitor_backends, backend, next);
1185         AST_RWLIST_UNLOCK(&cc_monitor_backends);
1186         return 0;
1187 }
1188
1189 static const struct ast_cc_monitor_callbacks *find_monitor_callbacks(const char * const type)
1190 {
1191         struct cc_monitor_backend *backend;
1192         const struct ast_cc_monitor_callbacks *callbacks = NULL;
1193
1194         AST_RWLIST_RDLOCK(&cc_monitor_backends);
1195         AST_RWLIST_TRAVERSE(&cc_monitor_backends, backend, next) {
1196                 if (!strcmp(backend->callbacks->type, type)) {
1197                         ast_log_dynamic_level(cc_logger_level, "Returning monitor backend %s\n", backend->callbacks->type);
1198                         callbacks = backend->callbacks;
1199                         break;
1200                 }
1201         }
1202         AST_RWLIST_UNLOCK(&cc_monitor_backends);
1203         return callbacks;
1204 }
1205
1206 void ast_cc_monitor_unregister(const struct ast_cc_monitor_callbacks *callbacks)
1207 {
1208         struct cc_monitor_backend *backend;
1209         AST_RWLIST_WRLOCK(&cc_monitor_backends);
1210         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&cc_monitor_backends, backend, next) {
1211                 if (backend->callbacks == callbacks) {
1212                         AST_RWLIST_REMOVE_CURRENT(next);
1213                         ast_free(backend);
1214                         break;
1215                 }
1216         }
1217         AST_RWLIST_TRAVERSE_SAFE_END;
1218         AST_RWLIST_UNLOCK(&cc_monitor_backends);
1219 }
1220
1221 struct cc_agent_backend {
1222         AST_LIST_ENTRY(cc_agent_backend) next;
1223         const struct ast_cc_agent_callbacks *callbacks;
1224 };
1225
1226 AST_RWLIST_HEAD_STATIC(cc_agent_backends, cc_agent_backend);
1227
1228 int ast_cc_agent_register(const struct ast_cc_agent_callbacks *callbacks)
1229 {
1230         struct cc_agent_backend *backend = ast_calloc(1, sizeof(*backend));
1231
1232         if (!backend) {
1233                 return -1;
1234         }
1235
1236         backend->callbacks = callbacks;
1237         AST_RWLIST_WRLOCK(&cc_agent_backends);
1238         AST_RWLIST_INSERT_TAIL(&cc_agent_backends, backend, next);
1239         AST_RWLIST_UNLOCK(&cc_agent_backends);
1240         return 0;
1241 }
1242
1243 void ast_cc_agent_unregister(const struct ast_cc_agent_callbacks *callbacks)
1244 {
1245         struct cc_agent_backend *backend;
1246         AST_RWLIST_WRLOCK(&cc_agent_backends);
1247         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&cc_agent_backends, backend, next) {
1248                 if (backend->callbacks == callbacks) {
1249                         AST_RWLIST_REMOVE_CURRENT(next);
1250                         ast_free(backend);
1251                         break;
1252                 }
1253         }
1254         AST_RWLIST_TRAVERSE_SAFE_END;
1255         AST_RWLIST_UNLOCK(&cc_agent_backends);
1256 }
1257
1258 static const struct ast_cc_agent_callbacks *find_agent_callbacks(struct ast_channel *chan)
1259 {
1260         struct cc_agent_backend *backend;
1261         const struct ast_cc_agent_callbacks *callbacks = NULL;
1262         struct ast_cc_config_params *cc_params;
1263         char type[32];
1264
1265         cc_params = ast_channel_get_cc_config_params(chan);
1266         if (!cc_params) {
1267                 return NULL;
1268         }
1269         switch (ast_get_cc_agent_policy(cc_params)) {
1270         case AST_CC_AGENT_GENERIC:
1271                 ast_copy_string(type, "generic", sizeof(type));
1272                 break;
1273         case AST_CC_AGENT_NATIVE:
1274                 ast_channel_get_cc_agent_type(chan, type, sizeof(type));
1275                 break;
1276         default:
1277                 ast_log_dynamic_level(cc_logger_level, "Not returning agent callbacks since this channel is configured not to have a CC agent\n");
1278                 return NULL;
1279         }
1280
1281         AST_RWLIST_RDLOCK(&cc_agent_backends);
1282         AST_RWLIST_TRAVERSE(&cc_agent_backends, backend, next) {
1283                 if (!strcmp(backend->callbacks->type, type)) {
1284                         ast_log_dynamic_level(cc_logger_level, "Returning agent backend %s\n", backend->callbacks->type);
1285                         callbacks = backend->callbacks;
1286                         break;
1287                 }
1288         }
1289         AST_RWLIST_UNLOCK(&cc_agent_backends);
1290         return callbacks;
1291 }
1292
1293 /*!
1294  * \internal
1295  * \brief Determine if the given device state is considered available by generic CCSS.
1296  * \since 1.8
1297  *
1298  * \param state Device state to test.
1299  *
1300  * \return TRUE if the given device state is considered available by generic CCSS.
1301  */
1302 static int cc_generic_is_device_available(enum ast_device_state state)
1303 {
1304         return state == AST_DEVICE_NOT_INUSE || state == AST_DEVICE_UNKNOWN;
1305 }
1306
1307 static int cc_generic_monitor_request_cc(struct ast_cc_monitor *monitor, int *available_timer_id);
1308 static int cc_generic_monitor_suspend(struct ast_cc_monitor *monitor);
1309 static int cc_generic_monitor_unsuspend(struct ast_cc_monitor *monitor);
1310 static int cc_generic_monitor_cancel_available_timer(struct ast_cc_monitor *monitor, int *sched_id);
1311 static void cc_generic_monitor_destructor(void *private_data);
1312
1313 static struct ast_cc_monitor_callbacks generic_monitor_cbs = {
1314         .type = "generic",
1315         .request_cc = cc_generic_monitor_request_cc,
1316         .suspend = cc_generic_monitor_suspend,
1317         .unsuspend = cc_generic_monitor_unsuspend,
1318         .cancel_available_timer = cc_generic_monitor_cancel_available_timer,
1319         .destructor = cc_generic_monitor_destructor,
1320 };
1321
1322 struct ao2_container *generic_monitors;
1323
1324 struct generic_monitor_instance {
1325         int core_id;
1326         int is_suspended;
1327         int monitoring;
1328         AST_LIST_ENTRY(generic_monitor_instance) next;
1329 };
1330
1331 struct generic_monitor_instance_list {
1332         const char *device_name;
1333         enum ast_device_state current_state;
1334         /* If there are multiple instances monitoring the
1335          * same device and one should fail, we need to know
1336          * whether to signal that the device can be recalled.
1337          * The problem is that the device state is not enough
1338          * to check. If a caller has requested CCNR, then the
1339          * fact that the device is available does not indicate
1340          * that the device is ready to be recalled. Instead, as
1341          * soon as one instance of the monitor becomes available
1342          * for a recall, we mark the entire list as being fit
1343          * for recall. If a CCNR request comes in, then we will
1344          * have to mark the list as unfit for recall since this
1345          * is a clear indicator that the person at the monitored
1346          * device has gone away and is actuall not fit to be
1347          * recalled
1348          */
1349         int fit_for_recall;
1350         struct stasis_subscription *sub;
1351         AST_LIST_HEAD_NOLOCK(, generic_monitor_instance) list;
1352 };
1353
1354 /*!
1355  * \brief private data for generic device monitor
1356  */
1357 struct generic_monitor_pvt {
1358         /*!
1359          * We need the device name during destruction so we
1360          * can find the appropriate item to destroy.
1361          */
1362         const char *device_name;
1363         /*!
1364          * We need the core ID for similar reasons. Once we
1365          * find the appropriate item in our ao2_container, we
1366          * need to remove the appropriate cc_monitor from the
1367          * list of monitors.
1368          */
1369         int core_id;
1370 };
1371
1372 static int generic_monitor_hash_fn(const void *obj, const int flags)
1373 {
1374         const struct generic_monitor_instance_list *generic_list = obj;
1375         return ast_str_hash(generic_list->device_name);
1376 }
1377
1378 static int generic_monitor_cmp_fn(void *obj, void *arg, int flags)
1379 {
1380         const struct generic_monitor_instance_list *generic_list1 = obj;
1381         const struct generic_monitor_instance_list *generic_list2 = arg;
1382
1383         return !strcmp(generic_list1->device_name, generic_list2->device_name) ? CMP_MATCH | CMP_STOP : 0;
1384 }
1385
1386 static struct generic_monitor_instance_list *find_generic_monitor_instance_list(const char * const device_name)
1387 {
1388         struct generic_monitor_instance_list finder = {0};
1389         char *uppertech = ast_strdupa(device_name);
1390         ast_tech_to_upper(uppertech);
1391         finder.device_name = uppertech;
1392
1393         return ao2_t_find(generic_monitors, &finder, OBJ_POINTER, "Finding generic monitor instance list");
1394 }
1395
1396 static void generic_monitor_instance_list_destructor(void *obj)
1397 {
1398         struct generic_monitor_instance_list *generic_list = obj;
1399         struct generic_monitor_instance *generic_instance;
1400
1401         generic_list->sub = stasis_unsubscribe(generic_list->sub);
1402         while ((generic_instance = AST_LIST_REMOVE_HEAD(&generic_list->list, next))) {
1403                 ast_free(generic_instance);
1404         }
1405         ast_free((char *)generic_list->device_name);
1406 }
1407
1408 static void generic_monitor_devstate_cb(void *userdata, struct stasis_subscription *sub, struct stasis_message *msg);
1409 static struct generic_monitor_instance_list *create_new_generic_list(struct ast_cc_monitor *monitor)
1410 {
1411         struct generic_monitor_instance_list *generic_list = ao2_t_alloc(sizeof(*generic_list),
1412                         generic_monitor_instance_list_destructor, "allocate generic monitor instance list");
1413         char * device_name;
1414         struct stasis_topic *device_specific_topic;
1415
1416         if (!generic_list) {
1417                 return NULL;
1418         }
1419
1420         if (!(device_name = ast_strdup(monitor->interface->device_name))) {
1421                 cc_unref(generic_list, "Failed to strdup the monitor's device name");
1422                 return NULL;
1423         }
1424         ast_tech_to_upper(device_name);
1425         generic_list->device_name = device_name;
1426
1427         device_specific_topic = ast_device_state_topic(device_name);
1428         if (!device_specific_topic) {
1429                 return NULL;
1430         }
1431
1432         if (!(generic_list->sub = stasis_subscribe(device_specific_topic, generic_monitor_devstate_cb, NULL))) {
1433                 cc_unref(generic_list, "Failed to subscribe to device state");
1434                 return NULL;
1435         }
1436         generic_list->current_state = ast_device_state(monitor->interface->device_name);
1437         ao2_t_link(generic_monitors, generic_list, "linking new generic monitor instance list");
1438         return generic_list;
1439 }
1440
1441 static int generic_monitor_devstate_tp_cb(void *data)
1442 {
1443         RAII_VAR(struct ast_device_state_message *, dev_state, data, ao2_cleanup);
1444         enum ast_device_state new_state = dev_state->state;
1445         enum ast_device_state previous_state;
1446         struct generic_monitor_instance_list *generic_list;
1447         struct generic_monitor_instance *generic_instance;
1448
1449         if (!(generic_list = find_generic_monitor_instance_list(dev_state->device))) {
1450                 /* The most likely cause for this is that we destroyed the monitor in the
1451                  * time between subscribing to its device state and the time this executes.
1452                  * Not really a big deal.
1453                  */
1454                 return 0;
1455         }
1456
1457         if (generic_list->current_state == new_state) {
1458                 /* The device state hasn't actually changed, so we don't really care */
1459                 cc_unref(generic_list, "Kill reference of generic list in devstate taskprocessor callback");
1460                 return 0;
1461         }
1462
1463         previous_state = generic_list->current_state;
1464         generic_list->current_state = new_state;
1465
1466         if (cc_generic_is_device_available(new_state) &&
1467                         (previous_state == AST_DEVICE_INUSE || previous_state == AST_DEVICE_UNAVAILABLE ||
1468                          previous_state == AST_DEVICE_BUSY)) {
1469                 AST_LIST_TRAVERSE(&generic_list->list, generic_instance, next) {
1470                         if (!generic_instance->is_suspended && generic_instance->monitoring) {
1471                                 generic_instance->monitoring = 0;
1472                                 generic_list->fit_for_recall = 1;
1473                                 ast_cc_monitor_callee_available(generic_instance->core_id, "Generic monitored party has become available");
1474                                 break;
1475                         }
1476                 }
1477         }
1478         cc_unref(generic_list, "Kill reference of generic list in devstate taskprocessor callback");
1479         return 0;
1480 }
1481
1482 static void generic_monitor_devstate_cb(void *userdata, struct stasis_subscription *sub, struct stasis_message *msg)
1483 {
1484         /* Wow, it's cool that we've picked up on a state change, but we really want
1485          * the actual work to be done in the core's taskprocessor execution thread
1486          * so that all monitor operations can be serialized. Locks?! We don't need
1487          * no steenkin' locks!
1488          */
1489         struct ast_device_state_message *dev_state;
1490         if (ast_device_state_message_type() != stasis_message_type(msg)) {
1491                 return;
1492         }
1493
1494         dev_state = stasis_message_data(msg);
1495         if (dev_state->eid) {
1496                 /* ignore non-aggregate states */
1497                 return;
1498         }
1499
1500         ao2_t_ref(dev_state, +1, "Bumping dev_state ref for cc_core_taskprocessor");
1501         if (ast_taskprocessor_push(cc_core_taskprocessor, generic_monitor_devstate_tp_cb, dev_state)) {
1502                 ao2_cleanup(dev_state);
1503                 return;
1504         }
1505 }
1506
1507 int ast_cc_available_timer_expire(const void *data)
1508 {
1509         struct ast_cc_monitor *monitor = (struct ast_cc_monitor *) data;
1510         int res;
1511         monitor->available_timer_id = -1;
1512         res = ast_cc_monitor_failed(monitor->core_id, monitor->interface->device_name, "Available timer expired for monitor");
1513         cc_unref(monitor, "Unref reference from scheduler\n");
1514         return res;
1515 }
1516
1517 static int cc_generic_monitor_request_cc(struct ast_cc_monitor *monitor, int *available_timer_id)
1518 {
1519         struct generic_monitor_instance_list *generic_list;
1520         struct generic_monitor_instance *generic_instance;
1521         struct generic_monitor_pvt *gen_mon_pvt;
1522         enum ast_cc_service_type service = monitor->service_offered;
1523         int when;
1524
1525         /* First things first. Native channel drivers will have their private data allocated
1526          * at the time that they tell the core that they can offer CC. Generic is quite a bit
1527          * different, and we wait until this point to allocate our private data.
1528          */
1529         if (!(gen_mon_pvt = ast_calloc(1, sizeof(*gen_mon_pvt)))) {
1530                 return -1;
1531         }
1532
1533         if (!(gen_mon_pvt->device_name = ast_strdup(monitor->interface->device_name))) {
1534                 ast_free(gen_mon_pvt);
1535                 return -1;
1536         }
1537
1538         gen_mon_pvt->core_id = monitor->core_id;
1539
1540         monitor->private_data = gen_mon_pvt;
1541
1542         if (!(generic_list = find_generic_monitor_instance_list(monitor->interface->device_name))) {
1543                 if (!(generic_list = create_new_generic_list(monitor))) {
1544                         return -1;
1545                 }
1546         }
1547
1548         if (!(generic_instance = ast_calloc(1, sizeof(*generic_instance)))) {
1549                 /* The generic monitor destructor will take care of the appropriate
1550                  * deallocations
1551                  */
1552                 cc_unref(generic_list, "Generic monitor instance failed to allocate");
1553                 return -1;
1554         }
1555         generic_instance->core_id = monitor->core_id;
1556         generic_instance->monitoring = 1;
1557         AST_LIST_INSERT_TAIL(&generic_list->list, generic_instance, next);
1558         when = service == AST_CC_CCBS ? ast_get_ccbs_available_timer(monitor->interface->config_params) :
1559                 ast_get_ccnr_available_timer(monitor->interface->config_params);
1560
1561         *available_timer_id = ast_sched_add(cc_sched_context, when * 1000,
1562                         ast_cc_available_timer_expire, cc_ref(monitor, "Give the scheduler a monitor reference"));
1563         if (*available_timer_id == -1) {
1564                 cc_unref(monitor, "Failed to schedule available timer. (monitor)");
1565                 cc_unref(generic_list, "Failed to schedule available timer. (generic_list)");
1566                 return -1;
1567         }
1568         /* If the new instance was created as CCNR, then that means this device is not currently
1569          * fit for recall even if it previously was.
1570          */
1571         if (service == AST_CC_CCNR || service == AST_CC_CCNL) {
1572                 generic_list->fit_for_recall = 0;
1573         }
1574         ast_cc_monitor_request_acked(monitor->core_id, "Generic monitor for %s subscribed to device state.",
1575                         monitor->interface->device_name);
1576         cc_unref(generic_list, "Finished with monitor instance reference in request cc callback");
1577         return 0;
1578 }
1579
1580 static int cc_generic_monitor_suspend(struct ast_cc_monitor *monitor)
1581 {
1582         struct generic_monitor_instance_list *generic_list;
1583         struct generic_monitor_instance *generic_instance;
1584         enum ast_device_state state = ast_device_state(monitor->interface->device_name);
1585
1586         if (!(generic_list = find_generic_monitor_instance_list(monitor->interface->device_name))) {
1587                 return -1;
1588         }
1589
1590         /* First we need to mark this particular monitor as being suspended. */
1591         AST_LIST_TRAVERSE(&generic_list->list, generic_instance, next) {
1592                 if (generic_instance->core_id == monitor->core_id) {
1593                         generic_instance->is_suspended = 1;
1594                         break;
1595                 }
1596         }
1597
1598         /* If the device being suspended is currently in use, then we don't need to
1599          * take any further actions
1600          */
1601         if (!cc_generic_is_device_available(state)) {
1602                 cc_unref(generic_list, "Device is in use. Nothing to do. Unref generic list.");
1603                 return 0;
1604         }
1605
1606         /* If the device is not in use, though, then it may be possible to report the
1607          * device's availability using a different monitor which is monitoring the
1608          * same device
1609          */
1610
1611         AST_LIST_TRAVERSE(&generic_list->list, generic_instance, next) {
1612                 if (!generic_instance->is_suspended) {
1613                         ast_cc_monitor_callee_available(generic_instance->core_id, "Generic monitored party has become available");
1614                         break;
1615                 }
1616         }
1617         cc_unref(generic_list, "Done with generic list in suspend callback");
1618         return 0;
1619 }
1620
1621 static int cc_generic_monitor_unsuspend(struct ast_cc_monitor *monitor)
1622 {
1623         struct generic_monitor_instance *generic_instance;
1624         struct generic_monitor_instance_list *generic_list = find_generic_monitor_instance_list(monitor->interface->device_name);
1625         enum ast_device_state state = ast_device_state(monitor->interface->device_name);
1626
1627         if (!generic_list) {
1628                 return -1;
1629         }
1630         /* If the device is currently available, we can immediately announce
1631          * its availability
1632          */
1633         if (cc_generic_is_device_available(state)) {
1634                 ast_cc_monitor_callee_available(monitor->core_id, "Generic monitored party has become available");
1635         }
1636
1637         /* In addition, we need to mark this generic_monitor_instance as not being suspended anymore */
1638         AST_LIST_TRAVERSE(&generic_list->list, generic_instance, next) {
1639                 if (generic_instance->core_id == monitor->core_id) {
1640                         generic_instance->is_suspended = 0;
1641                         generic_instance->monitoring = 1;
1642                         break;
1643                 }
1644         }
1645         cc_unref(generic_list, "Done with generic list in cc_generic_monitor_unsuspend");
1646         return 0;
1647 }
1648
1649 static int cc_generic_monitor_cancel_available_timer(struct ast_cc_monitor *monitor, int *sched_id)
1650 {
1651         ast_assert(sched_id != NULL);
1652
1653         if (*sched_id == -1) {
1654                 return 0;
1655         }
1656
1657         ast_log_dynamic_level(cc_logger_level, "Core %d: Canceling generic monitor available timer for monitor %s\n",
1658                         monitor->core_id, monitor->interface->device_name);
1659         if (!ast_sched_del(cc_sched_context, *sched_id)) {
1660                 cc_unref(monitor, "Remove scheduler's reference to the monitor");
1661         }
1662         *sched_id = -1;
1663         return 0;
1664 }
1665
1666 static void cc_generic_monitor_destructor(void *private_data)
1667 {
1668         struct generic_monitor_pvt *gen_mon_pvt = private_data;
1669         struct generic_monitor_instance_list *generic_list;
1670         struct generic_monitor_instance *generic_instance;
1671
1672         if (!private_data) {
1673                 /* If the private data is NULL, that means that the monitor hasn't even
1674                  * been created yet, but that the destructor was called. While this sort
1675                  * of behavior is useful for native monitors, with a generic one, there is
1676                  * nothing in particular to do.
1677                  */
1678                 return;
1679         }
1680
1681         ast_log_dynamic_level(cc_logger_level, "Core %d: Destroying generic monitor %s\n",
1682                         gen_mon_pvt->core_id, gen_mon_pvt->device_name);
1683
1684         if (!(generic_list = find_generic_monitor_instance_list(gen_mon_pvt->device_name))) {
1685                 /* If there's no generic list, that means that the monitor is being destroyed
1686                  * before we actually got to request CC. Not a biggie. Same in the situation
1687                  * below if the list traversal should complete without finding an entry.
1688                  */
1689                 ast_free((char *)gen_mon_pvt->device_name);
1690                 ast_free(gen_mon_pvt);
1691                 return;
1692         }
1693
1694         AST_LIST_TRAVERSE_SAFE_BEGIN(&generic_list->list, generic_instance, next) {
1695                 if (generic_instance->core_id == gen_mon_pvt->core_id) {
1696                         AST_LIST_REMOVE_CURRENT(next);
1697                         ast_free(generic_instance);
1698                         break;
1699                 }
1700         }
1701         AST_LIST_TRAVERSE_SAFE_END;
1702
1703         if (AST_LIST_EMPTY(&generic_list->list)) {
1704                 /* No more monitors with this device name exist. Time to unlink this
1705                  * list from the container
1706                  */
1707                 ao2_t_unlink(generic_monitors, generic_list, "Generic list is empty. Unlink it from the container");
1708         } else {
1709                 /* There are still instances for this particular device. The situation
1710                  * may be that we were attempting a CC recall and a failure occurred, perhaps
1711                  * on the agent side. If a failure happens here and the device being monitored
1712                  * is available, then we need to signal on the first unsuspended instance that
1713                  * the device is available for recall.
1714                  */
1715
1716                 /* First things first. We don't even want to consider this action if
1717                  * the device in question isn't available right now.
1718                  */
1719                 if (generic_list->fit_for_recall
1720                         && cc_generic_is_device_available(generic_list->current_state)) {
1721                         AST_LIST_TRAVERSE(&generic_list->list, generic_instance, next) {
1722                                 if (!generic_instance->is_suspended && generic_instance->monitoring) {
1723                                         ast_cc_monitor_callee_available(generic_instance->core_id, "Signaling generic monitor "
1724                                                         "availability due to other instance's failure.");
1725                                         break;
1726                                 }
1727                         }
1728                 }
1729         }
1730         cc_unref(generic_list, "Done with generic list in generic monitor destructor");
1731         ast_free((char *)gen_mon_pvt->device_name);
1732         ast_free(gen_mon_pvt);
1733 }
1734
1735 static void cc_interface_destroy(void *data)
1736 {
1737         struct ast_cc_interface *interface = data;
1738         ast_log_dynamic_level(cc_logger_level, "Destroying cc interface %s\n", interface->device_name);
1739         ast_cc_config_params_destroy(interface->config_params);
1740 }
1741
1742 /*!
1743  * \brief Data regarding an extension monitor's child's dialstrings
1744  *
1745  * \details
1746  * In developing CCSS, we had most aspects of its operation finished,
1747  * but there was one looming problem that we had failed to get right.
1748  * In our design document, we stated that when a CC recall occurs, all
1749  * endpoints that had been dialed originally would be called back.
1750  * Unfortunately, our implementation only allowed for devices which had
1751  * active monitors to inhabit the CC_INTERFACES channel variable, thus
1752  * making the automated recall only call monitored devices.
1753  *
1754  * Devices that were not CC-capable, or devices which failed CC at some
1755  * point during the process would not make it into the CC_INTERFACES
1756  * channel variable. This struct is meant as a remedy for the problem.
1757  */
1758 struct extension_child_dialstring {
1759         /*!
1760          * \brief the original dialstring used to call a particular device
1761          *
1762          * \details
1763          * When someone dials a particular endpoint, the dialstring used in
1764          * the dialplan is copied into this buffer. What's important here is
1765          * that this is the ORIGINAL dialstring, not the dialstring saved on
1766          * a device monitor. The dialstring on a device monitor is what should
1767          * be used when recalling that device. The two dialstrings may not be
1768          * the same.
1769          *
1770          * By keeping a copy of the original dialstring used, we can fall back
1771          * to using it if the device either does not ever offer CC or if the
1772          * device at some point fails for some reason, such as a timer expiration.
1773          */
1774         char original_dialstring[AST_CHANNEL_NAME];
1775         /*!
1776          * \brief The name of the device being dialed
1777          *
1778          * \details
1779          * This serves mainly as a key when searching for a particular dialstring.
1780          * For instance, let's say that we have called device SIP/400\@somepeer. This
1781          * device offers call completion, but then due to some unforeseen circumstance,
1782          * this device backs out and makes CC unavailable. When that happens, we need
1783          * to find the dialstring that corresponds to that device, and we use the
1784          * stored device name as a way to find it.
1785          *
1786          * \note There is one particular case where the device name stored here
1787          * will be empty. This is the case where we fail to request a channel, but we
1788          * still can make use of generic call completion. In such a case, since we never
1789          * were able to request the channel, we can't find what its device name is. In
1790          * this case, however, it is not important because the dialstring is guaranteed
1791          * to be the same both here and in the device monitor.
1792          */
1793         char device_name[AST_CHANNEL_NAME];
1794         /*!
1795          * \brief Is this structure valid for use in CC_INTERFACES?
1796          *
1797          * \details
1798          * When this structure is first created, all information stored here is planned
1799          * to be used, so we set the is_valid flag. However, if a device offers call
1800          * completion, it will potentially have its own dialstring to use for the recall,
1801          * so we find this structure and clear the is_valid flag. By clearing the is_valid
1802          * flag, we won't try to populate the CC_INTERFACES variable with the dialstring
1803          * stored in this struct. Now, if later, the device which had offered CC should fail,
1804          * perhaps due to a timer expiration, then we need to re-set the is_valid flag. This
1805          * way, we still will end up placing a call to the device again, and the dialstring
1806          * used will be the same as was originally used.
1807          */
1808         int is_valid;
1809         AST_LIST_ENTRY(extension_child_dialstring) next;
1810 };
1811
1812 /*!
1813  * \brief Private data for an extension monitor
1814  */
1815 struct extension_monitor_pvt {
1816         AST_LIST_HEAD_NOLOCK(, extension_child_dialstring) child_dialstrings;
1817 };
1818
1819 static void cc_extension_monitor_destructor(void *private_data)
1820 {
1821         struct extension_monitor_pvt *extension_pvt = private_data;
1822         struct extension_child_dialstring *child_dialstring;
1823
1824         /* This shouldn't be possible, but I'm paranoid */
1825         if (!extension_pvt) {
1826                 return;
1827         }
1828
1829         while ((child_dialstring = AST_LIST_REMOVE_HEAD(&extension_pvt->child_dialstrings, next))) {
1830                 ast_free(child_dialstring);
1831         }
1832         ast_free(extension_pvt);
1833 }
1834
1835 static void cc_monitor_destroy(void *data)
1836 {
1837         struct ast_cc_monitor *monitor = data;
1838         /* During the monitor creation process, it is possible for this
1839          * function to be called prior to when callbacks are assigned
1840          * to the monitor. Also, extension monitors do not have callbacks
1841          * assigned to them, so we wouldn't want to segfault when we try
1842          * to destroy one of them.
1843          */
1844         ast_log_dynamic_level(cc_logger_level, "Core %d: Calling destructor for monitor %s\n",
1845                         monitor->core_id, monitor->interface->device_name);
1846         if (monitor->interface->monitor_class == AST_CC_EXTENSION_MONITOR) {
1847                 cc_extension_monitor_destructor(monitor->private_data);
1848         }
1849         if (monitor->callbacks) {
1850                 monitor->callbacks->destructor(monitor->private_data);
1851         }
1852         cc_unref(monitor->interface, "Unreffing tree's reference to interface");
1853         ast_free(monitor->dialstring);
1854 }
1855
1856 static void cc_interface_tree_destroy(void *data)
1857 {
1858         struct cc_monitor_tree *cc_interface_tree = data;
1859         struct ast_cc_monitor *monitor;
1860         while ((monitor = AST_LIST_REMOVE_HEAD(cc_interface_tree, next))) {
1861                 if (monitor->callbacks) {
1862                         monitor->callbacks->cancel_available_timer(monitor, &monitor->available_timer_id);
1863                 }
1864                 cc_unref(monitor, "Destroying all monitors");
1865         }
1866         AST_LIST_HEAD_DESTROY(cc_interface_tree);
1867 }
1868
1869 /*!
1870  * This counter is used for assigning unique ids
1871  * to CC-enabled dialed interfaces.
1872  */
1873 static int dialed_cc_interface_counter;
1874
1875 /*!
1876  * \internal
1877  * \brief data stored in CC datastore
1878  *
1879  * The datastore creates a list of interfaces that were
1880  * dialed, including both extensions and devices. In addition
1881  * to the intrinsic data of the tree, some extra information
1882  * is needed for use by app_dial.
1883  */
1884 struct dialed_cc_interfaces {
1885         /*!
1886          * This value serves a dual-purpose. When dial starts, if the
1887          * dialed_cc_interfaces datastore currently exists on the calling
1888          * channel, then the dial_parent_id will serve as a means of
1889          * letting the new extension cc_monitor we create know
1890          * who his parent is. This value will be the extension
1891          * cc_monitor that dialed the local channel that resulted
1892          * in the new Dial app being called.
1893          *
1894          * In addition, once an extension cc_monitor is created,
1895          * the dial_parent_id will be changed to the id of that newly
1896          * created interface. This way, device interfaces created from
1897          * receiving AST_CONTROL_CC frames can use this field to determine
1898          * who their parent extension interface should be.
1899          */
1900         unsigned int dial_parent_id;
1901         /*!
1902          * Identifier for the potential CC request that may be made
1903          * based on this call. Even though an instance of the core may
1904          * not be made (since the caller may not request CC), we allocate
1905          * a new core_id at the beginning of the call so that recipient
1906          * channel drivers can have the information handy just in case
1907          * the caller does end up requesting CC.
1908          */
1909         int core_id;
1910         /*!
1911          * When a new Dial application is started, and the datastore
1912          * already exists on the channel, we can determine if we
1913          * should be adding any new interface information to tree.
1914          */
1915         char ignore;
1916         /*!
1917          * When it comes time to offer CC to the caller, we only want to offer
1918          * it to the original incoming channel. For nested Dials and outbound
1919          * channels, it is incorrect to attempt such a thing. This flag indicates
1920          * if the channel to which this datastore is attached may be legally
1921          * offered CC when the call is finished.
1922          */
1923         char is_original_caller;
1924         /*!
1925          * Reference-counted "tree" of interfaces.
1926          */
1927         struct cc_monitor_tree *interface_tree;
1928 };
1929
1930 /*!
1931  * \internal
1932  * \brief Destructor function for cc_interfaces datastore
1933  *
1934  * This function will free the actual datastore and drop
1935  * the refcount for the monitor tree by one. In cases
1936  * where CC can actually be used, this unref will not
1937  * result in the destruction of the monitor tree, because
1938  * the CC core will still have a reference.
1939  *
1940  * \param data The dialed_cc_interfaces struct to destroy
1941  */
1942 static void dialed_cc_interfaces_destroy(void *data)
1943 {
1944         struct dialed_cc_interfaces *cc_interfaces = data;
1945         cc_unref(cc_interfaces->interface_tree, "Unref dial's ref to monitor tree");
1946         ast_free(cc_interfaces);
1947 }
1948
1949 /*!
1950  * \internal
1951  * \brief Duplicate callback for cc_interfaces datastore
1952  *
1953  * Integers are copied by value, but the monitor tree
1954  * is done via a shallow copy and a bump of the refcount.
1955  * This way, sub-Dials will be appending interfaces onto
1956  * the same list as this call to Dial.
1957  *
1958  * \param data The old dialed_cc_interfaces we want to copy
1959  * \retval NULL Could not allocate memory for new dialed_cc_interfaces
1960  * \retval non-NULL The new copy of the dialed_cc_interfaces
1961  */
1962 static void *dialed_cc_interfaces_duplicate(void *data)
1963 {
1964         struct dialed_cc_interfaces *old_cc_interfaces = data;
1965         struct dialed_cc_interfaces *new_cc_interfaces = ast_calloc(1, sizeof(*new_cc_interfaces));
1966         if (!new_cc_interfaces) {
1967                 return NULL;
1968         }
1969         new_cc_interfaces->ignore = old_cc_interfaces->ignore;
1970         new_cc_interfaces->dial_parent_id = old_cc_interfaces->dial_parent_id;
1971         new_cc_interfaces->is_original_caller = 0;
1972         cc_ref(old_cc_interfaces->interface_tree, "New ref due to duplication of monitor tree");
1973         new_cc_interfaces->core_id = old_cc_interfaces->core_id;
1974         new_cc_interfaces->interface_tree = old_cc_interfaces->interface_tree;
1975         return new_cc_interfaces;
1976 }
1977
1978 /*!
1979  * \internal
1980  * \brief information regarding the dialed_cc_interfaces datastore
1981  *
1982  * The dialed_cc_interfaces datastore is responsible for keeping track
1983  * of what CC-enabled interfaces have been dialed by the caller. For
1984  * more information regarding the actual structure of the tree, see
1985  * the documentation provided in include/asterisk/ccss.h
1986  */
1987 static const struct ast_datastore_info dialed_cc_interfaces_info = {
1988         .type = "Dial CC Interfaces",
1989         .duplicate = dialed_cc_interfaces_duplicate,
1990         .destroy = dialed_cc_interfaces_destroy,
1991 };
1992
1993 static struct extension_monitor_pvt *extension_monitor_pvt_init(void)
1994 {
1995         struct extension_monitor_pvt *ext_pvt = ast_calloc(1, sizeof(*ext_pvt));
1996         if (!ext_pvt) {
1997                 return NULL;
1998         }
1999         AST_LIST_HEAD_INIT_NOLOCK(&ext_pvt->child_dialstrings);
2000         return ext_pvt;
2001 }
2002
2003 void ast_cc_extension_monitor_add_dialstring(struct ast_channel *incoming, const char * const dialstring, const char * const device_name)
2004 {
2005         struct ast_datastore *cc_datastore;
2006         struct dialed_cc_interfaces *cc_interfaces;
2007         struct ast_cc_monitor *monitor;
2008         struct extension_monitor_pvt *extension_pvt;
2009         struct extension_child_dialstring *child_dialstring;
2010         struct cc_monitor_tree *interface_tree;
2011         int id;
2012
2013         ast_channel_lock(incoming);
2014         if (!(cc_datastore = ast_channel_datastore_find(incoming, &dialed_cc_interfaces_info, NULL))) {
2015                 ast_channel_unlock(incoming);
2016                 return;
2017         }
2018
2019         cc_interfaces = cc_datastore->data;
2020         interface_tree = cc_interfaces->interface_tree;
2021         id = cc_interfaces->dial_parent_id;
2022         ast_channel_unlock(incoming);
2023
2024         AST_LIST_LOCK(interface_tree);
2025         AST_LIST_TRAVERSE(interface_tree, monitor, next) {
2026                 if (monitor->id == id) {
2027                         break;
2028                 }
2029         }
2030
2031         if (!monitor) {
2032                 AST_LIST_UNLOCK(interface_tree);
2033                 return;
2034         }
2035
2036         extension_pvt = monitor->private_data;
2037         if (!(child_dialstring = ast_calloc(1, sizeof(*child_dialstring)))) {
2038                 AST_LIST_UNLOCK(interface_tree);
2039                 return;
2040         }
2041         ast_copy_string(child_dialstring->original_dialstring, dialstring, sizeof(child_dialstring->original_dialstring));
2042         ast_copy_string(child_dialstring->device_name, device_name, sizeof(child_dialstring->device_name));
2043         child_dialstring->is_valid = 1;
2044         AST_LIST_INSERT_TAIL(&extension_pvt->child_dialstrings, child_dialstring, next);
2045         AST_LIST_UNLOCK(interface_tree);
2046 }
2047
2048 static void cc_extension_monitor_change_is_valid(struct cc_core_instance *core_instance, unsigned int parent_id, const char * const device_name, int is_valid)
2049 {
2050         struct ast_cc_monitor *monitor_iter;
2051         struct extension_monitor_pvt *extension_pvt;
2052         struct extension_child_dialstring *child_dialstring;
2053
2054         AST_LIST_TRAVERSE(core_instance->monitors, monitor_iter, next) {
2055                 if (monitor_iter->id == parent_id) {
2056                         break;
2057                 }
2058         }
2059
2060         if (!monitor_iter) {
2061                 return;
2062         }
2063         extension_pvt = monitor_iter->private_data;
2064
2065         AST_LIST_TRAVERSE(&extension_pvt->child_dialstrings, child_dialstring, next) {
2066                 if (!strcmp(child_dialstring->device_name, device_name)) {
2067                         child_dialstring->is_valid = is_valid;
2068                         break;
2069                 }
2070         }
2071 }
2072
2073 /*!
2074  * \internal
2075  * \brief Allocate and initialize an "extension" interface for CC purposes
2076  *
2077  * When app_dial starts, this function is called in order to set up the
2078  * information about the extension in which this Dial is occurring. Any
2079  * devices dialed will have this particular cc_monitor as a parent.
2080  *
2081  * \param exten Extension from which Dial is occurring
2082  * \param context Context to which exten belongs
2083  * \param parent_id What should we set the parent_id of this interface to?
2084  * \retval NULL Memory allocation failure
2085  * \retval non-NULL The newly-created cc_monitor for the extension
2086  */
2087 static struct ast_cc_monitor *cc_extension_monitor_init(const char * const exten, const char * const context, const unsigned int parent_id)
2088 {
2089         struct ast_str *str = ast_str_alloca(2 * AST_MAX_EXTENSION);
2090         struct ast_cc_interface *cc_interface;
2091         struct ast_cc_monitor *monitor;
2092
2093         ast_str_set(&str, 0, "%s@%s", exten, context);
2094
2095         if (!(cc_interface = ao2_t_alloc(sizeof(*cc_interface) + ast_str_strlen(str), cc_interface_destroy,
2096                                         "Allocating new ast_cc_interface"))) {
2097                 return NULL;
2098         }
2099
2100         if (!(monitor = ao2_t_alloc(sizeof(*monitor), cc_monitor_destroy, "Allocating new ast_cc_monitor"))) {
2101                 cc_unref(cc_interface, "failed to allocate the monitor, so unref the interface");
2102                 return NULL;
2103         }
2104
2105         if (!(monitor->private_data = extension_monitor_pvt_init())) {
2106                 cc_unref(monitor, "Failed to initialize extension monitor private data. uref monitor");
2107                 cc_unref(cc_interface, "Failed to initialize extension monitor private data. unref cc_interface");
2108         }
2109
2110         monitor->id = ast_atomic_fetchadd_int(&dialed_cc_interface_counter, +1);
2111         monitor->parent_id = parent_id;
2112         cc_interface->monitor_type = "extension";
2113         cc_interface->monitor_class = AST_CC_EXTENSION_MONITOR;
2114         strcpy(cc_interface->device_name, ast_str_buffer(str));
2115         monitor->interface = cc_interface;
2116         ast_log_dynamic_level(cc_logger_level, "Created an extension cc interface for '%s' with id %u and parent %u\n", cc_interface->device_name, monitor->id, monitor->parent_id);
2117         return monitor;
2118 }
2119
2120 /*!
2121  * \internal
2122  * \brief allocate dialed_cc_interfaces datastore and initialize fields
2123  *
2124  * This function is called when Situation 1 occurs in ast_cc_call_init.
2125  * See that function for more information on what Situation 1 is.
2126  *
2127  * In this particular case, we have to do a lot of memory allocation in order
2128  * to create the datastore, the data for the datastore, the tree of interfaces
2129  * that we'll be adding to, and the initial extension interface for this Dial
2130  * attempt.
2131  *
2132  * \param chan The channel onto which the datastore should be added.
2133  * \retval -1 An error occurred
2134  * \retval 0 Success
2135  */
2136 static int cc_interfaces_datastore_init(struct ast_channel *chan) {
2137         struct dialed_cc_interfaces *interfaces;
2138         struct ast_cc_monitor *monitor;
2139         struct ast_datastore *dial_cc_datastore;
2140
2141         /*XXX This may be a bit controversial. In an attempt to not allocate
2142          * extra resources, I make sure that a future request will be within
2143          * limits. The problem here is that it is reasonable to think that
2144          * even if we're not within the limits at this point, we may be by
2145          * the time the requestor will have made his request. This may be
2146          * deleted at some point.
2147          */
2148         if (!ast_cc_request_is_within_limits()) {
2149                 return 0;
2150         }
2151
2152         if (!(interfaces = ast_calloc(1, sizeof(*interfaces)))) {
2153                 return -1;
2154         }
2155
2156         if (!(monitor = cc_extension_monitor_init(S_OR(ast_channel_macroexten(chan), ast_channel_exten(chan)), S_OR(ast_channel_macrocontext(chan), ast_channel_context(chan)), 0))) {
2157                 ast_free(interfaces);
2158                 return -1;
2159         }
2160
2161         if (!(dial_cc_datastore = ast_datastore_alloc(&dialed_cc_interfaces_info, NULL))) {
2162                 cc_unref(monitor, "Could not allocate the dialed interfaces datastore. Unreffing monitor");
2163                 ast_free(interfaces);
2164                 return -1;
2165         }
2166
2167         if (!(interfaces->interface_tree = ao2_t_alloc(sizeof(*interfaces->interface_tree), cc_interface_tree_destroy,
2168                                         "Allocate monitor tree"))) {
2169                 ast_datastore_free(dial_cc_datastore);
2170                 cc_unref(monitor, "Could not allocate monitor tree on dialed interfaces datastore. Unreffing monitor");
2171                 ast_free(interfaces);
2172                 return -1;
2173         }
2174
2175         /* Finally, all that allocation is done... */
2176         AST_LIST_HEAD_INIT(interfaces->interface_tree);
2177         AST_LIST_INSERT_TAIL(interfaces->interface_tree, monitor, next);
2178         cc_ref(monitor, "List's reference to extension monitor");
2179         dial_cc_datastore->data = interfaces;
2180         dial_cc_datastore->inheritance = DATASTORE_INHERIT_FOREVER;
2181         interfaces->dial_parent_id = monitor->id;
2182         interfaces->core_id = monitor->core_id = ast_atomic_fetchadd_int(&core_id_counter, +1);
2183         interfaces->is_original_caller = 1;
2184         ast_channel_lock(chan);
2185         ast_channel_datastore_add(chan, dial_cc_datastore);
2186         ast_channel_unlock(chan);
2187         cc_unref(monitor, "Unreffing allocation's reference");
2188         return 0;
2189 }
2190
2191 /*!
2192  * \internal
2193  * \brief  Call a monitor's destructor before the monitor has been allocated
2194  * \since 1.8
2195  *
2196  * \param monitor_type The type of monitor callbacks to use when calling the destructor
2197  * \param private_data Data allocated by a channel driver that must be freed
2198  *
2199  * \details
2200  * I'll admit, this is a bit evil.
2201  *
2202  * When a channel driver determines that it can offer a call completion service to
2203  * a caller, it is very likely that the channel driver will need to allocate some
2204  * data so that when the time comes to request CC, the channel driver will have the
2205  * necessary data at hand.
2206  *
2207  * The problem is that there are many places where failures may occur before the monitor
2208  * has been properly allocated and had its callbacks assigned to it. If one of these
2209  * failures should occur, then we still need to let the channel driver know that it
2210  * must destroy the data that it allocated.
2211  *
2212  * \return Nothing
2213  */
2214 static void call_destructor_with_no_monitor(const char * const monitor_type, void *private_data)
2215 {
2216         const struct ast_cc_monitor_callbacks *monitor_callbacks = find_monitor_callbacks(monitor_type);
2217
2218         if (!monitor_callbacks) {
2219                 return;
2220         }
2221
2222         monitor_callbacks->destructor(private_data);
2223 }
2224
2225 /*!
2226  * \internal
2227  * \brief Allocate and intitialize a device cc_monitor
2228  *
2229  * For all intents and purposes, this is the same as
2230  * cc_extension_monitor_init, except that there is only
2231  * a single parameter used for naming the interface.
2232  *
2233  * This function is called when handling AST_CONTROL_CC frames.
2234  * The device has reported that CC is possible, so we add it
2235  * to the interface_tree.
2236  *
2237  * Note that it is not necessarily erroneous to add the same
2238  * device to the tree twice. If the same device is called by
2239  * two different extension during the same call, then
2240  * that is a legitimate situation. Of course, I'm pretty sure
2241  * the dialed_interfaces global datastore will not allow that
2242  * to happen anyway.
2243  *
2244  * \param device_name The name of the device being added to the tree
2245  * \param dialstring The dialstring used to dial the device being added
2246  * \param parent_id The parent of this new tree node.
2247  * \retval NULL Memory allocation failure
2248  * \retval non-NULL The new ast_cc_interface created.
2249  */
2250 static struct ast_cc_monitor *cc_device_monitor_init(const char * const device_name, const char * const dialstring, const struct cc_control_payload *cc_data, int core_id)
2251 {
2252         struct ast_cc_interface *cc_interface;
2253         struct ast_cc_monitor *monitor;
2254         size_t device_name_len = strlen(device_name);
2255         int parent_id = cc_data->parent_interface_id;
2256
2257         if (!(cc_interface = ao2_t_alloc(sizeof(*cc_interface) + device_name_len, cc_interface_destroy,
2258                                         "Allocating new ast_cc_interface"))) {
2259                 return NULL;
2260         }
2261
2262         if (!(cc_interface->config_params = ast_cc_config_params_init())) {
2263                 cc_unref(cc_interface, "Failed to allocate config params, unref interface");
2264                 return NULL;
2265         }
2266
2267         if (!(monitor = ao2_t_alloc(sizeof(*monitor), cc_monitor_destroy, "Allocating new ast_cc_monitor"))) {
2268                 cc_unref(cc_interface, "Failed to allocate monitor, unref interface");
2269                 return NULL;
2270         }
2271
2272         if (!(monitor->dialstring = ast_strdup(dialstring))) {
2273                 cc_unref(monitor, "Failed to copy dialable name. Unref monitor");
2274                 cc_unref(cc_interface, "Failed to copy dialable name");
2275                 return NULL;
2276         }
2277
2278         if (!(monitor->callbacks = find_monitor_callbacks(cc_data->monitor_type))) {
2279                 cc_unref(monitor, "Failed to find monitor callbacks. Unref monitor");
2280                 cc_unref(cc_interface, "Failed to find monitor callbacks");
2281                 return NULL;
2282         }
2283
2284         strcpy(cc_interface->device_name, device_name);
2285         monitor->id = ast_atomic_fetchadd_int(&dialed_cc_interface_counter, +1);
2286         monitor->parent_id = parent_id;
2287         monitor->core_id = core_id;
2288         monitor->service_offered = cc_data->service;
2289         monitor->private_data = cc_data->private_data;
2290         cc_interface->monitor_type = cc_data->monitor_type;
2291         cc_interface->monitor_class = AST_CC_DEVICE_MONITOR;
2292         monitor->interface = cc_interface;
2293         monitor->available_timer_id = -1;
2294         ast_cc_copy_config_params(cc_interface->config_params, &cc_data->config_params);
2295         ast_log_dynamic_level(cc_logger_level, "Core %d: Created a device cc interface for '%s' with id %u and parent %u\n",
2296                         monitor->core_id, cc_interface->device_name, monitor->id, monitor->parent_id);
2297         return monitor;
2298 }
2299
2300 /*!
2301  * \details
2302  * Unless we are ignoring CC for some reason, we will always
2303  * call this function when we read an AST_CONTROL_CC frame
2304  * from an outbound channel.
2305  *
2306  * This function will call cc_device_monitor_init to
2307  * create the new cc_monitor for the device from which
2308  * we read the frame. In addition, the new device will be added
2309  * to the monitor tree on the dialed_cc_interfaces datastore
2310  * on the inbound channel.
2311  *
2312  * If this is the first AST_CONTROL_CC frame that we have handled
2313  * for this call, then we will also initialize the CC core for
2314  * this call.
2315  */
2316 void ast_handle_cc_control_frame(struct ast_channel *inbound, struct ast_channel *outbound, void *frame_data)
2317 {
2318         char *device_name;
2319         char *dialstring;
2320         struct ast_cc_monitor *monitor;
2321         struct ast_datastore *cc_datastore;
2322         struct dialed_cc_interfaces *cc_interfaces;
2323         struct cc_control_payload *cc_data = frame_data;
2324         struct cc_core_instance *core_instance;
2325
2326         device_name = cc_data->device_name;
2327         dialstring = cc_data->dialstring;
2328
2329         ast_channel_lock(inbound);
2330         if (!(cc_datastore = ast_channel_datastore_find(inbound, &dialed_cc_interfaces_info, NULL))) {
2331                 ast_log(LOG_WARNING, "Unable to retrieve CC datastore while processing CC frame from '%s'. CC services will be unavailable.\n", device_name);
2332                 ast_channel_unlock(inbound);
2333                 call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
2334                 return;
2335         }
2336
2337         cc_interfaces = cc_datastore->data;
2338
2339         if (cc_interfaces->ignore) {
2340                 ast_channel_unlock(inbound);
2341                 call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
2342                 return;
2343         }
2344
2345         if (!cc_interfaces->is_original_caller) {
2346                 /* If the is_original_caller is not set on the *inbound* channel, then
2347                  * it must be a local channel. As such, we do not want to create a core instance
2348                  * or an agent for the local channel. Instead, we want to pass this along to the
2349                  * other side of the local channel so that the original caller can benefit.
2350                  */
2351                 ast_channel_unlock(inbound);
2352                 ast_indicate_data(inbound, AST_CONTROL_CC, cc_data, sizeof(*cc_data));
2353                 return;
2354         }
2355
2356         core_instance = find_cc_core_instance(cc_interfaces->core_id);
2357         if (!core_instance) {
2358                 core_instance = cc_core_init_instance(inbound, cc_interfaces->interface_tree,
2359                         cc_interfaces->core_id, cc_data);
2360                 if (!core_instance) {
2361                         cc_interfaces->ignore = 1;
2362                         ast_channel_unlock(inbound);
2363                         call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
2364                         return;
2365                 }
2366         }
2367
2368         ast_channel_unlock(inbound);
2369
2370         /* Yeah this kind of sucks, but luckily most people
2371          * aren't dialing thousands of interfaces on every call
2372          *
2373          * This traversal helps us to not create duplicate monitors in
2374          * case a device queues multiple CC control frames.
2375          */
2376         AST_LIST_LOCK(cc_interfaces->interface_tree);
2377         AST_LIST_TRAVERSE(cc_interfaces->interface_tree, monitor, next) {
2378                 if (!strcmp(monitor->interface->device_name, device_name)) {
2379                         ast_log_dynamic_level(cc_logger_level, "Core %d: Device %s sent us multiple CC control frames. Ignoring those beyond the first.\n",
2380                                         core_instance->core_id, device_name);
2381                         AST_LIST_UNLOCK(cc_interfaces->interface_tree);
2382                         cc_unref(core_instance, "Returning early from ast_handle_cc_control_frame. Unref core_instance");
2383                         call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
2384                         return;
2385                 }
2386         }
2387         AST_LIST_UNLOCK(cc_interfaces->interface_tree);
2388
2389         if (!(monitor = cc_device_monitor_init(device_name, dialstring, cc_data, core_instance->core_id))) {
2390                 ast_log(LOG_WARNING, "Unable to create CC device interface for '%s'. CC services will be unavailable on this interface.\n", device_name);
2391                 cc_unref(core_instance, "Returning early from ast_handle_cc_control_frame. Unref core_instance");
2392                 call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
2393                 return;
2394         }
2395
2396         AST_LIST_LOCK(cc_interfaces->interface_tree);
2397         cc_ref(monitor, "monitor tree's reference to the monitor");
2398         AST_LIST_INSERT_TAIL(cc_interfaces->interface_tree, monitor, next);
2399         AST_LIST_UNLOCK(cc_interfaces->interface_tree);
2400
2401         cc_extension_monitor_change_is_valid(core_instance, monitor->parent_id, monitor->interface->device_name, 0);
2402
2403         cc_publish_available(cc_interfaces->core_id, device_name, cc_service_to_string(cc_data->service));
2404
2405         cc_unref(core_instance, "Done with core_instance after handling CC control frame");
2406         cc_unref(monitor, "Unref reference from allocating monitor");
2407 }
2408
2409 int ast_cc_call_init(struct ast_channel *chan, int *ignore_cc)
2410 {
2411         /* There are three situations to deal with here:
2412          *
2413          * 1. The channel does not have a dialed_cc_interfaces datastore on
2414          * it. This means that this is the first time that Dial has
2415          * been called. We need to create/initialize the datastore.
2416          *
2417          * 2. The channel does have a cc_interface datastore on it and
2418          * the "ignore" indicator is 0. This means that a Local channel
2419          * was called by a "parent" dial. We can check the datastore's
2420          * parent field to see who the root of this particular dial tree
2421          * is.
2422          *
2423          * 3. The channel does have a cc_interface datastore on it and
2424          * the "ignore" indicator is 1. This means that a second Dial call
2425          * is being made from an extension. In this case, we do not
2426          * want to make any additions/modifications to the datastore. We
2427          * will instead set a flag to indicate that CCSS is completely
2428          * disabled for this Dial attempt.
2429          */
2430
2431         struct ast_datastore *cc_interfaces_datastore;
2432         struct dialed_cc_interfaces *interfaces;
2433         struct ast_cc_monitor *monitor;
2434         struct ast_cc_config_params *cc_params;
2435
2436         ast_channel_lock(chan);
2437
2438         cc_params = ast_channel_get_cc_config_params(chan);
2439         if (!cc_params) {
2440                 ast_channel_unlock(chan);
2441                 return -1;
2442         }
2443         if (ast_get_cc_agent_policy(cc_params) == AST_CC_AGENT_NEVER) {
2444                 /* We can't offer CC to this caller anyway, so don't bother with CC on this call
2445                  */
2446                 *ignore_cc = 1;
2447                 ast_channel_unlock(chan);
2448                 ast_log_dynamic_level(cc_logger_level, "Agent policy for %s is 'never'. CC not possible\n", ast_channel_name(chan));
2449                 return 0;
2450         }
2451
2452         if (!(cc_interfaces_datastore = ast_channel_datastore_find(chan, &dialed_cc_interfaces_info, NULL))) {
2453                 /* Situation 1 has occurred */
2454                 ast_channel_unlock(chan);
2455                 return cc_interfaces_datastore_init(chan);
2456         }
2457         interfaces = cc_interfaces_datastore->data;
2458         ast_channel_unlock(chan);
2459
2460         if (interfaces->ignore) {
2461                 /* Situation 3 has occurred */
2462                 *ignore_cc = 1;
2463                 ast_log_dynamic_level(cc_logger_level, "Datastore is present with ignore flag set. Ignoring CC offers on this call\n");
2464                 return 0;
2465         }
2466
2467         /* Situation 2 has occurred */
2468         if (!(monitor = cc_extension_monitor_init(S_OR(ast_channel_macroexten(chan), ast_channel_exten(chan)),
2469                         S_OR(ast_channel_macrocontext(chan), ast_channel_context(chan)), interfaces->dial_parent_id))) {
2470                 return -1;
2471         }
2472         monitor->core_id = interfaces->core_id;
2473         AST_LIST_LOCK(interfaces->interface_tree);
2474         cc_ref(monitor, "monitor tree's reference to the monitor");
2475         AST_LIST_INSERT_TAIL(interfaces->interface_tree, monitor, next);
2476         AST_LIST_UNLOCK(interfaces->interface_tree);
2477         interfaces->dial_parent_id = monitor->id;
2478         cc_unref(monitor, "Unref monitor's allocation reference");
2479         return 0;
2480 }
2481
2482 int ast_cc_request_is_within_limits(void)
2483 {
2484         return cc_request_count < global_cc_max_requests;
2485 }
2486
2487 int ast_cc_get_current_core_id(struct ast_channel *chan)
2488 {
2489         struct ast_datastore *datastore;
2490         struct dialed_cc_interfaces *cc_interfaces;
2491         int core_id_return;
2492
2493         ast_channel_lock(chan);
2494         if (!(datastore = ast_channel_datastore_find(chan, &dialed_cc_interfaces_info, NULL))) {
2495                 ast_channel_unlock(chan);
2496                 return -1;
2497         }
2498
2499         cc_interfaces = datastore->data;
2500         core_id_return = cc_interfaces->ignore ? -1 : cc_interfaces->core_id;
2501         ast_channel_unlock(chan);
2502         return core_id_return;
2503
2504 }
2505
2506 static long count_agents(const char * const caller, const int core_id_exception)
2507 {
2508         struct count_agents_cb_data data = {.core_id_exception = core_id_exception,};
2509
2510         ao2_t_callback_data(cc_core_instances, OBJ_NODATA, count_agents_cb, (char *)caller, &data, "Counting agents");
2511         ast_log_dynamic_level(cc_logger_level, "Counted %d agents\n", data.count);
2512         return data.count;
2513 }
2514
2515 static void kill_duplicate_offers(char *caller)
2516 {
2517         unsigned long match_flags = MATCH_NO_REQUEST;
2518         struct ao2_iterator *dups_iter;
2519
2520         /*
2521          * Must remove the ref that was in cc_core_instances outside of
2522          * the container lock to prevent deadlock.
2523          */
2524         dups_iter = ao2_t_callback_data(cc_core_instances, OBJ_MULTIPLE | OBJ_UNLINK,
2525                 match_agent, caller, &match_flags, "Killing duplicate offers");
2526         if (dups_iter) {
2527                 /* Now actually unref any duplicate offers by simply destroying the iterator. */
2528                 ao2_iterator_destroy(dups_iter);
2529         }
2530 }
2531
2532 static void check_callback_sanity(const struct ast_cc_agent_callbacks *callbacks)
2533 {
2534         ast_assert(callbacks->init != NULL);
2535         ast_assert(callbacks->start_offer_timer != NULL);
2536         ast_assert(callbacks->stop_offer_timer != NULL);
2537         ast_assert(callbacks->respond != NULL);
2538         ast_assert(callbacks->status_request != NULL);
2539         ast_assert(callbacks->start_monitoring != NULL);
2540         ast_assert(callbacks->callee_available != NULL);
2541         ast_assert(callbacks->destructor != NULL);
2542 }
2543
2544 static void agent_destroy(void *data)
2545 {
2546         struct ast_cc_agent *agent = data;
2547
2548         if (agent->callbacks) {
2549                 agent->callbacks->destructor(agent);
2550         }
2551         ast_cc_config_params_destroy(agent->cc_params);
2552 }
2553
2554 static struct ast_cc_agent *cc_agent_init(struct ast_channel *caller_chan,
2555                 const char * const caller_name, const int core_id,
2556                 struct cc_monitor_tree *interface_tree)
2557 {
2558         struct ast_cc_agent *agent;
2559         struct ast_cc_config_params *cc_params;
2560
2561         if (!(agent = ao2_t_alloc(sizeof(*agent) + strlen(caller_name), agent_destroy,
2562                                         "Allocating new ast_cc_agent"))) {
2563                 return NULL;
2564         }
2565
2566         agent->core_id = core_id;
2567         strcpy(agent->device_name, caller_name);
2568
2569         cc_params = ast_channel_get_cc_config_params(caller_chan);
2570         if (!cc_params) {
2571                 cc_unref(agent, "Could not get channel config params.");
2572                 return NULL;
2573         }
2574         if (!(agent->cc_params = ast_cc_config_params_init())) {
2575                 cc_unref(agent, "Could not init agent config params.");
2576                 return NULL;
2577         }
2578         ast_cc_copy_config_params(agent->cc_params, cc_params);
2579
2580         if (!(agent->callbacks = find_agent_callbacks(caller_chan))) {
2581                 cc_unref(agent, "Could not find agent callbacks.");
2582                 return NULL;
2583         }
2584         check_callback_sanity(agent->callbacks);
2585
2586         if (agent->callbacks->init(agent, caller_chan)) {
2587                 cc_unref(agent, "Agent init callback failed.");
2588                 return NULL;
2589         }
2590         ast_log_dynamic_level(cc_logger_level, "Core %u: Created an agent for caller %s\n",
2591                         agent->core_id, agent->device_name);
2592         return agent;
2593 }
2594
2595 /* Generic agent callbacks */
2596 static int cc_generic_agent_init(struct ast_cc_agent *agent, struct ast_channel *chan);
2597 static int cc_generic_agent_start_offer_timer(struct ast_cc_agent *agent);
2598 static int cc_generic_agent_stop_offer_timer(struct ast_cc_agent *agent);
2599 static void cc_generic_agent_respond(struct ast_cc_agent *agent, enum ast_cc_agent_response_reason reason);
2600 static int cc_generic_agent_status_request(struct ast_cc_agent *agent);
2601 static int cc_generic_agent_stop_ringing(struct ast_cc_agent *agent);
2602 static int cc_generic_agent_start_monitoring(struct ast_cc_agent *agent);
2603 static int cc_generic_agent_recall(struct ast_cc_agent *agent);
2604 static void cc_generic_agent_destructor(struct ast_cc_agent *agent);
2605
2606 static struct ast_cc_agent_callbacks generic_agent_callbacks = {
2607         .type = "generic",
2608         .init = cc_generic_agent_init,
2609         .start_offer_timer = cc_generic_agent_start_offer_timer,
2610         .stop_offer_timer = cc_generic_agent_stop_offer_timer,
2611         .respond = cc_generic_agent_respond,
2612         .status_request = cc_generic_agent_status_request,
2613         .stop_ringing = cc_generic_agent_stop_ringing,
2614         .start_monitoring = cc_generic_agent_start_monitoring,
2615         .callee_available = cc_generic_agent_recall,
2616         .destructor = cc_generic_agent_destructor,
2617 };
2618
2619 struct cc_generic_agent_pvt {
2620         /*!
2621          * Subscription to device state
2622          *
2623          * Used in the CC_CALLER_BUSY state. The
2624          * generic agent will subscribe to the
2625          * device state of the caller in order to
2626          * determine when we may move on
2627          */
2628         struct stasis_subscription *sub;
2629         /*!
2630          * Scheduler id of offer timer.
2631          */
2632         int offer_timer_id;
2633         /*!
2634          * Caller ID number
2635          *
2636          * When we re-call the caller, we need
2637          * to provide this information to
2638          * ast_request_and_dial so that the
2639          * information will be present in the
2640          * call to the callee
2641          */
2642         char cid_num[AST_CHANNEL_NAME];
2643         /*!
2644          * Caller ID name
2645          *
2646          * See the description of cid_num.
2647          * The same applies here, except this
2648          * is the caller's name.
2649          */
2650         char cid_name[AST_CHANNEL_NAME];
2651         /*!
2652          * Extension dialed
2653          *
2654          * The original extension dialed. This is used
2655          * so that when performing a recall, we can
2656          * call the proper extension.
2657          */
2658         char exten[AST_CHANNEL_NAME];
2659         /*!
2660          * Context dialed
2661          *
2662          * The original context dialed. This is used
2663          * so that when performaing a recall, we can
2664          * call into the proper context
2665          */
2666         char context[AST_CHANNEL_NAME];
2667 };
2668
2669 static int cc_generic_agent_init(struct ast_cc_agent *agent, struct ast_channel *chan)
2670 {
2671         struct cc_generic_agent_pvt *generic_pvt = ast_calloc(1, sizeof(*generic_pvt));
2672
2673         if (!generic_pvt) {
2674                 return -1;
2675         }
2676
2677         generic_pvt->offer_timer_id = -1;
2678         if (ast_channel_caller(chan)->id.number.valid && ast_channel_caller(chan)->id.number.str) {
2679                 ast_copy_string(generic_pvt->cid_num, ast_channel_caller(chan)->id.number.str, sizeof(generic_pvt->cid_num));
2680         }
2681         if (ast_channel_caller(chan)->id.name.valid && ast_channel_caller(chan)->id.name.str) {
2682                 ast_copy_string(generic_pvt->cid_name, ast_channel_caller(chan)->id.name.str, sizeof(generic_pvt->cid_name));
2683         }
2684         ast_copy_string(generic_pvt->exten, S_OR(ast_channel_macroexten(chan), ast_channel_exten(chan)), sizeof(generic_pvt->exten));
2685         ast_copy_string(generic_pvt->context, S_OR(ast_channel_macrocontext(chan), ast_channel_context(chan)), sizeof(generic_pvt->context));
2686         agent->private_data = generic_pvt;
2687         ast_set_flag(agent, AST_CC_AGENT_SKIP_OFFER);
2688         return 0;
2689 }
2690
2691 static int offer_timer_expire(const void *data)
2692 {
2693         struct ast_cc_agent *agent = (struct ast_cc_agent *) data;
2694         struct cc_generic_agent_pvt *agent_pvt = agent->private_data;
2695         ast_log_dynamic_level(cc_logger_level, "Core %u: Queuing change request because offer timer has expired.\n",
2696                         agent->core_id);
2697         agent_pvt->offer_timer_id = -1;
2698         ast_cc_failed(agent->core_id, "Generic agent %s offer timer expired", agent->device_name);
2699         cc_unref(agent, "Remove scheduler's reference to the agent");
2700         return 0;
2701 }
2702
2703 static int cc_generic_agent_start_offer_timer(struct ast_cc_agent *agent)
2704 {
2705         int when;
2706         int sched_id;
2707         struct cc_generic_agent_pvt *generic_pvt = agent->private_data;
2708
2709         ast_assert(cc_sched_context != NULL);
2710         ast_assert(agent->cc_params != NULL);
2711
2712         when = ast_get_cc_offer_timer(agent->cc_params) * 1000;
2713         ast_log_dynamic_level(cc_logger_level, "Core %u: About to schedule offer timer expiration for %d ms\n",
2714                         agent->core_id, when);
2715         if ((sched_id = ast_sched_add(cc_sched_context, when, offer_timer_expire, cc_ref(agent, "Give scheduler an agent ref"))) == -1) {
2716                 return -1;
2717         }
2718         generic_pvt->offer_timer_id = sched_id;
2719         return 0;
2720 }
2721
2722 static int cc_generic_agent_stop_offer_timer(struct ast_cc_agent *agent)
2723 {
2724         struct cc_generic_agent_pvt *generic_pvt = agent->private_data;
2725
2726         if (generic_pvt->offer_timer_id != -1) {
2727                 if (!ast_sched_del(cc_sched_context, generic_pvt->offer_timer_id)) {
2728                         cc_unref(agent, "Remove scheduler's reference to the agent");
2729                 }
2730                 generic_pvt->offer_timer_id = -1;
2731         }
2732         return 0;
2733 }
2734
2735 static void cc_generic_agent_respond(struct ast_cc_agent *agent, enum ast_cc_agent_response_reason reason)
2736 {
2737         /* The generic agent doesn't have to do anything special to
2738          * acknowledge a CC request. Just return.
2739          */
2740         return;
2741 }
2742
2743 static int cc_generic_agent_status_request(struct ast_cc_agent *agent)
2744 {
2745         ast_cc_agent_status_response(agent->core_id, ast_device_state(agent->device_name));
2746         return 0;
2747 }
2748
2749 static int cc_generic_agent_stop_ringing(struct ast_cc_agent *agent)
2750 {
2751         struct ast_channel *recall_chan = ast_channel_get_by_name_prefix(agent->device_name, strlen(agent->device_name));
2752
2753         if (!recall_chan) {
2754                 return 0;
2755         }
2756
2757         ast_softhangup(recall_chan, AST_SOFTHANGUP_EXPLICIT);
2758         return 0;
2759 }
2760
2761 static void generic_agent_devstate_cb(void *userdata, struct stasis_subscription *sub, struct stasis_message *msg)
2762 {
2763         struct ast_cc_agent *agent = userdata;
2764         enum ast_device_state new_state;
2765         struct ast_device_state_message *dev_state;
2766         struct cc_generic_agent_pvt *generic_pvt = agent->private_data;
2767
2768         if (stasis_subscription_final_message(sub, msg)) {
2769                 cc_unref(agent, "Done holding ref for subscription");
2770                 return;
2771         } else if (ast_device_state_message_type() != stasis_message_type(msg)) {
2772                 return;
2773         }
2774
2775         dev_state = stasis_message_data(msg);
2776         if (dev_state->eid) {
2777                 /* ignore non-aggregate states */
2778                 return;
2779         }
2780
2781         new_state = dev_state->state;
2782         if (!cc_generic_is_device_available(new_state)) {
2783                 /* Not interested in this new state of the device.  It is still busy. */
2784                 return;
2785         }
2786
2787         generic_pvt->sub = stasis_unsubscribe(sub);
2788         ast_cc_agent_caller_available(agent->core_id, "%s is no longer busy", agent->device_name);
2789 }
2790
2791 static int cc_generic_agent_start_monitoring(struct ast_cc_agent *agent)
2792 {
2793         struct cc_generic_agent_pvt *generic_pvt = agent->private_data;
2794         struct ast_str *str = ast_str_alloca(128);
2795         struct stasis_topic *device_specific_topic;
2796
2797         ast_assert(generic_pvt->sub == NULL);
2798         ast_str_set(&str, 0, "Agent monitoring %s device state since it is busy\n",
2799                 agent->device_name);
2800
2801         device_specific_topic = ast_device_state_topic(agent->device_name);
2802         if (!device_specific_topic) {
2803                 return -1;
2804         }
2805
2806         if (!(generic_pvt->sub = stasis_subscribe(device_specific_topic, generic_agent_devstate_cb, agent))) {
2807                 return -1;
2808         }
2809         cc_ref(agent, "Ref agent for subscription");
2810         return 0;
2811 }
2812
2813 static void *generic_recall(void *data)
2814 {
2815         struct ast_cc_agent *agent = data;
2816         struct cc_generic_agent_pvt *generic_pvt = agent->private_data;
2817         const char *interface = S_OR(ast_get_cc_agent_dialstring(agent->cc_params), ast_strdupa(agent->device_name));
2818         const char *tech;
2819         char *target;
2820         int reason;
2821         struct ast_channel *chan;
2822         const char *callback_macro = ast_get_cc_callback_macro(agent->cc_params);
2823         const char *callback_sub = ast_get_cc_callback_sub(agent->cc_params);
2824         unsigned int recall_timer = ast_get_cc_recall_timer(agent->cc_params) * 1000;
2825         struct ast_format_cap *tmp_cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
2826
2827         if (!tmp_cap) {
2828                 return NULL;
2829         }
2830
2831         tech = interface;
2832         if ((target = strchr(interface, '/'))) {
2833                 *target++ = '\0';
2834         }
2835
2836         ast_format_cap_append(tmp_cap, ast_format_slin, 0);
2837         if (!(chan = ast_request_and_dial(tech, tmp_cap, NULL, NULL, target, recall_timer, &reason, generic_pvt->cid_num, generic_pvt->cid_name))) {
2838                 /* Hmm, no channel. Sucks for you, bud.
2839                  */
2840                 ast_log_dynamic_level(cc_logger_level, "Core %u: Failed to call back %s for reason %d\n",
2841                                 agent->core_id, agent->device_name, reason);
2842                 ast_cc_failed(agent->core_id, "Failed to call back device %s/%s", tech, target);
2843                 ao2_ref(tmp_cap, -1);
2844                 return NULL;
2845         }
2846         ao2_ref(tmp_cap, -1);
2847         
2848         /* We have a channel. It's time now to set up the datastore of recalled CC interfaces.
2849          * This will be a common task for all recall functions. If it were possible, I'd have
2850          * the core do it automatically, but alas I cannot. Instead, I will provide a public
2851          * function to do so.
2852          */
2853         ast_setup_cc_recall_datastore(chan, agent->core_id);
2854         ast_cc_agent_set_interfaces_chanvar(chan);
2855
2856         ast_channel_exten_set(chan, generic_pvt->exten);
2857         ast_channel_context_set(chan, generic_pvt->context);
2858         ast_channel_priority_set(chan, 1);
2859
2860         pbx_builtin_setvar_helper(chan, "CC_EXTEN", generic_pvt->exten);
2861         pbx_builtin_setvar_helper(chan, "CC_CONTEXT", generic_pvt->context);
2862
2863         if (!ast_strlen_zero(callback_macro)) {
2864                 ast_log_dynamic_level(cc_logger_level, "Core %u: There's a callback macro configured for agent %s\n",
2865                                 agent->core_id, agent->device_name);
2866                 if (ast_app_exec_macro(NULL, chan, callback_macro)) {
2867                         ast_cc_failed(agent->core_id, "Callback macro to %s failed. Maybe a hangup?", agent->device_name);
2868                         ast_hangup(chan);
2869                         return NULL;
2870                 }
2871         }
2872
2873         if (!ast_strlen_zero(callback_sub)) {
2874                 ast_log_dynamic_level(cc_logger_level, "Core %u: There's a callback subroutine configured for agent %s\n",
2875                                 agent->core_id, agent->device_name);
2876                 if (ast_app_exec_sub(NULL, chan, callback_sub, 0)) {
2877                         ast_cc_failed(agent->core_id, "Callback subroutine to %s failed. Maybe a hangup?", agent->device_name);
2878                         ast_hangup(chan);
2879                         return NULL;
2880                 }
2881         }
2882         if (ast_pbx_start(chan)) {
2883                 ast_cc_failed(agent->core_id, "PBX failed to start for %s.", agent->device_name);
2884                 ast_hangup(chan);
2885                 return NULL;
2886         }
2887         ast_cc_agent_recalling(agent->core_id, "Generic agent %s is recalling",
2888                 agent->device_name);
2889         return NULL;
2890 }
2891
2892 static int cc_generic_agent_recall(struct ast_cc_agent *agent)
2893 {
2894         pthread_t clotho;
2895         enum ast_device_state current_state = ast_device_state(agent->device_name);
2896
2897         if (!cc_generic_is_device_available(current_state)) {
2898                 /* We can't try to contact the device right now because he's not available
2899                  * Let the core know he's busy.
2900                  */
2901                 ast_cc_agent_caller_busy(agent->core_id, "Generic agent caller %s is busy", agent->device_name);
2902                 return 0;
2903         }
2904         ast_pthread_create_detached_background(&clotho, NULL, generic_recall, agent);
2905         return 0;
2906 }
2907
2908 static void cc_generic_agent_destructor(struct ast_cc_agent *agent)
2909 {
2910         struct cc_generic_agent_pvt *agent_pvt = agent->private_data;
2911
2912         if (!agent_pvt) {
2913                 /* The agent constructor probably failed. */
2914                 return;
2915         }
2916
2917         cc_generic_agent_stop_offer_timer(agent);
2918         if (agent_pvt->sub) {
2919                 agent_pvt->sub = stasis_unsubscribe(agent_pvt->sub);
2920         }
2921
2922         ast_free(agent_pvt);
2923 }
2924
2925 static void cc_core_instance_destructor(void *data)
2926 {
2927         struct cc_core_instance *core_instance = data;
2928         ast_log_dynamic_level(cc_logger_level, "Core %d: Destroying core instance\n", core_instance->core_id);
2929         if (core_instance->agent) {
2930                 cc_unref(core_instance->agent, "Core instance is done with the agent now");
2931         }
2932         if (core_instance->monitors) {
2933                 core_instance->monitors = cc_unref(core_instance->monitors, "Core instance is done with interface list");
2934         }
2935 }
2936
2937 static struct cc_core_instance *cc_core_init_instance(struct ast_channel *caller_chan,
2938                 struct cc_monitor_tree *called_tree, const int core_id, struct cc_control_payload *cc_data)
2939 {
2940         char caller[AST_CHANNEL_NAME];
2941         struct cc_core_instance *core_instance;
2942         struct ast_cc_config_params *cc_params;
2943         long agent_count;
2944         int recall_core_id;
2945
2946         ast_channel_get_device_name(caller_chan, caller, sizeof(caller));
2947         cc_params = ast_channel_get_cc_config_params(caller_chan);
2948         if (!cc_params) {
2949                 ast_log_dynamic_level(cc_logger_level, "Could not get CC parameters for %s\n",
2950                         caller);
2951                 return NULL;
2952         }
2953         /* First, we need to kill off other pending CC offers from caller. If the caller is going
2954          * to request a CC service, it may only be for the latest call he made.
2955          */
2956         if (ast_get_cc_agent_policy(cc_params) == AST_CC_AGENT_GENERIC) {
2957                 kill_duplicate_offers(caller);
2958         }
2959
2960         ast_cc_is_recall(caller_chan, &recall_core_id, NULL);
2961         agent_count = count_agents(caller, recall_core_id);
2962         if (agent_count >= ast_get_cc_max_agents(cc_params)) {
2963                 ast_log_dynamic_level(cc_logger_level, "Caller %s already has the maximum number of agents configured\n", caller);
2964                 return NULL;
2965         }
2966
2967         /* Generic agents can only have a single outstanding CC request per caller. */
2968         if (agent_count > 0 && ast_get_cc_agent_policy(cc_params) == AST_CC_AGENT_GENERIC) {
2969                 ast_log_dynamic_level(cc_logger_level, "Generic agents can only have a single outstanding request\n");
2970                 return NULL;
2971         }
2972
2973         /* Next, we need to create the core instance for this call */
2974         if (!(core_instance = ao2_t_alloc(sizeof(*core_instance), cc_core_instance_destructor, "Creating core instance for CC"))) {
2975                 return NULL;
2976         }
2977
2978         core_instance->core_id = core_id;
2979         if (!(core_instance->agent = cc_agent_init(caller_chan, caller, core_instance->core_id, called_tree))) {
2980                 cc_unref(core_instance, "Couldn't allocate agent, unref core_instance");
2981                 return NULL;
2982         }
2983
2984         core_instance->monitors = cc_ref(called_tree, "Core instance getting ref to monitor tree");
2985
2986         ao2_t_link(cc_core_instances, core_instance, "Link core instance into container");
2987
2988         return core_instance;
2989 }
2990
2991 struct cc_state_change_args {
2992         struct cc_core_instance *core_instance;/*!< Holds reference to core instance. */
2993         enum cc_state state;
2994         int core_id;
2995         char debug[1];
2996 };
2997
2998 static int is_state_change_valid(enum cc_state current_state, const enum cc_state new_state, struct ast_cc_agent *agent)
2999 {
3000         int is_valid = 0;
3001         switch (new_state) {
3002         case CC_AVAILABLE:
3003                 ast_log_dynamic_level(cc_logger_level, "Core %u: Asked to change to state %u? That should never happen.\n",
3004                                 agent->core_id, new_state);
3005                 break;
3006         case CC_CALLER_OFFERED:
3007                 if (current_state == CC_AVAILABLE) {
3008                         is_valid = 1;
3009                 }
3010                 break;
3011         case CC_CALLER_REQUESTED:
3012                 if (current_state == CC_CALLER_OFFERED ||
3013                                 (current_state == CC_AVAILABLE && ast_test_flag(agent, AST_CC_AGENT_SKIP_OFFER))) {
3014                         is_valid = 1;
3015                 }
3016                 break;
3017         case CC_ACTIVE:
3018                 if (current_state == CC_CALLER_REQUESTED || current_state == CC_CALLER_BUSY) {
3019                         is_valid = 1;
3020                 }
3021                 break;
3022         case CC_CALLEE_READY:
3023                 if (current_state == CC_ACTIVE) {
3024                         is_valid = 1;
3025                 }
3026                 break;
3027         case CC_CALLER_BUSY:
3028                 if (current_state == CC_CALLEE_READY) {
3029                         is_valid = 1;
3030                 }
3031                 break;
3032         case CC_RECALLING:
3033                 if (current_state == CC_CALLEE_READY) {
3034                         is_valid = 1;
3035                 }
3036                 break;
3037         case CC_COMPLETE:
3038                 if (current_state == CC_RECALLING) {
3039                         is_valid = 1;
3040                 }
3041                 break;
3042         case CC_FAILED:
3043                 is_valid = 1;
3044                 break;
3045         default:
3046                 ast_log_dynamic_level(cc_logger_level, "Core %u: Asked to change to unknown state %u\n",
3047                                 agent->core_id, new_state);
3048                 break;
3049         }
3050
3051         return is_valid;
3052 }
3053
3054 static int cc_available(struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
3055 {
3056         /* This should never happen... */
3057         ast_log(LOG_WARNING, "Someone requested to change to CC_AVAILABLE? Ignoring.\n");
3058         return -1;
3059 }
3060
3061 static int cc_caller_offered(struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
3062 {
3063         if (core_instance->agent->callbacks->start_offer_timer(core_instance->agent)) {
3064                 ast_cc_failed(core_instance->core_id, "Failed to start the offer timer for %s\n",
3065                                 core_instance->agent->device_name);
3066                 return -1;
3067         }
3068         cc_publish_offertimerstart(core_instance->core_id, core_instance->agent->device_name, core_instance->agent->cc_params->cc_offer_timer);
3069         ast_log_dynamic_level(cc_logger_level, "Core %d: Started the offer timer for the agent %s!\n",
3070                         core_instance->core_id, core_instance->agent->device_name);
3071         return 0;
3072 }
3073
3074 /*!
3075  * \brief check if the core instance has any device monitors
3076  *
3077  * In any case where we end up removing a device monitor from the
3078  * list of device monitors, it is important to see what the state
3079  * of the list is afterwards. If we find that we only have extension
3080  * monitors left, then no devices are actually being monitored.
3081  * In such a case, we need to declare that CC has failed for this
3082  * call. This function helps those cases to determine if they should
3083  * declare failure.
3084  *
3085  * \param core_instance The core instance we are checking for the existence
3086  * of device monitors
3087  * \retval 0 No device monitors exist on this core_instance
3088  * \retval 1 There is still at least 1 device monitor remaining
3089  */
3090 static int has_device_monitors(struct cc_core_instance *core_instance)
3091 {
3092         struct ast_cc_monitor *iter;
3093         int res = 0;
3094
3095         AST_LIST_TRAVERSE(core_instance->monitors, iter, next) {
3096                 if (iter->interface->monitor_class == AST_CC_DEVICE_MONITOR) {
3097                         res = 1;
3098                         break;
3099                 }
3100         }
3101
3102         return res;
3103 }
3104
3105 static void request_cc(struct cc_core_instance *core_instance)
3106 {
3107         struct ast_cc_monitor *monitor_iter;
3108         AST_LIST_LOCK(core_instance->monitors);
3109         AST_LIST_TRAVERSE_SAFE_BEGIN(core_instance->monitors, monitor_iter, next) {
3110                 if (monitor_iter->interface->monitor_class == AST_CC_DEVICE_MONITOR) {
3111                         if (monitor_iter->callbacks->request_cc(monitor_iter, &monitor_iter->available_timer_id)) {
3112                                 AST_LIST_REMOVE_CURRENT(next);
3113                                 cc_extension_monitor_change_is_valid(core_instance, monitor_iter->parent_id,
3114                                                 monitor_iter->interface->device_name, 1);
3115                                 cc_unref(monitor_iter, "request_cc failed. Unref list's reference to monitor");
3116                         } else {
3117                                 cc_publish_requested(core_instance->core_id, core_instance->agent->device_name, monitor_iter->interface->device_name);
3118                         }
3119                 }
3120         }
3121         AST_LIST_TRAVERSE_SAFE_END;
3122
3123         if (!has_device_monitors(core_instance)) {
3124                 ast_cc_failed(core_instance->core_id, "All device monitors failed to request CC");
3125         }
3126         AST_LIST_UNLOCK(core_instance->monitors);
3127 }
3128
3129 static int cc_caller_requested(struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
3130 {
3131         if (!ast_cc_request_is_within_limits()) {
3132                 ast_log(LOG_WARNING, "Cannot request CC since there is no more room for requests\n");
3133                 core_instance->agent->callbacks->respond(core_instance->agent,
3134                         AST_CC_AGENT_RESPONSE_FAILURE_TOO_MANY);
3135                 ast_cc_failed(core_instance->core_id, "Too many requests in the system");
3136                 return -1;
3137         }
3138         core_instance->agent->callbacks->stop_offer_timer(core_instance->agent);
3139         request_cc(core_instance);
3140         return 0;
3141 }
3142
3143 static void unsuspend(struct cc_core_instance *core_instance)
3144 {
3145         struct ast_cc_monitor *monitor_iter;
3146         AST_LIST_LOCK(core_instance->monitors);
3147         AST_LIST_TRAVERSE_SAFE_BEGIN(core_instance->monitors, monitor_iter, next) {
3148                 if (monitor_iter->interface->monitor_class == AST_CC_DEVICE_MONITOR) {
3149                         if (monitor_iter->callbacks->unsuspend(monitor_iter)) {
3150                                 AST_LIST_REMOVE_CURRENT(next);
3151                                 cc_extension_monitor_change_is_valid(core_instance, monitor_iter->parent_id,
3152                                                 monitor_iter->interface->device_name, 1);
3153                                 cc_unref(monitor_iter, "unsuspend failed. Unref list's reference to monitor");
3154                         }
3155                 }
3156         }
3157         AST_LIST_TRAVERSE_SAFE_END;
3158
3159         if (!has_device_monitors(core_instance)) {
3160                 ast_cc_failed(core_instance->core_id, "All device monitors failed to unsuspend CC");
3161         }
3162         AST_LIST_UNLOCK(core_instance->monitors);
3163 }
3164
3165 static int cc_active(struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
3166 {
3167         /* Either
3168          * 1. Callee accepted CC request, call agent's ack callback.
3169          * 2. Caller became available, call agent's stop_monitoring callback and
3170          *    call monitor's unsuspend callback.
3171          */
3172         if (previous_state == CC_CALLER_REQUESTED) {
3173                 core_instance->agent->callbacks->respond(core_instance->agent,
3174                         AST_CC_AGENT_RESPONSE_SUCCESS);
3175                 cc_publish_requestacknowledged(core_instance->core_id, core_instance->agent->device_name);
3176         } else if (previous_state == CC_CALLER_BUSY) {
3177                 cc_publish_callerstopmonitoring(core_instance->core_id, core_instance->agent->device_name);
3178                 unsuspend(core_instance);
3179         }
3180         /* Not possible for previous_state to be anything else due to the is_state_change_valid check at the beginning */
3181         return 0;
3182 }
3183
3184 static int cc_callee_ready(struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
3185 {
3186         core_instance->agent->callbacks->callee_available(core_instance->agent);
3187         return 0;
3188 }
3189
3190 static void suspend(struct cc_core_instance *core_instance)
3191 {
3192         struct ast_cc_monitor *monitor_iter;
3193         AST_LIST_LOCK(core_instance->monitors);
3194         AST_LIST_TRAVERSE_SAFE_BEGIN(core_instance->monitors, monitor_iter, next) {
3195                 if (monitor_iter->interface->monitor_class == AST_CC_DEVICE_MONITOR) {
3196                         if (monitor_iter->callbacks->suspend(monitor_iter)) {
3197                                 AST_LIST_REMOVE_CURRENT(next);
3198                                 cc_extension_monitor_change_is_valid(core_instance, monitor_iter->parent_id,
3199                                                 monitor_iter->interface->device_name, 1);
3200                                 cc_unref(monitor_iter, "suspend failed. Unref list's reference to monitor");
3201                         }
3202                 }
3203         }
3204         AST_LIST_TRAVERSE_SAFE_END;
3205
3206         if (!has_device_monitors(core_instance)) {
3207                 ast_cc_failed(core_instance->core_id, "All device monitors failed to suspend CC");
3208         }
3209         AST_LIST_UNLOCK(core_instance->monitors);
3210 }
3211
3212 static int cc_caller_busy(struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
3213 {
3214         /* Callee was available, but caller was busy, call agent's begin_monitoring callback
3215          * and call monitor's suspend callback.
3216          */
3217         suspend(core_instance);
3218         core_instance->agent->callbacks->start_monitoring(core_instance->agent);
3219         cc_publish_callerstartmonitoring(core_instance->core_id, core_instance->agent->device_name);
3220         return 0;
3221 }
3222
3223 static void cancel_available_timer(struct cc_core_instance *core_instance)
3224 {
3225         struct ast_cc_monitor *monitor_iter;
3226         AST_LIST_LOCK(core_instance->monitors);
3227         AST_LIST_TRAVERSE_SAFE_BEGIN(core_instance->monitors, monitor_iter, next) {
3228                 if (monitor_iter->interface->monitor_class == AST_CC_DEVICE_MONITOR) {
3229                         if (monitor_iter->callbacks->cancel_available_timer(monitor_iter, &monitor_iter->available_timer_id)) {
3230                                 AST_LIST_REMOVE_CURRENT(next);
3231                                 cc_extension_monitor_change_is_valid(core_instance, monitor_iter->parent_id,
3232                                                 monitor_iter->interface->device_name, 1);
3233                                 cc_unref(monitor_iter, "cancel_available_timer failed. Unref list's reference to monitor");
3234                         }
3235                 }
3236         }
3237         AST_LIST_TRAVERSE_SAFE_END;
3238
3239         if (!has_device_monitors(core_instance)) {
3240                 ast_cc_failed(core_instance->core_id, "All device monitors failed to cancel their available timers");
3241         }
3242         AST_LIST_UNLOCK(core_instance->monitors);
3243 }
3244
3245 static int cc_recalling(struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
3246 {
3247         /* Both caller and callee are available, call agent's recall callback
3248          */
3249         cancel_available_timer(core_instance);
3250         cc_publish_callerrecalling(core_instance->core_id, core_instance->agent->device_name);
3251         return 0;
3252 }
3253
3254 static int cc_complete(struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
3255 {
3256         /* Recall has made progress, call agent and monitor destructor functions
3257          */
3258         cc_publish_recallcomplete(core_instance->core_id, core_instance->agent->device_name);
3259         ao2_t_unlink(cc_core_instances, core_instance, "Unlink core instance since CC recall has completed");
3260         return 0;
3261 }
3262
3263 static int cc_failed(struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
3264 {
3265         cc_publish_failure(core_instance->core_id, core_instance->agent->device_name, args->debug);
3266         ao2_t_unlink(cc_core_instances, core_instance, "Unlink core instance since CC failed");
3267         return 0;
3268 }
3269
3270 static int (* const state_change_funcs [])(struct cc_core_instance *, struct cc_state_change_args *, enum cc_state previous_state) = {
3271         [CC_AVAILABLE] = cc_available,
3272         [CC_CALLER_OFFERED] = cc_caller_offered,
3273         [CC_CALLER_REQUESTED] = cc_caller_requested,
3274         [CC_ACTIVE] = cc_active,
3275         [CC_CALLEE_READY] = cc_callee_ready,
3276         [CC_CALLER_BUSY] = cc_caller_busy,
3277         [CC_RECALLING] = cc_recalling,
3278         [CC_COMPLETE] = cc_complete,
3279         [CC_FAILED] = cc_failed,
3280 };
3281
3282 static int cc_do_state_change(void *datap)
3283 {
3284         struct cc_state_change_args *args = datap;
3285         struct cc_core_instance *core_instance;
3286         enum cc_state previous_state;
3287         int res;
3288
3289         ast_log_dynamic_level(cc_logger_level, "Core %d: State change to %u requested. Reason: %s\n",
3290                         args->core_id, args->state, args->debug);
3291
3292         core_instance = args->core_instance;
3293
3294         if (!is_state_change_valid(core_instance->current_state, args->state, core_instance->agent)) {
3295                 ast_log_dynamic_level(cc_logger_level, "Core %d: Invalid state change requested. Cannot go from %s to %s\n",
3296                                 args->core_id, cc_state_to_string(core_instance->current_state), cc_state_to_string(args->state));
3297                 if (args->state == CC_CALLER_REQUESTED) {
3298                         /*
3299                          * For out-of-order requests, we need to let the requester know that
3300                          * we can't handle the request now.
3301                          */
3302                         core_instance->agent->callbacks->respond(core_instance->agent,
3303                                 AST_CC_AGENT_RESPONSE_FAILURE_INVALID);
3304                 }
3305                 ast_free(args);
3306                 cc_unref(core_instance, "Unref core instance from when it was found earlier");
3307                 return -1;
3308         }
3309
3310         /* We can change to the new state now. */
3311         previous_state = core_instance->current_state;
3312         core_instance->current_state = args->state;
3313         res = state_change_funcs[core_instance->current_state](core_instance, args, previous_state);
3314
3315         /* If state change successful then notify any device state watchers of the change */
3316         if (!res && !strcmp(core_instance->agent->callbacks->type, "generic")) {
3317                 ccss_notify_device_state_change(core_instance->agent->device_name, core_instance->current_state);
3318         }
3319
3320         ast_free(args);
3321         cc_unref(core_instance, "Unref since state change has completed"); /* From ao2_find */
3322         return res;
3323 }
3324
3325 static int cc_request_state_change(enum cc_state state, const int core_id, const char *debug, va_list ap)
3326 {
3327         int res;
3328         int debuglen;
3329         char dummy[1];
3330         va_list aq;
3331         struct cc_core_instance *core_instance;
3332         struct cc_state_change_args *args;
3333         /* This initial call to vsnprintf is simply to find what the
3334          * size of the string needs to be
3335          */
3336         va_copy(aq, ap);
3337         /* We add 1 to the result since vsnprintf's return does not
3338          * include the terminating null byte
3339          */
3340         debuglen = vsnprintf(dummy, sizeof(dummy), debug, aq) + 1;
3341         va_end(aq);
3342
3343         if (!(args = ast_calloc(1, sizeof(*args) + debuglen))) {
3344                 return -1;
3345         }
3346
3347         core_instance = find_cc_core_instance(core_id);
3348         if (!core_instance) {
3349                 ast_log_dynamic_level(cc_logger_level, "Core %d: Unable to find core instance.\n",
3350                         core_id);
3351                 ast_free(args);
3352                 return -1;
3353         }
3354
3355         args->core_instance = core_instance;
3356         args->state = state;
3357         args->core_id = core_id;
3358         vsnprintf(args->debug, debuglen, debug, ap);
3359
3360         res = ast_taskprocessor_push(cc_core_taskprocessor, cc_do_state_change, args);
3361         if (res) {
3362                 cc_unref(core_instance, "Unref core instance. ast_taskprocessor_push failed");
3363                 ast_free(args);
3364         }
3365         return res;
3366 }
3367
3368 struct cc_recall_ds_data {
3369         int core_id;
3370         char ignore;
3371         char nested;
3372         struct cc_monitor_tree *interface_tree;
3373 };
3374
3375 static void *cc_recall_ds_duplicate(void *data)
3376 {
3377         struct cc_recall_ds_data *old_data = data;
3378         struct cc_recall_ds_data *new_data = ast_calloc(1, sizeof(*new_data));
3379
3380         if (!new_data) {
3381                 return NULL;
3382         }
3383         new_data->interface_tree = cc_ref(old_data->interface_tree, "Bump refcount of monitor tree for recall datastore duplicate");
3384         new_data->core_id = old_data->core_id;
3385         new_data->nested = 1;
3386         return new_data;
3387 }
3388
3389 static void cc_recall_ds_destroy(void *data)
3390 {
3391         struct cc_recall_ds_data *recall_data = data;
3392         recall_data->interface_tree = cc_unref(recall_data->interface_tree, "Unref recall monitor tree");
3393         ast_free(recall_data);
3394 }
3395
3396 static const struct ast_datastore_info recall_ds_info = {
3397         .type = "cc_recall",
3398         .duplicate = cc_recall_ds_duplicate,
3399         .destroy = cc_recall_ds_destroy,
3400 };
3401
3402 int ast_setup_cc_recall_datastore(struct ast_channel *chan, const int core_id)
3403 {
3404         struct ast_datastore *recall_datastore = ast_datastore_alloc(&recall_ds_info, NULL);
3405         struct cc_recall_ds_data *recall_data;
3406         struct cc_core_instance *core_instance;
3407
3408         if (!recall_datastore) {
3409                 return -1;
3410         }
3411
3412         if (!(recall_data = ast_calloc(1, sizeof(*recall_data)))) {
3413                 ast_datastore_free(recall_datastore);
3414                 return -1;
3415         }
3416
3417         if (!(core_instance = find_cc_core_instance(core_id))) {
3418                 ast_free(recall_data);
3419                 ast_datastore_free(recall_datastore);
3420                 return -1;
3421         }
3422
3423         recall_data->interface_tree = cc_ref(core_instance->monitors,
3424                         "Bump refcount for monitor tree for recall datastore");
3425         recall_data->core_id = core_id;
3426         recall_datastore->data = recall_data;
3427         recall_datastore->inheritance = DATASTORE_INHERIT_FOREVER;
3428         ast_channel_lock(chan);
3429         ast_channel_datastore_add(chan, recall_datastore);
3430         ast_channel_unlock(chan);
3431         cc_unref(core_instance, "Recall datastore set up. No need for core_instance ref");
3432         return 0;
3433 }
3434
3435 int ast_cc_is_recall(struct ast_channel *chan, int *core_id, const char * const monitor_type)
3436 {
3437         struct ast_datastore *recall_datastore;
3438         struct cc_recall_ds_data *recall_data;
3439         struct cc_monitor_tree *interface_tree;
3440         char device_name[AST_CHANNEL_NAME];
3441         struct ast_cc_monitor *device_monitor;
3442         int core_id_candidate;
3443
3444         ast_assert(core_id != NULL);
3445
3446         *core_id = -1;
3447
3448         ast_channel_lock(chan);
3449         if (!(recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
3450                 /* Obviously not a recall if the datastore isn't present */
3451                 ast_channel_unlock(chan);
3452                 return 0;
3453         }
3454
3455         recall_data = recall_datastore->data;
3456
3457         if (recall_data->ignore) {
3458                 /* Though this is a recall, the call to this particular interface is not part of the
3459                  * recall either because this is a call forward or because this is not the first
3460                  * invocation of Dial during this call
3461                  */
3462                 ast_channel_unlock(chan);
3463                 return 0;
3464         }
3465
3466         if (!recall_data->nested) {
3467                 /* If the nested flag is not set, then this means that
3468                  * the channel passed to this function is the caller making
3469                  * the recall. This means that we shouldn't look through
3470                  * the monitor tree for the channel because it shouldn't be
3471                  * there. However, this is a recall though, so return true.
3472                  */
3473                 *core_id = recall_data->core_id;
3474                 ast_channel_unlock(chan);
3475                 return 1;
3476         }
3477
3478         if (ast_strlen_zero(monitor_type)) {
3479                 /* If someone passed a NULL or empty monitor type, then it is clear
3480                  * the channel they passed in was an incoming channel, and so searching
3481                  * the list of dialed interfaces is not going to be helpful. Just return
3482                  * false immediately.
3483                  */
3484                 ast_channel_unlock(chan);
3485                 return 0;
3486         }
3487
3488         interface_tree = recall_data->interface_tree;
3489         ast_channel_get_device_name(chan, device_name, sizeof(device_name));
3490         /* We grab the value of the recall_data->core_id so that we
3491          * can unlock the channel before we start looking through the
3492          * interface list. That way we don't have to worry about a possible
3493          * clash between the channel lock and the monitor tree lock.
3494          */
3495         core_id_candidate = recall_data->core_id;
3496         ast_channel_unlock(chan);
3497
3498         /*
3499          * Now we need to find out if the channel device name
3500          * is in the list of interfaces in the called tree.
3501          */
3502         AST_LIST_LOCK(interface_tree);
3503         AST_LIST_TRAVERSE(interface_tree, device_monitor, next) {
3504                 if (!strcmp(device_monitor->interface->device_name, device_name) &&
3505                                 !strcmp(device_monitor->interface->monitor_type, monitor_type)) {
3506                         /* BOOM! Device is in the tree! We have a winner! */
3507                         *core_id = core_id_candidate;
3508                         AST_LIST_UNLOCK(interface_tree);
3509                         return 1;
3510                 }
3511         }
3512         AST_LIST_UNLOCK(interface_tree);
3513         return 0;
3514 }
3515
3516 struct ast_cc_monitor *ast_cc_get_monitor_by_recall_core_id(const int core_id, const char * const device_name)
3517 {
3518         struct cc_core_instance *core_instance = find_cc_core_instance(core_id);
3519         struct ast_cc_monitor *monitor_iter;
3520
3521         if (!core_instance) {
3522                 return NULL;
3523         }
3524
3525         AST_LIST_LOCK(core_instance->monitors);
3526         AST_LIST_TRAVERSE(core_instance->monitors, monitor_iter, next) {
3527                 if (!strcmp(monitor_iter->interface->device_name, device_name)) {
3528                         /* Found a monitor. */
3529                         cc_ref(monitor_iter, "Hand the requester of the monitor a reference");
3530                         break;
3531                 }
3532         }
3533         AST_LIST_UNLOCK(core_instance->monitors);
3534         cc_unref(core_instance, "Done with core instance ref in ast_cc_get_monitor_by_recall_core_id");
3535         return monitor_iter;
3536 }
3537
3538 /*!
3539  * \internal
3540  * \brief uniquely append a dialstring to our CC_INTERFACES chanvar string.
3541  *
3542  * We will only append a string if it has not already appeared in our channel
3543  * variable earlier. We ensure that we don't erroneously match substrings by
3544  * adding an ampersand to the end of our potential dialstring and searching for
3545  * it plus the ampersand in our variable.
3546  *
3547  * It's important to note that once we have built the full CC_INTERFACES string,
3548  * there will be an extra ampersand at the end which must be stripped off by
3549  * the caller of this function.
3550  *
3551  * \param str An ast_str holding what we will add to CC_INTERFACES
3552  * \param dialstring A new dialstring to add
3553  * \retval void
3554  */
3555 static void cc_unique_append(struct ast_str **str, const char *dialstring)
3556 {
3557         char dialstring_search[AST_CHANNEL_NAME];
3558
3559         if (ast_strlen_zero(dialstring)) {
3560                 /* No dialstring to append. */
3561                 return;
3562         }
3563         snprintf(dialstring_search, sizeof(dialstring_search), "%s%c", dialstring, '&');
3564         if (strstr(ast_str_buffer(*str), dialstring_search)) {
3565                 return;
3566         }
3567         ast_str_append(str, 0, "%s", dialstring_search);
3568 }
3569
3570 /*!
3571  * \internal
3572  * \brief Build the CC_INTERFACES channel variable
3573  *
3574  * The method used is to traverse the child dialstrings in the
3575  * passed-in extension monitor, adding any that have the is_valid
3576  * flag set. Then, traverse the monitors, finding all children
3577  * of the starting extension monitor and adding their dialstrings
3578  * as well.
3579  *
3580  * \param starting_point The extension monitor that is the parent to all
3581  * monitors whose dialstrings should be added to CC_INTERFACES
3582  * \param str Where we will store CC_INTERFACES
3583  * \retval void
3584  */
3585 static void build_cc_interfaces_chanvar(struct ast_cc_monitor *starting_point, struct ast_str **str)
3586 {
3587         struct extension_monitor_pvt *extension_pvt;
3588         struct extension_child_dialstring *child_dialstring;
3589         struct ast_cc_monitor *monitor_iter = starting_point;
3590         int top_level_id = starting_point->id;
3591         size_t length;
3592
3593         /* Init to an empty string. */
3594         ast_str_truncate(*str, 0);
3595
3596         /* First we need to take all of the is_valid child_dialstrings from
3597          * the extension monitor we found and add them to the CC_INTERFACES
3598          * chanvar
3599          */
3600         extension_pvt = starting_point->private_data;
3601         AST_LIST_TRAVERSE(&extension_pvt->child_dialstrings, child_dialstring, next) {
3602                 if (child_dialstring->is_valid) {
3603                         cc_unique_append(str, child_dialstring->original_dialstring);
3604                 }
3605         }
3606
3607         /* And now we get the dialstrings from each of the device monitors */
3608         while ((monitor_iter = AST_LIST_NEXT(monitor_iter, next))) {
3609                 if (monitor_iter->parent_id == top_level_id) {
3610                         cc_unique_append(str, monitor_iter->dialstring);
3611                 }
3612         }
3613
3614         /* str will have an extra '&' tacked onto the end of it, so we need
3615          * to get rid of that.
3616          */
3617         length = ast_str_strlen(*str);
3618         if (length) {
3619                 ast_str_truncate(*str, length - 1);
3620         }
3621         if (length <= 1) {
3622                 /* Nothing to recall?  This should not happen. */
3623                 ast_log(LOG_ERROR, "CC_INTERFACES is empty. starting device_name:'%s'\n",
3624                         starting_point->interface->device_name);
3625         }
3626 }
3627
3628 int ast_cc_agent_set_interfaces_chanvar(struct ast_channel *chan)
3629 {
3630         struct ast_datastore *recall_datastore;
3631         struct cc_monitor_tree *interface_tree;
3632         struct ast_cc_monitor *monitor;
3633         struct cc_recall_ds_data *recall_data;
3634         struct ast_str *str = ast_str_create(64);
3635         int core_id;
3636
3637         if (!str) {
3638                 return -1;
3639         }
3640
3641         ast_channel_lock(chan);
3642         if (!(recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
3643                 ast_channel_unlock(chan);
3644                 ast_free(str);
3645                 return -1;
3646         }
3647         recall_data = recall_datastore->data;
3648         interface_tree = recall_data->interface_tree;
3649         core_id = recall_data->core_id;
3650         ast_channel_unlock(chan);
3651
3652         AST_LIST_LOCK(interface_tree);
3653         monitor = AST_LIST_FIRST(interface_tree);
3654         build_cc_interfaces_chanvar(monitor, &str);
3655         AST_LIST_UNLOCK(interface_tree);
3656
3657         pbx_builtin_setvar_helper(chan, "CC_INTERFACES", ast_str_buffer(str));
3658         ast_log_dynamic_level(cc_logger_level, "Core %d: CC_INTERFACES set to %s\n",
3659                         core_id, ast_str_buffer(str));
3660
3661         ast_free(str);
3662         return 0;
3663 }
3664
3665 int ast_set_cc_interfaces_chanvar(struct ast_channel *chan, const char * const extension)
3666 {
3667         struct ast_datastore *recall_datastore;
3668         struct cc_monitor_tree *interface_tree;
3669         struct ast_cc_monitor *monitor_iter;
3670         struct cc_recall_ds_data *recall_data;
3671         struct ast_str *str = ast_str_create(64);
3672         int core_id;
3673
3674         if (!str) {
3675                 return -1;
3676         }
3677
3678         ast_channel_lock(chan);
3679         if (!(recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
3680                 ast_channel_unlock(chan);
3681                 ast_free(str);
3682                 return -1;
3683         }
3684         recall_data = recall_datastore->data;
3685         interface_tree = recall_data->interface_tree;
3686         core_id = recall_data->core_id;
3687         ast_channel_unlock(chan);
3688
3689         AST_LIST_LOCK(interface_tree);
3690         AST_LIST_TRAVERSE(interface_tree, monitor_iter, next) {
3691                 if (!strcmp(monitor_iter->interface->device_name, extension)) {
3692                         break;
3693                 }
3694         }
3695
3696         if (!monitor_iter) {
3697                 /* We couldn't find this extension. This may be because
3698                  * we have been directed into an unexpected extension because
3699                  * the admin has changed a CC_INTERFACES variable at some point.
3700                  */
3701                 AST_LIST_UNLOCK(interface_tree);
3702                 ast_free(str);
3703                 return -1;
3704         }
3705
3706         build_cc_interfaces_chanvar(monitor_iter, &str);
3707         AST_LIST_UNLOCK(interface_tree);
3708
3709         pbx_builtin_setvar_helper(chan, "CC_INTERFACES", ast_str_buffer(str));
3710         ast_log_dynamic_level(cc_logger_level, "Core %d: CC_INTERFACES set to %s\n",
3711                         core_id, ast_str_buffer(str));
3712
3713         ast_free(str);
3714         return 0;
3715 }
3716
3717 void ast_ignore_cc(struct ast_channel *chan)
3718 {
3719         struct ast_datastore *cc_datastore;
3720         struct ast_datastore *cc_recall_datastore;
3721         struct dialed_cc_interfaces *cc_interfaces;
3722         struct cc_recall_ds_data *recall_cc_data;
3723
3724         ast_channel_lock(chan);
3725         if ((cc_datastore = ast_channel_datastore_find(chan, &dialed_cc_interfaces_info, NULL))) {
3726                 cc_interfaces = cc_datastore->data;
3727                 cc_interfaces->ignore = 1;
3728         }
3729
3730         if ((cc_recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
3731                 recall_cc_data = cc_recall_datastore->data;
3732                 recall_cc_data->ignore = 1;
3733         }
3734         ast_channel_unlock(chan);
3735 }
3736
3737 static __attribute__((format(printf, 2, 3))) int cc_offer(const int core_id, const char * const debug, ...)
3738 {
3739         va_list ap;
3740         int res;
3741
3742         va_start(ap, debug);
3743         res = cc_request_state_change(CC_CALLER_OFFERED, core_id, debug, ap);
3744         va_end(ap);
3745         return res;
3746 }
3747
3748 int ast_cc_offer(struct ast_channel *caller_chan)
3749 {
3750         int core_id;
3751         int res = -1;
3752         struct ast_datastore *datastore;
3753         struct dialed_cc_interfaces *cc_interfaces;
3754         char cc_is_offerable;
3755
3756         ast_channel_lock(caller_chan);
3757         if (!(datastore = ast_channel_datastore_find(caller_chan, &dialed_cc_interfaces_info, NULL))) {
3758                 ast_channel_unlock(caller_chan);
3759                 return res;
3760         }
3761
3762         cc_interfaces = datastore->data;
3763         cc_is_offerable = cc_interfaces->is_original_caller;
3764         core_id = cc_interfaces->core_id;
3765         ast_channel_unlock(caller_chan);
3766
3767         if (cc_is_offerable) {
3768                 res = cc_offer(core_id, "CC offered to caller %s", ast_channel_name(caller_chan));
3769         }
3770         return res;
3771 }
3772
3773 int ast_cc_agent_accept_request(int core_id, const char * const debug, ...)
3774 {
3775         va_list ap;
3776         int res;
3777
3778         va_start(ap, debug);
3779         res = cc_request_state_change(CC_CALLER_REQUESTED, core_id, debug, ap);
3780         va_end(ap);
3781         return res;
3782 }
3783
3784 int ast_cc_monitor_request_acked(int core_id, const char * const debug, ...)
3785 {
3786         va_list ap;
3787         int res;
3788
3789         va_start(ap, debug);
3790         res = cc_request_state_change(CC_ACTIVE, core_id, debug, ap);
3791         va_end(ap);
3792         return res;
3793 }
3794
3795 int ast_cc_monitor_callee_available(const int core_id, const char * const debug, ...)
3796 {
3797         va_list ap;
3798         int res;
3799
3800         va_start(ap, debug);
3801         res = cc_request_state_change(CC_CALLEE_READY, core_id, debug, ap);
3802         va_end(ap);
3803         return res;
3804 }
3805
3806 int ast_cc_agent_caller_busy(int core_id, const char * debug, ...)
3807 {
3808         va_list ap;
3809         int res;
3810
3811         va_start(ap, debug);
3812         res = cc_request_state_change(CC_CALLER_BUSY, core_id, debug, ap);
3813         va_end(ap);
3814         return res;
3815 }
3816
3817 int ast_cc_agent_caller_available(int core_id, const char * const debug, ...)
3818 {
3819         va_list ap;
3820         int res;
3821
3822         va_start(ap, debug);
3823         res = cc_request_state_change(CC_ACTIVE, core_id, debug, ap);
3824         va_end(ap);
3825         return res;
3826 }
3827
3828 int ast_cc_agent_recalling(int core_id, const char * const debug, ...)
3829 {
3830         va_list ap;
3831         int res;
3832
3833         va_start(ap, debug);
3834         res = cc_request_state_change(CC_RECALLING, core_id, debug, ap);
3835         va_end(ap);
3836         return res;
3837 }
3838
3839 int ast_cc_completed(struct ast_channel *chan, const char * const debug, ...)
3840 {
3841         struct ast_datastore *recall_datastore;
3842         struct cc_recall_ds_data *recall_data;
3843         int core_id;
3844         va_list ap;
3845         int res;
3846
3847         ast_channel_lock(chan);
3848         if (!(recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
3849                 /* Silly! Why did you call this function if there's no recall DS? */
3850                 ast_channel_unlock(chan);
3851                 return -1;
3852         }
3853         recall_data = recall_datastore->data;
3854         if (recall_data->nested || recall_data->ignore) {
3855                 /* If this is being called from a nested Dial, it is too
3856                  * early to determine if the recall has actually completed.
3857                  * The outermost dial is the only one with the authority to
3858                  * declare the recall to be complete.
3859                  *
3860                  * Similarly, if this function has been called when the
3861                  * recall has progressed beyond the first dial, this is not
3862                  * a legitimate time to declare the recall to be done. In fact,
3863                  * that should have been done already.
3864                  */
3865                 ast_channel_unlock(chan);
3866                 return -1;
3867         }
3868         core_id = recall_data->core_id;
3869         ast_channel_unlock(chan);
3870         va_start(ap, debug);
3871         res = cc_request_state_change(CC_COMPLETE, core_id, debug, ap);
3872         va_end(ap);
3873         return res;
3874 }
3875
3876 int ast_cc_failed(int core_id, const char * const debug, ...)
3877 {
3878         va_list ap;
3879         int res;
3880
3881         va_start(ap, debug);
3882         res = cc_request_state_change(CC_FAILED, core_id, debug, ap);
3883         va_end(ap);
3884         return res;
3885 }
3886
3887 struct ast_cc_monitor_failure_data {
3888         const char *device_name;
3889         char *debug;
3890         int core_id;
3891 };
3892
3893 static int cc_monitor_failed(void *data)
3894 {
3895         struct ast_cc_monitor_failure_data *failure_data = data;
3896         struct cc_core_instance *core_instance;
3897         struct ast_cc_monitor *monitor_iter;
3898
3899         core_instance = find_cc_core_instance(failure_data->core_id);
3900         if (!core_instance) {
3901                 /* Core instance no longer exists or invalid core_id. */
3902                 ast_log_dynamic_level(cc_logger_level,
3903                         "Core %d: Could not find core instance for device %s '%s'\n",
3904                         failure_data->core_id, failure_data->device_name, failure_data->debug);
3905                 ast_free((char *) failure_data->device_name);
3906                 ast_free((char *) failure_data->debug);
3907                 ast_free(failure_data);
3908                 return -1;
3909         }
3910
3911         AST_LIST_LOCK(core_instance->monitors);
3912         AST_LIST_TRAVERSE_SAFE_BEGIN(core_instance->monitors, monitor_iter, next) {
3913                 if (monitor_iter->interface->monitor_class == AST_CC_DEVICE_MONITOR) {
3914                         if (!strcmp(monitor_iter->interface->device_name, failure_data->device_name)) {
3915                                 AST_LIST_REMOVE_CURRENT(next);
3916                                 cc_extension_monitor_change_is_valid(core_instance, monitor_iter->parent_id,
3917                                                 monitor_iter->interface->device_name, 1);
3918                                 monitor_iter->callbacks->cancel_available_timer(monitor_iter, &monitor_iter->available_timer_id);
3919                                 cc_publish_monitorfailed(monitor_iter->core_id, monitor_iter->interface->device_name);
3920                                 cc_unref(monitor_iter, "Monitor reported failure. Unref list's reference.");
3921                         }
3922                 }
3923         }
3924         AST_LIST_TRAVERSE_SAFE_END;
3925
3926         if (!has_device_monitors(core_instance)) {
3927                 ast_cc_failed(core_instance->core_id, "All monitors have failed\n");
3928         }
3929         AST_LIST_UNLOCK(core_instance->monitors);
3930         cc_unref(core_instance, "Finished with core_instance in cc_monitor_failed\n");
3931
3932         ast_free((char *) failure_data->device_name);
3933         ast_free((char *) failure_data->debug);
3934         ast_free(failure_data);
3935         return 0;
3936 }
3937
3938 int ast_cc_monitor_failed(int core_id, const char *const monitor_name, const char * const debug, ...)
3939 {
3940         struct ast_cc_monitor_failure_data *failure_data;
3941         int res;
3942         va_list ap;
3943
3944         if (!(failure_data = ast_calloc(1, sizeof(*failure_data)))) {
3945                 return -1;
3946         }
3947
3948         if (!(failure_data->device_name = ast_strdup(monitor_name))) {