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