createrepo_c library  0.15.1
C library for metadata manipulation
misc.h
1 /* createrepo_c - Library of routines for manipulation with repodata
2  * Copyright (C) 2012 Tomas Mlcoch
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
17  * USA.
18  */
19 
20 #ifndef __C_CREATEREPOLIB_MISC_H__
21 #define __C_CREATEREPOLIB_MISC_H__
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 #include <glib.h>
28 #include <string.h>
29 #include <curl/curl.h>
30 #include "compression_wrapper.h"
31 #include "xml_parser.h"
32 
40 #define CR_STATICSTRLEN(s) (sizeof(s)/sizeof(s[0]))
41 
42 /* Length of static defined array.
43  */
44 #define CR_ARRAYLEN(x) ((sizeof(x)/sizeof(0[x])) / ((size_t)(!(sizeof(x) % sizeof(0[x])))))
45 
50 const char *cr_flag_to_str(gint64 flags);
51 
54 typedef struct {
55  char *epoch;
56  char *version;
57  char *release;
58 } cr_EVR;
59 
60 typedef struct {
61  char *name;
62  char *epoch;
63  char *version;
64  char *release;
65 } cr_NEVR;
66 
67 typedef struct {
68  char *name;
69  char *epoch;
70  char *version;
71  char *release;
72  char *arch;
73 } cr_NEVRA;
74 
78 struct cr_Version {
79  long major;
80  long minor;
81  long patch;
82  char *suffix;
83 };
84 
85 
94 cr_EVR *cr_str_to_evr(const char *string, GStringChunk *chunk);
95 
102 void
103 cr_evr_free(cr_EVR *evr);
104 
110 static inline int cr_is_primary(const char *filename) {
111  if (!strncmp(filename, "/etc/", 5))
112  return 1;
113  if (!strcmp(filename, "/usr/lib/sendmail"))
114  return 1;
115  if (strstr(filename, "bin/"))
116  return 1;
117  return 0;
118 };
119 
123  unsigned int start;
124  unsigned int end;
125 };
126 
132 struct cr_HeaderRangeStruct cr_get_header_byte_range(const char *filename,
133  GError **err);
134 
140 char *cr_get_filename(const char *filepath);
141 
150 int cr_download(CURL *handle,
151  const char *url,
152  const char *destination,
153  GError **err);
154 
161 gboolean cr_copy_file(const char *src,
162  const char *dst,
163  GError **err);
164 
176 #define cr_compress_file(SRC, DST, COMTYPE, ZCK_DICT_DIR, ZCK_AUTO_CHUNK, ERR) \
177  cr_compress_file_with_stat(SRC, DST, COMTYPE, NULL, ZCK_DICT_DIR, \
178  ZCK_AUTO_CHUNK, ERR)
179 
192 int cr_compress_file_with_stat(const char *src,
193  char **dst,
194  cr_CompressionType comtype,
195  cr_ContentStat *stat,
196  const char *zck_dict_dir,
197  gboolean zck_auto_chunk,
198  GError **err);
199 
210 #define cr_decompress_file(SRC, DST, COMTYPE, ERR) \
211  cr_decompress_file_with_stat(SRC, DST, COMTYPE, NULL, ERR)
212 
224 int cr_decompress_file_with_stat(const char *src,
225  const char *dst,
226  cr_CompressionType comtype,
227  cr_ContentStat *stat,
228  GError **err);
229 
236 gboolean cr_better_copy_file(const char *src,
237  const char *dst,
238  GError **err);
239 
245 int cr_remove_dir(const char *path, GError **err);
246 
251 char *cr_normalize_dir_path(const char *path);
252 
257 struct cr_Version cr_str_to_version(const char *str);
258 
265 int cr_cmp_version_str(const char* str1, const char *str2);
266 
273 void cr_null_log_fn(const gchar *log_domain,
274  GLogLevelFlags log_level,
275  const gchar *message,
276  gpointer user_data);
277 
284 void cr_log_fn(const gchar *log_domain,
285  GLogLevelFlags log_level,
286  const gchar *message,
287  gpointer user_data);
288 
296 void cr_slist_free_full(GSList *list, GDestroyNotify free_f);
297 
305 void cr_queue_free_full(GQueue *queue, GDestroyNotify free_f);
306 
316 cr_NEVRA *cr_split_rpm_filename(const char *filename);
317 
323 #define cr_cmp_nevra(A, B) (cr_cmp_evr((A)->epoch, (A)->version, (A)->release,\
324  (B)->epoch, (B)->version, (B)->release))
325 
335 int cr_cmp_evr(const char *e1, const char *v1, const char *r1,
336  const char *e2, const char *v2, const char *r2);
337 
338 
344 static inline gchar *
345 cr_safe_string_chunk_insert(GStringChunk *chunk, const char *str)
346 {
347  if (!str) return NULL;
348  return g_string_chunk_insert(chunk, str);
349 }
350 
356 static inline gchar *
357 cr_safe_string_chunk_insert_and_free(GStringChunk *chunk, char *str)
358 {
359  if (!str) return NULL;
360  gchar *copy = g_string_chunk_insert(chunk, str);
361  g_free(str);
362  return copy;
363 }
364 
371 static inline gchar *
372 cr_safe_string_chunk_insert_null(GStringChunk *chunk, const char *str)
373 {
374  if (!str || *str == '\0') return NULL;
375  return g_string_chunk_insert(chunk, str);
376 }
377 
378 
384 static inline gchar *
385 cr_safe_string_chunk_insert_const(GStringChunk *chunk, const char *str)
386 {
387  if (!str) return NULL;
388  return g_string_chunk_insert_const(chunk, str);
389 }
390 
391 static inline gboolean
392 cr_key_file_get_boolean_default(GKeyFile *key_file,
393  const gchar *group_name,
394  const gchar *key,
395  gboolean default_value,
396  GError **error)
397 {
398  GError *tmp_err = NULL;
399  gboolean ret = g_key_file_get_boolean(key_file, group_name, key, &tmp_err);
400  if (tmp_err) {
401  g_propagate_error(error, tmp_err);
402  return default_value;
403  }
404  return ret;
405 }
406 
412 int
414  char *msg,
415  void *cbdata,
416  GError **err);
417 
424 gboolean
425 cr_write_to_file(GError **err, gchar *filename, const char *format, ...);
426 
427 typedef enum {
428  CR_CP_DEFAULT = (1<<0),
430  CR_CP_RECURSIVE = (1<<1),
434 } cr_CpFlags;
435 
443 gboolean
444 cr_cp(const char *src,
445  const char *dst,
446  cr_CpFlags flags,
447  const char *working_directory,
448  GError **err);
449 
450 typedef enum {
451  CR_RM_DEFAULT = (1<<0),
453  CR_RM_RECURSIVE = (1<<1),
455  CR_RM_FORCE = (1<<2),
457 } cr_RmFlags;
458 
465 gboolean
466 cr_rm(const char *path,
467  cr_RmFlags flags,
468  const char *working_dir,
469  GError **err);
470 
476 gchar *
477 cr_append_pid_and_datetime(const char *str, const char *suffix);
478 
487 gboolean
488 cr_spawn_check_exit_status(gint exit_status, GError **error);
489 
494 cr_NEVR *
495 cr_str_to_nevr(const char *str);
496 
500 void
501 cr_nevr_free(cr_NEVR *nevr);
502 
507 cr_NEVRA *
508 cr_str_to_nevra(const char *str);
509 
513 void
514 cr_nevra_free(cr_NEVRA *nevra);
515 
527 gboolean
528 cr_identical_files(const gchar *fn1,
529  const gchar *fn2,
530  gboolean *identical,
531  GError **err);
532 
536 gchar *
537 cr_cut_dirs(gchar *path, gint cut_dirs);
538 
542 const gchar *
544 
558 gchar *
559 cr_get_dict_file(const gchar *dir,
560  const gchar *file);
561 
564 #ifdef __cplusplus
565 }
566 #endif
567 
568 #endif /* __C_CREATEREPOLIB_MISC_H__ */
gchar * cr_append_pid_and_datetime(const char *str, const char *suffix)
cr_NEVRA * cr_str_to_nevra(const char *str)
unsigned int end
Definition: misc.h:124
char * cr_normalize_dir_path(const char *path)
gboolean cr_copy_file(const char *src, const char *dst, GError **err)
cr_CompressionType
void cr_nevra_free(cr_NEVRA *nevra)
int cr_cmp_evr(const char *e1, const char *v1, const char *r1, const char *e2, const char *v2, const char *r2)
int cr_warning_cb(cr_XmlParserWarningType type, char *msg, void *cbdata, GError **err)
const gchar * cr_version_string_with_features(void)
struct cr_HeaderRangeStruct cr_get_header_byte_range(const char *filename, GError **err)
cr_RmFlags
Definition: misc.h:450
unsigned int start
Definition: misc.h:123
cr_EVR * cr_str_to_evr(const char *string, GStringChunk *chunk)
cr_XmlParserWarningType
Definition: xml_parser.h:42
struct cr_Version cr_str_to_version(const char *str)
Definition: misc.h:60
Definition: misc.h:67
void cr_null_log_fn(const gchar *log_domain, GLogLevelFlags log_level, const gchar *message, gpointer user_data)
void cr_queue_free_full(GQueue *queue, GDestroyNotify free_f)
long patch
Definition: misc.h:81
int cr_cmp_version_str(const char *str1, const char *str2)
char * suffix
Definition: misc.h:82
void cr_evr_free(cr_EVR *evr)
gboolean cr_rm(const char *path, cr_RmFlags flags, const char *working_dir, GError **err)
void cr_log_fn(const gchar *log_domain, GLogLevelFlags log_level, const gchar *message, gpointer user_data)
cr_NEVRA * cr_split_rpm_filename(const char *filename)
gboolean cr_better_copy_file(const char *src, const char *dst, GError **err)
gboolean cr_cp(const char *src, const char *dst, cr_CpFlags flags, const char *working_directory, GError **err)
gboolean cr_spawn_check_exit_status(gint exit_status, GError **error)
char * release
Definition: misc.h:57
int cr_compress_file_with_stat(const char *src, char **dst, cr_CompressionType comtype, cr_ContentStat *stat, const char *zck_dict_dir, gboolean zck_auto_chunk, GError **err)
gchar * cr_cut_dirs(gchar *path, gint cut_dirs)
cr_CpFlags
Definition: misc.h:427
char * version
Definition: misc.h:56
char * cr_get_filename(const char *filepath)
gboolean cr_write_to_file(GError **err, gchar *filename, const char *format,...)
int cr_remove_dir(const char *path, GError **err)
gchar * cr_get_dict_file(const gchar *dir, const gchar *file)
const char * cr_flag_to_str(gint64 flags)
cr_NEVR * cr_str_to_nevr(const char *str)
char * epoch
Definition: misc.h:55
long minor
Definition: misc.h:80
Definition: misc.h:54
long major
Definition: misc.h:79
int cr_decompress_file_with_stat(const char *src, const char *dst, cr_CompressionType comtype, cr_ContentStat *stat, GError **err)
int cr_download(CURL *handle, const char *url, const char *destination, GError **err)
gboolean cr_identical_files(const gchar *fn1, const gchar *fn2, gboolean *identical, GError **err)
void cr_nevr_free(cr_NEVR *nevr)
void cr_slist_free_full(GSList *list, GDestroyNotify free_f)