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