1 /* message-property.cc - Properties are like tags, but (key,value) pairs.
2 * keys are allowed to repeat.
4 * This file is part of notmuch.
6 * Copyright © 2016 David Bremner
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see https://www.gnu.org/licenses/ .
21 * Author: David Bremner <david@tethera.net>
24 #include "notmuch-private.h"
25 #include "database-private.h"
26 #include "message-private.h"
29 notmuch_message_get_property (notmuch_message_t *message, const char *key, const char **value)
32 return NOTMUCH_STATUS_NULL_POINTER;
34 *value = _notmuch_string_map_get (_notmuch_message_property_map (message), key);
36 return NOTMUCH_STATUS_SUCCESS;
40 notmuch_message_count_properties (notmuch_message_t *message, const char *key, unsigned int *count)
42 if (! count || ! key || ! message)
43 return NOTMUCH_STATUS_NULL_POINTER;
45 notmuch_string_map_t *map;
47 map = _notmuch_message_property_map (message);
49 return NOTMUCH_STATUS_NULL_POINTER;
51 notmuch_string_map_iterator_t *matcher = _notmuch_string_map_iterator_create (map, key, true);
54 return NOTMUCH_STATUS_OUT_OF_MEMORY;
57 while (_notmuch_string_map_iterator_valid (matcher)) {
59 _notmuch_string_map_iterator_move_to_next (matcher);
62 _notmuch_string_map_iterator_destroy (matcher);
63 return NOTMUCH_STATUS_SUCCESS;
66 static notmuch_status_t
67 _notmuch_message_modify_property (notmuch_message_t *message, const char *key, const char *value,
70 notmuch_private_status_t private_status;
71 notmuch_status_t status;
74 status = _notmuch_database_ensure_writable (notmuch_message_get_database (message));
78 if (key == NULL || value == NULL)
79 return NOTMUCH_STATUS_NULL_POINTER;
81 if (strchr (key, '='))
82 return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
84 term = talloc_asprintf (message, "%s=%s", key, value);
87 private_status = _notmuch_message_remove_term (message, "property", term);
89 private_status = _notmuch_message_add_term (message, "property", term);
92 return COERCE_STATUS (private_status,
93 "Unhandled error modifying message property");
94 if (! _notmuch_message_frozen (message))
95 _notmuch_message_sync (message);
100 return NOTMUCH_STATUS_SUCCESS;
104 notmuch_message_add_property (notmuch_message_t *message, const char *key, const char *value)
106 return _notmuch_message_modify_property (message, key, value, false);
110 notmuch_message_remove_property (notmuch_message_t *message, const char *key, const char *value)
112 return _notmuch_message_modify_property (message, key, value, true);
117 _notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key, bool prefix)
119 notmuch_status_t status;
120 const char *term_prefix;
122 status = _notmuch_database_ensure_writable (notmuch_message_get_database (message));
126 _notmuch_message_invalidate_metadata (message, "property");
128 term_prefix = talloc_asprintf (message, "%s%s%s", _find_prefix ("property"), key,
131 term_prefix = _find_prefix ("property");
133 /* XXX better error reporting ? */
134 _notmuch_message_remove_terms (message, term_prefix);
136 return NOTMUCH_STATUS_SUCCESS;
140 notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key)
142 return _notmuch_message_remove_all_properties (message, key, false);
146 notmuch_message_remove_all_properties_with_prefix (notmuch_message_t *message, const char *prefix)
148 return _notmuch_message_remove_all_properties (message, prefix, true);
151 notmuch_message_properties_t *
152 notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact)
154 notmuch_string_map_t *map;
156 map = _notmuch_message_property_map (message);
157 return _notmuch_string_map_iterator_create (map, key, exact);
161 notmuch_message_properties_valid (notmuch_message_properties_t *properties)
163 return _notmuch_string_map_iterator_valid (properties);
167 notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties)
169 return _notmuch_string_map_iterator_move_to_next (properties);
173 notmuch_message_properties_key (notmuch_message_properties_t *properties)
175 return _notmuch_string_map_iterator_key (properties);
179 notmuch_message_properties_value (notmuch_message_properties_t *properties)
181 return _notmuch_string_map_iterator_value (properties);
185 notmuch_message_properties_destroy (notmuch_message_properties_t *properties)
187 _notmuch_string_map_iterator_destroy (properties);