Mercurial > dovecot > original-hg > dovecot-1.2

annotate src/lib-storage/mail-namespace.h @ 6978:4fb1b0f43d60 HEAD

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mail_storage_create() now finishes namespace initialization so namespaces can be created more easily.
author Timo Sirainen <tss@iki.fi>
date Sun, 09 Dec 2007 15:50:24 +0200
parents e1fde9940f7e
children 81806d402514
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6410
e4eb71ae8e96 Changed .h ifdef/defines to use <NAME>_H format.
Timo Sirainen <tss@iki.fi>
parents: 6236
diff changeset
1 #ifndef MAIL_NAMESPACE_H
e4eb71ae8e96 Changed .h ifdef/defines to use <NAME>_H format.
Timo Sirainen <tss@iki.fi>
parents: 6236
diff changeset
2 #define MAIL_NAMESPACE_H
5500
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
3
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
4 enum namespace_type {
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
5 NAMESPACE_PRIVATE,
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
6 NAMESPACE_SHARED,
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
7 NAMESPACE_PUBLIC
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
8 };
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
9
5808
45735dd11f17 Moved several namespace booleans to a flags field. Removed unused
Timo Sirainen <tss@iki.fi>
parents: 5804
diff changeset
10 enum namespace_flags {
45735dd11f17 Moved several namespace booleans to a flags field. Removed unused
Timo Sirainen <tss@iki.fi>
parents: 5804
diff changeset
11 /* Namespace contains the INBOX mailbox (there can be only one) */
6603
afc28dd2d4c5 Added subscriptions setting to namespaces to specify if it should handle
Timo Sirainen <tss@iki.fi>
parents: 6459
diff changeset
12 NAMESPACE_FLAG_INBOX = 0x01,
5808
45735dd11f17 Moved several namespace booleans to a flags field. Removed unused
Timo Sirainen <tss@iki.fi>
parents: 5804
diff changeset
13 /* Namespace is visible only by explicitly using its full prefix */
6603
afc28dd2d4c5 Added subscriptions setting to namespaces to specify if it should handle
Timo Sirainen <tss@iki.fi>
parents: 6459
diff changeset
14 NAMESPACE_FLAG_HIDDEN = 0x02,
5808
45735dd11f17 Moved several namespace booleans to a flags field. Removed unused
Timo Sirainen <tss@iki.fi>
parents: 5804
diff changeset
15 /* Namespace is visible with LIST */
6603
afc28dd2d4c5 Added subscriptions setting to namespaces to specify if it should handle
Timo Sirainen <tss@iki.fi>
parents: 6459
diff changeset
16 NAMESPACE_FLAG_LIST = 0x04,
afc28dd2d4c5 Added subscriptions setting to namespaces to specify if it should handle
Timo Sirainen <tss@iki.fi>
parents: 6459
diff changeset
17 /* Namespace uses its own subscriptions. */
afc28dd2d4c5 Added subscriptions setting to namespaces to specify if it should handle
Timo Sirainen <tss@iki.fi>
parents: 6459
diff changeset
18 NAMESPACE_FLAG_SUBSCRIPTIONS = 0x10,
afc28dd2d4c5 Added subscriptions setting to namespaces to specify if it should handle
Timo Sirainen <tss@iki.fi>
parents: 6459
diff changeset
19
6459
c6849b4a3812 Mark deliver's dummy mbox namespace as internal and don't include it in
Timo Sirainen <tss@iki.fi>
parents: 6410
diff changeset
20 /* Namespace is created for internal use only. */
6603
afc28dd2d4c5 Added subscriptions setting to namespaces to specify if it should handle
Timo Sirainen <tss@iki.fi>
parents: 6459
diff changeset
21 NAMESPACE_FLAG_INTERNAL = 0x1000
5808
45735dd11f17 Moved several namespace booleans to a flags field. Removed unused
Timo Sirainen <tss@iki.fi>
parents: 5804
diff changeset
22 };
45735dd11f17 Moved several namespace booleans to a flags field. Removed unused
Timo Sirainen <tss@iki.fi>
parents: 5804
diff changeset
23
5500
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
24 struct mail_namespace {
5804
c7f35a9beb0b Store namespaces sorted by their prefix length.
Timo Sirainen <tss@iki.fi>
parents: 5802
diff changeset
25 /* Namespaces are sorted by their prefix length, "" comes first */
5500
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
26 struct mail_namespace *next;
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
27
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
28 enum namespace_type type;
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
29 char sep, real_sep, sep_str[3];
5808
45735dd11f17 Moved several namespace booleans to a flags field. Removed unused
Timo Sirainen <tss@iki.fi>
parents: 5804
diff changeset
30 enum namespace_flags flags;
5500
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
31
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
32 const char *prefix;
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
33 size_t prefix_len;
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
34
5539
7d828d1b39ab Added mailbox_list to struct mail_namespace. Added a few functions to get
Timo Sirainen <tss@iki.fi>
parents: 5500
diff changeset
35 struct mailbox_list *list;
7d828d1b39ab Added mailbox_list to struct mail_namespace. Added a few functions to get
Timo Sirainen <tss@iki.fi>
parents: 5500
diff changeset
36 /* FIXME: we should support multiple storages in one namespace */
5500
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
37 struct mail_storage *storage;
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
38 };
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
39
6236
aca5c234b71a Added hook_mail_namespaces_created.
Timo Sirainen <tss@iki.fi>
parents: 5810
diff changeset
40 /* Called after namespaces has been created */
aca5c234b71a Added hook_mail_namespaces_created.
Timo Sirainen <tss@iki.fi>
parents: 5810
diff changeset
41 extern void (*hook_mail_namespaces_created)(struct mail_namespace *namespaces);
aca5c234b71a Added hook_mail_namespaces_created.
Timo Sirainen <tss@iki.fi>
parents: 5810
diff changeset
42
5500
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
43 int mail_namespaces_init(pool_t pool, const char *user,
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
44 struct mail_namespace **namespaces_r);
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
45 struct mail_namespace *mail_namespaces_init_empty(pool_t pool);
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
46 void mail_namespaces_deinit(struct mail_namespace **namespaces);
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
47
5576
36ebd0fe2076 Added mail_namespace_update_name()
Timo Sirainen <tss@iki.fi>
parents: 5539
diff changeset
48 /* Update hierarchy separators in given name to real_sep characters. */
5500
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
49 const char *mail_namespace_fix_sep(struct mail_namespace *ns, const char *name);
6639
e1fde9940f7e Fixes to handling namespace prefixes and real!=virtual separator. Added a
Timo Sirainen <tss@iki.fi>
parents: 6603
diff changeset
50 /* Write virtual mailbox name to dest and return it. Separators are changed to
e1fde9940f7e Fixes to handling namespace prefixes and real!=virtual separator. Added a
Timo Sirainen <tss@iki.fi>
parents: 6603
diff changeset
51 virtual ones and namespace prefix is inserted except for INBOX. */
e1fde9940f7e Fixes to handling namespace prefixes and real!=virtual separator. Added a
Timo Sirainen <tss@iki.fi>
parents: 6603
diff changeset
52 const char *mail_namespace_get_vname(struct mail_namespace *ns, string_t *dest,
e1fde9940f7e Fixes to handling namespace prefixes and real!=virtual separator. Added a
Timo Sirainen <tss@iki.fi>
parents: 6603
diff changeset
53 const char *name);
e1fde9940f7e Fixes to handling namespace prefixes and real!=virtual separator. Added a
Timo Sirainen <tss@iki.fi>
parents: 6603
diff changeset
54
5802
8416f66ac5ab Make sure all listable namespaces use the same separator. If there's no ref
Timo Sirainen <tss@iki.fi>
parents: 5800
diff changeset
55 /* Returns the hierarchy separator for mailboxes that are listed at root. */
8416f66ac5ab Make sure all listable namespaces use the same separator. If there's no ref
Timo Sirainen <tss@iki.fi>
parents: 5800
diff changeset
56 char mail_namespace_get_root_sep(struct mail_namespace *namespaces);
5500
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
57
5576
36ebd0fe2076 Added mail_namespace_update_name()
Timo Sirainen <tss@iki.fi>
parents: 5539
diff changeset
58 /* Returns namespace based on the mailbox name's prefix. Updates mailbox to
36ebd0fe2076 Added mail_namespace_update_name()
Timo Sirainen <tss@iki.fi>
parents: 5539
diff changeset
59 be a valid name inside the namespace (prefix is skipped, hierarchy separator
36ebd0fe2076 Added mail_namespace_update_name()
Timo Sirainen <tss@iki.fi>
parents: 5539
diff changeset
60 is changed to real_sep). If no namespaces were found, returns NULL. */
5500
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
61 struct mail_namespace *
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
62 mail_namespace_find(struct mail_namespace *namespaces, const char **mailbox);
5576
36ebd0fe2076 Added mail_namespace_update_name()
Timo Sirainen <tss@iki.fi>
parents: 5539
diff changeset
63 /* Like above, but ignore hidden namespaces. */
5500
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
64 struct mail_namespace *
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
65 mail_namespace_find_visible(struct mail_namespace *namespaces,
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
66 const char **mailbox);
6603
afc28dd2d4c5 Added subscriptions setting to namespaces to specify if it should handle
Timo Sirainen <tss@iki.fi>
parents: 6459
diff changeset
67 /* Like above, but find only from namespaces with subscriptions flag set. */
afc28dd2d4c5 Added subscriptions setting to namespaces to specify if it should handle
Timo Sirainen <tss@iki.fi>
parents: 6459
diff changeset
68 struct mail_namespace *
afc28dd2d4c5 Added subscriptions setting to namespaces to specify if it should handle
Timo Sirainen <tss@iki.fi>
parents: 6459
diff changeset
69 mail_namespace_find_subscribable(struct mail_namespace *namespaces,
afc28dd2d4c5 Added subscriptions setting to namespaces to specify if it should handle
Timo Sirainen <tss@iki.fi>
parents: 6459
diff changeset
70 const char **mailbox);
5810
f56a71347378 Added mail_namespace_find_inbox() and mail_namespace_find_prefix_nosep()
Timo Sirainen <tss@iki.fi>
parents: 5808
diff changeset
71 /* Returns the INBOX namespace */
f56a71347378 Added mail_namespace_find_inbox() and mail_namespace_find_prefix_nosep()
Timo Sirainen <tss@iki.fi>
parents: 5808
diff changeset
72 struct mail_namespace *
f56a71347378 Added mail_namespace_find_inbox() and mail_namespace_find_prefix_nosep()
Timo Sirainen <tss@iki.fi>
parents: 5808
diff changeset
73 mail_namespace_find_inbox(struct mail_namespace *namespaces);
5576
36ebd0fe2076 Added mail_namespace_update_name()
Timo Sirainen <tss@iki.fi>
parents: 5539
diff changeset
74 /* Returns TRUE if the given namespace matches the mailbox's prefix.
36ebd0fe2076 Added mail_namespace_update_name()
Timo Sirainen <tss@iki.fi>
parents: 5539
diff changeset
75 Updates mailbox name to be a valid name inside the namespace. */
36ebd0fe2076 Added mail_namespace_update_name()
Timo Sirainen <tss@iki.fi>
parents: 5539
diff changeset
76 bool mail_namespace_update_name(struct mail_namespace *ns,
36ebd0fe2076 Added mail_namespace_update_name()
Timo Sirainen <tss@iki.fi>
parents: 5539
diff changeset
77 const char **mailbox);
36ebd0fe2076 Added mail_namespace_update_name()
Timo Sirainen <tss@iki.fi>
parents: 5539
diff changeset
78
36ebd0fe2076 Added mail_namespace_update_name()
Timo Sirainen <tss@iki.fi>
parents: 5539
diff changeset
79 /* Find a namespace with given prefix. */
5500
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
80 struct mail_namespace *
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
81 mail_namespace_find_prefix(struct mail_namespace *namespaces,
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
82 const char *prefix);
5810
f56a71347378 Added mail_namespace_find_inbox() and mail_namespace_find_prefix_nosep()
Timo Sirainen <tss@iki.fi>
parents: 5808
diff changeset
83 /* Like _find_prefix(), but ignore trailing separator */
f56a71347378 Added mail_namespace_find_inbox() and mail_namespace_find_prefix_nosep()
Timo Sirainen <tss@iki.fi>
parents: 5808
diff changeset
84 struct mail_namespace *
f56a71347378 Added mail_namespace_find_inbox() and mail_namespace_find_prefix_nosep()
Timo Sirainen <tss@iki.fi>
parents: 5808
diff changeset
85 mail_namespace_find_prefix_nosep(struct mail_namespace *namespaces,
f56a71347378 Added mail_namespace_find_inbox() and mail_namespace_find_prefix_nosep()
Timo Sirainen <tss@iki.fi>
parents: 5808
diff changeset
86 const char *prefix);
5500
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
87
6978
4fb1b0f43d60 mail_storage_create() now finishes namespace initialization so namespaces
Timo Sirainen <tss@iki.fi>
parents: 6639
diff changeset
88 /* Called internally by mail_storage_create(). */
4fb1b0f43d60 mail_storage_create() now finishes namespace initialization so namespaces
Timo Sirainen <tss@iki.fi>
parents: 6639
diff changeset
89 void mail_namespace_init_storage(struct mail_namespace *ns);
4fb1b0f43d60 mail_storage_create() now finishes namespace initialization so namespaces
Timo Sirainen <tss@iki.fi>
parents: 6639
diff changeset
90
5500
4862cb37106c Moved namespace handling to lib-storage. Beginnings of namespace support for
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
91 #endif