2 * Copyright (c) 2000-2009 Apple Inc. All rights reserved.
4 * @APPLE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
21 * @APPLE_LICENSE_HEADER_END@
25 * Modification History
27 * June 1, 2001 Allan Nathanson <ajn@apple.com>
28 * - public API conversion
30 * November 9, 2000 Allan Nathanson <ajn@apple.com>
36 #include <sys/errno.h>
40 #include "dictionary.h"
43 #include "notifications.h"
50 const cmdInfo commands_store
[] = {
51 /* cmd minArgs maxArgs func group ctype */
54 { "help", 0, 0, do_help
, 0, 0,
55 " help : list available commands" },
57 { "f.read", 1, 1, do_readFile
, 0, 0,
58 " f.read file : process commands from file" },
60 { "quit", 0, 0, do_quit
, 0, 0,
63 { "q", 0, 0, do_quit
, 0, -1,
66 { "exit", 0, 0, do_quit
, 0, -1,
69 /* local dictionary manipulation commands */
71 { "d.init", 0, 0, do_dictInit
, 1, 0,
72 " d.init : initialize (empty) dictionary" },
74 { "d.show", 0, 0, do_dictShow
, 1, 0,
75 " d.show : show dictionary contents" },
77 { "d.add", 2, 101, do_dictSetKey
, 1, 0,
78 " d.add key [*#?] val [v2 ...] : add information to dictionary\n"
79 " (*=array, #=number, ?=boolean)" },
81 { "d.remove", 1, 1, do_dictRemoveKey
, 1, 0,
82 " d.remove key : remove key from dictionary" },
84 /* dynamic store manipulation commands */
86 { "open", 0, 1, do_open
, 2, 1,
87 " open [\"temporary\"] : open a session with \"configd\"" },
89 { "close", 0, 0, do_close
, 2, 1,
90 " close : close current \"configd\" session" },
92 { "lock", 0, 0, do_lock
, 3, 1,
93 " lock : locks write access to data store" },
95 { "unlock", 0, 0, do_unlock
, 3, 1,
96 " unlock : unlocks write access to data store" },
98 { "list", 0, 2, do_list
, 4, 0,
99 " list [pattern] : list keys in data store" },
101 { "add", 1, 2, do_add
, 4, 0,
102 " add key [\"temporary\"] : add key in data store w/current dict" },
104 { "get", 1, 1, do_get
, 4, 0,
105 " get key : get dict from data store w/key" },
107 { "set", 1, 1, do_set
, 4, 0,
108 " set key : set key in data store w/current dict" },
110 { "show", 1, 2, do_show
, 4, 0,
111 " show key [\"pattern\"] : show values in data store w/key" },
113 { "remove", 1, 1, do_remove
, 4, 0,
114 " remove key : remove key from data store" },
116 { "notify", 1, 1, do_notify
, 4, 0,
117 " notify key : notify key in data store" },
119 { "touch", 1, 1, do_touch
, 4, 1,
120 " touch key : touch key in data store" },
122 { "n.list", 0, 1, do_notify_list
, 5, 0,
123 " n.list [\"pattern\"] : list notification keys" },
125 { "n.add", 1, 2, do_notify_add
, 5, 0,
126 " n.add key [\"pattern\"] : add notification key" },
128 { "n.remove", 1, 2, do_notify_remove
, 5, 0,
129 " n.remove key [\"pattern\"] : remove notification key" },
131 { "n.changes", 0, 0, do_notify_changes
, 5, 0,
132 " n.changes : list changed keys" },
134 { "n.watch", 0, 0, do_notify_watch
, 5, 0,
135 " n.watch : watch for changes" },
137 { "n.wait", 0, 0, do_notify_wait
, 5, 2,
138 " n.wait : wait for changes" },
140 { "n.callback", 0, 1, do_notify_callback
, 5, 2,
141 " n.callback [\"verbose\"] : watch for changes" },
143 { "n.signal", 1, 2, do_notify_signal
, 5, 2,
144 " n.signal sig [pid] : signal changes" },
146 { "n.file", 0, 1, do_notify_file
, 5, 2,
147 " n.file [identifier] : watch for changes via file" },
149 { "n.cancel", 0, 1, do_notify_cancel
, 5, 0,
150 " n.cancel : cancel notification requests" },
152 { "snapshot", 0, 0, do_snapshot
, 99, 2,
153 " snapshot : save snapshot of store and session data" }
156 const int nCommands_store
= (sizeof(commands_store
)/sizeof(cmdInfo
));
160 const cmdInfo commands_net
[] = {
161 /* cmd minArgs maxArgs func group ctype */
164 { "help", 0, 0, do_help
, 0, 0,
165 " help : list available commands" },
167 { "f.read", 1, 1, do_readFile
, 0, 0,
168 " f.read file : process commands from file" },
170 { "quit", 0, 1, do_net_quit
, 0, 0,
171 " quit [!] : quit" },
173 { "q", 0, 1, do_net_quit
, 0, -1,
176 { "exit", 0, 1, do_net_quit
, 0, -1,
179 /* network configuration manipulation commands */
181 { "open", 0, 1, do_net_open
, 2, 1,
182 " open : open the network configuration" },
184 { "commit", 0, 0, do_net_commit
, 2, 0,
185 " commit : commit any changes" },
187 { "apply", 0, 0, do_net_apply
, 2, 0,
188 " apply : apply any changes" },
190 { "close", 0, 1, do_net_close
, 2, 1,
191 " close [!] : close the network configuration" },
193 { "create", 1, 3, do_net_create
, 3, 0,
194 " create interface <interfaceType> [ <interfaceName> | <interface#> ]\n"
195 " create protocol <protocolType>\n"
196 " create service [ <interfaceName> | <interface#> [ <serviceName> ]]\n"
197 " create set [setName]" },
199 { "disable", 1, 2, do_net_disable
, 4, 0,
200 " disable protocol [ <protocolType> ]\n"
201 " disable service [ <serviceName> | <service#> ]" },
203 { "enable", 1, 2, do_net_enable
, 5, 0,
204 " enable protocol [ <protocolType> ]\n"
205 " enable service [ <serviceName> | <service#> ]" },
207 { "remove", 1, 2, do_net_remove
, 6, 0,
208 " remove protocol [ <protocolType> ]\n"
209 " remove service [ <serviceName> | <service#> ]\n"
210 " remove set [ <setName> | <set#> ]" },
212 { "select", 2, 3, do_net_select
, 7, 0,
213 " select interface <interfaceName> | <interface#> | $child | $service | $vlan | $bond <memberName>\n"
214 " select protocol <protocolType>\n"
215 " select service <serviceName> | <service#>\n"
216 " select set <setName> | <set#>" },
218 { "set", 2, 101, do_net_set
, 8, 0,
219 " set interface context-sensitive-arguments (or ? for help)\n"
220 " set protocol context-sensitive-arguments (or ? for help)\n"
221 " set service [ name <serviceName> ] [ order new-order ] [ rank ("" | First | Last | Never) [temp] ]\n"
222 " set set [ name setName ]" },
224 { "show", 1, 2, do_net_show
, 9, 0,
226 " show interface [ <interfaceName> | <interface#> ]\n"
228 " show protocol [ <protocolType> ]\n"
229 " show services [ all ]\n"
230 " show service [ <serviceName> | <service#> ]\n"
232 " show set [ <setName> | <set#> ]" },
234 { "update", 0, 1, do_net_update
, 10, 0,
235 " update : update the network configuration" },
237 { "snapshot", 0, 0, do_net_snapshot
, 99, 2,
242 const int nCommands_net
= (sizeof(commands_net
)/sizeof(cmdInfo
));
246 const cmdInfo commands_prefs
[] = {
247 /* cmd minArgs maxArgs func group ctype */
250 { "help", 0, 0, do_help
, 0, 0,
251 " help : list available commands" },
253 { "f.read", 1, 1, do_readFile
, 0, 0,
254 " f.read file : process commands from file" },
256 { "quit", 0, 1, do_prefs_quit
, 0, 0,
257 " quit [!] : quit" },
259 { "q", 0, 1, do_prefs_quit
, 0, -1,
262 { "exit", 0, 1, do_prefs_quit
, 0, -1,
265 /* local dictionary manipulation commands */
267 { "d.init", 0, 0, do_dictInit
, 1, 0,
268 " d.init : initialize (empty) dictionary" },
270 { "d.show", 0, 0, do_dictShow
, 1, 0,
271 " d.show : show dictionary contents" },
273 { "d.add", 2, 101, do_dictSetKey
, 1, 0,
274 " d.add key [*#?] val [v2 ...] : add information to dictionary\n"
275 " (*=array, #=number, ?=boolean)" },
277 { "d.remove", 1, 1, do_dictRemoveKey
, 1, 0,
278 " d.remove key : remove key from dictionary" },
280 /* data store manipulation commands */
282 { "open", 0, 1, do_prefs_open
, 2, 1,
283 " open [\"prefsID\"] : open a \"preferences\" session" },
285 { "lock", 0, 1, do_prefs_lock
, 3, 1,
286 " lock [wait] : locks write access to preferences" },
288 { "commit", 0, 0, do_prefs_commit
, 2, 0,
289 " commit : commit any changes" },
291 { "apply", 0, 0, do_prefs_apply
, 2, 0,
292 " apply : apply any changes" },
294 { "unlock", 0, 0, do_prefs_unlock
, 3, 1,
295 " unlock : unlocks write access to preferences" },
297 { "close", 0, 1, do_prefs_close
, 2, 1,
298 " close [!] : close current \"preference\" session" },
300 { "synchronize",0, 1, do_prefs_synchronize
, 2, 0,
301 " synchronize : synchronize a \"preferences\" session" },
303 { "list", 0, 1, do_prefs_list
, 4, 0,
304 " list [path] : list preference paths" },
306 { "get", 1, 1, do_prefs_get
, 4, 0,
307 " get path : get dict from preferences w/path" },
309 { "set", 1, 2, do_prefs_set
, 4, 0,
310 " set path : set path in preferences w/current dict\n"
311 " set path link : set path in preferences w/link" },
313 { "remove", 1, 1, do_prefs_remove
, 4, 0,
314 " remove path : remove path from preferences" }
317 const int nCommands_prefs
= (sizeof(commands_prefs
)/sizeof(cmdInfo
));
320 __private_extern__ cmdInfo
*commands
= NULL
;
321 __private_extern__
int nCommands
= 0;
322 __private_extern__ Boolean enablePrivateAPI
= FALSE
;
323 __private_extern__ Boolean termRequested
= FALSE
;
328 do_command(int argc
, char **argv
)
333 for (i
= 0; i
< nCommands
; i
++) {
334 if ((commands
[i
].ctype
> 1) && !enablePrivateAPI
) {
335 continue; /* if "private" API and access has not been enabled */
338 if (strcasecmp(cmd
, commands
[i
].cmd
) == 0) {
341 if (argc
< commands
[i
].minArgs
) {
342 SCPrint(TRUE
, stdout
, CFSTR("%s: too few arguments\n"), cmd
);
344 } else if (argc
> commands
[i
].maxArgs
) {
345 SCPrint(TRUE
, stdout
, CFSTR("%s: too many arguments\n"), cmd
);
348 (*commands
[i
].func
)(argc
, argv
);
353 SCPrint(TRUE
, stdout
, CFSTR("%s: unknown, type \"help\" for command info\n"), cmd
);
360 do_help(int argc
, char **argv
)
362 int g
= -1; /* current group */
365 SCPrint(TRUE
, stdout
, CFSTR("\nAvailable commands:\n"));
366 for (i
= 0; i
< nCommands
; i
++) {
367 if (commands
[i
].ctype
< 0) {
368 continue; /* if "hidden" */
371 if ((commands
[i
].ctype
> 0) && !enablePrivateAPI
) {
372 continue; /* if "private" API and access has not been enabled */
375 /* check if this is a new command group */
376 if (g
!= commands
[i
].group
) {
377 SCPrint(TRUE
, stdout
, CFSTR("\n"));
378 g
= commands
[i
].group
;
381 /* display the command */
382 SCPrint(TRUE
, stdout
, CFSTR("%s\n"), commands
[i
].usage
);
384 SCPrint(TRUE
, stdout
, CFSTR("\n"));
392 do_readFile(int argc
, char **argv
)
396 /* allocate command input stream */
397 src
= (InputRef
)CFAllocatorAllocate(NULL
, sizeof(Input
), 0);
399 src
->fp
= fopen(argv
[0], "r");
401 if (src
->fp
== NULL
) {
402 SCPrint(TRUE
, stdout
, CFSTR("f.read: could not open file (%s).\n"), strerror(errno
));
403 CFAllocatorDeallocate(NULL
, src
);
407 /* open file, increase nesting level */
408 SCPrint(TRUE
, stdout
, CFSTR("f.read: reading file (%s).\n"), argv
[0]);
414 ok
= process_line(src
);
420 (void)fclose(src
->fp
);
421 CFAllocatorDeallocate(NULL
, src
);
429 do_quit(int argc
, char **argv
)
431 termRequested
= TRUE
;