razor.h
author James Bowes <jbowes@redhat.com>
Sun Jun 15 18:16:20 2008 -0400 (2008-06-15)
changeset 229 cae6308aa5b1
parent 225 c51f49f38d18
permissions -rw-r--r--
WIP patch for seperate files for filelists and package details
krh@212
     1
/*
krh@212
     2
 * Copyright (C) 2008  Kristian Høgsberg <krh@redhat.com>
krh@212
     3
 * Copyright (C) 2008  Red Hat, Inc
krh@212
     4
 *
krh@212
     5
 * This program is free software; you can redistribute it and/or modify
krh@212
     6
 * it under the terms of the GNU General Public License as published by
krh@212
     7
 * the Free Software Foundation; either version 2 of the License, or
krh@212
     8
 * (at your option) any later version.
krh@212
     9
 *
krh@212
    10
 * This program is distributed in the hope that it will be useful,
krh@212
    11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
krh@212
    12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
krh@212
    13
 * GNU General Public License for more details.
krh@212
    14
 *
krh@212
    15
 * You should have received a copy of the GNU General Public License along
krh@212
    16
 * with this program; if not, write to the Free Software Foundation, Inc.,
krh@212
    17
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
krh@212
    18
 */
krh@212
    19
krh@27
    20
#ifndef _RAZOR_H_
krh@27
    21
#define _RAZOR_H_
krh@27
    22
krh@43
    23
#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
krh@43
    24
krh@43
    25
struct razor_set;
krh@92
    26
struct razor_package;
krh@92
    27
struct razor_property;
krh@43
    28
jbowes@229
    29
enum razor_repo_file_type {
jbowes@229
    30
	RAZOR_REPO_FILE_MAIN,
jbowes@229
    31
	RAZOR_REPO_FILE_DETAILS,
jbowes@229
    32
	RAZOR_REPO_FILE_FILES
jbowes@229
    33
};
jbowes@229
    34
krh@66
    35
enum razor_property_type {
krh@66
    36
	RAZOR_PROPERTY_REQUIRES,
krh@66
    37
	RAZOR_PROPERTY_PROVIDES,
krh@66
    38
	RAZOR_PROPERTY_CONFLICTS,
krh@66
    39
	RAZOR_PROPERTY_OBSOLETES
krh@66
    40
};
krh@66
    41
danw@109
    42
enum razor_version_relation {
danw@109
    43
	RAZOR_VERSION_LESS,
danw@109
    44
	RAZOR_VERSION_LESS_OR_EQUAL,
danw@109
    45
	RAZOR_VERSION_EQUAL,
danw@109
    46
	RAZOR_VERSION_GREATER_OR_EQUAL,
danw@109
    47
	RAZOR_VERSION_GREATER
danw@109
    48
};
danw@137
    49
extern const char * const razor_version_relations[];
danw@109
    50
krh@91
    51
struct razor_set *razor_set_create(void);
krh@43
    52
struct razor_set *razor_set_open(const char *filename);
krh@43
    53
void razor_set_destroy(struct razor_set *set);
jbowes@229
    54
int razor_set_write_to_fd(struct razor_set *set, int fd,
jbowes@229
    55
			  enum razor_repo_file_type type);
jbowes@229
    56
int razor_set_write(struct razor_set *set, const char *filename,
jbowes@229
    57
		    enum razor_repo_file_type type);
jbowes@229
    58
jbowes@229
    59
void razor_set_open_details(struct razor_set *set, const char *filename);
jbowes@229
    60
void razor_set_open_files(struct razor_set *set, const char *filename);
krh@43
    61
krh@92
    62
struct razor_package *
krh@92
    63
razor_set_get_package(struct razor_set *set, const char *package);
krh@92
    64
jbowes@225
    65
void
jbowes@225
    66
razor_package_get_details(struct razor_set *set, struct razor_package *package,
jbowes@225
    67
			  const char **summary, const char **description,
jbowes@225
    68
			  const char **url, const char **license);
jbowes@224
    69
krh@92
    70
struct razor_package_iterator;
krh@92
    71
struct razor_package_iterator *
krh@92
    72
razor_package_iterator_create(struct razor_set *set);
krh@101
    73
struct razor_package_iterator *
krh@101
    74
razor_package_iterator_create_for_property(struct razor_set *set,
krh@101
    75
					   struct razor_property *property);
krh@102
    76
struct razor_package_iterator *
krh@102
    77
razor_package_iterator_create_for_file(struct razor_set *set,
krh@102
    78
				       const char *filename);
krh@92
    79
krh@92
    80
int razor_package_iterator_next(struct razor_package_iterator *pi,
krh@92
    81
				struct razor_package **package,
krh@192
    82
				const char **name,
krh@192
    83
				const char **version,
krh@192
    84
				const char **arch);
krh@92
    85
void razor_package_iterator_destroy(struct razor_package_iterator *pi);
krh@92
    86
krh@216
    87
struct razor_package_query *
krh@216
    88
razor_package_query_create(struct razor_set *set);
krh@216
    89
void
krh@216
    90
razor_package_query_add_package(struct razor_package_query *pq,
krh@216
    91
				struct razor_package *p);
krh@216
    92
void
krh@216
    93
razor_package_query_add_iterator(struct razor_package_query *pq,
krh@216
    94
				 struct razor_package_iterator *pi);
krh@216
    95
struct razor_package_iterator *
krh@216
    96
razor_package_query_finish(struct razor_package_query *pq);
krh@216
    97
krh@92
    98
struct razor_property_iterator;
krh@92
    99
struct razor_property_iterator *
krh@92
   100
razor_property_iterator_create(struct razor_set *set,
krh@92
   101
			       struct razor_package *package);
krh@92
   102
int razor_property_iterator_next(struct razor_property_iterator *pi,
krh@92
   103
				 struct razor_property **property,
danw@109
   104
				 const char **name,
danw@109
   105
				 enum razor_version_relation *relation,
danw@109
   106
				 const char **version,
krh@92
   107
				 enum razor_property_type *type);
krh@92
   108
void
krh@92
   109
razor_property_iterator_destroy(struct razor_property_iterator *pi);
krh@92
   110
krh@49
   111
void razor_set_list_files(struct razor_set *set, const char *prefix);
krh@56
   112
void razor_set_list_package_files(struct razor_set *set, const char *name);
krh@43
   113
krh@43
   114
void razor_set_list_unsatisfied(struct razor_set *set);
krh@43
   115
krh@44
   116
typedef void (*razor_package_callback_t)(const char *name,
krh@44
   117
					 const char *old_version,
krh@44
   118
					 const char *new_version,
krh@192
   119
					 const char *arch,
krh@44
   120
					 void *data);
krh@44
   121
void
krh@44
   122
razor_set_diff(struct razor_set *set, struct razor_set *upstream,
krh@44
   123
	       razor_package_callback_t callback, void *data);
krh@44
   124
danw@137
   125
/* Package transactions */
danw@137
   126
danw@137
   127
enum razor_transaction_package_state {
danw@137
   128
	/* Basic states */
danw@145
   129
	RAZOR_PACKAGE_INSTALL,
danw@154
   130
	RAZOR_PACKAGE_FORCED_UPDATE,
danw@145
   131
	RAZOR_PACKAGE_REMOVE,
danw@154
   132
	RAZOR_PACKAGE_OBSOLETED,
danw@137
   133
danw@137
   134
	/* Error states */
danw@145
   135
danw@169
   136
	RAZOR_PACKAGE_FIRST_ERROR_STATE = 0x4,
danw@169
   137
	RAZOR_PACKAGE_UNAVAILABLE_FLAG = 0x4,
danw@169
   138
danw@145
   139
	/* Package requested for install does not exist */
danw@169
   140
	RAZOR_PACKAGE_INSTALL_UNAVAILABLE = RAZOR_PACKAGE_INSTALL | RAZOR_PACKAGE_UNAVAILABLE_FLAG,
danw@169
   141
	/* Package requiring update does not have any update */
danw@169
   142
	RAZOR_PACKAGE_UPDATE_UNAVAILABLE = RAZOR_PACKAGE_FORCED_UPDATE | RAZOR_PACKAGE_UNAVAILABLE_FLAG,
danw@145
   143
	/* Package requested for removal does not exist */
danw@169
   144
	RAZOR_PACKAGE_REMOVE_NOT_INSTALLED = RAZOR_PACKAGE_REMOVE | RAZOR_PACKAGE_UNAVAILABLE_FLAG,
danw@169
   145
	/* (not used) */
danw@169
   146
	RAZOR_PACKAGE_OBSOLETE_UNAVAILABLE = RAZOR_PACKAGE_OBSOLETED | RAZOR_PACKAGE_UNAVAILABLE_FLAG,
danw@169
   147
danw@145
   148
	/* No newer version of package is available */
danw@145
   149
	RAZOR_PACKAGE_UP_TO_DATE,
danw@145
   150
	/* Package marked for both install and remove */
danw@145
   151
	RAZOR_PACKAGE_CONTRADICTION,
danw@145
   152
	/* Package would add a conflict with an already-installed package */
danw@145
   153
	RAZOR_PACKAGE_NEW_CONFLICT,
danw@145
   154
	/* Already-installed package has a conflict against this package */
danw@145
   155
	RAZOR_PACKAGE_OLD_CONFLICT,
danw@145
   156
	/* Requirement of to-be-installed package can't be satisfied */
danw@154
   157
	RAZOR_PACKAGE_UNSATISFIABLE,
danw@137
   158
};
danw@137
   159
danw@137
   160
struct razor_transaction *
krh@208
   161
razor_transaction_create(struct razor_set *system, struct razor_set *upstream);
krh@208
   162
void razor_transaction_install_package(struct razor_transaction *transaction,
krh@208
   163
				       struct razor_package *package);
krh@208
   164
void razor_transaction_remove_package(struct razor_transaction *transaction,
krh@208
   165
				      struct razor_package *package);
krh@208
   166
void razor_transaction_update_all(struct razor_transaction *transaction);
krh@210
   167
int razor_transaction_resolve(struct razor_transaction *trans);
krh@196
   168
struct razor_set *razor_transaction_finish(struct razor_transaction *trans);
danw@137
   169
void razor_transaction_destroy(struct razor_transaction *trans);
krh@44
   170
krh@190
   171
/* Temporary helper for test suite. */
krh@190
   172
int razor_transaction_unsatisfied_property(struct razor_transaction *trans,
krh@190
   173
					   const char *name,
krh@190
   174
					   enum razor_version_relation rel,
krh@190
   175
					   const char *version);
krh@190
   176
krh@44
   177
/* Importer interface; for building a razor set from external sources,
krh@44
   178
 * like yum, rpmdb or razor package files. */
krh@44
   179
krh@30
   180
struct razor_importer;
krh@77
   181
struct razor_rpm;
krh@27
   182
krh@30
   183
struct razor_importer *razor_importer_new(void);
krh@75
   184
void razor_importer_destroy(struct razor_importer *importer);
krh@30
   185
void razor_importer_begin_package(struct razor_importer *importer,
krh@192
   186
				  const char *name,
krh@192
   187
				  const char *version,
krh@192
   188
				  const char *arch);
jbowes@224
   189
void razor_importer_add_details(struct razor_importer *importer,
jbowes@224
   190
				const char *summary,
jbowes@225
   191
				const char *description,
jbowes@225
   192
				const char *url,
jbowes@225
   193
				const char *license);
krh@66
   194
void razor_importer_add_property(struct razor_importer *importer,
danw@109
   195
				 const char *name,
danw@109
   196
				 enum razor_version_relation relation,
danw@109
   197
				 const char *version,
krh@66
   198
				 enum razor_property_type type);
krh@46
   199
void razor_importer_add_file(struct razor_importer *importer,
krh@46
   200
			     const char *name);
krh@30
   201
void razor_importer_finish_package(struct razor_importer *importer);
krh@75
   202
krh@75
   203
int razor_importer_add_rpm(struct razor_importer *importer,
krh@77
   204
			   struct razor_rpm *rpm);
krh@75
   205
krh@30
   206
struct razor_set *razor_importer_finish(struct razor_importer *importer);
krh@27
   207
danw@143
   208
void razor_build_evr(char *evr_buf, int size, const char *epoch,
danw@143
   209
		     const char *version, const char *release);
danw@143
   210
krh@70
   211
struct razor_set *razor_set_create_from_yum(void);
krh@28
   212
struct razor_set *razor_set_create_from_rpmdb(void);
krh@27
   213
krh@74
   214
/* RPM functions */
krh@77
   215
krh@77
   216
struct razor_rpm *razor_rpm_open(const char *filename);
krh@77
   217
int razor_rpm_install(struct razor_rpm *rpm, const char *root);
krh@77
   218
int razor_rpm_close(struct razor_rpm *rpm);
krh@74
   219
krh@27
   220
#endif /* _RAZOR_H_ */