Annotation of src/usr.bin/cvs/cvs.h, Revision 1.51
1.51 ! jfb 1: /* $OpenBSD: cvs.h,v 1.50 2005/04/12 14:58:40 joris Exp $ */
1.1 jfb 2: /*
3: * Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org>
1.35 tedu 4: * All rights reserved.
1.1 jfb 5: *
1.35 tedu 6: * Redistribution and use in source and binary forms, with or without
7: * modification, are permitted provided that the following conditions
8: * are met:
1.1 jfb 9: *
1.35 tedu 10: * 1. Redistributions of source code must retain the above copyright
11: * notice, this list of conditions and the following disclaimer.
1.1 jfb 12: * 2. The name of the author may not be used to endorse or promote products
1.35 tedu 13: * derived from this software without specific prior written permission.
1.1 jfb 14: *
15: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
16: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
17: * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
18: * THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
21: * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
22: * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
23: * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
1.35 tedu 24: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.1 jfb 25: */
26:
27: #ifndef CVS_H
28: #define CVS_H
29:
30: #include <sys/param.h>
1.8 jfb 31: #include <stdio.h>
1.9 jfb 32: #include <dirent.h>
33:
1.1 jfb 34: #include "rcs.h"
1.19 jfb 35: #include "file.h"
1.1 jfb 36:
1.19 jfb 37: #define CVS_VERSION_MAJOR 0
38: #define CVS_VERSION_MINOR 2
39: #define CVS_VERSION "OpenCVS 0.2"
1.1 jfb 40:
41:
42: #define CVS_HIST_CACHE 128
43: #define CVS_HIST_NBFLD 6
44:
45:
46: #define CVS_CKSUM_LEN 33 /* length of a CVS checksum string */
47:
1.50 joris 48: /* error codes */
1.51 ! jfb 49: #define CVS_EX_OK 0
1.50 joris 50: #define CVS_EX_USAGE 1
51: #define CVS_EX_DATA 2
52: #define CVS_EX_PROTO 3
53: #define CVS_EX_FILE 4
1.1 jfb 54:
55: /* operations */
1.19 jfb 56: #define CVS_OP_UNKNOWN 0
1.1 jfb 57: #define CVS_OP_ADD 1
1.43 jfb 58: #define CVS_OP_ADMIN 2
59: #define CVS_OP_ANNOTATE 3
60: #define CVS_OP_CHECKOUT 4
61: #define CVS_OP_COMMIT 5
62: #define CVS_OP_DIFF 6
63: #define CVS_OP_EDIT 7
64: #define CVS_OP_EDITORS 8
65: #define CVS_OP_EXPORT 9
66: #define CVS_OP_HISTORY 10
67: #define CVS_OP_IMPORT 11
68: #define CVS_OP_INIT 12
69: #define CVS_OP_LOG 13
70: #define CVS_OP_RANNOTATE 14
71: #define CVS_OP_RDIFF 15
72: #define CVS_OP_RELEASE 16
73: #define CVS_OP_REMOVE 17
74: #define CVS_OP_RLOG 18
75: #define CVS_OP_RTAG 19
76: #define CVS_OP_SERVER 20
77: #define CVS_OP_STATUS 21
78: #define CVS_OP_TAG 22
79: #define CVS_OP_UNEDIT 23
80: #define CVS_OP_UPDATE 24
81: #define CVS_OP_VERSION 25
82: #define CVS_OP_WATCH 26
83: #define CVS_OP_WATCHERS 27
1.1 jfb 84:
1.19 jfb 85: #define CVS_OP_ANY 64 /* all operations */
1.1 jfb 86:
87:
88: /* methods */
89: #define CVS_METHOD_NONE 0
90: #define CVS_METHOD_LOCAL 1 /* local access */
91: #define CVS_METHOD_SERVER 2 /* tunnel through CVS_RSH */
92: #define CVS_METHOD_PSERVER 3 /* cvs pserver */
93: #define CVS_METHOD_KSERVER 4 /* kerberos */
94: #define CVS_METHOD_GSERVER 5 /* gssapi server */
95: #define CVS_METHOD_EXT 6
96: #define CVS_METHOD_FORK 7 /* local but fork */
97:
98: #define CVS_CMD_MAXNAMELEN 16
99: #define CVS_CMD_MAXALIAS 2
100: #define CVS_CMD_MAXDESCRLEN 64
1.34 jfb 101: #define CVS_CMD_MAXARG 128
1.1 jfb 102:
103:
104: /* defaults */
1.21 jfb 105: #define CVS_SERVER_DEFAULT "cvs"
1.1 jfb 106: #define CVS_RSH_DEFAULT "ssh"
107: #define CVS_EDITOR_DEFAULT "vi"
108:
109:
110: /* server-side paths */
111: #define CVS_PATH_ROOT "CVSROOT"
112: #define CVS_PATH_COMMITINFO CVS_PATH_ROOT "/commitinfo"
113: #define CVS_PATH_CONFIG CVS_PATH_ROOT "/config"
114: #define CVS_PATH_CVSIGNORE CVS_PATH_ROOT "/cvsignore"
115: #define CVS_PATH_CVSWRAPPERS CVS_PATH_ROOT "/cvswrappers"
116: #define CVS_PATH_EDITINFO CVS_PATH_ROOT "/editinfo"
117: #define CVS_PATH_HISTORY CVS_PATH_ROOT "/history"
118: #define CVS_PATH_LOGINFO CVS_PATH_ROOT "/loginfo"
119: #define CVS_PATH_MODULES CVS_PATH_ROOT "/modules"
120: #define CVS_PATH_NOTIFY CVS_PATH_ROOT "/notify"
121: #define CVS_PATH_RCSINFO CVS_PATH_ROOT "/rcsinfo"
122: #define CVS_PATH_TAGINFO CVS_PATH_ROOT "/taginfo"
123: #define CVS_PATH_VERIFYMSG CVS_PATH_ROOT "/verifymsg"
124:
125:
126: /* client-side paths */
127: #define CVS_PATH_RC ".cvsrc"
128: #define CVS_PATH_CVSDIR "CVS"
129: #define CVS_PATH_ENTRIES CVS_PATH_CVSDIR "/Entries"
130: #define CVS_PATH_STATICENTRIES CVS_PATH_CVSDIR "/Entries.Static"
131: #define CVS_PATH_LOGENTRIES CVS_PATH_CVSDIR "/Entries.Log"
132: #define CVS_PATH_ROOTSPEC CVS_PATH_CVSDIR "/Root"
1.10 jfb 133: #define CVS_PATH_REPOSITORY CVS_PATH_CVSDIR "/Repository"
1.1 jfb 134:
1.46 joris 135: struct cvs_cmd_info {
136: /* parses the options for the command */
137: int (*cmd_options)(char *, int, char **, int *);
138:
139: /* send command specific flags (CVS_METHOD_REMOTE only) */
140: int (*cmd_sendflags)(struct cvsroot *);
141:
142: /* callback to be used for cvs_file_examine() */
143: int (*cmd_examine)(CVSFILE *, void *);
144:
145: /* called after everything is done */
146: int (*cmd_cleanup)(void);
147:
148: /* helper function, gets called after cvs_file_get()
149: * to do command specific operations if needed.
150: */
151: int (*cmd_helper)(void);
152:
153: /* flags for cvs_file_get() */
154: int file_flags;
155:
156: /* number of request */
157: int cmd_req;
158:
159: /* info on the command (see flags below) */
160: int cmd_flags;
161: };
162:
163: /* flags for cmd_flags */
164: #define CVS_CMD_ALLOWSPEC 0x01
165: #define CVS_CMD_NEEDLOG 0x02
166: #define CVS_CMD_SENDARGS1 0x04
167: #define CVS_CMD_SENDARGS2 0x08
168: #define CVS_CMD_SENDDIR 0x10
169:
170: struct cvs_cmd {
171: int cmd_op;
172: char cmd_name[CVS_CMD_MAXNAMELEN];
173: char cmd_alias[CVS_CMD_MAXALIAS][CVS_CMD_MAXNAMELEN];
1.47 joris 174: struct cvs_cmd_info *cmd_info;
1.46 joris 175: char *cmd_synopsis;
176: char *cmd_opts;
177: char cmd_descr[CVS_CMD_MAXDESCRLEN];
178: char *cmd_defargs;
179: };
1.1 jfb 180:
1.7 jfb 181: struct cvs_file;
182: struct cvs_dir;
1.19 jfb 183: struct cvs_flist;
1.7 jfb 184:
1.41 jfb 185: struct cvs_var {
186: char *cv_name;
187: char *cv_val;
188: TAILQ_ENTRY(cvs_var) cv_link;
189: };
190:
191:
192:
1.1 jfb 193: struct cvs_op {
1.19 jfb 194: u_int co_op;
195: uid_t co_uid; /* user performing the operation */
196: char *co_tag; /* tag or branch, NULL if HEAD */
197: char *co_msg; /* message string (on commit or add) */
198: struct cvs_flist co_files;
1.1 jfb 199: };
200:
201:
1.36 jfb 202: #define CVS_ROOT_CONNECTED 0x01
203:
1.1 jfb 204: struct cvsroot {
1.11 jfb 205: char *cr_str;
1.1 jfb 206: u_int cr_method;
207: char *cr_buf;
208: char *cr_user;
209: char *cr_pass;
210: char *cr_host;
211: char *cr_dir;
212: u_int cr_port;
1.11 jfb 213: u_int cr_ref;
214:
215: /* connection data */
1.36 jfb 216: u_int cr_flags;
1.11 jfb 217: FILE *cr_srvin;
218: FILE *cr_srvout;
1.21 jfb 219: FILE *cr_srverr;
1.29 jfb 220: char *cr_version; /* version of remote server */
221: u_char cr_vrmask[16]; /* mask of valid requests supported by server */
1.1 jfb 222: };
1.20 jfb 223:
1.29 jfb 224: #define CVS_SETVR(rt, rq) ((rt)->cr_vrmask[(rq) / 8] |= (1 << ((rq) % 8)))
225: #define CVS_GETVR(rt, rq) ((rt)->cr_vrmask[(rq) / 8] & (1 << ((rq) % 8)))
226: #define CVS_CLRVR(rt, rq) ((rt)->cr_vrmask[(rq) / 8] &= ~(1 << ((rq) % 8)))
1.20 jfb 227: #define CVS_RSTVR(rt) memset((rt)->cr_vrmask, 0, sizeof((rt)->cr_vrmask))
1.1 jfb 228:
229:
230: #define CVS_HIST_ADDED 'A'
231: #define CVS_HIST_EXPORT 'E'
232: #define CVS_HIST_RELEASE 'F'
233: #define CVS_HIST_MODIFIED 'M'
234: #define CVS_HIST_CHECKOUT 'O'
235: #define CVS_HIST_COMMIT 'R'
236: #define CVS_HIST_TAG 'T'
237:
238:
1.28 jfb 239: #define CVS_DATE_DUMMY "dummy timestamp"
240: #define CVS_DATE_DMSEC (time_t)-1
1.27 jfb 241:
1.1 jfb 242: #define CVS_ENT_NONE 0
243: #define CVS_ENT_FILE 1
244: #define CVS_ENT_DIR 2
1.27 jfb 245:
1.44 jfb 246: #define CVS_ENT_REG 0
247: #define CVS_ENT_ADDED 1
248: #define CVS_ENT_REMOVED 2
249:
1.1 jfb 250:
1.17 jfb 251: #define CVS_ENTF_SYNC 0x01 /* contents of disk and memory match */
252: #define CVS_ENTF_WR 0x02 /* file is opened for writing too */
253:
1.1 jfb 254:
255: struct cvs_ent {
1.44 jfb 256: char *ce_buf;
257: u_int16_t ce_type;
258: u_int16_t ce_status;
259: char *ce_name;
260: RCSNUM *ce_rev;
261: time_t ce_mtime;
262: char *ce_opts;
263: char *ce_tag;
1.4 jfb 264: TAILQ_ENTRY(cvs_ent) ce_list;
1.1 jfb 265: };
266:
267: typedef struct cvs_entries {
268: char *cef_path;
1.3 jfb 269: FILE *cef_file;
1.17 jfb 270: u_int cef_flags;
1.1 jfb 271:
1.4 jfb 272: TAILQ_HEAD(, cvs_ent) cef_ent;
273: struct cvs_ent *cef_cur;
1.1 jfb 274: } CVSENTRIES;
275:
276:
277: struct cvs_hent {
278: char ch_event;
279: time_t ch_date;
280: uid_t ch_uid;
281: char *ch_user;
282: char *ch_curdir;
283: char *ch_repo;
284: RCSNUM *ch_rev;
285: char *ch_arg;
286: };
287:
288:
289: typedef struct cvs_histfile {
290: int chf_fd;
291: char *chf_buf; /* read buffer */
292: size_t chf_blen; /* buffer size */
293: size_t chf_bused; /* bytes used in buffer */
294:
295: off_t chf_off; /* next read */
296: u_int chf_sindex; /* history entry index of first in array */
297: u_int chf_cindex; /* current index (for getnext()) */
298: u_int chf_nbhent; /* number of valid entries in the array */
299:
300: struct cvs_hent chf_hent[CVS_HIST_CACHE];
301:
302: } CVSHIST;
303:
304:
1.15 jfb 305: #ifdef CVS
1.42 jfb 306:
1.22 jfb 307: extern char *cvs_command;
1.18 jfb 308: extern char *cvs_editor;
1.30 krapht 309: extern char *cvs_msg;
1.42 jfb 310: extern char *cvs_rsh;
1.22 jfb 311:
1.42 jfb 312: extern int verbosity;
313: extern int cvs_trace;
314: extern int cvs_nolog;
315: extern int cvs_compress;
316: extern int cvs_cmdop;
317: extern int cvs_nocase;
318: extern int cvs_readonly;
1.22 jfb 319:
1.23 jfb 320: extern CVSFILE *cvs_files;
321:
1.15 jfb 322: #endif
323:
1.1 jfb 324:
325: /* client command handlers */
1.47 joris 326: extern struct cvs_cmd_info cvs_add;
327: extern struct cvs_cmd_info cvs_admin;
328: extern struct cvs_cmd_info cvs_annotate;
329: extern struct cvs_cmd_info cvs_checkout;
330: extern struct cvs_cmd_info cvs_commit;
331: extern struct cvs_cmd_info cvs_diff;
332: extern struct cvs_cmd_info cvs_getlog;
333: extern struct cvs_cmd_info cvs_history;
334: extern struct cvs_cmd_info cvs_import;
335: extern struct cvs_cmd_info cvs_init;
336: extern struct cvs_cmd_info cvs_remove;
337: extern struct cvs_cmd_info cvs_status;
338: extern struct cvs_cmd_info cvs_tag;
339: extern struct cvs_cmd_info cvs_update;
340: extern struct cvs_cmd_info cvs_version;
1.48 joris 341: extern struct cvs_cmd_info cmd_server;
1.47 joris 342:
1.49 jfb 343: struct cvs_cmd* cvs_findcmd (const char *);
344: int cvs_startcmd (struct cvs_cmd *, int, char **);
345: int cvs_server (int, char **);
1.41 jfb 346:
347:
348: int cvs_var_set (const char *, const char *);
349: int cvs_var_unset (const char *);
350: const char* cvs_var_get (const char *);
1.1 jfb 351:
352:
353: /* from root.c */
354: struct cvsroot* cvsroot_parse (const char *);
355: void cvsroot_free (struct cvsroot *);
356: struct cvsroot* cvsroot_get (const char *);
1.2 jfb 357:
358:
1.1 jfb 359: /* Entries API */
1.3 jfb 360: CVSENTRIES* cvs_ent_open (const char *, int);
1.1 jfb 361: struct cvs_ent* cvs_ent_get (CVSENTRIES *, const char *);
362: struct cvs_ent* cvs_ent_next (CVSENTRIES *);
363: int cvs_ent_add (CVSENTRIES *, struct cvs_ent *);
1.5 jfb 364: int cvs_ent_addln (CVSENTRIES *, const char *);
1.1 jfb 365: int cvs_ent_remove (CVSENTRIES *, const char *);
1.17 jfb 366: int cvs_ent_write (CVSENTRIES *);
1.1 jfb 367: struct cvs_ent* cvs_ent_parse (const char *);
368: void cvs_ent_close (CVSENTRIES *);
1.8 jfb 369: void cvs_ent_free (struct cvs_ent *);
370: struct cvs_ent* cvs_ent_getent (const char *);
1.1 jfb 371:
372: /* history API */
373: CVSHIST* cvs_hist_open (const char *);
374: void cvs_hist_close (CVSHIST *);
375: int cvs_hist_parse (CVSHIST *);
376: struct cvs_hent* cvs_hist_getnext (CVSHIST *);
377: int cvs_hist_append (CVSHIST *, struct cvs_hent *);
378:
1.31 jfb 379: /* from logmsg.c */
380: char* cvs_logmsg_open (const char *);
1.37 jfb 381: char* cvs_logmsg_get (const char *, struct cvs_flist *, struct cvs_flist *, struct cvs_flist *);
1.31 jfb 382: int cvs_logmsg_send (struct cvsroot *, const char *);
1.1 jfb 383:
384: /* from util.c */
1.28 jfb 385: #define CVS_DATE_CTIME 0
386: #define CVS_DATE_RFC822 1
387:
1.1 jfb 388: int cvs_readrepo (const char *, char *, size_t);
1.28 jfb 389: time_t cvs_datesec (const char *, int, int);
1.1 jfb 390: int cvs_modetostr (mode_t, char *, size_t);
391: int cvs_strtomode (const char *, mode_t *);
1.26 jfb 392: int cvs_splitpath (const char *, char *, size_t, char **);
1.32 jfb 393: int cvs_mkadmin (CVSFILE *, mode_t);
1.1 jfb 394: int cvs_cksum (const char *, char *, size_t);
395: int cvs_exec (int, char **, int []);
1.6 jfb 396: int cvs_getargv (const char *, char **, int);
1.34 jfb 397: char** cvs_makeargv (const char *, int *);
1.6 jfb 398: void cvs_freeargv (char **, int);
1.1 jfb 399:
400:
401: #endif /* CVS_H */