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
|
(* virt-v2v
* Copyright (C) 2009-2023 Red Hat Inc.
*
* 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.
*)
(* Poor man's XML DOM, mutable for ease of modification. *)
open Std_utils
open Tools_utils
open Printf
type node =
| PCData of string
| Comment of string
| Element of element
and element = {
e_name : string; (* Name of element. *)
mutable e_attrs : attr list; (* Attributes. *)
mutable e_children : node list; (* Child elements. *)
}
and attr = string * string
and doc = Doc of element
let doc name attrs children =
Doc { e_name = name; e_attrs = attrs; e_children = children }
let e name attrs children =
Element { e_name = name; e_attrs = attrs; e_children = children }
(* This outputs nicely formatted and indented XML, ie. with lots of
* whitespace. As far as I know this is safe for the kind of documents
* we will be writing, ie. libvirt XML and OVF metadata, where
* whitespace is generally not significant, but readability is useful.
*)
let rec node_to_buf ?(indent = 0) buf = function
| PCData str ->
Buffer.add_string buf (xml_quote_pcdata str)
| Comment str ->
buffer_add_spaces buf indent;
bprintf buf "<!-- %s -->" (xml_quote_pcdata str)
| Element e ->
element_to_buf ~indent buf e
and element_to_buf ?(indent = 0) buf
{ e_name = name; e_attrs = attrs; e_children = children } =
buffer_add_spaces buf indent;
bprintf buf "<%s" name;
List.iter (fun (n, v) -> bprintf buf " %s='%s'" n (xml_quote_attr v)) attrs;
if children <> [] then (
Buffer.add_string buf ">";
let last_child_was_element = ref false in
List.iter (
function
| Element _ as child ->
last_child_was_element := true;
Buffer.add_char buf '\n';
node_to_buf ~indent:(indent+2) buf child;
| PCData _ as child ->
last_child_was_element := false;
node_to_buf ~indent:(indent+2) buf child;
| Comment _ as child ->
last_child_was_element := true;
Buffer.add_char buf '\n';
node_to_buf ~indent:(indent+2) buf child;
) children;
if !last_child_was_element then (
Buffer.add_char buf '\n';
buffer_add_spaces buf indent
);
bprintf buf "</%s>" name
) else (
Buffer.add_string buf "/>"
)
and buffer_add_spaces buf n =
Buffer.add_string buf (String.spaces n)
(* Quote XML <element attr='...'> content. Note you must use single
* quotes around the attribute.
*)
and xml_quote_attr str =
let str = String.replace str "&" "&" in
let str = String.replace str "'" "'" in
let str = String.replace str "<" "<" in
let str = String.replace str ">" ">" in
str
and xml_quote_pcdata str =
let str = String.replace str "&" "&" in
let str = String.replace str "<" "<" in
let str = String.replace str ">" ">" in
str
let doc_to_buf buf (Doc doc) =
bprintf buf "<?xml version='1.0' encoding='utf-8'?>\n";
element_to_buf buf doc;
bprintf buf "\n"
let doc_to_string doc =
let buf = Buffer.create 4096 in
doc_to_buf buf doc;
Buffer.contents buf
let doc_to_chan chan doc =
let buf = Buffer.create 4096 in
doc_to_buf buf doc;
Buffer.output_buffer chan buf
let path_to_nodes (Doc doc) path =
match path with
| [] -> invalid_arg "path_to_nodes: empty path"
| top_name :: path ->
if doc.e_name <> top_name then []
else (
let rec loop nodes path =
match path with
| [] -> []
| [p] ->
List.filter (
function
| PCData _ -> false
| Comment _ -> false
| Element e when e.e_name = p -> true
| Element _ -> false
) nodes
| p :: ps ->
let children =
List.filter_map (
function
| PCData _ -> None
| Comment _ -> None
| Element e when e.e_name = p -> Some e.e_children
| Element _ -> None
) nodes in
List.concat (List.map (fun nodes -> loop nodes ps) children)
in
loop doc.e_children path
)
let filter_node_list_by_attr nodes attr =
List.filter (
function
| Element { e_attrs = attrs } when List.mem attr attrs -> true
| Element _ | PCData _ | Comment _ -> false
) nodes
let find_node_by_attr nodes attr =
match filter_node_list_by_attr nodes attr with
| [] -> raise Not_found
| x::_ -> x
let append_attr attr = function
| PCData _ | Comment _ -> invalid_arg "append_attr"
| Element e -> e.e_attrs <- e.e_attrs @ [attr]
let append_child child = function
| PCData _ | Comment _ -> invalid_arg "append_child"
| Element e -> e.e_children <- e.e_children @ [child]
|
