1 /* vim:tw=78:ts=8:sw=4:set ft=c: */
3 Copyright (C) 2006-2008 Ben Kibbey <bjk@luxsci.net>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
35 #include "pwmd_error.h"
39 void log_write(const gchar
*fmt
, ...);
40 static xmlNodePtr
find_element(xmlNodePtr node
, gchar
*element
, xmlNodePtr stop
);
41 static xmlChar
*node_has_attribute(xmlNodePtr n
, xmlChar
*attr
);
44 * 'element' must be allocated.
46 gboolean
is_literal_element(gchar
**element
)
50 if (!element
|| !*element
)
53 if (*(*element
) == '!') {
56 for (p
= *element
, c
= p
+1; *c
; c
++)
67 * Fails if 'element' begins with punctuation or digit or contains whitespace.
69 * I'm not sure about using g_unichar_isspace() rather than isspace()?
71 gboolean
valid_xml_element(xmlChar
*element
)
75 gchar
*p
= (gchar
*)element
;
77 if (!element
|| !*element
)
83 len
= g_utf8_strlen(p
, -1) - 1;
84 c
= g_utf8_get_char(p
++);
86 if (g_unichar_ispunct(c
) == TRUE
|| g_unichar_isdigit(c
) == TRUE
)
90 c
= g_utf8_get_char(p
++);
92 if (g_unichar_isspace(c
))
99 gboolean
valid_element_path(gchar
**path
, gboolean has_value
)
103 for (p
= path
; *p
; p
++) {
105 * An empty element is valid and don't check the syntax of the
108 if (has_value
== TRUE
&& (!*(p
+1) || !*p
[0]))
111 if (valid_xml_element((xmlChar
*)*p
) == FALSE
)
118 gpg_error_t
new_account(xmlDocPtr doc
, gchar
*name
)
120 xmlNodePtr root
= xmlDocGetRootElement(doc
);
126 return EPWMD_LIBXML_ERROR
;
131 n
= xmlNewNode(NULL
, (xmlChar
*)"account");
132 n
= xmlAddChild(root
, n
);
133 a
= xmlNewProp(n
, (xmlChar
*)"name", (xmlChar
*)p
);
137 xmlChar
*new_document()
140 const xmlChar
*line
= (xmlChar
*)
141 "<?xml version=\"1.0\"?>"
142 "<!DOCTYPE accounts ["
143 "<!ELEMENT accounts (account*)>"
144 "<!ATTLIST account name CDATA #REQUIRED>"
148 buf
= gcry_calloc(1, xmlStrlen(line
) + 1);
149 return buf
? xmlStrcat(buf
, line
) : NULL
;
153 * Lists root account element names. If there's a target attribute both
154 * literal and non-literal element names will be added.
156 gpg_error_t
list_accounts(xmlDocPtr doc
, GString
**result
)
164 n
= xmlDocGetRootElement(doc
);
166 if (!n
|| !n
->children
)
167 return EPWMD_EMPTY_ELEMENT
;
169 for (n
= n
->children
; n
; n
= n
->next
) {
171 xmlChar
*val
, *target
;
175 if (n
->type
!= XML_ELEMENT_NODE
)
178 a
= xmlHasProp(n
, (xmlChar
*)"name");
180 if (!a
|| !a
->children
->content
)
183 val
= xmlNodeGetContent(a
->children
);
186 rc
= gpg_error_from_errno(ENOMEM
);
190 tmp
= g_strdup_printf("!%s", (gchar
*)val
);
194 rc
= gpg_error_from_errno(ENOMEM
);
198 tlist
= g_slist_append(list
, tmp
);
202 rc
= gpg_error_from_errno(ENOMEM
);
207 target
= node_has_attribute(n
, (xmlChar
*)"target");
210 gchar
*t
= g_strdup((gchar
*)val
);
215 rc
= gpg_error_from_errno(ENOMEM
);
219 tlist
= g_slist_append(list
, t
);
224 rc
= gpg_error_from_errno(ENOMEM
);
235 total
= g_slist_length(list
);
238 return EPWMD_EMPTY_ELEMENT
;
240 string
= g_string_new(NULL
);
243 rc
= gpg_error_from_errno(ENOMEM
);
247 for (i
= 0; i
< total
; i
++) {
248 gchar
*val
= g_slist_nth_data(list
, i
);
250 g_string_append_printf(string
, "%s\n", val
);
253 string
= g_string_truncate(string
, string
->len
- 1);
257 total
= g_slist_length(list
);
259 for (i
= 0; i
< total
; i
++)
260 g_free(g_slist_nth_data(list
, i
));
266 // FIXME return a gboolean in case of memory allocation failure
267 gchar
**split_input_line(gchar
*str
, gchar
*delim
, gint n
)
272 return g_strsplit(str
, delim
, n
);
276 * Prevents a sibling element past the current element path with the same
279 static xmlNodePtr
find_stop_node(xmlNodePtr node
)
283 for (n
= node
->parent
->children
; n
; n
= n
->next
) {
292 * Alot like create_elements_cb() but doesn't use the last element of 'req' as
293 * content but as an element.
295 xmlNodePtr
create_target_elements_cb(xmlNodePtr node
, gchar
**path
,
296 gpg_error_t
*rc
, void *data
)
301 if (xmlStrEqual(node
->name
, (xmlChar
*)*req
))
304 for (i
= 0; req
[i
]; i
++) {
307 if ((n
= find_element(node
, req
[i
], find_stop_node(node
))) == NULL
||
308 (n
&& n
->parent
== node
->parent
)) {
309 is_literal_element(&req
[i
]);
310 n
= xmlNewNode(NULL
, (xmlChar
*)req
[i
]);
313 *rc
= gpg_error_from_errno(ENOMEM
);
317 node
= xmlAddChild(node
, n
);
320 *rc
= gpg_error_from_errno(ENOMEM
);
331 xmlNodePtr
find_text_node(xmlNodePtr node
)
335 if (n
&& n
->type
== XML_TEXT_NODE
)
338 for (n
= node
; n
; n
= n
->next
) {
339 if (n
->type
== XML_TEXT_NODE
)
346 xmlNodePtr
create_elements_cb(xmlNodePtr node
, gchar
**elements
,
347 gpg_error_t
*rc
, void *data
)
350 gchar
**req
= elements
;
352 if (node
->type
== XML_TEXT_NODE
)
355 if (node
->name
&& xmlStrEqual(node
->name
, (xmlChar
*)*req
))
358 for (i
= 0; req
[i
]; i
++) {
363 * Strip the first '!' if needed. If there's another, it's an
364 * rc. The syntax has already been checked before calling this
367 is_literal_element(&req
[i
]);
371 * The value of the element tree.
374 n
= find_text_node(node
->children
);
377 /* Use AddContent here to prevent overwriting any children. */
378 xmlNodeAddContent(node
, (xmlChar
*)req
[i
]);
379 else if (n
&& !*req
[i
])
380 xmlNodeSetContent(n
, NULL
);
382 xmlNodeSetContent(n
, (xmlChar
*)req
[i
]);
387 n
= find_element(node
, req
[i
], find_stop_node(node
));
390 * If the found element has the same parent as the current element,
391 * they are siblings and the new element needs to be created as a
392 * child of the current element (node).
394 if (n
&& n
->parent
== node
->parent
)
398 n
= xmlNewNode(NULL
, (xmlChar
*)req
[i
]);
401 *rc
= gpg_error_from_errno(ENOMEM
);
405 node
= xmlAddChild(node
, n
);
408 *rc
= gpg_error_from_errno(ENOMEM
);
419 xmlNodePtr
find_account(xmlDocPtr doc
, gchar
***req
, gpg_error_t
*rc
,
420 gboolean
*target
, gint recursion_depth
)
422 xmlNodePtr n
= xmlDocGetRootElement(doc
);
424 gchar
*account
= g_strdup(*req
[0]);
425 gboolean literal
= is_literal_element(&account
);
428 *rc
= gpg_error_from_errno(ENOMEM
);
435 if (max_recursion_depth
>= 1 && recursion_depth
> max_recursion_depth
) {
436 xmlChar
*t
= xmlGetNodePath(n
);
438 log_write("%s: %s", pwmd_strerror(EPWMD_LOOP
), t
);
445 if (n
->type
== XML_ELEMENT_NODE
) {
446 if (depth
== 0 && xmlStrEqual(n
->name
, (xmlChar
*)"accounts")) {
452 if (depth
== 1 && xmlStrEqual(n
->name
, (xmlChar
*)"account")) {
453 xmlChar
*content
= node_has_attribute(n
, (xmlChar
*)"name");
458 if (xmlStrEqual(content
, (xmlChar
*)account
)) {
459 gchar
**nreq
, **tmp
= NULL
;
461 if (literal
== TRUE
) {
468 content
= node_has_attribute(n
, (xmlChar
*)"target");
475 if (strchr((gchar
*)content
, '\t')) {
476 nreq
= split_input_line((gchar
*)content
, "\t", 0);
484 *rc
= gpg_error_from_errno(ENOMEM
);
490 tmp
= strvcatv(nreq
, tmp
+1);
494 *rc
= gpg_error_from_errno(ENOMEM
);
502 if (strv_printf(&tmp
, "%s", content
) == FALSE
) {
504 *rc
= gpg_error_from_errno(ENOMEM
);
510 nreq
= strvcatv(tmp
, nreq
+1);
514 *rc
= gpg_error_from_errno(ENOMEM
);
526 n
= find_account(doc
, req
, rc
, target
, recursion_depth
);
536 *rc
= EPWMD_ELEMENT_NOT_FOUND
;
540 static xmlNodePtr
find_element(xmlNodePtr node
, gchar
*element
, xmlNodePtr stop
)
544 if (!node
|| !element
)
547 for (n
= node
; n
; n
= n
->next
) {
548 if (n
->type
!= XML_ELEMENT_NODE
)
554 if (xmlStrEqual(n
->name
, (xmlChar
*)element
))
561 static xmlChar
*node_has_attribute(xmlNodePtr n
, xmlChar
*attr
)
563 xmlAttrPtr a
= xmlHasProp(n
, attr
);
568 if (!a
->children
|| !a
->children
->content
)
571 return xmlGetProp(n
, attr
);
574 static gboolean
element_to_literal(gchar
**element
)
576 gchar
*p
= g_strdup_printf("!%s", *element
);
586 xmlNodePtr
find_elements(xmlDocPtr doc
, xmlNodePtr node
,
587 gchar
**req
, gpg_error_t
*rc
, gboolean
*target
,
588 xmlNodePtr (*found_fn
)(xmlNodePtr
, gchar
**, gpg_error_t
*, gchar
**, void *),
589 xmlNodePtr (*not_found_fn
)(xmlNodePtr
, gchar
**, gpg_error_t
*, void *),
590 gboolean is_list_command
, gint recursion_depth
, void *data
)
592 xmlNodePtr n
, last
, last_node
;
599 if (max_recursion_depth
>= 1 && recursion_depth
> max_recursion_depth
) {
600 xmlChar
*t
= xmlGetNodePath(node
);
602 log_write("%s: %s", pwmd_strerror(EPWMD_LOOP
), t
);
609 for (last_node
= last
= n
= node
, p
= req
; *p
; p
++) {
611 gchar
*t
= g_strdup(*p
);
615 *rc
= gpg_error_from_errno(ENOMEM
);
619 literal
= is_literal_element(&t
);
620 n
= find_element(last
, t
, NULL
);
625 return not_found_fn(found
? last_node
: last_node
->parent
, p
, rc
, data
);
627 *rc
= EPWMD_ELEMENT_NOT_FOUND
;
635 if (literal
== FALSE
) {
636 xmlChar
*content
= node_has_attribute(n
, (xmlChar
*)"target");
637 gchar
**nreq
= NULL
, **nnreq
;
640 if (is_list_command
== TRUE
) {
641 if (element_to_literal(&(*p
)) == FALSE
) {
642 *rc
= gpg_error_from_errno(ENOMEM
);
650 if (strchr((gchar
*)content
, '\t') != NULL
) {
651 if ((nreq
= split_input_line((gchar
*)content
, "\t", 0)) == NULL
) {
653 *rc
= EPWMD_INVALID_ELEMENT
;
658 if ((nreq
= split_input_line((gchar
*)content
, " ", 0)) == NULL
) {
660 *rc
= EPWMD_INVALID_ELEMENT
;
666 tmp
= find_account(doc
, &nreq
, rc
, target
, 0);
674 found_fn(tmp
, nreq
, rc
, p
+1, data
);
682 nnreq
= strvcatv(nreq
+1, p
+1);
686 if (!nnreq
|| !*nnreq
) {
696 n
= find_elements(doc
, tmp
->children
, nnreq
, rc
, NULL
, found_fn
,
697 not_found_fn
, is_list_command
, recursion_depth
, data
);
700 gchar
**zz
= p
+1, **qq
= nnreq
;
702 if (g_strv_length(nnreq
) > g_strv_length(p
+1))
705 for (; *qq
&& *zz
; zz
++) {
707 *zz
= g_strdup(*qq
++);
710 *rc
= gpg_error_from_errno(ENOMEM
);
725 static gboolean
update_element_list(struct element_list_s
*elements
)
730 if (!elements
|| !elements
->elements
)
733 line
= g_strjoinv("\t", elements
->elements
);
738 g_strfreev(elements
->elements
);
739 elements
->elements
= NULL
;
740 l
= g_slist_append(elements
->list
, line
);
749 static gpg_error_t
path_list_recurse(xmlDocPtr doc
, xmlNodePtr node
,
750 struct element_list_s
*elements
)
755 for (n
= node
; n
; n
= n
->next
) {
756 xmlChar
*target
= NULL
;
758 if (n
->type
!= XML_ELEMENT_NODE
)
761 if (strv_printf(&elements
->elements
, "%s\t!%s", elements
->prefix
, n
->name
) == FALSE
)
762 return gpg_err_code_from_errno(ENOMEM
);
764 if (update_element_list(elements
) == FALSE
)
765 return gpg_err_code_from_errno(ENOMEM
);
767 target
= node_has_attribute(n
, (xmlChar
*)"target");
771 gchar
*save
= elements
->prefix
;
772 gboolean r
= elements
->resolving
;
776 if (max_recursion_depth
>= 1 && elements
->depth
> max_recursion_depth
) {
777 xmlChar
*t
= xmlGetNodePath(n
);
778 log_write("%s: %s", pwmd_strerror(EPWMD_LOOP
), t
);
784 if (strv_printf(&elements
->elements
, "%s\t%s", elements
->prefix
, n
->name
) == FALSE
) {
786 return gpg_err_code_from_errno(ENOMEM
);
789 tmp
= g_strjoinv("\t", elements
->elements
);
793 return gpg_err_code_from_errno(ENOMEM
);
796 if (update_element_list(elements
) == FALSE
) {
798 return gpg_err_code_from_errno(ENOMEM
);
801 elements
->prefix
= tmp
;
802 elements
->resolving
= TRUE
;
803 rc
= create_path_list(doc
, elements
, (gchar
*)target
);
805 elements
->resolving
= r
;
808 elements
->prefix
= save
;
816 gchar
*tmp
= g_strdup_printf("%s\t!%s", elements
->prefix
, n
->name
);
817 gchar
*save
= elements
->prefix
;
820 return gpg_err_code_from_errno(ENOMEM
);
822 elements
->prefix
= tmp
;
823 rc
= path_list_recurse(doc
, n
->children
, elements
);
824 g_free(elements
->prefix
);
825 elements
->prefix
= save
;
836 * From the element path 'path', find sub-nodes and append them to the list.
838 gpg_error_t
create_path_list(xmlDocPtr doc
, struct element_list_s
*elements
,
842 gchar
**req
, **req_orig
;
844 gboolean a_target
= FALSE
;
846 req
= split_input_line(path
, "\t", 0);
849 req
= split_input_line(path
, " ", 0);
852 return EPWMD_COMMAND_SYNTAX
;
855 req_orig
= g_strdupv(req
);
858 rc
= gpg_err_code_from_errno(ENOMEM
);
862 n
= find_account(doc
, &req
, &rc
, &a_target
, 0);
864 if (!n
&& rc
== EPWMD_ELEMENT_NOT_FOUND
&& elements
->resolving
== TRUE
) {
871 if (a_target
== TRUE
) {
873 *req
= g_strdup(*req_orig
);
877 gboolean e_target
= FALSE
;
879 n
= find_elements(doc
, n
->children
, req
+1, &rc
, &e_target
, NULL
, NULL
, TRUE
, 0, NULL
);
881 if (!n
&& rc
== EPWMD_ELEMENT_NOT_FOUND
&& elements
->resolving
== TRUE
) {
889 if (!elements
->prefix
) {
893 * If any req_orig element contains no target the element should be prefixed with
894 * the literal character. Not really crucial if the client isn't human
895 * because child elements are prefixed for the current path. But may
896 * be confusing if editing by hand.
898 elements
->prefix
= g_strjoinv("\t", req_orig
);
900 if (!elements
->prefix
) {
901 rc
= gpg_err_code_from_errno(ENOMEM
);
905 if (strv_printf(&elements
->elements
, "%s", elements
->prefix
) == FALSE
) {
906 rc
= gpg_err_code_from_errno(ENOMEM
);
910 if (update_element_list(elements
) == FALSE
) {
911 rc
= gpg_err_code_from_errno(ENOMEM
);
916 rc
= path_list_recurse(doc
, n
->children
, elements
);
920 g_strfreev(req_orig
);
926 gpg_error_t
recurse_xpath_nodeset(xmlDocPtr doc
, xmlNodeSetPtr nodes
,
927 xmlChar
*value
, xmlBufferPtr
*result
)
929 gint i
= value
? nodes
->nodeNr
- 1 : 0;
932 buf
= xmlBufferCreate();
935 return gpg_err_code_from_errno(ENOMEM
);
937 for (; value
? i
>= 0 : i
< nodes
->nodeNr
; value
? i
-- : i
++) {
938 xmlNodePtr n
= nodes
->nodeTab
[i
];
944 if (xmlNodeDump(buf
, doc
, n
, 0, 0) == -1) {
946 return EPWMD_LIBXML_ERROR
;
952 xmlNodeSetContent(n
, value
);