1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
|
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
/* e-local-folder.c
*
* Copyright (C) 2000 Ximian, Inc.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of version 2 of the GNU General Public
* published by the Free Software Foundation; either version 2 of the
* License as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this program; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*
* Author: Ettore Perazzoli
*/
/* The metafile goes like this:
<?xml version="1.0"?>
<efolder>
<type>mail</type>
<name>Inbox</name>
<name locale="it">Posta in Arrivo</name>
<description>This is the default folder for incoming messages</description>
<description locale="it">Cartella che contiene i messaggi in arrivo</description>
<homepage>http://www.somewhere.net</homepage>
</efolder>
FIXME: Do we want to use a namespace for this?
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <string.h>
#include <unistd.h>
#include <gnome-xml/parser.h>
#include <gnome-xml/xmlmemory.h>
#include <libgnome/gnome-defs.h>
#include <libgnome/gnome-util.h>
#include <gal/util/e-util.h>
#include <gal/util/e-xml-utils.h>
#include <libgnome/gnome-util.h>
#include "e-local-folder.h"
#define PARENT_TYPE E_TYPE_FOLDER
static EFolderClass *parent_class = NULL;
#define URI_PREFIX "file://"
#define URI_PREFIX_LEN 7
/* This provides the name and the description for a specific locale. */
struct _I18nInfo {
char *language_id;
char *name;
char *description;
};
typedef struct _I18nInfo I18nInfo;
struct _ELocalFolderPrivate {
GHashTable *language_id_to_i18n_info;
};
/* Locale information. */
static char *global_language_id = NULL;
/* I18nInfo handling. */
static I18nInfo *
i18n_info_new (const char *language_id,
const char *name,
const char *description)
{
I18nInfo *info;
info = g_new (I18nInfo, 1);
info->language_id = g_strdup (language_id);
info->name = g_strdup (name);
info->description = g_strdup (description);
return info;
}
static void
i18n_info_free (I18nInfo *info)
{
g_free (info->language_id);
g_free (info->name);
g_free (info->description);
g_free (info);
}
/* Language ID -> I18nInfo hash table handling. */
static void
add_i18n_info_to_hash (GHashTable *language_id_to_i18n_info_hash,
I18nInfo *i18n_info)
{
I18nInfo *existing_i18n_info;
existing_i18n_info = (I18nInfo *) g_hash_table_lookup (language_id_to_i18n_info_hash,
i18n_info->language_id);
if (existing_i18n_info != NULL) {
g_hash_table_remove (language_id_to_i18n_info_hash,
i18n_info->language_id);
i18n_info_free (existing_i18n_info);
}
g_hash_table_insert (language_id_to_i18n_info_hash, i18n_info->language_id, i18n_info);
}
static void
language_id_to_i18n_info_hash_foreach_free (void *key,
void *value,
void *data)
{
i18n_info_free ((I18nInfo *) value);
}
static I18nInfo *
get_i18n_info_for_language (ELocalFolder *local_folder,
const char *language_id)
{
ELocalFolderPrivate *priv;
I18nInfo *i18n_info;
priv = local_folder->priv;
if (language_id == NULL)
language_id = global_language_id;
i18n_info = g_hash_table_lookup (priv->language_id_to_i18n_info, language_id);
/* For locale info like `en_UK@yadda', we try to use `en' as a backup. */
/* Note: this is exactly the same thing that gnome-config does with the
I18N value handling. I hope it works. */
if (i18n_info == NULL) {
size_t n;
n = strcspn (language_id, "@_");
if (language_id[n] != '\0') {
char *simplified_language_id;
simplified_language_id = g_strndup (language_id, n);
i18n_info = g_hash_table_lookup (priv->language_id_to_i18n_info,
simplified_language_id);
}
}
return i18n_info;
}
/* Locale handling. */
static void
setup_global_language_id (void)
{
/* FIXME: Implement. */
global_language_id = "C";
}
/* Update the EFolder attributes according to the current locale. */
static void
update_for_global_locale (ELocalFolder *local_folder)
{
I18nInfo *i18n_info;
i18n_info = get_i18n_info_for_language (local_folder, NULL);
if (i18n_info == NULL)
i18n_info = get_i18n_info_for_language (local_folder, "C");
g_assert (i18n_info != NULL);
e_folder_set_name (E_FOLDER (local_folder), i18n_info->name);
e_folder_set_description (E_FOLDER (local_folder), i18n_info->description);
}
/* XML tree handling. */
static char *
get_string_value (xmlNode *node,
const char *name)
{
xmlNode *p;
xmlChar *xml_string;
char *retval;
p = e_xml_get_child_by_name (node, (xmlChar *) name);
if (p == NULL)
return NULL;
p = e_xml_get_child_by_name (p, (xmlChar *) "text");
if (p == NULL)
return NULL;
xml_string = xmlNodeListGetString (node->doc, p, TRUE);
retval = g_strdup ((char *) xml_string);
xmlFree (xml_string);
return retval;
}
static void
retrieve_info_item (ELocalFolder *local_folder,
xmlNode *node)
{
xmlChar *lang;
char *name;
char *description;
lang = xmlGetProp (node, "lang");
name = get_string_value (node, "name");
description = get_string_value (node, "description");
if (lang == NULL) {
e_local_folder_add_i18n_info (local_folder, "C", name, description);
} else {
e_local_folder_add_i18n_info (local_folder, lang, name, description);
xmlFree (lang);
}
g_free (name);
g_free (description);
}
static void
retrieve_info (ELocalFolder *local_folder,
xmlNode *root_xml_node)
{
ELocalFolderPrivate *priv;
xmlNode *p;
priv = local_folder->priv;
for (p = root_xml_node->childs; p != NULL; p = p->next) {
if (xmlStrcmp (p->name, "info") == 0)
retrieve_info_item (local_folder, p);
}
}
static gboolean
construct_loading_metadata (ELocalFolder *local_folder,
const char *path)
{
EFolder *folder;
xmlDoc *doc;
xmlNode *root;
char *type;
char *metadata_path;
char *physical_uri;
folder = E_FOLDER (local_folder);
metadata_path = g_concat_dir_and_file (path, E_LOCAL_FOLDER_METADATA_FILE_NAME);
doc = xmlParseFile (metadata_path);
if (doc == NULL) {
g_free (metadata_path);
return FALSE;
}
root = xmlDocGetRootElement (doc);
if (root == NULL || strcmp (root->name, "efolder") != 0) {
g_free (metadata_path);
xmlFreeDoc (doc);
return FALSE;
}
type = get_string_value (root, "type");
if (type == NULL) {
g_free (metadata_path);
xmlFreeDoc (doc);
return FALSE;
}
e_local_folder_construct (local_folder, g_basename (path), type, NULL);
g_free (type);
retrieve_info (local_folder, root);
xmlFreeDoc (doc);
physical_uri = g_strconcat (URI_PREFIX, path, NULL);
e_folder_set_physical_uri (folder, physical_uri);
g_free (physical_uri);
g_free (metadata_path);
return TRUE;
}
static gboolean
save_metadata (ELocalFolder *local_folder)
{
EFolder *folder;
xmlDoc *doc;
xmlNode *root;
const char *physical_directory;
char *physical_path;
folder = E_FOLDER (local_folder);
doc = xmlNewDoc ((xmlChar *) "1.0");
root = xmlNewDocNode (doc, NULL, (xmlChar *) "efolder", NULL);
xmlDocSetRootElement (doc, root);
xmlNewChild (root, NULL, (xmlChar *) "type",
(xmlChar *) e_folder_get_type_string (folder));
if (e_folder_get_description (folder) != NULL)
xmlNewTextChild (root, NULL, (xmlChar *) "description",
(xmlChar *) e_folder_get_description (folder));
physical_directory = e_folder_get_physical_uri (folder) + URI_PREFIX_LEN - 1;
physical_path = g_concat_dir_and_file (physical_directory, E_LOCAL_FOLDER_METADATA_FILE_NAME);
if (xmlSaveFile (physical_path, doc) < 0) {
unlink (physical_path);
g_free (physical_path);
xmlFreeDoc (doc);
return FALSE;
}
g_free (physical_path);
xmlFreeDoc (doc);
return TRUE;
}
/* GtkObject methods. */
static void
destroy (GtkObject *object)
{
ELocalFolder *local_folder;
ELocalFolderPrivate *priv;
local_folder = E_LOCAL_FOLDER (object);
priv = local_folder->priv;
g_hash_table_foreach (priv->language_id_to_i18n_info,
language_id_to_i18n_info_hash_foreach_free,
NULL);
g_hash_table_destroy (priv->language_id_to_i18n_info);
g_free (priv);
(* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
}
static void
class_init (ELocalFolderClass *klass)
{
GtkObjectClass *object_class;
parent_class = gtk_type_class (e_folder_get_type ());
object_class = GTK_OBJECT_CLASS (klass);
object_class->destroy = destroy;
setup_global_language_id ();
}
static void
init (ELocalFolder *local_folder)
{
ELocalFolderPrivate *priv;
priv = g_new (ELocalFolderPrivate, 1);
priv->language_id_to_i18n_info = g_hash_table_new (g_str_hash, g_str_equal);
local_folder->priv = priv;
}
void
e_local_folder_construct (ELocalFolder *local_folder,
const char *name,
const char *type,
const char *description)
{
ELocalFolderPrivate *priv;
I18nInfo *i18n_info;
g_return_if_fail (local_folder != NULL);
g_return_if_fail (E_IS_LOCAL_FOLDER (local_folder));
g_return_if_fail (name != NULL);
g_return_if_fail (type != NULL);
priv = local_folder->priv;
e_folder_construct (E_FOLDER (local_folder), name, type, description);
i18n_info = i18n_info_new ("C", name, description);
add_i18n_info_to_hash (priv->language_id_to_i18n_info, i18n_info);
}
EFolder *
e_local_folder_new (const char *name,
const char *type,
const char *description)
{
ELocalFolder *local_folder;
g_return_val_if_fail (name != NULL, NULL);
g_return_val_if_fail (type != NULL, NULL);
local_folder = gtk_type_new (e_local_folder_get_type ());
e_local_folder_construct (local_folder, name, type, description);
return E_FOLDER (local_folder);
}
EFolder *
e_local_folder_new_from_path (const char *path)
{
EFolder *folder;
g_return_val_if_fail (g_path_is_absolute (path), NULL);
folder = gtk_type_new (e_local_folder_get_type ());
if (! construct_loading_metadata (E_LOCAL_FOLDER (folder), path)) {
gtk_object_unref (GTK_OBJECT (folder));
return NULL;
}
return folder;
}
gboolean
e_local_folder_save (ELocalFolder *local_folder)
{
g_return_val_if_fail (local_folder != NULL, FALSE);
g_return_val_if_fail (E_IS_LOCAL_FOLDER (local_folder), FALSE);
g_return_val_if_fail (e_folder_get_physical_uri (E_FOLDER (local_folder)) != NULL, FALSE);
return save_metadata (local_folder);
}
/**
* e_local_folder_add_i18n_info:
* @local_folder: A pointer to an ELocalFolder object
* @language_id: An I1I8N locale ID
* @name: Name for @local_folder in the specified @language_id
* @description: Description for @local_folder in the specified @language_id
*
* Set the @name and @description for the specified @language_id locale.
**/
void
e_local_folder_add_i18n_info (ELocalFolder *local_folder,
const char *language_id,
const char *name,
const char *description)
{
ELocalFolderPrivate *priv;
I18nInfo *info;
g_return_if_fail (local_folder != NULL);
g_return_if_fail (E_IS_LOCAL_FOLDER (local_folder));
g_return_if_fail (language_id != NULL);
g_return_if_fail (name != NULL || description != NULL);
priv = local_folder->priv;
info = i18n_info_new (language_id, name, description);
add_i18n_info_to_hash (priv->language_id_to_i18n_info, info);
update_for_global_locale (local_folder);
}
/**
* e_local_folder_get_i18n_info:
* @local_folder: A pointer to an ELocalFolder object
* @language_id: The ID of the language whose locale we want to retrieve name
* and description for
* @language_id_return: The actual locale ID that the name and description are
* saved under (e.g. if you ask for an "en_UK@yadda", we might give you the
* info for just "en")
* @name_return: A pointer to a pointer that will point to the i18nized name on
* return. Can be NULL.
* @description_return: A pointer to a pointer that will point to the i18n
* description on return. Can be NULL.
*
* Retrieve the name and description for @local_folder in the specified locale.
*
* Return value: %TRUE if some info is found for that @language_id, %FALSE
* otherwise.
**/
gboolean
e_local_folder_get_i18n_info (ELocalFolder *local_folder,
const char *language_id,
const char **language_id_return,
const char **name_return,
const char **description_return)
{
ELocalFolderPrivate *priv;
I18nInfo *i18n_info;
g_return_val_if_fail (local_folder != NULL, FALSE);
g_return_val_if_fail (E_IS_LOCAL_FOLDER (local_folder), FALSE);
g_return_val_if_fail (language_id != NULL, FALSE);
priv = local_folder->priv;
i18n_info = get_i18n_info_for_language (local_folder, language_id);
if (i18n_info == NULL) {
if (language_id_return != NULL)
*language_id_return = NULL;
if (name_return != NULL)
*name_return = NULL;
if (description_return != NULL)
*description_return = NULL;
return FALSE;
}
if (language_id_return != NULL)
*language_id_return = i18n_info->language_id;
if (name_return != NULL)
*name_return = i18n_info->name;
if (description_return != NULL)
*description_return = i18n_info->description;
return TRUE;
}
E_MAKE_TYPE (e_local_folder, "ELocalFolder", ELocalFolder, class_init, init, PARENT_TYPE)
|