rpm  4.13.0
rpmcli.h
Go to the documentation of this file.
1 #ifndef H_RPMCLI
2 #define H_RPMCLI
3 
8 #include <popt.h>
9 
10 #include <rpm/rpmlib.h>
11 #include <rpm/rpmurl.h>
12 #include <rpm/rpmmacro.h>
13 #include <rpm/rpmcallback.h>
14 #include <rpm/rpmts.h>
15 #include <rpm/rpmfi.h>
16 #include <rpm/rpmvf.h>
17 #include <rpm/argv.h>
18 
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22 
26 extern struct poptOption rpmcliAllPoptTable[];
27 
28 extern const char * rpmcliPipeOutput;
29 
30 extern const char * rpmcliRcfile;
31 
32 extern const char * rpmcliRootDir;
33 
41 poptContext
42 rpmcliInit(int argc, char *const argv[], struct poptOption * optionsTable);
43 
48 void rpmcliConfigured(void);
49 
55 poptContext
56 rpmcliFini(poptContext optCon);
57 
61 #define RPMCLI_POPT_NODEPS -1025
62 #define RPMCLI_POPT_FORCE -1026
63 #define RPMCLI_POPT_NOMD5 -1027
64 #define RPMCLI_POPT_NOFILEDIGEST -1027 /* same as obsolete RPMCLI_POPT_NOMD5 */
65 #define RPMCLI_POPT_NOSCRIPTS -1028
66 #define RPMCLI_POPT_NOSIGNATURE -1029
67 #define RPMCLI_POPT_NODIGEST -1030
68 #define RPMCLI_POPT_NOHDRCHK -1031
69 #define RPMCLI_POPT_NOCONTEXTS -1032
70 
71 /* ==================================================================== */
98 };
99 
101 
108  QUERY_MD5 = (1 << 0),
109  QUERY_FILEDIGEST = (1 << 0),
110  QUERY_SIZE = (1 << 1),
111  QUERY_LINKTO = (1 << 2),
112  QUERY_USER = (1 << 3),
113  QUERY_GROUP = (1 << 4),
114  QUERY_MTIME = (1 << 5),
115  QUERY_MODE = (1 << 6),
116  QUERY_RDEV = (1 << 7),
117  /* bits 8-14 unused, reserved for rpmVerifyAttrs */
118  QUERY_CONTEXTS = (1 << 15),
119  QUERY_FILES = (1 << 16),
120  QUERY_DEPS = (1 << 17),
121  QUERY_SCRIPT = (1 << 18),
122  QUERY_DIGEST = (1 << 19),
123  QUERY_SIGNATURE = (1 << 20),
124  QUERY_PATCHES = (1 << 21),
125  QUERY_HDRCHK = (1 << 22),
126  QUERY_FOR_LIST = (1 << 23),
127  QUERY_FOR_STATE = (1 << 24),
128  QUERY_FOR_DOCS = (1 << 25),
129  QUERY_FOR_CONFIG = (1 << 26),
130  QUERY_FOR_DUMPFILES = (1 << 27),
131  QUERY_FOR_LICENSE = (1 << 28)
132 };
133 
135 
136 #define _QUERY_FOR_BITS \
137  (QUERY_FOR_LIST|QUERY_FOR_STATE|QUERY_FOR_DOCS|QUERY_FOR_CONFIG|\
138  QUERY_FOR_LICENSE|QUERY_FOR_DUMPFILES)
139 
143 extern rpmQueryFlags rpmcliQueryFlags;
144 
147 typedef struct rpmQVKArguments_s * QVA_t;
148 
157 typedef int (*QVF_t) (QVA_t qva, rpmts ts, Header h);
158 
167 typedef int (*QSpecF_t) (rpmts ts, QVA_t qva, const char * arg);
168 
173  rpmQVSources qva_source;
175  rpmQueryFlags qva_flags;
181  char qva_mode;
189 };
190 
193 extern struct rpmQVKArguments_s rpmQVKArgs;
194 
197 extern struct poptOption rpmQVSourcePoptTable[];
198 
201 extern struct poptOption rpmQueryPoptTable[];
202 
205 extern struct poptOption rpmVerifyPoptTable[];
206 
211 void rpmDisplayQueryTags(FILE * fp);
212 
221 int showQueryPackage(QVA_t qva, rpmts ts, Header h);
222 
230 int rpmcliArgIter(rpmts ts, QVA_t qva, ARGV_const_t argv);
231 
240 int rpmcliQuery(rpmts ts, QVA_t qva, ARGV_const_t argv);
241 
249 int showVerifyPackage(QVA_t qva, rpmts ts, Header h);
250 
259 int rpmVerifySignatures(QVA_t qva, rpmts ts, FD_t fd, const char * fn);
260 
269 int rpmcliVerify(rpmts ts, QVA_t qva, ARGV_const_t argv);
270 
271 /* ==================================================================== */
273 /* --- install/upgrade/erase modes */
274 
280  INSTALL_PERCENT = (1 << 0),
281  INSTALL_HASH = (1 << 1),
282  INSTALL_NODEPS = (1 << 2),
283  INSTALL_NOORDER = (1 << 3),
284  INSTALL_LABEL = (1 << 4),
285  INSTALL_UPGRADE = (1 << 5),
286  INSTALL_FRESHEN = (1 << 6),
287  INSTALL_INSTALL = (1 << 7),
288  INSTALL_ERASE = (1 << 8),
289  INSTALL_ALLMATCHES = (1 << 9),
290  INSTALL_REINSTALL = (1 << 10),
291 };
292 
294 
298 #define UNINSTALL_NONE INSTALL_NONE
299 #define UNINSTALL_NODEPS INSTALL_NODEPS
300 #define UNINSTALL_ALLMATCHES INSTALL_ALLMATCHES
301 
316 void * rpmShowProgress(const void * arg,
317  const rpmCallbackType what,
318  const rpm_loff_t amount,
319  const rpm_loff_t total,
320  fnpyKey key,
321  void * data);
322 
331 int rpmInstallSource(rpmts ts, const char * arg,
332  char ** specFilePtr,
333  char ** cookie);
334 
335 
342  rpmInstallFlags installInterfaceFlags;
344  int noDeps;
345  int incldocs;
347  char * prefix;
348 };
349 
359 int rpmInstall(rpmts ts, struct rpmInstallArguments_s * ia, ARGV_t fileArgv);
360 
369 int rpmErase(rpmts ts, struct rpmInstallArguments_s * ia, ARGV_const_t argv);
370 
373 extern struct rpmInstallArguments_s rpmIArgs;
374 
377 extern struct poptOption rpmInstallPoptTable[];
378 
379 /* ==================================================================== */
388 
396 
397 #ifdef __cplusplus
398 }
399 #endif
400 
401 #endif /* H_RPMCLI */
rpmQVSources_e
Query/Verify argument qualifiers.
Definition: rpmcli.h:78
const char * rpmcliRcfile
enum rpmCallbackType_e rpmCallbackType
Bit(s) to identify progress callbacks.
int rpmInstall(rpmts ts, struct rpmInstallArguments_s *ia, ARGV_t fileArgv)
Install/upgrade/freshen/reinstall binary rpm package.
rpmQueryFlags rpmcliQueryFlags
Bit(s) from common command line options.
int qva_sourceCount
Definition: rpmcli.h:174
int rpmcliArgIter(rpmts ts, QVA_t qva, ARGV_const_t argv)
Iterate over query/verify arg list.
char ** ARGV_t
Definition: argv.h:15
struct _FD_s * FD_t
RPM IO file descriptor type.
Definition: rpmtypes.h:98
rpmprobFilterFlags probFilter
Definition: rpmcli.h:341
int rpmcliQuery(rpmts ts, QVA_t qva, ARGV_const_t argv)
Display package information.
rpmFlags rpmQVSources
Definition: rpmcli.h:100
rpmQueryFlags qva_flags
Definition: rpmcli.h:175
rpmInstallFlags_e
Bit(s) to control rpmInstall() operation.
Definition: rpmcli.h:278
struct poptOption rpmInstallPoptTable[]
poptContext rpmcliInit(int argc, char *const argv[], struct poptOption *optionsTable)
Initialize most everything needed by an rpm CLI executable context.
poptContext rpmcliFini(poptContext optCon)
Destroy most everything needed by an rpm CLI executable context.
rpmRelocation * relocations
Definition: rpmcli.h:346
struct rpmQVKArguments_s rpmQVKArgs
int showQueryPackage(QVA_t qva, rpmts ts, Header h)
Display results of package query.
struct poptOption rpmVerifyPoptTable[]
int rpmcliVerify(rpmts ts, QVA_t qva, ARGV_const_t argv)
Verify package install.
rpmFlags rpmInstallFlags
Definition: rpmcli.h:293
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.
rpmFlags rpmprobFilterFlags
Definition: rpmprob.h:34
Describe query/verify/signature command line operation.
Definition: rpmcli.h:172
QSpecF_t qva_specQuery
Definition: rpmcli.h:179
We pass these around as an array with a sentinel.
Definition: rpmfiles.h:94
struct poptOption rpmQueryPoptTable[]
int rpmErase(rpmts ts, struct rpmInstallArguments_s *ia, ARGV_const_t argv)
Erase binary rpm package.
QVF_t qva_showPackage
Definition: rpmcli.h:178
void rpmcliConfigured(void)
Make sure that rpm configuration has been read.
int(* QVF_t)(QVA_t qva, rpmts ts, Header h)
Function to display iterator matches.
Definition: rpmcli.h:157
const char * rpmcliPipeOutput
rpmFlags rpmQueryFlags
Definition: rpmcli.h:134
rpmtransFlags transFlags
Definition: rpmcli.h:340
uint64_t rpm_loff_t
Definition: rpmtypes.h:51
int(* QSpecF_t)(rpmts ts, QVA_t qva, const char *arg)
Function to query spec file.
Definition: rpmcli.h:167
rpmQVSources qva_source
Definition: rpmcli.h:173
int rpmInstallSource(rpmts ts, const char *arg, char **specFilePtr, char **cookie)
Install source rpm package.
rpmfileAttrs qva_fflags
Definition: rpmcli.h:176
static struct poptOption optionsTable[]
Definition: rpmbuild.c:260
rpmInstallFlags installInterfaceFlags
Definition: rpmcli.h:342
uint32_t rpmFlags
Definition: rpmtypes.h:42
const char * rpmcliRootDir
int showVerifyPackage(QVA_t qva, rpmts ts, Header h)
Display results of package verify.
void rpmDisplayQueryTags(FILE *fp)
Display list of tags that can be used in –queryformat.
char * qva_queryFormat
Definition: rpmcli.h:180
char *const * ARGV_const_t
Definition: argv.h:16
struct rpmts_s * rpmts
The main types involved in transaction manipulation.
Definition: rpmtypes.h:63
struct rpmQVKArguments_s * QVA_t
Definition: rpmcli.h:147
Describe database command line requests.
Definition: rpmcli.h:339
rpmFlags rpmfileAttrs
Definition: rpmfiles.h:65
struct rpmInstallArguments_s rpmIArgs
int rpmcliVerifySignatures(rpmts ts, ARGV_const_t argv)
Verify package signatures.
struct poptOption rpmQVSourcePoptTable[]
const void * fnpyKey
Definition: rpmtypes.h:75
rpmFlags rpmtransFlags
Definition: rpmts.h:58
int rpmcliImportPubkeys(rpmts ts, ARGV_const_t argv)
Import public key(s) to rpm keyring.
struct poptOption rpmcliAllPoptTable[]
Popt option table for options shared by all modes and executables.
rpmQueryFlags_e
Bit(s) to control rpmQuery() operation, stored in qva_flags.
Definition: rpmcli.h:106
struct headerToken_s * Header
RPM header and data retrieval types.
Definition: rpmtypes.h:24
int rpmVerifySignatures(QVA_t qva, rpmts ts, FD_t fd, const char *fn)
Check package and header signatures.