librazor/razor.h.in
author J. Ali Harlow <ali@juiblex.co.uk>
Thu Jun 07 18:36:20 2018 +0100 (2018-06-07)
changeset 499 c89e5edb8eae
parent 483 8087224f30c4
permissions -rw-r--r--
Improve error on failure to lock database
ali@452
     1
/*
ali@452
     2
 * Copyright (C) 2008  Kristian Høgsberg <krh@redhat.com>
ali@452
     3
 * Copyright (C) 2008  Red Hat, Inc
ali@499
     4
 * Copyright (C) 2009, 2011, 2012, 2014, 2016, 2018
ali@499
     5
 *		 J. Ali Harlow <ali@juiblex.co.uk>
ali@452
     6
 *
ali@452
     7
 * This program is free software; you can redistribute it and/or modify
ali@452
     8
 * it under the terms of the GNU General Public License as published by
ali@452
     9
 * the Free Software Foundation; either version 2 of the License, or
ali@452
    10
 * (at your option) any later version.
ali@452
    11
 *
ali@452
    12
 * This program is distributed in the hope that it will be useful,
ali@452
    13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
ali@452
    14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
ali@452
    15
 * GNU General Public License for more details.
ali@452
    16
 *
ali@452
    17
 * You should have received a copy of the GNU General Public License along
ali@452
    18
 * with this program; if not, write to the Free Software Foundation, Inc.,
ali@452
    19
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
ali@452
    20
 */
ali@452
    21
ali@452
    22
#ifndef _RAZOR_H_
ali@452
    23
#define _RAZOR_H_
ali@452
    24
ali@457
    25
#include <stdio.h>
ali@452
    26
#include <stdint.h>
ali@475
    27
#include <sys/stat.h>
ali@452
    28
ali@452
    29
/* GCC extensions */
ali@452
    30
#if defined(__GNUC__)
ali@452
    31
#if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96)
ali@452
    32
#define RAZOR_MALLOC __attribute__((__malloc__))
ali@452
    33
#else
ali@452
    34
#define RAZOR_MALLOC
ali@452
    35
#endif
ali@452
    36
#if __GNUC__ >= 4
ali@452
    37
#define RAZOR_NULL_TERMINATED __attribute__ ((__sentinel__))
ali@452
    38
#else
ali@452
    39
#define RAZOR_NULL_TERMINATED
ali@452
    40
#endif
ali@452
    41
#endif	/* __GNUC__ */
ali@452
    42
ali@452
    43
enum razor_section_type {
ali@452
    44
	RAZOR_SECTION_MAIN = 0x01,
ali@452
    45
	RAZOR_SECTION_DETAILS = 0x02,
ali@452
    46
	RAZOR_SECTION_FILES = 0x04,
ali@452
    47
	RAZOR_SECTION_ALL = 0x07
ali@452
    48
};
ali@452
    49
ali@452
    50
enum razor_stage_type {
ali@452
    51
	RAZOR_STAGE_SCRIPTS_PRE = 0x1,
ali@452
    52
	RAZOR_STAGE_FILES = 0x2,
ali@452
    53
	RAZOR_STAGE_SCRIPTS_POST = 0x4,
ali@452
    54
	RAZOR_STAGE_SCRIPTS = 0x5,
ali@452
    55
	RAZOR_STAGE_ALL = 0x7
ali@452
    56
};
ali@452
    57
ali@452
    58
enum razor_detail_type {
ali@452
    59
	RAZOR_DETAIL_LAST = 0,	/* the sentinel */
ali@452
    60
	RAZOR_DETAIL_NAME,
ali@452
    61
	RAZOR_DETAIL_VERSION,
ali@452
    62
	RAZOR_DETAIL_ARCH,
ali@452
    63
	RAZOR_DETAIL_SUMMARY,
ali@452
    64
	RAZOR_DETAIL_DESCRIPTION,
ali@452
    65
	RAZOR_DETAIL_URL,
ali@452
    66
	RAZOR_DETAIL_LICENSE,
ali@452
    67
	RAZOR_DETAIL_PREUNPROG,
ali@452
    68
	RAZOR_DETAIL_PREUN,
ali@452
    69
	RAZOR_DETAIL_POSTUNPROG,
ali@452
    70
	RAZOR_DETAIL_POSTUN,
ali@452
    71
	RAZOR_DETAIL_PREFIXES
ali@452
    72
};
ali@452
    73
ali@452
    74
enum razor_property_flags {
ali@452
    75
	RAZOR_PROPERTY_LESS		= 1 << 0,
ali@452
    76
	RAZOR_PROPERTY_GREATER		= 1 << 1,
ali@452
    77
	RAZOR_PROPERTY_EQUAL		= 1 << 2,
ali@452
    78
	RAZOR_PROPERTY_RELATION_MASK	=
ali@452
    79
		RAZOR_PROPERTY_LESS |
ali@452
    80
		RAZOR_PROPERTY_GREATER |
ali@452
    81
		RAZOR_PROPERTY_EQUAL,
ali@452
    82
ali@452
    83
	RAZOR_PROPERTY_REQUIRES		= 0 << 3,
ali@452
    84
	RAZOR_PROPERTY_PROVIDES		= 1 << 3,
ali@452
    85
	RAZOR_PROPERTY_CONFLICTS	= 2 << 3,
ali@452
    86
	RAZOR_PROPERTY_OBSOLETES	= 3 << 3,
ali@452
    87
	RAZOR_PROPERTY_TYPE_MASK	= 3 << 3,
ali@452
    88
		
ali@452
    89
	RAZOR_PROPERTY_PRE		= 1 << 5,
ali@452
    90
	RAZOR_PROPERTY_POST		= 1 << 6,
ali@452
    91
	RAZOR_PROPERTY_PREUN		= 1 << 7,
ali@452
    92
	RAZOR_PROPERTY_POSTUN		= 1 << 8,
ali@452
    93
	RAZOR_PROPERTY_SCRIPT_MASK	=
ali@452
    94
		RAZOR_PROPERTY_PRE |
ali@452
    95
		RAZOR_PROPERTY_POST |
ali@452
    96
		RAZOR_PROPERTY_PREUN |
ali@452
    97
		RAZOR_PROPERTY_POSTUN
ali@452
    98
};
ali@452
    99
ali@452
   100
enum razor_set_flags {
ali@452
   101
	/*
ali@452
   102
	 * Create a private copy of the razor set such that changes made
ali@452
   103
	 * to the underlying file are not visible in the razor set.
ali@452
   104
	 * If this flag is not set then the caller must ensure that the
ali@452
   105
	 * underlying file (if any) is not changed.
ali@452
   106
	 */
ali@452
   107
	RAZOR_SET_PRIVATE		= 1 << 0,
ali@452
   108
};
ali@452
   109
ali@452
   110
/**
ali@452
   111
 * SECTION:error
ali@452
   112
 * @title: Error reporting
ali@452
   113
 * @short_description: A system for reporting errors.
ali@452
   114
 *
ali@452
   115
 * This object represents an error condition.
ali@452
   116
 */
ali@452
   117
struct razor_error;
ali@452
   118
ali@452
   119
struct razor_error *razor_error_new_str(int domain, int code,
ali@452
   120
					const char *object, const char *str);
ali@452
   121
struct razor_error *razor_error_dup(struct razor_error *src,
ali@452
   122
				    const char *summary);
ali@452
   123
ali@452
   124
#define razor_set_error(error, domain, code, object, str) \
ali@452
   125
	if (error) \
ali@452
   126
		*(error) = razor_error_new_str(domain, code, object, str); \
ali@452
   127
	else
ali@452
   128
ali@452
   129
#define razor_propagate_error(dest, src, summary) \
ali@452
   130
	if (dest) \
ali@452
   131
		*(dest) = razor_error_dup(src, summary); \
ali@452
   132
	else
ali@452
   133
ali@475
   134
#define razor_error_matches(error, domain, code) \
ali@475
   135
	((error) && razor_error_get_domain(error) == (domain) && \
ali@475
   136
	 razor_error_get_code(error) == (code))
ali@475
   137
ali@452
   138
#define RAZOR_ERROR_DOMAIN(i1,i2,i3,c) \
ali@452
   139
	(((i1)&0xff)<<24|((i2)&0xff)<<16|((i3)&0xff)<<8|(c)&0xff)
ali@452
   140
ali@452
   141
#define RAZOR_GENERAL_ERROR	RAZOR_ERROR_DOMAIN('R','z','r',0)
ali@452
   142
#define RAZOR_POSIX_ERROR	RAZOR_ERROR_DOMAIN('R','z','r',1)
ali@452
   143
#define RAZOR_MSWIN_ERROR	RAZOR_ERROR_DOMAIN('R','z','r',2)
ali@452
   144
#define RAZOR_ZLIB_ERROR	RAZOR_ERROR_DOMAIN('R','z','r',3)
ali@452
   145
ali@452
   146
enum razor_general_error {
ali@452
   147
	RAZOR_GENERAL_ERROR_FAILED,
ali@452
   148
	RAZOR_GENERAL_ERROR_DATABASE_CORRUPTED,
ali@452
   149
	RAZOR_GENERAL_ERROR_DATABASE_INCOMPATIBLE,
ali@452
   150
	RAZOR_GENERAL_ERROR_DATABASE_EXISTS,
ali@452
   151
	RAZOR_GENERAL_ERROR_DATABASE_LOCKED,
ali@452
   152
	RAZOR_GENERAL_ERROR_RPM_UNSUPPORTED,
ali@475
   153
	RAZOR_GENERAL_ERROR_UNSUPPORTED_URI,
ali@475
   154
	RAZOR_GENERAL_ERROR_BAD_URI,
ali@483
   155
	RAZOR_GENERAL_ERROR_UNSUPPORTED_ARCHIVE,
ali@499
   156
	RAZOR_GENERAL_ERROR_ALREADY_LOCKED,
ali@499
   157
	RAZOR_GENERAL_ERROR_EXTERNALLY_LOCKED,
ali@452
   158
};
ali@452
   159
ali@452
   160
int razor_error_get_domain(struct razor_error *error);
ali@452
   161
int razor_error_get_code(struct razor_error *error);
ali@452
   162
const char *razor_error_get_object(struct razor_error *error);
ali@452
   163
const char *razor_error_get_primary_text(struct razor_error *error);
ali@452
   164
const char *razor_error_get_secondary_text(struct razor_error *error);
ali@452
   165
const char *razor_error_get_msg(struct razor_error *error);
ali@452
   166
void razor_error_free(struct razor_error *error);
ali@452
   167
ali@452
   168
/**
ali@452
   169
 * SECTION:atomic
ali@452
   170
 * @title: Atomic transactions
ali@452
   171
 * @short_description: File-based transactions that shouldn't half-succeed
ali@452
   172
 *
ali@452
   173
 * This is a helper object for issuing a sequence of file-based actions
ali@452
   174
 * that should either all succeed or all fail.
ali@452
   175
 *
ali@452
   176
 * Note that currently only Windows 7 has a native implementation and that
ali@452
   177
 * while the emulated fallback implementation attempts to rollback the
ali@452
   178
 * transaction if it fails, this is not guaranteed to succeed and that
ali@452
   179
 * the transaction is held in core (and thus vulnernable to program crashes,
ali@452
   180
 * power loss, etc.). This could (and should) be improved.
ali@452
   181
 *
ali@452
   182
 * Atomic transactions can be disabled via configure, in which case all
ali@452
   183
 * bets are off.
ali@452
   184
 **/
ali@452
   185
ali@452
   186
@RAZOR_HAVE_ATOMIC_ROLLBACK@
ali@452
   187
ali@452
   188
struct razor_atomic;
ali@452
   189
ali@452
   190
struct razor_atomic *razor_atomic_open(const char *description);
ali@452
   191
int razor_atomic_commit(struct razor_atomic *atomic);
ali@452
   192
struct razor_error *razor_atomic_get_error(struct razor_atomic *atomic);
ali@452
   193
const char *razor_atomic_get_error_msg(struct razor_atomic *atomic);
ali@452
   194
void razor_atomic_destroy(struct razor_atomic *atomic);
ali@452
   195
ali@452
   196
/**
ali@452
   197
 * razor_atomic_make_dirs
ali@452
   198
 * 
ali@479
   199
 * Create all sub-directories leading up to uri. We know root_uri exists
ali@479
   200
 * and is a dir, root_uri does not end in a '/', and uri either has a
ali@479
   201
 * leading '/' or (on MS-Windows only) root_uri is the empty string
ali@479
   202
 * and uri starts with drive (eg., "c:/windows").
ali@479
   203
 * Note: uri itself is not created, only the directory in which it
ali@452
   204
 * (would) exist.
ali@452
   205
 *
ali@452
   206
 * Returns: non-zero on error.
ali@452
   207
 **/
ali@475
   208
int razor_atomic_make_dirs(struct razor_atomic *atomic, const char *root_uri,
ali@475
   209
  const char *uri);
ali@452
   210
int razor_atomic_remove(struct razor_atomic *atomic, const char *path);
ali@475
   211
int razor_atomic_rename_file(struct razor_atomic *atomic, const char *old_uri,
ali@475
   212
			     const char *new_uri);
ali@452
   213
ali@452
   214
/**
ali@452
   215
 * razor_atomic_create_dir
ali@452
   216
 * 
ali@452
   217
 * Create a directory, replacing any existing object at this path except
ali@452
   218
 * an existing directory (which is not counted as a error).
ali@452
   219
 *
ali@452
   220
 * Returns: non-zero on error.
ali@452
   221
 */
ali@475
   222
int razor_atomic_create_dir(struct razor_atomic *atomic, const char *uri,
ali@475
   223
			    mode_t mode);
ali@452
   224
ali@452
   225
/**
ali@452
   226
 * razor_atomic_create_symlink
ali@452
   227
 * 
ali@452
   228
 * Create a symbolic link, replacing any existing object at this path except
ali@452
   229
 * a non-empty directory.
ali@452
   230
 *
ali@452
   231
 * Note: This function will always fail on platforms that don't support
ali@452
   232
 * symbolic links.
ali@452
   233
 *
ali@452
   234
 * Returns: non-zero on error.
ali@452
   235
 */
ali@452
   236
int razor_atomic_create_symlink(struct razor_atomic *atomic, const char *target,
ali@475
   237
				const char *uri);
ali@452
   238
/**
ali@452
   239
 * razor_atomic_create_file
ali@452
   240
 * 
ali@452
   241
 * Create a file, replacing any existing object at this path except
ali@452
   242
 * a non-empty directory.
ali@452
   243
 *
ali@452
   244
 * Returns: A handle to be passed to razor_atomic_write() and
ali@452
   245
 * razor_atomic_close() or a negative value on error.
ali@452
   246
 */
ali@475
   247
int razor_atomic_create_file(struct razor_atomic *atomic, const char *uri,
ali@475
   248
			     mode_t mode);
ali@452
   249
int razor_atomic_write(struct razor_atomic *atomic, int handle,
ali@475
   250
		       const void *data, size_t size);
ali@452
   251
int razor_atomic_close(struct razor_atomic *atomic, int handle);
ali@452
   252
int razor_atomic_sync(struct razor_atomic *atomic, int handle);
ali@452
   253
void razor_atomic_abort(struct razor_atomic *atomic, int domain, int code,
ali@475
   254
			const char *error_msg);
ali@475
   255
void
ali@475
   256
razor_atomic_propagate_error(struct razor_atomic *atomic,
ali@475
   257
			     struct razor_error *error, const char *summary);
ali@452
   258
int razor_atomic_in_error_state(struct razor_atomic *atomic);
ali@452
   259
ali@452
   260
/**
ali@452
   261
 * SECTION:set
ali@452
   262
 * @title: Package Set
ali@452
   263
 * @short_description: Represents a set of packages and their metadata.
ali@452
   264
 *
ali@452
   265
 * This object represents a set of packages, their dependency
ali@452
   266
 * information, the file lists and a number of other details.
ali@452
   267
 **/
ali@452
   268
ali@452
   269
struct razor_set;
ali@452
   270
struct razor_package;
ali@452
   271
struct razor_property;
ali@452
   272
ali@452
   273
#define RAZOR_HEADER_VERSION		2	/* Current version */
ali@452
   274
#define RAZOR_HEADER_VERSION_MIN	1	/* Minimum version we support */
ali@452
   275
ali@452
   276
/**
ali@452
   277
 * razor_set_create:
ali@452
   278
 * 
ali@452
   279
 * Create a new #razor_set object.
ali@452
   280
 * 
ali@452
   281
 * Returns: the new #razor_set object.
ali@452
   282
 **/
ali@452
   283
struct razor_set *razor_set_create_without_root(void);
ali@452
   284
struct razor_set *razor_set_create(void);
ali@452
   285
struct razor_set *
ali@475
   286
razor_set_open(const char *uri, enum razor_set_flags flags,
ali@452
   287
	       struct razor_error **error);
ali@452
   288
uint32_t razor_set_get_header_version(struct razor_set *set);
ali@452
   289
int razor_set_set_header_version(struct razor_set *set,
ali@452
   290
				 uint32_t header_version);
ali@452
   291
void razor_set_unref(struct razor_set *set);
ali@452
   292
struct razor_set *razor_set_ref(struct razor_set *set);
ali@452
   293
void razor_set_write_to_handle(struct razor_set *set,
ali@452
   294
			       struct razor_atomic *atomic, int handle,
ali@452
   295
			       uint32_t section_mask);
ali@452
   296
int razor_set_write(struct razor_set *set, struct razor_atomic *atomic,
ali@475
   297
		    const char *uri, uint32_t setions);
ali@452
   298
int
ali@475
   299
razor_set_bind_sections(struct razor_set *set, const char *uri,
ali@452
   300
			enum razor_set_flags flags, struct razor_error **error);
ali@452
   301
ali@452
   302
void
ali@452
   303
razor_package_get_details(struct razor_set *set,
ali@452
   304
			  struct razor_package *package, ...);
ali@452
   305
int
ali@452
   306
razor_package_remove(struct razor_set *prev, struct razor_set *next,
ali@452
   307
		     struct razor_atomic *atomic, struct razor_package *package,
ali@479
   308
		     const char *root_uri, int install_count,
ali@452
   309
		     enum razor_stage_type stage);
ali@452
   310
ali@452
   311
/**
ali@452
   312
 * SECTION:iterator
ali@452
   313
 * @title: Iterators
ali@452
   314
 * @short_description: Objects for traversing packages or properties.
ali@452
   315
 *
ali@452
   316
 * The razor iterator objects provides a way to iterate through a set
ali@452
   317
 * of packages or properties.
ali@452
   318
 **/
ali@452
   319
ali@452
   320
struct razor_package_iterator;
ali@452
   321
ali@452
   322
/**
ali@452
   323
 * razor_package_iterator_create:
ali@452
   324
 * 
ali@452
   325
 * Create a new #razor_package_iterator object.
ali@452
   326
 * 
ali@452
   327
 * Returns: the new #razor_package_iterator object.
ali@452
   328
 **/
ali@452
   329
ali@452
   330
struct razor_package_iterator *
ali@452
   331
razor_package_iterator_create(struct razor_set *set);
ali@452
   332
ali@452
   333
/**
ali@452
   334
 * razor_package_iterator_create_for_property:
ali@452
   335
 * 
ali@452
   336
 * Create a new #razor_package_iterator object for the packages that
ali@452
   337
 * own the given property.
ali@452
   338
 * 
ali@452
   339
 * Returns: the new #razor_package_iterator object.
ali@452
   340
 **/
ali@452
   341
struct razor_package_iterator *
ali@452
   342
razor_package_iterator_create_for_property(struct razor_set *set,
ali@452
   343
					   struct razor_property *property);
ali@452
   344
ali@452
   345
/**
ali@452
   346
 * razor_package_iterator_create_for_file:
ali@452
   347
 *
ali@452
   348
 * Create a new #razor_package_iterator object for the packages that
ali@452
   349
 * contain the given file name.
ali@452
   350
 *
ali@452
   351
 * Returns: the new #razor_package_iterator object.
ali@452
   352
 **/
ali@452
   353
struct razor_package_iterator *
ali@452
   354
razor_package_iterator_create_for_file(struct razor_set *set,
ali@452
   355
				       const char *filename);
ali@452
   356
ali@452
   357
int razor_package_iterator_next(struct razor_package_iterator *pi,
ali@452
   358
				struct razor_package **package, ...);
ali@452
   359
void razor_package_iterator_destroy(struct razor_package_iterator *pi);
ali@452
   360
ali@452
   361
struct razor_package_query *
ali@452
   362
razor_package_query_create(struct razor_set *set);
ali@452
   363
void
ali@452
   364
razor_package_query_add_package(struct razor_package_query *pq,
ali@452
   365
				struct razor_package *p);
ali@452
   366
void
ali@452
   367
razor_package_query_add_iterator(struct razor_package_query *pq,
ali@452
   368
				 struct razor_package_iterator *pi);
ali@452
   369
struct razor_package_iterator *
ali@452
   370
razor_package_query_finish(struct razor_package_query *pq);
ali@452
   371
ali@452
   372
struct razor_property_iterator;
ali@452
   373
struct razor_property_iterator *
ali@452
   374
razor_property_iterator_create(struct razor_set *set,
ali@452
   375
			       struct razor_package *package);
ali@452
   376
int razor_property_iterator_next(struct razor_property_iterator *pi,
ali@452
   377
				 struct razor_property **property,
ali@452
   378
				 const char **name,
ali@452
   379
				 uint32_t *flags,
ali@452
   380
				 const char **version);
ali@452
   381
void
ali@452
   382
razor_property_iterator_destroy(struct razor_property_iterator *pi);
ali@452
   383
ali@452
   384
struct razor_file_iterator;
ali@452
   385
struct razor_file_iterator *
ali@452
   386
razor_file_iterator_create(struct razor_set *set,
ali@452
   387
			   struct razor_package *package, int post_order);
ali@452
   388
int razor_file_iterator_next(struct razor_file_iterator *fi,
ali@452
   389
			     const char **name);
ali@452
   390
void razor_file_iterator_destroy(struct razor_file_iterator *fi);
ali@452
   391
ali@452
   392
void razor_set_list_files(struct razor_set *set, const char *prefix);
ali@452
   393
void razor_set_list_package_files(struct razor_set *set,
ali@452
   394
				  struct razor_package *package);
ali@452
   395
ali@462
   396
struct razor_string_iterator;
ali@462
   397
struct razor_string_iterator *
ali@462
   398
razor_install_prefix_iterator_create(struct razor_set *set,
ali@462
   399
				     struct razor_package *package);
ali@462
   400
int razor_string_iterator_next(struct razor_string_iterator *si,
ali@462
   401
			       const char **string);
ali@462
   402
void razor_string_iterator_destroy(struct razor_string_iterator *si);
ali@462
   403
ali@452
   404
enum razor_diff_action {
ali@452
   405
	RAZOR_DIFF_ACTION_ADD,
ali@452
   406
	RAZOR_DIFF_ACTION_REMOVE,
ali@452
   407
};
ali@452
   408
ali@452
   409
typedef void (*razor_diff_callback_t)(enum razor_diff_action action,
ali@452
   410
				      struct razor_package *package,
ali@452
   411
				      const char *name,
ali@452
   412
				      const char *version,
ali@452
   413
				      const char *arch,
ali@452
   414
				      void *data);
ali@452
   415
ali@452
   416
void
ali@452
   417
razor_set_diff(struct razor_set *set, struct razor_set *upstream,
ali@452
   418
	       razor_diff_callback_t callback, void *data);
ali@452
   419
ali@452
   420
struct razor_install_iterator;
ali@452
   421
ali@452
   422
enum razor_install_action {
ali@452
   423
	RAZOR_INSTALL_ACTION_ADD,
ali@452
   424
	RAZOR_INSTALL_ACTION_REMOVE,
ali@452
   425
	RAZOR_INSTALL_ACTION_COMMIT
ali@452
   426
};
ali@452
   427
ali@452
   428
struct razor_install_iterator *
ali@452
   429
razor_set_create_install_iterator(struct razor_set *set,
ali@452
   430
				  struct razor_set *next);
ali@452
   431
ali@452
   432
int razor_install_iterator_next(struct razor_install_iterator *ii,
ali@452
   433
				struct razor_package **package,
ali@452
   434
				enum razor_install_action *action,
ali@452
   435
				int *count);
ali@452
   436
ali@452
   437
/**
ali@452
   438
 * razor_install_iterator_commit_set
ali@452
   439
 *
ali@452
   440
 * Immediately after razor_install_iterator_next() returns
ali@452
   441
 * RAZOR_INSTALL_ACTION_COMMIT, this function will return the razor_set
ali@452
   442
 * which should be committed.
ali@452
   443
 *
ali@452
   444
 * Returns: a new #razor_set object.
ali@452
   445
 **/
ali@452
   446
struct razor_set *
ali@452
   447
razor_install_iterator_commit_set(struct razor_install_iterator *ii);
ali@452
   448
ali@452
   449
void razor_install_iterator_rewind(struct razor_install_iterator *ii);
ali@452
   450
size_t razor_install_iterator_tell(struct razor_install_iterator *ii);
ali@452
   451
size_t razor_install_iterator_seek(struct razor_install_iterator *ii,
ali@452
   452
				   size_t pos);
ali@452
   453
void razor_install_iterator_destroy(struct razor_install_iterator *ii);
ali@452
   454
ali@452
   455
/**
ali@452
   456
 * SECTION:transaction
ali@452
   457
 * @title: Transaction
ali@452
   458
 * @short_description: Create a new package set by merging two or more sets.
ali@452
   459
 *
ali@452
   460
 * The razor transaction object provides a way to create a new package set
ali@452
   461
 * from packages from one or more other package sets.
ali@452
   462
 **/
ali@452
   463
ali@452
   464
struct razor_rpm;
ali@452
   465
ali@452
   466
struct razor_transaction *
ali@452
   467
razor_transaction_create(struct razor_set *system, struct razor_set *upstream);
ali@452
   468
void razor_transaction_install_package(struct razor_transaction *transaction,
ali@452
   469
				       struct razor_package *package);
ali@452
   470
void razor_transaction_remove_package(struct razor_transaction *transaction,
ali@452
   471
				      struct razor_package *package);
ali@452
   472
void razor_transaction_update_package(struct razor_transaction *trans,
ali@452
   473
				      struct razor_package *package);
ali@452
   474
void razor_transaction_fixup_package(struct razor_transaction *trans,
ali@452
   475
				     struct razor_package *package,
ali@452
   476
				     struct razor_rpm *rpm);
ali@452
   477
void razor_transaction_update_all(struct razor_transaction *transaction);
ali@452
   478
int razor_transaction_resolve(struct razor_transaction *trans);
ali@452
   479
ali@452
   480
typedef void (*razor_unsatisfied_callback_t)(const char *requirement,
ali@452
   481
					     struct razor_package *package,
ali@452
   482
					     const char *name,
ali@452
   483
					     const char *version,
ali@452
   484
					     const char *arch,
ali@452
   485
					     void *data);
ali@452
   486
ali@452
   487
int razor_transaction_unsatisfied(struct razor_transaction *trans,
ali@452
   488
				  razor_unsatisfied_callback_t callback,
ali@452
   489
				  void *data);
ali@452
   490
int razor_transaction_describe(struct razor_transaction *trans);
ali@452
   491
struct razor_set *razor_transaction_commit(struct razor_transaction *trans);
ali@452
   492
void razor_transaction_destroy(struct razor_transaction *trans);
ali@452
   493
ali@452
   494
/* Temporary helper for test suite. */
ali@452
   495
int razor_transaction_unsatisfied_property(struct razor_transaction *trans,
ali@452
   496
					   const char *name,
ali@452
   497
					   uint32_t flags,
ali@452
   498
					   const char *version);
ali@452
   499
ali@452
   500
/**
ali@452
   501
 * SECTION:rpm
ali@452
   502
 * @title: Razor RPM
ali@452
   503
 * @short_description: Operating on RPM files.
ali@452
   504
 *
ali@452
   505
 * Functions for open RPM files and extracting information and
ali@452
   506
 * installing or removing RPM files.
ali@452
   507
 **/
ali@452
   508
ali@452
   509
struct razor_relocations;
ali@452
   510
ali@452
   511
struct razor_relocations *razor_relocations_create(void);
ali@452
   512
void razor_relocations_add(struct razor_relocations *relocations,
ali@452
   513
			   const char *oldpath, const char *newpath);
ali@452
   514
void razor_relocations_set_rpm(struct razor_relocations *relocations,
ali@452
   515
			       struct razor_rpm *rpm);
ali@452
   516
const char *razor_relocations_apply(struct razor_relocations *relocations,
ali@452
   517
				    const char *path);
ali@452
   518
void razor_relocations_destroy(struct razor_relocations *relocations);
ali@452
   519
ali@475
   520
struct razor_rpm *razor_rpm_open(const char *uri, struct razor_error **error);
ali@452
   521
void razor_rpm_get_details(struct razor_rpm *rpm, ...);
ali@452
   522
void razor_rpm_set_relocations(struct razor_rpm *rpm,
ali@452
   523
			       struct razor_relocations *relocations);
ali@452
   524
int razor_rpm_install(struct razor_rpm *rpm, struct razor_atomic *atomic,
ali@475
   525
		      const char *root_uri, int install_count,
ali@452
   526
		      enum razor_stage_type stage);
ali@452
   527
int razor_rpm_close(struct razor_rpm *rpm);
ali@452
   528
ali@452
   529
/**
ali@452
   530
 * SECTION:importer
ali@452
   531
 * @title: Importer
ali@452
   532
 * @short_description: A mechanism for building #razor_set objects
ali@452
   533
 *
ali@452
   534
 * The %razor_importer is a helper object for building a razor set
ali@452
   535
 * from external sources, like yum metadata, the RPM database or RPM
ali@452
   536
 * files.
ali@452
   537
 *
ali@452
   538
 * The importer is a stateful object; it has the notion of a current
ali@452
   539
 * package, and the caller can provide meta data such as properties,
ali@452
   540
 * files and similiar for the package as it becomes available.  Once a
ali@452
   541
 * package is fully described, the next pacakge can begin.  When all
ali@452
   542
 * packages have been described to the importer, the importer will
ali@452
   543
 * create a new %razor_set with the specified packages.
ali@452
   544
 *
ali@452
   545
 * A typical use
ali@452
   546
 * of the importer will follow this template:
ali@452
   547
 * |[
ali@452
   548
 * importer = razor_importer_create();
ali@452
   549
 *
ali@452
   550
 * while ( /<!-- -->* more packages to import *<!-- -->/; ) {
ali@452
   551
 *   /<!-- -->* get name, version and arch of next package *<!-- -->/
ali@452
   552
 *   razor_importer_begin_package(importer, name, version, arch);
ali@452
   553
 *   razor_importer_add_details(importer, summary, description, url, license);
ali@452
   554
 *
ali@452
   555
 *   while ( /<!-- -->* more properties to add *<!-- -->/ )
ali@452
   556
 *     razor_importer_add_property(importer, name, flags, version);
ali@452
   557
 *
ali@452
   558
 *   while ( /<!-- -->* [more files to add *<!-- -->/ )
ali@452
   559
 *     razor_importer_add_file(importer, name);
ali@452
   560
 *
ali@452
   561
 *   razor_importer_finish_package(importer);
ali@452
   562
 * }
ali@452
   563
 *
ali@452
   564
 * return razor_importer_finish(importer);
ali@452
   565
 * ]|
ali@452
   566
 **/
ali@452
   567
struct razor_importer;
ali@452
   568
ali@452
   569
struct razor_importer *razor_importer_create(void);
ali@452
   570
void razor_importer_destroy(struct razor_importer *importer);
ali@452
   571
void razor_importer_begin_package(struct razor_importer *importer,
ali@452
   572
				  const char *name,
ali@452
   573
				  const char *version,
ali@452
   574
				  const char *arch);
ali@452
   575
void razor_importer_add_details(struct razor_importer *importer,
ali@452
   576
				const char *summary,
ali@452
   577
				const char *description,
ali@452
   578
				const char *url,
ali@452
   579
				const char *license);
ali@452
   580
void razor_importer_add_script(struct razor_importer *importer,
ali@452
   581
			       enum razor_property_flags script,
ali@452
   582
			       const char *program,
ali@452
   583
			       const char *body);
ali@452
   584
void razor_importer_add_install_prefix(struct razor_importer *importer,
ali@452
   585
				       const char *install_prefix);
ali@452
   586
void razor_importer_add_property(struct razor_importer *importer,
ali@452
   587
				 const char *name,
ali@452
   588
				 uint32_t flags,
ali@452
   589
				 const char *version);
ali@452
   590
void razor_importer_add_file(struct razor_importer *importer,
ali@452
   591
			     const char *name);
ali@452
   592
void razor_importer_finish_package(struct razor_importer *importer);
ali@452
   593
ali@452
   594
int razor_importer_add_rpm(struct razor_importer *importer,
ali@452
   595
			   struct razor_rpm *rpm);
ali@452
   596
ali@452
   597
struct razor_set *razor_importer_finish(struct razor_importer *importer);
ali@452
   598
ali@452
   599
/**
ali@452
   600
 * SECTION:root
ali@452
   601
 * @title: Root
ali@452
   602
 * @short_description: Functions for accessing an install root.
ali@452
   603
 *
ali@452
   604
 * The #razor_root object encapsulate access to and locking of a razor
ali@452
   605
 * install root.
ali@452
   606
 **/
ali@452
   607
struct razor_root;
ali@452
   608
ali@475
   609
const char *razor_get_database_uri(void);
ali@475
   610
void razor_set_database_uri(const char *database_uri);
ali@475
   611
int razor_root_create(const char *root_uri, struct razor_error **error);
ali@452
   612
struct razor_root *
ali@475
   613
razor_root_open(const char *root_uri, struct razor_error **error);
ali@452
   614
struct razor_set *
ali@475
   615
razor_root_open_read_only(const char *root_uri, struct razor_error **error);
ali@452
   616
struct razor_set *razor_root_get_system_set(struct razor_root *root);
ali@452
   617
int razor_root_close(struct razor_root *root);
ali@452
   618
int
ali@452
   619
razor_root_update(struct razor_root *root, struct razor_set *next,
ali@452
   620
		  struct razor_atomic *atomic);
ali@452
   621
ali@452
   622
/**
ali@475
   623
 * SECTION:uri-io
ali@475
   624
 * @title: URI Input/Output
ali@475
   625
 * @short_description: Functions to support non-file URI handlers
ali@475
   626
 *
ali@475
   627
 * Libraries that want to support URIs other than file URIs (which razor
ali@475
   628
 * handles internally), can install their own URI handlers. Unsupported
ali@475
   629
 * virtual functions should be set to %NULL. A fallback URI handler (which
ali@475
   630
 * will be used if no scheme-specific handler is found) can be installed
ali@475
   631
 * by passing scheme as %NULL. Finally, URI handlers can be removed by
ali@475
   632
 * passing vtable as %NULL.
ali@475
   633
 **/
ali@475
   634
ali@475
   635
struct razor_uri_vtable {
ali@475
   636
	unsigned structure_size;
ali@475
   637
	int (*mkdir)(const char *path, mode_t mode, struct razor_error **error);
ali@475
   638
	int (*unlink)(const char *path, struct razor_error **error);
ali@475
   639
	int (*open)(const char *path, int flags, mode_t mode,
ali@475
   640
		    struct razor_error **error);
ali@475
   641
	int (*move)(const char *path, const char *dest,
ali@475
   642
		    struct razor_error **error);
ali@475
   643
	void *(*get_contents)(const char *path, size_t *length, int _private,
ali@475
   644
			      struct razor_error **error);
ali@475
   645
	int (*free_contents)(void *addr, size_t length);
ali@475
   646
	int (*is_directory)(const char *path, struct razor_error **error);
ali@475
   647
	char *(*mkdtemp_near)(const char *path, const char *_template,
ali@475
   648
			      struct razor_error **error);
ali@475
   649
	void *(*opendir)(const char *path, struct razor_error **error);
ali@475
   650
	char *(*readdir)(void *dir, struct razor_error **error);
ali@475
   651
	int (*closedir)(void *dir, struct razor_error **error);
ali@475
   652
};
ali@475
   653
ali@476
   654
int razor_uri_mkdir(const char *uri, mode_t mode, struct razor_error **error);
ali@476
   655
int razor_uri_unlink(const char *uri, struct razor_error **error);
ali@476
   656
int razor_uri_open(const char *uri, int flags, mode_t mode,
ali@476
   657
		   struct razor_error **error);
ali@476
   658
int razor_uri_move(const char *uri, const char *dest,
ali@476
   659
		   struct razor_error **error);
ali@476
   660
int razor_uri_is_directory(const char *uri, struct razor_error **error);
ali@476
   661
char *razor_uri_mkdtemp_near(const char *uri, const char *_template,
ali@476
   662
			     struct razor_error **error) RAZOR_MALLOC;
ali@476
   663
void *razor_uri_opendir(const char *uri, struct razor_error **error);
ali@476
   664
char *razor_uri_readdir(void *dir, struct razor_error **error) RAZOR_MALLOC;
ali@476
   665
int razor_uri_closedir(void *dir, struct razor_error **error);
ali@476
   666
void *razor_uri_get_contents(const char *uri, size_t *length, int _private,
ali@476
   667
			     struct razor_error **error);
ali@476
   668
int razor_uri_free_contents(void *addr, size_t length);
ali@476
   669
ali@475
   670
int razor_uri_set_vtable(const char *scheme, struct razor_uri_vtable *vtable,
ali@475
   671
			 struct razor_error **error);
ali@475
   672
ali@475
   673
/**
ali@452
   674
 * SECTION:misc
ali@452
   675
 * @title: Miscellaneous Functions
ali@452
   676
 * @short_description: Various helper functions
ali@452
   677
 *
ali@452
   678
 * Functions that doesn't fit anywhere else.
ali@452
   679
 **/
ali@452
   680
ali@452
   681
const char *
ali@452
   682
razor_property_relation_to_string(struct razor_property *p);
ali@452
   683
const char *
ali@452
   684
razor_property_type_to_string(struct razor_property *p);
ali@452
   685
ali@452
   686
void razor_build_evr(char *evr_buf, int size, const char *epoch,
ali@452
   687
		     const char *version, const char *release);
ali@452
   688
int razor_versioncmp(const char *s1, const char *s2);
ali@452
   689
ali@452
   690
void razor_disable_root_name_checks(int disable);
ali@452
   691
ali@452
   692
void razor_set_lua_loader(const char *modname, void (*loader)());
ali@452
   693
void (*razor_get_lua_loader(const char *modname))();
ali@452
   694
ali@452
   695
char *razor_concat(const char *s, ...) RAZOR_MALLOC RAZOR_NULL_TERMINATED;
ali@452
   696
ali@475
   697
char *razor_path_from_uri(const char *uri, struct razor_error **error)
ali@475
   698
      RAZOR_MALLOC;
ali@475
   699
char *razor_path_to_uri(const char *path) RAZOR_MALLOC;
ali@476
   700
char *razor_path_relative_to_uri(const char *uri, const char *path,
ali@475
   701
				 struct razor_error **error) RAZOR_MALLOC;
ali@452
   702
ali@477
   703
/* According to RFC 3986 § 5.2 */
ali@477
   704
char *razor_resolve_relative_uri(const char *base_uri, const char *relative_uri,
ali@477
   705
				 struct razor_error **error);
ali@477
   706
ali@452
   707
const char *razor_system_arch(void);
ali@452
   708
ali@475
   709
int razor_dump_database(FILE *fp, const char *root_uri, const char *filename,
ali@457
   710
			struct razor_error **error);
ali@457
   711
ali@452
   712
#endif /* _RAZOR_H_ */