usr.sbin/pkg_install/lib/lib.h

   1 /* $FreeBSD: src/usr.sbin/pkg_install/lib/lib.h,v 1.29.2.12 2003/06/09 17:01:26 lioux Exp $ */
   2
   3 /*
   4  * FreeBSD install - a package for the installation and maintainance
   5  * of non-core utilities.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * Jordan K. Hubbard
  17  * 18 July 1993
  18  *
  19  * Include and define various things wanted by the library routines.
  20  *
  21  */
  22
  23 #ifndef _INST_LIB_LIB_H_
  24 #define _INST_LIB_LIB_H_
  25
  26 /* Includes */
  27 #include <sys/param.h>
  28 #include <sys/file.h>
  29 #include <sys/stat.h>
  30 #include <sys/queue.h>
  31 #include <ctype.h>
  32 #include <dirent.h>
  33 #include <stdarg.h>
  34 #include <stdio.h>
  35 #include <stdlib.h>
  36 #include <string.h>
  37 #include <unistd.h>
  38
  39 /* Macros */
  40 #define SUCCESS (0)
  41 #define FAIL    (-1)
  42
  43 #ifndef TRUE
  44 #define TRUE    (1)
  45 #endif
  46
  47 #ifndef FALSE
  48 #define FALSE   (0)
  49 #endif
  50
  51 #define YES             2
  52 #define NO              1
  53
  54 /* Usually "rm", but often "echo" during debugging! */
  55 #define REMOVE_CMD      "rm"
  56
  57 /* Usually "rm", but often "echo" during debugging! */
  58 #define RMDIR_CMD       "rmdir"
  59
  60 /* Where we put logging information by default, else ${PKG_DBDIR} if set */
  61 #define DEF_LOG_DIR     "/var/db/pkg"
  62 /* just in case we change the environment variable name */
  63 #define PKG_DBDIR       "PKG_DBDIR"
  64 /* macro to get name of directory where we put logging information */
  65 #define LOG_DIR         (getenv(PKG_DBDIR) ? getenv(PKG_DBDIR) : DEF_LOG_DIR)
  66
  67 /* The names of our "special" files */
  68 #define CONTENTS_FNAME          "+CONTENTS"
  69 #define COMMENT_FNAME           "+COMMENT"
  70 #define DESC_FNAME              "+DESC"
  71 #define INSTALL_FNAME           "+INSTALL"
  72 #define POST_INSTALL_FNAME      "+POST-INSTALL"
  73 #define DEINSTALL_FNAME         "+DEINSTALL"
  74 #define POST_DEINSTALL_FNAME    "+POST-DEINSTALL"
  75 #define REQUIRE_FNAME           "+REQUIRE"
  76 #define REQUIRED_BY_FNAME       "+REQUIRED_BY"
  77 #define DISPLAY_FNAME           "+DISPLAY"
  78 #define MTREE_FNAME             "+MTREE_DIRS"
  79
  80 #define CMD_CHAR                '@'     /* prefix for extended PLIST cmd */
  81
  82 /* The name of the "prefix" environment variable given to scripts */
  83 #define PKG_PREFIX_VNAME        "PKG_PREFIX"
  84
  85 /* Version numbers to assist with changes in package file format */
  86 #define PLIST_FMT_VER_MAJOR     1
  87 #define PLIST_FMT_VER_MINOR     1
  88
  89 enum _plist_t {
  90     PLIST_FILE, PLIST_CWD, PLIST_CMD, PLIST_CHMOD,
  91     PLIST_CHOWN, PLIST_CHGRP, PLIST_COMMENT, PLIST_IGNORE,
  92     PLIST_NAME, PLIST_UNEXEC, PLIST_SRC, PLIST_DISPLAY,
  93     PLIST_PKGDEP, PLIST_MTREE, PLIST_DIR_RM, PLIST_IGNORE_INST,
  94     PLIST_OPTION, PLIST_ORIGIN, PLIST_DEPORIGIN
  95 };
  96 typedef enum _plist_t plist_t;
  97
  98 enum _match_t {
  99     MATCH_ALL, MATCH_EXACT, MATCH_GLOB, MATCH_REGEX
 100 };
 101 typedef enum _match_t match_t;
 102
 103 /* Types */
 104 typedef unsigned int Boolean;
 105
 106 struct _plist {
 107     struct _plist *prev, *next;
 108     char *name;
 109     Boolean marked;
 110     plist_t type;
 111 };
 112 typedef struct _plist *PackingList;
 113
 114 struct _pack {
 115     struct _plist *head, *tail;
 116     char *name;
 117     char *origin;
 118     int fmtver_maj, fmtver_mnr;
 119 };
 120 typedef struct _pack Package;
 121
 122 struct reqr_by_entry {
 123     STAILQ_ENTRY(reqr_by_entry) link;
 124     char pkgname[PATH_MAX];
 125 };
 126 STAILQ_HEAD(reqr_by_head, reqr_by_entry);
 127
 128 /* Prototypes */
 129 /* Misc */
 130 int             vsystem(const char *, ...);
 131 char            *vpipe(const char *, ...);
 132 void            cleanup(int);
 133 char            *make_playpen(char *, off_t);
 134 char            *where_playpen(void);
 135 void            leave_playpen(void);
 136 off_t           min_free(const char *);
 137
 138 /* String */
 139 char            *get_dash_string(char **);
 140 char            *copy_string(const char *);
 141 char            *copy_string_plus_newline(const char *);
 142 Boolean         suffix(const char *, const char *);
 143 void            nuke_suffix(char *);
 144 void            str_lowercase(char *);
 145 char            *strconcat(const char *, const char *);
 146 char            *get_string(char *, int, FILE *);
 147
 148 /* File */
 149 Boolean         fexists(const char *);
 150 Boolean         isdir(const char *);
 151 Boolean         isemptydir(const char *fname);
 152 Boolean         isemptyfile(const char *fname);
 153 Boolean         isfile(const char *);
 154 Boolean         isempty(const char *);
 155 Boolean         issymlink(const char *);
 156 Boolean         isURL(const char *);
 157 char            *fileGetURL(const char *, const char *);
 158 char            *fileFindByPath(const char *, const char *);
 159 char            *fileGetContents(const char *);
 160 void            write_file(const char *, const char *);
 161 void            copy_file(const char *, const char *, const char *);
 162 void            move_file(const char *, const char *, const char *);
 163 void            copy_hierarchy(const char *, const char *, Boolean);
 164 int             delete_hierarchy(const char *, Boolean, Boolean);
 165 int             unpack(const char *, const char *);
 166 void            format_cmd(char *, const char *, const char *, const char *);
 167
 168 /* Msg */
 169 void            upchuck(const char *);
 170 void            barf(const char *, ...);
 171 void            whinge(const char *, ...);
 172 Boolean         y_or_n(Boolean, const char *, ...);
 173
 174 /* Packing list */
 175 PackingList     new_plist_entry(void);
 176 PackingList     last_plist(Package *);
 177 PackingList     find_plist(Package *, plist_t);
 178 char            *find_plist_option(Package *, const char *name);
 179 void            plist_delete(Package *, Boolean, plist_t, const char *);
 180 void            free_plist(Package *);
 181 void            mark_plist(Package *);
 182 void            csum_plist_entry(char *, PackingList);
 183 void            add_plist(Package *, plist_t, const char *);
 184 void            add_plist_top(Package *, plist_t, const char *);
 185 void            delete_plist(Package *pkg, Boolean all, plist_t type, const char *name);
 186 void            write_plist(Package *, FILE *);
 187 void            read_plist(Package *, FILE *);
 188 int             plist_cmd(const char *, char **);
 189 int             delete_package(Boolean, Boolean, Package *);
 190 Boolean         make_preserve_name(char *, int, const char *, const char *);
 191
 192 /* For all */
 193 int             pkg_perform(char **);
 194
 195 /* Query installed packages */
 196 char            **matchinstalled(match_t, char **, int *);
 197 char            **matchbyorigin(const char *, int *);
 198 int             isinstalledpkg(const char *name);
 199
 200 /* Dependencies */
 201 int             sortdeps(char **);
 202 int             chkifdepends(const char *, const char *);
 203 int             requiredby(const char *, struct reqr_by_head **, Boolean, Boolean);
 204
 205 /* Version */
 206 int             verscmp(Package *, int, int);
 207
 208 /* Externs */
 209 extern Boolean  Verbose;
 210 extern Boolean  Fake;
 211 extern Boolean  Force;
 212 extern int      AutoAnswer;
 213
 214 #endif /* _INST_LIB_LIB_H_ */