parking_tests: Fix assertions and possibly crashes in res_parking unit tests
[asterisk/asterisk.git] / res / parking / parking_ui.c
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 CLI commands
22  *
23  * \author Jonathan Rose <jrose@digium.com>
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include "res_parking.h"
31 #include "asterisk/config.h"
32 #include "asterisk/config_options.h"
33 #include "asterisk/utils.h"
34 #include "asterisk/module.h"
35 #include "asterisk/cli.h"
36 #include "asterisk/astobj2.h"
37 #include "asterisk/features.h"
38 #include "asterisk/manager.h"
39
40 static void display_parked_call(struct parked_user *user, int fd)
41 {
42         ast_cli(fd, "  Space               :  %d\n", user->parking_space);
43         ast_cli(fd, "  Channel             :  %s\n", ast_channel_name(user->chan));
44         ast_cli(fd, "  Parker Dial String  :  %s\n", user->parker_dial_string);
45         ast_cli(fd, "\n");
46 }
47
48 static int display_parked_users_cb(void *obj, void *arg, int flags)
49 {
50         int *fd = arg;
51         struct parked_user *user = obj;
52         display_parked_call(user, *fd);
53         return 0;
54 }
55
56 static void display_parking_lot(struct parking_lot *lot, int fd)
57 {
58         ast_cli(fd, "Parking Lot: %s\n--------------------------------------------------------------------------\n", lot->name);
59         ast_cli(fd, "Parking Extension   :  %s\n", lot->cfg->parkext);
60         ast_cli(fd, "Parking Context     :  %s\n", lot->cfg->parking_con);
61         ast_cli(fd, "Parking Spaces      :  %d-%d\n", lot->cfg->parking_start, lot->cfg->parking_stop);
62         ast_cli(fd, "Parking Time        :  %u sec\n", lot->cfg->parkingtime);
63         ast_cli(fd, "Comeback to Origin  :  %s\n", lot->cfg->comebacktoorigin ? "yes" : "no");
64         ast_cli(fd, "Comeback Context    :  %s%s\n", lot->cfg->comebackcontext, lot->cfg->comebacktoorigin ? " (comebacktoorigin=yes, not used)" : "");
65         ast_cli(fd, "Comeback Dial Time  :  %u sec\n", lot->cfg->comebackdialtime);
66         ast_cli(fd, "MusicOnHold Class   :  %s\n", lot->cfg->mohclass);
67         ast_cli(fd, "Enabled             :  %s\n", (lot->mode == PARKINGLOT_DISABLED) ? "no" : "yes");
68         ast_cli(fd, "Dynamic             :  %s\n", (lot->mode == PARKINGLOT_DYNAMIC) ? "yes" : "no");
69         ast_cli(fd, "\n");
70 }
71
72 static int display_parking_lot_cb(void *obj, void *arg, int flags)
73 {
74         int *fd = arg;
75         struct parking_lot *lot = obj;
76         display_parking_lot(lot, *fd);
77         return 0;
78 }
79
80 static void cli_display_parking_lot(int fd, const char *name)
81 {
82         RAII_VAR(struct parking_lot *, lot, NULL, ao2_cleanup);
83         lot = parking_lot_find_by_name(name);
84
85         /* If the parking lot couldn't be found with the search, also abort. */
86         if (!lot) {
87                 ast_cli(fd, "Could not find parking lot '%s'\n\n", name);
88                 return;
89         }
90
91         display_parking_lot(lot, fd);
92
93         ast_cli(fd, "Parked Calls\n------------\n");
94
95         if (!ao2_container_count(lot->parked_users)) {
96                 ast_cli(fd, "  (none)\n");
97                 ast_cli(fd, "\n\n");
98                 return;
99         }
100
101         ao2_callback(lot->parked_users, OBJ_MULTIPLE | OBJ_NODATA, display_parked_users_cb, &fd);
102         ast_cli(fd, "\n");
103 }
104
105 static void cli_display_parking_global(int fd)
106 {
107         ast_cli(fd, "Parking General Options\n"
108                     "-----------------------\n");
109         ast_cli(fd, "Dynamic Parking     :  %s\n", parking_dynamic_lots_enabled() ? "yes" : "no");
110         ast_cli(fd, "\n");
111 }
112
113 static void cli_display_parking_lot_list(int fd)
114 {
115         struct ao2_container *lot_container;
116
117         lot_container = get_parking_lot_container();
118
119         if (!lot_container) {
120                 ast_cli(fd, "Failed to obtain parking lot list.\n\n");
121                 return;
122         }
123
124         ao2_callback(lot_container, OBJ_MULTIPLE | OBJ_NODATA, display_parking_lot_cb, &fd);
125         ast_cli(fd, "\n");
126 }
127
128 struct parking_lot_complete {
129         int seeking;    /*! Nth match to return. */
130         int which;      /*! Which match currently on. */
131 };
132
133 static int complete_parking_lot_search(void *obj, void *arg, void *data, int flags)
134 {
135         struct parking_lot_complete *search = data;
136         if (++search->which > search->seeking) {
137                 return CMP_MATCH;
138         }
139         return 0;
140 }
141
142 static char *complete_parking_lot(const char *word, int seeking)
143 {
144         char *ret = NULL;
145         struct parking_lot *lot;
146         struct ao2_container *global_lots = get_parking_lot_container();
147         struct parking_lot_complete search = {
148                 .seeking = seeking,
149                 };
150
151         lot = ao2_callback_data(global_lots, ast_strlen_zero(word) ? 0 : OBJ_PARTIAL_KEY,
152                 complete_parking_lot_search, (char *) word, &search);
153
154         if (!lot) {
155                 return NULL;
156         }
157
158         ret = ast_strdup(lot->name);
159         ao2_ref(lot, -1);
160         return ret;
161 }
162
163 /* \brief command parking show <name> */
164 static char *handle_show_parking_lot_cmd(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
165 {
166         switch (cmd) {
167         case CLI_INIT:
168                 e->command = "parking show";
169                 e->usage =
170                         "Usage: parking show [name]\n"
171                         "       Shows a list of parking lots or details of a specific parking lot.";
172                 return NULL;
173         case CLI_GENERATE:
174                 if (a->pos == 2) {
175                         return complete_parking_lot(a->word, a->n);
176                 }
177                 return NULL;
178         }
179
180         ast_cli(a->fd, "\n");
181
182         if (a->argc == 2) {
183                 cli_display_parking_global(a->fd);
184                 cli_display_parking_lot_list(a->fd);
185                 return CLI_SUCCESS;
186         }
187
188         if (a->argc == 3) {
189                 cli_display_parking_lot(a->fd, a->argv[2]);
190                 return CLI_SUCCESS;
191         }
192
193         return CLI_SHOWUSAGE;
194 }
195
196 static struct ast_cli_entry cli_parking_lot[] = {
197         AST_CLI_DEFINE(handle_show_parking_lot_cmd, "Show a parking lot or a list of all parking lots."),
198 };
199
200 int load_parking_ui(void)
201 {
202         return ast_cli_register_multiple(cli_parking_lot, ARRAY_LEN(cli_parking_lot));
203 }
204
205 void unload_parking_ui(void)
206 {
207         ast_cli_unregister_multiple(cli_parking_lot, ARRAY_LEN(cli_parking_lot));
208 }