r24809: Consolidate the use of temporary talloc contexts.
[nivanova/samba-autobuild/.git] / source3 / smbd / notify.c
1 /*
2    Unix SMB/CIFS implementation.
3    change notify handling
4    Copyright (C) Andrew Tridgell 2000
5    Copyright (C) Jeremy Allison 1994-1998
6    Copyright (C) Volker Lendecke 2007
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
20 */
21
22 #include "includes.h"
23
24 struct notify_change_request {
25         struct notify_change_request *prev, *next;
26         struct files_struct *fsp;       /* backpointer for cancel by mid */
27         uint8 request_buf[smb_size];
28         uint32 filter;
29         uint32 max_param;
30         struct notify_mid_map *mid_map;
31         void *backend_data;
32 };
33
34 static void notify_fsp(files_struct *fsp, uint32 action, const char *name);
35
36 static struct notify_mid_map *notify_changes_by_mid;
37
38 /*
39  * For NTCancel, we need to find the notify_change_request indexed by
40  * mid. Separate list here.
41  */
42
43 struct notify_mid_map {
44         struct notify_mid_map *prev, *next;
45         struct notify_change_request *req;
46         uint16 mid;
47 };
48
49 static BOOL notify_change_record_identical(struct notify_change *c1,
50                                         struct notify_change *c2)
51 {
52         /* Note this is deliberately case sensitive. */
53         if (c1->action == c2->action &&
54                         strcmp(c1->name, c2->name) == 0) {
55                 return True;
56         }
57         return False;
58 }
59
60 static BOOL notify_marshall_changes(int num_changes,
61                                 uint32 max_offset,
62                                 struct notify_change *changes,
63                                 prs_struct *ps)
64 {
65         int i;
66         UNISTR uni_name;
67
68         for (i=0; i<num_changes; i++) {
69                 struct notify_change *c;
70                 size_t namelen;
71                 uint32 u32_tmp; /* Temp arg to prs_uint32 to avoid
72                                  * signed/unsigned issues */
73
74                 /* Coalesce any identical records. */
75                 while (i+1 < num_changes &&
76                         notify_change_record_identical(&changes[i],
77                                                 &changes[i+1])) {
78                         i++;
79                 }
80
81                 c = &changes[i];
82
83                 namelen = convert_string_allocate(
84                         NULL, CH_UNIX, CH_UTF16LE, c->name, strlen(c->name)+1,
85                         &uni_name.buffer, True);
86                 if ((namelen == -1) || (uni_name.buffer == NULL)) {
87                         goto fail;
88                 }
89
90                 namelen -= 2;   /* Dump NULL termination */
91
92                 /*
93                  * Offset to next entry, only if there is one
94                  */
95
96                 u32_tmp = (i == num_changes-1) ? 0 : namelen + 12;
97                 if (!prs_uint32("offset", ps, 1, &u32_tmp)) goto fail;
98
99                 u32_tmp = c->action;
100                 if (!prs_uint32("action", ps, 1, &u32_tmp)) goto fail;
101
102                 u32_tmp = namelen;
103                 if (!prs_uint32("namelen", ps, 1, &u32_tmp)) goto fail;
104
105                 if (!prs_unistr("name", ps, 1, &uni_name)) goto fail;
106
107                 /*
108                  * Not NULL terminated, decrease by the 2 UCS2 \0 chars
109                  */
110                 prs_set_offset(ps, prs_offset(ps)-2);
111
112                 SAFE_FREE(uni_name.buffer);
113
114                 if (prs_offset(ps) > max_offset) {
115                         /* Too much data for client. */
116                         return False;
117                 }
118         }
119
120         return True;
121
122  fail:
123         SAFE_FREE(uni_name.buffer);
124         return False;
125 }
126
127 /****************************************************************************
128  Setup the common parts of the return packet and send it.
129 *****************************************************************************/
130
131 static void change_notify_reply_packet(const uint8 *request_buf,
132                                        NTSTATUS error_code)
133 {
134         const char *inbuf = (char *)request_buf;
135         char outbuf[smb_size+38];
136
137         memset(outbuf, '\0', sizeof(outbuf));
138         construct_reply_common(inbuf, outbuf);
139
140         ERROR_NT(error_code);
141
142         /*
143          * Seems NT needs a transact command with an error code
144          * in it. This is a longer packet than a simple error.
145          */
146         set_message(inbuf,outbuf,18,0,False);
147
148         show_msg(outbuf);
149         if (!send_smb(smbd_server_fd(),outbuf))
150                 exit_server_cleanly("change_notify_reply_packet: send_smb "
151                                     "failed.");
152 }
153
154 void change_notify_reply(const uint8 *request_buf, uint32 max_param,
155                          struct notify_change_buf *notify_buf)
156 {
157         prs_struct ps;
158         struct smb_request *req = NULL;
159         uint8 tmp_request[smb_size];
160
161         if (notify_buf->num_changes == -1) {
162                 change_notify_reply_packet(request_buf, NT_STATUS_OK);
163                 notify_buf->num_changes = 0;
164                 return;
165         }
166
167         prs_init(&ps, 0, NULL, MARSHALL);
168
169         if (!notify_marshall_changes(notify_buf->num_changes, max_param,
170                                         notify_buf->changes, &ps)) {
171                 /*
172                  * We exceed what the client is willing to accept. Send
173                  * nothing.
174                  */
175                 change_notify_reply_packet(request_buf, NT_STATUS_OK);
176                 goto done;
177         }
178
179         if (!(req = talloc(talloc_tos(), struct smb_request))) {
180                 change_notify_reply_packet(request_buf, NT_STATUS_NO_MEMORY);
181                 goto done;
182         }
183
184         memcpy(tmp_request, request_buf, smb_size);
185
186         /*
187          * We're only interested in the header fields here
188          */
189
190         smb_setlen(NULL, (char *)tmp_request, smb_size);
191         SCVAL(tmp_request, smb_wct, 0);
192
193         init_smb_request(req, tmp_request);
194
195         send_nt_replies(req, NT_STATUS_OK, prs_data_p(&ps),
196                         prs_offset(&ps), NULL, 0);
197
198  done:
199         TALLOC_FREE(req);
200         prs_mem_free(&ps);
201
202         TALLOC_FREE(notify_buf->changes);
203         notify_buf->num_changes = 0;
204 }
205
206 static void notify_callback(void *private_data, const struct notify_event *e)
207 {
208         files_struct *fsp = (files_struct *)private_data;
209         DEBUG(10, ("notify_callback called for %s\n", fsp->fsp_name));
210         notify_fsp(fsp, e->action, e->path);
211 }
212
213 NTSTATUS change_notify_create(struct files_struct *fsp, uint32 filter,
214                               BOOL recursive)
215 {
216         char *fullpath;
217         struct notify_entry e;
218         NTSTATUS status;
219
220         SMB_ASSERT(fsp->notify == NULL);
221
222         if (!(fsp->notify = TALLOC_ZERO_P(NULL, struct notify_change_buf))) {
223                 DEBUG(0, ("talloc failed\n"));
224                 return NT_STATUS_NO_MEMORY;
225         }
226
227         if (asprintf(&fullpath, "%s/%s", fsp->conn->connectpath,
228                      fsp->fsp_name) == -1) {
229                 DEBUG(0, ("asprintf failed\n"));
230                 return NT_STATUS_NO_MEMORY;
231         }
232
233         e.path = fullpath;
234         e.filter = filter;
235         e.subdir_filter = 0;
236         if (recursive) {
237                 e.subdir_filter = filter;
238         }
239
240         status = notify_add(fsp->conn->notify_ctx, &e, notify_callback, fsp);
241         SAFE_FREE(fullpath);
242
243         return status;
244 }
245
246 NTSTATUS change_notify_add_request(const uint8 *inbuf, uint32 max_param,
247                                    uint32 filter, BOOL recursive,
248                                    struct files_struct *fsp)
249 {
250         struct notify_change_request *request = NULL;
251         struct notify_mid_map *map = NULL;
252
253         if (!(request = SMB_MALLOC_P(struct notify_change_request))
254             || !(map = SMB_MALLOC_P(struct notify_mid_map))) {
255                 SAFE_FREE(request);
256                 return NT_STATUS_NO_MEMORY;
257         }
258
259         request->mid_map = map;
260         map->req = request;
261
262         memcpy(request->request_buf, inbuf, sizeof(request->request_buf));
263         request->max_param = max_param;
264         request->filter = filter;
265         request->fsp = fsp;
266         request->backend_data = NULL;
267
268         DLIST_ADD_END(fsp->notify->requests, request,
269                       struct notify_change_request *);
270
271         map->mid = SVAL(inbuf, smb_mid);
272         DLIST_ADD(notify_changes_by_mid, map);
273
274         /* Push the MID of this packet on the signing queue. */
275         srv_defer_sign_response(SVAL(inbuf,smb_mid));
276
277         return NT_STATUS_OK;
278 }
279
280 static void change_notify_remove_request(struct notify_change_request *remove_req)
281 {
282         files_struct *fsp;
283         struct notify_change_request *req;
284
285         /*
286          * Paranoia checks, the fsp referenced must must have the request in
287          * its list of pending requests
288          */
289
290         fsp = remove_req->fsp;
291         SMB_ASSERT(fsp->notify != NULL);
292
293         for (req = fsp->notify->requests; req; req = req->next) {
294                 if (req == remove_req) {
295                         break;
296                 }
297         }
298
299         if (req == NULL) {
300                 smb_panic("notify_req not found in fsp's requests");
301         }
302
303         DLIST_REMOVE(fsp->notify->requests, req);
304         DLIST_REMOVE(notify_changes_by_mid, req->mid_map);
305         SAFE_FREE(req->mid_map);
306         TALLOC_FREE(req->backend_data);
307         SAFE_FREE(req);
308 }
309
310 /****************************************************************************
311  Delete entries by mid from the change notify pending queue. Always send reply.
312 *****************************************************************************/
313
314 void remove_pending_change_notify_requests_by_mid(uint16 mid)
315 {
316         struct notify_mid_map *map;
317
318         for (map = notify_changes_by_mid; map; map = map->next) {
319                 if (map->mid == mid) {
320                         break;
321                 }
322         }
323
324         if (map == NULL) {
325                 return;
326         }
327
328         change_notify_reply_packet(map->req->request_buf, NT_STATUS_CANCELLED);
329         change_notify_remove_request(map->req);
330 }
331
332 /****************************************************************************
333  Delete entries by fnum from the change notify pending queue.
334 *****************************************************************************/
335
336 void remove_pending_change_notify_requests_by_fid(files_struct *fsp,
337                                                   NTSTATUS status)
338 {
339         if (fsp->notify == NULL) {
340                 return;
341         }
342
343         while (fsp->notify->requests != NULL) {
344                 change_notify_reply_packet(
345                         fsp->notify->requests->request_buf, status);
346                 change_notify_remove_request(fsp->notify->requests);
347         }
348 }
349
350 void notify_fname(connection_struct *conn, uint32 action, uint32 filter,
351                   const char *path)
352 {
353         char *fullpath;
354
355         if (asprintf(&fullpath, "%s/%s", conn->connectpath, path) == -1) {
356                 DEBUG(0, ("asprintf failed\n"));
357                 return;
358         }
359
360         notify_trigger(conn->notify_ctx, action, filter, fullpath);
361         SAFE_FREE(fullpath);
362 }
363
364 static void notify_fsp(files_struct *fsp, uint32 action, const char *name)
365 {
366         struct notify_change *change, *changes;
367         char *tmp;
368
369         if (fsp->notify == NULL) {
370                 /*
371                  * Nobody is waiting, don't queue
372                  */
373                 return;
374         }
375
376         /*
377          * Someone has triggered a notify previously, queue the change for
378          * later.
379          */
380
381         if ((fsp->notify->num_changes > 1000) || (name == NULL)) {
382                 /*
383                  * The real number depends on the client buf, just provide a
384                  * guard against a DoS here.
385                  */
386                 TALLOC_FREE(fsp->notify->changes);
387                 fsp->notify->num_changes = -1;
388                 return;
389         }
390
391         if (fsp->notify->num_changes == -1) {
392                 return;
393         }
394
395         if (!(changes = TALLOC_REALLOC_ARRAY(
396                       fsp->notify, fsp->notify->changes,
397                       struct notify_change, fsp->notify->num_changes+1))) {
398                 DEBUG(0, ("talloc_realloc failed\n"));
399                 return;
400         }
401
402         fsp->notify->changes = changes;
403
404         change = &(fsp->notify->changes[fsp->notify->num_changes]);
405
406         if (!(tmp = talloc_strdup(changes, name))) {
407                 DEBUG(0, ("talloc_strdup failed\n"));
408                 return;
409         }
410
411         string_replace(tmp, '/', '\\');
412         change->name = tmp;     
413
414         change->action = action;
415         fsp->notify->num_changes += 1;
416
417         if (fsp->notify->requests == NULL) {
418                 /*
419                  * Nobody is waiting, so don't send anything. The ot
420                  */
421                 return;
422         }
423
424         if (action == NOTIFY_ACTION_OLD_NAME) {
425                 /*
426                  * We have to send the two rename events in one reply. So hold
427                  * the first part back.
428                  */
429                 return;
430         }
431
432         /*
433          * Someone is waiting for the change, trigger the reply immediately.
434          *
435          * TODO: do we have to walk the lists of requests pending?
436          */
437
438         change_notify_reply(fsp->notify->requests->request_buf,
439                             fsp->notify->requests->max_param,
440                             fsp->notify);
441
442         change_notify_remove_request(fsp->notify->requests);
443 }
444
445 char *notify_filter_string(TALLOC_CTX *mem_ctx, uint32 filter)
446 {
447         char *result = NULL;
448
449         result = talloc_strdup(mem_ctx, "");
450
451         if (filter & FILE_NOTIFY_CHANGE_FILE_NAME)
452                 result = talloc_asprintf_append(result, "FILE_NAME|");
453         if (filter & FILE_NOTIFY_CHANGE_DIR_NAME)
454                 result = talloc_asprintf_append(result, "DIR_NAME|");
455         if (filter & FILE_NOTIFY_CHANGE_ATTRIBUTES)
456                 result = talloc_asprintf_append(result, "ATTRIBUTES|");
457         if (filter & FILE_NOTIFY_CHANGE_SIZE)
458                 result = talloc_asprintf_append(result, "SIZE|");
459         if (filter & FILE_NOTIFY_CHANGE_LAST_WRITE)
460                 result = talloc_asprintf_append(result, "LAST_WRITE|");
461         if (filter & FILE_NOTIFY_CHANGE_LAST_ACCESS)
462                 result = talloc_asprintf_append(result, "LAST_ACCESS|");
463         if (filter & FILE_NOTIFY_CHANGE_CREATION)
464                 result = talloc_asprintf_append(result, "CREATION|");
465         if (filter & FILE_NOTIFY_CHANGE_EA)
466                 result = talloc_asprintf_append(result, "EA|");
467         if (filter & FILE_NOTIFY_CHANGE_SECURITY)
468                 result = talloc_asprintf_append(result, "SECURITY|");
469         if (filter & FILE_NOTIFY_CHANGE_STREAM_NAME)
470                 result = talloc_asprintf_append(result, "STREAM_NAME|");
471         if (filter & FILE_NOTIFY_CHANGE_STREAM_SIZE)
472                 result = talloc_asprintf_append(result, "STREAM_SIZE|");
473         if (filter & FILE_NOTIFY_CHANGE_STREAM_WRITE)
474                 result = talloc_asprintf_append(result, "STREAM_WRITE|");
475
476         if (result == NULL) return NULL;
477         if (*result == '\0') return result;
478
479         result[strlen(result)-1] = '\0';
480         return result;
481 }
482
483 struct sys_notify_context *sys_notify_context_create(connection_struct *conn,
484                                                      TALLOC_CTX *mem_ctx, 
485                                                      struct event_context *ev)
486 {
487         struct sys_notify_context *ctx;
488
489         if (!(ctx = TALLOC_P(mem_ctx, struct sys_notify_context))) {
490                 DEBUG(0, ("talloc failed\n"));
491                 return NULL;
492         }
493
494         ctx->ev = ev;
495         ctx->conn = conn;
496         ctx->private_data = NULL;
497         return ctx;
498 }
499
500 NTSTATUS sys_notify_watch(struct sys_notify_context *ctx,
501                           struct notify_entry *e,
502                           void (*callback)(struct sys_notify_context *ctx, 
503                                            void *private_data,
504                                            struct notify_event *ev),
505                           void *private_data, void *handle)
506 {
507         return SMB_VFS_NOTIFY_WATCH(ctx->conn, ctx, e, callback, private_data,
508                                     handle);
509 }
510