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

/*	This is the file f_defs.h for the SMS Client, which allows a nieve
 *      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_

/* general Library functions. */

char * malloc();

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