/*
 *
 *	Copyright (C) 1988, 1989 by the Massachusetts Institute of Technology
 *    	Developed by the MIT Student Information Processing Board (SIPB).
 *    	For copying information, see the file mit-copyright.h in this release.
 *
 */
/*
 *
 * mtg.h  -- Include file for things that define the structure of a meeting.
 *
 */

/*
 *
 * A discuss meeting is a directory with various files in it,
 * like the 'trans' file, and the 'control' file.  
 *
 * 'trans' contains the text of the transactions, one after another,
 * and is written in an append-only fashion.  This reduces the chance that
 * actual transactions will become munged, and will make writing utilities
 * to hack meetings (expunging them, salvaging them) very easy.
 *
 * 'control' contains the other parts of the meeting.  This contains the
 * latest information about the meeting itself (the superblock), and
 * how transactions are chained together.
 *
 */

/*
 *
 * mtg_super -- Structure definition for the meeting superblk.  This structure
 * 		sits at the base of the control file.
 *
 *		Short name, long name, and chairman are strings, which we do
 *		not hold in any fixed length field.  They are stored at
 *		location faddr, in the file, and have slen bytes, including
 *		a trailing NULL.  
 * 
 */
typedef struct {
        int version;			/* version of this structure */
	int unique;			/* magic number */
	trn_nums first;			/* first logical trn */
	trn_nums last;			/* last  logical trn */
	trn_nums lowest;		/* lowest  physical trn */
	trn_nums highest;		/* highest physical trn */
	trn_nums highest_chain;		/* highest chain number */
	time_t date_created;		/* when created */
	time_t date_modified;		/* when modified */
	
	faddr long_name_addr;		/* location of long name string */
	faddr chairman_addr;		/* location of chairman string */
	slen long_name_len;		/* len of long name */
	slen chairman_len;		/* len of chairman */
	short flags;			/* meeting flag (low-bit is public) */
	faddr chain_start;		/* starting address for chain structure */
	faddr high_water;		/* next byte to be used in control file */
	faddr trn_fsize;		/* next byte to be used in trn file */
	faddr highest_trn_addr;		/* address of highest trn addr */
} mtg_super;

/* Masks for meeting flags */
#define MTG_PUBLIC	0x01
#define MTG_NOZEPHYR	0x02

/* version number */
#define MTG_SUPER_1 1

/* unique number */
#define MTG_SUPER_UNIQUE 100866
#define MTG_SUPER_UNIQUE_SWAP 0x028a0100


/*
 *
 * chain_blk -- Basic component of the chain structure, which is kept in the
 * 		control file.  Since it is a fixed length structure,
 *		the chain_blk's are just an array based at 
 *		mtg_super.chain_start, extending to the end of the file.
 *
 *		The information in this structure describes two different
 *		entities, which are merged for convenience's sake.  The
 *		first half describes the chaining information for the
 *		transaction numbered 'current'.  The second half describes
 *		the chain numbered 'current'.  We can do this because
 *		we will never have more chains than transactions.
 *
 */
typedef struct {
        int version;				/* version number */
	int unique;				/* magic number */
	trn_nums current;			/* this trn num */
	trn_nums prev;				/* previous non-deleted trn */
	trn_nums next;				/* next trn */
	trn_nums pref;				/* pref trn */
	trn_nums nref;				/* nref trn */
	int trn_chain;				/* which chain trn is in */
	faddr trn_addr;				/* location of trn */
	short flags;				/* transaction deleted, etc */
	bool filler;				/* filler -- must be zero */

	/* the rest of this information describes the chain numbered current */
	trn_nums chain_fref;			/* fref of chain */
	trn_nums chain_lref;			/* lref of chain */
} chain_blk;

/* version & magic */
#define CHAIN_BLK_1 1
#define CHAIN_BLK_UNIQUE 102966

/* flags for transactions */
#define CB_DELETED 1

/*
 *
 * trn_base --  base of transaction file.  This structure records
 * 		historical information about the creation of this meeting.
 *		This is kept just in case something gets destroyed.
 *
 */

typedef struct {
        int version;			/* version of this structure */
	int unique;			/* magic number */
	time_t date_created;		/* when created */
	faddr long_name_addr;		/* location of long name string */
	faddr chairman_addr;		/* location of chairman string */
	slen long_name_len;		/* len of long name */
	slen chairman_len;		/* len of chairman */
	bool public_flag;		/* meeting is public */
} trn_base;

#define TRN_BASE_1 1
#define TRN_BASE_UNIQUE 070476
#define TRN_BASE_UNIQUE_SWAP 0x3e710000

/*
 *
 *  trn_hdr --  defines the header of a transaction.  This holds everything
 *		but the chaining information, except it remembers what pref
 *		was (so that chains can be reconstructed).
 *
 */
typedef struct {
        int version;				/* version of this struct */
	int unique;				/* magic number */
	trn_nums current;			/* this transaction number */
	trn_nums orig_pref;			/* original pref trn */
	time_t date_entered;			/* date/time trn entered */
	int num_lines;				/* # lines in trn */
	int num_chars;				/* # chars in trn */
	faddr prev_trn;				/* addr of prev */
	faddr subject_addr;			/* address of subject */
	faddr author_addr;			/* addr of author & signature*/
	faddr text_addr;			/* address of trn text */
	slen subject_len;			/* subject len (incl NULL) */
	slen author_len;			/* author + signature len */
} trn_hdr;

#define TRN_HDR_1 1
#define TRN_HDR_UNIQUE 102463

#include "atom.h"
#include "globals.h"

/* core.c */
void add_trn (char *, tfile, char *, trn_nums, trn_nums *, int *);
void add_trn2 (char *, tfile, char *, char *, trn_nums, trn_nums *, int *);
void add_trn_priv (char *, tfile, char *, char *, trn_nums, trn_nums, char *,
		   time_t, int, trn_nums *, int *);
void expunge_trn (char *, trn_nums, int *);
void get_trn_info (char *, trn_nums, trn_info *, int *);
void get_trn_info2 (char *, trn_nums, trn_info2 *, int *);
void get_trn_info3 (char *, trn_nums, trn_info3 *, int *);
void set_trn_flags (char *, trn_nums, int, int *);
void delete_trn (char *, trn_nums, int *);
void retrieve_trn (char *, trn_nums, int *);
void create_mtg (char *, char *, bool, int *);
void create_mtg_priv (char *, char *, bool, time_t, char *, dsc_acl *, int *);
void get_mtg_info (char *, mtg_info *, int *);
void get_trn (char *, trn_nums, tfile, int *);
void remove_mtg (char *, int *);
void updated_mtg (char *, int, int , bool *, int *);

/* coreutil.c */
int open_mtg(char *);
int read_super(void);
int write_super(void);
int forget_super(void);
int start_read(void);
int finish_read(void);
faddr chain_addr(trn_nums);
int read_chain(trn_nums, chain_blk *);
int write_chain(chain_blk *);
int read_trn(faddr, trn_hdr *, char **, char **, char **);
int core_abort(void);
int fsize(int);
int fis_owner(int, int);
bool has_trn_access(char *, int);
bool has_mtg_access(int);
void mtg_znotify(char *, char *, char *, char *);
int swap_super(mtg_super *);
int swap_chain(chain_blk *);
int swap_trn_base(trn_base *);
int swap_trn(trn_hdr *);