rpm  4.14.3-rc1
rpmcli.h
Go to the documentation of this file.
1 #ifndef H_RPMCLI
2 #define H_RPMCLI
3 
10 #include <popt.h>
11 
12 #include <rpm/rpmlib.h>
13 #include <rpm/rpmurl.h>
14 #include <rpm/rpmmacro.h>
15 #include <rpm/rpmcallback.h>
16 #include <rpm/rpmts.h>
17 #include <rpm/rpmfi.h>
18 #include <rpm/rpmvf.h>
19 #include <rpm/argv.h>
20 
21 #ifdef __cplusplus
22 extern "C" {
23 #endif
24 
28 extern struct poptOption rpmcliAllPoptTable[];
29 
30 extern const char * rpmcliPipeOutput;
31 
32 extern const char * rpmcliRcfile;
33 
34 extern const char * rpmcliRootDir;
35 
43 poptContext
44 rpmcliInit(int argc, char *const argv[], struct poptOption * optionsTable);
45 
50 void rpmcliConfigured(void);
51 
57 poptContext
58 rpmcliFini(poptContext optCon);
59 
63 #define RPMCLI_POPT_NODEPS -1025
64 #define RPMCLI_POPT_FORCE -1026
65 #define RPMCLI_POPT_NOMD5 -1027
66 #define RPMCLI_POPT_NOFILEDIGEST -1027 /* same as obsolete RPMCLI_POPT_NOMD5 */
67 #define RPMCLI_POPT_NOSCRIPTS -1028
68 #define RPMCLI_POPT_NOSIGNATURE -1029
69 #define RPMCLI_POPT_NODIGEST -1030
70 #define RPMCLI_POPT_NOHDRCHK -1031
71 #define RPMCLI_POPT_NOCONTEXTS -1032
72 #define RPMCLI_POPT_NOCAPS -1033
73 #define RPMCLI_POPT_TARGETPLATFORM -1034
74 
75 /* ==================================================================== */
105 };
106 
108 
115  QUERY_MD5 = (1 << 0),
116  QUERY_FILEDIGEST = (1 << 0),
117  QUERY_SIZE = (1 << 1),
118  QUERY_LINKTO = (1 << 2),
119  QUERY_USER = (1 << 3),
120  QUERY_GROUP = (1 << 4),
121  QUERY_MTIME = (1 << 5),
122  QUERY_MODE = (1 << 6),
123  QUERY_RDEV = (1 << 7),
124  /* bits 8-14 unused, reserved for rpmVerifyAttrs */
125  QUERY_CONTEXTS = (1 << 15),
126  QUERY_FILES = (1 << 16),
127  QUERY_DEPS = (1 << 17),
128  QUERY_SCRIPT = (1 << 18),
129  QUERY_DIGEST = (1 << 19),
130  QUERY_SIGNATURE = (1 << 20),
131  QUERY_PATCHES = (1 << 21),
132  QUERY_HDRCHK = (1 << 22),
133  QUERY_FOR_LIST = (1 << 23),
134  QUERY_FOR_STATE = (1 << 24),
135  QUERY_FOR_DOCS = (1 << 25),
136  QUERY_FOR_CONFIG = (1 << 26),
137  QUERY_FOR_DUMPFILES = (1 << 27),
138  QUERY_FOR_LICENSE = (1 << 28),
139  QUERY_FOR_ARTIFACT = (1 << 29),
140 };
141 
143 
144 #define _QUERY_FOR_BITS \
145  (QUERY_FOR_LIST|QUERY_FOR_STATE|QUERY_FOR_DOCS|QUERY_FOR_CONFIG|\
146  QUERY_FOR_LICENSE|QUERY_FOR_DUMPFILES)
147 
152 
154 
155 extern int rpmcliVfyLevelMask;
156 
159 typedef struct rpmQVKArguments_s * QVA_t;
160 
169 typedef int (*QVF_t) (QVA_t qva, rpmts ts, Header h);
170 
179 typedef int (*QSpecF_t) (rpmts ts, QVA_t qva, const char * arg);
180 
193  char qva_mode;
201 };
202 
205 extern struct rpmQVKArguments_s rpmQVKArgs;
206 
209 extern struct poptOption rpmQVSourcePoptTable[];
210 
213 extern struct poptOption rpmQueryPoptTable[];
214 
217 extern struct poptOption rpmVerifyPoptTable[];
218 
223 void rpmDisplayQueryTags(FILE * fp);
224 
233 int showQueryPackage(QVA_t qva, rpmts ts, Header h);
234 
242 int rpmcliArgIter(rpmts ts, QVA_t qva, ARGV_const_t argv);
243 
252 int rpmcliQuery(rpmts ts, QVA_t qva, ARGV_const_t argv);
253 
261 int showVerifyPackage(QVA_t qva, rpmts ts, Header h);
262 
271 int rpmVerifySignatures(QVA_t qva, rpmts ts, FD_t fd, const char * fn);
272 
281 int rpmcliVerify(rpmts ts, QVA_t qva, ARGV_const_t argv);
282 
283 /* ==================================================================== */
285 /* --- install/upgrade/erase modes */
286 
292  INSTALL_PERCENT = (1 << 0),
293  INSTALL_HASH = (1 << 1),
294  INSTALL_NODEPS = (1 << 2),
295  INSTALL_NOORDER = (1 << 3),
296  INSTALL_LABEL = (1 << 4),
297  INSTALL_UPGRADE = (1 << 5),
298  INSTALL_FRESHEN = (1 << 6),
299  INSTALL_INSTALL = (1 << 7),
300  INSTALL_ERASE = (1 << 8),
301  INSTALL_ALLMATCHES = (1 << 9),
302  INSTALL_REINSTALL = (1 << 10),
303 };
304 
306 
310 #define UNINSTALL_NONE INSTALL_NONE
311 #define UNINSTALL_NODEPS INSTALL_NODEPS
312 #define UNINSTALL_ALLMATCHES INSTALL_ALLMATCHES
313 
328 void * rpmShowProgress(const void * arg,
329  const rpmCallbackType what,
330  const rpm_loff_t amount,
331  const rpm_loff_t total,
332  fnpyKey key,
333  void * data);
334 
343 int rpmInstallSource(rpmts ts, const char * arg,
344  char ** specFilePtr,
345  char ** cookie);
346 
347 
356  int noDeps;
357  int incldocs;
359  char * prefix;
360 };
361 
371 int rpmInstall(rpmts ts, struct rpmInstallArguments_s * ia, ARGV_t fileArgv);
372 
381 int rpmErase(rpmts ts, struct rpmInstallArguments_s * ia, ARGV_const_t argv);
382 
385 extern struct rpmInstallArguments_s rpmIArgs;
386 
389 extern struct poptOption rpmInstallPoptTable[];
390 
391 /* ==================================================================== */
400 
408 
409 #ifdef __cplusplus
410 }
411 #endif
412 
413 #endif /* H_RPMCLI */
const char * rpmcliRcfile
enum rpmCallbackType_e rpmCallbackType
Bit(s) to identify progress callbacks.
struct rpmQVKArguments_s * QVA_t
Definition: rpmcli.h:159
int qva_sourceCount
Definition: rpmcli.h:186
char ** ARGV_t
Definition: argv.h:17
rpmprobFilterFlags probFilter
Definition: rpmcli.h:353
void rpmDisplayQueryTags(FILE *fp)
Display list of tags that can be used in –queryformat.
rpmFlags rpmQVSources
Definition: rpmcli.h:107
int rpmErase(rpmts ts, struct rpmInstallArguments_s *ia, ARGV_const_t argv)
Erase binary rpm package.
rpmQueryFlags qva_flags
Definition: rpmcli.h:187
rpmQVSources_e
Query/Verify argument qualifiers.
Definition: rpmcli.h:82
poptContext rpmcliInit(int argc, char *const argv[], struct poptOption *optionsTable)
Initialize most everything needed by an rpm CLI executable context.
int rpmcliQuery(rpmts ts, QVA_t qva, ARGV_const_t argv)
Display package information.
int rpmcliVfyLevelMask
rpmRelocation * relocations
Definition: rpmcli.h:358
int rpmcliVerifySignatures(rpmts ts, ARGV_const_t argv)
Verify package signatures.
struct rpmts_s * rpmts
The main types involved in transaction manipulation.
Definition: rpmtypes.h:63
rpmFlags rpmprobFilterFlags
Definition: rpmprob.h:35
Describe query/verify/signature command line operation.
Definition: rpmcli.h:184
QSpecF_t qva_specQuery
Definition: rpmcli.h:191
We pass these around as an array with a sentinel.
Definition: rpmfiles.h:96
struct rpmQVKArguments_s rpmQVKArgs
int showVerifyPackage(QVA_t qva, rpmts ts, Header h)
Display results of package verify.
QVF_t qva_showPackage
Definition: rpmcli.h:190
rpmQueryFlags rpmcliQueryFlags
Bit(s) from common command line options.
struct poptOption rpmInstallPoptTable[]
int rpmInstallSource(rpmts ts, const char *arg, char **specFilePtr, char **cookie)
Install source rpm package.
uint32_t rpmFlags
Definition: rpmtypes.h:42
poptContext rpmcliFini(poptContext optCon)
Destroy most everything needed by an rpm CLI executable context.
const char * rpmcliPipeOutput
int showQueryPackage(QVA_t qva, rpmts ts, Header h)
Display results of package query.
struct poptOption rpmQueryPoptTable[]
rpmFlags rpmQueryFlags
Definition: rpmcli.h:142
struct _FD_s * FD_t
RPM IO file descriptor type.
Definition: rpmtypes.h:98
int(* QVF_t)(QVA_t qva, rpmts ts, Header h)
Function to display iterator matches.
Definition: rpmcli.h:169
rpmtransFlags transFlags
Definition: rpmcli.h:352
struct poptOption rpmQVSourcePoptTable[]
rpmQVSources qva_source
Definition: rpmcli.h:185
struct headerToken_s * Header
RPM header and data retrieval types.
Definition: rpmtypes.h:24
int rpmcliVerify(rpmts ts, QVA_t qva, ARGV_const_t argv)
Verify package install.
const void * fnpyKey
Definition: rpmtypes.h:75
rpmfileAttrs qva_fflags
Definition: rpmcli.h:188
rpmInstallFlags installInterfaceFlags
Definition: rpmcli.h:354
rpmFlags rpmVSFlags
Definition: rpmts.h:111
struct rpmInstallArguments_s rpmIArgs
rpmVSFlags rpmcliVSFlags
const char * rpmcliRootDir
struct poptOption rpmcliAllPoptTable[]
Popt option table for options shared by all modes and executables.
char * qva_queryFormat
Definition: rpmcli.h:192
char *const * ARGV_const_t
Definition: argv.h:18
rpmInstallFlags_e
Bit(s) to control rpmInstall() operation.
Definition: rpmcli.h:290
rpmQueryFlags_e
Bit(s) to control rpmQuery() operation, stored in qva_flags.
Definition: rpmcli.h:113
Describe database command line requests.
Definition: rpmcli.h:351
void rpmcliConfigured(void)
Make sure that rpm configuration has been read.
struct poptOption rpmVerifyPoptTable[]
rpmFlags rpmInstallFlags
Definition: rpmcli.h:305
int(* QSpecF_t)(rpmts ts, QVA_t qva, const char *arg)
Function to query spec file.
Definition: rpmcli.h:179
rpmFlags rpmfileAttrs
Definition: rpmfiles.h:66
int rpmInstall(rpmts ts, struct rpmInstallArguments_s *ia, ARGV_t fileArgv)
Install/upgrade/freshen/reinstall binary rpm package.
void * rpmShowProgress(const void *arg, const rpmCallbackType what, const rpm_loff_t amount, const rpm_loff_t total, fnpyKey key, void *data)
The rpm CLI generic transaction callback handler.
int rpmcliArgIter(rpmts ts, QVA_t qva, ARGV_const_t argv)
Iterate over query/verify arg list.
rpmFlags rpmtransFlags
Definition: rpmts.h:59
int rpmcliImportPubkeys(rpmts ts, ARGV_const_t argv)
Import public key(s) to rpm keyring.
uint64_t rpm_loff_t
Definition: rpmtypes.h:51
int rpmVerifySignatures(QVA_t qva, rpmts ts, FD_t fd, const char *fn)
Check package and header signatures.