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