createrepo_c library  0.9.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 
174 #define cr_compress_file(SRC, DST, COMTYPE, ERR) \
175  cr_compress_file_with_stat(SRC, DST, COMTYPE, NULL, ERR)
176 
187 int cr_compress_file_with_stat(const char *src,
188  const char *dst,
189  cr_CompressionType comtype,
190  cr_ContentStat *stat,
191  GError **err);
192 
203 #define cr_decompress_file(SRC, DST, COMTYPE, ERR) \
204  cr_decompress_file_with_stat(SRC, DST, COMTYPE, NULL, ERR)
205 
217 int cr_decompress_file_with_stat(const char *src,
218  const char *dst,
219  cr_CompressionType comtype,
220  cr_ContentStat *stat,
221  GError **err);
222 
229 gboolean cr_better_copy_file(const char *src,
230  const char *dst,
231  GError **err);
232 
238 int cr_remove_dir(const char *path, GError **err);
239 
244 char *cr_normalize_dir_path(const char *path);
245 
250 struct cr_Version cr_str_to_version(const char *str);
251 
258 int cr_cmp_version_str(const char* str1, const char *str2);
259 
266 void cr_null_log_fn(const gchar *log_domain,
267  GLogLevelFlags log_level,
268  const gchar *message,
269  gpointer user_data);
270 
277 void cr_log_fn(const gchar *log_domain,
278  GLogLevelFlags log_level,
279  const gchar *message,
280  gpointer user_data);
281 
289 void cr_slist_free_full(GSList *list, GDestroyNotify free_f);
290 
298 void cr_queue_free_full(GQueue *queue, GDestroyNotify free_f);
299 
309 cr_NEVRA *cr_split_rpm_filename(const char *filename);
310 
316 #define cr_cmp_nevra(A, B) (cr_cmp_evr((A)->epoch, (A)->version, (A)->release,\
317  (B)->epoch, (B)->version, (B)->release))
318 
328 int cr_cmp_evr(const char *e1, const char *v1, const char *r1,
329  const char *e2, const char *v2, const char *r2);
330 
331 
337 static inline gchar *
338 cr_safe_string_chunk_insert(GStringChunk *chunk, const char *str)
339 {
340  if (!str) return NULL;
341  return g_string_chunk_insert(chunk, str);
342 }
343 
349 static inline gchar *
350 cr_safe_string_chunk_insert_and_free(GStringChunk *chunk, char *str)
351 {
352  if (!str) return NULL;
353  gchar *copy = g_string_chunk_insert(chunk, str);
354  g_free(str);
355  return copy;
356 }
357 
364 static inline gchar *
365 cr_safe_string_chunk_insert_null(GStringChunk *chunk, const char *str)
366 {
367  if (!str || *str == '\0') return NULL;
368  return g_string_chunk_insert(chunk, str);
369 }
370 
371 
377 static inline gchar *
378 cr_safe_string_chunk_insert_const(GStringChunk *chunk, const char *str)
379 {
380  if (!str) return NULL;
381  return g_string_chunk_insert_const(chunk, str);
382 }
383 
384 static inline gboolean
385 cr_key_file_get_boolean_default(GKeyFile *key_file,
386  const gchar *group_name,
387  const gchar *key,
388  gboolean default_value,
389  GError **error)
390 {
391  GError *tmp_err = NULL;
392  gboolean ret = g_key_file_get_boolean(key_file, group_name, key, &tmp_err);
393  if (tmp_err) {
394  g_propagate_error(error, tmp_err);
395  return default_value;
396  }
397  return ret;
398 }
399 
405 int
407  char *msg,
408  void *cbdata,
409  GError **err);
410 
417 gboolean
418 cr_write_to_file(GError **err, gchar *filename, const char *format, ...);
419 
420 typedef enum {
421  CR_CP_DEFAULT = (1<<0),
423  CR_CP_RECURSIVE = (1<<1),
427 } cr_CpFlags;
428 
436 gboolean
437 cr_cp(const char *src,
438  const char *dst,
439  cr_CpFlags flags,
440  const char *working_directory,
441  GError **err);
442 
443 typedef enum {
444  CR_RM_DEFAULT = (1<<0),
446  CR_RM_RECURSIVE = (1<<1),
448  CR_RM_FORCE = (1<<2),
450 } cr_RmFlags;
451 
458 gboolean
459 cr_rm(const char *path,
460  cr_RmFlags flags,
461  const char *working_dir,
462  GError **err);
463 
469 gchar *
470 cr_append_pid_and_datetime(const char *str, const char *suffix);
471 
480 gboolean
481 cr_spawn_check_exit_status(gint exit_status, GError **error);
482 
487 cr_NEVR *
488 cr_str_to_nevr(const char *str);
489 
493 void
494 cr_nevr_free(cr_NEVR *nevr);
495 
500 cr_NEVRA *
501 cr_str_to_nevra(const char *str);
502 
506 void
507 cr_nevra_free(cr_NEVRA *nevra);
508 
520 gboolean
521 cr_identical_files(const gchar *fn1,
522  const gchar *fn2,
523  gboolean *identical,
524  GError **err);
525 
529 gchar *
530 cr_cut_dirs(gchar *path, gint cut_dirs);
531 
534 #ifdef __cplusplus
535 }
536 #endif
537 
538 #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)
struct cr_HeaderRangeStruct cr_get_header_byte_range(const char *filename, GError **err)
cr_RmFlags
Definition: misc.h:443
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
gchar * cr_cut_dirs(gchar *path, gint cut_dirs)
int cr_compress_file_with_stat(const char *src, const char *dst, cr_CompressionType comtype, cr_ContentStat *stat, GError **err)
cr_CpFlags
Definition: misc.h:420
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)
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)