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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
/*
Copyright 2024 Northern.tech AS
This file is part of CFEngine 3 - written and maintained by Northern.tech AS.
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; version 3.
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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
To the extent this program is licensed as part of the Enterprise
versions of CFEngine, the applicable Commercial Open Source License
(COSL) may apply to this file if you as a licensee so wish it. See
included file COSL.txt.
*/
#include <files_edit.h>
#include <actuator.h>
#include <eval_context.h>
#include <files_names.h>
#include <files_interfaces.h>
#include <files_operators.h>
#include <files_lib.h>
#include <files_editxml.h>
#include <item_lib.h>
#include <policy.h>
/*****************************************************************************/
EditContext *NewEditContext(char *filename, const Attributes *a)
{
assert(a != NULL);
EditContext *ec;
if (!IsAbsoluteFileName(filename))
{
Log(LOG_LEVEL_ERR, "Relative file name '%s' was marked for editing but has no invariant meaning", filename);
return NULL;
}
ec = xcalloc(1, sizeof(EditContext));
ec->filename = filename;
/* If making changes in chroot, we need to load the file from the chroot
* instead. */
if (ChrootChanges())
{
ec->changes_filename = xstrdup(ToChangesChroot(filename));
}
else
{
ec->changes_filename = xstrdup(filename);
}
ec->new_line_mode = FileNewLineMode(ec->changes_filename);
if (a->haveeditline)
{
if (!LoadFileAsItemList(&(ec->file_start), ec->changes_filename,
a->edits, a->edits.empty_before_use))
{
free(ec);
return NULL;
}
}
if (a->haveeditxml)
{
#ifdef HAVE_LIBXML2
if (!LoadFileAsXmlDoc(&(ec->xmldoc), ec->changes_filename,
a->edits, a->edits.empty_before_use))
{
free(ec);
return NULL;
}
#else
Log(LOG_LEVEL_ERR, "Cannot edit XML files without LIBXML2");
free(ec);
return NULL;
#endif
}
if (a->edits.empty_before_use)
{
Log(LOG_LEVEL_VERBOSE, "Build file model from a blank slate");
}
return ec;
}
/*****************************************************************************/
void FinishEditContext(EvalContext *ctx, EditContext *ec, const Attributes *a, const Promise *pp,
PromiseResult *result)
{
if ((*result != PROMISE_RESULT_NOOP) && (*result != PROMISE_RESULT_CHANGE))
{
// Failure or skipped. Don't update the file.
goto end;
}
/* If some edits are to be saved, but we are not making changes to
* files (dry-run), just log the fact (MakingChanges() does that). */
if ((ec != NULL) && (ec->num_edits > 0) &&
!CompareToFile(ctx, ec->file_start, ec->changes_filename, a, pp, result) &&
!MakingChanges(ctx, pp, a, result, "edit file '%s'", ec->filename))
{
goto end;
}
else if (ec && (ec->num_edits > 0))
{
if (a->haveeditline || a->edit_template || a->edit_template_string)
{
if (CompareToFile(ctx, ec->file_start, ec->changes_filename, a, pp, result))
{
RecordNoChange(ctx, pp, a, "No edit changes to file '%s' need saving",
ec->filename);
}
else if (SaveItemListAsFile(ec->file_start, ec->changes_filename, a, ec->new_line_mode))
{
RecordChange(ctx, pp, a, "Edited file '%s'", ec->filename);
*result = PromiseResultUpdate(*result, PROMISE_RESULT_CHANGE);
}
else
{
RecordFailure(ctx, pp, a, "Unable to save file '%s' after editing", ec->filename);
*result = PromiseResultUpdate(*result, PROMISE_RESULT_FAIL);
}
}
if (a->haveeditxml)
{
#ifdef HAVE_LIBXML2
if (XmlCompareToFile(ec->xmldoc, ec->changes_filename, a->edits))
{
if (ec)
{
RecordNoChange(ctx, pp, a, "No edit changes to xml file '%s' need saving",
ec->filename);
}
}
else if (SaveXmlDocAsFile(ec->xmldoc, ec->changes_filename, a, ec->new_line_mode))
{
RecordChange(ctx, pp, a, "Edited xml file '%s'", ec->filename);
*result = PromiseResultUpdate(*result, PROMISE_RESULT_CHANGE);
}
else
{
RecordFailure(ctx, pp, a, "Failed to edit XML file '%s'", ec->filename);
*result = PromiseResultUpdate(*result, PROMISE_RESULT_FAIL);
}
xmlFreeDoc(ec->xmldoc);
#else
RecordFailure(ctx, pp, a, "Cannot edit XML files without LIBXML2");
*result = PromiseResultUpdate(*result, PROMISE_RESULT_FAIL);
#endif
}
}
else if (ec)
{
RecordNoChange(ctx, pp, a, "No edit changes to file '%s' need saving", ec->filename);
}
end:
if (ec != NULL)
{
DeleteItemList(ec->file_start);
free(ec->changes_filename);
free(ec);
}
}
/*********************************************************************/
/* Level */
/*********************************************************************/
#ifdef HAVE_LIBXML2
/***************************************************************************/
bool LoadFileAsXmlDoc(xmlDocPtr *doc, const char *file, EditDefaults edits, bool only_checks)
{
assert (doc != NULL);
struct stat statbuf;
if (stat(file, &statbuf) == -1)
{
Log(LOG_LEVEL_ERR, "The proposed file '%s' could not be loaded. (stat: %s)", file, GetErrorStr());
return false;
}
if (edits.maxfilesize != 0 && statbuf.st_size > edits.maxfilesize)
{
Log(LOG_LEVEL_INFO, "File '%s' is bigger than the edit limit. max_file_size = '%jd' > '%d' bytes", file,
(intmax_t) statbuf.st_size, edits.maxfilesize);
return false;
}
if (!S_ISREG(statbuf.st_mode))
{
Log(LOG_LEVEL_INFO, "'%s' is not a plain file", file);
return false;
}
if (only_checks || (statbuf.st_size == 0))
{
/* Checks done and none of them failed and returned we can just return
* an empty doc here. */
if ((*doc = xmlNewDoc(BAD_CAST "1.0")) == NULL)
{
Log(LOG_LEVEL_INFO, "Document '%s' not parsed successfully. (xmlNewDoc: %s)", file, GetErrorStr());
return false;
}
return true;
}
*doc = xmlParseFile(file);
if (doc == NULL)
{
Log(LOG_LEVEL_INFO, "Document '%s' not parsed successfully. (xmlParseFile: %s)", file, GetErrorStr());
return false;
}
return true;
}
/*********************************************************************/
static bool SaveXmlCallback(const char *dest_filename, void *param,
ARG_UNUSED NewLineMode new_line_mode)
{
xmlDocPtr doc = param;
//saving xml to file
if (xmlSaveFile(dest_filename, doc) == -1)
{
Log(LOG_LEVEL_ERR, "Failed to write xml document to file '%s' after editing. (xmlSaveFile: %s)", dest_filename, GetErrorStr());
return false;
}
return true;
}
/*********************************************************************/
bool SaveXmlDocAsFile(xmlDocPtr doc, const char *file, const Attributes *a, NewLineMode new_line_mode)
{
return SaveAsFile(&SaveXmlCallback, doc, file, a, new_line_mode);
}
#endif /* HAVE_LIBXML2 */
|
