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