createrepo_c library  0.17.7
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 
147 char *cr_get_cleaned_href(const char *filepath);
148 
157 int cr_download(CURL *handle,
158  const char *url,
159  const char *destination,
160  GError **err);
161 
168 gboolean cr_copy_file(const char *src,
169  const char *dst,
170  GError **err);
171 
183 #define cr_compress_file(SRC, DST, COMTYPE, ZCK_DICT_DIR, ZCK_AUTO_CHUNK, ERR) \
184  cr_compress_file_with_stat(SRC, DST, COMTYPE, NULL, ZCK_DICT_DIR, \
185  ZCK_AUTO_CHUNK, ERR)
186 
199 #define cr_compress_file_v2(SRC, DST, COMTYPE, ZCK_DICT_DIR, ZCK_AUTO_CHUNK, ERR) \
200  cr_compress_file_with_stat_v2(SRC, DST, COMTYPE, NULL, ZCK_DICT_DIR, \
201  ZCK_AUTO_CHUNK, ERR)
202 
214 int cr_compress_file_with_stat(const char *src,
215  char **dst,
216  cr_CompressionType comtype,
217  cr_ContentStat *stat,
218  const char *zck_dict_dir,
219  gboolean zck_auto_chunk,
220  GError **err);
221 
237 int cr_compress_file_with_stat_v2(const char *src,
238  const char *dst,
239  cr_CompressionType comtype,
240  cr_ContentStat *stat,
241  const char *zck_dict_dir,
242  gboolean zck_auto_chunk,
243  GError **err);
244 
255 #define cr_decompress_file(SRC, DST, COMTYPE, ERR) \
256  cr_decompress_file_with_stat(SRC, DST, COMTYPE, NULL, ERR)
257 
269 int cr_decompress_file_with_stat(const char *src,
270  const char *dst,
271  cr_CompressionType comtype,
272  cr_ContentStat *stat,
273  GError **err);
274 
281 gboolean cr_better_copy_file(const char *src,
282  const char *dst,
283  GError **err);
284 
290 int cr_remove_dir(const char *path, GError **err);
291 
296 char *cr_normalize_dir_path(const char *path);
297 
302 struct cr_Version cr_str_to_version(const char *str);
303 
310 int cr_cmp_version_str(const char* str1, const char *str2);
311 
318 void cr_null_log_fn(const gchar *log_domain,
319  GLogLevelFlags log_level,
320  const gchar *message,
321  gpointer user_data);
322 
329 void cr_log_fn(const gchar *log_domain,
330  GLogLevelFlags log_level,
331  const gchar *message,
332  gpointer user_data);
333 
341 void cr_slist_free_full(GSList *list, GDestroyNotify free_f);
342 
350 void cr_queue_free_full(GQueue *queue, GDestroyNotify free_f);
351 
361 cr_NEVRA *cr_split_rpm_filename(const char *filename);
362 
368 #define cr_cmp_nevra(A, B) (cr_cmp_evr((A)->epoch, (A)->version, (A)->release,\
369  (B)->epoch, (B)->version, (B)->release))
370 
380 int cr_cmp_evr(const char *e1, const char *v1, const char *r1,
381  const char *e2, const char *v2, const char *r2);
382 
383 
389 static inline gchar *
390 cr_safe_string_chunk_insert(GStringChunk *chunk, const char *str)
391 {
392  if (!str) return NULL;
393  return g_string_chunk_insert(chunk, str);
394 }
395 
401 static inline gchar *
402 cr_safe_string_chunk_insert_and_free(GStringChunk *chunk, char *str)
403 {
404  if (!str) return NULL;
405  gchar *copy = g_string_chunk_insert(chunk, str);
406  g_free(str);
407  return copy;
408 }
409 
416 static inline gchar *
417 cr_safe_string_chunk_insert_null(GStringChunk *chunk, const char *str)
418 {
419  if (!str || *str == '\0') return NULL;
420  return g_string_chunk_insert(chunk, str);
421 }
422 
423 
429 static inline gchar *
430 cr_safe_string_chunk_insert_const(GStringChunk *chunk, const char *str)
431 {
432  if (!str) return NULL;
433  return g_string_chunk_insert_const(chunk, str);
434 }
435 
436 static inline gboolean
437 cr_key_file_get_boolean_default(GKeyFile *key_file,
438  const gchar *group_name,
439  const gchar *key,
440  gboolean default_value,
441  GError **error)
442 {
443  GError *tmp_err = NULL;
444  gboolean ret = g_key_file_get_boolean(key_file, group_name, key, &tmp_err);
445  if (tmp_err) {
446  g_propagate_error(error, tmp_err);
447  return default_value;
448  }
449  return ret;
450 }
451 
457 int
459  char *msg,
460  void *cbdata,
461  GError **err);
462 
469 gboolean
470 cr_write_to_file(GError **err, gchar *filename, const char *format, ...);
471 
472 typedef enum {
473  CR_CP_DEFAULT = (1<<0),
475  CR_CP_RECURSIVE = (1<<1),
479 } cr_CpFlags;
480 
488 gboolean
489 cr_cp(const char *src,
490  const char *dst,
491  cr_CpFlags flags,
492  const char *working_directory,
493  GError **err);
494 
495 typedef enum {
496  CR_RM_DEFAULT = (1<<0),
498  CR_RM_RECURSIVE = (1<<1),
500  CR_RM_FORCE = (1<<2),
502 } cr_RmFlags;
503 
510 gboolean
511 cr_rm(const char *path,
512  cr_RmFlags flags,
513  const char *working_dir,
514  GError **err);
515 
521 gchar *
522 cr_append_pid_and_datetime(const char *str, const char *suffix);
523 
532 gboolean
533 cr_spawn_check_exit_status(gint exit_status, GError **error);
534 
539 cr_NEVR *
540 cr_str_to_nevr(const char *str);
541 
545 void
546 cr_nevr_free(cr_NEVR *nevr);
547 
552 cr_NEVRA *
553 cr_str_to_nevra(const char *str);
554 
558 void
559 cr_nevra_free(cr_NEVRA *nevra);
560 
572 gboolean
573 cr_identical_files(const gchar *fn1,
574  const gchar *fn2,
575  gboolean *identical,
576  GError **err);
577 
581 gchar *
582 cr_cut_dirs(gchar *path, gint cut_dirs);
583 
587 const gchar *
589 
603 gchar *
604 cr_get_dict_file(const gchar *dir,
605  const gchar *file);
606 
609 #ifdef __cplusplus
610 }
611 #endif
612 
613 #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:495
char * cr_get_cleaned_href(const char *filepath)
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:472
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)
int cr_compress_file_with_stat_v2(const char *src, const char *dst, cr_CompressionType comtype, cr_ContentStat *stat, const char *zck_dict_dir, gboolean zck_auto_chunk, GError **err)
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)