[BACK]Return to cvs.h CVS log [TXT][DIR] Up to [local] / src / usr.bin / cvs

Annotation of src/usr.bin/cvs/cvs.h, Revision 1.66

1.66    ! xsa         1: /*     $OpenBSD: cvs.h,v 1.65 2005/06/07 09:06:15 joris 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.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.19      jfb        60: #define CVS_OP_UNKNOWN      0
1.1       jfb        61: #define CVS_OP_ADD          1
1.43      jfb        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.19      jfb        89: #define CVS_OP_ANY         64     /* all operations */
1.1       jfb        90:
                     91:
                     92: /* methods */
                     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
1.34      jfb       105: #define CVS_CMD_MAXARG      128
1.1       jfb       106:
                    107:
                    108: /* defaults */
1.21      jfb       109: #define CVS_SERVER_DEFAULT  "cvs"
1.1       jfb       110: #define CVS_RSH_DEFAULT     "ssh"
                    111: #define CVS_EDITOR_DEFAULT  "vi"
                    112:
                    113:
                    114: /* server-side paths */
                    115: #define CVS_PATH_ROOT         "CVSROOT"
                    116: #define CVS_PATH_COMMITINFO   CVS_PATH_ROOT "/commitinfo"
                    117: #define CVS_PATH_CONFIG       CVS_PATH_ROOT "/config"
                    118: #define CVS_PATH_CVSIGNORE    CVS_PATH_ROOT "/cvsignore"
                    119: #define CVS_PATH_CVSWRAPPERS  CVS_PATH_ROOT "/cvswrappers"
                    120: #define CVS_PATH_EDITINFO     CVS_PATH_ROOT "/editinfo"
                    121: #define CVS_PATH_HISTORY      CVS_PATH_ROOT "/history"
                    122: #define CVS_PATH_LOGINFO      CVS_PATH_ROOT "/loginfo"
                    123: #define CVS_PATH_MODULES      CVS_PATH_ROOT "/modules"
                    124: #define CVS_PATH_NOTIFY       CVS_PATH_ROOT "/notify"
                    125: #define CVS_PATH_RCSINFO      CVS_PATH_ROOT "/rcsinfo"
                    126: #define CVS_PATH_TAGINFO      CVS_PATH_ROOT "/taginfo"
                    127: #define CVS_PATH_VERIFYMSG    CVS_PATH_ROOT "/verifymsg"
                    128:
                    129:
                    130: /* client-side paths */
                    131: #define CVS_PATH_RC             ".cvsrc"
                    132: #define CVS_PATH_CVSDIR         "CVS"
                    133: #define CVS_PATH_ENTRIES        CVS_PATH_CVSDIR "/Entries"
                    134: #define CVS_PATH_STATICENTRIES  CVS_PATH_CVSDIR "/Entries.Static"
                    135: #define CVS_PATH_LOGENTRIES     CVS_PATH_CVSDIR "/Entries.Log"
                    136: #define CVS_PATH_ROOTSPEC       CVS_PATH_CVSDIR "/Root"
1.10      jfb       137: #define CVS_PATH_REPOSITORY     CVS_PATH_CVSDIR "/Repository"
1.1       jfb       138:
1.46      joris     139:
                    140: /* flags for cmd_flags */
                    141: #define CVS_CMD_ALLOWSPEC      0x01
                    142: #define CVS_CMD_SENDARGS1      0x04
                    143: #define CVS_CMD_SENDARGS2      0x08
                    144: #define CVS_CMD_SENDDIR                0x10
1.60      joris     145: #define CVS_CMD_PRUNEDIRS      0x20
1.46      joris     146:
1.58      jfb       147:
1.46      joris     148: struct cvs_cmd {
1.58      jfb       149:        int   cmd_op;
                    150:        int   cmd_req;
                    151:        char  cmd_name[CVS_CMD_MAXNAMELEN];
                    152:        char  cmd_alias[CVS_CMD_MAXALIAS][CVS_CMD_MAXNAMELEN];
                    153:        char  cmd_descr[CVS_CMD_MAXDESCRLEN];
1.46      joris     154:        char *cmd_synopsis;
                    155:        char *cmd_opts;
                    156:        char *cmd_defargs;
1.58      jfb       157:        int   file_flags;
                    158:
                    159:        /* operations vector */
                    160:        int (*cmd_init)        (struct cvs_cmd *, int, char **, int *);
                    161:        int (*cmd_pre_exec)    (struct cvsroot *);
                    162:        int (*cmd_exec_remote) (CVSFILE *, void *);
                    163:        int (*cmd_exec_local)  (CVSFILE *, void *);
                    164:        int (*cmd_post_exec)   (struct cvsroot *);
                    165:        int (*cmd_cleanup)     (void);
                    166:
                    167:        /* flags for cvs_file_get() */
                    168:        int   cmd_flags;
1.46      joris     169: };
1.1       jfb       170:
1.7       jfb       171: struct cvs_file;
                    172: struct cvs_dir;
1.19      jfb       173: struct cvs_flist;
1.7       jfb       174:
1.41      jfb       175: struct cvs_var {
                    176:        char   *cv_name;
                    177:        char   *cv_val;
                    178:        TAILQ_ENTRY(cvs_var) cv_link;
                    179: };
                    180:
                    181:
                    182:
1.1       jfb       183: struct cvs_op {
1.19      jfb       184:        u_int             co_op;
                    185:        uid_t             co_uid;    /* user performing the operation */
                    186:        char             *co_tag;    /* tag or branch, NULL if HEAD */
                    187:        char             *co_msg;    /* message string (on commit or add) */
                    188:        struct cvs_flist  co_files;
1.1       jfb       189: };
                    190:
                    191:
1.36      jfb       192: #define CVS_ROOT_CONNECTED    0x01
                    193:
1.1       jfb       194: struct cvsroot {
1.11      jfb       195:        char   *cr_str;
1.1       jfb       196:        u_int   cr_method;
                    197:        char   *cr_buf;
                    198:        char   *cr_user;
                    199:        char   *cr_pass;
                    200:        char   *cr_host;
                    201:        char   *cr_dir;
                    202:        u_int   cr_port;
1.11      jfb       203:        u_int   cr_ref;
                    204:
                    205:        /* connection data */
1.36      jfb       206:        u_int   cr_flags;
1.11      jfb       207:        FILE   *cr_srvin;
                    208:        FILE   *cr_srvout;
1.21      jfb       209:        FILE   *cr_srverr;
1.29      jfb       210:        char   *cr_version;     /* version of remote server */
                    211:        u_char  cr_vrmask[16];  /* mask of valid requests supported by server */
1.1       jfb       212: };
1.20      jfb       213:
1.29      jfb       214: #define CVS_SETVR(rt, rq)  ((rt)->cr_vrmask[(rq) / 8] |=  (1 << ((rq) % 8)))
                    215: #define CVS_GETVR(rt, rq)  ((rt)->cr_vrmask[(rq) / 8] &   (1 << ((rq) % 8)))
                    216: #define CVS_CLRVR(rt, rq)  ((rt)->cr_vrmask[(rq) / 8] &= ~(1 << ((rq) % 8)))
1.20      jfb       217: #define CVS_RSTVR(rt)      memset((rt)->cr_vrmask, 0, sizeof((rt)->cr_vrmask))
1.1       jfb       218:
                    219:
                    220: #define CVS_HIST_ADDED    'A'
                    221: #define CVS_HIST_EXPORT   'E'
                    222: #define CVS_HIST_RELEASE  'F'
                    223: #define CVS_HIST_MODIFIED 'M'
                    224: #define CVS_HIST_CHECKOUT 'O'
                    225: #define CVS_HIST_COMMIT   'R'
                    226: #define CVS_HIST_TAG      'T'
                    227:
                    228:
1.28      jfb       229: #define CVS_DATE_DUMMY  "dummy timestamp"
                    230: #define CVS_DATE_DMSEC  (time_t)-1
1.27      jfb       231:
1.1       jfb       232: #define CVS_ENT_NONE    0
                    233: #define CVS_ENT_FILE    1
                    234: #define CVS_ENT_DIR     2
1.27      jfb       235:
1.44      jfb       236: #define CVS_ENT_REG      0
                    237: #define CVS_ENT_ADDED    1
                    238: #define CVS_ENT_REMOVED  2
                    239:
1.1       jfb       240:
1.17      jfb       241: #define CVS_ENTF_SYNC   0x01    /* contents of disk and memory match */
                    242: #define CVS_ENTF_WR     0x02    /* file is opened for writing too */
                    243:
1.1       jfb       244:
                    245: struct cvs_ent {
1.44      jfb       246:        char      *ce_buf;
                    247:        u_int16_t  ce_type;
                    248:        u_int16_t  ce_status;
                    249:        char      *ce_name;
                    250:        RCSNUM    *ce_rev;
                    251:        time_t     ce_mtime;
                    252:        char      *ce_opts;
                    253:        char      *ce_tag;
1.4       jfb       254:        TAILQ_ENTRY(cvs_ent) ce_list;
1.1       jfb       255: };
                    256:
                    257: typedef struct cvs_entries {
                    258:        char    *cef_path;
1.17      jfb       259:        u_int    cef_flags;
1.1       jfb       260:
1.4       jfb       261:        TAILQ_HEAD(, cvs_ent) cef_ent;
                    262:        struct cvs_ent       *cef_cur;
1.1       jfb       263: } CVSENTRIES;
                    264:
                    265:
                    266: struct cvs_hent {
                    267:        char    ch_event;
                    268:        time_t  ch_date;
                    269:        uid_t   ch_uid;
                    270:        char   *ch_user;
                    271:        char   *ch_curdir;
                    272:        char   *ch_repo;
                    273:        RCSNUM *ch_rev;
                    274:        char   *ch_arg;
                    275: };
                    276:
                    277:
                    278: typedef struct cvs_histfile {
                    279:        int     chf_fd;
                    280:        char   *chf_buf;       /* read buffer */
                    281:        size_t  chf_blen;      /* buffer size */
                    282:        size_t  chf_bused;     /* bytes used in buffer */
                    283:
                    284:        off_t   chf_off;       /* next read */
                    285:        u_int   chf_sindex;    /* history entry index of first in array */
                    286:        u_int   chf_cindex;    /* current index (for getnext()) */
                    287:        u_int   chf_nbhent;    /* number of valid entries in the array */
                    288:
                    289:        struct cvs_hent chf_hent[CVS_HIST_CACHE];
                    290:
                    291: } CVSHIST;
                    292:
                    293:
1.64      joris     294: extern char *cvs_repo_base;
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;
1.15      jfb       310:
1.58      jfb       311: extern struct cvs_cmd *cvs_cdt[];
1.1       jfb       312:
1.58      jfb       313: extern struct cvs_cmd cvs_cmd_add;
                    314: extern struct cvs_cmd cvs_cmd_admin;
                    315: extern struct cvs_cmd cvs_cmd_annotate;
                    316: extern struct cvs_cmd cvs_cmd_checkout;
                    317: extern struct cvs_cmd cvs_cmd_commit;
                    318: extern struct cvs_cmd cvs_cmd_diff;
                    319: extern struct cvs_cmd cvs_cmd_edit;
                    320: extern struct cvs_cmd cvs_cmd_editors;
                    321: extern struct cvs_cmd cvs_cmd_export;
                    322: extern struct cvs_cmd cvs_cmd_history;
                    323: extern struct cvs_cmd cvs_cmd_import;
                    324: extern struct cvs_cmd cvs_cmd_init;
                    325: extern struct cvs_cmd cvs_cmd_log;
                    326: extern struct cvs_cmd cvs_cmd_login;
                    327: extern struct cvs_cmd cvs_cmd_logout;
                    328: extern struct cvs_cmd cvs_cmd_rdiff;
                    329: extern struct cvs_cmd cvs_cmd_release;
                    330: extern struct cvs_cmd cvs_cmd_remove;
                    331: extern struct cvs_cmd cvs_cmd_rlog;
                    332: extern struct cvs_cmd cvs_cmd_rtag;
                    333: extern struct cvs_cmd cvs_cmd_status;
                    334: extern struct cvs_cmd cvs_cmd_tag;
                    335: extern struct cvs_cmd cvs_cmd_update;
                    336: extern struct cvs_cmd cvs_cmd_version;
                    337: extern struct cvs_cmd cvs_cmd_server;
                    338: extern struct cvs_cmd cvs_cmd_unedit;
                    339: extern struct cvs_cmd cvs_cmd_watch;
                    340: extern struct cvs_cmd cvs_cmd_watchers;
                    341:
                    342:
                    343: struct cvs_cmd* cvs_findcmd       (const char *);
                    344: struct cvs_cmd* cvs_findcmdbyreq  (int);
                    345: int             cvs_startcmd      (struct cvs_cmd *, int, char **);
                    346: int             cvs_server        (int, char **);
1.41      jfb       347:
                    348: int         cvs_var_set   (const char *, const char *);
                    349: int         cvs_var_unset (const char *);
                    350: const char* cvs_var_get   (const char *);
1.1       jfb       351:
                    352:
                    353: /* from root.c */
                    354: struct cvsroot*  cvsroot_parse (const char *);
                    355: void             cvsroot_free  (struct cvsroot *);
                    356: struct cvsroot*  cvsroot_get   (const char *);
1.2       jfb       357:
                    358:
1.1       jfb       359: /* Entries API */
1.3       jfb       360: CVSENTRIES*      cvs_ent_open   (const char *, int);
1.1       jfb       361: struct cvs_ent*  cvs_ent_get    (CVSENTRIES *, const char *);
                    362: struct cvs_ent*  cvs_ent_next   (CVSENTRIES *);
                    363: int              cvs_ent_add    (CVSENTRIES *, struct cvs_ent *);
1.5       jfb       364: int              cvs_ent_addln  (CVSENTRIES *, const char *);
1.1       jfb       365: int              cvs_ent_remove (CVSENTRIES *, const char *);
1.17      jfb       366: int              cvs_ent_write  (CVSENTRIES *);
1.1       jfb       367: struct cvs_ent*  cvs_ent_parse  (const char *);
                    368: void             cvs_ent_close  (CVSENTRIES *);
1.8       jfb       369: void             cvs_ent_free   (struct cvs_ent *);
1.1       jfb       370:
                    371: /* history API */
                    372: CVSHIST*         cvs_hist_open    (const char *);
                    373: void             cvs_hist_close   (CVSHIST *);
                    374: int              cvs_hist_parse   (CVSHIST *);
                    375: struct cvs_hent* cvs_hist_getnext (CVSHIST *);
                    376: int              cvs_hist_append  (CVSHIST *, struct cvs_hent *);
                    377:
1.31      jfb       378: /* from logmsg.c */
                    379: char*  cvs_logmsg_open (const char *);
1.37      jfb       380: char*  cvs_logmsg_get  (const char *, struct cvs_flist *, struct cvs_flist *, struct cvs_flist *);
1.31      jfb       381: int    cvs_logmsg_send (struct cvsroot *, const char *);
1.1       jfb       382:
1.56      jfb       383:
                    384: time_t cvs_date_parse  (const char *);
1.28      jfb       385:
1.1       jfb       386: int    cvs_readrepo   (const char *, char *, size_t);
                    387: int    cvs_modetostr  (mode_t, char *, size_t);
                    388: int    cvs_strtomode  (const char *, mode_t *);
1.26      jfb       389: int    cvs_splitpath  (const char *, char *, size_t, char **);
1.59      joris     390: int    cvs_mkadmin    (const char *, const char *, const char *);
1.1       jfb       391: int    cvs_cksum      (const char *, char *, size_t);
                    392: int    cvs_exec       (int, char **, int []);
1.6       jfb       393: int    cvs_getargv    (const char *, char **, int);
1.55      joris     394: int    cvs_remove_dir (const char *);
1.34      jfb       395: char** cvs_makeargv   (const char *, int *);
1.6       jfb       396: void   cvs_freeargv   (char **, int);
1.62      jfb       397: size_t cvs_path_cat   (const char *, const char *, char *, size_t);
1.1       jfb       398:
                    399:
                    400: #endif /* CVS_H */