Asterisk - The Open Source Telephony Project  GIT-master-a1fa8df
res_parking.c
Go to the documentation of this file.
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Jonathan Rose <jrose@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18 
19 /*! \file
20  *
21  * \brief Call Parking Resource
22  *
23  * \author Jonathan Rose <jrose@digium.com>
24  */
25 
26 /*** MODULEINFO
27  <depend>bridge_holding</depend>
28  <support_level>core</support_level>
29  ***/
30 
31 /*** DOCUMENTATION
32  <configInfo name="res_parking" language="en_US">
33  <configFile name="res_parking.conf">
34  <configObject name="globals">
35  <synopsis>Options that apply to every parking lot</synopsis>
36  <configOption name="parkeddynamic">
37  <synopsis>Enables dynamically created parkinglots.</synopsis>
38  <description>
39  <para>If the option is enabled then the following variables can
40  be used to dynamically create new parking lots.
41  </para>
42  <para>The <variable>PARKINGDYNAMIC</variable> variable specifies the
43  parking lot to use as a template to create a dynamic parking lot. It
44  is an error to specify a non-existent parking lot for the template.
45  If not set then the default parking lot is used as the template.
46  </para>
47  <para>The <variable>PARKINGDYNCONTEXT</variable> variable specifies the
48  dialplan context to use for the newly created dynamic parking lot. If
49  not set then the context from the parking lot template is used. The
50  context is created if it does not already exist and the new parking lot
51  needs to create extensions.
52  </para>
53  <para>The <variable>PARKINGDYNEXTEN</variable> variable specifies the
54  <literal>parkext</literal> to use for the newly created dynamic
55  parking lot. If not set then the <literal>parkext</literal> is used from
56  the parking lot template. If the template does not specify a
57  <literal>parkext</literal> then no extensions are created for the newly
58  created parking lot. The dynamic parking lot cannot be created if it
59  needs to create extensions that overlap existing parking lot extensions.
60  The only exception to this is for the <literal>parkext</literal>
61  extension and only if neither of the overlaping parking lot's
62  <literal>parkext</literal> is exclusive.
63  </para>
64  <para>The <variable>PARKINGDYNPOS</variable> variable specifies the
65  parking positions to use for the newly created dynamic parking lot. If
66  not set then the <literal>parkpos</literal> from the parking lot template
67  is used.
68  </para>
69  </description>
70  </configOption>
71  </configObject>
72  <configObject name="parking_lot">
73  <synopsis>Defined parking lots for res_parking to use to park calls on</synopsis>
74  <configOption name="context" default="parkedcalls">
75  <synopsis>The name of the context where calls are parked and picked up from.</synopsis>
76  <description><para>This option is only used if parkext is set.</para></description>
77  </configOption>
78  <configOption name="parkext">
79  <synopsis>Extension to park calls to this parking lot.</synopsis>
80  <description>
81  <para>If this option is used, this extension will automatically
82  be created to place calls into parking lots. In addition, if
83  <literal>parkext_exclusive</literal> is set for this parking
84  lot, the name of the parking lot will be included in the
85  application's arguments so that it only parks to this parking
86  lot. The extension will be created in <literal>context</literal>.
87  Using this option also creates extensions for retrieving
88  parked calls from the parking spaces in the same context.
89  </para>
90  <note>
91  <para>Generated parking extensions cannot overlap.
92  The only exception is if neither overlapping
93  <literal>parkext</literal> is exclusive.
94  </para>
95  </note>
96  </description>
97  </configOption>
98  <configOption name="parkext_exclusive" default="no">
99  <synopsis>If yes, the extension registered as parkext will park exclusively to this parking lot.</synopsis>
100  </configOption>
101  <configOption name="parkpos" default="701-750">
102  <synopsis>Numerical range of parking spaces which can be used to retrieve parked calls.</synopsis>
103  <description>
104  <para>If <literal>parkext</literal> is set, these extensions
105  will automatically be mapped in <literal>context</literal>
106  in order to pick up calls parked to these parking spaces.
107  </para>
108  </description>
109  </configOption>
110  <configOption name="parkinghints" default="no">
111  <synopsis>If yes, this parking lot will add hints automatically for parking spaces.</synopsis>
112  </configOption>
113  <configOption name="parkingtime" default="45">
114  <synopsis>Amount of time a call will remain parked before giving up (in seconds).</synopsis>
115  </configOption>
116  <configOption name="parkedmusicclass">
117  <synopsis>Which music class to use for parked calls. They will use the default if unspecified.</synopsis>
118  </configOption>
119  <configOption name="comebacktoorigin" default="yes">
120  <synopsis>Determines what should be done with the parked channel if no one picks it up before it times out.</synopsis>
121  <description><para>Valid Options:</para>
122  <enumlist>
123  <enum name="yes">
124  <para>Automatically have the parked channel dial the device that parked the call with dial
125  timeout set by the <literal>parkingtime</literal> option. When the call times out an extension
126  to dial the PARKER will automatically be created in the <literal>park-dial</literal> context with
127  an extension of the flattened parker device name. If the call is not answered, the parked channel
128  that is timing out will continue in the dial plan at that point if there are more priorities in
129  the extension (which won't be the case unless the dialplan deliberately includes such priorities
130  in the <literal>park-dial</literal> context through pattern matching or deliberately written
131  flattened peer extensions).</para>
132  </enum>
133  <enum name="no">
134  <para>Place the call into the PBX at <literal>comebackcontext</literal> instead. The extension will
135  still be set as the flattened peer name. If an extension the flattened peer name isn't available
136  then it will fall back to the <literal>s</literal> extension. If that also is unavailable it will
137  attempt to fall back to <literal>s@default</literal>. The normal dial extension will still be
138  created in the <literal>park-dial</literal> context with the extension also being the flattened
139  peer name.</para>
140  </enum>
141  </enumlist>
142  <note><para>Flattened Peer Names - Extensions can not include slash characters since those are used for pattern
143  matching. When a peer name is flattened, slashes become underscores. For example if the parker of a call
144  is called <literal>SIP/0004F2040001</literal> then flattened peer name and therefor the extensions created
145  and used on timeouts will be <literal>SIP_0004F204001</literal>.</para></note>
146  <note><para>When parking times out and the channel returns to the dial plan, the following variables are set:
147  </para></note>
148  <variablelist>
149  <variable name="PARKING_SPACE">
150  <para>extension that the call was parked in prior to timing out.</para>
151  </variable>
152  <variable name="PARKEDLOT">
153  <para>name of the lot that the call was parked in prior to timing out.</para>
154  </variable>
155  <variable name="PARKER">
156  <para>The device that parked the call</para>
157  </variable>
158  <variable name="PARKER_FLAT">
159  <para>The flat version of <variable>PARKER</variable></para>
160  </variable>
161  </variablelist>
162  </description>
163  </configOption>
164  <configOption name="comebackdialtime" default="30">
165  <synopsis>Timeout for the Dial extension created to call back the parker when a parked call times out.</synopsis>
166  </configOption>
167  <configOption name="comebackcontext" default="parkedcallstimeout">
168  <synopsis>Context where parked calls will enter the PBX on timeout when comebacktoorigin=no</synopsis>
169  <description><para>The extension the call enters will prioritize the flattened peer name in this context.
170  If the flattened peer name extension is unavailable, then the 's' extension in this context will be
171  used. If that also is unavailable, the 's' extension in the 'default' context will be used.</para>
172  </description>
173  </configOption>
174  <configOption name="courtesytone">
175  <synopsis>If the name of a sound file is provided, use this as the courtesy tone</synopsis>
176  <description><para>By default, this tone is only played to the caller of a parked call. Who receives the tone
177  can be changed using the <literal>parkedplay</literal> option.</para>
178  </description>
179  </configOption>
180  <configOption name="parkedplay" default="caller">
181  <synopsis>Who we should play the courtesytone to on the pickup of a parked call from this lot</synopsis>
182  <description>
183  <enumlist>
184  <enum name="no"><para>Apply to neither side.</para></enum>
185  <enum name="caller"><para>Apply only to the call connecting with the call coming out of the parking lot.</para></enum>
186  <enum name="callee"><para>Apply only to the call coming out of the parking lot.</para></enum>
187  <enum name="both"><para>Apply to both sides.</para></enum>
188  </enumlist>
189  <note><para>If courtesy tone is not specified then this option will be ignored.</para></note>
190  </description>
191  </configOption>
192  <configOption name="parkedcalltransfers" default="no">
193  <synopsis>Who to apply the DTMF transfer features to when parked calls are picked up or timeout.</synopsis>
194  <description>
195  <xi:include xpointer="xpointer(/docs/configInfo[@name='res_parking']/configFile[@name='res_parking.conf']/configObject[@name='parking_lot']/configOption[@name='parkedplay']/description/enumlist)" />
196  </description>
197  </configOption>
198  <configOption name="parkedcallreparking" default="no">
199  <synopsis>Who to apply the DTMF parking feature to when parked calls are picked up or timeout.</synopsis>
200  <description>
201  <xi:include xpointer="xpointer(/docs/configInfo[@name='res_parking']/configFile[@name='res_parking.conf']/configObject[@name='parking_lot']/configOption[@name='parkedplay']/description/enumlist)" />
202  </description>
203  </configOption>
204  <configOption name="parkedcallhangup" default="no">
205  <synopsis>Who to apply the DTMF hangup feature to when parked calls are picked up or timeout.</synopsis>
206  <description>
207  <xi:include xpointer="xpointer(/docs/configInfo[@name='res_parking']/configFile[@name='res_parking.conf']/configObject[@name='parking_lot']/configOption[@name='parkedplay']/description/enumlist)" />
208  </description>
209  </configOption>
210  <configOption name="parkedcallrecording" default="no">
211  <synopsis>Who to apply the DTMF MixMonitor recording feature to when parked calls are picked up or timeout.</synopsis>
212  <description>
213  <xi:include xpointer="xpointer(/docs/configInfo[@name='res_parking']/configFile[@name='res_parking.conf']/configObject[@name='parking_lot']/configOption[@name='parkedplay']/description/enumlist)" />
214  </description>
215  </configOption>
216  <configOption name="findslot" default="first">
217  <synopsis>Rule to use when trying to figure out which parking space a call should be parked with.</synopsis>
218  <description>
219  <enumlist>
220  <enum name="first"><para>Always try to place in the lowest available space in the parking lot</para></enum>
221  <enum name="next"><para>Track the last parking space used and always attempt to use the one immediately after.
222  </para></enum>
223  </enumlist>
224  </description>
225  </configOption>
226  </configObject>
227  </configFile>
228  </configInfo>
229  ***/
230 
231 #include "asterisk.h"
232 
233 #include "parking/res_parking.h"
234 #include "asterisk/config.h"
235 #include "asterisk/config_options.h"
236 #include "asterisk/utils.h"
237 #include "asterisk/module.h"
238 #include "asterisk/cli.h"
239 #include "asterisk/astobj2.h"
240 #include "asterisk/features.h"
241 #include "asterisk/manager.h"
242 #include "asterisk/pbx.h"
243 
244 static int parking_lot_sort_fn(const void *obj_left, const void *obj_right, int flags)
245 {
246  const struct parking_lot *left = obj_left;
247  const struct parking_lot *right = obj_right;
248  const char *right_key = obj_right;
249  int cmp;
250 
251  switch (flags & (OBJ_POINTER | OBJ_KEY | OBJ_PARTIAL_KEY)) {
252  default:
253  case OBJ_POINTER:
254  right_key = right->name;
255  /* Fall through */
256  case OBJ_KEY:
257  cmp = strcmp(left->name, right_key);
258  break;
259  case OBJ_PARTIAL_KEY:
260  cmp = strncmp(left->name, right_key, strlen(right_key));
261  }
262  return cmp;
263 }
264 
265 /*! All parking lots that are currently alive in some fashion can be obtained from here */
267 
268 static void *parking_config_alloc(void);
269 
270 static void *parking_lot_cfg_alloc(const char *cat);
271 static void *named_item_find(struct ao2_container *container, const char *name); /* XXX This is really just a generic string find. Move to astobj2.c? */
272 
273 static int config_parking_preapply(void);
274 static void link_configured_disable_marked_lots(void);
275 
278 };
279 
283 };
284 
285 static struct aco_type global_option = {
286  .type = ACO_GLOBAL,
287  .name = "globals",
288  .item_offset = offsetof(struct parking_config, global),
289  .category_match = ACO_WHITELIST_EXACT,
290  .category = "general",
291 };
292 
293 struct aco_type *global_options[] = ACO_TYPES(&global_option);
294 
295 static struct aco_type parking_lot_type = {
296  .type = ACO_ITEM,
297  .name = "parking_lot",
298  .category_match = ACO_BLACKLIST_EXACT,
299  .category = "general",
300  .item_alloc = parking_lot_cfg_alloc,
301  .item_find = named_item_find,
302  .item_offset = offsetof(struct parking_config, parking_lots),
303 };
304 
305 struct aco_type *parking_lot_types[] = ACO_TYPES(&parking_lot_type);
306 
308  .filename = "res_parking.conf",
309  .types = ACO_TYPES(&global_option, &parking_lot_type),
310 };
311 
313 
315  .files = ACO_FILES(&parking_lot_conf),
316  .pre_apply_config = config_parking_preapply,
317  .post_apply_config = link_configured_disable_marked_lots,
318 );
319 
320 static int parking_lot_cfg_hash_fn(const void *obj, const int flags)
321 {
322  const struct parking_lot_cfg *entry;
323  const char *key;
324 
325  switch (flags & (OBJ_POINTER | OBJ_KEY | OBJ_PARTIAL_KEY)) {
326  case OBJ_KEY:
327  key = obj;
328  return ast_str_hash(key);
329  case OBJ_PARTIAL_KEY:
330  ast_assert(0);
331  return 0;
332  default:
333  entry = obj;
334  return ast_str_hash(entry->name);
335  }
336 }
337 
338 static int parking_lot_cfg_cmp_fn(void *obj, void *arg, const int flags)
339 {
340  struct parking_lot_cfg *entry1 = obj;
341 
342  char *key;
343  size_t key_size;
344  struct parking_lot_cfg *entry2;
345 
346  switch (flags & (OBJ_POINTER | OBJ_KEY | OBJ_PARTIAL_KEY)) {
347  case OBJ_KEY:
348  key = arg;
349  return (!strcmp(entry1->name, key)) ? CMP_MATCH : 0;
350  case OBJ_PARTIAL_KEY:
351  key = arg;
352  key_size = strlen(key);
353  return (!strncmp(entry1->name, key, key_size)) ? CMP_MATCH : 0;
354  case OBJ_POINTER:
355  entry2 = arg;
356  return (!strcmp(entry1->name, entry2->name)) ? CMP_MATCH : 0;
357  default:
358  return CMP_STOP;
359  }
360 }
361 
362 /*! \brief destructor for parking_config */
363 static void parking_config_destructor(void *obj)
364 {
365  struct parking_config *cfg = obj;
367  ao2_cleanup(cfg->global);
368 }
369 
370 /*! \brief destructor for parking_global_config */
371 static void parking_global_config_destructor(void *obj)
372 {
373  /* For now, do nothing. */
374 }
375 
376 /*! \brief allocator callback for parking_config. Notice it returns void * since it is only used by the backend config code */
377 static void *parking_config_alloc(void)
378 {
379  RAII_VAR(struct parking_config *, cfg, NULL, ao2_cleanup);
380 
381  if (!(cfg = ao2_alloc(sizeof(*cfg), parking_config_destructor))) {
382  return NULL;
383  }
384 
385  cfg->parking_lots = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_MUTEX, 0, 37,
387  if (!cfg->parking_lots) {
388  return NULL;
389  }
390 
391  if (!(cfg->global = ao2_alloc(sizeof(*cfg->global), parking_global_config_destructor))) {
392  return NULL;
393  }
394 
395  /* Bump the ref count since RAII_VAR is going to eat one */
396  ao2_ref(cfg, +1);
397  return cfg;
398 }
399 
401 {
402  if (lot->mode != PARKINGLOT_DISABLED) {
403  return -1;
404  }
405 
406  if (!ao2_container_count(lot->parked_users)) {
407  ao2_unlink(parking_lot_container, lot);
408  return 0;
409  }
410 
411  return -1;
412 }
413 
414 static void parking_lot_disable(struct parking_lot *lot)
415 {
416  /* If a dynamic lot wasn't removed, we need to restore it to full functionality afterwards. */
417  int was_dynamic = (lot->mode == PARKINGLOT_DYNAMIC);
418 
419  lot->mode = PARKINGLOT_DISABLED;
420  if (parking_lot_remove_if_unused(lot) && was_dynamic) {
421  lot->mode = PARKINGLOT_DYNAMIC;
422  lot->disable_mark = 0;
423  }
424 }
425 
426 /*! \brief Destroy a parking lot cfg object */
427 static void parking_lot_cfg_destructor(void *obj)
428 {
429  struct parking_lot_cfg *lot_cfg = obj;
432 }
433 
434 /* The arg just needs to have the parking space with it */
435 static int parked_user_cmp_fn(void *obj, void *arg, int flags)
436 {
437  int *search_space = arg;
438  struct parked_user *user = obj;
439  int object_space = user->parking_space;
440 
441  if (*search_space == object_space) {
442  return CMP_MATCH;
443  }
444  return 0;
445 }
446 
447 static int parked_user_sort_fn(const void *obj_left, const void *obj_right, int flags)
448 {
449  const struct parked_user *left = obj_left;
450  const struct parked_user *right = obj_right;
451 
452  return left->parking_space - right->parking_space;
453 }
454 
455 /*!
456  * \brief create a parking lot structure
457  * \param cat name given to the parking lot
458  * \retval NULL failure
459  * \retval non-NULL successfully allocated parking lot
460  */
461 static void *parking_lot_cfg_alloc(const char *cat)
462 {
463  struct parking_lot_cfg *lot_cfg;
464 
465  lot_cfg = ao2_alloc(sizeof(*lot_cfg), parking_lot_cfg_destructor);
466  if (!lot_cfg) {
467  return NULL;
468  }
469 
470  if (ast_string_field_init(lot_cfg, 32)) {
471  ao2_cleanup(lot_cfg);
472  return NULL;
473  }
474 
475  ast_string_field_set(lot_cfg, name, cat);
476 
477  return lot_cfg;
478 }
479 
480 #if defined(TEST_FRAMEWORK)
481 struct parking_lot_cfg *parking_lot_cfg_create(const char *cat)
482 {
483  return parking_lot_cfg_alloc(cat);
484 }
485 #endif
486 
487 /*!
488  * XXX This is actually incredibly generic and might be better placed in something like astobj2 if there isn't already an equivalent
489  * \brief find an item in a container by its name
490  *
491  * \param container ao2container where we want the item from
492  * \param key name of the item wanted to be found
493  *
494  * \retval pointer to the parking lot if available. NULL if not found.
495  */
496 static void *named_item_find(struct ao2_container *container, const char *name)
497 {
498  return ao2_find(container, name, OBJ_KEY);
499 }
500 
501 /*!
502  * \brief Custom field handler for parking positions
503  */
504 static int option_handler_parkpos(const struct aco_option *opt, struct ast_variable *var, void *obj)
505 {
506  struct parking_lot_cfg *lot_cfg = obj;
507  int low;
508  int high;
509 
510  if (sscanf(var->value, "%30d-%30d", &low, &high) != 2) {
511  ast_log(LOG_WARNING, "Format for parking positions is a-b, where a and b are numbers\n");
512  } else if (high < low || low <= 0 || high <= 0) {
513  ast_log(LOG_WARNING, "Format for parking positions is a-b, where a <= b\n");
514  } else {
515  lot_cfg->parking_start = low;
516  lot_cfg->parking_stop = high;
517  return 0;
518  }
519  return -1;
520 }
521 
522 /*!
523  * \brief Custom field handler for the findslot option
524  */
525 static int option_handler_findslot(const struct aco_option *opt, struct ast_variable *var, void *obj)
526 {
527  struct parking_lot_cfg *lot_cfg = obj;
528 
529  if (!strcmp(var->value, "first")) {
530  lot_cfg->parkfindnext = 0;
531  } else if (!strcmp(var->value, "next")) {
532  lot_cfg->parkfindnext = 1;
533  } else {
534  ast_log(LOG_WARNING, "value '%s' is not valid for findslot option.\n", var->value);
535  return -1;
536  }
537 
538  return 0;
539 }
540 
541 /*!
542  * \brief Maps string values for option_handler_parkedfeature to their ENUM values
543  */
544 static int parking_feature_flag_cfg(int *param, const char *var)
545 {
546  if (ast_false(var)) {
547  *param = 0;
548  } else if (!strcasecmp(var, "both")) {
549  *param = AST_FEATURE_FLAG_BYBOTH;
550  } else if (!strcasecmp(var, "caller")) {
551  *param = AST_FEATURE_FLAG_BYCALLER;
552  } else if (!strcasecmp(var, "callee")) {
553  *param = AST_FEATURE_FLAG_BYCALLEE;
554  } else {
555  return -1;
556  }
557 
558  return 0;
559 }
560 
561 /*!
562  * \brief Custom field handler for feature mapping on parked call pickup options
563  */
564 static int option_handler_parkedfeature(const struct aco_option *opt, struct ast_variable *var, void *obj)
565 {
566  struct parking_lot_cfg *cfg = obj;
568  int *parameter = NULL;
569 
570  switch (option) {
571  case OPT_PARKEDPLAY:
572  parameter = &cfg->parkedplay;
573  break;
574  case OPT_PARKEDTRANSFERS:
575  parameter = &cfg->parkedcalltransfers;
576  break;
577  case OPT_PARKEDREPARKING:
578  parameter = &cfg->parkedcallreparking;
579  break;
580  case OPT_PARKEDHANGUP:
581  parameter = &cfg->parkedcallhangup;
582  break;
583  case OPT_PARKEDRECORDING:
584  parameter = &cfg->parkedcallrecording;
585  break;
586  }
587 
588  ast_assert(parameter != NULL);
589  if (!parameter || parking_feature_flag_cfg(parameter, var->value)) {
590  return -1;
591  }
592 
593  return 0;
594 }
595 
597 {
598  return parking_lot_container;
599 }
600 
601 struct parking_lot *parking_lot_find_by_name(const char *lot_name)
602 {
603  struct parking_lot *lot = named_item_find(parking_lot_container, lot_name);
604  return lot;
605 }
606 
608 {
609  const char *name;
610 
611  /* The channel variable overrides everything */
612  name = pbx_builtin_getvar_helper(chan, "PARKINGLOT");
613  if (ast_strlen_zero(name)) {
614  /* Try the channel's parking lot. */
615  name = ast_channel_parkinglot(chan);
616  if (ast_strlen_zero(name)) {
617  /* Fall back to the default parking lot. */
618  name = DEFAULT_PARKING_LOT;
619  }
620  }
621 
622  return name;
623 }
624 
625 static void parking_lot_destructor(void *obj)
626 {
627  struct parking_lot *lot = obj;
628 
629  if (lot->parking_bridge) {
631  }
633  ao2_cleanup(lot->cfg);
635 }
636 
637 static struct parking_lot *alloc_new_parking_lot(struct parking_lot_cfg *lot_cfg)
638 {
639  struct parking_lot *lot;
640  if (!(lot = ao2_alloc(sizeof(*lot), parking_lot_destructor))) {
641  return NULL;
642  }
643 
644  if (ast_string_field_init(lot, 32)) {
645  return NULL;
646  }
647 
648  /* Create parked user ordered list */
653 
654  if (!lot->parked_users) {
655  ao2_cleanup(lot);
656  return NULL;
657  }
658 
659  ast_string_field_set(lot, name, lot_cfg->name);
660  return lot;
661 }
662 
664 {
665  if (!ast_strlen_zero(lot_cfg->registrar)) {
666  /* Although the function is called ast_context_destroy, the use of this funtion is
667  * intended only to remove extensions, hints, etc registered by the parking lot's registrar.
668  * It won't actually destroy the context unless that context is empty afterwards and it is
669  * unreferenced.
670  */
672  }
673 
674  /* If we come back for a second pass, someone else has this registrar now. */
675  ast_string_field_set(lot_cfg, registrar, "");
676 }
677 
679 {
681  struct parking_lot_cfg *lot_cfg;
682  struct ao2_iterator iter;
683 
684  if (!cfg) {
685  return;
686  }
687 
688  for (iter = ao2_iterator_init(cfg->parking_lots, 0); (lot_cfg = ao2_iterator_next(&iter)); ao2_ref(lot_cfg, -1)) {
690  }
691 
693 
694  ao2_iterator_destroy(&iter);
695 }
696 
697 /*!
698  * \internal
699  * \since 12
700  * \brief Create an extension using ast_add_extension2_nolock. This function automatically allocates a duplicate
701  * of the data string so that whatever calls it doesn't have to deal with freeing it if the ast_add_extension2_nolock
702  * fails.
703  *
704  * \param context a write locked ast_context. Make certain it is write locked prior to calling this function
705  * \param replace whether the extension should replace existing extensions
706  * \param extension name of the extension desired
707  * \param priority priority of the extension we are registering
708  * \param application name of the application being used for the extension
709  * \param data application arguments
710  * \param registrar name of the registrar you should use for the extension.
711  * Make sure this string doesn't go anywhere while there are still extensions using it.
712  */
713 static int parking_add_extension(struct ast_context *context, int replace, const char *extension,
714  int priority, const char *application, const char *data, const char *registrar)
715 {
716  char *data_duplicate = ast_strdup(data);
717 
718  if (!data_duplicate) {
719  return -1;
720  }
721 
722  if (ast_add_extension2_nolock(context, replace, extension, priority, NULL, NULL,
723  application, data_duplicate, ast_free_ptr, registrar, NULL, 0)) {
724  return -1;
725  }
726 
727  return 0;
728 }
729 
730 static int extension_is_compatible(struct parking_lot_cfg *lot_cfg, const char *app_type, struct ast_exten *extension)
731 {
732  const char *extension_registrar = ast_get_extension_registrar(extension);
733  const char *extension_context = ast_get_context_name(ast_get_extension_context(extension));
734  const char *extension_name = ast_get_extension_name(extension);
735  const char *extension_application = ast_get_extension_app(extension);
736 
737  ast_assert(extension_registrar && extension_context && extension_name && extension_application);
738 
739  if (strcmp(extension_registrar, BASE_REGISTRAR)) {
740  ast_log(LOG_ERROR, "Parking lot '%s' -- Needs an extension '%s@%s', but that extension is already owned by %s.\n",
741  lot_cfg->name, extension_name, extension_context, extension_registrar);
742  return 0;
743  }
744 
745  if (strcmp(extension_application, app_type)) {
746  ast_log(LOG_ERROR, "Parking lot '%s' -- Needs an extension '%s@%s' with a non-exclusive %s application, "
747  "but a/an %s application is already registered to that extension by %s.\n",
748  lot_cfg->name, extension_name, extension_context, app_type,
749  extension_application, BASE_REGISTRAR);
750  return 0;
751  }
752 
753  ast_debug(3, "Parking lot '%s' -- extension '%s@%s' with application %s is compatible.\n",
754  lot_cfg->name, extension_name, extension_context, app_type);
755  return 1;
756 }
757 
759 {
760  int parkingspace;
761  struct ast_exten *existing_exten;
762  struct ast_context *lot_context;
763  struct pbx_find_info find_info = { .stacklen = 0 }; /* the rest is reset in pbx_find_extension */
764  const char *parkext_registrar_pointer; /* Used for park extension */
765  const char *parkedcall_registrar_pointer; /* Used for parkedcall extensions/hints */
766 
767  if (ast_strlen_zero(lot_cfg->parkext)) {
768  return 0;
769  }
770 
771  ast_string_field_build(lot_cfg, registrar, "%s/%s", BASE_REGISTRAR, lot_cfg->name);
772  parkedcall_registrar_pointer = lot_cfg->registrar;
773 
774  if (lot_cfg->parkext_exclusive) {
775  parkext_registrar_pointer = lot_cfg->registrar;
776  } else {
777  parkext_registrar_pointer = BASE_REGISTRAR;
778  }
779 
780  /* We need the contexts list locked to safely be able to both read and lock the specific context within */
782 
783  if (!(lot_context = ast_context_find_or_create(NULL, NULL, lot_cfg->parking_con, parkext_registrar_pointer))) {
784  ast_log(LOG_ERROR, "Parking lot '%s' -- Needs a context '%s' which does not exist and Asterisk was unable to create\n",
785  lot_cfg->name, lot_cfg->parking_con);
787  return -1;
788  }
789 
790  /* Once we know what context we will be modifying, we need to write lock it because we will be reading extensions
791  * and we don't want something else to destroy them while we are looking at them.
792  */
793  ast_wrlock_context(lot_context);
794 
796 
797  /* Handle generation/confirmation for the Park extension */
798  if ((existing_exten = pbx_find_extension(NULL, NULL, &find_info, lot_cfg->parking_con, lot_cfg->parkext, 1, NULL, NULL, E_MATCH))) {
799  if (lot_cfg->parkext_exclusive || !extension_is_compatible(lot_cfg, PARK_APPLICATION, existing_exten)) {
800  ast_unlock_context(lot_context);
801  return -1;
802  }
803  } else if (parking_add_extension(lot_context, 0, lot_cfg->parkext, 1, PARK_APPLICATION,
804  lot_cfg->parkext_exclusive ? lot_cfg->name : "", parkext_registrar_pointer)) {
805  ast_log(LOG_ERROR, "Parking lot '%s' -- Failed to add %s extension '%s@%s' to the PBX.\n",
806  lot_cfg->name, PARK_APPLICATION, lot_cfg->parkext, lot_cfg->parking_con);
807  ast_unlock_context(lot_context);
808  return -1;
809  }
810 
811  /* Handle generation/confirmation for the ParkedCall extensions and hints */
812  for (parkingspace = lot_cfg->parking_start; parkingspace <= lot_cfg->parking_stop; parkingspace++) {
813  char space[AST_MAX_EXTENSION];
814  RAII_VAR(struct ast_str *, arguments_string, NULL, ast_free);
815  find_info.stacklen = 0; /* reset for pbx_find_exten */
816 
817  snprintf(space, sizeof(space), "%d", parkingspace);
818 
819  /* Unlike the Park extensions, ParkedCall extensions and their hints may never be shared for any reason. */
820  if ((existing_exten = pbx_find_extension(NULL, NULL, &find_info, lot_cfg->parking_con, space, 1, NULL, NULL, E_MATCH))) {
821  ast_unlock_context(lot_context);
822  return -1;
823  }
824 
825  arguments_string = ast_str_create(32);
826  if (!arguments_string) {
827  ast_unlock_context(lot_context);
828  return -1;
829  }
830 
831  ast_str_set(&arguments_string, 0, "%s,%s", lot_cfg->name, space);
832  if (parking_add_extension(lot_context, 0, space, 1, PARKED_CALL_APPLICATION,
833  ast_str_buffer(arguments_string), parkedcall_registrar_pointer)) {
834  ast_log(LOG_ERROR, "Parking lot '%s' -- Failed to add %s extension '%s@%s' to the PBX.\n",
835  lot_cfg->name, PARKED_CALL_APPLICATION, space, lot_cfg->parking_con);
836  ast_unlock_context(lot_context);
837  return -1;
838  }
839 
840  find_info.stacklen = 0; /* reset for pbx_find_exten */
841 
842  if (lot_cfg->parkaddhints) {
843  char hint_device[AST_MAX_EXTENSION];
844 
845  snprintf(hint_device, sizeof(hint_device), "park:%s@%s", space, lot_cfg->parking_con);
846 
847  if ((existing_exten = pbx_find_extension(NULL, NULL, &find_info, lot_cfg->parking_con, space, PRIORITY_HINT, NULL, NULL, E_MATCH))) {
848  ast_log(LOG_ERROR, "Parking lot '%s' -- Needs to add a hint '%s' at '%s@%s' but one already exists owned by %s\n",
849  lot_cfg->name, hint_device, space, lot_cfg->parking_con, ast_get_extension_registrar(existing_exten));
850  ast_unlock_context(lot_context);
851  return -1;
852  }
853 
854  if (parking_add_extension(lot_context, 0, space, PRIORITY_HINT, hint_device, "", parkedcall_registrar_pointer)) {
855  ast_log(LOG_ERROR, "Parking lot '%s' -- Failed to add hint '%s@%s' to the PBX.\n",
856  lot_cfg->name, space, lot_cfg->parking_con);
857  ast_unlock_context(lot_context);
858  return -1;
859  }
860  }
861  }
862 
863  ast_unlock_context(lot_context);
864 
865  return 0;
866 }
867 
868 struct parking_lot *parking_lot_build_or_update(struct parking_lot_cfg *lot_cfg, int dynamic)
869 {
870  struct parking_lot *lot;
871  struct parking_lot_cfg *replaced_cfg = NULL;
872  int found = 0;
873 
874  /* Start by trying to find it. If that works we can skip the rest. */
875  lot = named_item_find(parking_lot_container, lot_cfg->name);
876  if (!lot) {
877  lot = alloc_new_parking_lot(lot_cfg);
878 
879  /* If we still don't have a lot, we failed to alloc one. */
880  if (!lot) {
881  return NULL;
882  }
883  } else {
884  found = 1;
885 
886  if (dynamic) {
887  ast_log(LOG_ERROR, "Tried to create dynamic parking lot with name '%s' but a lot with that name already exists.\n", lot_cfg->name);
888  ao2_cleanup(lot);
889  return NULL;
890  }
891  }
892 
893  /* Set the configuration reference. Unref the one currently in the lot if it's there. */
894  if (lot->cfg) {
895  replaced_cfg = lot->cfg;
896  }
897 
898  ao2_ref(lot_cfg, +1);
899  lot->cfg = lot_cfg;
900 
901  ao2_cleanup(replaced_cfg);
902 
903  /* Set the operating mode to normal since the parking lot has a configuration. */
904  lot->disable_mark = 0;
905  lot->mode = dynamic ? PARKINGLOT_DYNAMIC : PARKINGLOT_NORMAL;
906 
907  if (!found) {
908  /* Link after configuration is set since a lot without configuration will cause all kinds of trouble. */
909  ao2_link(parking_lot_container, lot);
910  };
911 
912  return lot;
913 }
914 
916 {
918  struct parking_lot_cfg *lot_cfg;
919  struct ao2_iterator iter;
920 
921  iter = ao2_iterator_init(cfg->parking_lots, 0);
922  for (; (lot_cfg = ao2_iterator_next(&iter)); ao2_ref(lot_cfg, -1)) {
924  }
925  ao2_iterator_destroy(&iter);
926 }
927 
929 {
931 
932  if (!cfg) {
933  return 0;
934  }
935 
936  return cfg->global->parkeddynamic;
937 }
938 
939 static struct parking_lot_cfg *clone_parkinglot_cfg(struct parking_lot_cfg *source, const char *name)
940 {
941  struct parking_lot_cfg *cfg = parking_lot_cfg_alloc(name);
942 
943  if (!cfg) {
944  return NULL;
945  }
946 
947  ast_string_fields_copy(cfg, source);
948 
949  /* Needs to be reset after being copied */
950  ast_string_field_set(cfg, name, name);
951 
952  /* Stuff that should be cloned that isn't hit by string field copy */
953  cfg->parking_start = source->parking_start;
954  cfg->parking_stop = source->parking_stop;
955  cfg->parkingtime = source->parkingtime;
956  cfg->comebackdialtime = source->comebackdialtime;
957  cfg->parkfindnext = source->parkfindnext;
958  cfg->parkext_exclusive = source->parkext_exclusive;
959  cfg->parkaddhints = source->parkaddhints;
960  cfg->comebacktoorigin = source->comebacktoorigin;
961  cfg->parkedplay = source->parkedplay;
964  cfg->parkedcallhangup = source->parkedcallhangup;
966 
967  return cfg;
968 }
969 
970 static struct parking_lot *create_dynamic_lot_full(const char *name, struct ast_channel *chan, int forced)
971 {
973  RAII_VAR(struct parking_lot *, template_lot, NULL, ao2_cleanup);
974 
975  struct parking_lot *lot;
976  const char *dyn_context;
977  const char *dyn_exten;
978  const char *dyn_range;
979  const char *template_name;
980  const char *chan_template_name;
981  int dyn_start;
982  int dyn_end;
983 
984  if (!forced && !parking_dynamic_lots_enabled()) {
985  return NULL;
986  }
987 
988  ast_channel_lock(chan);
989  chan_template_name = ast_strdupa(S_OR(pbx_builtin_getvar_helper(chan, "PARKINGDYNAMIC"), ""));
990  dyn_context = ast_strdupa(S_OR(pbx_builtin_getvar_helper(chan, "PARKINGDYNCONTEXT"), ""));
991  dyn_exten = ast_strdupa(S_OR(pbx_builtin_getvar_helper(chan, "PARKINGDYNEXTEN"), ""));
992  dyn_range = ast_strdupa(S_OR(pbx_builtin_getvar_helper(chan, "PARKINGDYNPOS"), ""));
993  ast_channel_unlock(chan);
994 
995  template_name = S_OR(chan_template_name, DEFAULT_PARKING_LOT);
996 
997  template_lot = parking_lot_find_by_name(template_name);
998  if (!template_lot) {
999  ast_log(LOG_ERROR, "Lot %s does not exist. Can not use it as a dynamic parking lot template.\n",
1000  template_name);
1001  return NULL;
1002  }
1003 
1004  cfg = clone_parkinglot_cfg(template_lot->cfg, name);
1005 
1006  if (!cfg) {
1007  ast_log(LOG_ERROR, "Failed to allocate dynamic parking lot configuration.\n");
1008  return NULL;
1009  }
1010 
1011  if (!ast_strlen_zero(dyn_exten)) {
1012  ast_string_field_set(cfg, parkext, dyn_exten);
1013  }
1014 
1015  if (!ast_strlen_zero(dyn_context)) {
1016  ast_string_field_set(cfg, parking_con, dyn_context);
1017  }
1018 
1019  if (!ast_strlen_zero(dyn_range)) {
1020  if (sscanf(dyn_range, "%30d-%30d", &dyn_start, &dyn_end) != 2) {
1022  "Invalid parking range %s specified in PARKINGDYNPOS: could not parse minimum/maximum parking space range\n", dyn_range);
1023  return NULL;
1024  }
1025  if (dyn_end < dyn_start || dyn_start < 0) {
1027  "Invalid parking range %s specified for PARKINGDYNPOS: end parking space must be greater than starting parking space.\n", dyn_range);
1028  return NULL;
1029  }
1030 
1031  cfg->parking_start = dyn_start;
1032  cfg->parking_stop = dyn_end;
1033  }
1034 
1036  ast_log(LOG_ERROR, "Extensions for dynamic parking lot '%s' could not be registered. Dynamic lot creation failed.\n", name);
1037  return NULL;
1038  }
1039 
1040  ao2_lock(parking_lot_container);
1041 
1042  if ((lot = parking_lot_find_by_name(name))) {
1043  ao2_unlock(parking_lot_container);
1044  ast_log(LOG_ERROR, "Started creating dynamic parking lot '%s', but a parking lot with that name already exists.\n", name);
1045  ao2_ref(lot, -1);
1046  return NULL;
1047  }
1048 
1049  lot = parking_lot_build_or_update(cfg, 1);
1050  ao2_unlock(parking_lot_container);
1051 
1052  if (!lot) {
1053  ast_log(LOG_NOTICE, "Failed to build dynamic parking lot '%s'\n", name);
1054  }
1055 
1056  return lot;
1057 }
1058 
1059 struct parking_lot *parking_create_dynamic_lot(const char *name, struct ast_channel *chan){
1060  return create_dynamic_lot_full(name, chan, 0);
1061 }
1062 
1063 #if defined(TEST_FRAMEWORK)
1064 struct parking_lot *parking_create_dynamic_lot_forced(const char *name, struct ast_channel *chan) {
1065  return create_dynamic_lot_full(name, chan, 1);
1066 }
1067 #endif
1068 
1069 /* Preapply */
1070 
1072 {
1073  struct parking_config *cfg = aco_pending_config(&cfg_info);
1074  RAII_VAR(struct parking_lot_cfg *, lot_cfg, NULL, ao2_cleanup);
1075 
1076  if (!cfg) {
1077  return 0;
1078  }
1079 
1081  if (!lot_cfg) {
1083  if (!lot_cfg) {
1084  return -1;
1085  }
1086  ast_log(AST_LOG_NOTICE, "Adding %s profile to res_parking\n", DEFAULT_PARKING_LOT);
1087  aco_set_defaults(&parking_lot_type, DEFAULT_PARKING_LOT, lot_cfg);
1088  ast_string_field_set(lot_cfg, parkext, DEFAULT_PARKING_EXTEN);
1089  ao2_link(cfg->parking_lots, lot_cfg);
1090  }
1091 
1092  return 0;
1093 }
1094 
1096 {
1097  struct parking_lot_cfg *lot_cfg;
1098  struct ao2_iterator iter;
1099 
1100  for (iter = ao2_iterator_init(cfg_pending->parking_lots, 0); (lot_cfg = ao2_iterator_next(&iter)); ao2_ref(lot_cfg, -1)) {
1102  }
1103 
1104  ao2_iterator_destroy(&iter);
1105 
1107 
1108 }
1109 
1111 {
1112  struct parking_config *cfg = aco_pending_config(&cfg_info);
1113  struct ao2_iterator iter;
1114  RAII_VAR(struct parking_lot_cfg *, lot_cfg, NULL, ao2_cleanup);
1115  int res = 0;
1116 
1117  if (!cfg) {
1118  return 0;
1119  }
1120 
1121  /* Clear existing extensions */
1123 
1124  /* Attempt to build new extensions for each lot */
1125  for (iter = ao2_iterator_init(cfg->parking_lots, 0); (lot_cfg = ao2_iterator_next(&iter)); ao2_ref(lot_cfg, -1)) {
1126  if (parking_lot_cfg_create_extensions(lot_cfg)) {
1127  ao2_cleanup(lot_cfg);
1128  lot_cfg = NULL;
1129  res = -1;
1130  break;
1131  }
1132  }
1133  ao2_iterator_destroy(&iter);
1134 
1135  if (res) {
1137  ast_log(LOG_ERROR, "Extension registration failed. Previously configured lot extensions were removed and can not be safely restored.\n");
1138  }
1139 
1140  return res;
1141 }
1142 
1143 static void mark_lots_as_disabled(void)
1144 {
1145  struct ao2_iterator iter;
1146  struct parking_lot *lot;
1147 
1148  for (iter = ao2_iterator_init(parking_lot_container, 0); (lot = ao2_iterator_next(&iter)); ao2_ref(lot, -1)) {
1149  lot->disable_mark = 1;
1150  }
1151 
1152  ao2_iterator_destroy(&iter);
1153 }
1154 
1155 static int config_parking_preapply(void)
1156 {
1158 
1160  return -1;
1161  }
1162 
1164  return -1;
1165  }
1166 
1167  return 0;
1168 }
1169 
1170 static void disable_marked_lots(void)
1171 {
1172  struct ao2_iterator iter;
1173  struct parking_lot *lot;
1174 
1175  for (iter = ao2_iterator_init(parking_lot_container, 0); (lot = ao2_iterator_next(&iter)); ao2_ref(lot, -1)) {
1176  if (lot->disable_mark) {
1177  parking_lot_disable(lot);
1178  }
1179  }
1180 
1181  ao2_iterator_destroy(&iter);
1182 }
1183 
1185 {
1188 }
1189 
1190 static int unload_module(void)
1191 {
1199  ao2_cleanup(parking_lot_container);
1200  parking_lot_container = NULL;
1201  aco_info_destroy(&cfg_info);
1203 
1204  return 0;
1205 }
1206 
1207 static int load_module(void)
1208 {
1209  parking_lot_container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_MUTEX,
1212  NULL);
1213  if (!parking_lot_container) {
1214  goto error;
1215  }
1216 
1217  if (aco_info_init(&cfg_info)) {
1218  goto error;
1219  }
1220 
1221  /* Global options */
1222  aco_option_register(&cfg_info, "parkeddynamic", ACO_EXACT, global_options, "no", OPT_BOOL_T, 1, FLDSET(struct parking_global_config, parkeddynamic));
1223 
1224  /* Register the per parking lot options. */
1225  aco_option_register(&cfg_info, "parkext", ACO_EXACT, parking_lot_types, "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct parking_lot_cfg, parkext));
1226  aco_option_register(&cfg_info, "context", ACO_EXACT, parking_lot_types, "parkedcalls", OPT_STRINGFIELD_T, 0, STRFLDSET(struct parking_lot_cfg, parking_con));
1227  aco_option_register(&cfg_info, "parkingtime", ACO_EXACT, parking_lot_types, "45", OPT_UINT_T, 0, FLDSET(struct parking_lot_cfg, parkingtime));
1228  aco_option_register(&cfg_info, "comebacktoorigin", ACO_EXACT, parking_lot_types, "yes", OPT_BOOL_T, 1, FLDSET(struct parking_lot_cfg, comebacktoorigin));
1229  aco_option_register(&cfg_info, "comebackcontext", ACO_EXACT, parking_lot_types, "parkedcallstimeout", OPT_STRINGFIELD_T, 0, STRFLDSET(struct parking_lot_cfg, comebackcontext));
1230  aco_option_register(&cfg_info, "comebackdialtime", ACO_EXACT, parking_lot_types, "30", OPT_UINT_T, 0, FLDSET(struct parking_lot_cfg, comebackdialtime));
1231  aco_option_register(&cfg_info, "parkedmusicclass", ACO_EXACT, parking_lot_types, "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct parking_lot_cfg, mohclass));
1232  aco_option_register(&cfg_info, "parkext_exclusive", ACO_EXACT, parking_lot_types, "no", OPT_BOOL_T, 1, FLDSET(struct parking_lot_cfg, parkext_exclusive));
1233  aco_option_register(&cfg_info, "parkinghints", ACO_EXACT, parking_lot_types, "no", OPT_BOOL_T, 1, FLDSET(struct parking_lot_cfg, parkaddhints));
1234  aco_option_register(&cfg_info, "courtesytone", ACO_EXACT, parking_lot_types, "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct parking_lot_cfg, courtesytone));
1235 
1236  /* More complicated parking lot options that require special handling */
1237  aco_option_register_custom(&cfg_info, "parkpos", ACO_EXACT, parking_lot_types, "701-750", option_handler_parkpos, 0);
1238  aco_option_register_custom(&cfg_info, "findslot", ACO_EXACT, parking_lot_types, "first", option_handler_findslot, 0);
1239  aco_option_register_custom(&cfg_info, "parkedplay", ACO_EXACT, parking_lot_types, "caller", option_handler_parkedfeature, OPT_PARKEDPLAY);
1240  aco_option_register_custom(&cfg_info, "parkedcalltransfers", ACO_EXACT, parking_lot_types, "no", option_handler_parkedfeature, OPT_PARKEDTRANSFERS);
1241  aco_option_register_custom(&cfg_info, "parkedcallreparking", ACO_EXACT, parking_lot_types, "no", option_handler_parkedfeature, OPT_PARKEDREPARKING);
1242  aco_option_register_custom(&cfg_info, "parkedcallhangup", ACO_EXACT, parking_lot_types, "no", option_handler_parkedfeature, OPT_PARKEDHANGUP);
1243  aco_option_register_custom(&cfg_info, "parkedcallrecording", ACO_EXACT, parking_lot_types, "no", option_handler_parkedfeature, OPT_PARKEDRECORDING);
1244 
1245  if (aco_process_config(&cfg_info, 0) == ACO_PROCESS_ERROR) {
1246  goto error;
1247  }
1248 
1249  if (load_parking_applications()) {
1250  goto error;
1251  }
1252 
1253  if (load_parking_ui()) {
1254  goto error;
1255  }
1256 
1257  if (load_parking_manager()) {
1258  goto error;
1259  }
1260 
1262  goto error;
1263  }
1264 
1265  if (load_parking_devstate()) {
1266  goto error;
1267  }
1268 
1269  if (load_parking_tests()) {
1270  goto error;
1271  }
1272 
1273  return AST_MODULE_LOAD_SUCCESS;
1274 
1275 error:
1276  unload_module();
1277  return AST_MODULE_LOAD_DECLINE;
1278 }
1279 
1280 static int reload_module(void)
1281 {
1282  if (aco_process_config(&cfg_info, 1) == ACO_PROCESS_ERROR) {
1283  return AST_MODULE_LOAD_DECLINE;
1284  }
1285 
1286  return 0;
1287 }
1288 
1289 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Call Parking Resource",
1290  .support_level = AST_MODULE_SUPPORT_CORE,
1291  .load = load_module,
1292  .unload = unload_module,
1293  .reload = reload_module,
1294  .load_pri = AST_MODPRI_DEVSTATE_PROVIDER,
1295 );
parked_call_feature_options
Definition: res_parking.h:48
static void remove_pending_parking_lot_extensions(struct parking_config *cfg_pending)
Definition: res_parking.c:1095
static void disable_marked_lots(void)
Definition: res_parking.c:1170
#define DEFAULT_PARKING_LOT
Definition: res_parking.h:34
int ast_unlock_context(struct ast_context *con)
Definition: pbx.c:8530
static int unload_module(void)
Definition: res_parking.c:1190
#define ast_channel_lock(chan)
Definition: channel.h:2913
Main Channel structure associated with a channel.
static const char name[]
Definition: format_mp3.c:68
int load_parking_manager(void)
Register manager actions and setup subscriptions for stasis events.
Asterisk main include file. File version handling, generic pbx functions.
ast_exten: An extension The dialplan is saved as a linked list with each context having it&#39;s own link...
Definition: pbx.c:237
unsigned int comebackdialtime
Definition: res_parking.h:70
int ao2_container_count(struct ao2_container *c)
Returns the number of elements in a container.
CONFIG_INFO_STANDARD(cfg_info, globals, parking_config_alloc,.files=ACO_FILES(&parking_lot_conf),.pre_apply_config=config_parking_preapply,.post_apply_config=link_configured_disable_marked_lots,)
static void parking_global_config_destructor(void *obj)
destructor for parking_global_config
Definition: res_parking.c:371
const char * ast_get_extension_registrar(struct ast_exten *e)
Definition: pbx.c:8571
const char * ast_get_context_name(struct ast_context *con)
Definition: ael_main.c:421
int parkedcallreparking
Definition: res_parking.h:77
static struct aco_type global
Definition: test_config.c:1445
struct aco_type * global_options[]
Definition: res_parking.c:293
struct parking_lot * parking_create_dynamic_lot(const char *name, struct ast_channel *chan)
Create a dynamic parking lot.
Definition: res_parking.c:1059
#define aco_option_register_custom(info, name, matchtype, types, default_val, handler, flags)
Register a config option.
static int parking_lot_cfg_cmp_fn(void *obj, void *arg, const int flags)
Definition: res_parking.c:338
unsigned int aco_option_get_flags(const struct aco_option *option)
Read the flags of a config option - useful when using a custom callback for a config option...
void unload_parking_ui(void)
Unregister CLI commands.
Definition: parking_ui.c:203
static int reload(void)
void unload_parking_applications(void)
Unregister parking applications.
static int verify_default_parking_lot(void)
Definition: res_parking.c:1071
static struct parking_lot * create_dynamic_lot_full(const char *name, struct ast_channel *chan, int forced)
Definition: res_parking.c:970
#define OBJ_KEY
Definition: astobj2.h:1155
struct parking_global_config * global
Definition: res_parking.c:281
static int parking_lot_sort_fn(const void *obj_left, const void *obj_right, int flags)
Definition: res_parking.c:244
#define BASE_REGISTRAR
Definition: res_parking.h:36
struct ast_bridge * parking_bridge
Definition: res_parking.h:94
#define OBJ_POINTER
Definition: astobj2.h:1154
#define LOG_WARNING
Definition: logger.h:274
char * ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition: strings.h:714
struct ao2_container * parked_users
Definition: res_parking.h:95
const char * ast_get_extension_app(struct ast_exten *e)
Definition: pbx.c:8596
int load_parking_tests(void)
Register parking unit tests.
#define aco_option_register(info, name, matchtype, types, default_val, opt_type, flags,...)
Register a config option.
unsigned int parkingtime
Definition: res_parking.h:69
#define ao2_container_alloc_list(ao2_options, container_options, sort_fn, cmp_fn)
Definition: astobj2.h:1335
Structure for variables, used for configurations and for channel variables.
#define var
Definition: ast_expr2f.c:614
int parking_lot_remove_if_unused(struct parking_lot *lot)
Remove a parking lot from the usable lists if it is no longer involved in any calls and no configurat...
Definition: res_parking.c:400
void parking_lot_cfg_remove_extensions(struct parking_lot_cfg *lot_cfg)
Remove extensions belonging to a parking lot configuration.
Definition: res_parking.c:663
static int configure_parking_extensions(void)
Definition: res_parking.c:1110
int ast_bridge_destroy(struct ast_bridge *bridge, int cause)
Destroy a bridge.
Definition: bridge.c:970
enum aco_process_status aco_process_config(struct aco_info *info, int reload)
Process a config info via the options registered with an aco_info.
#define ao2_global_obj_ref(holder)
Definition: astobj2.h:925
void ao2_iterator_destroy(struct ao2_iterator *iter)
Destroy a container iterator.
#define ast_assert(a)
Definition: utils.h:710
int ast_wrlock_contexts(void)
Write locks the context list.
Definition: pbx.c:8502
#define ao2_unlock(a)
Definition: astobj2.h:730
static int parking_feature_flag_cfg(int *param, const char *var)
Maps string values for option_handler_parkedfeature to their ENUM values.
Definition: res_parking.c:544
int load_parking_ui(void)
Register CLI commands.
Definition: parking_ui.c:198
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:243
static void * named_item_find(struct ao2_container *container, const char *name)
find an item in a container by its name
Definition: res_parking.c:496
int disable_mark
Definition: res_parking.h:98
#define NULL
Definition: resample.c:96
The representation of a single configuration file to be processed.
static int priority
enum aco_type_t type
void ast_free_ptr(void *ptr)
free() wrapper
Definition: astmm.c:1771
#define ACO_TYPES(...)
A helper macro to ensure that aco_info types always have a sentinel.
void unload_parking_bridge_features(void)
Unregister features registered by load_parking_bridge_features.
static int parked_user_sort_fn(const void *obj_left, const void *obj_right, int flags)
Definition: res_parking.c:447
const char * pbx_builtin_getvar_helper(struct ast_channel *chan, const char *name)
Return a pointer to the value of the corresponding channel variable.
#define OBJ_PARTIAL_KEY
Definition: astobj2.h:1156
Utility functions.
static int option_handler_findslot(const struct aco_option *opt, struct ast_variable *var, void *obj)
Custom field handler for the findslot option.
Definition: res_parking.c:525
int ast_str_set(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Set a dynamic string using variable arguments.
Definition: strings.h:1065
struct ao2_container * get_parking_lot_container(void)
Get a pointer to the parking lot container for purposes such as iteration.
Definition: res_parking.c:596
void unload_parking_devstate(void)
Unregister Parking devstate handler.
#define AST_LOG_NOTICE
Definition: logger.h:268
Configuration File Parser.
#define ast_debug(level,...)
Log a DEBUG message.
Definition: logger.h:444
#define ast_log
Definition: astobj2.c:42
static AO2_GLOBAL_OBJ_STATIC(globals)
#define FLDSET(type,...)
Convert a struct and list of fields to an argument list of field offsets.
const ast_string_field name
Definition: res_parking.h:89
int aco_info_init(struct aco_info *info)
Initialize an aco_info structure.
const ast_string_field parking_con
Definition: res_parking.h:89
int load_parking_bridge_features(void)
Register bridge features for parking.
void * aco_pending_config(struct aco_info *info)
Get pending config changes.
int parking_dynamic_lots_enabled(void)
Check global configuration to see if dynamic parking is enabled.
Definition: res_parking.c:928
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition: utils.h:911
Type for default option handler for unsigned integers.
#define ast_string_field_init(x, size)
Initialize a field pool and fields.
Definition: stringfields.h:353
unsigned int parkaddhints
Definition: res_parking.h:73
static int parked_user_cmp_fn(void *obj, void *arg, int flags)
Definition: res_parking.c:435
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65
struct parking_lot * parking_lot_find_by_name(const char *lot_name)
Find a parking lot based on its name.
Definition: res_parking.c:601
struct aco_type * parking_lot_types[]
Definition: res_parking.c:305
static struct ao2_container * parking_lot_container
Definition: res_parking.c:266
#define AST_MAX_EXTENSION
Definition: channel.h:135
const char * find_channel_parking_lot_name(struct ast_channel *chan)
Find parking lot name from channel.
Definition: res_parking.c:607
int parking_space
Definition: res_parking.h:107
structure to hold extensions
#define ao2_ref(o, delta)
Definition: astobj2.h:464
static int option_handler_parkedfeature(const struct aco_option *opt, struct ast_variable *var, void *obj)
Custom field handler for feature mapping on parked call pickup options.
Definition: res_parking.c:564
#define ao2_lock(a)
Definition: astobj2.h:718
static void mark_lots_as_disabled(void)
Definition: res_parking.c:1143
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: astmm.h:300
struct ao2_container * container
Definition: res_fax.c:502
static struct console_pvt globals
static void parking_lot_disable(struct parking_lot *lot)
Definition: res_parking.c:414
#define PRIORITY_HINT
Definition: pbx.h:54
static struct aco_type global_option
Definition: res_parking.c:285
Core PBX routines and definitions.
unsigned int comebacktoorigin
Definition: res_parking.h:74
struct ao2_container * parking_lots
Definition: res_parking.c:282
static void * parking_lot_cfg_alloc(const char *cat)
create a parking lot structure
Definition: res_parking.c:461
static void parking_config_destructor(void *obj)
destructor for parking_config
Definition: res_parking.c:363
static int parking_add_extension(struct ast_context *context, int replace, const char *extension, int priority, const char *application, const char *data, const char *registrar)
Definition: res_parking.c:713
Their was an error and no changes were applied.
int load_parking_applications(void)
Register parking applications.
The AMI - Asterisk Manager Interface - is a TCP protocol created to manage Asterisk with third-party ...
Configuration option-handling.
#define ast_string_fields_copy(copy, orig)
Copy all string fields from one instance to another of the same structure.
Definition: stringfields.h:627
#define LOG_ERROR
Definition: logger.h:285
#define ao2_container_alloc_hash(ao2_options, container_options, n_buckets, hash_fn, sort_fn, cmp_fn)
Definition: astobj2.h:1310
static struct parking_lot_cfg * clone_parkinglot_cfg(struct parking_lot_cfg *source, const char *name)
Definition: res_parking.c:939
The descriptor of a dynamic string XXX storage will be optimized later if needed We use the ts field ...
Definition: strings.h:584
const ast_string_field registrar
Definition: res_parking.h:89
#define ao2_unlink(container, obj)
Definition: astobj2.h:1598
void aco_info_destroy(struct aco_info *info)
Destroy an initialized aco_info struct.
#define ao2_global_obj_release(holder)
Definition: astobj2.h:865
Type for default option handler for bools (ast_true/ast_false)
int ast_unlock_contexts(void)
Unlocks contexts.
Definition: pbx.c:8512
static int reload_module(void)
Definition: res_parking.c:1280
void unload_parking_tests(void)
Unregister parking unit tests.
#define ao2_iterator_next(iter)
Definition: astobj2.h:1933
#define ao2_alloc(data_size, destructor_fn)
Definition: astobj2.h:411
const char * ast_get_extension_name(struct ast_exten *exten)
Definition: pbx.c:8548
#define LOG_NOTICE
Definition: logger.h:263
static int config_parking_preapply(void)
Definition: res_parking.c:1155
int ast_wrlock_context(struct ast_context *con)
Write locks a given context.
Definition: pbx.c:8520
static void generate_or_link_lots_to_configs(void)
Definition: res_parking.c:915
#define PARK_APPLICATION
The default parking application that Asterisk expects.
Definition: parking.h:35
static int option_handler_parkpos(const struct aco_option *opt, struct ast_variable *var, void *obj)
Custom field handler for parking positions.
Definition: res_parking.c:504
static char * registrar
Definition: pbx_ael.c:78
#define ast_channel_unlock(chan)
Definition: channel.h:2914
#define ast_free(a)
Definition: astmm.h:182
unsigned int parkfindnext
Definition: res_parking.h:71
#define PARKED_CALL_APPLICATION
Definition: res_parking.h:38
static int extension_is_compatible(struct parking_lot_cfg *lot_cfg, const char *app_type, struct ast_exten *extension)
Definition: res_parking.c:730
void unload_parking_manager(void)
Unregister manager actions and remove subscriptions for stasis events.
int aco_set_defaults(struct aco_type *type, const char *category, void *obj)
Set all default options of obj.
int stacklen
Definition: extconf.h:238
#define STRFLDSET(type,...)
Convert a struct and a list of stringfield fields to an argument list of field offsets.
Module has failed to load, may be in an inconsistent state.
Definition: module.h:78
const ast_string_field name
Definition: res_parking.h:100
static void * parking_config_alloc(void)
allocator callback for parking_config. Notice it returns void * since it is only used by the backend ...
Definition: res_parking.c:377
#define ao2_find(container, arg, flags)
Definition: astobj2.h:1756
structure to hold users read from users.conf
#define ast_string_field_build(x, field, fmt, args...)
Set a field to a complex (built) value.
Definition: stringfields.h:550
int parkedcalltransfers
Definition: res_parking.h:76
AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS|AST_MODFLAG_LOAD_ORDER, "HTTP Phone Provisioning",.support_level=AST_MODULE_SUPPORT_EXTENDED,.load=load_module,.unload=unload_module,.reload=reload,.load_pri=AST_MODPRI_CHANNEL_DEPEND,.requires="http",)
static int replace(struct ast_channel *chan, const char *cmd, char *data, struct ast_str **buf, ssize_t len)
Definition: func_strings.c:810
#define ACO_FILES(...)
struct aco_file parking_lot_conf
Definition: res_parking.c:307
enum parking_lot_modes mode
Definition: res_parking.h:97
When we need to walk through a container, we use an ao2_iterator to keep track of the current positio...
Definition: astobj2.h:1841
#define ao2_cleanup(obj)
Definition: astobj2.h:1958
Standard Command Line Interface.
static int load_module(void)
Definition: res_parking.c:1207
Type information about a category-level configurable object.
const ast_string_field parkext
Definition: res_parking.h:89
#define S_OR(a, b)
returns the equivalent of logic or for strings: first one if not empty, otherwise second one...
Definition: strings.h:79
int attribute_pure ast_false(const char *val)
Make sure something is false. Determine if a string containing a boolean value is "false"...
Definition: main/utils.c:1968
const char * filename
struct parking_lot * parking_lot_build_or_update(struct parking_lot_cfg *lot_cfg, int dynamic)
If a parking lot exists in the parking lot list already, update its status to match the provided conf...
Definition: res_parking.c:868
int parkedcallrecording
Definition: res_parking.h:79
void ast_context_destroy(struct ast_context *con, const char *registrar)
Destroy a context (matches the specified context or ANY context if NULL)
Definition: pbx.c:8260
Type for default option handler for stringfields.
int load_parking_devstate(void)
Register Parking devstate handler.
Definition: search.h:40
int error(const char *format,...)
Definition: utils/frame.c:999
Reject objects with duplicate keys in container.
Definition: astobj2.h:1192
Call Parking Resource Internal API.
static void remove_all_configured_parking_lot_extensions(void)
Definition: res_parking.c:678
static int parking_lot_cfg_hash_fn(const void *obj, const int flags)
Definition: res_parking.c:320
Generic container type.
static char context[AST_MAX_CONTEXT]
Definition: chan_alsa.c:120
Call Parking and Pickup API Includes code and algorithms from the Zapata library. ...
struct ast_context * ast_context_find_or_create(struct ast_context **extcontexts, struct ast_hashtab *exttable, const char *name, const char *registrar)
Register a new context or find an existing one.
Definition: pbx.c:6198
#define ASTERISK_GPL_KEY
The text the key() function should return.
Definition: module.h:46
#define DEFAULT_PARKING_EXTEN
Definition: res_parking.h:35
Asterisk module definitions.
struct ast_exten * pbx_find_extension(struct ast_channel *chan, struct ast_context *bypass, struct pbx_find_info *q, const char *context, const char *exten, int priority, const char *label, const char *callerid, enum ext_match_t action)
Definition: ael_main.c:152
#define ast_string_field_free_memory(x)
free all memory - to be called before destroying the object
Definition: stringfields.h:368
ast_context: An extension context - must remain in sync with fake_context
Definition: pbx.c:284
static void link_configured_disable_marked_lots(void)
Definition: res_parking.c:1184
int parking_lot_cfg_create_extensions(struct parking_lot_cfg *lot_cfg)
Add extensions for a parking lot configuration.
Definition: res_parking.c:758
struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags) attribute_warn_unused_result
Create an iterator for a container.
unsigned int parkext_exclusive
Definition: res_parking.h:72
static void parking_lot_destructor(void *obj)
Definition: res_parking.c:625
const char * ast_channel_parkinglot(const struct ast_channel *chan)
static struct aco_type parking_lot_type
Definition: res_parking.c:295
int ast_add_extension2_nolock(struct ast_context *con, int replace, const char *extension, int priority, const char *label, const char *callerid, const char *application, void *data, void(*datad)(void *), const char *registrar, const char *registrar_file, int registrar_line)
Same as ast_add_extension2, but assumes you have already locked context.
Definition: pbx.c:7308
static void parking_lot_cfg_destructor(void *obj)
Destroy a parking lot cfg object.
Definition: res_parking.c:427
struct ast_context * ast_get_extension_context(struct ast_exten *exten)
Definition: pbx.c:8543
#define ast_str_create(init_len)
Create a malloc&#39;ed dynamic length string.
Definition: strings.h:620
static struct parking_lot * alloc_new_parking_lot(struct parking_lot_cfg *lot_cfg)
Definition: res_parking.c:637
static force_inline int attribute_pure ast_str_hash(const char *str)
Compute a hash value on a string.
Definition: strings.h:1206
#define ast_string_field_set(x, field, data)
Set a field to a simple string value.
Definition: stringfields.h:514
struct parking_lot_cfg * cfg
Definition: res_parking.h:96
#define ao2_link(container, obj)
Definition: astobj2.h:1549