1/* $FreeBSD: releng/10.3/usr.sbin/pkg_install/lib/lib.h 245828 2013-01-22 22:41:12Z bapt $ */ 2 3/* 4 * FreeBSD install - a package for the installation and maintenance 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 <sys/utsname.h> 32#include <ctype.h> 33#include <dirent.h> 34#include <stdarg.h> 35#include <stdio.h> 36#include <stdlib.h> 37#include <string.h> 38#include <unistd.h> 39 40/* Macros */ 41#define SUCCESS (0) 42#define FAIL (-1) 43 44#ifndef TRUE 45#define TRUE (1) 46#endif 47 48#ifndef FALSE 49#define FALSE (0) 50#endif 51 52#define YES 2 53#define NO 1 54 55/* Some more stat macros. */ 56#define S_IRALL 0000444 57#define S_IWALL 0000222 58#define S_IXALL 0000111 59 60/* Usually "rm", but often "echo" during debugging! */ 61#define REMOVE_CMD "/bin/rm" 62 63/* Usually "rm", but often "echo" during debugging! */ 64#define RMDIR_CMD "/bin/rmdir" 65 66/* Where the ports lives by default */ 67#define DEF_PORTS_DIR "/usr/ports" 68/* just in case we change the environment variable name */ 69#define PORTSDIR "PORTSDIR" 70/* macro to get name of directory where the ports lives */ 71#define PORTS_DIR (getenv(PORTSDIR) ? getenv(PORTSDIR) : DEF_PORTS_DIR) 72 73/* Where we put logging information by default, else ${PKG_DBDIR} if set */ 74#define DEF_LOG_DIR "/var/db/pkg" 75/* just in case we change the environment variable name */ 76#define PKG_DBDIR "PKG_DBDIR" 77/* macro to get name of directory where we put logging information */ 78#define LOG_DIR (getenv(PKG_DBDIR) ? getenv(PKG_DBDIR) : DEF_LOG_DIR) 79 80/* The names of our "special" files */ 81#define CONTENTS_FNAME "+CONTENTS" 82#define COMMENT_FNAME "+COMMENT" 83#define DESC_FNAME "+DESC" 84#define INSTALL_FNAME "+INSTALL" 85#define POST_INSTALL_FNAME "+POST-INSTALL" 86#define DEINSTALL_FNAME "+DEINSTALL" 87#define POST_DEINSTALL_FNAME "+POST-DEINSTALL" 88#define REQUIRE_FNAME "+REQUIRE" 89#define REQUIRED_BY_FNAME "+REQUIRED_BY" 90#define DISPLAY_FNAME "+DISPLAY" 91#define MTREE_FNAME "+MTREE_DIRS" 92 93#define CMD_CHAR '@' /* prefix for extended PLIST cmd */ 94 95/* The name of the "prefix" environment variable given to scripts */ 96#define PKG_PREFIX_VNAME "PKG_PREFIX" 97 98/* 99 * Version of the package tools - increase whenever you make a change 100 * in the code that is not cosmetic only. 101 */ 102#define PKG_INSTALL_VERSION 20130122 103 104#define PKG_WRAPCONF_FNAME "/var/db/pkg_install.conf" 105#define main(argc, argv) real_main(argc, argv) 106 107/* Version numbers to assist with changes in package file format */ 108#define PLIST_FMT_VER_MAJOR 1 109#define PLIST_FMT_VER_MINOR 1 110 111enum _plist_t { 112 PLIST_FILE, PLIST_CWD, PLIST_CMD, PLIST_CHMOD, 113 PLIST_CHOWN, PLIST_CHGRP, PLIST_COMMENT, PLIST_IGNORE, 114 PLIST_NAME, PLIST_UNEXEC, PLIST_SRC, PLIST_DISPLAY, 115 PLIST_PKGDEP, PLIST_CONFLICTS, PLIST_MTREE, PLIST_DIR_RM, 116 PLIST_IGNORE_INST, PLIST_OPTION, PLIST_ORIGIN, PLIST_DEPORIGIN, 117 PLIST_NOINST 118}; 119typedef enum _plist_t plist_t; 120 121enum _match_t { 122 MATCH_ALL, MATCH_EXACT, MATCH_GLOB, MATCH_NGLOB, MATCH_EREGEX, MATCH_REGEX 123}; 124typedef enum _match_t match_t; 125 126/* Types */ 127typedef unsigned int Boolean; 128 129struct _plist { 130 struct _plist *prev, *next; 131 char *name; 132 Boolean marked; 133 plist_t type; 134}; 135typedef struct _plist *PackingList; 136 137struct _pack { 138 struct _plist *head, *tail; 139 const char *name; 140 const char *origin; 141 int fmtver_maj, fmtver_mnr; 142}; 143typedef struct _pack Package; 144 145struct reqr_by_entry { 146 STAILQ_ENTRY(reqr_by_entry) link; 147 char pkgname[PATH_MAX]; 148}; 149STAILQ_HEAD(reqr_by_head, reqr_by_entry); 150 151/* Prototypes */ 152/* Misc */ 153int vsystem(const char *, ...); 154char *vpipe(const char *, ...); 155void cleanup(int); 156const char *make_playpen(char *, off_t); 157char *where_playpen(void); 158int leave_playpen(void); 159off_t min_free(const char *); 160void warnpkgng(void); 161 162/* String */ 163char *get_dash_string(char **); 164char *copy_string(const char *); 165char *copy_string_adds_newline(const char *); 166Boolean suffix(const char *, const char *); 167void nuke_suffix(char *); 168void str_lowercase(char *); 169char *strconcat(const char *, const char *); 170char *get_string(char *, int, FILE *); 171 172/* File */ 173Boolean fexists(const char *); 174Boolean isdir(const char *); 175Boolean isemptydir(const char *fname); 176Boolean isemptyfile(const char *fname); 177Boolean isfile(const char *); 178Boolean isempty(const char *); 179Boolean issymlink(const char *); 180Boolean isURL(const char *); 181const char *fileGetURL(const char *, const char *, int); 182char *fileFindByPath(const char *, const char *); 183char *fileGetContents(const char *); 184void write_file(const char *, const char *); 185void copy_file(const char *, const char *, const char *); 186void move_file(const char *, const char *, const char *); 187void copy_hierarchy(const char *, const char *, Boolean); 188int delete_hierarchy(const char *, Boolean, Boolean); 189int unpack(const char *, const char *); 190void format_cmd(char *, int, const char *, const char *, const char *); 191 192/* Msg */ 193void upchuck(const char *); 194void barf(const char *, ...); 195void whinge(const char *, ...); 196Boolean y_or_n(Boolean, const char *, ...); 197 198/* Packing list */ 199PackingList new_plist_entry(void); 200PackingList last_plist(Package *); 201PackingList find_plist(Package *, plist_t); 202char *find_plist_option(Package *, const char *name); 203void plist_delete(Package *, Boolean, plist_t, const char *); 204void free_plist(Package *); 205void mark_plist(Package *); 206void csum_plist_entry(char *, PackingList); 207void add_plist(Package *, plist_t, const char *); 208void add_plist_top(Package *, plist_t, const char *); 209void delete_plist(Package *pkg, Boolean all, plist_t type, const char *name); 210void write_plist(Package *, FILE *); 211void read_plist(Package *, FILE *); 212int plist_cmd(const char *, char **); 213int delete_package(Boolean, Boolean, Package *); 214Boolean make_preserve_name(char *, int, const char *, const char *); 215 216/* For all */ 217int pkg_perform(char **); 218int real_main(int, char **); 219 220/* Query installed packages */ 221char **matchinstalled(match_t, char **, int *); 222char **matchbyorigin(const char *, int *); 223char ***matchallbyorigin(const char **, int *); 224int isinstalledpkg(const char *name); 225int pattern_match(match_t MatchType, char *pattern, const char *pkgname); 226 227/* Dependencies */ 228int sortdeps(char **); 229int chkifdepends(const char *, const char *); 230int requiredby(const char *, struct reqr_by_head **, Boolean, Boolean); 231 232/* Version */ 233int verscmp(Package *, int, int); 234int version_cmp(const char *, const char *); 235 236/* Externs */ 237extern Boolean Quiet; 238extern Boolean Fake; 239extern Boolean Force; 240extern int AutoAnswer; 241extern int Verbose; 242 243#endif /* _INST_LIB_LIB_H_ */ 244