1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
/* createrepo_c - Library of routines for manipulation with repodata
* Copyright (C) 2013 Tomas Mlcoch
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*/
#ifndef __C_CREATEREPOLIB_CREATEREPO_SHARED_H__
#define __C_CREATEREPOLIB_CREATEREPO_SHARED_H__
#ifdef __cplusplus
extern "C" {
#endif
#include <glib.h>
#include "checksum.h"
#include "compression_wrapper.h"
#include "package.h"
/** \defgroup createrepo_shared Createrepo API.
*
* Module with createrepo API
*
* \addtogroup createrepo_shared
* @{
*/
/**
* This function does:
* Sets a signal handler for signals that lead to process temination.
* (List obtained from the "man 7 signal")
* Signals that are ignored (SIGCHILD) or lead just to stop (SIGSTOP, ...)
* don't get this handler - these signals do not terminate the process!
* This handler assures that the cleanup function that is hooked on exit
* gets called.
*
* @param lock_dir Dir that serves as lock (".repodata/")
* @param tmp_out_repo Dir that is really used for repodata generation
* (usually exactly the same as lock dir if not
* --ignore-lock is specified). Could be NULL.
* @return TRUE on success, FALSE if err is set.
*/
gboolean
cr_set_cleanup_handler(const char *lock_dir,
const char *tmp_out_repo,
GError **err);
/**
* Block process terminating signals.
* (Useful for creating pseudo-atomic sections in code)
*/
gboolean
cr_block_terminating_signals(GError **err);
/**
* Unblock process terminating signals.
*/
gboolean
cr_unblock_terminating_signals(GError **err);
/**
* This function does:
* - Tries to create repo/.repodata/ dir.
* - If it doesn't exists, it's created and function returns TRUE.
* - If it exists and ignore_lock is FALSE, returns FALSE and err is set.
* - If it exists and ignore_lock is TRUE it:
* - Removes the existing .repodata/ dir and all its content
* - Creates (empty) new one (just as a lock dir - place holder)
* - Creates .repodata.pid.datetime.usec/ that should be used for
* repodata generation
*
* @param repo_dir Path to repo (a dir that contains repodata/ subdir)
* @param ignore_lock Ignore existing .repodata/ dir - remove it and
* create a new one.
* @param lock_dir Location to store path to a directory used as
* a lock. Always repodir+"/.repodata/".
* Even if FALSE is returned, the content of this
* variable IS DEFINED.
* @param tmp_repodata_dir Location to store a path to a directory used as
* a temporary directory for repodata generation.
* If ignore_lock is FALSE than
* lock_dir is same as tmp_repodata_dir.
* If FALSE is returned, the content of this variable
* is undefined.
* @param err GError **
* @return TRUE on success, FALSE if err is set.
*/
gboolean
cr_lock_repo(const gchar *repo_dir,
gboolean ignore_lock,
gchar **lock_dir,
gchar **tmp_repodata_dir,
GError **err);
/**
* Unset cleanup handler.
* @param err GError **
* @return TRUE on success, FALSE if err is set.
*/
gboolean
cr_unset_cleanup_handler(GError **err);
/**
* Setup logging for the application.
*/
void
cr_setup_logging(gboolean quiet, gboolean verbose);
/**
* Set global pointer to exit value that is used in function set by atexit
* @param exit_val Pointer to exit_value int
*/
void
cr_set_global_exit_value(int *exit_val);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* __C_CREATEREPOLIB_CREATEREPO_SHARED__ */
|
