nexmon – Blame information for rev 1
?pathlinks?
Rev | Author | Line No. | Line |
---|---|---|---|
1 | office | 1 | /* gbookmarkfile.c: parsing and building desktop bookmarks |
2 | * |
||
3 | * Copyright (C) 2005-2006 Emmanuele Bassi |
||
4 | * |
||
5 | * This library is free software; you can redistribute it and/or |
||
6 | * modify it under the terms of the GNU Library General Public |
||
7 | * License as published by the Free Software Foundation; either |
||
8 | * version 2 of the License, or (at your option) any later version. |
||
9 | * |
||
10 | * This library 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 GNU |
||
13 | * Library General Public License for more details. |
||
14 | * |
||
15 | * You should have received a copy of the GNU Library General Public |
||
16 | * License along with this library; if not, write to the |
||
17 | * Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
||
18 | */ |
||
19 | |||
20 | #include "config.h" |
||
21 | |||
22 | #include "gbookmarkfile.h" |
||
23 | |||
24 | #include <stdio.h> |
||
25 | #include <stdlib.h> |
||
26 | #include <string.h> |
||
27 | #include <errno.h> |
||
28 | #include <fcntl.h> |
||
29 | #include <locale.h> |
||
30 | #include <time.h> |
||
31 | #include <stdarg.h> |
||
32 | |||
33 | #include "gconvert.h" |
||
34 | #include "gdataset.h" |
||
35 | #include "gerror.h" |
||
36 | #include "gfileutils.h" |
||
37 | #include "ghash.h" |
||
38 | #include "glibintl.h" |
||
39 | #include "glist.h" |
||
40 | #include "gmain.h" |
||
41 | #include "gmarkup.h" |
||
42 | #include "gmem.h" |
||
43 | #include "gmessages.h" |
||
44 | #include "gshell.h" |
||
45 | #include "gslice.h" |
||
46 | #include "gstdio.h" |
||
47 | #include "gstring.h" |
||
48 | #include "gstrfuncs.h" |
||
49 | #include "gtimer.h" |
||
50 | #include "gutils.h" |
||
51 | |||
52 | |||
53 | /** |
||
54 | * SECTION:bookmarkfile |
||
55 | * @title: Bookmark file parser |
||
56 | * @short_description: parses files containing bookmarks |
||
57 | * |
||
58 | * GBookmarkFile lets you parse, edit or create files containing bookmarks |
||
59 | * to URI, along with some meta-data about the resource pointed by the URI |
||
60 | * like its MIME type, the application that is registering the bookmark and |
||
61 | * the icon that should be used to represent the bookmark. The data is stored |
||
62 | * using the |
||
63 | * [Desktop Bookmark Specification](http://www.gnome.org/~ebassi/bookmark-spec). |
||
64 | * |
||
65 | * The syntax of the bookmark files is described in detail inside the |
||
66 | * Desktop Bookmark Specification, here is a quick summary: bookmark |
||
67 | * files use a sub-class of the XML Bookmark Exchange Language |
||
68 | * specification, consisting of valid UTF-8 encoded XML, under the |
||
69 | * <xbel> root element; each bookmark is stored inside a |
||
70 | * <bookmark> element, using its URI: no relative paths can |
||
71 | * be used inside a bookmark file. The bookmark may have a user defined |
||
72 | * title and description, to be used instead of the URI. Under the |
||
73 | * <metadata> element, with its owner attribute set to |
||
74 | * `http://freedesktop.org`, is stored the meta-data about a resource |
||
75 | * pointed by its URI. The meta-data consists of the resource's MIME |
||
76 | * type; the applications that have registered a bookmark; the groups |
||
77 | * to which a bookmark belongs to; a visibility flag, used to set the |
||
78 | * bookmark as "private" to the applications and groups that has it |
||
79 | * registered; the URI and MIME type of an icon, to be used when |
||
80 | * displaying the bookmark inside a GUI. |
||
81 | * |
||
82 | * Here is an example of a bookmark file: |
||
83 | * [bookmarks.xbel](https://git.gnome.org/browse/glib/tree/glib/tests/bookmarks.xbel) |
||
84 | * |
||
85 | * A bookmark file might contain more than one bookmark; each bookmark |
||
86 | * is accessed through its URI. |
||
87 | * |
||
88 | * The important caveat of bookmark files is that when you add a new |
||
89 | * bookmark you must also add the application that is registering it, using |
||
90 | * g_bookmark_file_add_application() or g_bookmark_file_set_app_info(). |
||
91 | * If a bookmark has no applications then it won't be dumped when creating |
||
92 | * the on disk representation, using g_bookmark_file_to_data() or |
||
93 | * g_bookmark_file_to_file(). |
||
94 | * |
||
95 | * The #GBookmarkFile parser was added in GLib 2.12. |
||
96 | */ |
||
97 | |||
98 | /* XBEL 1.0 standard entities */ |
||
99 | #define XBEL_VERSION "1.0" |
||
100 | #define XBEL_DTD_NICK "xbel" |
||
101 | #define XBEL_DTD_SYSTEM "+//IDN python.org//DTD XML Bookmark " \ |
||
102 | "Exchange Language 1.0//EN//XML" |
||
103 | |||
104 | #define XBEL_DTD_URI "http://www.python.org/topics/xml/dtds/xbel-1.0.dtd" |
||
105 | |||
106 | #define XBEL_ROOT_ELEMENT "xbel" |
||
107 | #define XBEL_FOLDER_ELEMENT "folder" /* unused */ |
||
108 | #define XBEL_BOOKMARK_ELEMENT "bookmark" |
||
109 | #define XBEL_ALIAS_ELEMENT "alias" /* unused */ |
||
110 | #define XBEL_SEPARATOR_ELEMENT "separator" /* unused */ |
||
111 | #define XBEL_TITLE_ELEMENT "title" |
||
112 | #define XBEL_DESC_ELEMENT "desc" |
||
113 | #define XBEL_INFO_ELEMENT "info" |
||
114 | #define XBEL_METADATA_ELEMENT "metadata" |
||
115 | |||
116 | #define XBEL_VERSION_ATTRIBUTE "version" |
||
117 | #define XBEL_FOLDED_ATTRIBUTE "folded" /* unused */ |
||
118 | #define XBEL_OWNER_ATTRIBUTE "owner" |
||
119 | #define XBEL_ADDED_ATTRIBUTE "added" |
||
120 | #define XBEL_VISITED_ATTRIBUTE "visited" |
||
121 | #define XBEL_MODIFIED_ATTRIBUTE "modified" |
||
122 | #define XBEL_ID_ATTRIBUTE "id" |
||
123 | #define XBEL_HREF_ATTRIBUTE "href" |
||
124 | #define XBEL_REF_ATTRIBUTE "ref" /* unused */ |
||
125 | |||
126 | #define XBEL_YES_VALUE "yes" |
||
127 | #define XBEL_NO_VALUE "no" |
||
128 | |||
129 | /* Desktop bookmark spec entities */ |
||
130 | #define BOOKMARK_METADATA_OWNER "http://freedesktop.org" |
||
131 | |||
132 | #define BOOKMARK_NAMESPACE_NAME "bookmark" |
||
133 | #define BOOKMARK_NAMESPACE_URI "http://www.freedesktop.org/standards/desktop-bookmarks" |
||
134 | |||
135 | #define BOOKMARK_GROUPS_ELEMENT "groups" |
||
136 | #define BOOKMARK_GROUP_ELEMENT "group" |
||
137 | #define BOOKMARK_APPLICATIONS_ELEMENT "applications" |
||
138 | #define BOOKMARK_APPLICATION_ELEMENT "application" |
||
139 | #define BOOKMARK_ICON_ELEMENT "icon" |
||
140 | #define BOOKMARK_PRIVATE_ELEMENT "private" |
||
141 | |||
142 | #define BOOKMARK_NAME_ATTRIBUTE "name" |
||
143 | #define BOOKMARK_EXEC_ATTRIBUTE "exec" |
||
144 | #define BOOKMARK_COUNT_ATTRIBUTE "count" |
||
145 | #define BOOKMARK_TIMESTAMP_ATTRIBUTE "timestamp" /* deprecated by "modified" */ |
||
146 | #define BOOKMARK_MODIFIED_ATTRIBUTE "modified" |
||
147 | #define BOOKMARK_HREF_ATTRIBUTE "href" |
||
148 | #define BOOKMARK_TYPE_ATTRIBUTE "type" |
||
149 | |||
150 | /* Shared MIME Info entities */ |
||
151 | #define MIME_NAMESPACE_NAME "mime" |
||
152 | #define MIME_NAMESPACE_URI "http://www.freedesktop.org/standards/shared-mime-info" |
||
153 | #define MIME_TYPE_ELEMENT "mime-type" |
||
154 | #define MIME_TYPE_ATTRIBUTE "type" |
||
155 | |||
156 | |||
157 | typedef struct _BookmarkAppInfo BookmarkAppInfo; |
||
158 | typedef struct _BookmarkMetadata BookmarkMetadata; |
||
159 | typedef struct _BookmarkItem BookmarkItem; |
||
160 | typedef struct _ParseData ParseData; |
||
161 | |||
162 | struct _BookmarkAppInfo |
||
163 | { |
||
164 | gchar *name; |
||
165 | gchar *exec; |
||
166 | |||
167 | guint count; |
||
168 | |||
169 | time_t stamp; |
||
170 | }; |
||
171 | |||
172 | struct _BookmarkMetadata |
||
173 | { |
||
174 | gchar *mime_type; |
||
175 | |||
176 | GList *groups; |
||
177 | |||
178 | GList *applications; |
||
179 | GHashTable *apps_by_name; |
||
180 | |||
181 | gchar *icon_href; |
||
182 | gchar *icon_mime; |
||
183 | |||
184 | guint is_private : 1; |
||
185 | }; |
||
186 | |||
187 | struct _BookmarkItem |
||
188 | { |
||
189 | gchar *uri; |
||
190 | |||
191 | gchar *title; |
||
192 | gchar *description; |
||
193 | |||
194 | time_t added; |
||
195 | time_t modified; |
||
196 | time_t visited; |
||
197 | |||
198 | BookmarkMetadata *metadata; |
||
199 | }; |
||
200 | |||
201 | struct _GBookmarkFile |
||
202 | { |
||
203 | gchar *title; |
||
204 | gchar *description; |
||
205 | |||
206 | /* we store our items in a list and keep a copy inside |
||
207 | * an hash table for faster lookup performances |
||
208 | */ |
||
209 | GList *items; |
||
210 | GHashTable *items_by_uri; |
||
211 | }; |
||
212 | |||
213 | /* parser state machine */ |
||
214 | enum |
||
215 | { |
||
216 | STATE_STARTED = 0, |
||
217 | |||
218 | STATE_ROOT, |
||
219 | STATE_BOOKMARK, |
||
220 | STATE_TITLE, |
||
221 | STATE_DESC, |
||
222 | STATE_INFO, |
||
223 | STATE_METADATA, |
||
224 | STATE_APPLICATIONS, |
||
225 | STATE_APPLICATION, |
||
226 | STATE_GROUPS, |
||
227 | STATE_GROUP, |
||
228 | STATE_MIME, |
||
229 | STATE_ICON, |
||
230 | |||
231 | STATE_FINISHED |
||
232 | }; |
||
233 | |||
234 | static void g_bookmark_file_init (GBookmarkFile *bookmark); |
||
235 | static void g_bookmark_file_clear (GBookmarkFile *bookmark); |
||
236 | static gboolean g_bookmark_file_parse (GBookmarkFile *bookmark, |
||
237 | const gchar *buffer, |
||
238 | gsize length, |
||
239 | GError **error); |
||
240 | static gchar * g_bookmark_file_dump (GBookmarkFile *bookmark, |
||
241 | gsize *length, |
||
242 | GError **error); |
||
243 | static BookmarkItem *g_bookmark_file_lookup_item (GBookmarkFile *bookmark, |
||
244 | const gchar *uri); |
||
245 | static void g_bookmark_file_add_item (GBookmarkFile *bookmark, |
||
246 | BookmarkItem *item, |
||
247 | GError **error); |
||
248 | |||
249 | static time_t timestamp_from_iso8601 (const gchar *iso_date); |
||
250 | static gchar * timestamp_to_iso8601 (time_t timestamp); |
||
251 | |||
252 | /******************************** |
||
253 | * BookmarkAppInfo * |
||
254 | * * |
||
255 | * Application metadata storage * |
||
256 | ********************************/ |
||
257 | static BookmarkAppInfo * |
||
258 | bookmark_app_info_new (const gchar *name) |
||
259 | { |
||
260 | BookmarkAppInfo *retval; |
||
261 | |||
262 | g_warn_if_fail (name != NULL); |
||
263 | |||
264 | retval = g_slice_new (BookmarkAppInfo); |
||
265 | |||
266 | retval->name = g_strdup (name); |
||
267 | retval->exec = NULL; |
||
268 | retval->count = 0; |
||
269 | retval->stamp = 0; |
||
270 | |||
271 | return retval; |
||
272 | } |
||
273 | |||
274 | static void |
||
275 | bookmark_app_info_free (BookmarkAppInfo *app_info) |
||
276 | { |
||
277 | if (!app_info) |
||
278 | return; |
||
279 | |||
280 | g_free (app_info->name); |
||
281 | g_free (app_info->exec); |
||
282 | |||
283 | g_slice_free (BookmarkAppInfo, app_info); |
||
284 | } |
||
285 | |||
286 | static gchar * |
||
287 | bookmark_app_info_dump (BookmarkAppInfo *app_info) |
||
288 | { |
||
289 | gchar *retval; |
||
290 | gchar *name, *exec, *modified, *count; |
||
291 | |||
292 | g_warn_if_fail (app_info != NULL); |
||
293 | |||
294 | if (app_info->count == 0) |
||
295 | return NULL; |
||
296 | |||
297 | name = g_markup_escape_text (app_info->name, -1); |
||
298 | exec = g_markup_escape_text (app_info->exec, -1); |
||
299 | modified = timestamp_to_iso8601 (app_info->stamp); |
||
300 | count = g_strdup_printf ("%u", app_info->count); |
||
301 | |||
302 | retval = g_strconcat (" " |
||
303 | "<" BOOKMARK_NAMESPACE_NAME ":" BOOKMARK_APPLICATION_ELEMENT |
||
304 | " " BOOKMARK_NAME_ATTRIBUTE "=\"", name, "\"" |
||
305 | " " BOOKMARK_EXEC_ATTRIBUTE "=\"", exec, "\"" |
||
306 | " " BOOKMARK_MODIFIED_ATTRIBUTE "=\"", modified, "\"" |
||
307 | " " BOOKMARK_COUNT_ATTRIBUTE "=\"", count, "\"/>\n", |
||
308 | NULL); |
||
309 | |||
310 | g_free (name); |
||
311 | g_free (exec); |
||
312 | g_free (modified); |
||
313 | g_free (count); |
||
314 | |||
315 | return retval; |
||
316 | } |
||
317 | |||
318 | |||
319 | /*********************** |
||
320 | * BookmarkMetadata * |
||
321 | * * |
||
322 | * Metadata storage * |
||
323 | ***********************/ |
||
324 | static BookmarkMetadata * |
||
325 | bookmark_metadata_new (void) |
||
326 | { |
||
327 | BookmarkMetadata *retval; |
||
328 | |||
329 | retval = g_slice_new (BookmarkMetadata); |
||
330 | |||
331 | retval->mime_type = NULL; |
||
332 | |||
333 | retval->groups = NULL; |
||
334 | |||
335 | retval->applications = NULL; |
||
336 | retval->apps_by_name = g_hash_table_new_full (g_str_hash, |
||
337 | g_str_equal, |
||
338 | NULL, |
||
339 | NULL); |
||
340 | |||
341 | retval->is_private = FALSE; |
||
342 | |||
343 | retval->icon_href = NULL; |
||
344 | retval->icon_mime = NULL; |
||
345 | |||
346 | return retval; |
||
347 | } |
||
348 | |||
349 | static void |
||
350 | bookmark_metadata_free (BookmarkMetadata *metadata) |
||
351 | { |
||
352 | if (!metadata) |
||
353 | return; |
||
354 | |||
355 | g_free (metadata->mime_type); |
||
356 | |||
357 | g_list_free_full (metadata->groups, g_free); |
||
358 | g_list_free_full (metadata->applications, (GDestroyNotify) bookmark_app_info_free); |
||
359 | |||
360 | g_hash_table_destroy (metadata->apps_by_name); |
||
361 | |||
362 | g_free (metadata->icon_href); |
||
363 | g_free (metadata->icon_mime); |
||
364 | |||
365 | g_slice_free (BookmarkMetadata, metadata); |
||
366 | } |
||
367 | |||
368 | static gchar * |
||
369 | bookmark_metadata_dump (BookmarkMetadata *metadata) |
||
370 | { |
||
371 | GString *retval; |
||
372 | gchar *buffer; |
||
373 | |||
374 | if (!metadata->applications) |
||
375 | return NULL; |
||
376 | |||
377 | retval = g_string_sized_new (1024); |
||
378 | |||
379 | /* metadata container */ |
||
380 | g_string_append (retval, |
||
381 | " " |
||
382 | "<" XBEL_METADATA_ELEMENT |
||
383 | " " XBEL_OWNER_ATTRIBUTE "=\"" BOOKMARK_METADATA_OWNER |
||
384 | "\">\n"); |
||
385 | |||
386 | /* mime type */ |
||
387 | if (metadata->mime_type) { |
||
388 | buffer = g_strconcat (" " |
||
389 | "<" MIME_NAMESPACE_NAME ":" MIME_TYPE_ELEMENT " " |
||
390 | MIME_TYPE_ATTRIBUTE "=\"", metadata->mime_type, "\"/>\n", |
||
391 | NULL); |
||
392 | g_string_append (retval, buffer); |
||
393 | g_free (buffer); |
||
394 | } |
||
395 | |||
396 | if (metadata->groups) |
||
397 | { |
||
398 | GList *l; |
||
399 | |||
400 | /* open groups container */ |
||
401 | g_string_append (retval, |
||
402 | " " |
||
403 | "<" BOOKMARK_NAMESPACE_NAME |
||
404 | ":" BOOKMARK_GROUPS_ELEMENT ">\n"); |
||
405 | |||
406 | for (l = g_list_last (metadata->groups); l != NULL; l = l->prev) |
||
407 | { |
||
408 | gchar *group_name; |
||
409 | |||
410 | group_name = g_markup_escape_text ((gchar *) l->data, -1); |
||
411 | buffer = g_strconcat (" " |
||
412 | "<" BOOKMARK_NAMESPACE_NAME |
||
413 | ":" BOOKMARK_GROUP_ELEMENT ">", |
||
414 | group_name, |
||
415 | "</" BOOKMARK_NAMESPACE_NAME |
||
416 | ":" BOOKMARK_GROUP_ELEMENT ">\n", NULL); |
||
417 | g_string_append (retval, buffer); |
||
418 | |||
419 | g_free (buffer); |
||
420 | g_free (group_name); |
||
421 | } |
||
422 | |||
423 | /* close groups container */ |
||
424 | g_string_append (retval, |
||
425 | " " |
||
426 | "</" BOOKMARK_NAMESPACE_NAME |
||
427 | ":" BOOKMARK_GROUPS_ELEMENT ">\n"); |
||
428 | } |
||
429 | |||
430 | if (metadata->applications) |
||
431 | { |
||
432 | GList *l; |
||
433 | |||
434 | /* open applications container */ |
||
435 | g_string_append (retval, |
||
436 | " " |
||
437 | "<" BOOKMARK_NAMESPACE_NAME |
||
438 | ":" BOOKMARK_APPLICATIONS_ELEMENT ">\n"); |
||
439 | |||
440 | for (l = g_list_last (metadata->applications); l != NULL; l = l->prev) |
||
441 | { |
||
442 | BookmarkAppInfo *app_info = (BookmarkAppInfo *) l->data; |
||
443 | gchar *app_data; |
||
444 | |||
445 | g_warn_if_fail (app_info != NULL); |
||
446 | |||
447 | app_data = bookmark_app_info_dump (app_info); |
||
448 | |||
449 | if (app_data) |
||
450 | { |
||
451 | retval = g_string_append (retval, app_data); |
||
452 | |||
453 | g_free (app_data); |
||
454 | } |
||
455 | } |
||
456 | |||
457 | /* close applications container */ |
||
458 | g_string_append (retval, |
||
459 | " " |
||
460 | "</" BOOKMARK_NAMESPACE_NAME |
||
461 | ":" BOOKMARK_APPLICATIONS_ELEMENT ">\n"); |
||
462 | } |
||
463 | |||
464 | /* icon */ |
||
465 | if (metadata->icon_href) |
||
466 | { |
||
467 | if (!metadata->icon_mime) |
||
468 | metadata->icon_mime = g_strdup ("application/octet-stream"); |
||
469 | |||
470 | buffer = g_strconcat (" " |
||
471 | "<" BOOKMARK_NAMESPACE_NAME |
||
472 | ":" BOOKMARK_ICON_ELEMENT |
||
473 | " " BOOKMARK_HREF_ATTRIBUTE "=\"", metadata->icon_href, |
||
474 | "\" " BOOKMARK_TYPE_ATTRIBUTE "=\"", metadata->icon_mime, "\"/>\n", NULL); |
||
475 | g_string_append (retval, buffer); |
||
476 | |||
477 | g_free (buffer); |
||
478 | } |
||
479 | |||
480 | /* private hint */ |
||
481 | if (metadata->is_private) |
||
482 | g_string_append (retval, |
||
483 | " " |
||
484 | "<" BOOKMARK_NAMESPACE_NAME |
||
485 | ":" BOOKMARK_PRIVATE_ELEMENT "/>\n"); |
||
486 | |||
487 | /* close metadata container */ |
||
488 | g_string_append (retval, |
||
489 | " " |
||
490 | "</" XBEL_METADATA_ELEMENT ">\n"); |
||
491 | |||
492 | return g_string_free (retval, FALSE); |
||
493 | } |
||
494 | |||
495 | /****************************************************** |
||
496 | * BookmarkItem * |
||
497 | * * |
||
498 | * Storage for a single bookmark item inside the list * |
||
499 | ******************************************************/ |
||
500 | static BookmarkItem * |
||
501 | bookmark_item_new (const gchar *uri) |
||
502 | { |
||
503 | BookmarkItem *item; |
||
504 | |||
505 | g_warn_if_fail (uri != NULL); |
||
506 | |||
507 | item = g_slice_new (BookmarkItem); |
||
508 | item->uri = g_strdup (uri); |
||
509 | |||
510 | item->title = NULL; |
||
511 | item->description = NULL; |
||
512 | |||
513 | item->added = (time_t) -1; |
||
514 | item->modified = (time_t) -1; |
||
515 | item->visited = (time_t) -1; |
||
516 | |||
517 | item->metadata = NULL; |
||
518 | |||
519 | return item; |
||
520 | } |
||
521 | |||
522 | static void |
||
523 | bookmark_item_free (BookmarkItem *item) |
||
524 | { |
||
525 | if (!item) |
||
526 | return; |
||
527 | |||
528 | g_free (item->uri); |
||
529 | g_free (item->title); |
||
530 | g_free (item->description); |
||
531 | |||
532 | if (item->metadata) |
||
533 | bookmark_metadata_free (item->metadata); |
||
534 | |||
535 | g_slice_free (BookmarkItem, item); |
||
536 | } |
||
537 | |||
538 | static gchar * |
||
539 | bookmark_item_dump (BookmarkItem *item) |
||
540 | { |
||
541 | GString *retval; |
||
542 | gchar *added, *visited, *modified; |
||
543 | gchar *escaped_uri; |
||
544 | gchar *buffer; |
||
545 | |||
546 | /* at this point, we must have at least a registered application; if we don't |
||
547 | * we don't screw up the bookmark file, and just skip this item |
||
548 | */ |
||
549 | if (!item->metadata || !item->metadata->applications) |
||
550 | { |
||
551 | g_warning ("Item for URI '%s' has no registered applications: skipping.\n", item->uri); |
||
552 | return NULL; |
||
553 | } |
||
554 | |||
555 | retval = g_string_sized_new (4096); |
||
556 | |||
557 | added = timestamp_to_iso8601 (item->added); |
||
558 | modified = timestamp_to_iso8601 (item->modified); |
||
559 | visited = timestamp_to_iso8601 (item->visited); |
||
560 | |||
561 | escaped_uri = g_markup_escape_text (item->uri, -1); |
||
562 | |||
563 | buffer = g_strconcat (" <" |
||
564 | XBEL_BOOKMARK_ELEMENT |
||
565 | " " |
||
566 | XBEL_HREF_ATTRIBUTE "=\"", escaped_uri, "\" " |
||
567 | XBEL_ADDED_ATTRIBUTE "=\"", added, "\" " |
||
568 | XBEL_MODIFIED_ATTRIBUTE "=\"", modified, "\" " |
||
569 | XBEL_VISITED_ATTRIBUTE "=\"", visited, "\">\n", |
||
570 | NULL); |
||
571 | |||
572 | g_string_append (retval, buffer); |
||
573 | |||
574 | g_free (escaped_uri); |
||
575 | g_free (visited); |
||
576 | g_free (modified); |
||
577 | g_free (added); |
||
578 | g_free (buffer); |
||
579 | |||
580 | if (item->title) |
||
581 | { |
||
582 | gchar *escaped_title; |
||
583 | |||
584 | escaped_title = g_markup_escape_text (item->title, -1); |
||
585 | buffer = g_strconcat (" " |
||
586 | "<" XBEL_TITLE_ELEMENT ">", |
||
587 | escaped_title, |
||
588 | "</" XBEL_TITLE_ELEMENT ">\n", |
||
589 | NULL); |
||
590 | g_string_append (retval, buffer); |
||
591 | |||
592 | g_free (escaped_title); |
||
593 | g_free (buffer); |
||
594 | } |
||
595 | |||
596 | if (item->description) |
||
597 | { |
||
598 | gchar *escaped_desc; |
||
599 | |||
600 | escaped_desc = g_markup_escape_text (item->description, -1); |
||
601 | buffer = g_strconcat (" " |
||
602 | "<" XBEL_DESC_ELEMENT ">", |
||
603 | escaped_desc, |
||
604 | "</" XBEL_DESC_ELEMENT ">\n", |
||
605 | NULL); |
||
606 | g_string_append (retval, buffer); |
||
607 | |||
608 | g_free (escaped_desc); |
||
609 | g_free (buffer); |
||
610 | } |
||
611 | |||
612 | if (item->metadata) |
||
613 | { |
||
614 | gchar *metadata; |
||
615 | |||
616 | metadata = bookmark_metadata_dump (item->metadata); |
||
617 | if (metadata) |
||
618 | { |
||
619 | buffer = g_strconcat (" " |
||
620 | "<" XBEL_INFO_ELEMENT ">\n", |
||
621 | metadata, |
||
622 | " " |
||
623 | "</" XBEL_INFO_ELEMENT ">\n", |
||
624 | NULL); |
||
625 | retval = g_string_append (retval, buffer); |
||
626 | |||
627 | g_free (buffer); |
||
628 | g_free (metadata); |
||
629 | } |
||
630 | } |
||
631 | |||
632 | g_string_append (retval, " </" XBEL_BOOKMARK_ELEMENT ">\n"); |
||
633 | |||
634 | return g_string_free (retval, FALSE); |
||
635 | } |
||
636 | |||
637 | static BookmarkAppInfo * |
||
638 | bookmark_item_lookup_app_info (BookmarkItem *item, |
||
639 | const gchar *app_name) |
||
640 | { |
||
641 | g_warn_if_fail (item != NULL && app_name != NULL); |
||
642 | |||
643 | if (!item->metadata) |
||
644 | return NULL; |
||
645 | |||
646 | return g_hash_table_lookup (item->metadata->apps_by_name, app_name); |
||
647 | } |
||
648 | |||
649 | /************************* |
||
650 | * GBookmarkFile * |
||
651 | *************************/ |
||
652 | |||
653 | static void |
||
654 | g_bookmark_file_init (GBookmarkFile *bookmark) |
||
655 | { |
||
656 | bookmark->title = NULL; |
||
657 | bookmark->description = NULL; |
||
658 | |||
659 | bookmark->items = NULL; |
||
660 | bookmark->items_by_uri = g_hash_table_new_full (g_str_hash, |
||
661 | g_str_equal, |
||
662 | NULL, |
||
663 | NULL); |
||
664 | } |
||
665 | |||
666 | static void |
||
667 | g_bookmark_file_clear (GBookmarkFile *bookmark) |
||
668 | { |
||
669 | g_free (bookmark->title); |
||
670 | g_free (bookmark->description); |
||
671 | |||
672 | g_list_free_full (bookmark->items, (GDestroyNotify) bookmark_item_free); |
||
673 | bookmark->items = NULL; |
||
674 | |||
675 | if (bookmark->items_by_uri) |
||
676 | { |
||
677 | g_hash_table_destroy (bookmark->items_by_uri); |
||
678 | |||
679 | bookmark->items_by_uri = NULL; |
||
680 | } |
||
681 | } |
||
682 | |||
683 | struct _ParseData |
||
684 | { |
||
685 | gint state; |
||
686 | |||
687 | GHashTable *namespaces; |
||
688 | |||
689 | GBookmarkFile *bookmark_file; |
||
690 | BookmarkItem *current_item; |
||
691 | }; |
||
692 | |||
693 | static ParseData * |
||
694 | parse_data_new (void) |
||
695 | { |
||
696 | ParseData *retval; |
||
697 | |||
698 | retval = g_new (ParseData, 1); |
||
699 | |||
700 | retval->state = STATE_STARTED; |
||
701 | retval->namespaces = g_hash_table_new_full (g_str_hash, g_str_equal, |
||
702 | (GDestroyNotify) g_free, |
||
703 | (GDestroyNotify) g_free); |
||
704 | retval->bookmark_file = NULL; |
||
705 | retval->current_item = NULL; |
||
706 | |||
707 | return retval; |
||
708 | } |
||
709 | |||
710 | static void |
||
711 | parse_data_free (ParseData *parse_data) |
||
712 | { |
||
713 | g_hash_table_destroy (parse_data->namespaces); |
||
714 | |||
715 | g_free (parse_data); |
||
716 | } |
||
717 | |||
718 | #define IS_ATTRIBUTE(s,a) ((0 == strcmp ((s), (a)))) |
||
719 | |||
720 | static void |
||
721 | parse_bookmark_element (GMarkupParseContext *context, |
||
722 | ParseData *parse_data, |
||
723 | const gchar **attribute_names, |
||
724 | const gchar **attribute_values, |
||
725 | GError **error) |
||
726 | { |
||
727 | const gchar *uri, *added, *modified, *visited; |
||
728 | const gchar *attr; |
||
729 | gint i; |
||
730 | BookmarkItem *item; |
||
731 | GError *add_error; |
||
732 | |||
733 | g_warn_if_fail ((parse_data != NULL) && (parse_data->state == STATE_BOOKMARK)); |
||
734 | |||
735 | i = 0; |
||
736 | uri = added = modified = visited = NULL; |
||
737 | for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i]) |
||
738 | { |
||
739 | if (IS_ATTRIBUTE (attr, XBEL_HREF_ATTRIBUTE)) |
||
740 | uri = attribute_values[i]; |
||
741 | else if (IS_ATTRIBUTE (attr, XBEL_ADDED_ATTRIBUTE)) |
||
742 | added = attribute_values[i]; |
||
743 | else if (IS_ATTRIBUTE (attr, XBEL_MODIFIED_ATTRIBUTE)) |
||
744 | modified = attribute_values[i]; |
||
745 | else if (IS_ATTRIBUTE (attr, XBEL_VISITED_ATTRIBUTE)) |
||
746 | visited = attribute_values[i]; |
||
747 | else |
||
748 | { |
||
749 | /* bookmark is defined by the XBEL spec, so we need |
||
750 | * to error out if the element has different or |
||
751 | * missing attributes |
||
752 | */ |
||
753 | g_set_error (error, G_MARKUP_ERROR, |
||
754 | G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE, |
||
755 | _("Unexpected attribute '%s' for element '%s'"), |
||
756 | attr, |
||
757 | XBEL_BOOKMARK_ELEMENT); |
||
758 | return; |
||
759 | } |
||
760 | } |
||
761 | |||
762 | if (!uri) |
||
763 | { |
||
764 | g_set_error (error, G_MARKUP_ERROR, |
||
765 | G_MARKUP_ERROR_INVALID_CONTENT, |
||
766 | _("Attribute '%s' of element '%s' not found"), |
||
767 | XBEL_HREF_ATTRIBUTE, |
||
768 | XBEL_BOOKMARK_ELEMENT); |
||
769 | return; |
||
770 | } |
||
771 | |||
772 | g_warn_if_fail (parse_data->current_item == NULL); |
||
773 | |||
774 | item = bookmark_item_new (uri); |
||
775 | |||
776 | if (added) |
||
777 | item->added = timestamp_from_iso8601 (added); |
||
778 | |||
779 | if (modified) |
||
780 | item->modified = timestamp_from_iso8601 (modified); |
||
781 | |||
782 | if (visited) |
||
783 | item->visited = timestamp_from_iso8601 (visited); |
||
784 | |||
785 | add_error = NULL; |
||
786 | g_bookmark_file_add_item (parse_data->bookmark_file, |
||
787 | item, |
||
788 | &add_error); |
||
789 | if (add_error) |
||
790 | { |
||
791 | bookmark_item_free (item); |
||
792 | |||
793 | g_propagate_error (error, add_error); |
||
794 | |||
795 | return; |
||
796 | } |
||
797 | |||
798 | parse_data->current_item = item; |
||
799 | } |
||
800 | |||
801 | static void |
||
802 | parse_application_element (GMarkupParseContext *context, |
||
803 | ParseData *parse_data, |
||
804 | const gchar **attribute_names, |
||
805 | const gchar **attribute_values, |
||
806 | GError **error) |
||
807 | { |
||
808 | const gchar *name, *exec, *count, *stamp, *modified; |
||
809 | const gchar *attr; |
||
810 | gint i; |
||
811 | BookmarkItem *item; |
||
812 | BookmarkAppInfo *ai; |
||
813 | |||
814 | g_warn_if_fail ((parse_data != NULL) && (parse_data->state == STATE_APPLICATION)); |
||
815 | |||
816 | i = 0; |
||
817 | name = exec = count = stamp = modified = NULL; |
||
818 | for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i]) |
||
819 | { |
||
820 | if (IS_ATTRIBUTE (attr, BOOKMARK_NAME_ATTRIBUTE)) |
||
821 | name = attribute_values[i]; |
||
822 | else if (IS_ATTRIBUTE (attr, BOOKMARK_EXEC_ATTRIBUTE)) |
||
823 | exec = attribute_values[i]; |
||
824 | else if (IS_ATTRIBUTE (attr, BOOKMARK_COUNT_ATTRIBUTE)) |
||
825 | count = attribute_values[i]; |
||
826 | else if (IS_ATTRIBUTE (attr, BOOKMARK_TIMESTAMP_ATTRIBUTE)) |
||
827 | stamp = attribute_values[i]; |
||
828 | else if (IS_ATTRIBUTE (attr, BOOKMARK_MODIFIED_ATTRIBUTE)) |
||
829 | modified = attribute_values[i]; |
||
830 | } |
||
831 | |||
832 | /* the "name" and "exec" attributes are mandatory */ |
||
833 | if (!name) |
||
834 | { |
||
835 | g_set_error (error, G_MARKUP_ERROR, |
||
836 | G_MARKUP_ERROR_INVALID_CONTENT, |
||
837 | _("Attribute '%s' of element '%s' not found"), |
||
838 | BOOKMARK_NAME_ATTRIBUTE, |
||
839 | BOOKMARK_APPLICATION_ELEMENT); |
||
840 | return; |
||
841 | } |
||
842 | |||
843 | if (!exec) |
||
844 | { |
||
845 | g_set_error (error, G_MARKUP_ERROR, |
||
846 | G_MARKUP_ERROR_INVALID_CONTENT, |
||
847 | _("Attribute '%s' of element '%s' not found"), |
||
848 | BOOKMARK_EXEC_ATTRIBUTE, |
||
849 | BOOKMARK_APPLICATION_ELEMENT); |
||
850 | return; |
||
851 | } |
||
852 | |||
853 | g_warn_if_fail (parse_data->current_item != NULL); |
||
854 | item = parse_data->current_item; |
||
855 | |||
856 | ai = bookmark_item_lookup_app_info (item, name); |
||
857 | if (!ai) |
||
858 | { |
||
859 | ai = bookmark_app_info_new (name); |
||
860 | |||
861 | if (!item->metadata) |
||
862 | item->metadata = bookmark_metadata_new (); |
||
863 | |||
864 | item->metadata->applications = g_list_prepend (item->metadata->applications, ai); |
||
865 | g_hash_table_replace (item->metadata->apps_by_name, ai->name, ai); |
||
866 | } |
||
867 | |||
868 | ai->exec = g_strdup (exec); |
||
869 | |||
870 | if (count) |
||
871 | ai->count = atoi (count); |
||
872 | else |
||
873 | ai->count = 1; |
||
874 | |||
875 | if (modified) |
||
876 | ai->stamp = timestamp_from_iso8601 (modified); |
||
877 | else |
||
878 | { |
||
879 | /* the timestamp attribute has been deprecated but we still parse |
||
880 | * it for backward compatibility |
||
881 | */ |
||
882 | if (stamp) |
||
883 | ai->stamp = (time_t) atol (stamp); |
||
884 | else |
||
885 | ai->stamp = time (NULL); |
||
886 | } |
||
887 | } |
||
888 | |||
889 | static void |
||
890 | parse_mime_type_element (GMarkupParseContext *context, |
||
891 | ParseData *parse_data, |
||
892 | const gchar **attribute_names, |
||
893 | const gchar **attribute_values, |
||
894 | GError **error) |
||
895 | { |
||
896 | const gchar *type; |
||
897 | const gchar *attr; |
||
898 | gint i; |
||
899 | BookmarkItem *item; |
||
900 | |||
901 | g_warn_if_fail ((parse_data != NULL) && (parse_data->state == STATE_MIME)); |
||
902 | |||
903 | i = 0; |
||
904 | type = NULL; |
||
905 | for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i]) |
||
906 | { |
||
907 | if (IS_ATTRIBUTE (attr, MIME_TYPE_ATTRIBUTE)) |
||
908 | type = attribute_values[i]; |
||
909 | } |
||
910 | |||
911 | if (!type) |
||
912 | type = "application/octet-stream"; |
||
913 | |||
914 | g_warn_if_fail (parse_data->current_item != NULL); |
||
915 | item = parse_data->current_item; |
||
916 | |||
917 | if (!item->metadata) |
||
918 | item->metadata = bookmark_metadata_new (); |
||
919 | |||
920 | item->metadata->mime_type = g_strdup (type); |
||
921 | } |
||
922 | |||
923 | static void |
||
924 | parse_icon_element (GMarkupParseContext *context, |
||
925 | ParseData *parse_data, |
||
926 | const gchar **attribute_names, |
||
927 | const gchar **attribute_values, |
||
928 | GError **error) |
||
929 | { |
||
930 | const gchar *href; |
||
931 | const gchar *type; |
||
932 | const gchar *attr; |
||
933 | gint i; |
||
934 | BookmarkItem *item; |
||
935 | |||
936 | g_warn_if_fail ((parse_data != NULL) && (parse_data->state == STATE_ICON)); |
||
937 | |||
938 | i = 0; |
||
939 | href = NULL; |
||
940 | type = NULL; |
||
941 | for (attr = attribute_names[i]; attr != NULL; attr = attribute_names[++i]) |
||
942 | { |
||
943 | if (IS_ATTRIBUTE (attr, BOOKMARK_HREF_ATTRIBUTE)) |
||
944 | href = attribute_values[i]; |
||
945 | else if (IS_ATTRIBUTE (attr, BOOKMARK_TYPE_ATTRIBUTE)) |
||
946 | type = attribute_values[i]; |
||
947 | } |
||
948 | |||
949 | /* the "href" attribute is mandatory */ |
||
950 | if (!href) |
||
951 | { |
||
952 | g_set_error (error, G_MARKUP_ERROR, |
||
953 | G_MARKUP_ERROR_INVALID_CONTENT, |
||
954 | _("Attribute '%s' of element '%s' not found"), |
||
955 | BOOKMARK_HREF_ATTRIBUTE, |
||
956 | BOOKMARK_ICON_ELEMENT); |
||
957 | return; |
||
958 | } |
||
959 | |||
960 | if (!type) |
||
961 | type = "application/octet-stream"; |
||
962 | |||
963 | g_warn_if_fail (parse_data->current_item != NULL); |
||
964 | item = parse_data->current_item; |
||
965 | |||
966 | if (!item->metadata) |
||
967 | item->metadata = bookmark_metadata_new (); |
||
968 | |||
969 | item->metadata->icon_href = g_strdup (href); |
||
970 | item->metadata->icon_mime = g_strdup (type); |
||
971 | } |
||
972 | |||
973 | /* scans through the attributes of an element for the "xmlns" pragma, and |
||
974 | * adds any resulting namespace declaration to a per-parser hashtable, using |
||
975 | * the namespace name as a key for the namespace URI; if no key was found, |
||
976 | * the namespace is considered as default, and stored under the "default" key. |
||
977 | * |
||
978 | * FIXME: this works on the assumption that the generator of the XBEL file |
||
979 | * is either this code or is smart enough to place the namespace declarations |
||
980 | * inside the main root node or inside the metadata node and does not redefine |
||
981 | * a namespace inside an inner node; this does *not* conform to the |
||
982 | * XML-NS standard, although is a close approximation. In order to make this |
||
983 | * conformant to the XML-NS specification we should use a per-element |
||
984 | * namespace table inside GMarkup and ask it to resolve the namespaces for us. |
||
985 | */ |
||
986 | static void |
||
987 | map_namespace_to_name (ParseData *parse_data, |
||
988 | const gchar **attribute_names, |
||
989 | const gchar **attribute_values) |
||
990 | { |
||
991 | const gchar *attr; |
||
992 | gint i; |
||
993 | |||
994 | g_warn_if_fail (parse_data != NULL); |
||
995 | |||
996 | if (!attribute_names || !attribute_names[0]) |
||
997 | return; |
||
998 | |||
999 | i = 0; |
||
1000 | for (attr = attribute_names[i]; attr; attr = attribute_names[++i]) |
||
1001 | { |
||
1002 | if (g_str_has_prefix (attr, "xmlns")) |
||
1003 | { |
||
1004 | gchar *namespace_name, *namespace_uri; |
||
1005 | gchar *p; |
||
1006 | |||
1007 | p = g_utf8_strchr (attr, -1, ':'); |
||
1008 | if (p) |
||
1009 | p = g_utf8_next_char (p); |
||
1010 | else |
||
1011 | p = "default"; |
||
1012 | |||
1013 | namespace_name = g_strdup (p); |
||
1014 | namespace_uri = g_strdup (attribute_values[i]); |
||
1015 | |||
1016 | g_hash_table_replace (parse_data->namespaces, |
||
1017 | namespace_name, |
||
1018 | namespace_uri); |
||
1019 | } |
||
1020 | } |
||
1021 | } |
||
1022 | |||
1023 | /* checks whether @element_full is equal to @element. |
||
1024 | * |
||
1025 | * if @namespace is set, it tries to resolve the namespace to a known URI, |
||
1026 | * and if found is prepended to the element name, from which is separated |
||
1027 | * using the character specified in the @sep parameter. |
||
1028 | */ |
||
1029 | static gboolean |
||
1030 | is_element_full (ParseData *parse_data, |
||
1031 | const gchar *element_full, |
||
1032 | const gchar *namespace, |
||
1033 | const gchar *element, |
||
1034 | const gchar sep) |
||
1035 | { |
||
1036 | gchar *ns_uri, *ns_name; |
||
1037 | const gchar *p, *element_name; |
||
1038 | gboolean retval; |
||
1039 | |||
1040 | g_warn_if_fail (parse_data != NULL); |
||
1041 | g_warn_if_fail (element_full != NULL); |
||
1042 | |||
1043 | if (!element) |
||
1044 | return FALSE; |
||
1045 | |||
1046 | /* no namespace requested: dumb element compare */ |
||
1047 | if (!namespace) |
||
1048 | return (0 == strcmp (element_full, element)); |
||
1049 | |||
1050 | /* search for namespace separator; if none found, assume we are under the |
||
1051 | * default namespace, and set ns_name to our "default" marker; if no default |
||
1052 | * namespace has been set, just do a plain comparison between @full_element |
||
1053 | * and @element. |
||
1054 | */ |
||
1055 | p = g_utf8_strchr (element_full, -1, ':'); |
||
1056 | if (p) |
||
1057 | { |
||
1058 | ns_name = g_strndup (element_full, p - element_full); |
||
1059 | element_name = g_utf8_next_char (p); |
||
1060 | } |
||
1061 | else |
||
1062 | { |
||
1063 | ns_name = g_strdup ("default"); |
||
1064 | element_name = element_full; |
||
1065 | } |
||
1066 | |||
1067 | ns_uri = g_hash_table_lookup (parse_data->namespaces, ns_name); |
||
1068 | if (!ns_uri) |
||
1069 | { |
||
1070 | /* no default namespace found */ |
||
1071 | g_free (ns_name); |
||
1072 | |||
1073 | return (0 == strcmp (element_full, element)); |
||
1074 | } |
||
1075 | |||
1076 | retval = (0 == strcmp (ns_uri, namespace) && |
||
1077 | |||
1078 | |||
1079 | g_free (ns_name); |
||
1080 | |||
1081 | return retval; |
||
1082 | } |
||
1083 | |||
1084 | #define IS_ELEMENT(p,s,e) (is_element_full ((p), (s), NULL, (e), '\0')) |
||
1085 | #define IS_ELEMENT_NS(p,s,n,e) (is_element_full ((p), (s), (n), (e), '|')) |
||
1086 | |||
1087 | static void |
||
1088 | start_element_raw_cb (GMarkupParseContext *context, |
||
1089 | const gchar *element_name, |
||
1090 | const gchar **attribute_names, |
||
1091 | const gchar **attribute_values, |
||
1092 | gpointer user_data, |
||
1093 | GError **error) |
||
1094 | { |
||
1095 | ParseData *parse_data = (ParseData *) user_data; |
||
1096 | |||
1097 | /* we must check for namespace declarations first |
||
1098 | * |
||
1099 | * XXX - we could speed up things by checking for namespace declarations |
||
1100 | * only on the root node, where they usually are; this would probably break |
||
1101 | * on streams not produced by us or by "smart" generators |
||
1102 | */ |
||
1103 | map_namespace_to_name (parse_data, attribute_names, attribute_values); |
||
1104 | |||
1105 | switch (parse_data->state) |
||
1106 | { |
||
1107 | case STATE_STARTED: |
||
1108 | if (IS_ELEMENT (parse_data, element_name, XBEL_ROOT_ELEMENT)) |
||
1109 | { |
||
1110 | const gchar *attr; |
||
1111 | gint i; |
||
1112 | |||
1113 | i = 0; |
||
1114 | for (attr = attribute_names[i]; attr; attr = attribute_names[++i]) |
||
1115 | { |
||
1116 | if ((IS_ATTRIBUTE (attr, XBEL_VERSION_ATTRIBUTE)) && |
||
1117 | (0 == strcmp (attribute_values[i], XBEL_VERSION))) |
||
1118 | parse_data->state = STATE_ROOT; |
||
1119 | } |
||
1120 | } |
||
1121 | else |
||
1122 | g_set_error (error, G_MARKUP_ERROR, |
||
1123 | G_MARKUP_ERROR_INVALID_CONTENT, |
||
1124 | _("Unexpected tag '%s', tag '%s' expected"), |
||
1125 | element_name, XBEL_ROOT_ELEMENT); |
||
1126 | break; |
||
1127 | case STATE_ROOT: |
||
1128 | if (IS_ELEMENT (parse_data, element_name, XBEL_TITLE_ELEMENT)) |
||
1129 | parse_data->state = STATE_TITLE; |
||
1130 | else if (IS_ELEMENT (parse_data, element_name, XBEL_DESC_ELEMENT)) |
||
1131 | parse_data->state = STATE_DESC; |
||
1132 | else if (IS_ELEMENT (parse_data, element_name, XBEL_BOOKMARK_ELEMENT)) |
||
1133 | { |
||
1134 | GError *inner_error = NULL; |
||
1135 | |||
1136 | parse_data->state = STATE_BOOKMARK; |
||
1137 | |||
1138 | parse_bookmark_element (context, |
||
1139 | parse_data, |
||
1140 | attribute_names, |
||
1141 | attribute_values, |
||
1142 | &inner_error); |
||
1143 | if (inner_error) |
||
1144 | g_propagate_error (error, inner_error); |
||
1145 | } |
||
1146 | else |
||
1147 | g_set_error (error, G_MARKUP_ERROR, |
||
1148 | G_MARKUP_ERROR_INVALID_CONTENT, |
||
1149 | _("Unexpected tag '%s' inside '%s'"), |
||
1150 | element_name, |
||
1151 | XBEL_ROOT_ELEMENT); |
||
1152 | break; |
||
1153 | case STATE_BOOKMARK: |
||
1154 | if (IS_ELEMENT (parse_data, element_name, XBEL_TITLE_ELEMENT)) |
||
1155 | parse_data->state = STATE_TITLE; |
||
1156 | else if (IS_ELEMENT (parse_data, element_name, XBEL_DESC_ELEMENT)) |
||
1157 | parse_data->state = STATE_DESC; |
||
1158 | else if (IS_ELEMENT (parse_data, element_name, XBEL_INFO_ELEMENT)) |
||
1159 | parse_data->state = STATE_INFO; |
||
1160 | else |
||
1161 | g_set_error (error, G_MARKUP_ERROR, |
||
1162 | G_MARKUP_ERROR_INVALID_CONTENT, |
||
1163 | _("Unexpected tag '%s' inside '%s'"), |
||
1164 | element_name, |
||
1165 | XBEL_BOOKMARK_ELEMENT); |
||
1166 | break; |
||
1167 | case STATE_INFO: |
||
1168 | if (IS_ELEMENT (parse_data, element_name, XBEL_METADATA_ELEMENT)) |
||
1169 | { |
||
1170 | const gchar *attr; |
||
1171 | gint i; |
||
1172 | |||
1173 | i = 0; |
||
1174 | for (attr = attribute_names[i]; attr; attr = attribute_names[++i]) |
||
1175 | { |
||
1176 | if ((IS_ATTRIBUTE (attr, XBEL_OWNER_ATTRIBUTE)) && |
||
1177 | (0 == strcmp (attribute_values[i], BOOKMARK_METADATA_OWNER))) |
||
1178 | { |
||
1179 | parse_data->state = STATE_METADATA; |
||
1180 | |||
1181 | if (!parse_data->current_item->metadata) |
||
1182 | parse_data->current_item->metadata = bookmark_metadata_new (); |
||
1183 | } |
||
1184 | } |
||
1185 | } |
||
1186 | else |
||
1187 | g_set_error (error, G_MARKUP_ERROR, |
||
1188 | G_MARKUP_ERROR_INVALID_CONTENT, |
||
1189 | _("Unexpected tag '%s', tag '%s' expected"), |
||
1190 | element_name, |
||
1191 | XBEL_METADATA_ELEMENT); |
||
1192 | break; |
||
1193 | case STATE_METADATA: |
||
1194 | if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_APPLICATIONS_ELEMENT)) |
||
1195 | parse_data->state = STATE_APPLICATIONS; |
||
1196 | else if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_GROUPS_ELEMENT)) |
||
1197 | parse_data->state = STATE_GROUPS; |
||
1198 | else if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_PRIVATE_ELEMENT)) |
||
1199 | parse_data->current_item->metadata->is_private = TRUE; |
||
1200 | else if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_ICON_ELEMENT)) |
||
1201 | { |
||
1202 | GError *inner_error = NULL; |
||
1203 | |||
1204 | parse_data->state = STATE_ICON; |
||
1205 | |||
1206 | parse_icon_element (context, |
||
1207 | parse_data, |
||
1208 | attribute_names, |
||
1209 | attribute_values, |
||
1210 | &inner_error); |
||
1211 | if (inner_error) |
||
1212 | g_propagate_error (error, inner_error); |
||
1213 | } |
||
1214 | else if (IS_ELEMENT_NS (parse_data, element_name, MIME_NAMESPACE_URI, MIME_TYPE_ELEMENT)) |
||
1215 | { |
||
1216 | GError *inner_error = NULL; |
||
1217 | |||
1218 | parse_data->state = STATE_MIME; |
||
1219 | |||
1220 | parse_mime_type_element (context, |
||
1221 | parse_data, |
||
1222 | attribute_names, |
||
1223 | attribute_values, |
||
1224 | &inner_error); |
||
1225 | if (inner_error) |
||
1226 | g_propagate_error (error, inner_error); |
||
1227 | } |
||
1228 | else |
||
1229 | g_set_error (error, G_MARKUP_ERROR, |
||
1230 | G_MARKUP_ERROR_UNKNOWN_ELEMENT, |
||
1231 | _("Unexpected tag '%s' inside '%s'"), |
||
1232 | element_name, |
||
1233 | XBEL_METADATA_ELEMENT); |
||
1234 | break; |
||
1235 | case STATE_APPLICATIONS: |
||
1236 | if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_APPLICATION_ELEMENT)) |
||
1237 | { |
||
1238 | GError *inner_error = NULL; |
||
1239 | |||
1240 | parse_data->state = STATE_APPLICATION; |
||
1241 | |||
1242 | parse_application_element (context, |
||
1243 | parse_data, |
||
1244 | attribute_names, |
||
1245 | attribute_values, |
||
1246 | &inner_error); |
||
1247 | if (inner_error) |
||
1248 | g_propagate_error (error, inner_error); |
||
1249 | } |
||
1250 | else |
||
1251 | g_set_error (error, G_MARKUP_ERROR, |
||
1252 | G_MARKUP_ERROR_INVALID_CONTENT, |
||
1253 | _("Unexpected tag '%s', tag '%s' expected"), |
||
1254 | element_name, |
||
1255 | BOOKMARK_APPLICATION_ELEMENT); |
||
1256 | break; |
||
1257 | case STATE_GROUPS: |
||
1258 | if (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_GROUP_ELEMENT)) |
||
1259 | parse_data->state = STATE_GROUP; |
||
1260 | else |
||
1261 | g_set_error (error, G_MARKUP_ERROR, |
||
1262 | G_MARKUP_ERROR_INVALID_CONTENT, |
||
1263 | _("Unexpected tag '%s', tag '%s' expected"), |
||
1264 | element_name, |
||
1265 | BOOKMARK_GROUP_ELEMENT); |
||
1266 | break; |
||
1267 | default: |
||
1268 | g_warn_if_reached (); |
||
1269 | break; |
||
1270 | } |
||
1271 | } |
||
1272 | |||
1273 | static void |
||
1274 | end_element_raw_cb (GMarkupParseContext *context, |
||
1275 | const gchar *element_name, |
||
1276 | gpointer user_data, |
||
1277 | GError **error) |
||
1278 | { |
||
1279 | ParseData *parse_data = (ParseData *) user_data; |
||
1280 | |||
1281 | if (IS_ELEMENT (parse_data, element_name, XBEL_ROOT_ELEMENT)) |
||
1282 | parse_data->state = STATE_FINISHED; |
||
1283 | else if (IS_ELEMENT (parse_data, element_name, XBEL_BOOKMARK_ELEMENT)) |
||
1284 | { |
||
1285 | parse_data->current_item = NULL; |
||
1286 | |||
1287 | parse_data->state = STATE_ROOT; |
||
1288 | } |
||
1289 | else if ((IS_ELEMENT (parse_data, element_name, XBEL_INFO_ELEMENT)) || |
||
1290 | (IS_ELEMENT (parse_data, element_name, XBEL_TITLE_ELEMENT)) || |
||
1291 | (IS_ELEMENT (parse_data, element_name, XBEL_DESC_ELEMENT))) |
||
1292 | { |
||
1293 | if (parse_data->current_item) |
||
1294 | parse_data->state = STATE_BOOKMARK; |
||
1295 | else |
||
1296 | parse_data->state = STATE_ROOT; |
||
1297 | } |
||
1298 | else if (IS_ELEMENT (parse_data, element_name, XBEL_METADATA_ELEMENT)) |
||
1299 | parse_data->state = STATE_INFO; |
||
1300 | else if (IS_ELEMENT_NS (parse_data, element_name, |
||
1301 | BOOKMARK_NAMESPACE_URI, |
||
1302 | BOOKMARK_APPLICATION_ELEMENT)) |
||
1303 | parse_data->state = STATE_APPLICATIONS; |
||
1304 | else if (IS_ELEMENT_NS (parse_data, element_name, |
||
1305 | BOOKMARK_NAMESPACE_URI, |
||
1306 | BOOKMARK_GROUP_ELEMENT)) |
||
1307 | parse_data->state = STATE_GROUPS; |
||
1308 | else if ((IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_APPLICATIONS_ELEMENT)) || |
||
1309 | (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_GROUPS_ELEMENT)) || |
||
1310 | (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_PRIVATE_ELEMENT)) || |
||
1311 | (IS_ELEMENT_NS (parse_data, element_name, BOOKMARK_NAMESPACE_URI, BOOKMARK_ICON_ELEMENT)) || |
||
1312 | (IS_ELEMENT_NS (parse_data, element_name, MIME_NAMESPACE_URI, MIME_TYPE_ELEMENT))) |
||
1313 | parse_data->state = STATE_METADATA; |
||
1314 | } |
||
1315 | |||
1316 | static void |
||
1317 | text_raw_cb (GMarkupParseContext *context, |
||
1318 | const gchar *text, |
||
1319 | gsize length, |
||
1320 | gpointer user_data, |
||
1321 | GError **error) |
||
1322 | { |
||
1323 | ParseData *parse_data = (ParseData *) user_data; |
||
1324 | gchar *payload; |
||
1325 | |||
1326 | payload = g_strndup (text, length); |
||
1327 | |||
1328 | switch (parse_data->state) |
||
1329 | { |
||
1330 | case STATE_TITLE: |
||
1331 | if (parse_data->current_item) |
||
1332 | { |
||
1333 | g_free (parse_data->current_item->title); |
||
1334 | parse_data->current_item->title = g_strdup (payload); |
||
1335 | } |
||
1336 | else |
||
1337 | { |
||
1338 | g_free (parse_data->bookmark_file->title); |
||
1339 | parse_data->bookmark_file->title = g_strdup (payload); |
||
1340 | } |
||
1341 | break; |
||
1342 | case STATE_DESC: |
||
1343 | if (parse_data->current_item) |
||
1344 | { |
||
1345 | g_free (parse_data->current_item->description); |
||
1346 | parse_data->current_item->description = g_strdup (payload); |
||
1347 | } |
||
1348 | else |
||
1349 | { |
||
1350 | g_free (parse_data->bookmark_file->description); |
||
1351 | parse_data->bookmark_file->description = g_strdup (payload); |
||
1352 | } |
||
1353 | break; |
||
1354 | case STATE_GROUP: |
||
1355 | { |
||
1356 | GList *groups; |
||
1357 | |||
1358 | g_warn_if_fail (parse_data->current_item != NULL); |
||
1359 | |||
1360 | if (!parse_data->current_item->metadata) |
||
1361 | parse_data->current_item->metadata = bookmark_metadata_new (); |
||
1362 | |||
1363 | groups = parse_data->current_item->metadata->groups; |
||
1364 | parse_data->current_item->metadata->groups = g_list_prepend (groups, g_strdup (payload)); |
||
1365 | } |
||
1366 | break; |
||
1367 | case STATE_ROOT: |
||
1368 | case STATE_BOOKMARK: |
||
1369 | case STATE_INFO: |
||
1370 | case STATE_METADATA: |
||
1371 | case STATE_APPLICATIONS: |
||
1372 | case STATE_APPLICATION: |
||
1373 | case STATE_GROUPS: |
||
1374 | case STATE_MIME: |
||
1375 | case STATE_ICON: |
||
1376 | break; |
||
1377 | default: |
||
1378 | g_warn_if_reached (); |
||
1379 | break; |
||
1380 | } |
||
1381 | |||
1382 | g_free (payload); |
||
1383 | } |
||
1384 | |||
1385 | static const GMarkupParser markup_parser = |
||
1386 | { |
||
1387 | start_element_raw_cb, /* start_element */ |
||
1388 | end_element_raw_cb, /* end_element */ |
||
1389 | text_raw_cb, /* text */ |
||
1390 | NULL, /* passthrough */ |
||
1391 | NULL |
||
1392 | }; |
||
1393 | |||
1394 | static gboolean |
||
1395 | g_bookmark_file_parse (GBookmarkFile *bookmark, |
||
1396 | const gchar *buffer, |
||
1397 | gsize length, |
||
1398 | GError **error) |
||
1399 | { |
||
1400 | GMarkupParseContext *context; |
||
1401 | ParseData *parse_data; |
||
1402 | GError *parse_error, *end_error; |
||
1403 | gboolean retval; |
||
1404 | |||
1405 | g_warn_if_fail (bookmark != NULL); |
||
1406 | |||
1407 | if (!buffer) |
||
1408 | return FALSE; |
||
1409 | |||
1410 | parse_error = NULL; |
||
1411 | end_error = NULL; |
||
1412 | |||
1413 | if (length == (gsize) -1) |
||
1414 | length = strlen (buffer); |
||
1415 | |||
1416 | parse_data = parse_data_new (); |
||
1417 | parse_data->bookmark_file = bookmark; |
||
1418 | |||
1419 | context = g_markup_parse_context_new (&markup_parser, |
||
1420 | 0, |
||
1421 | parse_data, |
||
1422 | (GDestroyNotify) parse_data_free); |
||
1423 | |||
1424 | retval = g_markup_parse_context_parse (context, |
||
1425 | buffer, |
||
1426 | length, |
||
1427 | &parse_error); |
||
1428 | if (!retval) |
||
1429 | g_propagate_error (error, parse_error); |
||
1430 | else |
||
1431 | { |
||
1432 | retval = g_markup_parse_context_end_parse (context, &end_error); |
||
1433 | if (!retval) |
||
1434 | g_propagate_error (error, end_error); |
||
1435 | } |
||
1436 | |||
1437 | g_markup_parse_context_free (context); |
||
1438 | |||
1439 | return retval; |
||
1440 | } |
||
1441 | |||
1442 | static gchar * |
||
1443 | g_bookmark_file_dump (GBookmarkFile *bookmark, |
||
1444 | gsize *length, |
||
1445 | GError **error) |
||
1446 | { |
||
1447 | GString *retval; |
||
1448 | gchar *buffer; |
||
1449 | GList *l; |
||
1450 | |||
1451 | retval = g_string_sized_new (4096); |
||
1452 | |||
1453 | g_string_append (retval, |
||
1454 | "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" |
||
1455 | #if 0 |
||
1456 | /* XXX - do we really need the doctype? */ |
||
1457 | "<!DOCTYPE " XBEL_DTD_NICK "\n" |
||
1458 | " PUBLIC \"" XBEL_DTD_SYSTEM "\"\n" |
||
1459 | " \"" XBEL_DTD_URI "\">\n" |
||
1460 | #endif |
||
1461 | "<" XBEL_ROOT_ELEMENT " " XBEL_VERSION_ATTRIBUTE "=\"" XBEL_VERSION "\"\n" |
||
1462 | " xmlns:" BOOKMARK_NAMESPACE_NAME "=\"" BOOKMARK_NAMESPACE_URI "\"\n" |
||
1463 | " xmlns:" MIME_NAMESPACE_NAME "=\"" MIME_NAMESPACE_URI "\"\n>"); |
||
1464 | |||
1465 | if (bookmark->title) |
||
1466 | { |
||
1467 | gchar *escaped_title; |
||
1468 | |||
1469 | escaped_title = g_markup_escape_text (bookmark->title, -1); |
||
1470 | |||
1471 | buffer = g_strconcat (" " |
||
1472 | "<" XBEL_TITLE_ELEMENT ">", |
||
1473 | escaped_title, |
||
1474 | "</" XBEL_TITLE_ELEMENT ">\n", NULL); |
||
1475 | |||
1476 | g_string_append (retval, buffer); |
||
1477 | |||
1478 | g_free (buffer); |
||
1479 | g_free (escaped_title); |
||
1480 | } |
||
1481 | |||
1482 | if (bookmark->description) |
||
1483 | { |
||
1484 | gchar *escaped_desc; |
||
1485 | |||
1486 | escaped_desc = g_markup_escape_text (bookmark->description, -1); |
||
1487 | |||
1488 | buffer = g_strconcat (" " |
||
1489 | "<" XBEL_DESC_ELEMENT ">", |
||
1490 | escaped_desc, |
||
1491 | "</" XBEL_DESC_ELEMENT ">\n", NULL); |
||
1492 | g_string_append (retval, buffer); |
||
1493 | |||
1494 | g_free (buffer); |
||
1495 | g_free (escaped_desc); |
||
1496 | } |
||
1497 | |||
1498 | if (!bookmark->items) |
||
1499 | goto out; |
||
1500 | else |
||
1501 | retval = g_string_append (retval, "\n"); |
||
1502 | |||
1503 | /* the items are stored in reverse order */ |
||
1504 | for (l = g_list_last (bookmark->items); |
||
1505 | l != NULL; |
||
1506 | l = l->prev) |
||
1507 | { |
||
1508 | BookmarkItem *item = (BookmarkItem *) l->data; |
||
1509 | gchar *item_dump; |
||
1510 | |||
1511 | item_dump = bookmark_item_dump (item); |
||
1512 | if (!item_dump) |
||
1513 | continue; |
||
1514 | |||
1515 | retval = g_string_append (retval, item_dump); |
||
1516 | |||
1517 | g_free (item_dump); |
||
1518 | } |
||
1519 | |||
1520 | out: |
||
1521 | g_string_append (retval, "</" XBEL_ROOT_ELEMENT ">"); |
||
1522 | |||
1523 | if (length) |
||
1524 | *length = retval->len; |
||
1525 | |||
1526 | return g_string_free (retval, FALSE); |
||
1527 | } |
||
1528 | |||
1529 | /************** |
||
1530 | * Misc * |
||
1531 | **************/ |
||
1532 | |||
1533 | /* converts a Unix timestamp in a ISO 8601 compliant string; you |
||
1534 | * should free the returned string. |
||
1535 | */ |
||
1536 | static gchar * |
||
1537 | timestamp_to_iso8601 (time_t timestamp) |
||
1538 | { |
||
1539 | GTimeVal stamp; |
||
1540 | |||
1541 | if (timestamp == (time_t) -1) |
||
1542 | g_get_current_time (&stamp); |
||
1543 | else |
||
1544 | { |
||
1545 | stamp.tv_sec = timestamp; |
||
1546 | stamp.tv_usec = 0; |
||
1547 | } |
||
1548 | |||
1549 | return g_time_val_to_iso8601 (&stamp); |
||
1550 | } |
||
1551 | |||
1552 | static time_t |
||
1553 | timestamp_from_iso8601 (const gchar *iso_date) |
||
1554 | { |
||
1555 | GTimeVal stamp; |
||
1556 | |||
1557 | if (!g_time_val_from_iso8601 (iso_date, &stamp)) |
||
1558 | return (time_t) -1; |
||
1559 | |||
1560 | return (time_t) stamp.tv_sec; |
||
1561 | } |
||
1562 | |||
1563 | G_DEFINE_QUARK (g-bookmark-file-error-quark, g_bookmark_file_error) |
||
1564 | |||
1565 | /******************** |
||
1566 | * Public API * |
||
1567 | ********************/ |
||
1568 | |||
1569 | /** |
||
1570 | * g_bookmark_file_new: |
||
1571 | * |
||
1572 | * Creates a new empty #GBookmarkFile object. |
||
1573 | * |
||
1574 | * Use g_bookmark_file_load_from_file(), g_bookmark_file_load_from_data() |
||
1575 | * or g_bookmark_file_load_from_data_dirs() to read an existing bookmark |
||
1576 | * file. |
||
1577 | * |
||
1578 | * Returns: an empty #GBookmarkFile |
||
1579 | * |
||
1580 | * Since: 2.12 |
||
1581 | */ |
||
1582 | GBookmarkFile * |
||
1583 | g_bookmark_file_new (void) |
||
1584 | { |
||
1585 | GBookmarkFile *bookmark; |
||
1586 | |||
1587 | bookmark = g_new (GBookmarkFile, 1); |
||
1588 | |||
1589 | g_bookmark_file_init (bookmark); |
||
1590 | |||
1591 | return bookmark; |
||
1592 | } |
||
1593 | |||
1594 | /** |
||
1595 | * g_bookmark_file_free: |
||
1596 | * @bookmark: a #GBookmarkFile |
||
1597 | * |
||
1598 | * Frees a #GBookmarkFile. |
||
1599 | * |
||
1600 | * Since: 2.12 |
||
1601 | */ |
||
1602 | void |
||
1603 | g_bookmark_file_free (GBookmarkFile *bookmark) |
||
1604 | { |
||
1605 | if (!bookmark) |
||
1606 | return; |
||
1607 | |||
1608 | g_bookmark_file_clear (bookmark); |
||
1609 | |||
1610 | g_free (bookmark); |
||
1611 | } |
||
1612 | |||
1613 | /** |
||
1614 | * g_bookmark_file_load_from_data: |
||
1615 | * @bookmark: an empty #GBookmarkFile struct |
||
1616 | * @data: desktop bookmarks loaded in memory |
||
1617 | * @length: the length of @data in bytes |
||
1618 | * @error: return location for a #GError, or %NULL |
||
1619 | * |
||
1620 | * Loads a bookmark file from memory into an empty #GBookmarkFile |
||
1621 | * structure. If the object cannot be created then @error is set to a |
||
1622 | * #GBookmarkFileError. |
||
1623 | * |
||
1624 | * Returns: %TRUE if a desktop bookmark could be loaded. |
||
1625 | * |
||
1626 | * Since: 2.12 |
||
1627 | */ |
||
1628 | gboolean |
||
1629 | g_bookmark_file_load_from_data (GBookmarkFile *bookmark, |
||
1630 | const gchar *data, |
||
1631 | gsize length, |
||
1632 | GError **error) |
||
1633 | { |
||
1634 | GError *parse_error; |
||
1635 | gboolean retval; |
||
1636 | |||
1637 | g_return_val_if_fail (bookmark != NULL, FALSE); |
||
1638 | |||
1639 | if (length == (gsize) -1) |
||
1640 | length = strlen (data); |
||
1641 | |||
1642 | if (bookmark->items) |
||
1643 | { |
||
1644 | g_bookmark_file_clear (bookmark); |
||
1645 | g_bookmark_file_init (bookmark); |
||
1646 | } |
||
1647 | |||
1648 | parse_error = NULL; |
||
1649 | retval = g_bookmark_file_parse (bookmark, data, length, &parse_error); |
||
1650 | |||
1651 | if (!retval) |
||
1652 | g_propagate_error (error, parse_error); |
||
1653 | |||
1654 | return retval; |
||
1655 | } |
||
1656 | |||
1657 | /** |
||
1658 | * g_bookmark_file_load_from_file: |
||
1659 | * @bookmark: an empty #GBookmarkFile struct |
||
1660 | * @filename: the path of a filename to load, in the GLib file name encoding |
||
1661 | * @error: return location for a #GError, or %NULL |
||
1662 | * |
||
1663 | * Loads a desktop bookmark file into an empty #GBookmarkFile structure. |
||
1664 | * If the file could not be loaded then @error is set to either a #GFileError |
||
1665 | * or #GBookmarkFileError. |
||
1666 | * |
||
1667 | * Returns: %TRUE if a desktop bookmark file could be loaded |
||
1668 | * |
||
1669 | * Since: 2.12 |
||
1670 | */ |
||
1671 | gboolean |
||
1672 | g_bookmark_file_load_from_file (GBookmarkFile *bookmark, |
||
1673 | const gchar *filename, |
||
1674 | GError **error) |
||
1675 | { |
||
1676 | gboolean ret = FALSE; |
||
1677 | gchar *buffer = NULL; |
||
1678 | gsize len; |
||
1679 | |||
1680 | g_return_val_if_fail (bookmark != NULL, FALSE); |
||
1681 | g_return_val_if_fail (filename != NULL, FALSE); |
||
1682 | |||
1683 | if (!g_file_get_contents (filename, &buffer, &len, error)) |
||
1684 | goto out; |
||
1685 | |||
1686 | if (!g_bookmark_file_load_from_data (bookmark, buffer, len, error)) |
||
1687 | goto out; |
||
1688 | |||
1689 | ret = TRUE; |
||
1690 | out: |
||
1691 | g_free (buffer); |
||
1692 | return ret; |
||
1693 | } |
||
1694 | |||
1695 | |||
1696 | /* Iterates through all the directories in *dirs trying to |
||
1697 | * find file. When it successfully locates file, returns a |
||
1698 | * string its absolute path. It also leaves the unchecked |
||
1699 | * directories in *dirs. You should free the returned string |
||
1700 | * |
||
1701 | * Adapted from gkeyfile.c |
||
1702 | */ |
||
1703 | static gchar * |
||
1704 | find_file_in_data_dirs (const gchar *file, |
||
1705 | gchar ***dirs, |
||
1706 | GError **error) |
||
1707 | { |
||
1708 | gchar **data_dirs, *data_dir, *path; |
||
1709 | |||
1710 | path = NULL; |
||
1711 | |||
1712 | if (dirs == NULL) |
||
1713 | return NULL; |
||
1714 | |||
1715 | data_dirs = *dirs; |
||
1716 | path = NULL; |
||
1717 | while (data_dirs && (data_dir = *data_dirs) && !path) |
||
1718 | { |
||
1719 | gchar *candidate_file, *sub_dir; |
||
1720 | |||
1721 | candidate_file = (gchar *) file; |
||
1722 | sub_dir = g_strdup (""); |
||
1723 | while (candidate_file != NULL && !path) |
||
1724 | { |
||
1725 | gchar *p; |
||
1726 | |||
1727 | path = g_build_filename (data_dir, sub_dir, |
||
1728 | candidate_file, NULL); |
||
1729 | |||
1730 | candidate_file = strchr (candidate_file, '-'); |
||
1731 | |||
1732 | if (candidate_file == NULL) |
||
1733 | break; |
||
1734 | |||
1735 | candidate_file++; |
||
1736 | |||
1737 | g_free (sub_dir); |
||
1738 | sub_dir = g_strndup (file, candidate_file - file - 1); |
||
1739 | |||
1740 | for (p = sub_dir; *p != '\0'; p++) |
||
1741 | { |
||
1742 | if (*p == '-') |
||
1743 | *p = G_DIR_SEPARATOR; |
||
1744 | } |
||
1745 | } |
||
1746 | g_free (sub_dir); |
||
1747 | data_dirs++; |
||
1748 | } |
||
1749 | |||
1750 | *dirs = data_dirs; |
||
1751 | |||
1752 | if (!path) |
||
1753 | { |
||
1754 | g_set_error_literal (error, G_BOOKMARK_FILE_ERROR, |
||
1755 | G_BOOKMARK_FILE_ERROR_FILE_NOT_FOUND, |
||
1756 | _("No valid bookmark file found in data dirs")); |
||
1757 | |||
1758 | return NULL; |
||
1759 | } |
||
1760 | |||
1761 | return path; |
||
1762 | } |
||
1763 | |||
1764 | |||
1765 | /** |
||
1766 | * g_bookmark_file_load_from_data_dirs: |
||
1767 | * @bookmark: a #GBookmarkFile |
||
1768 | * @file: a relative path to a filename to open and parse |
||
1769 | * @full_path: (allow-none): return location for a string containing the full path |
||
1770 | * of the file, or %NULL |
||
1771 | * @error: return location for a #GError, or %NULL |
||
1772 | * |
||
1773 | * This function looks for a desktop bookmark file named @file in the |
||
1774 | * paths returned from g_get_user_data_dir() and g_get_system_data_dirs(), |
||
1775 | * loads the file into @bookmark and returns the file's full path in |
||
1776 | * @full_path. If the file could not be loaded then an %error is |
||
1777 | * set to either a #GFileError or #GBookmarkFileError. |
||
1778 | * |
||
1779 | * Returns: %TRUE if a key file could be loaded, %FALSE otherwise |
||
1780 | * |
||
1781 | * Since: 2.12 |
||
1782 | */ |
||
1783 | gboolean |
||
1784 | g_bookmark_file_load_from_data_dirs (GBookmarkFile *bookmark, |
||
1785 | const gchar *file, |
||
1786 | gchar **full_path, |
||
1787 | GError **error) |
||
1788 | { |
||
1789 | GError *file_error = NULL; |
||
1790 | gchar **all_data_dirs, **data_dirs; |
||
1791 | const gchar *user_data_dir; |
||
1792 | const gchar * const * system_data_dirs; |
||
1793 | gsize i, j; |
||
1794 | gchar *output_path; |
||
1795 | gboolean found_file; |
||
1796 | |||
1797 | g_return_val_if_fail (bookmark != NULL, FALSE); |
||
1798 | g_return_val_if_fail (!g_path_is_absolute (file), FALSE); |
||
1799 | |||
1800 | user_data_dir = g_get_user_data_dir (); |
||
1801 | system_data_dirs = g_get_system_data_dirs (); |
||
1802 | all_data_dirs = g_new0 (gchar *, g_strv_length ((gchar **)system_data_dirs) + 2); |
||
1803 | |||
1804 | i = 0; |
||
1805 | all_data_dirs[i++] = g_strdup (user_data_dir); |
||
1806 | |||
1807 | j = 0; |
||
1808 | while (system_data_dirs[j] != NULL) |
||
1809 | all_data_dirs[i++] = g_strdup (system_data_dirs[j++]); |
||
1810 | |||
1811 | found_file = FALSE; |
||
1812 | data_dirs = all_data_dirs; |
||
1813 | output_path = NULL; |
||
1814 | while (*data_dirs != NULL && !found_file) |
||
1815 | { |
||
1816 | g_free (output_path); |
||
1817 | |||
1818 | output_path = find_file_in_data_dirs (file, &data_dirs, &file_error); |
||
1819 | |||
1820 | if (file_error) |
||
1821 | { |
||
1822 | g_propagate_error (error, file_error); |
||
1823 | break; |
||
1824 | } |
||
1825 | |||
1826 | found_file = g_bookmark_file_load_from_file (bookmark, |
||
1827 | output_path, |
||
1828 | &file_error); |
||
1829 | if (file_error) |
||
1830 | { |
||
1831 | g_propagate_error (error, file_error); |
||
1832 | break; |
||
1833 | } |
||
1834 | } |
||
1835 | |||
1836 | if (found_file && full_path) |
||
1837 | *full_path = output_path; |
||
1838 | else |
||
1839 | g_free (output_path); |
||
1840 | |||
1841 | g_strfreev (all_data_dirs); |
||
1842 | |||
1843 | return found_file; |
||
1844 | } |
||
1845 | |||
1846 | |||
1847 | /** |
||
1848 | * g_bookmark_file_to_data: |
||
1849 | * @bookmark: a #GBookmarkFile |
||
1850 | * @length: (allow-none) (out): return location for the length of the returned string, or %NULL |
||
1851 | * @error: return location for a #GError, or %NULL |
||
1852 | * |
||
1853 | * This function outputs @bookmark as a string. |
||
1854 | * |
||
1855 | * Returns: a newly allocated string holding |
||
1856 | * the contents of the #GBookmarkFile |
||
1857 | * |
||
1858 | * Since: 2.12 |
||
1859 | */ |
||
1860 | gchar * |
||
1861 | g_bookmark_file_to_data (GBookmarkFile *bookmark, |
||
1862 | gsize *length, |
||
1863 | GError **error) |
||
1864 | { |
||
1865 | GError *write_error = NULL; |
||
1866 | gchar *retval; |
||
1867 | |||
1868 | g_return_val_if_fail (bookmark != NULL, NULL); |
||
1869 | |||
1870 | retval = g_bookmark_file_dump (bookmark, length, &write_error); |
||
1871 | if (write_error) |
||
1872 | { |
||
1873 | g_propagate_error (error, write_error); |
||
1874 | |||
1875 | return NULL; |
||
1876 | } |
||
1877 | |||
1878 | return retval; |
||
1879 | } |
||
1880 | |||
1881 | /** |
||
1882 | * g_bookmark_file_to_file: |
||
1883 | * @bookmark: a #GBookmarkFile |
||
1884 | * @filename: path of the output file |
||
1885 | * @error: return location for a #GError, or %NULL |
||
1886 | * |
||
1887 | * This function outputs @bookmark into a file. The write process is |
||
1888 | * guaranteed to be atomic by using g_file_set_contents() internally. |
||
1889 | * |
||
1890 | * Returns: %TRUE if the file was successfully written. |
||
1891 | * |
||
1892 | * Since: 2.12 |
||
1893 | */ |
||
1894 | gboolean |
||
1895 | g_bookmark_file_to_file (GBookmarkFile *bookmark, |
||
1896 | const gchar *filename, |
||
1897 | GError **error) |
||
1898 | { |
||
1899 | gchar *data; |
||
1900 | GError *data_error, *write_error; |
||
1901 | gsize len; |
||
1902 | gboolean retval; |
||
1903 | |||
1904 | g_return_val_if_fail (bookmark != NULL, FALSE); |
||
1905 | g_return_val_if_fail (filename != NULL, FALSE); |
||
1906 | |||
1907 | data_error = NULL; |
||
1908 | data = g_bookmark_file_to_data (bookmark, &len, &data_error); |
||
1909 | if (data_error) |
||
1910 | { |
||
1911 | g_propagate_error (error, data_error); |
||
1912 | |||
1913 | return FALSE; |
||
1914 | } |
||
1915 | |||
1916 | write_error = NULL; |
||
1917 | g_file_set_contents (filename, data, len, &write_error); |
||
1918 | if (write_error) |
||
1919 | { |
||
1920 | g_propagate_error (error, write_error); |
||
1921 | |||
1922 | retval = FALSE; |
||
1923 | } |
||
1924 | else |
||
1925 | retval = TRUE; |
||
1926 | |||
1927 | g_free (data); |
||
1928 | |||
1929 | return retval; |
||
1930 | } |
||
1931 | |||
1932 | static BookmarkItem * |
||
1933 | g_bookmark_file_lookup_item (GBookmarkFile *bookmark, |
||
1934 | const gchar *uri) |
||
1935 | { |
||
1936 | g_warn_if_fail (bookmark != NULL && uri != NULL); |
||
1937 | |||
1938 | return g_hash_table_lookup (bookmark->items_by_uri, uri); |
||
1939 | } |
||
1940 | |||
1941 | /* this function adds a new item to the list */ |
||
1942 | static void |
||
1943 | g_bookmark_file_add_item (GBookmarkFile *bookmark, |
||
1944 | BookmarkItem *item, |
||
1945 | GError **error) |
||
1946 | { |
||
1947 | g_warn_if_fail (bookmark != NULL); |
||
1948 | g_warn_if_fail (item != NULL); |
||
1949 | |||
1950 | /* this should never happen; and if it does, then we are |
||
1951 | * screwing up something big time. |
||
1952 | */ |
||
1953 | if (G_UNLIKELY (g_bookmark_file_has_item (bookmark, item->uri))) |
||
1954 | { |
||
1955 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
1956 | G_BOOKMARK_FILE_ERROR_INVALID_URI, |
||
1957 | _("A bookmark for URI '%s' already exists"), |
||
1958 | item->uri); |
||
1959 | return; |
||
1960 | } |
||
1961 | |||
1962 | bookmark->items = g_list_prepend (bookmark->items, item); |
||
1963 | |||
1964 | g_hash_table_replace (bookmark->items_by_uri, |
||
1965 | item->uri, |
||
1966 | item); |
||
1967 | |||
1968 | if (item->added == (time_t) -1) |
||
1969 | item->added = time (NULL); |
||
1970 | |||
1971 | if (item->modified == (time_t) -1) |
||
1972 | item->modified = time (NULL); |
||
1973 | } |
||
1974 | |||
1975 | /** |
||
1976 | * g_bookmark_file_remove_item: |
||
1977 | * @bookmark: a #GBookmarkFile |
||
1978 | * @uri: a valid URI |
||
1979 | * @error: return location for a #GError, or %NULL |
||
1980 | * |
||
1981 | * Removes the bookmark for @uri from the bookmark file @bookmark. |
||
1982 | * |
||
1983 | * Returns: %TRUE if the bookmark was removed successfully. |
||
1984 | * |
||
1985 | * Since: 2.12 |
||
1986 | */ |
||
1987 | gboolean |
||
1988 | g_bookmark_file_remove_item (GBookmarkFile *bookmark, |
||
1989 | const gchar *uri, |
||
1990 | GError **error) |
||
1991 | { |
||
1992 | BookmarkItem *item; |
||
1993 | |||
1994 | g_return_val_if_fail (bookmark != NULL, FALSE); |
||
1995 | g_return_val_if_fail (uri != NULL, FALSE); |
||
1996 | |||
1997 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
1998 | |||
1999 | if (!item) |
||
2000 | { |
||
2001 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
2002 | G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND, |
||
2003 | _("No bookmark found for URI '%s'"), |
||
2004 | uri); |
||
2005 | return FALSE; |
||
2006 | } |
||
2007 | |||
2008 | bookmark->items = g_list_remove (bookmark->items, item); |
||
2009 | g_hash_table_remove (bookmark->items_by_uri, item->uri); |
||
2010 | |||
2011 | bookmark_item_free (item); |
||
2012 | |||
2013 | return TRUE; |
||
2014 | } |
||
2015 | |||
2016 | /** |
||
2017 | * g_bookmark_file_has_item: |
||
2018 | * @bookmark: a #GBookmarkFile |
||
2019 | * @uri: a valid URI |
||
2020 | * |
||
2021 | * Looks whether the desktop bookmark has an item with its URI set to @uri. |
||
2022 | * |
||
2023 | * Returns: %TRUE if @uri is inside @bookmark, %FALSE otherwise |
||
2024 | * |
||
2025 | * Since: 2.12 |
||
2026 | */ |
||
2027 | gboolean |
||
2028 | g_bookmark_file_has_item (GBookmarkFile *bookmark, |
||
2029 | const gchar *uri) |
||
2030 | { |
||
2031 | g_return_val_if_fail (bookmark != NULL, FALSE); |
||
2032 | g_return_val_if_fail (uri != NULL, FALSE); |
||
2033 | |||
2034 | return (NULL != g_hash_table_lookup (bookmark->items_by_uri, uri)); |
||
2035 | } |
||
2036 | |||
2037 | /** |
||
2038 | * g_bookmark_file_get_uris: |
||
2039 | * @bookmark: a #GBookmarkFile |
||
2040 | * @length: (allow-none) (out): return location for the number of returned URIs, or %NULL |
||
2041 | * |
||
2042 | * Returns all URIs of the bookmarks in the bookmark file @bookmark. |
||
2043 | * The array of returned URIs will be %NULL-terminated, so @length may |
||
2044 | * optionally be %NULL. |
||
2045 | * |
||
2046 | * Returns: (array length=length) (transfer full): a newly allocated %NULL-terminated array of strings. |
||
2047 | * Use g_strfreev() to free it. |
||
2048 | * |
||
2049 | * Since: 2.12 |
||
2050 | */ |
||
2051 | gchar ** |
||
2052 | g_bookmark_file_get_uris (GBookmarkFile *bookmark, |
||
2053 | gsize *length) |
||
2054 | { |
||
2055 | GList *l; |
||
2056 | gchar **uris; |
||
2057 | gsize i, n_items; |
||
2058 | |||
2059 | g_return_val_if_fail (bookmark != NULL, NULL); |
||
2060 | |||
2061 | n_items = g_list_length (bookmark->items); |
||
2062 | uris = g_new0 (gchar *, n_items + 1); |
||
2063 | |||
2064 | /* the items are stored in reverse order, so we walk the list backward */ |
||
2065 | for (l = g_list_last (bookmark->items), i = 0; l != NULL; l = l->prev) |
||
2066 | { |
||
2067 | BookmarkItem *item = (BookmarkItem *) l->data; |
||
2068 | |||
2069 | g_warn_if_fail (item != NULL); |
||
2070 | |||
2071 | uris[i++] = g_strdup (item->uri); |
||
2072 | } |
||
2073 | uris[i] = NULL; |
||
2074 | |||
2075 | if (length) |
||
2076 | *length = i; |
||
2077 | |||
2078 | return uris; |
||
2079 | } |
||
2080 | |||
2081 | /** |
||
2082 | * g_bookmark_file_set_title: |
||
2083 | * @bookmark: a #GBookmarkFile |
||
2084 | * @uri: (allow-none): a valid URI or %NULL |
||
2085 | * @title: a UTF-8 encoded string |
||
2086 | * |
||
2087 | * Sets @title as the title of the bookmark for @uri inside the |
||
2088 | * bookmark file @bookmark. |
||
2089 | * |
||
2090 | * If @uri is %NULL, the title of @bookmark is set. |
||
2091 | * |
||
2092 | * If a bookmark for @uri cannot be found then it is created. |
||
2093 | * |
||
2094 | * Since: 2.12 |
||
2095 | */ |
||
2096 | void |
||
2097 | g_bookmark_file_set_title (GBookmarkFile *bookmark, |
||
2098 | const gchar *uri, |
||
2099 | const gchar *title) |
||
2100 | { |
||
2101 | g_return_if_fail (bookmark != NULL); |
||
2102 | |||
2103 | if (!uri) |
||
2104 | { |
||
2105 | g_free (bookmark->title); |
||
2106 | bookmark->title = g_strdup (title); |
||
2107 | } |
||
2108 | else |
||
2109 | { |
||
2110 | BookmarkItem *item; |
||
2111 | |||
2112 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2113 | if (!item) |
||
2114 | { |
||
2115 | item = bookmark_item_new (uri); |
||
2116 | g_bookmark_file_add_item (bookmark, item, NULL); |
||
2117 | } |
||
2118 | |||
2119 | g_free (item->title); |
||
2120 | item->title = g_strdup (title); |
||
2121 | |||
2122 | item->modified = time (NULL); |
||
2123 | } |
||
2124 | } |
||
2125 | |||
2126 | /** |
||
2127 | * g_bookmark_file_get_title: |
||
2128 | * @bookmark: a #GBookmarkFile |
||
2129 | * @uri: (allow-none): a valid URI or %NULL |
||
2130 | * @error: return location for a #GError, or %NULL |
||
2131 | * |
||
2132 | * Returns the title of the bookmark for @uri. |
||
2133 | * |
||
2134 | * If @uri is %NULL, the title of @bookmark is returned. |
||
2135 | * |
||
2136 | * In the event the URI cannot be found, %NULL is returned and |
||
2137 | * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. |
||
2138 | * |
||
2139 | * Returns: a newly allocated string or %NULL if the specified |
||
2140 | * URI cannot be found. |
||
2141 | * |
||
2142 | * Since: 2.12 |
||
2143 | */ |
||
2144 | gchar * |
||
2145 | g_bookmark_file_get_title (GBookmarkFile *bookmark, |
||
2146 | const gchar *uri, |
||
2147 | GError **error) |
||
2148 | { |
||
2149 | BookmarkItem *item; |
||
2150 | |||
2151 | g_return_val_if_fail (bookmark != NULL, NULL); |
||
2152 | |||
2153 | if (!uri) |
||
2154 | return g_strdup (bookmark->title); |
||
2155 | |||
2156 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2157 | if (!item) |
||
2158 | { |
||
2159 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
2160 | G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND, |
||
2161 | _("No bookmark found for URI '%s'"), |
||
2162 | uri); |
||
2163 | return NULL; |
||
2164 | } |
||
2165 | |||
2166 | return g_strdup (item->title); |
||
2167 | } |
||
2168 | |||
2169 | /** |
||
2170 | * g_bookmark_file_set_description: |
||
2171 | * @bookmark: a #GBookmarkFile |
||
2172 | * @uri: (allow-none): a valid URI or %NULL |
||
2173 | * @description: a string |
||
2174 | * |
||
2175 | * Sets @description as the description of the bookmark for @uri. |
||
2176 | * |
||
2177 | * If @uri is %NULL, the description of @bookmark is set. |
||
2178 | * |
||
2179 | * If a bookmark for @uri cannot be found then it is created. |
||
2180 | * |
||
2181 | * Since: 2.12 |
||
2182 | */ |
||
2183 | void |
||
2184 | g_bookmark_file_set_description (GBookmarkFile *bookmark, |
||
2185 | const gchar *uri, |
||
2186 | const gchar *description) |
||
2187 | { |
||
2188 | g_return_if_fail (bookmark != NULL); |
||
2189 | |||
2190 | if (!uri) |
||
2191 | { |
||
2192 | g_free (bookmark->description); |
||
2193 | bookmark->description = g_strdup (description); |
||
2194 | } |
||
2195 | else |
||
2196 | { |
||
2197 | BookmarkItem *item; |
||
2198 | |||
2199 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2200 | if (!item) |
||
2201 | { |
||
2202 | item = bookmark_item_new (uri); |
||
2203 | g_bookmark_file_add_item (bookmark, item, NULL); |
||
2204 | } |
||
2205 | |||
2206 | g_free (item->description); |
||
2207 | item->description = g_strdup (description); |
||
2208 | |||
2209 | item->modified = time (NULL); |
||
2210 | } |
||
2211 | } |
||
2212 | |||
2213 | /** |
||
2214 | * g_bookmark_file_get_description: |
||
2215 | * @bookmark: a #GBookmarkFile |
||
2216 | * @uri: a valid URI |
||
2217 | * @error: return location for a #GError, or %NULL |
||
2218 | * |
||
2219 | * Retrieves the description of the bookmark for @uri. |
||
2220 | * |
||
2221 | * In the event the URI cannot be found, %NULL is returned and |
||
2222 | * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. |
||
2223 | * |
||
2224 | * Returns: a newly allocated string or %NULL if the specified |
||
2225 | * URI cannot be found. |
||
2226 | * |
||
2227 | * Since: 2.12 |
||
2228 | */ |
||
2229 | gchar * |
||
2230 | g_bookmark_file_get_description (GBookmarkFile *bookmark, |
||
2231 | const gchar *uri, |
||
2232 | GError **error) |
||
2233 | { |
||
2234 | BookmarkItem *item; |
||
2235 | |||
2236 | g_return_val_if_fail (bookmark != NULL, NULL); |
||
2237 | |||
2238 | if (!uri) |
||
2239 | return g_strdup (bookmark->description); |
||
2240 | |||
2241 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2242 | if (!item) |
||
2243 | { |
||
2244 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
2245 | G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND, |
||
2246 | _("No bookmark found for URI '%s'"), |
||
2247 | uri); |
||
2248 | return NULL; |
||
2249 | } |
||
2250 | |||
2251 | return g_strdup (item->description); |
||
2252 | } |
||
2253 | |||
2254 | /** |
||
2255 | * g_bookmark_file_set_mime_type: |
||
2256 | * @bookmark: a #GBookmarkFile |
||
2257 | * @uri: a valid URI |
||
2258 | * @mime_type: a MIME type |
||
2259 | * |
||
2260 | * Sets @mime_type as the MIME type of the bookmark for @uri. |
||
2261 | * |
||
2262 | * If a bookmark for @uri cannot be found then it is created. |
||
2263 | * |
||
2264 | * Since: 2.12 |
||
2265 | */ |
||
2266 | void |
||
2267 | g_bookmark_file_set_mime_type (GBookmarkFile *bookmark, |
||
2268 | const gchar *uri, |
||
2269 | const gchar *mime_type) |
||
2270 | { |
||
2271 | BookmarkItem *item; |
||
2272 | |||
2273 | g_return_if_fail (bookmark != NULL); |
||
2274 | g_return_if_fail (uri != NULL); |
||
2275 | g_return_if_fail (mime_type != NULL); |
||
2276 | |||
2277 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2278 | if (!item) |
||
2279 | { |
||
2280 | item = bookmark_item_new (uri); |
||
2281 | g_bookmark_file_add_item (bookmark, item, NULL); |
||
2282 | } |
||
2283 | |||
2284 | if (!item->metadata) |
||
2285 | item->metadata = bookmark_metadata_new (); |
||
2286 | |||
2287 | g_free (item->metadata->mime_type); |
||
2288 | |||
2289 | item->metadata->mime_type = g_strdup (mime_type); |
||
2290 | item->modified = time (NULL); |
||
2291 | } |
||
2292 | |||
2293 | /** |
||
2294 | * g_bookmark_file_get_mime_type: |
||
2295 | * @bookmark: a #GBookmarkFile |
||
2296 | * @uri: a valid URI |
||
2297 | * @error: return location for a #GError, or %NULL |
||
2298 | * |
||
2299 | * Retrieves the MIME type of the resource pointed by @uri. |
||
2300 | * |
||
2301 | * In the event the URI cannot be found, %NULL is returned and |
||
2302 | * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the |
||
2303 | * event that the MIME type cannot be found, %NULL is returned and |
||
2304 | * @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE. |
||
2305 | * |
||
2306 | * Returns: a newly allocated string or %NULL if the specified |
||
2307 | * URI cannot be found. |
||
2308 | * |
||
2309 | * Since: 2.12 |
||
2310 | */ |
||
2311 | gchar * |
||
2312 | g_bookmark_file_get_mime_type (GBookmarkFile *bookmark, |
||
2313 | const gchar *uri, |
||
2314 | GError **error) |
||
2315 | { |
||
2316 | BookmarkItem *item; |
||
2317 | |||
2318 | g_return_val_if_fail (bookmark != NULL, NULL); |
||
2319 | g_return_val_if_fail (uri != NULL, NULL); |
||
2320 | |||
2321 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2322 | if (!item) |
||
2323 | { |
||
2324 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
2325 | G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND, |
||
2326 | _("No bookmark found for URI '%s'"), |
||
2327 | uri); |
||
2328 | return NULL; |
||
2329 | } |
||
2330 | |||
2331 | if (!item->metadata) |
||
2332 | { |
||
2333 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
2334 | G_BOOKMARK_FILE_ERROR_INVALID_VALUE, |
||
2335 | _("No MIME type defined in the bookmark for URI '%s'"), |
||
2336 | uri); |
||
2337 | return NULL; |
||
2338 | } |
||
2339 | |||
2340 | return g_strdup (item->metadata->mime_type); |
||
2341 | } |
||
2342 | |||
2343 | /** |
||
2344 | * g_bookmark_file_set_is_private: |
||
2345 | * @bookmark: a #GBookmarkFile |
||
2346 | * @uri: a valid URI |
||
2347 | * @is_private: %TRUE if the bookmark should be marked as private |
||
2348 | * |
||
2349 | * Sets the private flag of the bookmark for @uri. |
||
2350 | * |
||
2351 | * If a bookmark for @uri cannot be found then it is created. |
||
2352 | * |
||
2353 | * Since: 2.12 |
||
2354 | */ |
||
2355 | void |
||
2356 | g_bookmark_file_set_is_private (GBookmarkFile *bookmark, |
||
2357 | const gchar *uri, |
||
2358 | gboolean is_private) |
||
2359 | { |
||
2360 | BookmarkItem *item; |
||
2361 | |||
2362 | g_return_if_fail (bookmark != NULL); |
||
2363 | g_return_if_fail (uri != NULL); |
||
2364 | |||
2365 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2366 | if (!item) |
||
2367 | { |
||
2368 | item = bookmark_item_new (uri); |
||
2369 | g_bookmark_file_add_item (bookmark, item, NULL); |
||
2370 | } |
||
2371 | |||
2372 | if (!item->metadata) |
||
2373 | item->metadata = bookmark_metadata_new (); |
||
2374 | |||
2375 | item->metadata->is_private = (is_private == TRUE); |
||
2376 | item->modified = time (NULL); |
||
2377 | } |
||
2378 | |||
2379 | /** |
||
2380 | * g_bookmark_file_get_is_private: |
||
2381 | * @bookmark: a #GBookmarkFile |
||
2382 | * @uri: a valid URI |
||
2383 | * @error: return location for a #GError, or %NULL |
||
2384 | * |
||
2385 | * Gets whether the private flag of the bookmark for @uri is set. |
||
2386 | * |
||
2387 | * In the event the URI cannot be found, %FALSE is returned and |
||
2388 | * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the |
||
2389 | * event that the private flag cannot be found, %FALSE is returned and |
||
2390 | * @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE. |
||
2391 | * |
||
2392 | * Returns: %TRUE if the private flag is set, %FALSE otherwise. |
||
2393 | * |
||
2394 | * Since: 2.12 |
||
2395 | */ |
||
2396 | gboolean |
||
2397 | g_bookmark_file_get_is_private (GBookmarkFile *bookmark, |
||
2398 | const gchar *uri, |
||
2399 | GError **error) |
||
2400 | { |
||
2401 | BookmarkItem *item; |
||
2402 | |||
2403 | g_return_val_if_fail (bookmark != NULL, FALSE); |
||
2404 | g_return_val_if_fail (uri != NULL, FALSE); |
||
2405 | |||
2406 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2407 | if (!item) |
||
2408 | { |
||
2409 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
2410 | G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND, |
||
2411 | _("No bookmark found for URI '%s'"), |
||
2412 | uri); |
||
2413 | return FALSE; |
||
2414 | } |
||
2415 | |||
2416 | if (!item->metadata) |
||
2417 | { |
||
2418 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
2419 | G_BOOKMARK_FILE_ERROR_INVALID_VALUE, |
||
2420 | _("No private flag has been defined in bookmark for URI '%s'"), |
||
2421 | uri); |
||
2422 | return FALSE; |
||
2423 | } |
||
2424 | |||
2425 | return item->metadata->is_private; |
||
2426 | } |
||
2427 | |||
2428 | /** |
||
2429 | * g_bookmark_file_set_added: |
||
2430 | * @bookmark: a #GBookmarkFile |
||
2431 | * @uri: a valid URI |
||
2432 | * @added: a timestamp or -1 to use the current time |
||
2433 | * |
||
2434 | * Sets the time the bookmark for @uri was added into @bookmark. |
||
2435 | * |
||
2436 | * If no bookmark for @uri is found then it is created. |
||
2437 | * |
||
2438 | * Since: 2.12 |
||
2439 | */ |
||
2440 | void |
||
2441 | g_bookmark_file_set_added (GBookmarkFile *bookmark, |
||
2442 | const gchar *uri, |
||
2443 | time_t added) |
||
2444 | { |
||
2445 | BookmarkItem *item; |
||
2446 | |||
2447 | g_return_if_fail (bookmark != NULL); |
||
2448 | g_return_if_fail (uri != NULL); |
||
2449 | |||
2450 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2451 | if (!item) |
||
2452 | { |
||
2453 | item = bookmark_item_new (uri); |
||
2454 | g_bookmark_file_add_item (bookmark, item, NULL); |
||
2455 | } |
||
2456 | |||
2457 | if (added == (time_t) -1) |
||
2458 | time (&added); |
||
2459 | |||
2460 | item->added = added; |
||
2461 | item->modified = added; |
||
2462 | } |
||
2463 | |||
2464 | /** |
||
2465 | * g_bookmark_file_get_added: |
||
2466 | * @bookmark: a #GBookmarkFile |
||
2467 | * @uri: a valid URI |
||
2468 | * @error: return location for a #GError, or %NULL |
||
2469 | * |
||
2470 | * Gets the time the bookmark for @uri was added to @bookmark |
||
2471 | * |
||
2472 | * In the event the URI cannot be found, -1 is returned and |
||
2473 | * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. |
||
2474 | * |
||
2475 | * Returns: a timestamp |
||
2476 | * |
||
2477 | * Since: 2.12 |
||
2478 | */ |
||
2479 | time_t |
||
2480 | g_bookmark_file_get_added (GBookmarkFile *bookmark, |
||
2481 | const gchar *uri, |
||
2482 | GError **error) |
||
2483 | { |
||
2484 | BookmarkItem *item; |
||
2485 | |||
2486 | g_return_val_if_fail (bookmark != NULL, (time_t) -1); |
||
2487 | g_return_val_if_fail (uri != NULL, (time_t) -1); |
||
2488 | |||
2489 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2490 | if (!item) |
||
2491 | { |
||
2492 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
2493 | G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND, |
||
2494 | _("No bookmark found for URI '%s'"), |
||
2495 | uri); |
||
2496 | return (time_t) -1; |
||
2497 | } |
||
2498 | |||
2499 | return item->added; |
||
2500 | } |
||
2501 | |||
2502 | /** |
||
2503 | * g_bookmark_file_set_modified: |
||
2504 | * @bookmark: a #GBookmarkFile |
||
2505 | * @uri: a valid URI |
||
2506 | * @modified: a timestamp or -1 to use the current time |
||
2507 | * |
||
2508 | * Sets the last time the bookmark for @uri was last modified. |
||
2509 | * |
||
2510 | * If no bookmark for @uri is found then it is created. |
||
2511 | * |
||
2512 | * The "modified" time should only be set when the bookmark's meta-data |
||
2513 | * was actually changed. Every function of #GBookmarkFile that |
||
2514 | * modifies a bookmark also changes the modification time, except for |
||
2515 | * g_bookmark_file_set_visited(). |
||
2516 | * |
||
2517 | * Since: 2.12 |
||
2518 | */ |
||
2519 | void |
||
2520 | g_bookmark_file_set_modified (GBookmarkFile *bookmark, |
||
2521 | const gchar *uri, |
||
2522 | time_t modified) |
||
2523 | { |
||
2524 | BookmarkItem *item; |
||
2525 | |||
2526 | g_return_if_fail (bookmark != NULL); |
||
2527 | g_return_if_fail (uri != NULL); |
||
2528 | |||
2529 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2530 | if (!item) |
||
2531 | { |
||
2532 | item = bookmark_item_new (uri); |
||
2533 | g_bookmark_file_add_item (bookmark, item, NULL); |
||
2534 | } |
||
2535 | |||
2536 | if (modified == (time_t) -1) |
||
2537 | time (&modified); |
||
2538 | |||
2539 | item->modified = modified; |
||
2540 | } |
||
2541 | |||
2542 | /** |
||
2543 | * g_bookmark_file_get_modified: |
||
2544 | * @bookmark: a #GBookmarkFile |
||
2545 | * @uri: a valid URI |
||
2546 | * @error: return location for a #GError, or %NULL |
||
2547 | * |
||
2548 | * Gets the time when the bookmark for @uri was last modified. |
||
2549 | * |
||
2550 | * In the event the URI cannot be found, -1 is returned and |
||
2551 | * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. |
||
2552 | * |
||
2553 | * Returns: a timestamp |
||
2554 | * |
||
2555 | * Since: 2.12 |
||
2556 | */ |
||
2557 | time_t |
||
2558 | g_bookmark_file_get_modified (GBookmarkFile *bookmark, |
||
2559 | const gchar *uri, |
||
2560 | GError **error) |
||
2561 | { |
||
2562 | BookmarkItem *item; |
||
2563 | |||
2564 | g_return_val_if_fail (bookmark != NULL, (time_t) -1); |
||
2565 | g_return_val_if_fail (uri != NULL, (time_t) -1); |
||
2566 | |||
2567 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2568 | if (!item) |
||
2569 | { |
||
2570 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
2571 | G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND, |
||
2572 | _("No bookmark found for URI '%s'"), |
||
2573 | uri); |
||
2574 | return (time_t) -1; |
||
2575 | } |
||
2576 | |||
2577 | return item->modified; |
||
2578 | } |
||
2579 | |||
2580 | /** |
||
2581 | * g_bookmark_file_set_visited: |
||
2582 | * @bookmark: a #GBookmarkFile |
||
2583 | * @uri: a valid URI |
||
2584 | * @visited: a timestamp or -1 to use the current time |
||
2585 | * |
||
2586 | * Sets the time the bookmark for @uri was last visited. |
||
2587 | * |
||
2588 | * If no bookmark for @uri is found then it is created. |
||
2589 | * |
||
2590 | * The "visited" time should only be set if the bookmark was launched, |
||
2591 | * either using the command line retrieved by g_bookmark_file_get_app_info() |
||
2592 | * or by the default application for the bookmark's MIME type, retrieved |
||
2593 | * using g_bookmark_file_get_mime_type(). Changing the "visited" time |
||
2594 | * does not affect the "modified" time. |
||
2595 | * |
||
2596 | * Since: 2.12 |
||
2597 | */ |
||
2598 | void |
||
2599 | g_bookmark_file_set_visited (GBookmarkFile *bookmark, |
||
2600 | const gchar *uri, |
||
2601 | time_t visited) |
||
2602 | { |
||
2603 | BookmarkItem *item; |
||
2604 | |||
2605 | g_return_if_fail (bookmark != NULL); |
||
2606 | g_return_if_fail (uri != NULL); |
||
2607 | |||
2608 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2609 | if (!item) |
||
2610 | { |
||
2611 | item = bookmark_item_new (uri); |
||
2612 | g_bookmark_file_add_item (bookmark, item, NULL); |
||
2613 | } |
||
2614 | |||
2615 | if (visited == (time_t) -1) |
||
2616 | time (&visited); |
||
2617 | |||
2618 | item->visited = visited; |
||
2619 | } |
||
2620 | |||
2621 | /** |
||
2622 | * g_bookmark_file_get_visited: |
||
2623 | * @bookmark: a #GBookmarkFile |
||
2624 | * @uri: a valid URI |
||
2625 | * @error: return location for a #GError, or %NULL |
||
2626 | * |
||
2627 | * Gets the time the bookmark for @uri was last visited. |
||
2628 | * |
||
2629 | * In the event the URI cannot be found, -1 is returned and |
||
2630 | * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. |
||
2631 | * |
||
2632 | * Returns: a timestamp. |
||
2633 | * |
||
2634 | * Since: 2.12 |
||
2635 | */ |
||
2636 | time_t |
||
2637 | g_bookmark_file_get_visited (GBookmarkFile *bookmark, |
||
2638 | const gchar *uri, |
||
2639 | GError **error) |
||
2640 | { |
||
2641 | BookmarkItem *item; |
||
2642 | |||
2643 | g_return_val_if_fail (bookmark != NULL, (time_t) -1); |
||
2644 | g_return_val_if_fail (uri != NULL, (time_t) -1); |
||
2645 | |||
2646 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2647 | if (!item) |
||
2648 | { |
||
2649 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
2650 | G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND, |
||
2651 | _("No bookmark found for URI '%s'"), |
||
2652 | uri); |
||
2653 | return (time_t) -1; |
||
2654 | } |
||
2655 | |||
2656 | return item->visited; |
||
2657 | } |
||
2658 | |||
2659 | /** |
||
2660 | * g_bookmark_file_has_group: |
||
2661 | * @bookmark: a #GBookmarkFile |
||
2662 | * @uri: a valid URI |
||
2663 | * @group: the group name to be searched |
||
2664 | * @error: return location for a #GError, or %NULL |
||
2665 | * |
||
2666 | * Checks whether @group appears in the list of groups to which |
||
2667 | * the bookmark for @uri belongs to. |
||
2668 | * |
||
2669 | * In the event the URI cannot be found, %FALSE is returned and |
||
2670 | * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. |
||
2671 | * |
||
2672 | * Returns: %TRUE if @group was found. |
||
2673 | * |
||
2674 | * Since: 2.12 |
||
2675 | */ |
||
2676 | gboolean |
||
2677 | g_bookmark_file_has_group (GBookmarkFile *bookmark, |
||
2678 | const gchar *uri, |
||
2679 | const gchar *group, |
||
2680 | GError **error) |
||
2681 | { |
||
2682 | BookmarkItem *item; |
||
2683 | GList *l; |
||
2684 | |||
2685 | g_return_val_if_fail (bookmark != NULL, FALSE); |
||
2686 | g_return_val_if_fail (uri != NULL, FALSE); |
||
2687 | |||
2688 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2689 | if (!item) |
||
2690 | { |
||
2691 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
2692 | G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND, |
||
2693 | _("No bookmark found for URI '%s'"), |
||
2694 | uri); |
||
2695 | return FALSE; |
||
2696 | } |
||
2697 | |||
2698 | if (!item->metadata) |
||
2699 | return FALSE; |
||
2700 | |||
2701 | for (l = item->metadata->groups; l != NULL; l = l->next) |
||
2702 | { |
||
2703 | if (strcmp (l->data, group) == 0) |
||
2704 | return TRUE; |
||
2705 | } |
||
2706 | |||
2707 | return FALSE; |
||
2708 | |||
2709 | } |
||
2710 | |||
2711 | /** |
||
2712 | * g_bookmark_file_add_group: |
||
2713 | * @bookmark: a #GBookmarkFile |
||
2714 | * @uri: a valid URI |
||
2715 | * @group: the group name to be added |
||
2716 | * |
||
2717 | * Adds @group to the list of groups to which the bookmark for @uri |
||
2718 | * belongs to. |
||
2719 | * |
||
2720 | * If no bookmark for @uri is found then it is created. |
||
2721 | * |
||
2722 | * Since: 2.12 |
||
2723 | */ |
||
2724 | void |
||
2725 | g_bookmark_file_add_group (GBookmarkFile *bookmark, |
||
2726 | const gchar *uri, |
||
2727 | const gchar *group) |
||
2728 | { |
||
2729 | BookmarkItem *item; |
||
2730 | |||
2731 | g_return_if_fail (bookmark != NULL); |
||
2732 | g_return_if_fail (uri != NULL); |
||
2733 | g_return_if_fail (group != NULL && group[0] != '\0'); |
||
2734 | |||
2735 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2736 | if (!item) |
||
2737 | { |
||
2738 | item = bookmark_item_new (uri); |
||
2739 | g_bookmark_file_add_item (bookmark, item, NULL); |
||
2740 | } |
||
2741 | |||
2742 | if (!item->metadata) |
||
2743 | item->metadata = bookmark_metadata_new (); |
||
2744 | |||
2745 | if (!g_bookmark_file_has_group (bookmark, uri, group, NULL)) |
||
2746 | { |
||
2747 | item->metadata->groups = g_list_prepend (item->metadata->groups, |
||
2748 | g_strdup (group)); |
||
2749 | |||
2750 | item->modified = time (NULL); |
||
2751 | } |
||
2752 | } |
||
2753 | |||
2754 | /** |
||
2755 | * g_bookmark_file_remove_group: |
||
2756 | * @bookmark: a #GBookmarkFile |
||
2757 | * @uri: a valid URI |
||
2758 | * @group: the group name to be removed |
||
2759 | * @error: return location for a #GError, or %NULL |
||
2760 | * |
||
2761 | * Removes @group from the list of groups to which the bookmark |
||
2762 | * for @uri belongs to. |
||
2763 | * |
||
2764 | * In the event the URI cannot be found, %FALSE is returned and |
||
2765 | * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. |
||
2766 | * In the event no group was defined, %FALSE is returned and |
||
2767 | * @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE. |
||
2768 | * |
||
2769 | * Returns: %TRUE if @group was successfully removed. |
||
2770 | * |
||
2771 | * Since: 2.12 |
||
2772 | */ |
||
2773 | gboolean |
||
2774 | g_bookmark_file_remove_group (GBookmarkFile *bookmark, |
||
2775 | const gchar *uri, |
||
2776 | const gchar *group, |
||
2777 | GError **error) |
||
2778 | { |
||
2779 | BookmarkItem *item; |
||
2780 | GList *l; |
||
2781 | |||
2782 | g_return_val_if_fail (bookmark != NULL, FALSE); |
||
2783 | g_return_val_if_fail (uri != NULL, FALSE); |
||
2784 | |||
2785 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2786 | if (!item) |
||
2787 | { |
||
2788 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
2789 | G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND, |
||
2790 | _("No bookmark found for URI '%s'"), |
||
2791 | uri); |
||
2792 | return FALSE; |
||
2793 | } |
||
2794 | |||
2795 | if (!item->metadata) |
||
2796 | { |
||
2797 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
2798 | G_BOOKMARK_FILE_ERROR_INVALID_VALUE, |
||
2799 | _("No groups set in bookmark for URI '%s'"), |
||
2800 | uri); |
||
2801 | return FALSE; |
||
2802 | } |
||
2803 | |||
2804 | for (l = item->metadata->groups; l != NULL; l = l->next) |
||
2805 | { |
||
2806 | if (strcmp (l->data, group) == 0) |
||
2807 | { |
||
2808 | item->metadata->groups = g_list_remove_link (item->metadata->groups, l); |
||
2809 | g_free (l->data); |
||
2810 | g_list_free_1 (l); |
||
2811 | |||
2812 | item->modified = time (NULL); |
||
2813 | |||
2814 | return TRUE; |
||
2815 | } |
||
2816 | } |
||
2817 | |||
2818 | return FALSE; |
||
2819 | } |
||
2820 | |||
2821 | /** |
||
2822 | * g_bookmark_file_set_groups: |
||
2823 | * @bookmark: a #GBookmarkFile |
||
2824 | * @uri: an item's URI |
||
2825 | * @groups: (allow-none): an array of group names, or %NULL to remove all groups |
||
2826 | * @length: number of group name values in @groups |
||
2827 | * |
||
2828 | * Sets a list of group names for the item with URI @uri. Each previously |
||
2829 | * set group name list is removed. |
||
2830 | * |
||
2831 | * If @uri cannot be found then an item for it is created. |
||
2832 | * |
||
2833 | * Since: 2.12 |
||
2834 | */ |
||
2835 | void |
||
2836 | g_bookmark_file_set_groups (GBookmarkFile *bookmark, |
||
2837 | const gchar *uri, |
||
2838 | const gchar **groups, |
||
2839 | gsize length) |
||
2840 | { |
||
2841 | BookmarkItem *item; |
||
2842 | gsize i; |
||
2843 | |||
2844 | g_return_if_fail (bookmark != NULL); |
||
2845 | g_return_if_fail (uri != NULL); |
||
2846 | g_return_if_fail (groups != NULL); |
||
2847 | |||
2848 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2849 | if (!item) |
||
2850 | { |
||
2851 | item = bookmark_item_new (uri); |
||
2852 | g_bookmark_file_add_item (bookmark, item, NULL); |
||
2853 | } |
||
2854 | |||
2855 | if (!item->metadata) |
||
2856 | item->metadata = bookmark_metadata_new (); |
||
2857 | |||
2858 | g_list_free_full (item->metadata->groups, g_free); |
||
2859 | item->metadata->groups = NULL; |
||
2860 | |||
2861 | if (groups) |
||
2862 | { |
||
2863 | for (i = 0; groups[i] != NULL && i < length; i++) |
||
2864 | item->metadata->groups = g_list_append (item->metadata->groups, |
||
2865 | g_strdup (groups[i])); |
||
2866 | } |
||
2867 | |||
2868 | item->modified = time (NULL); |
||
2869 | } |
||
2870 | |||
2871 | /** |
||
2872 | * g_bookmark_file_get_groups: |
||
2873 | * @bookmark: a #GBookmarkFile |
||
2874 | * @uri: a valid URI |
||
2875 | * @length: (allow-none) (out): return location for the length of the returned string, or %NULL |
||
2876 | * @error: return location for a #GError, or %NULL |
||
2877 | * |
||
2878 | * Retrieves the list of group names of the bookmark for @uri. |
||
2879 | * |
||
2880 | * In the event the URI cannot be found, %NULL is returned and |
||
2881 | * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. |
||
2882 | * |
||
2883 | * The returned array is %NULL terminated, so @length may optionally |
||
2884 | * be %NULL. |
||
2885 | * |
||
2886 | * Returns: (array length=length) (transfer full): a newly allocated %NULL-terminated array of group names. |
||
2887 | * Use g_strfreev() to free it. |
||
2888 | * |
||
2889 | * Since: 2.12 |
||
2890 | */ |
||
2891 | gchar ** |
||
2892 | g_bookmark_file_get_groups (GBookmarkFile *bookmark, |
||
2893 | const gchar *uri, |
||
2894 | gsize *length, |
||
2895 | GError **error) |
||
2896 | { |
||
2897 | BookmarkItem *item; |
||
2898 | GList *l; |
||
2899 | gsize len, i; |
||
2900 | gchar **retval; |
||
2901 | |||
2902 | g_return_val_if_fail (bookmark != NULL, NULL); |
||
2903 | g_return_val_if_fail (uri != NULL, NULL); |
||
2904 | |||
2905 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2906 | if (!item) |
||
2907 | { |
||
2908 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
2909 | G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND, |
||
2910 | _("No bookmark found for URI '%s'"), |
||
2911 | uri); |
||
2912 | return NULL; |
||
2913 | } |
||
2914 | |||
2915 | if (!item->metadata) |
||
2916 | { |
||
2917 | if (length) |
||
2918 | *length = 0; |
||
2919 | |||
2920 | return NULL; |
||
2921 | } |
||
2922 | |||
2923 | len = g_list_length (item->metadata->groups); |
||
2924 | retval = g_new0 (gchar *, len + 1); |
||
2925 | for (l = g_list_last (item->metadata->groups), i = 0; |
||
2926 | l != NULL; |
||
2927 | l = l->prev) |
||
2928 | { |
||
2929 | gchar *group_name = (gchar *) l->data; |
||
2930 | |||
2931 | g_warn_if_fail (group_name != NULL); |
||
2932 | |||
2933 | retval[i++] = g_strdup (group_name); |
||
2934 | } |
||
2935 | retval[i] = NULL; |
||
2936 | |||
2937 | if (length) |
||
2938 | *length = len; |
||
2939 | |||
2940 | return retval; |
||
2941 | } |
||
2942 | |||
2943 | /** |
||
2944 | * g_bookmark_file_add_application: |
||
2945 | * @bookmark: a #GBookmarkFile |
||
2946 | * @uri: a valid URI |
||
2947 | * @name: (allow-none): the name of the application registering the bookmark |
||
2948 | * or %NULL |
||
2949 | * @exec: (allow-none): command line to be used to launch the bookmark or %NULL |
||
2950 | * |
||
2951 | * Adds the application with @name and @exec to the list of |
||
2952 | * applications that have registered a bookmark for @uri into |
||
2953 | * @bookmark. |
||
2954 | * |
||
2955 | * Every bookmark inside a #GBookmarkFile must have at least an |
||
2956 | * application registered. Each application must provide a name, a |
||
2957 | * command line useful for launching the bookmark, the number of times |
||
2958 | * the bookmark has been registered by the application and the last |
||
2959 | * time the application registered this bookmark. |
||
2960 | * |
||
2961 | * If @name is %NULL, the name of the application will be the |
||
2962 | * same returned by g_get_application_name(); if @exec is %NULL, the |
||
2963 | * command line will be a composition of the program name as |
||
2964 | * returned by g_get_prgname() and the "\%u" modifier, which will be |
||
2965 | * expanded to the bookmark's URI. |
||
2966 | * |
||
2967 | * This function will automatically take care of updating the |
||
2968 | * registrations count and timestamping in case an application |
||
2969 | * with the same @name had already registered a bookmark for |
||
2970 | * @uri inside @bookmark. |
||
2971 | * |
||
2972 | * If no bookmark for @uri is found, one is created. |
||
2973 | * |
||
2974 | * Since: 2.12 |
||
2975 | */ |
||
2976 | void |
||
2977 | g_bookmark_file_add_application (GBookmarkFile *bookmark, |
||
2978 | const gchar *uri, |
||
2979 | const gchar *name, |
||
2980 | const gchar *exec) |
||
2981 | { |
||
2982 | BookmarkItem *item; |
||
2983 | gchar *app_name, *app_exec; |
||
2984 | |||
2985 | g_return_if_fail (bookmark != NULL); |
||
2986 | g_return_if_fail (uri != NULL); |
||
2987 | |||
2988 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
2989 | if (!item) |
||
2990 | { |
||
2991 | item = bookmark_item_new (uri); |
||
2992 | g_bookmark_file_add_item (bookmark, item, NULL); |
||
2993 | } |
||
2994 | |||
2995 | if (name && name[0] != '\0') |
||
2996 | app_name = g_strdup (name); |
||
2997 | else |
||
2998 | app_name = g_strdup (g_get_application_name ()); |
||
2999 | |||
3000 | if (exec && exec[0] != '\0') |
||
3001 | app_exec = g_strdup (exec); |
||
3002 | else |
||
3003 | app_exec = g_strjoin (" ", g_get_prgname(), "%u", NULL); |
||
3004 | |||
3005 | g_bookmark_file_set_app_info (bookmark, uri, |
||
3006 | app_name, |
||
3007 | app_exec, |
||
3008 | -1, |
||
3009 | (time_t) -1, |
||
3010 | NULL); |
||
3011 | |||
3012 | g_free (app_exec); |
||
3013 | g_free (app_name); |
||
3014 | } |
||
3015 | |||
3016 | /** |
||
3017 | * g_bookmark_file_remove_application: |
||
3018 | * @bookmark: a #GBookmarkFile |
||
3019 | * @uri: a valid URI |
||
3020 | * @name: the name of the application |
||
3021 | * @error: return location for a #GError or %NULL |
||
3022 | * |
||
3023 | * Removes application registered with @name from the list of applications |
||
3024 | * that have registered a bookmark for @uri inside @bookmark. |
||
3025 | * |
||
3026 | * In the event the URI cannot be found, %FALSE is returned and |
||
3027 | * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. |
||
3028 | * In the event that no application with name @app_name has registered |
||
3029 | * a bookmark for @uri, %FALSE is returned and error is set to |
||
3030 | * #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. |
||
3031 | * |
||
3032 | * Returns: %TRUE if the application was successfully removed. |
||
3033 | * |
||
3034 | * Since: 2.12 |
||
3035 | */ |
||
3036 | gboolean |
||
3037 | g_bookmark_file_remove_application (GBookmarkFile *bookmark, |
||
3038 | const gchar *uri, |
||
3039 | const gchar *name, |
||
3040 | GError **error) |
||
3041 | { |
||
3042 | GError *set_error; |
||
3043 | gboolean retval; |
||
3044 | |||
3045 | g_return_val_if_fail (bookmark != NULL, FALSE); |
||
3046 | g_return_val_if_fail (uri != NULL, FALSE); |
||
3047 | g_return_val_if_fail (name != NULL, FALSE); |
||
3048 | |||
3049 | set_error = NULL; |
||
3050 | retval = g_bookmark_file_set_app_info (bookmark, uri, |
||
3051 | name, |
||
3052 | "", |
||
3053 | 0, |
||
3054 | (time_t) -1, |
||
3055 | &set_error); |
||
3056 | if (set_error) |
||
3057 | { |
||
3058 | g_propagate_error (error, set_error); |
||
3059 | |||
3060 | return FALSE; |
||
3061 | } |
||
3062 | |||
3063 | return retval; |
||
3064 | } |
||
3065 | |||
3066 | /** |
||
3067 | * g_bookmark_file_has_application: |
||
3068 | * @bookmark: a #GBookmarkFile |
||
3069 | * @uri: a valid URI |
||
3070 | * @name: the name of the application |
||
3071 | * @error: return location for a #GError or %NULL |
||
3072 | * |
||
3073 | * Checks whether the bookmark for @uri inside @bookmark has been |
||
3074 | * registered by application @name. |
||
3075 | * |
||
3076 | * In the event the URI cannot be found, %FALSE is returned and |
||
3077 | * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. |
||
3078 | * |
||
3079 | * Returns: %TRUE if the application @name was found |
||
3080 | * |
||
3081 | * Since: 2.12 |
||
3082 | */ |
||
3083 | gboolean |
||
3084 | g_bookmark_file_has_application (GBookmarkFile *bookmark, |
||
3085 | const gchar *uri, |
||
3086 | const gchar *name, |
||
3087 | GError **error) |
||
3088 | { |
||
3089 | BookmarkItem *item; |
||
3090 | |||
3091 | g_return_val_if_fail (bookmark != NULL, FALSE); |
||
3092 | g_return_val_if_fail (uri != NULL, FALSE); |
||
3093 | g_return_val_if_fail (name != NULL, FALSE); |
||
3094 | |||
3095 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
3096 | if (!item) |
||
3097 | { |
||
3098 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
3099 | G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND, |
||
3100 | _("No bookmark found for URI '%s'"), |
||
3101 | uri); |
||
3102 | return FALSE; |
||
3103 | } |
||
3104 | |||
3105 | return (NULL != bookmark_item_lookup_app_info (item, name)); |
||
3106 | } |
||
3107 | |||
3108 | /** |
||
3109 | * g_bookmark_file_set_app_info: |
||
3110 | * @bookmark: a #GBookmarkFile |
||
3111 | * @uri: a valid URI |
||
3112 | * @name: an application's name |
||
3113 | * @exec: an application's command line |
||
3114 | * @count: the number of registrations done for this application |
||
3115 | * @stamp: the time of the last registration for this application |
||
3116 | * @error: return location for a #GError or %NULL |
||
3117 | * |
||
3118 | * Sets the meta-data of application @name inside the list of |
||
3119 | * applications that have registered a bookmark for @uri inside |
||
3120 | * @bookmark. |
||
3121 | * |
||
3122 | * You should rarely use this function; use g_bookmark_file_add_application() |
||
3123 | * and g_bookmark_file_remove_application() instead. |
||
3124 | * |
||
3125 | * @name can be any UTF-8 encoded string used to identify an |
||
3126 | * application. |
||
3127 | * @exec can have one of these two modifiers: "\%f", which will |
||
3128 | * be expanded as the local file name retrieved from the bookmark's |
||
3129 | * URI; "\%u", which will be expanded as the bookmark's URI. |
||
3130 | * The expansion is done automatically when retrieving the stored |
||
3131 | * command line using the g_bookmark_file_get_app_info() function. |
||
3132 | * @count is the number of times the application has registered the |
||
3133 | * bookmark; if is < 0, the current registration count will be increased |
||
3134 | * by one, if is 0, the application with @name will be removed from |
||
3135 | * the list of registered applications. |
||
3136 | * @stamp is the Unix time of the last registration; if it is -1, the |
||
3137 | * current time will be used. |
||
3138 | * |
||
3139 | * If you try to remove an application by setting its registration count to |
||
3140 | * zero, and no bookmark for @uri is found, %FALSE is returned and |
||
3141 | * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND; similarly, |
||
3142 | * in the event that no application @name has registered a bookmark |
||
3143 | * for @uri, %FALSE is returned and error is set to |
||
3144 | * #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. Otherwise, if no bookmark |
||
3145 | * for @uri is found, one is created. |
||
3146 | * |
||
3147 | * Returns: %TRUE if the application's meta-data was successfully |
||
3148 | * changed. |
||
3149 | * |
||
3150 | * Since: 2.12 |
||
3151 | */ |
||
3152 | gboolean |
||
3153 | g_bookmark_file_set_app_info (GBookmarkFile *bookmark, |
||
3154 | const gchar *uri, |
||
3155 | const gchar *name, |
||
3156 | const gchar *exec, |
||
3157 | gint count, |
||
3158 | time_t stamp, |
||
3159 | GError **error) |
||
3160 | { |
||
3161 | BookmarkItem *item; |
||
3162 | BookmarkAppInfo *ai; |
||
3163 | |||
3164 | g_return_val_if_fail (bookmark != NULL, FALSE); |
||
3165 | g_return_val_if_fail (uri != NULL, FALSE); |
||
3166 | g_return_val_if_fail (name != NULL, FALSE); |
||
3167 | g_return_val_if_fail (exec != NULL, FALSE); |
||
3168 | |||
3169 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
3170 | if (!item) |
||
3171 | { |
||
3172 | if (count == 0) |
||
3173 | { |
||
3174 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
3175 | G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND, |
||
3176 | _("No bookmark found for URI '%s'"), |
||
3177 | uri); |
||
3178 | return FALSE; |
||
3179 | } |
||
3180 | else |
||
3181 | { |
||
3182 | item = bookmark_item_new (uri); |
||
3183 | g_bookmark_file_add_item (bookmark, item, NULL); |
||
3184 | } |
||
3185 | } |
||
3186 | |||
3187 | if (!item->metadata) |
||
3188 | item->metadata = bookmark_metadata_new (); |
||
3189 | |||
3190 | ai = bookmark_item_lookup_app_info (item, name); |
||
3191 | if (!ai) |
||
3192 | { |
||
3193 | if (count == 0) |
||
3194 | { |
||
3195 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
3196 | G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED, |
||
3197 | _("No application with name '%s' registered a bookmark for '%s'"), |
||
3198 | name, |
||
3199 | uri); |
||
3200 | return FALSE; |
||
3201 | } |
||
3202 | else |
||
3203 | { |
||
3204 | ai = bookmark_app_info_new (name); |
||
3205 | |||
3206 | item->metadata->applications = g_list_prepend (item->metadata->applications, ai); |
||
3207 | g_hash_table_replace (item->metadata->apps_by_name, ai->name, ai); |
||
3208 | } |
||
3209 | } |
||
3210 | |||
3211 | if (count == 0) |
||
3212 | { |
||
3213 | item->metadata->applications = g_list_remove (item->metadata->applications, ai); |
||
3214 | g_hash_table_remove (item->metadata->apps_by_name, ai->name); |
||
3215 | bookmark_app_info_free (ai); |
||
3216 | |||
3217 | item->modified = time (NULL); |
||
3218 | |||
3219 | return TRUE; |
||
3220 | } |
||
3221 | else if (count > 0) |
||
3222 | ai->count = count; |
||
3223 | else |
||
3224 | ai->count += 1; |
||
3225 | |||
3226 | if (stamp != (time_t) -1) |
||
3227 | ai->stamp = stamp; |
||
3228 | else |
||
3229 | ai->stamp = time (NULL); |
||
3230 | |||
3231 | if (exec && exec[0] != '\0') |
||
3232 | { |
||
3233 | g_free (ai->exec); |
||
3234 | ai->exec = g_shell_quote (exec); |
||
3235 | } |
||
3236 | |||
3237 | item->modified = time (NULL); |
||
3238 | |||
3239 | return TRUE; |
||
3240 | } |
||
3241 | |||
3242 | /* expands the application's command line */ |
||
3243 | static gchar * |
||
3244 | expand_exec_line (const gchar *exec_fmt, |
||
3245 | const gchar *uri) |
||
3246 | { |
||
3247 | GString *exec; |
||
3248 | gchar ch; |
||
3249 | |||
3250 | exec = g_string_sized_new (512); |
||
3251 | while ((ch = *exec_fmt++) != '\0') |
||
3252 | { |
||
3253 | if (ch != '%') |
||
3254 | { |
||
3255 | exec = g_string_append_c (exec, ch); |
||
3256 | continue; |
||
3257 | } |
||
3258 | |||
3259 | ch = *exec_fmt++; |
||
3260 | switch (ch) |
||
3261 | { |
||
3262 | case '\0': |
||
3263 | goto out; |
||
3264 | case 'U': |
||
3265 | case 'u': |
||
3266 | g_string_append (exec, uri); |
||
3267 | break; |
||
3268 | case 'F': |
||
3269 | case 'f': |
||
3270 | { |
||
3271 | gchar *file = g_filename_from_uri (uri, NULL, NULL); |
||
3272 | if (file) |
||
3273 | { |
||
3274 | g_string_append (exec, file); |
||
3275 | g_free (file); |
||
3276 | } |
||
3277 | else |
||
3278 | { |
||
3279 | g_string_free (exec, TRUE); |
||
3280 | return NULL; |
||
3281 | } |
||
3282 | } |
||
3283 | break; |
||
3284 | case '%': |
||
3285 | default: |
||
3286 | exec = g_string_append_c (exec, ch); |
||
3287 | break; |
||
3288 | } |
||
3289 | } |
||
3290 | |||
3291 | out: |
||
3292 | return g_string_free (exec, FALSE); |
||
3293 | } |
||
3294 | |||
3295 | /** |
||
3296 | * g_bookmark_file_get_app_info: |
||
3297 | * @bookmark: a #GBookmarkFile |
||
3298 | * @uri: a valid URI |
||
3299 | * @name: an application's name |
||
3300 | * @exec: (allow-none) (out): return location for the command line of the application, or %NULL |
||
3301 | * @count: (allow-none) (out): return location for the registration count, or %NULL |
||
3302 | * @stamp: (allow-none) (out): return location for the last registration time, or %NULL |
||
3303 | * @error: return location for a #GError, or %NULL |
||
3304 | * |
||
3305 | * Gets the registration informations of @app_name for the bookmark for |
||
3306 | * @uri. See g_bookmark_file_set_app_info() for more informations about |
||
3307 | * the returned data. |
||
3308 | * |
||
3309 | * The string returned in @app_exec must be freed. |
||
3310 | * |
||
3311 | * In the event the URI cannot be found, %FALSE is returned and |
||
3312 | * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the |
||
3313 | * event that no application with name @app_name has registered a bookmark |
||
3314 | * for @uri, %FALSE is returned and error is set to |
||
3315 | * #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. In the event that unquoting |
||
3316 | * the command line fails, an error of the #G_SHELL_ERROR domain is |
||
3317 | * set and %FALSE is returned. |
||
3318 | * |
||
3319 | * Returns: %TRUE on success. |
||
3320 | * |
||
3321 | * Since: 2.12 |
||
3322 | */ |
||
3323 | gboolean |
||
3324 | g_bookmark_file_get_app_info (GBookmarkFile *bookmark, |
||
3325 | const gchar *uri, |
||
3326 | const gchar *name, |
||
3327 | gchar **exec, |
||
3328 | guint *count, |
||
3329 | time_t *stamp, |
||
3330 | GError **error) |
||
3331 | { |
||
3332 | BookmarkItem *item; |
||
3333 | BookmarkAppInfo *ai; |
||
3334 | |||
3335 | g_return_val_if_fail (bookmark != NULL, FALSE); |
||
3336 | g_return_val_if_fail (uri != NULL, FALSE); |
||
3337 | g_return_val_if_fail (name != NULL, FALSE); |
||
3338 | |||
3339 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
3340 | if (!item) |
||
3341 | { |
||
3342 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
3343 | G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND, |
||
3344 | _("No bookmark found for URI '%s'"), |
||
3345 | uri); |
||
3346 | return FALSE; |
||
3347 | } |
||
3348 | |||
3349 | ai = bookmark_item_lookup_app_info (item, name); |
||
3350 | if (!ai) |
||
3351 | { |
||
3352 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
3353 | G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED, |
||
3354 | _("No application with name '%s' registered a bookmark for '%s'"), |
||
3355 | name, |
||
3356 | uri); |
||
3357 | return FALSE; |
||
3358 | } |
||
3359 | |||
3360 | if (exec) |
||
3361 | { |
||
3362 | GError *unquote_error = NULL; |
||
3363 | gchar *command_line; |
||
3364 | |||
3365 | command_line = g_shell_unquote (ai->exec, &unquote_error); |
||
3366 | if (unquote_error) |
||
3367 | { |
||
3368 | g_propagate_error (error, unquote_error); |
||
3369 | return FALSE; |
||
3370 | } |
||
3371 | |||
3372 | *exec = expand_exec_line (command_line, uri); |
||
3373 | if (!*exec) |
||
3374 | { |
||
3375 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
3376 | G_BOOKMARK_FILE_ERROR_INVALID_URI, |
||
3377 | _("Failed to expand exec line '%s' with URI '%s'"), |
||
3378 | ai->exec, uri); |
||
3379 | g_free (command_line); |
||
3380 | |||
3381 | return FALSE; |
||
3382 | } |
||
3383 | else |
||
3384 | g_free (command_line); |
||
3385 | } |
||
3386 | |||
3387 | if (count) |
||
3388 | *count = ai->count; |
||
3389 | |||
3390 | if (stamp) |
||
3391 | *stamp = ai->stamp; |
||
3392 | |||
3393 | return TRUE; |
||
3394 | } |
||
3395 | |||
3396 | /** |
||
3397 | * g_bookmark_file_get_applications: |
||
3398 | * @bookmark: a #GBookmarkFile |
||
3399 | * @uri: a valid URI |
||
3400 | * @length: (allow-none) (out): return location of the length of the returned list, or %NULL |
||
3401 | * @error: return location for a #GError, or %NULL |
||
3402 | * |
||
3403 | * Retrieves the names of the applications that have registered the |
||
3404 | * bookmark for @uri. |
||
3405 | * |
||
3406 | * In the event the URI cannot be found, %NULL is returned and |
||
3407 | * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. |
||
3408 | * |
||
3409 | * Returns: (array length=length) (transfer full): a newly allocated %NULL-terminated array of strings. |
||
3410 | * Use g_strfreev() to free it. |
||
3411 | * |
||
3412 | * Since: 2.12 |
||
3413 | */ |
||
3414 | gchar ** |
||
3415 | g_bookmark_file_get_applications (GBookmarkFile *bookmark, |
||
3416 | const gchar *uri, |
||
3417 | gsize *length, |
||
3418 | GError **error) |
||
3419 | { |
||
3420 | BookmarkItem *item; |
||
3421 | GList *l; |
||
3422 | gchar **apps; |
||
3423 | gsize i, n_apps; |
||
3424 | |||
3425 | g_return_val_if_fail (bookmark != NULL, NULL); |
||
3426 | g_return_val_if_fail (uri != NULL, NULL); |
||
3427 | |||
3428 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
3429 | if (!item) |
||
3430 | { |
||
3431 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
3432 | G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND, |
||
3433 | _("No bookmark found for URI '%s'"), |
||
3434 | uri); |
||
3435 | return NULL; |
||
3436 | } |
||
3437 | |||
3438 | if (!item->metadata) |
||
3439 | { |
||
3440 | if (length) |
||
3441 | *length = 0; |
||
3442 | |||
3443 | return NULL; |
||
3444 | } |
||
3445 | |||
3446 | n_apps = g_list_length (item->metadata->applications); |
||
3447 | apps = g_new0 (gchar *, n_apps + 1); |
||
3448 | |||
3449 | for (l = g_list_last (item->metadata->applications), i = 0; |
||
3450 | l != NULL; |
||
3451 | l = l->prev) |
||
3452 | { |
||
3453 | BookmarkAppInfo *ai; |
||
3454 | |||
3455 | ai = (BookmarkAppInfo *) l->data; |
||
3456 | |||
3457 | g_warn_if_fail (ai != NULL); |
||
3458 | g_warn_if_fail (ai->name != NULL); |
||
3459 | |||
3460 | apps[i++] = g_strdup (ai->name); |
||
3461 | } |
||
3462 | apps[i] = NULL; |
||
3463 | |||
3464 | if (length) |
||
3465 | *length = i; |
||
3466 | |||
3467 | return apps; |
||
3468 | } |
||
3469 | |||
3470 | /** |
||
3471 | * g_bookmark_file_get_size: |
||
3472 | * @bookmark: a #GBookmarkFile |
||
3473 | * |
||
3474 | * Gets the number of bookmarks inside @bookmark. |
||
3475 | * |
||
3476 | * Returns: the number of bookmarks |
||
3477 | * |
||
3478 | * Since: 2.12 |
||
3479 | */ |
||
3480 | gint |
||
3481 | g_bookmark_file_get_size (GBookmarkFile *bookmark) |
||
3482 | { |
||
3483 | g_return_val_if_fail (bookmark != NULL, 0); |
||
3484 | |||
3485 | return g_list_length (bookmark->items); |
||
3486 | } |
||
3487 | |||
3488 | /** |
||
3489 | * g_bookmark_file_move_item: |
||
3490 | * @bookmark: a #GBookmarkFile |
||
3491 | * @old_uri: a valid URI |
||
3492 | * @new_uri: (allow-none): a valid URI, or %NULL |
||
3493 | * @error: return location for a #GError or %NULL |
||
3494 | * |
||
3495 | * Changes the URI of a bookmark item from @old_uri to @new_uri. Any |
||
3496 | * existing bookmark for @new_uri will be overwritten. If @new_uri is |
||
3497 | * %NULL, then the bookmark is removed. |
||
3498 | * |
||
3499 | * In the event the URI cannot be found, %FALSE is returned and |
||
3500 | * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. |
||
3501 | * |
||
3502 | * Returns: %TRUE if the URI was successfully changed |
||
3503 | * |
||
3504 | * Since: 2.12 |
||
3505 | */ |
||
3506 | gboolean |
||
3507 | g_bookmark_file_move_item (GBookmarkFile *bookmark, |
||
3508 | const gchar *old_uri, |
||
3509 | const gchar *new_uri, |
||
3510 | GError **error) |
||
3511 | { |
||
3512 | BookmarkItem *item; |
||
3513 | |||
3514 | g_return_val_if_fail (bookmark != NULL, FALSE); |
||
3515 | g_return_val_if_fail (old_uri != NULL, FALSE); |
||
3516 | |||
3517 | item = g_bookmark_file_lookup_item (bookmark, old_uri); |
||
3518 | if (!item) |
||
3519 | { |
||
3520 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
3521 | G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND, |
||
3522 | _("No bookmark found for URI '%s'"), |
||
3523 | old_uri); |
||
3524 | return FALSE; |
||
3525 | } |
||
3526 | |||
3527 | if (new_uri && new_uri[0] != '\0') |
||
3528 | { |
||
3529 | if (g_bookmark_file_has_item (bookmark, new_uri)) |
||
3530 | { |
||
3531 | if (!g_bookmark_file_remove_item (bookmark, new_uri, error)) |
||
3532 | return FALSE; |
||
3533 | } |
||
3534 | |||
3535 | g_hash_table_steal (bookmark->items_by_uri, item->uri); |
||
3536 | |||
3537 | g_free (item->uri); |
||
3538 | item->uri = g_strdup (new_uri); |
||
3539 | item->modified = time (NULL); |
||
3540 | |||
3541 | g_hash_table_replace (bookmark->items_by_uri, item->uri, item); |
||
3542 | |||
3543 | return TRUE; |
||
3544 | } |
||
3545 | else |
||
3546 | { |
||
3547 | if (!g_bookmark_file_remove_item (bookmark, old_uri, error)) |
||
3548 | return FALSE; |
||
3549 | |||
3550 | return TRUE; |
||
3551 | } |
||
3552 | } |
||
3553 | |||
3554 | /** |
||
3555 | * g_bookmark_file_set_icon: |
||
3556 | * @bookmark: a #GBookmarkFile |
||
3557 | * @uri: a valid URI |
||
3558 | * @href: (allow-none): the URI of the icon for the bookmark, or %NULL |
||
3559 | * @mime_type: the MIME type of the icon for the bookmark |
||
3560 | * |
||
3561 | * Sets the icon for the bookmark for @uri. If @href is %NULL, unsets |
||
3562 | * the currently set icon. @href can either be a full URL for the icon |
||
3563 | * file or the icon name following the Icon Naming specification. |
||
3564 | * |
||
3565 | * If no bookmark for @uri is found one is created. |
||
3566 | * |
||
3567 | * Since: 2.12 |
||
3568 | */ |
||
3569 | void |
||
3570 | g_bookmark_file_set_icon (GBookmarkFile *bookmark, |
||
3571 | const gchar *uri, |
||
3572 | const gchar *href, |
||
3573 | const gchar *mime_type) |
||
3574 | { |
||
3575 | BookmarkItem *item; |
||
3576 | |||
3577 | g_return_if_fail (bookmark != NULL); |
||
3578 | g_return_if_fail (uri != NULL); |
||
3579 | |||
3580 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
3581 | if (!item) |
||
3582 | { |
||
3583 | item = bookmark_item_new (uri); |
||
3584 | g_bookmark_file_add_item (bookmark, item, NULL); |
||
3585 | } |
||
3586 | |||
3587 | if (!item->metadata) |
||
3588 | item->metadata = bookmark_metadata_new (); |
||
3589 | |||
3590 | g_free (item->metadata->icon_href); |
||
3591 | g_free (item->metadata->icon_mime); |
||
3592 | |||
3593 | item->metadata->icon_href = g_strdup (href); |
||
3594 | |||
3595 | if (mime_type && mime_type[0] != '\0') |
||
3596 | item->metadata->icon_mime = g_strdup (mime_type); |
||
3597 | else |
||
3598 | item->metadata->icon_mime = g_strdup ("application/octet-stream"); |
||
3599 | |||
3600 | item->modified = time (NULL); |
||
3601 | } |
||
3602 | |||
3603 | /** |
||
3604 | * g_bookmark_file_get_icon: |
||
3605 | * @bookmark: a #GBookmarkFile |
||
3606 | * @uri: a valid URI |
||
3607 | * @href: (allow-none) (out): return location for the icon's location or %NULL |
||
3608 | * @mime_type: (allow-none) (out): return location for the icon's MIME type or %NULL |
||
3609 | * @error: return location for a #GError or %NULL |
||
3610 | * |
||
3611 | * Gets the icon of the bookmark for @uri. |
||
3612 | * |
||
3613 | * In the event the URI cannot be found, %FALSE is returned and |
||
3614 | * @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. |
||
3615 | * |
||
3616 | * Returns: %TRUE if the icon for the bookmark for the URI was found. |
||
3617 | * You should free the returned strings. |
||
3618 | * |
||
3619 | * Since: 2.12 |
||
3620 | */ |
||
3621 | gboolean |
||
3622 | g_bookmark_file_get_icon (GBookmarkFile *bookmark, |
||
3623 | const gchar *uri, |
||
3624 | gchar **href, |
||
3625 | gchar **mime_type, |
||
3626 | GError **error) |
||
3627 | { |
||
3628 | BookmarkItem *item; |
||
3629 | |||
3630 | g_return_val_if_fail (bookmark != NULL, FALSE); |
||
3631 | g_return_val_if_fail (uri != NULL, FALSE); |
||
3632 | |||
3633 | item = g_bookmark_file_lookup_item (bookmark, uri); |
||
3634 | if (!item) |
||
3635 | { |
||
3636 | g_set_error (error, G_BOOKMARK_FILE_ERROR, |
||
3637 | G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND, |
||
3638 | _("No bookmark found for URI '%s'"), |
||
3639 | uri); |
||
3640 | return FALSE; |
||
3641 | } |
||
3642 | |||
3643 | if ((!item->metadata) || (!item->metadata->icon_href)) |
||
3644 | return FALSE; |
||
3645 | |||
3646 | if (href) |
||
3647 | *href = g_strdup (item->metadata->icon_href); |
||
3648 | |||
3649 | if (mime_type) |
||
3650 | *mime_type = g_strdup (item->metadata->icon_mime); |
||
3651 | |||
3652 | return TRUE; |
||
3653 | } |