res_pjsip: Allow configuration of endpoint identifier query order
[asterisk/asterisk.git] / res / res_pjsip_registrar_expire.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*** MODULEINFO
20         <depend>pjproject</depend>
21         <depend>res_pjsip</depend>
22         <support_level>core</support_level>
23  ***/
24
25 #include "asterisk.h"
26
27 #include <pjsip.h>
28
29 #include "asterisk/res_pjsip.h"
30 #include "asterisk/module.h"
31 #include "asterisk/sched.h"
32
33 #define CONTACT_AUTOEXPIRE_BUCKETS 977
34
35 static struct ao2_container *contact_autoexpire;
36
37 /*! \brief Scheduler used for automatically expiring contacts */
38 static struct ast_sched_context *sched;
39
40 /*! \brief Structure used for contact auto-expiration */
41 struct contact_expiration {
42         /*! \brief Contact that is being auto-expired */
43         struct ast_sip_contact *contact;
44
45         /*! \brief Scheduled item for performing expiration */
46         int sched;
47 };
48
49 /*! \brief Destructor function for contact auto-expiration */
50 static void contact_expiration_destroy(void *obj)
51 {
52         struct contact_expiration *expiration = obj;
53
54         ao2_cleanup(expiration->contact);
55 }
56
57 /*! \brief Hashing function for contact auto-expiration */
58 static int contact_expiration_hash(const void *obj, const int flags)
59 {
60         const struct contact_expiration *expiration = obj;
61         const char *id = obj;
62
63         return ast_str_hash(flags & OBJ_KEY ? id : ast_sorcery_object_get_id(expiration->contact));
64 }
65
66 /*! \brief Comparison function for contact auto-expiration */
67 static int contact_expiration_cmp(void *obj, void *arg, int flags)
68 {
69         struct contact_expiration *expiration1 = obj, *expiration2 = arg;
70         const char *id = arg;
71
72         return !strcmp(ast_sorcery_object_get_id(expiration1->contact), flags & OBJ_KEY ? id :
73                        ast_sorcery_object_get_id(expiration2->contact)) ? CMP_MATCH | CMP_STOP : 0;
74 }
75
76 /*! \brief Scheduler function which deletes a contact */
77 static int contact_expiration_expire(const void *data)
78 {
79         RAII_VAR(struct contact_expiration *, expiration, (void*)data, ao2_cleanup);
80
81         expiration->sched = -1;
82
83         /* This will end up invoking the deleted observer callback, which will perform the unlinking and such */
84         ast_sorcery_delete(ast_sip_get_sorcery(), expiration->contact);
85
86         return 0;
87 }
88
89 /*! \brief Observer callback for when a contact is created */
90 static void contact_expiration_observer_created(const void *object)
91 {
92         const struct ast_sip_contact *contact = object;
93         RAII_VAR(struct contact_expiration *, expiration, NULL, ao2_cleanup);
94         int expires = MAX(0, ast_tvdiff_ms(contact->expiration_time, ast_tvnow()));
95
96         if (ast_tvzero(contact->expiration_time)) {
97                 return;
98         }
99
100         if (!(expiration = ao2_alloc_options(sizeof(*expiration), contact_expiration_destroy, AO2_ALLOC_OPT_LOCK_NOLOCK))) {
101                 return;
102         }
103
104         expiration->contact = (struct ast_sip_contact*)contact;
105         ao2_ref(expiration->contact, +1);
106
107         ao2_ref(expiration, +1);
108         if ((expiration->sched = ast_sched_add(sched, expires, contact_expiration_expire, expiration)) < 0) {
109                 ao2_cleanup(expiration);
110                 ast_log(LOG_ERROR, "Scheduled expiration for contact '%s' could not be performed, contact may persist past life\n",
111                         ast_sorcery_object_get_id(contact));
112                 return;
113         }
114
115         ao2_link(contact_autoexpire, expiration);
116 }
117
118 /*! \brief Observer callback for when a contact is updated */
119 static void contact_expiration_observer_updated(const void *object)
120 {
121         const struct ast_sip_contact *contact = object;
122         RAII_VAR(struct contact_expiration *, expiration, ao2_find(contact_autoexpire, ast_sorcery_object_get_id(contact), OBJ_KEY), ao2_cleanup);
123         int expires = MAX(0, ast_tvdiff_ms(contact->expiration_time, ast_tvnow()));
124
125         if (!expiration) {
126                 return;
127         }
128
129         AST_SCHED_REPLACE_UNREF(expiration->sched, sched, expires, contact_expiration_expire, expiration, ao2_cleanup(expiration), ao2_cleanup(expiration), ao2_ref(expiration, +1));
130 }
131
132 /*! \brief Observer callback for when a contact is deleted */
133 static void contact_expiration_observer_deleted(const void *object)
134 {
135         RAII_VAR(struct contact_expiration *, expiration, ao2_find(contact_autoexpire, ast_sorcery_object_get_id(object), OBJ_KEY | OBJ_UNLINK), ao2_cleanup);
136
137         if (!expiration) {
138                 return;
139         }
140
141         AST_SCHED_DEL_UNREF(sched, expiration->sched, ao2_cleanup(expiration));
142 }
143
144 /*! \brief Observer callbacks for autoexpiring contacts */
145 static const struct ast_sorcery_observer contact_expiration_observer = {
146         .created = contact_expiration_observer_created,
147         .updated = contact_expiration_observer_updated,
148         .deleted = contact_expiration_observer_deleted,
149 };
150
151 /*! \brief Callback function which deletes a contact if it has expired or sets up auto-expiry */
152 static int contact_expiration_setup(void *obj, void *arg, int flags)
153 {
154         struct ast_sip_contact *contact = obj;
155         int expires = MAX(0, ast_tvdiff_ms(contact->expiration_time, ast_tvnow()));
156
157         if (!expires) {
158                 ast_sorcery_delete(ast_sip_get_sorcery(), contact);
159         } else {
160                 contact_expiration_observer_created(contact);
161         }
162
163         return 0;
164 }
165
166 /*! \brief Initialize auto-expiration of any existing contacts */
167 static void contact_expiration_initialize_existing(void)
168 {
169         RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
170
171         if (!(contacts = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "contact", AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL))) {
172                 return;
173         }
174
175         ao2_callback(contacts, OBJ_NODATA, contact_expiration_setup, NULL);
176 }
177
178 static int load_module(void)
179 {
180         CHECK_PJSIP_MODULE_LOADED();
181
182         if (!(contact_autoexpire = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_NOLOCK, CONTACT_AUTOEXPIRE_BUCKETS,
183                 contact_expiration_hash, contact_expiration_cmp))) {
184                 ast_log(LOG_ERROR, "Could not create container for contact auto-expiration\n");
185                 return AST_MODULE_LOAD_FAILURE;
186         }
187
188         if (!(sched = ast_sched_context_create())) {
189                 ast_log(LOG_ERROR, "Could not create scheduler for contact auto-expiration\n");
190                 goto error;
191         }
192
193         if (ast_sched_start_thread(sched)) {
194                 ast_log(LOG_ERROR, "Could not start scheduler thread for contact auto-expiration\n");
195                 goto error;
196         }
197
198         contact_expiration_initialize_existing();
199
200         if (ast_sorcery_observer_add(ast_sip_get_sorcery(), "contact", &contact_expiration_observer)) {
201                 ast_log(LOG_ERROR, "Could not add observer for notifications about contacts for contact auto-expiration\n");
202                 goto error;
203         }
204
205         return AST_MODULE_LOAD_SUCCESS;
206
207 error:
208         if (sched) {
209                 ast_sched_context_destroy(sched);
210         }
211
212         ao2_cleanup(contact_autoexpire);
213         return AST_MODULE_LOAD_FAILURE;
214 }
215
216 static int unload_module(void)
217 {
218         ast_sorcery_observer_remove(ast_sip_get_sorcery(), "contact", &contact_expiration_observer);
219         ast_sched_context_destroy(sched);
220         ao2_cleanup(contact_autoexpire);
221
222         return 0;
223 }
224
225 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PJSIP Contact Auto-Expiration",
226                 .support_level = AST_MODULE_SUPPORT_CORE,
227                 .load = load_module,
228                 .unload = unload_module,
229                 .load_pri = AST_MODPRI_APP_DEPEND,
230                );