1 #if (!defined(lint) && !defined(SABER))
2 static char rcsid_module_c[] = "$Header$";
5 /* This is the file lists.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: All list manipulation functions, except delete.
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>
28 #include "mit-copyright.h"
38 #define DEFAULT_ACTIVE DEFAULT_YES
39 #define DEFAULT_PUBLIC DEFAULT_YES
40 #define DEFAULT_HIDDEN DEFAULT_NO
41 #define DEFAULT_MAILLIST DEFAULT_YES
42 #define DEFAULT_GROUP DEFAULT_NO
43 #define DEFAULT_GID UNIQUE_GID
44 #define DEFAULT_ACE_TYPE "user"
45 #define DEFAULT_ACE_NAME (user)
46 #define DEFAULT_DESCRIPTION DEFAULT_COMMENT
48 /* globals only for this file. */
50 static char current_list[BUFSIZ];
52 /* Function Name: PrintListAce
53 * Description: This function prints the list ace information.
54 * Arguments: info - an info structure.
64 sprintf(buf, "Item: %-20s Name: %s", info[ACE_TYPE],
69 /* Function Name: PrintListInfo
70 * Description: This function Prints out the List info in a coherent form.
71 * Arguments: info - the List info.
82 (void) sprintf(buf, "%20sList: %s", "", info[L_NAME]);
83 (void) Put_message(buf);
84 (void) sprintf(buf, "Description: %s", info[L_DESC]);
85 (void) Put_message(buf);
86 if ( atoi(info[L_MAILLIST]))
87 Put_message("This list is a mailing list.");
89 Put_message("This list is NOT a mailing list.");
90 if ( atoi(info[L_GROUP]) ) {
91 (void) sprintf(buf,"This list is a Group and its ID number is %s",
96 Put_message("This list is NOT a Group.");
98 if (strcmp(info[L_ACE_TYPE],"NONE") == 0)
99 Put_message("This list has no Administrator, how strange?!");
101 sprintf(buf, "The Administrator of this list is the %s: %s",
102 info[L_ACE_TYPE], info[L_ACE_NAME]);
106 (void) sprintf(buf, "This list is: %s, %s, and %s",
107 atoi(info[L_ACTIVE]) ? "active" : "inactive",
108 atoi(info[L_PUBLIC]) ? "public" : "private",
109 atoi(info[L_HIDDEN]) ? "hidden" : "visible");
110 (void) Put_message(buf);
111 sprintf(buf, MOD_FORMAT, info[L_MODBY], info[L_MODTIME], info[L_MODWITH]);
112 (void) Put_message(buf);
115 /* Function Name: GetListInfo
116 * Description: Stores all info about a group of lists in a queue.
117 * Arguments: type - type of info to store.
118 * name - name of the info.
119 * Returns: the first element in the queue.
124 GetListInfo(type, name1, name2)
126 char * name1, *name2;
129 struct qelem * elem = NULL;
135 if ( (status = do_mr_query("get_list_info", 1, args,
136 StoreInfo, (char *) &elem)) != 0) {
137 com_err(program_name, status, " in get_list_info");
143 if ( (status = do_mr_query("get_members_of_list", 1, args,
144 StoreInfo, (char *) &elem)) != 0) {
145 com_err(program_name, status, " in get_members_of_list");
152 if ( (status = do_mr_query("get_lists_of_member", 2, args,
153 StoreInfo, (char *) &elem)) != 0) {
154 com_err(program_name, status, " in get_list_of_members");
161 if ( (status = do_mr_query("get_ace_use", 2, args,
162 StoreInfo, (char *) &elem)) != 0) {
163 com_err(program_name, status, " in get_ace_use");
168 return( QueueTop(elem) );
171 /* Function Name: AskListInfo.
172 * Description: This function askes the user for information about a
173 * machine and saves it into a structure.
174 * Arguments: info - a pointer the the structure to put the
176 * name - add a newname field? (T/F)
177 * Returns: SUB_ERROR or SUB_NORMAL.
181 AskListInfo(info, name)
185 char temp_buf[BUFSIZ], *newname;
188 sprintf(temp_buf,"Setting information of list %s.",info[L_NAME]);
189 Put_message(temp_buf);
194 newname = Strsave(info[L_NAME]);
195 if (GetValueFromUser("The new name for this list", &newname) ==
198 if (ValidName(newname))
202 if (GetYesNoValueFromUser("Is this an active list", &info[L_ACTIVE]) ==
205 if (GetYesNoValueFromUser("Is this a public list", &info[L_PUBLIC]) ==
208 if (GetYesNoValueFromUser("Is this a hidden list", &info[L_HIDDEN]) ==
211 if (GetYesNoValueFromUser("Is this a maillist", &info[L_MAILLIST]) ==
214 if (GetYesNoValueFromUser("Is this a group", &info[L_GROUP]) == SUB_ERROR)
216 if (atoi(info[L_GROUP]))
217 if (GetValueFromUser("What is the GID for this group.", &info[L_GID]) ==
221 if (GetTypeFromUser("What Type of Administrator", "ace_type",
222 &info[L_ACE_TYPE]) == SUB_ERROR)
224 if ((strcasecmp(info[L_ACE_TYPE], "NONE") != 0) &&
225 (strcasecmp(info[L_ACE_TYPE], "none") != 0)) {
226 sprintf(temp_buf, "Which %s will be the administrator of this list: ",
228 if (GetValueFromUser(temp_buf, &info[L_ACE_NAME]) == SUB_ERROR)
231 if (GetValueFromUser("Description: ", &info[L_DESC]) == SUB_ERROR)
234 FreeAndClear(&info[L_MODTIME], TRUE);
235 FreeAndClear(&info[L_MODBY], TRUE);
236 FreeAndClear(&info[L_MODWITH], TRUE);
238 * Slide the newname into the #2 slot, this screws up all future references
241 if (name) /* slide the newname into the #2 slot. */
242 SlipInNewName(info, newname);
247 /* -------------- List functions. -------------- */
249 /* Function Name: ShowListInfo.
250 * Description: shows info on a list.
251 * Arguments: argc, argv - name of list in argv[1].
252 * Returns: DM status code.
257 ShowListInfo(argc, argv)
261 struct qelem *top, *list;
263 top = list = GetListInfo(LIST, argv[1], (char *) NULL);
264 while (list != NULL) {
265 PrintListInfo( (char **) list->q_data);
273 /* Function Name: RealUpdateList
274 * Description: performs the actual update of the list.
275 * Arguments: info - all information needed to update the list.
276 * junk - an UNUSED boolean.
282 RealUpdateList(info, junk)
289 if ((args = AskListInfo(info, TRUE)) == NULL) {
290 Put_message("Aborted.");
293 if ( (stat = do_mr_query("update_list", CountArgs(args), args,
294 Scream, (char *) NULL)) != MR_SUCCESS) {
295 com_err(program_name, stat, " in UpdateList.");
296 Put_message("List ** NOT ** Updated.");
299 Put_message("List successfully updated.");
302 /* Function Name: UpdateList
303 * Description: updates the information on a list.
304 * Arguments: argc, argv - name of list in argv[1].
305 * Returns: DM Status code.
310 UpdateList(argc, argv)
316 top = GetListInfo(LIST, argv[1], (char *) NULL);
317 QueryLoop(top, NullPrint, RealUpdateList, "Update the list");
323 /* Function Name: SetDefaults
324 * Description: sets defaults for AddList function
325 * Arguments: info - the array to add them to.
326 * name - name of the program to add.
327 * Returns: defaults - the default information.
331 SetDefaults(info, name)
335 info[L_NAME] = Strsave(name);
336 info[L_ACTIVE] = Strsave(DEFAULT_ACTIVE);
337 info[L_PUBLIC] = Strsave(DEFAULT_PUBLIC);
338 info[L_HIDDEN] = Strsave(DEFAULT_HIDDEN);
339 info[L_MAILLIST] = Strsave(DEFAULT_MAILLIST);
340 info[L_GROUP] = Strsave(DEFAULT_GROUP);
341 info[L_GID] = Strsave(DEFAULT_GID);
342 info[L_ACE_TYPE] = Strsave(DEFAULT_ACE_TYPE);
343 info[L_ACE_NAME] = Strsave(DEFAULT_ACE_NAME);
344 info[L_DESC] = Strsave(DEFAULT_DESCRIPTION);
345 info[L_MODTIME] = info[L_MODBY] = info[L_MODWITH] = info[L_END] = NULL;
349 /* Function Name: AddList
351 * Arguments: argc, argv - name of list in argv[1].
352 * Returns: SUB_ERROR if list not created.
361 static char *info[MAX_ARGS_SIZE], **add_args;
362 int status, ret_code = SUB_NORMAL;
364 if (!ValidName(argv[1]))
366 status = do_mr_query("get_list_info", 1, argv + 1, NullFunc,
368 if (status != MR_NO_MATCH) {
369 if (status == MR_SUCCESS)
370 Put_message("This list already exists.");
372 com_err(program_name, status, " in AddList.");
376 if ((add_args = AskListInfo(SetDefaults(info,argv[1]), FALSE)) == NULL) {
377 Put_message("Aborted.");
381 if ( (status = do_mr_query("add_list", CountArgs(add_args), add_args,
382 Scream, (char *) NULL)) != MR_SUCCESS) {
383 com_err(program_name, status, " in AddList.");
384 Put_message("List Not Created.");
385 ret_code = SUB_ERROR;
392 /* Function Name: Instructions
393 * Description: This func prints out instruction on manipulating lists.
395 * Returns: DM Status Code.
401 static char * message[] = {
402 "Listmaint handles the creation, deletion, and updating of lists.",
403 "A list can be a mailing list, a group list, or both.",
404 "The concept behind lists is that a list has an owner",
405 "- administrator - and members.",
406 "The administrator of a list may be another list.",
407 "The members of a list can be users (login names), other lists,",
408 "or address strings.",
409 "You can use certain keys to do the following:",
410 " Refresh the screen - Type ctrl-L.",
411 " Escape from a function - Type ctrl-C.",
412 " Suspend the program (temporarily) - Type ctrl-Z.",
416 return(PrintHelp(message));
419 /*-*-* LISTMAINT UPDATE MENU *-*-*/
421 /* Function Name: ListmaintMemberMenuEntry
422 * Description: entry routine into the listmaint member menu.
423 * Arguments: m - the member menu.
424 * argc, argv - name of the list in argv[1].
430 ListmaintMemberMenuEntry(m, argc, argv)
435 char temp_buf[BUFSIZ];
436 char *list_name = argv[1];
439 if (!ValidName(list_name))
442 if (*argv[0] == 'a') { /* add_list */
443 if (AddList(argc, argv) == SUB_ERROR)
445 (void) sprintf(temp_buf, "List '%s' created. Do you want to %s",
446 list_name, "change its membership (y/n)? ");
447 if (YesNoQuestion(temp_buf, TRUE) != TRUE )
451 /* All we want to know is if it exists. */
452 switch( (stat = do_mr_query("count_members_of_list", 1, argv + 1,
453 NullFunc, (char *) NULL))) {
457 Put_message("This list does not exist.");
460 Put_message("You are not allowed to view this list.");
463 com_err(program_name, stat, " in get_list_info");
467 (void) sprintf(temp_buf,
468 "Change/Display membership of '%s'", list_name);
469 m->m_title = Strsave(temp_buf);
470 strcpy(current_list, list_name);
474 /* Function Name: ListmaintMemberMenuExit
475 * Description: This is the function called when the member menu is
476 * exited, it frees the memory that is storing the name.
477 * Arguments: m - the menu
482 ListmaintMemberMenuExit(m)
486 strcpy(current_list, "");
490 /* Function Name: ListMembersByType
491 * Description: This function lists the users of a list by type.
492 * Arguments: type - the type of the list "USER", "LIST", or "STRING".
494 * NOTE: if type is NULL, all lists members are listed.
498 ListMembersByType(type)
501 char temp_buf[BUFSIZ];
505 args[0] = current_list;
509 if ( (status = do_mr_query("get_members_of_list", CountArgs(args), args,
510 PrintByType, type)) != 0) {
511 com_err(program_name, status, " in ListMembersByType");
516 Put_message("List is empty (no members).");
518 sprintf(temp_buf,"No %s Members",type);
519 Put_message(temp_buf);
524 /* Function Name: ListAllMembers
525 * Description: lists all members of the current list.
533 ListMembersByType(NULL);
537 /* Function Name: ListUserMembers
538 * Description: This function lists all members of a list of type "USER".
540 * Returns: DM_NORMAL.
545 ListMembersByType("USER");
549 /* Function Name: ListListMembers
550 * Description: This function lists all members of a list of type "LIST".
552 * Returns: DM_NORMAL.
557 ListMembersByType("LIST");
561 /* Function Name: ListStringMembers
562 * Description:This function lists all members of a list of type "STRING".
564 * Returns: DM_NORMAL.
569 ListMembersByType("STRING");
573 /* Function Name: GetMemberInfo
574 * Description: This function gets the information needed to
575 * add or delete a user from a list.
576 * Arguments: argc, argv - standard.
577 * action - name of the action to be performed either
579 * ret_argc, ret_argv - the returned value of argc and argv.
580 * Returns: SUB_ERROR or SUB_NORMAL.
584 GetMemberInfo(action, ret_argv)
585 char *action, **ret_argv;
587 char temp_buf[BUFSIZ];
589 ret_argv[LM_LIST] = Strsave(current_list);
591 ret_argv[LM_TYPE] = Strsave("user");
592 if (GetTypeFromUser("Type of member", "member", &ret_argv[LM_TYPE]) ==
596 sprintf(temp_buf,"Name of %s to %s", ret_argv[LM_TYPE], action);
597 ret_argv[LM_MEMBER] = Strsave(user);
598 if (GetValueFromUser(temp_buf, &ret_argv[LM_MEMBER]) == SUB_ERROR)
600 ret_argv[LM_END] = NULL; /* NULL terminate this list. */
602 if (strcasecmp(ret_argv[LM_TYPE], "string") &&
603 !ValidName( ret_argv[LM_MEMBER] ) ) {
610 /* Function Name: AddMember
611 * Description: This function adds a member to a list.
613 * Returns: DM_NORMAL.
619 char *args[10], temp_buf[BUFSIZ], *p;
621 struct qelem *mailhubs, *elem, *GetTypeValues();
623 if ( GetMemberInfo("add", args) == SUB_ERROR )
626 if (!strcmp(args[LM_TYPE], "STRING")) {
627 if (p = strchr(args[LM_MEMBER], '@')) {
628 char *host = canonicalize_hostname(strsave(++p));
629 mailhubs = GetTypeValues("mailhub");
630 for (elem = mailhubs; elem; elem = elem->q_forw) {
631 if (!strcasecmp(host, elem->q_data)) {
633 host = strsave(args[LM_MEMBER]);
635 sprintf(temp_buf, "String \"%s\" should be USER or LIST \"%s\" because it is a local name.",
636 host, args[LM_MEMBER]);
637 Put_message(temp_buf);
644 } else if (!strchr(args[LM_MEMBER], '!')) {
645 Put_message("Member which is not a foreign mail address should not be type STRING.");
650 if ( (status = do_mr_query("add_member_to_list", CountArgs(args), args,
651 Scream, NULL)) != MR_SUCCESS) {
652 if (status == MR_EXISTS) {
653 sprintf(temp_buf, "The %s %s is already a member of LIST %s.",
654 args[LM_TYPE], args[LM_MEMBER], args[LM_LIST]);
655 Put_message(temp_buf);
658 com_err(program_name, status, " in AddMember");
665 /* Function Name: DeleteMember
666 * Description: This function deletes a member from a list.
677 if( GetMemberInfo("delete", args) == SUB_ERROR )
680 if (Confirm("Are you sure you want to delete this member?") ) {
681 if (status = do_mr_query("delete_member_from_list", CountArgs(args),
683 com_err(program_name, status, " in DeleteMember");
685 Put_message("Deletion Completed.");
688 Put_message("Deletion has been Aborted.");
694 /* Function Name: InterRemoveItemFromLists
695 * Description: This function allows interactive removal of an item
696 * (user, string, list) for all list that it is on.
698 * Returns: DM_NORMAL.
699 * NOTES: QueryLoop() does not work here because info does not have
700 * enough information in it to delete the member from the list.
704 InterRemoveItemFromLists()
707 char *type, *name, *args[10], buf[BUFSIZ];
708 struct qelem *top, *elem;
710 type = strsave("USER");
711 if (GetTypeFromUser("Type of member", "member", &type) == SUB_ERROR)
714 sprintf(buf, "Name of %s", type);
715 name = strsave(user);
716 if (GetValueFromUser(buf, &name) == SUB_ERROR)
719 if (!ValidName(name))
722 top = elem = GetListInfo(GLOM, type, name);
724 while(elem != NULL) {
726 char ** info = (char **) elem->q_data;
727 sprintf(line, "Delete %s %s from the list \"%s\" (y/n/q)? ", type,
728 name, info[GLOM_NAME]);
729 switch (YesNoQuitQuestion(line, FALSE)) {
731 Put_message("deleting...");
732 args[DM_LIST] = info[GLOM_NAME];
733 args[DM_TYPE] = type;
734 args[DM_MEMBER] = name;
735 if ( (status = do_mr_query("delete_member_from_list", 3, args,
736 Scream, (char *) NULL)) != 0)
737 /* should probabally check to delete list. */
738 com_err(program_name, status, " in delete_member");
743 Put_message("Aborting...");
753 /*-*-* LIST MENU *-*-*/
755 /* Function Name: ListByMember
756 * Description: This gets all lists that a given member is a member of.
758 * Returns: DM_NORMAL.
764 char buf[BUFSIZ], temp_buf[BUFSIZ], *type, *name, **info;
765 Bool maillist, group;
766 struct qelem *top, *elem;
768 type = strsave("USER");
769 if (GetTypeFromUser("Type of member", "member", &type) == SUB_ERROR)
772 sprintf(buf, "Name of %s", type);
773 name = strsave(user);
774 if (GetValueFromUser(buf, &name) == SUB_ERROR)
777 /* What we really want is a recursive search */
778 sprintf(temp_buf, "R%s", type);
779 free(type); type = Strsave(temp_buf);
781 if ((maillist = YesNoQuestion("Show Lists that are Maillists (y/n) ?",
784 if ((group = YesNoQuestion("Show Lists that are Groups (y/n) ?",
788 elem = top = GetListInfo(GLOM, type, name);
790 while (elem != NULL) {
791 info = (char**) elem->q_data;
792 if ((maillist == TRUE && !strcmp(info[GLOM_MAILLIST], "1")) ||
793 (group == TRUE && !strcmp(info[GLOM_GROUP], "1")))
794 Put_message(info[GLOM_NAME]);
801 /* Function Name: ListByAdministrator
802 * Description: This function prints all lists which a given user or
805 * Returns: DM_NORMAL.
809 ListByAdministrator()
811 char buf[BUFSIZ], temp_buf[BUFSIZ], *type, *name;
814 type = strsave("USER");
815 if (GetTypeFromUser("Type of member", "member", &type) == SUB_ERROR)
818 sprintf(buf, "Name of %s", type);
819 name = strsave(user);
820 if (GetValueFromUser(buf, &name) == SUB_ERROR)
823 switch (YesNoQuestion("Do you want a recursive search (y/n)", FALSE)) {
825 sprintf(temp_buf, "R%s", type); /* "USER" to "RUSER" etc. */
827 type = Strsave(temp_buf);
835 top = GetListInfo(ACE_USE, type, name);
836 Loop(top, PrintListAce);
842 /* Function Name: ListAllPublicMailLists
843 * Description: This function lists all public mailing lists.
845 * Returns: DM_NORMAL.
848 ListAllPublicMailLists()
851 static char * args[] = {
854 "FALSE", /* hidden */
855 "TRUE", /* maillist */
856 "DONTCARE", /* group. */
859 if (YesNoQuestion("This query will take a while. Do you wish to continue?",
861 if (status = do_mr_query("qualified_get_lists", 5, args,
862 Print, (char *) NULL) != 0)
863 com_err(program_name, status, " in ListAllGroups");