[moira.git] / clients / moira / f_defs.h

/*	This is the file f_defs.h for the SMS Client, which allows a
 *      user to quickly and easily maintain most parts of the SMS database.
 *	It Contains: useful definitions.
 *
 *	Created: 	4/12/88
 *	By:		Chris D. Peterson
 *
 *      $Source$
 *      $Author$
 *      $Header$
 *
 *  	Copyright 1988 by the Massachusetts Institute of Technology.
 *
 *	For further information on copyright and distribution
 *	see the file mit-copyright.h
 */

#include "mit-copyright.h"

#ifndef _f_defs_
#define _f_defs_

/* attach.c */

int GetFS();			/* Get information about named filsys. */
int GetFSM();			/* Get filesys by machine */
int AddFS();			/* Adds a new Filsys to the database. */
int ChangeFS();			/* Changes information in a Filsys entry. */
int DeleteFS();			/* Delete a filesystem from the database. */

int AddFSToGroup();		/* Add a filesystem to an fsgroup */
int RemoveFSFromGroup();	/* remove a filesystem from an fsgroup */
int ChangeFSGroupOrder();	/* change the sortorder on an fsgrouop */
int FSGroupHelp();		/* print info about fsgroups */

int GetFSAlias();		/* Gets the value for a Filsys alias. */
int CreateFSAlias();		/* Creates a new alias in the database. */
int DeleteFSAlias();		/* Deletes an FS alias from the database. */

int AttachHelp();		/* Help information specific to filsys. */

/* cluster.c */

int ShowMachineInfo();		/* Show information on a(many) machine(s). */
int ShowMachineQuery();		/* Show mach info based on complex query */
int AddMachine();		/* add a new machine to teh database. */
int UpdateMachine();		/* updates machine information. */
int DeleteMachine();		/* delete a machine from the database. */
int MachineToClusterMap();	/* show machines in clusters. */
int AddMachineToCluster();	/* add a machine to a new cluster. */
int RemoveMachineFromCluster();	/* remove a machine from a cluster. */

int ShowClusterInfo();		/* Show information about a cluster. */
int AddCluster();		/* adds a new cluster to the database. */
int UpdateCluster();		/* updates information about a cluster. */
int DeleteCluster();		/* removes a cluste from the database. */

int ShowClusterInfo();		/* show information about a cluster. */
int MachinesInCluster();	/* list all machines in a give cluster. */
int AddCluster();
int UpdateCluster();		/* add, update, and delete clusters. */
int DeleteCluster();

int ShowClusterData();		/* Show, add, and remove data  */
int AddClusterData();		/* associated with a cluster. */
int RemoveClusterData();

int ShowSubnetInfo();
int AddSubnet();
int UpdateSubnet();
int DeleteSubnet();

int ShowCname();
int AddCname();
int DeleteCname();

/* delete.c */

int DeleteList(), DeleteUser();

/* lists.c */

int ListByMember();		/* list all list to which a member belongs. */
int ListByAdministrator();	/* list all list to which a given member can
				 administer. */
int ListAllGroups();
int ListAllPublicMailLists();	/* List misc. types of lists. */
int ListAllMailLists();

int AddMember(), DeleteMember(); /* add and delete mamber of current list. */
int ListAllMembers();
int ListUserMembers();		/* List various members of the current list. */
int ListListMembers();
int ListStringMembers();

int ShowListInfo();		/* show info about a list. */
int UpdateList();		/* change info about a list. */
int InterRemoveItemFromLists();	/* Interactivly remove item from all lists */

int ListmaintMemberMenuEntry();	/* entry and exit functions for member menu. */
int ListmaintMemberMenuExit();
int ListHelp();			/* help function for lists. */

/* nfs.c */

int ShowNFSService();		/* functions that manipulate nfs physical  */
int AddNFSService();		/* services. */
int UpdateNFSService();
int DeleteNFSService();

/* pobox.c */

int GetUserPOBox();		/* operate on user post office boxes. */
int SetUserPOBox();
int RemoveUserPOBox();

/* quota.c */

int ShowDefaultQuota();		/* show or change system default quota. */
int ChangeDefaultQuota();

int GetQuota();	        	/* modify a user's quota. */
int GetQuotaByFilesys();
int AddQuota();
int UpdateQuota();
int DeleteQuota();

/* user.c */

int ShowUserByLogin();		/* misc. ways to show user. */
int ShowUserByName();
int ShowUserByClass();
int ShowUserById();
int AddNewUser();		/* add a new user to the database. */
int RegisterUser();		/* register a user. */
int UpdateUser();		/* modify info about a user. */
int DeactivateUser();		/* change a user's status to DELETED */
int ChangeUserPOBox();		/* change the PO box of a user. */
int DeleteUserByUid();		/* detete a user by uid. */
int GetKrbmap();		/* fetch a user->kerberos mapping */
int AddKrbmap();
int DeleteKrbmap();
int GetDirFlags();
int SetDirFlags();

/* printer.c */
int AddPcap();
int GetPcap();
int ChngPcap();
int DeletePcap();
int GetPalladium(), AddPalladium(), ChngPalladium(), DeletePalladium();
int ShowPalladiumAlias(), AddPalladiumAlias(), DeletePalladiumAlias();

/* zephyr.c */
int AddZephyr();
int GetZephyr();
int ChngZephyr();
int DeleteZephyr();

/* dcm.c */
int EnableDcm(), InProgress(), DcmFailed(), Dcm();
int enabledcm(), showserv(), addserv(), updateserv(), delserv();
int showhost(), resetsrverr(), resetsrvc(), resethosterr();
int resethost(), sethostor(), addhost(), updatehost(), delhost();
int inprogress(), failed(), dcm();

/* misc.c */
int TableStats(), ShowClients(), ShowValue(), ShowAlias();

/* utils.c */

/*
 * For descriptions of all of these functions see the
 * internals documentation.
 */

void EncryptMITID();		/* Encrypts an mit id number. */
char **CopyInfo();		/* Copies a NULL terminated array of strings */
void FreeInfo();		/* Frees a NULL terminated array of strings. */
void FreeQueue();		/* Frees an entire queue. */
void FreeAndClear();		/* Frees a single pointer. */
void Loop();			/* Performs an operation on every item in
				   a queue. */
void QueryLoop();		/* Queries the user before performing
				   an operation on every item in
				   a queue. */
void RemoveHyphens();		/* Removes the hyphens from a string. */
void SlipInNewName();		/* Slips a new name into an argument list in
				   the correct place. */
int CountArgs();		/* Counts the strings in a NULL terminated
				   array. */
int GetValueFromUser();		/* Updates value by asking the user. */
int GetYesNoValueFromUser();	/* Updates yes/no value by asking the user. */
int GetFSTypes();		/* Gets Filesystem types from a user. */
int NullFunc();			/* NULL return function. */
int Print();			/* Prints out array of strings. */
int PrintByType();		/* Prints out array of strings by type. */
int PrintHelp();		/* Prints out help information. */
int StoreInfo();		/* Stores info returned from and SMS query
				   in a queue. */
int Scream();			/* Query Return function that yells if called*/
int ToggleVerboseMode();	/* Turns on and off the verbose variable. */
char *CanonicalizeHostname();	/* this is what it does. */
char *NullPrint();		/* Prints nothing, returns argv[0]. */
char *Strsave();		/* allocated space for a copy of the string. */
char *atot();			/* convert unix time to date string */
struct qelem *QueueTop();	/* Finds the top of a queue. */
Bool Confirm();			/* Confirms a delete operation, with user. */
Bool YesNoQuestion();		/* Asks a user a yes no type question. */
Bool YesNoQuitQuestion();	/* Asks a user a yes - no - quit question. */

#endif /* _f_defs_ */		/* Do Not Add Anything After This Line */
Commit	Line	Data
5eaef520	1	/* This is the file f_defs.h for the SMS Client, which allows a
ec47f9a6	2	* user to quickly and easily maintain most parts of the SMS database.
ec47f9a6	3	* It Contains: useful definitions.
5eaef520	4	*
ec47f9a6	5	* Created: 4/12/88
	6	* By: Chris D. Peterson
	7	*
	8	* $Source$
	9	* $Author$
	10	* $Header$
5eaef520	11	*
ec47f9a6	12	* Copyright 1988 by the Massachusetts Institute of Technology.
ec47f9a6	13	*
5eaef520	14	* For further information on copyright and distribution
ec47f9a6	15	* see the file mit-copyright.h
	16	*/
	17
	18	#include "mit-copyright.h"
	19
	20	#ifndef _f_defs_
	21	#define _f_defs_
	22
ec47f9a6	23	/* attach.c */
	24
	25	int GetFS(); /* Get information about named filsys. */
d232c3df	26	int GetFSM(); /* Get filesys by machine */
ec47f9a6	27	int AddFS(); /* Adds a new Filsys to the database. */
	28	int ChangeFS(); /* Changes information in a Filsys entry. */
	29	int DeleteFS(); /* Delete a filesystem from the database. */
	30
9e2516d6	31	int AddFSToGroup(); /* Add a filesystem to an fsgroup */
	32	int RemoveFSFromGroup(); /* remove a filesystem from an fsgroup */
	33	int ChangeFSGroupOrder(); /* change the sortorder on an fsgrouop */
	34	int FSGroupHelp(); /* print info about fsgroups */
	35
ec47f9a6	36	int GetFSAlias(); /* Gets the value for a Filsys alias. */
	37	int CreateFSAlias(); /* Creates a new alias in the database. */
	38	int DeleteFSAlias(); /* Deletes an FS alias from the database. */
	39
	40	int AttachHelp(); /* Help information specific to filsys. */
	41
	42	/* cluster.c */
	43
	44	int ShowMachineInfo(); /* Show information on a(many) machine(s). */
ad7e0e04	45	int ShowMachineQuery(); /* Show mach info based on complex query */
ec47f9a6	46	int AddMachine(); /* add a new machine to teh database. */
	47	int UpdateMachine(); /* updates machine information. */
	48	int DeleteMachine(); /* delete a machine from the database. */
	49	int MachineToClusterMap(); /* show machines in clusters. */
	50	int AddMachineToCluster(); /* add a machine to a new cluster. */
	51	int RemoveMachineFromCluster(); /* remove a machine from a cluster. */
	52
	53	int ShowClusterInfo(); /* Show information about a cluster. */
	54	int AddCluster(); /* adds a new cluster to the database. */
	55	int UpdateCluster(); /* updates information about a cluster. */
	56	int DeleteCluster(); /* removes a cluste from the database. */
	57
	58	int ShowClusterInfo(); /* show information about a cluster. */
	59	int MachinesInCluster(); /* list all machines in a give cluster. */
5eaef520	60	int AddCluster();
ec47f9a6	61	int UpdateCluster(); /* add, update, and delete clusters. */
	62	int DeleteCluster();
	63
	64	int ShowClusterData(); /* Show, add, and remove data */
	65	int AddClusterData(); /* associated with a cluster. */
	66	int RemoveClusterData();
	67
ad7e0e04	68	int ShowSubnetInfo();
	69	int AddSubnet();
	70	int UpdateSubnet();
	71	int DeleteSubnet();
	72
	73	int ShowCname();
	74	int AddCname();
	75	int DeleteCname();
	76
ec47f9a6	77	/* delete.c */
	78
	79	int DeleteList(), DeleteUser();
	80
	81	/* lists.c */
	82
	83	int ListByMember(); /* list all list to which a member belongs. */
	84	int ListByAdministrator(); /* list all list to which a given member can
	85	administer. */
5eaef520	86	int ListAllGroups();
ec47f9a6	87	int ListAllPublicMailLists(); /* List misc. types of lists. */
	88	int ListAllMailLists();
	89
	90	int AddMember(), DeleteMember(); /* add and delete mamber of current list. */
	91	int ListAllMembers();
	92	int ListUserMembers(); /* List various members of the current list. */
	93	int ListListMembers();
	94	int ListStringMembers();
	95
	96	int ShowListInfo(); /* show info about a list. */
	97	int UpdateList(); /* change info about a list. */
5eaef520	98	int InterRemoveItemFromLists(); /* Interactivly remove item from all lists */
ec47f9a6	99
ec47f9a6	100	int ListmaintMemberMenuEntry(); /* entry and exit functions for member menu. */
5eaef520	101	int ListmaintMemberMenuExit();
ec47f9a6	102	int ListHelp(); /* help function for lists. */
	103
	104	/* nfs.c */
	105
	106	int ShowNFSService(); /* functions that manipulate nfs physical */
	107	int AddNFSService(); /* services. */
	108	int UpdateNFSService();
	109	int DeleteNFSService();
	110
	111	/* pobox.c */
	112
	113	int GetUserPOBox(); /* operate on user post office boxes. */
	114	int SetUserPOBox();
	115	int RemoveUserPOBox();
	116
	117	/* quota.c */
	118
	119	int ShowDefaultQuota(); /* show or change system default quota. */
	120	int ChangeDefaultQuota();
	121
9550857c	122	int GetQuota(); /* modify a user's quota. */
	123	int GetQuotaByFilesys();
	124	int AddQuota();
	125	int UpdateQuota();
	126	int DeleteQuota();
ec47f9a6	127
	128	/* user.c */
	129
	130	int ShowUserByLogin(); /* misc. ways to show user. */
	131	int ShowUserByName();
	132	int ShowUserByClass();
81701699	133	int ShowUserById();
ec47f9a6	134	int AddNewUser(); /* add a new user to the database. */
	135	int RegisterUser(); /* register a user. */
	136	int UpdateUser(); /* modify info about a user. */
8a48c3f7	137	int DeactivateUser(); /* change a user's status to DELETED */
ec47f9a6	138	int ChangeUserPOBox(); /* change the PO box of a user. */
ec47f9a6	139	int DeleteUserByUid(); /* detete a user by uid. */
2246fa87	140	int GetKrbmap(); /* fetch a user->kerberos mapping */
	141	int AddKrbmap();
	142	int DeleteKrbmap();
10207d4d	143	int GetDirFlags();
10207d4d	144	int SetDirFlags();
ec47f9a6	145
4bfa54ec	146	/* printer.c */
	147	int AddPcap();
	148	int GetPcap();
	149	int ChngPcap();
	150	int DeletePcap();
2246fa87	151	int GetPalladium(), AddPalladium(), ChngPalladium(), DeletePalladium();
2246fa87	152	int ShowPalladiumAlias(), AddPalladiumAlias(), DeletePalladiumAlias();
4bfa54ec	153
c6ce81c2	154	/* zephyr.c */
	155	int AddZephyr();
	156	int GetZephyr();
	157	int ChngZephyr();
	158	int DeleteZephyr();
	159
4bfa54ec	160	/* dcm.c */
	161	int EnableDcm(), InProgress(), DcmFailed(), Dcm();
	162	int enabledcm(), showserv(), addserv(), updateserv(), delserv();
	163	int showhost(), resetsrverr(), resetsrvc(), resethosterr();
	164	int resethost(), sethostor(), addhost(), updatehost(), delhost();
	165	int inprogress(), failed(), dcm();
	166
58c38ae1	167	/* misc.c */
	168	int TableStats(), ShowClients(), ShowValue(), ShowAlias();
	169
ec47f9a6	170	/* utils.c */
ec47f9a6	171
5eaef520	172	/*
5eaef520	173	* For descriptions of all of these functions see the
ec47f9a6	174	* internals documentation.
	175	*/
	176
	177	void EncryptMITID(); /* Encrypts an mit id number. */
c5ad9c7b	178	char *CopyInfo(); / Copies a NULL terminated array of strings */
ec47f9a6	179	void FreeInfo(); /* Frees a NULL terminated array of strings. */
	180	void FreeQueue(); /* Frees an entire queue. */
	181	void FreeAndClear(); /* Frees a single pointer. */
	182	void Loop(); /* Performs an operation on every item in
	183	a queue. */
5eaef520	184	void QueryLoop(); /* Queries the user before performing
ec47f9a6	185	an operation on every item in
	186	a queue. */
	187	void RemoveHyphens(); /* Removes the hyphens from a string. */
	188	void SlipInNewName(); /* Slips a new name into an argument list in
	189	the correct place. */
5eaef520	190	int CountArgs(); /* Counts the strings in a NULL terminated
ec47f9a6	191	array. */
ec47f9a6	192	int GetValueFromUser(); /* Updates value by asking the user. */
5eaef520	193	int GetYesNoValueFromUser(); /* Updates yes/no value by asking the user. */
ec47f9a6	194	int GetFSTypes(); /* Gets Filesystem types from a user. */
	195	int NullFunc(); /* NULL return function. */
	196	int Print(); /* Prints out array of strings. */
	197	int PrintByType(); /* Prints out array of strings by type. */
	198	int PrintHelp(); /* Prints out help information. */
	199	int StoreInfo(); /* Stores info returned from and SMS query
	200	in a queue. */
	201	int Scream(); /* Query Return function that yells if called*/
	202	int ToggleVerboseMode(); /* Turns on and off the verbose variable. */
	203	char CanonicalizeHostname(); / this is what it does. */
	204	char NullPrint(); / Prints nothing, returns argv[0]. */
	205	char Strsave(); / allocated space for a copy of the string. */
3ceae461	206	char atot(); / convert unix time to date string */
5eaef520	207	struct qelem QueueTop(); / Finds the top of a queue. */
ec47f9a6	208	Bool Confirm(); /* Confirms a delete operation, with user. */
	209	Bool YesNoQuestion(); /* Asks a user a yes no type question. */
	210	Bool YesNoQuitQuestion(); /* Asks a user a yes - no - quit question. */
	211
c5ad9c7b	212	#endif /* _f_defs_ / / Do Not Add Anything After This Line */
ec47f9a6	213
ec47f9a6	214