lib.h revision 159554
1/* $FreeBSD: head/usr.sbin/pkg_install/lib/lib.h 159554 2006-06-12 22:39:32Z obrien $ */ 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 "/bin/rm" 56 57/* Usually "rm", but often "echo" during debugging! */ 58#define RMDIR_CMD "/bin/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#if defined(__FreeBSD_version) && __FreeBSD_version >= 700000 81#define INDEX_FNAME "INDEX-7" 82#elif defined(__FreeBSD_version) && __FreeBSD_version >= 600000 83#define INDEX_FNAME "INDEX-6" 84#elif defined(__FreeBSD_version) && __FreeBSD_version >= 500036 85#define INDEX_FNAME "INDEX-5" 86#else 87#define INDEX_FNAME "INDEX" 88#endif 89 90#define CMD_CHAR '@' /* prefix for extended PLIST cmd */ 91 92/* The name of the "prefix" environment variable given to scripts */ 93#define PKG_PREFIX_VNAME "PKG_PREFIX" 94 95/* 96 * Version of the package tools - increase only when some 97 * functionality used by bsd.port.mk is changed, added or removed 98 */ 99#define PKG_INSTALL_VERSION 20040629 100 101#define PKG_WRAPCONF_FNAME "/var/db/pkg_install.conf" 102#define main(argc, argv) real_main(argc, argv) 103 104/* Version numbers to assist with changes in package file format */ 105#define PLIST_FMT_VER_MAJOR 1 106#define PLIST_FMT_VER_MINOR 1 107 108enum _plist_t { 109 PLIST_FILE, PLIST_CWD, PLIST_CMD, PLIST_CHMOD, 110 PLIST_CHOWN, PLIST_CHGRP, PLIST_COMMENT, PLIST_IGNORE, 111 PLIST_NAME, PLIST_UNEXEC, PLIST_SRC, PLIST_DISPLAY, 112 PLIST_PKGDEP, PLIST_CONFLICTS, PLIST_MTREE, PLIST_DIR_RM, 113 PLIST_IGNORE_INST, PLIST_OPTION, PLIST_ORIGIN, PLIST_DEPORIGIN, 114 PLIST_NOINST 115}; 116typedef enum _plist_t plist_t; 117 118enum _match_t { 119 MATCH_ALL, MATCH_EXACT, MATCH_GLOB, MATCH_NGLOB, MATCH_EREGEX, MATCH_REGEX 120}; 121typedef enum _match_t match_t; 122 123/* Types */ 124typedef unsigned int Boolean; 125 126struct _plist { 127 struct _plist *prev, *next; 128 char *name; 129 Boolean marked; 130 plist_t type; 131}; 132typedef struct _plist *PackingList; 133 134struct _pack { 135 struct _plist *head, *tail; 136 const char *name; 137 const char *origin; 138 int fmtver_maj, fmtver_mnr; 139}; 140typedef struct _pack Package; 141 142struct reqr_by_entry { 143 STAILQ_ENTRY(reqr_by_entry) link; 144 char pkgname[PATH_MAX]; 145}; 146STAILQ_HEAD(reqr_by_head, reqr_by_entry); 147 148/* Prototypes */ 149/* Misc */ 150int vsystem(const char *, ...); 151char *vpipe(const char *, ...); 152void cleanup(int); 153char *make_playpen(char *, off_t); 154char *where_playpen(void); 155void leave_playpen(void); 156off_t min_free(const char *); 157 158/* String */ 159char *get_dash_string(char **); 160char *copy_string(const char *); 161char *copy_string_adds_newline(const char *); 162Boolean suffix(const char *, const char *); 163void nuke_suffix(char *); 164void str_lowercase(char *); 165char *strconcat(const char *, const char *); 166char *get_string(char *, int, FILE *); 167 168/* File */ 169Boolean fexists(const char *); 170Boolean isdir(const char *); 171Boolean isemptydir(const char *fname); 172Boolean isemptyfile(const char *fname); 173Boolean isfile(const char *); 174Boolean isempty(const char *); 175Boolean issymlink(const char *); 176Boolean isURL(const char *); 177char *fileGetURL(const char *, const char *, int); 178char *fileFindByPath(const char *, const char *); 179char *fileGetContents(const char *); 180void write_file(const char *, const char *); 181void copy_file(const char *, const char *, const char *); 182void move_file(const char *, const char *, const char *); 183void copy_hierarchy(const char *, const char *, Boolean); 184int delete_hierarchy(const char *, Boolean, Boolean); 185int unpack(const char *, const char *); 186void format_cmd(char *, int, const char *, const char *, const char *); 187 188/* Msg */ 189void upchuck(const char *); 190void barf(const char *, ...); 191void whinge(const char *, ...); 192Boolean y_or_n(Boolean, const char *, ...); 193 194/* Packing list */ 195PackingList new_plist_entry(void); 196PackingList last_plist(Package *); 197PackingList find_plist(Package *, plist_t); 198char *find_plist_option(Package *, const char *name); 199void plist_delete(Package *, Boolean, plist_t, const char *); 200void free_plist(Package *); 201void mark_plist(Package *); 202void csum_plist_entry(char *, PackingList); 203void add_plist(Package *, plist_t, const char *); 204void add_plist_top(Package *, plist_t, const char *); 205void delete_plist(Package *pkg, Boolean all, plist_t type, const char *name); 206void write_plist(Package *, FILE *); 207void read_plist(Package *, FILE *); 208int plist_cmd(const char *, char **); 209int delete_package(Boolean, Boolean, Package *); 210Boolean make_preserve_name(char *, int, const char *, const char *); 211 212/* For all */ 213int pkg_perform(char **); 214int real_main(int, char **); 215 216/* Query installed packages */ 217char **matchinstalled(match_t, char **, int *); 218char **matchbyorigin(const char *, int *); 219int isinstalledpkg(const char *name); 220int pattern_match(match_t MatchType, char *pattern, const char *pkgname); 221 222/* Dependencies */ 223int sortdeps(char **); 224int chkifdepends(const char *, const char *); 225int requiredby(const char *, struct reqr_by_head **, Boolean, Boolean); 226 227/* Version */ 228int verscmp(Package *, int, int); 229int version_cmp(const char *, const char *); 230 231/* Externs */ 232extern Boolean Quiet; 233extern Boolean Fake; 234extern Boolean Force; 235extern int AutoAnswer; 236extern int Verbose; 237 238#endif /* _INST_LIB_LIB_H_ */ 239