Annotation of src/usr.bin/cvs/cvs.h, Revision 1.43
1.43 ! jfb 1: /* $OpenBSD: cvs.h,v 1.42 2005/01/13 17:53:34 jfb 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:
129:
1.7 jfb 130: struct cvs_file;
131: struct cvs_dir;
1.19 jfb 132: struct cvs_flist;
1.7 jfb 133:
1.41 jfb 134: struct cvs_var {
135: char *cv_name;
136: char *cv_val;
137: TAILQ_ENTRY(cvs_var) cv_link;
138: };
139:
140:
141:
1.1 jfb 142: struct cvs_op {
1.19 jfb 143: u_int co_op;
144: uid_t co_uid; /* user performing the operation */
145: char *co_tag; /* tag or branch, NULL if HEAD */
146: char *co_msg; /* message string (on commit or add) */
147: struct cvs_flist co_files;
1.1 jfb 148: };
149:
150:
1.36 jfb 151: #define CVS_ROOT_CONNECTED 0x01
152:
1.1 jfb 153: struct cvsroot {
1.11 jfb 154: char *cr_str;
1.1 jfb 155: u_int cr_method;
156: char *cr_buf;
157: char *cr_user;
158: char *cr_pass;
159: char *cr_host;
160: char *cr_dir;
161: u_int cr_port;
1.11 jfb 162: u_int cr_ref;
163:
164: /* connection data */
1.36 jfb 165: u_int cr_flags;
1.11 jfb 166: FILE *cr_srvin;
167: FILE *cr_srvout;
1.21 jfb 168: FILE *cr_srverr;
1.29 jfb 169: char *cr_version; /* version of remote server */
170: u_char cr_vrmask[16]; /* mask of valid requests supported by server */
1.1 jfb 171: };
1.20 jfb 172:
1.29 jfb 173: #define CVS_SETVR(rt, rq) ((rt)->cr_vrmask[(rq) / 8] |= (1 << ((rq) % 8)))
174: #define CVS_GETVR(rt, rq) ((rt)->cr_vrmask[(rq) / 8] & (1 << ((rq) % 8)))
175: #define CVS_CLRVR(rt, rq) ((rt)->cr_vrmask[(rq) / 8] &= ~(1 << ((rq) % 8)))
1.20 jfb 176: #define CVS_RSTVR(rt) memset((rt)->cr_vrmask, 0, sizeof((rt)->cr_vrmask))
1.1 jfb 177:
178:
179: #define CVS_HIST_ADDED 'A'
180: #define CVS_HIST_EXPORT 'E'
181: #define CVS_HIST_RELEASE 'F'
182: #define CVS_HIST_MODIFIED 'M'
183: #define CVS_HIST_CHECKOUT 'O'
184: #define CVS_HIST_COMMIT 'R'
185: #define CVS_HIST_TAG 'T'
186:
187:
1.28 jfb 188: #define CVS_DATE_DUMMY "dummy timestamp"
189: #define CVS_DATE_DMSEC (time_t)-1
1.27 jfb 190:
1.1 jfb 191: #define CVS_ENT_NONE 0
192: #define CVS_ENT_FILE 1
193: #define CVS_ENT_DIR 2
1.27 jfb 194:
1.1 jfb 195:
1.17 jfb 196: #define CVS_ENTF_SYNC 0x01 /* contents of disk and memory match */
197: #define CVS_ENTF_WR 0x02 /* file is opened for writing too */
198:
1.1 jfb 199:
200: struct cvs_ent {
201: char *ce_buf;
202: u_int ce_type;
203: char *ce_name;
204: RCSNUM *ce_rev;
1.26 jfb 205: time_t ce_mtime;
1.1 jfb 206: char *ce_opts;
207: char *ce_tag;
1.4 jfb 208: TAILQ_ENTRY(cvs_ent) ce_list;
1.1 jfb 209: };
210:
211: typedef struct cvs_entries {
212: char *cef_path;
1.3 jfb 213: FILE *cef_file;
1.17 jfb 214: u_int cef_flags;
1.1 jfb 215:
1.4 jfb 216: TAILQ_HEAD(, cvs_ent) cef_ent;
217: struct cvs_ent *cef_cur;
1.1 jfb 218: } CVSENTRIES;
219:
220:
221: struct cvs_hent {
222: char ch_event;
223: time_t ch_date;
224: uid_t ch_uid;
225: char *ch_user;
226: char *ch_curdir;
227: char *ch_repo;
228: RCSNUM *ch_rev;
229: char *ch_arg;
230: };
231:
232:
233: typedef struct cvs_histfile {
234: int chf_fd;
235: char *chf_buf; /* read buffer */
236: size_t chf_blen; /* buffer size */
237: size_t chf_bused; /* bytes used in buffer */
238:
239: off_t chf_off; /* next read */
240: u_int chf_sindex; /* history entry index of first in array */
241: u_int chf_cindex; /* current index (for getnext()) */
242: u_int chf_nbhent; /* number of valid entries in the array */
243:
244: struct cvs_hent chf_hent[CVS_HIST_CACHE];
245:
246: } CVSHIST;
247:
248:
1.15 jfb 249: #ifdef CVS
1.42 jfb 250:
1.22 jfb 251: extern char *cvs_command;
1.18 jfb 252: extern char *cvs_editor;
1.30 krapht 253: extern char *cvs_msg;
1.42 jfb 254: extern char *cvs_rsh;
1.22 jfb 255:
1.42 jfb 256: extern int verbosity;
257: extern int cvs_trace;
258: extern int cvs_nolog;
259: extern int cvs_compress;
260: extern int cvs_cmdop;
261: extern int cvs_nocase;
262: extern int cvs_readonly;
1.22 jfb 263:
1.23 jfb 264: extern CVSFILE *cvs_files;
265:
1.15 jfb 266: #endif
267:
1.1 jfb 268:
269: /* client command handlers */
270: int cvs_add (int, char **);
1.38 jfb 271: int cvs_annotate (int, char **);
1.9 jfb 272: int cvs_checkout (int, char **);
1.1 jfb 273: int cvs_commit (int, char **);
274: int cvs_diff (int, char **);
275: int cvs_getlog (int, char **);
276: int cvs_history (int, char **);
1.30 krapht 277: int cvs_import (int, char **);
1.1 jfb 278: int cvs_init (int, char **);
1.40 xsa 279: int cvs_remove (int, char **);
1.1 jfb 280: int cvs_server (int, char **);
1.15 jfb 281: int cvs_status (int, char **);
1.39 jfb 282: int cvs_tag (int, char **);
1.1 jfb 283: int cvs_update (int, char **);
284: int cvs_version (int, char **);
1.41 jfb 285:
286:
287: int cvs_var_set (const char *, const char *);
288: int cvs_var_unset (const char *);
289: const char* cvs_var_get (const char *);
1.1 jfb 290:
291:
292: /* from root.c */
293: struct cvsroot* cvsroot_parse (const char *);
294: void cvsroot_free (struct cvsroot *);
295: struct cvsroot* cvsroot_get (const char *);
1.2 jfb 296:
297:
1.1 jfb 298: /* Entries API */
1.3 jfb 299: CVSENTRIES* cvs_ent_open (const char *, int);
1.1 jfb 300: struct cvs_ent* cvs_ent_get (CVSENTRIES *, const char *);
301: struct cvs_ent* cvs_ent_next (CVSENTRIES *);
302: int cvs_ent_add (CVSENTRIES *, struct cvs_ent *);
1.5 jfb 303: int cvs_ent_addln (CVSENTRIES *, const char *);
1.1 jfb 304: int cvs_ent_remove (CVSENTRIES *, const char *);
1.17 jfb 305: int cvs_ent_write (CVSENTRIES *);
1.1 jfb 306: struct cvs_ent* cvs_ent_parse (const char *);
307: void cvs_ent_close (CVSENTRIES *);
1.8 jfb 308: void cvs_ent_free (struct cvs_ent *);
309: struct cvs_ent* cvs_ent_getent (const char *);
1.1 jfb 310:
311: /* history API */
312: CVSHIST* cvs_hist_open (const char *);
313: void cvs_hist_close (CVSHIST *);
314: int cvs_hist_parse (CVSHIST *);
315: struct cvs_hent* cvs_hist_getnext (CVSHIST *);
316: int cvs_hist_append (CVSHIST *, struct cvs_hent *);
317:
1.31 jfb 318: /* from logmsg.c */
319: char* cvs_logmsg_open (const char *);
1.37 jfb 320: char* cvs_logmsg_get (const char *, struct cvs_flist *, struct cvs_flist *, struct cvs_flist *);
1.31 jfb 321: int cvs_logmsg_send (struct cvsroot *, const char *);
1.1 jfb 322:
323: /* from util.c */
1.28 jfb 324: #define CVS_DATE_CTIME 0
325: #define CVS_DATE_RFC822 1
326:
1.1 jfb 327: int cvs_readrepo (const char *, char *, size_t);
1.28 jfb 328: time_t cvs_datesec (const char *, int, int);
1.1 jfb 329: int cvs_modetostr (mode_t, char *, size_t);
330: int cvs_strtomode (const char *, mode_t *);
1.26 jfb 331: int cvs_splitpath (const char *, char *, size_t, char **);
1.32 jfb 332: int cvs_mkadmin (CVSFILE *, mode_t);
1.1 jfb 333: int cvs_cksum (const char *, char *, size_t);
334: int cvs_exec (int, char **, int []);
1.6 jfb 335: int cvs_getargv (const char *, char **, int);
1.34 jfb 336: char** cvs_makeargv (const char *, int *);
1.6 jfb 337: void cvs_freeargv (char **, int);
1.1 jfb 338:
339:
340: #endif /* CVS_H */