librazor/razor.h
author James Bowes <jbowes@redhat.com>
Fri Jun 20 19:04:47 2008 -0400 (2008-06-20)
changeset 258 29d5002bd17f
parent 248 057933050c42
child 259 5b0601d184ed
permissions -rw-r--r--
Merge branch 'krh/master'

Conflicts:

librazor/razor.h
librazor/rpm.c
razor.c
src/main.c
     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_repo_file_type {
    30 	RAZOR_REPO_FILE_MAIN,
    31 	RAZOR_REPO_FILE_DETAILS,
    32 	RAZOR_REPO_FILE_FILES
    33 };
    34 
    35 enum razor_property_flags {
    36 	RAZOR_PROPERTY_LESS		= 1 << 0,
    37 	RAZOR_PROPERTY_GREATER		= 1 << 1,
    38 	RAZOR_PROPERTY_EQUAL		= 1 << 2,
    39 	RAZOR_PROPERTY_RELATION_MASK	=
    40 		RAZOR_PROPERTY_LESS |
    41 		RAZOR_PROPERTY_GREATER |
    42 		RAZOR_PROPERTY_EQUAL,
    43 
    44 	RAZOR_PROPERTY_REQUIRES		= 0 << 3,
    45 	RAZOR_PROPERTY_PROVIDES		= 1 << 3,
    46 	RAZOR_PROPERTY_CONFLICTS	= 2 << 3,
    47 	RAZOR_PROPERTY_OBSOLETES	= 3 << 3,
    48 	RAZOR_PROPERTY_TYPE_MASK	= 3 << 3,
    49 		
    50 	RAZOR_PROPERTY_PRE		= 1 << 5,
    51 	RAZOR_PROPERTY_POST		= 1 << 6,
    52 	RAZOR_PROPERTY_PREUN		= 1 << 7,
    53 	RAZOR_PROPERTY_POSTUN		= 1 << 8
    54 };
    55 
    56 const char *
    57 razor_property_relation_to_string(struct razor_property *p);
    58 const char *
    59 razor_property_type_to_string(struct razor_property *p);
    60 
    61 struct razor_set *razor_set_create(void);
    62 struct razor_set *razor_set_open(const char *filename);
    63 void razor_set_destroy(struct razor_set *set);
    64 int razor_set_write_to_fd(struct razor_set *set, int fd,
    65 			  enum razor_repo_file_type type);
    66 int razor_set_write(struct razor_set *set, const char *filename,
    67 		    enum razor_repo_file_type type);
    68 
    69 void razor_set_open_details(struct razor_set *set, const char *filename);
    70 void razor_set_open_files(struct razor_set *set, const char *filename);
    71 
    72 struct razor_package *
    73 razor_set_get_package(struct razor_set *set, const char *package);
    74 
    75 void
    76 razor_package_get_details(struct razor_set *set, struct razor_package *package,
    77 			  const char **summary, const char **description,
    78 			  const char **url, const char **license);
    79 
    80 struct razor_package_iterator;
    81 struct razor_package_iterator *
    82 razor_package_iterator_create(struct razor_set *set);
    83 struct razor_package_iterator *
    84 razor_package_iterator_create_for_property(struct razor_set *set,
    85 					   struct razor_property *property);
    86 struct razor_package_iterator *
    87 razor_package_iterator_create_for_file(struct razor_set *set,
    88 				       const char *filename);
    89 
    90 int razor_package_iterator_next(struct razor_package_iterator *pi,
    91 				struct razor_package **package,
    92 				const char **name,
    93 				const char **version,
    94 				const char **arch);
    95 void razor_package_iterator_destroy(struct razor_package_iterator *pi);
    96 
    97 struct razor_package_query *
    98 razor_package_query_create(struct razor_set *set);
    99 void
   100 razor_package_query_add_package(struct razor_package_query *pq,
   101 				struct razor_package *p);
   102 void
   103 razor_package_query_add_iterator(struct razor_package_query *pq,
   104 				 struct razor_package_iterator *pi);
   105 struct razor_package_iterator *
   106 razor_package_query_finish(struct razor_package_query *pq);
   107 
   108 struct razor_property_iterator;
   109 struct razor_property_iterator *
   110 razor_property_iterator_create(struct razor_set *set,
   111 			       struct razor_package *package);
   112 int razor_property_iterator_next(struct razor_property_iterator *pi,
   113 				 struct razor_property **property,
   114 				 const char **name,
   115 				 uint32_t *flags,
   116 				 const char **version);
   117 void
   118 razor_property_iterator_destroy(struct razor_property_iterator *pi);
   119 
   120 void razor_set_list_files(struct razor_set *set, const char *prefix);
   121 void razor_set_list_package_files(struct razor_set *set, const char *name);
   122 
   123 void razor_set_list_unsatisfied(struct razor_set *set);
   124 
   125 typedef void (*razor_package_callback_t)(const char *name,
   126 					 const char *old_version,
   127 					 const char *new_version,
   128 					 const char *arch,
   129 					 void *data);
   130 void
   131 razor_set_diff(struct razor_set *set, struct razor_set *upstream,
   132 	       razor_package_callback_t callback, void *data);
   133 
   134 /* Package transactions */
   135 
   136 struct razor_transaction *
   137 razor_transaction_create(struct razor_set *system, struct razor_set *upstream);
   138 void razor_transaction_install_package(struct razor_transaction *transaction,
   139 				       struct razor_package *package);
   140 void razor_transaction_remove_package(struct razor_transaction *transaction,
   141 				      struct razor_package *package);
   142 void razor_transaction_update_package(struct razor_transaction *trans,
   143 				      struct razor_package *package);
   144 void razor_transaction_update_all(struct razor_transaction *transaction);
   145 int razor_transaction_resolve(struct razor_transaction *trans);
   146 int razor_transaction_describe(struct razor_transaction *trans);
   147 struct razor_set *razor_transaction_finish(struct razor_transaction *trans);
   148 void razor_transaction_destroy(struct razor_transaction *trans);
   149 
   150 /* Temporary helper for test suite. */
   151 int razor_transaction_unsatisfied_property(struct razor_transaction *trans,
   152 					   const char *name,
   153 					   uint32_t flags,
   154 					   const char *version);
   155 
   156 /* Importer interface; for building a razor set from external sources,
   157  * like yum, rpmdb or razor package files. */
   158 
   159 struct razor_importer;
   160 struct razor_rpm;
   161 
   162 struct razor_importer *razor_importer_new(void);
   163 void razor_importer_destroy(struct razor_importer *importer);
   164 void razor_importer_begin_package(struct razor_importer *importer,
   165 				  const char *name,
   166 				  const char *version,
   167 				  const char *arch);
   168 void razor_importer_add_details(struct razor_importer *importer,
   169 				const char *summary,
   170 				const char *description,
   171 				const char *url,
   172 				const char *license);
   173 void razor_importer_add_property(struct razor_importer *importer,
   174 				 const char *name,
   175 				 uint32_t flags,
   176 				 const char *version);
   177 void razor_importer_add_file(struct razor_importer *importer,
   178 			     const char *name);
   179 void razor_importer_finish_package(struct razor_importer *importer);
   180 
   181 int razor_importer_add_rpm(struct razor_importer *importer,
   182 			   struct razor_rpm *rpm);
   183 
   184 struct razor_set *razor_importer_finish(struct razor_importer *importer);
   185 
   186 void razor_build_evr(char *evr_buf, int size, const char *epoch,
   187 		     const char *version, const char *release);
   188 int razor_versioncmp(const char *s1, const char *s2);
   189 
   190 struct razor_set *razor_set_create_from_yum(void);
   191 struct razor_set *razor_set_create_from_rpmdb(void);
   192 
   193 /* RPM functions */
   194 
   195 struct razor_rpm *razor_rpm_open(const char *filename);
   196 int razor_rpm_install(struct razor_rpm *rpm, const char *root);
   197 int razor_rpm_close(struct razor_rpm *rpm);
   198 
   199 
   200 /* Razor root functions. The root data struct encapsulates filesystem
   201  * conventions and the locking protocol. */
   202 
   203 struct razor_root;
   204 #define RAZOR_ROOT_OPEN_WRITE 0x01
   205 
   206 int razor_root_create(const char *root);
   207 struct razor_root *razor_root_open(const char *root, int flags);
   208 struct razor_set *razor_root_open_read_only(const char *root);
   209 struct razor_transaction *
   210 razor_root_create_transaction(struct razor_root *image,
   211 			      struct razor_set *upstream);
   212 int razor_root_close(struct razor_root *image);
   213 void razor_root_update(struct razor_root *image, struct razor_set *next);
   214 int razor_root_commit(struct razor_root *image);
   215 void razor_root_diff(struct razor_root *root,
   216 		     razor_package_callback_t callback, void *data);
   217 
   218 #endif /* _RAZOR_H_ */