1 #if (!defined(lint) && !defined(SABER))
2 static char rcsid_module_c[] = "$Header$";
5 /* This is the file utils.c for the MOIRA Client, which allows a nieve
6 * user to quickly and easily maintain most parts of the MOIRA database.
7 * It Contains: Many useful utility functions.
10 * By: Chris D. Peterson
16 * Copyright 1988 by the Massachusetts Institute of Technology.
18 * For further information on copyright and distribution
19 * see the file mit-copyright.h
25 #include <moira_site.h>
29 #include "mit-copyright.h"
34 #include <netdb.h> /* for gethostbyname. */
36 /* Function Name: AddQueue
37 * Description: Adds an element to a queue
38 * Arguments: elem, pred - element and its predecessor.
44 struct qelem * elem, *pred;
52 elem->q_forw = pred->q_forw;
56 /* Function Name: RemoveQueue
57 * Description: removes an element from a queue.
66 if (elem->q_forw != NULL)
67 (elem->q_forw)->q_back = elem->q_back;
68 if (elem->q_back != NULL)
69 (elem->q_back)->q_forw = elem->q_forw;
73 /* CopyInfo: allocates memory for a copy of a NULL terminated array of
74 * strings <and returns a pointer to the copy.
83 ret = (char **) malloc(sizeof(char *) * (CountArgs(info) + 1));
86 for (i = 0; info[i]; i++)
87 ret[i] = Strsave(info[i]);
93 /* Function Name: FreeInfo
94 * Description: Frees all elements of a NULL terminated arrary of char*'s
95 * Arguments: info - array who's elements we are to free.
103 while (*info != NULL)
104 FreeAndClear(info++, TRUE);
107 /* Function Name: FreeAndClear - I couldn't resist the name.
108 * Description: Clears pointer and optionially frees it.
109 * Arguments: pointer - pointer to work with.
110 * free_it - if TRUE then free pointer.
115 FreeAndClear(pointer, free_it)
119 if (*pointer == NULL)
126 /* Function Name: QueueTop
127 * Description: returns a qelem pointer that points to the top of
129 * Arguments: elem - any element of a queue.
130 * Returns: top element of a queue.
137 if (elem == NULL) /* NULL returns NULL. */
139 while (elem->q_back != NULL)
144 /* Function Name: FreeQueueElem
145 * Description: Frees one element of the queue.
146 * Arguments: elem - the elem to free.
154 char ** info = (char **) elem->q_data;
156 if (info != (char **) NULL) {
157 FreeInfo( info ); /* free info fields */
158 free(elem->q_data); /* free info array itself. */
160 RemoveQueue(elem); /* remove this element from the queue */
161 free(elem); /* free its space. */
164 /* Function Name: FreeQueue
165 * Description: Cleans up the queue
166 * Arguments: elem - any element of the queue.
174 struct qelem *temp, *local = QueueTop(elem);
176 while(local != NULL) {
177 temp = local->q_forw;
178 FreeQueueElem(local);
183 /* Function Name: QueueCount
184 * Description: Counts the number of elements in a queue
185 * Arguments: elem - any element in the queue.
194 elem = QueueTop(elem);
195 while (elem != NULL) {
202 /* Function Name: StoreInfo
203 * Description: Stores information from an moira query into a queue.
204 * Arguments: argc, argv, - information returned from the query returned
206 * data - the previous element on the queue, this data will be
207 * stored in a qelem struct immediatly after this elem.
208 * If NULL then a new queue will be created. This value
209 * is updated to the current element at the end off the
211 * Returns: MR_CONT, or MR_ABORT if it has problems.
215 StoreInfo(argc, argv, data)
220 char ** info = (char **) malloc( MAX_ARGS_SIZE * sizeof(char *));
221 struct qelem ** old_elem = (struct qelem **) data;
222 struct qelem * new_elem = (struct qelem *) malloc (sizeof (struct qelem));
225 if ( (new_elem == (struct qelem *) NULL) || (info == (char **) NULL) ) {
226 Put_message("Could Not allocate more memory.");
227 FreeQueue(*old_elem);
228 *old_elem = (struct qelem *) NULL;
232 for (count = 0; count < argc; count++)
233 info[count] = Strsave(argv[count]);
234 info[count] = NULL; /* NULL terminate this sucker. */
236 new_elem->q_data = (char *) info;
237 AddQueue(new_elem, *old_elem);
239 *old_elem = new_elem;
243 /* Function Name: CountArgs
244 * Description: Retrieve the number of args in a null terminated
246 * Arguments: info - the argument list.
247 * Returns: number if args in the list.
256 while (*info != NULL) {
264 /* Function Name: Scream
265 * Description: Bitch Loudly and exit, it is intended as a callback
266 * function for queries that should never return a value.
268 * Returns: doesn't exit.
274 com_err(program_name, 0,
275 "\nA Moira update returned a value -- programmer botch\n");
282 /* Function Name: PromptWithDefault
283 * Description: allows a user to be prompted for input, and given a
285 * Arguments: prompt - the prompt string.
286 * buf, buflen - buffer to be returned and its MAX size?
287 * default value for the answer.
288 * Returns: zero on failure
292 PromptWithDefault(prompt, buf, buflen, def)
300 if (parsed_argc > 0) {
302 strncpy(buf, parsed_argv[0], buflen);
303 sprintf(tmp, "%s: %s", prompt, buf);
309 (void) sprintf(tmp, "%s [%s]: ", prompt, def ? def : "");
310 ans = Prompt_input(tmp, buf, buflen);
312 (void) strcpy(buf, def);
313 else if (!strcmp(buf, "\"\""))
318 /* Function Name: YesNoQuestion
319 * Description: This prompts the user for the answer to a yes-no or
320 * true-false question.
321 * Arguments: prompt - the prompt for the user.
322 * bool_def - the default value either TRUE or FALSE.
323 * Returns: TRUE or FALSE or -1 on error
327 YesNoQuestion(prompt, bool_def)
334 if (!PromptWithDefault(prompt, ans, 2, bool_def ? "y" : "n"))
344 Put_message("Please answer 'y' or 'n'.");
349 /* Function Name: YesNoQuitQuestion
350 * Description: This prompts the user for the answer to a yes-no or
351 * true-false question, with a quit option.
352 * Arguments: prompt - the prompt for the user.
353 * bool_def - the default value either TRUE or FALSE.
354 * Returns: TRUE or FALSE or -1 on error or QUIT
355 * NOTE: It is not possible to have quit the default, but then I don't
356 * seem to need this functionality.
360 YesNoQuitQuestion(prompt, bool_def)
367 if (!PromptWithDefault(prompt, ans, 2, bool_def ? "y" : "n"))
380 Put_message("Please answer 'y', 'n' or 'q'.");
386 /* Function Name: Confirm
387 * Description: This function asks the user to confirm the action
388 * he is about to take, used for things like deleting.
389 * Arguments: prompt - the prompt string.
390 * Returns: TRUE/FALSE - wether or not the confirmation occured.
397 return( !verbose || (YesNoQuestion(prompt,FALSE) == TRUE) );
400 /* Function Name: ValidName
401 * Description: This function checks to see if we have a valid list name.
402 * Arguments: s - the list name.
403 * Returns: TRUE if Valid.
411 Put_message("Please use a non-empty name.");
412 else if (index(s, ' '))
413 Put_message("You cannot use space (' ') in this name.");
414 else if (index(s, '*') || index(s, '?') || index(s, '['))
415 Put_message("Wildcards not accepted here.");
421 /* Function Name: ToggleVerboseMode
422 * Description: This function toggles the verbose mode.
424 * Returns: DM_NORMAL.
434 Put_message("Delete functions will first confirm\n");
436 Put_message("Delete functions will be silent\n");
441 /* Function Name: NullFunc
442 * Description: dummy callback routine
453 /* Function Name: SlipInNewName
454 * Description: Slips the new name into the number 2 slot of a list, and
455 * returns a pointer to the new list.
456 * Arguments: info - list that needs this name slipped into it.
457 * name - the name to slip into the list.
458 * Returns: a pointer to the new list.
459 * NOTE: This screws up the numbers of the elements of the array in a
464 SlipInNewName(info, name)
470 /* This also pushes the NULL down. */
471 for (i = CountArgs(info); i > 0; i--) {
474 info[1] = name; /* now slip in the name. */
477 /* Function Name: GetValueFromUser
478 * Description: This function gets a value from a user for the field
480 * Arguments: prompt - prompt for user.
481 * pointer - pointer to default value, will be returned
483 * Returns: SUB_ERROR if break hit (^C).
487 GetValueFromUser(prompt, pointer)
488 char * prompt, ** pointer;
492 if (PromptWithDefault(prompt, buf, BUFSIZ, *pointer) == 0)
496 * If these are the same then there is no need to allocate a new string.
498 * a difference that makes no difference, IS no difference.
501 if (strcmp(buf, *pointer) != 0) {
502 if (*pointer != NULL)
504 *pointer = Strsave(buf);
509 /* Function Name: GetYesNoValueFromUser
510 * Description: This function gets a value from a user for the field
512 * Arguments: prompt - prompt for user.
513 * pointer - pointer to default value, will be returned
515 * Returns: SUB_ERROR if break hit (^C).
519 GetYesNoValueFromUser(prompt, pointer)
520 char * prompt, ** pointer;
522 char user_prompt[BUFSIZ];
525 if ( strcmp (*pointer, DEFAULT_YES) == 0 )
530 sprintf(user_prompt, "%s (y/n)", prompt);
532 switch (YesNoQuestion(user_prompt, default_val)) {
534 if (*pointer != NULL)
536 *pointer = Strsave(DEFAULT_YES);
539 if (*pointer != NULL)
541 *pointer = Strsave(DEFAULT_NO);
550 /* Function Name: GetFSVal
551 * Description: asks about a specific filesystem value.
552 * Arguments: name - string for this type of filesystem.
553 * mask - mask for this type of filesystem.
554 * current - current filesystem state. (for defaults).
555 * new - new filesystem state.
556 * Returns: TRUE if successful.
560 GetFSVal(name, mask, current, new)
562 int mask, current, *new;
564 char temp_buf[BUFSIZ];
565 sprintf(temp_buf, "Is this a %s filsystem", name);
566 switch (YesNoQuestion(temp_buf, ( (mask & current) == mask) )) {
571 break; /* zero by default. */
578 /* Function Name: GetFSTypes
579 * Description: Allows user to specify filsystem types.
580 * Arguments: current - current value of filsystem, freed here.
581 * Returns: SUB_ERROR on ^C.
585 GetFSTypes(current, options)
589 int c_value, new_val = 0; /* current value of filesys type (int). */
590 char ret_value[BUFSIZ];
592 if (*current == NULL)
595 c_value = atoi(*current);
597 if (GetFSVal("student", MR_FS_STUDENT, c_value, &new_val) == FALSE)
599 if (GetFSVal("faculty", MR_FS_FACULTY, c_value, &new_val) == FALSE)
601 if (GetFSVal("staff", MR_FS_STAFF, c_value, &new_val) == FALSE)
603 if (GetFSVal("miscellaneous", MR_FS_MISC, c_value, &new_val) == FALSE)
606 if (GetFSVal("Group Quotas", MR_FS_GROUPQUOTA, c_value, &new_val) ==
611 FreeAndClear(current, TRUE);
612 sprintf(ret_value, "%d", new_val);
613 *current = Strsave(ret_value);
617 /* Function Name: Strsave
618 * Description: save a string.
619 * Arguments: string - the string to save.
620 * Returns: The malloced string, now safely saved, or NULL.
627 register char *newstr = malloc((unsigned) strlen(str) + 1);
629 if (newstr == (char *) NULL)
630 return ((char *) NULL);
632 return (strcpy(newstr, str));
635 /* Function Name: Print
636 * Description: prints out all the arguments on a single line.
637 * Arguments: argc, argv - the standard MR arguments.
638 * callback - the callback function - NOT USED.
644 Print(argc, argv, callback)
646 char **argv, *callback;
652 (void) strcpy(buf,argv[0]); /* no newline 'cause Put_message adds one */
653 for (i = 1; i < argc; i++)
654 (void) sprintf(buf,"%s %s",buf,argv[i]);
655 (void) Put_message(buf);
660 /* Function Name: PrintByType
661 * Description: This function prints all members of the type specified
662 * by the callback arg, unless the callback is NULL, in which
663 * case it prints all members.
664 * Arguments: argc, argc - normal arguments for mr_callback function.
665 * callback - either a type of member or NULL.
666 * Returns: MR_CONT or MR_QUIT.
671 PrintByType(argc, argv, callback)
673 char **argv, *callback;
675 if (callback == NULL)
676 return( Print(argc, argv, callback) );
677 if (strcmp(argv[0], callback) == 0)
678 return( Print(argc, argv, callback) );
682 /* Function Name: PrintHelp
683 * Description: Prints Help Information in a NULL terminated
685 * Arguments: message.
686 * Returns: DM_NORMAL.
695 for (i = 0; i < CountArgs(message); i++)
696 Put_message(message[i]);
701 /* Function Name: Loop
702 * Description: This function goes through the entire queue, and
703 * and executes the given function on each element.
704 * Arguments: elem - top element of the queue.
705 * func - the function to execute.
714 while (elem != NULL) {
715 char ** info = (char **) elem->q_data;
722 /* Function Name: QueryLoop
723 * Description: This functions loops through a queue containing
724 * information about some item that we want to perform
725 * an operation on, and then calls the correct routine
726 * perform that operation.
727 * Arguments: top - top of the queue of information.
728 * print_func - print function.
729 * op_function - operation to be performed.
730 * query_string - string the prompts the user whether or not
731 * to perform this operation.
734 * print_opt - should expect one arguent, the info array
736 * is expected to return the name of the item.
737 * op_func - should expect two arguments.
738 * 1) the info array of char *'s.
739 * 2) a boolean the is true if there only
740 * one item in this queue, used for delete
742 * query_string - this should be of such a form that when the
743 * name of the object and '(y/n/q) ?' are appended
744 * then it should still make sense, an example is
749 QueryLoop(elem, print_func, op_func, query_string)
752 FCharStar print_func;
756 char temp_buf[BUFSIZ], *name;
758 elem = QueueTop(elem);
759 one_item = (QueueCount(elem) == 1);
760 while (elem != NULL) {
761 char **info = (char **) elem->q_data;
764 (*op_func) (info, one_item);
766 name = (*print_func) (info); /* call print function. */
767 sprintf(temp_buf,"%s %s (y/n/q)", query_string, name);
768 switch(YesNoQuitQuestion(temp_buf, FALSE)) {
770 (*op_func) (info, one_item);
775 Put_message("Aborting...");
783 /* Function Name: NullPrint
784 * Description: print function that returns nothing.
785 * Arguments: info - a pointer to the info array - Not used.
797 /* Function Name: GetTypeValues
798 * Description: gets legal values for a typed object, keeping a cache
799 * Arguments: type name
800 * Returns: argv of values
808 char *argv[3], *p, **pp, *strsave();
809 struct qelem *elem, *oelem;
810 static struct qelem *cache = NULL;
811 struct cache_elem { char *cache_name; struct qelem *cache_data; } *ce;
813 for (elem = cache; elem; elem = elem->q_forw) {
814 ce = (struct cache_elem *)elem->q_data;
815 if (!strcmp(ce->cache_name, tname))
816 return(ce->cache_data);
823 if (stat = do_mr_query("get_alias", 3, argv, StoreInfo, (char *)&elem)) {
824 com_err(program_name, stat, " in GetTypeValues");
828 for (elem = QueueTop(elem); elem; elem = elem->q_forw) {
829 pp = (char **) elem->q_data;
834 elem = (struct qelem *) malloc(sizeof(struct qelem));
835 ce = (struct cache_elem *) malloc(sizeof(struct cache_elem));
836 ce->cache_name = strsave(tname);
837 ce->cache_data = QueueTop(oelem);
838 elem->q_data = (char *)ce;
839 AddQueue(elem, cache);
840 cache = QueueTop(elem);
841 return(ce->cache_data);
845 /* Function Name: GetTypeFromUser
846 * Description: gets a typed value from the user
847 * Arguments: prompt string, type name, buffer pointer
848 * Returns: SUB_ERROR if ^C, SUB_NORMAL otherwise
851 int GetTypeFromUser(prompt, tname, pointer)
856 char def[BUFSIZ], buffer[BUFSIZ], *p, *argv[3];
860 strcpy(def, *pointer);
861 strcpy(buffer, prompt);
862 strcat(buffer, " (");
863 for (elem = GetTypeValues(tname); elem; elem = elem->q_forw) {
864 strcat(buffer, elem->q_data);
866 strcat(buffer, ", ");
869 if (strlen(buffer) > 64)
870 sprintf(buffer, "%s (? for help)", prompt);
871 if (GetValueFromUser(buffer, pointer) == SUB_ERROR)
873 if (**pointer == '?') {
874 sprintf(buffer, "Type %s is one of:", tname);
876 for (elem = GetTypeValues(tname); elem; elem = elem->q_forw) {
877 Put_message(elem->q_data);
879 *pointer = strsave(def);
880 return(GetTypeFromUser(prompt, tname, pointer));
882 for (elem = GetTypeValues(tname); elem; elem = elem->q_forw) {
883 if (!strcasecmp(elem->q_data, *pointer)) {
884 strcpy(*pointer, elem->q_data);
888 sprintf(buffer, "\"%s\" is not a legal value for %s. Use one of:",
891 for (elem = GetTypeValues(tname); elem; elem = elem->q_forw) {
892 Put_message(elem->q_data);
894 sprintf(buffer, "Are you sure you want \"%s\" to be a legal %s",
896 if (YesNoQuestion("Do you want this to be a new legal value", 0) == TRUE &&
897 YesNoQuestion(buffer, 0) == TRUE) {
901 /* don't uppercase access flags. Do uppercase everything else */
902 if (strncmp(tname, "fs_access", 9))
903 for (p = argv[2]; *p; p++)
906 if (stat = do_mr_query("add_alias", 3, argv, Scream, NULL)) {
907 com_err(program_name, stat, " in add_alias");
909 elem = (struct qelem *) malloc(sizeof(struct qelem));
910 elem->q_data = strsave(*pointer);
911 AddQueue(elem, GetTypeValues(tname));
912 Put_message("Done.");
915 *pointer = strsave(def);
916 return(GetTypeFromUser(prompt, tname, pointer));
920 do_mr_query(name, argc, argv, proc, hint)
928 extern char *whoami, *moira_server;
931 status = mr_query(name, argc, argv, proc, hint);
932 if (status != MR_ABORTED && status != MR_NOT_CONNECTED)
934 status = mr_connect(moira_server);
936 com_err(whoami, status, " while re-connecting to server %s",
940 status = mr_auth(whoami);
942 com_err(whoami, status, " while re-authenticating to server %s",
947 status = mr_query(name, argc, argv, proc, hint);