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