Annotation of src/usr.bin/cvs/cvs.h, Revision 1.78
1.78 ! joris 1: /* $OpenBSD: cvs.h,v 1.77 2005/08/04 13:31:14 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.1 jfb 142:
1.46 joris 143:
144: /* flags for cmd_flags */
145: #define CVS_CMD_ALLOWSPEC 0x01
146: #define CVS_CMD_SENDARGS1 0x04
147: #define CVS_CMD_SENDARGS2 0x08
148: #define CVS_CMD_SENDDIR 0x10
1.60 joris 149: #define CVS_CMD_PRUNEDIRS 0x20
1.46 joris 150:
1.58 jfb 151:
1.46 joris 152: struct cvs_cmd {
1.58 jfb 153: int cmd_op;
154: int cmd_req;
155: char cmd_name[CVS_CMD_MAXNAMELEN];
156: char cmd_alias[CVS_CMD_MAXALIAS][CVS_CMD_MAXNAMELEN];
157: char cmd_descr[CVS_CMD_MAXDESCRLEN];
1.46 joris 158: char *cmd_synopsis;
159: char *cmd_opts;
160: char *cmd_defargs;
1.58 jfb 161: int file_flags;
162:
163: /* operations vector */
164: int (*cmd_init) (struct cvs_cmd *, int, char **, int *);
165: int (*cmd_pre_exec) (struct cvsroot *);
166: int (*cmd_exec_remote) (CVSFILE *, void *);
167: int (*cmd_exec_local) (CVSFILE *, void *);
168: int (*cmd_post_exec) (struct cvsroot *);
169: int (*cmd_cleanup) (void);
170:
171: /* flags for cvs_file_get() */
172: int cmd_flags;
1.46 joris 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.74 xsa 196: #define CVS_ROOT_CONNECTED 0x01
1.36 jfb 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.78 ! joris 216:
! 217: TAILQ_ENTRY(cvsroot) root_cache;
1.1 jfb 218: };
1.20 jfb 219:
1.74 xsa 220: #define CVS_SETVR(rt, rq) ((rt)->cr_vrmask[(rq) / 8] |= (1 << ((rq) % 8)))
221: #define CVS_GETVR(rt, rq) ((rt)->cr_vrmask[(rq) / 8] & (1 << ((rq) % 8)))
222: #define CVS_CLRVR(rt, rq) ((rt)->cr_vrmask[(rq) / 8] &= ~(1 << ((rq) % 8)))
223: #define CVS_RSTVR(rt) memset((rt)->cr_vrmask, 0, sizeof((rt)->cr_vrmask))
224:
225:
226: #define CVS_HIST_ADDED 'A'
227: #define CVS_HIST_EXPORT 'E'
228: #define CVS_HIST_RELEASE 'F'
229: #define CVS_HIST_MODIFIED 'M'
230: #define CVS_HIST_CHECKOUT 'O'
231: #define CVS_HIST_COMMIT 'R'
232: #define CVS_HIST_TAG 'T'
233:
234:
235: #define CVS_DATE_DUMMY "dummy timestamp"
236: #define CVS_DATE_DMSEC (time_t)-1
237:
238: #define CVS_ENT_NONE 0
239: #define CVS_ENT_FILE 1
240: #define CVS_ENT_DIR 2
241:
242: #define CVS_ENT_REG 0
243: #define CVS_ENT_ADDED 1
244: #define CVS_ENT_REMOVED 2
245: #define CVS_ENT_UPTODATE 3
1.1 jfb 246:
1.74 xsa 247: #define CVS_ENTF_SYNC 0x01 /* contents of disk and memory match */
248: #define CVS_ENTF_WR 0x02 /* file is opened for writing too */
1.17 jfb 249:
1.1 jfb 250:
251: struct cvs_ent {
1.74 xsa 252: char *ce_buf;
253: u_int16_t ce_type;
254: u_int16_t ce_status;
255: char *ce_name;
256: RCSNUM *ce_rev;
257: time_t ce_mtime;
258: char *ce_opts;
259: char *ce_tag;
260: TAILQ_ENTRY(cvs_ent) ce_list;
1.1 jfb 261: };
262:
263: typedef struct cvs_entries {
1.74 xsa 264: char *cef_path;
265: u_int cef_flags;
1.1 jfb 266:
1.74 xsa 267: TAILQ_HEAD(, cvs_ent) cef_ent;
268: struct cvs_ent *cef_cur;
1.1 jfb 269: } CVSENTRIES;
270:
271:
272: struct cvs_hent {
1.74 xsa 273: char ch_event;
274: time_t ch_date;
275: uid_t ch_uid;
276: char *ch_user;
277: char *ch_curdir;
278: char *ch_repo;
279: RCSNUM *ch_rev;
280: char *ch_arg;
1.1 jfb 281: };
282:
283:
284: typedef struct cvs_histfile {
1.74 xsa 285: int chf_fd;
286: char *chf_buf; /* read buffer */
287: size_t chf_blen; /* buffer size */
288: size_t chf_bused; /* bytes used in buffer */
289:
290: off_t chf_off; /* next read */
291: u_int chf_sindex; /* history entry index of first in array */
292: u_int chf_cindex; /* current index (for getnext()) */
293: u_int chf_nbhent; /* number of valid entries in the array */
1.1 jfb 294:
1.74 xsa 295: struct cvs_hent chf_hent[CVS_HIST_CACHE];
1.1 jfb 296:
297: } CVSHIST;
298:
299:
1.67 joris 300: extern char *cvs_req_modulename;
1.64 joris 301: extern char *cvs_repo_base;
1.22 jfb 302: extern char *cvs_command;
1.18 jfb 303: extern char *cvs_editor;
1.76 xsa 304: extern char *cvs_homedir;
1.30 krapht 305: extern char *cvs_msg;
1.42 jfb 306: extern char *cvs_rsh;
1.77 xsa 307: extern char *cvs_tmpdir;
1.22 jfb 308:
1.42 jfb 309: extern int verbosity;
310: extern int cvs_trace;
311: extern int cvs_nolog;
312: extern int cvs_compress;
313: extern int cvs_cmdop;
314: extern int cvs_nocase;
1.57 xsa 315: extern int cvs_noexec;
1.42 jfb 316: extern int cvs_readonly;
1.72 joris 317: extern int cvs_error;
1.23 jfb 318: extern CVSFILE *cvs_files;
1.15 jfb 319:
1.58 jfb 320: extern struct cvs_cmd *cvs_cdt[];
1.1 jfb 321:
1.58 jfb 322: extern struct cvs_cmd cvs_cmd_add;
323: extern struct cvs_cmd cvs_cmd_admin;
324: extern struct cvs_cmd cvs_cmd_annotate;
325: extern struct cvs_cmd cvs_cmd_checkout;
326: extern struct cvs_cmd cvs_cmd_commit;
327: extern struct cvs_cmd cvs_cmd_diff;
328: extern struct cvs_cmd cvs_cmd_edit;
329: extern struct cvs_cmd cvs_cmd_editors;
330: extern struct cvs_cmd cvs_cmd_export;
331: extern struct cvs_cmd cvs_cmd_history;
332: extern struct cvs_cmd cvs_cmd_import;
333: extern struct cvs_cmd cvs_cmd_init;
334: extern struct cvs_cmd cvs_cmd_log;
335: extern struct cvs_cmd cvs_cmd_login;
336: extern struct cvs_cmd cvs_cmd_logout;
337: extern struct cvs_cmd cvs_cmd_rdiff;
338: extern struct cvs_cmd cvs_cmd_release;
339: extern struct cvs_cmd cvs_cmd_remove;
340: extern struct cvs_cmd cvs_cmd_rlog;
341: extern struct cvs_cmd cvs_cmd_rtag;
342: extern struct cvs_cmd cvs_cmd_status;
343: extern struct cvs_cmd cvs_cmd_tag;
344: extern struct cvs_cmd cvs_cmd_update;
345: extern struct cvs_cmd cvs_cmd_version;
346: extern struct cvs_cmd cvs_cmd_server;
347: extern struct cvs_cmd cvs_cmd_unedit;
348: extern struct cvs_cmd cvs_cmd_watch;
349: extern struct cvs_cmd cvs_cmd_watchers;
350:
351:
1.74 xsa 352: struct cvs_cmd *cvs_findcmd(const char *);
353: struct cvs_cmd *cvs_findcmdbyreq(int);
354: int cvs_startcmd(struct cvs_cmd *, int, char **);
355: int cvs_server(int, char **);
356:
357: int cvs_var_set(const char *, const char *);
358: int cvs_var_unset(const char *);
359: const char *cvs_var_get(const char *);
1.1 jfb 360:
361:
1.69 xsa 362: /* root.c */
1.74 xsa 363: struct cvsroot *cvsroot_parse(const char *);
364: void cvsroot_free(struct cvsroot *);
365: struct cvsroot *cvsroot_get(const char *);
1.2 jfb 366:
367:
1.1 jfb 368: /* Entries API */
1.74 xsa 369: CVSENTRIES *cvs_ent_open(const char *, int);
370: struct cvs_ent *cvs_ent_get(CVSENTRIES *, const char *);
371: struct cvs_ent *cvs_ent_next(CVSENTRIES *);
372: int cvs_ent_add(CVSENTRIES *, struct cvs_ent *);
373: int cvs_ent_addln(CVSENTRIES *, const char *);
374: int cvs_ent_remove(CVSENTRIES *, const char *);
375: int cvs_ent_write(CVSENTRIES *);
376: struct cvs_ent *cvs_ent_parse(const char *);
377: void cvs_ent_close(CVSENTRIES *);
378: void cvs_ent_free(struct cvs_ent *);
1.1 jfb 379:
380: /* history API */
1.74 xsa 381: CVSHIST *cvs_hist_open(const char *);
382: void cvs_hist_close(CVSHIST *);
383: int cvs_hist_parse(CVSHIST *);
384: struct cvs_hent *cvs_hist_getnext(CVSHIST *);
385: int cvs_hist_append(CVSHIST *, struct cvs_hent *);
1.1 jfb 386:
1.69 xsa 387: /* logmsg.c */
1.74 xsa 388: char *cvs_logmsg_open(const char *);
389: char *cvs_logmsg_get(const char *, struct cvs_flist *,
390: struct cvs_flist *, struct cvs_flist *);
391: int cvs_logmsg_send(struct cvsroot *, const char *);
1.1 jfb 392:
1.69 xsa 393: /* date.y */
1.74 xsa 394: time_t cvs_date_parse(const char *);
1.28 jfb 395:
1.69 xsa 396: /* util.c */
1.74 xsa 397: int cvs_readrepo(const char *, char *, size_t);
398: int cvs_modetostr(mode_t, char *, size_t);
399: int cvs_strtomode(const char *, mode_t *);
400: int cvs_splitpath(const char *, char *, size_t, char **);
401: int cvs_mkadmin(const char *, const char *, const char *);
402: int cvs_cksum(const char *, char *, size_t);
403: int cvs_exec(int, char **, int []);
404: int cvs_getargv(const char *, char **, int);
405: int cvs_chdir(const char *);
406: int cvs_unlink(const char *);
1.75 xsa 407: int cvs_rmdir(const char *);
1.74 xsa 408: int cvs_create_dir(const char *, int, char *, char *);
409: char *cvs_rcs_getpath(CVSFILE *, char *, size_t);
410: char **cvs_makeargv(const char *, int *);
411: void cvs_freeargv(char **, int);
412: size_t cvs_path_cat(const char *, const char *, char *, size_t);
1.1 jfb 413:
414:
1.74 xsa 415: #endif /* CVS_H */