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