Merge branch 'v3-2-test' of ssh://jra@git.samba.org/data/git/samba into v3-2-test
[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(connection_struct *conn,
132                                 const uint8 *request_buf,
133                                        NTSTATUS error_code)
134 {
135         char outbuf[smb_size+38];
136
137         memset(outbuf, '\0', sizeof(outbuf));
138         construct_reply_common((char *)request_buf, 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         srv_set_message(outbuf,18,0,False);
147
148         show_msg(outbuf);
149         if (!srv_send_smb(smbd_server_fd(),
150                         outbuf,
151                         IS_CONN_ENCRYPTED(conn)))
152                 exit_server_cleanly("change_notify_reply_packet: srv_send_smb "
153                                     "failed.");
154 }
155
156 void change_notify_reply(connection_struct *conn,
157                         const uint8 *request_buf, uint32 max_param,
158                          struct notify_change_buf *notify_buf)
159 {
160         prs_struct ps;
161         struct smb_request *req = NULL;
162         uint8 tmp_request[smb_size];
163
164         if (notify_buf->num_changes == -1) {
165                 change_notify_reply_packet(conn, request_buf, NT_STATUS_OK);
166                 notify_buf->num_changes = 0;
167                 return;
168         }
169
170         prs_init(&ps, 0, NULL, MARSHALL);
171
172         if (!notify_marshall_changes(notify_buf->num_changes, max_param,
173                                         notify_buf->changes, &ps)) {
174                 /*
175                  * We exceed what the client is willing to accept. Send
176                  * nothing.
177                  */
178                 change_notify_reply_packet(conn, request_buf, NT_STATUS_OK);
179                 goto done;
180         }
181
182         if (!(req = talloc(talloc_tos(), struct smb_request))) {
183                 change_notify_reply_packet(conn, request_buf, NT_STATUS_NO_MEMORY);
184                 goto done;
185         }
186
187         memcpy(tmp_request, request_buf, smb_size);
188
189         /*
190          * We're only interested in the header fields here
191          */
192
193         smb_setlen((char *)tmp_request, smb_size);
194         SCVAL(tmp_request, smb_wct, 0);
195
196         init_smb_request(req, tmp_request,0, conn->encrypted_tid);
197
198         send_nt_replies(conn, req, NT_STATUS_OK, prs_data_p(&ps),
199                         prs_offset(&ps), NULL, 0);
200
201  done:
202         TALLOC_FREE(req);
203         prs_mem_free(&ps);
204
205         TALLOC_FREE(notify_buf->changes);
206         notify_buf->num_changes = 0;
207 }
208
209 static void notify_callback(void *private_data, const struct notify_event *e)
210 {
211         files_struct *fsp = (files_struct *)private_data;
212         DEBUG(10, ("notify_callback called for %s\n", fsp->fsp_name));
213         notify_fsp(fsp, e->action, e->path);
214 }
215
216 NTSTATUS change_notify_create(struct files_struct *fsp, uint32 filter,
217                               bool recursive)
218 {
219         char *fullpath;
220         struct notify_entry e;
221         NTSTATUS status;
222
223         SMB_ASSERT(fsp->notify == NULL);
224
225         if (!(fsp->notify = TALLOC_ZERO_P(NULL, struct notify_change_buf))) {
226                 DEBUG(0, ("talloc failed\n"));
227                 return NT_STATUS_NO_MEMORY;
228         }
229
230         if (asprintf(&fullpath, "%s/%s", fsp->conn->connectpath,
231                      fsp->fsp_name) == -1) {
232                 DEBUG(0, ("asprintf failed\n"));
233                 return NT_STATUS_NO_MEMORY;
234         }
235
236         e.path = fullpath;
237         e.filter = filter;
238         e.subdir_filter = 0;
239         if (recursive) {
240                 e.subdir_filter = filter;
241         }
242
243         status = notify_add(fsp->conn->notify_ctx, &e, notify_callback, fsp);
244         SAFE_FREE(fullpath);
245
246         return status;
247 }
248
249 NTSTATUS change_notify_add_request(const struct smb_request *req,
250                                 uint32 max_param,
251                                 uint32 filter, bool recursive,
252                                 struct files_struct *fsp)
253 {
254         struct notify_change_request *request = NULL;
255         struct notify_mid_map *map = NULL;
256
257         if (!(request = SMB_MALLOC_P(struct notify_change_request))
258             || !(map = SMB_MALLOC_P(struct notify_mid_map))) {
259                 SAFE_FREE(request);
260                 return NT_STATUS_NO_MEMORY;
261         }
262
263         request->mid_map = map;
264         map->req = request;
265
266         memcpy(request->request_buf, req->inbuf, sizeof(request->request_buf));
267         request->max_param = max_param;
268         request->filter = filter;
269         request->fsp = fsp;
270         request->backend_data = NULL;
271
272         DLIST_ADD_END(fsp->notify->requests, request,
273                       struct notify_change_request *);
274
275         map->mid = SVAL(req->inbuf, smb_mid);
276         DLIST_ADD(notify_changes_by_mid, map);
277
278         /* Push the MID of this packet on the signing queue. */
279         srv_defer_sign_response(SVAL(req->inbuf,smb_mid));
280
281         return NT_STATUS_OK;
282 }
283
284 static void change_notify_remove_request(struct notify_change_request *remove_req)
285 {
286         files_struct *fsp;
287         struct notify_change_request *req;
288
289         /*
290          * Paranoia checks, the fsp referenced must must have the request in
291          * its list of pending requests
292          */
293
294         fsp = remove_req->fsp;
295         SMB_ASSERT(fsp->notify != NULL);
296
297         for (req = fsp->notify->requests; req; req = req->next) {
298                 if (req == remove_req) {
299                         break;
300                 }
301         }
302
303         if (req == NULL) {
304                 smb_panic("notify_req not found in fsp's requests");
305         }
306
307         DLIST_REMOVE(fsp->notify->requests, req);
308         DLIST_REMOVE(notify_changes_by_mid, req->mid_map);
309         SAFE_FREE(req->mid_map);
310         TALLOC_FREE(req->backend_data);
311         SAFE_FREE(req);
312 }
313
314 /****************************************************************************
315  Delete entries by mid from the change notify pending queue. Always send reply.
316 *****************************************************************************/
317
318 void remove_pending_change_notify_requests_by_mid(uint16 mid)
319 {
320         struct notify_mid_map *map;
321
322         for (map = notify_changes_by_mid; map; map = map->next) {
323                 if (map->mid == mid) {
324                         break;
325                 }
326         }
327
328         if (map == NULL) {
329                 return;
330         }
331
332         change_notify_reply_packet(map->req->fsp->conn,
333                         map->req->request_buf, NT_STATUS_CANCELLED);
334         change_notify_remove_request(map->req);
335 }
336
337 /****************************************************************************
338  Delete entries by fnum from the change notify pending queue.
339 *****************************************************************************/
340
341 void remove_pending_change_notify_requests_by_fid(files_struct *fsp,
342                                                   NTSTATUS status)
343 {
344         if (fsp->notify == NULL) {
345                 return;
346         }
347
348         while (fsp->notify->requests != NULL) {
349                 change_notify_reply_packet(fsp->conn,
350                         fsp->notify->requests->request_buf, status);
351                 change_notify_remove_request(fsp->notify->requests);
352         }
353 }
354
355 void notify_fname(connection_struct *conn, uint32 action, uint32 filter,
356                   const char *path)
357 {
358         char *fullpath;
359
360         if (asprintf(&fullpath, "%s/%s", conn->connectpath, path) == -1) {
361                 DEBUG(0, ("asprintf failed\n"));
362                 return;
363         }
364
365         notify_trigger(conn->notify_ctx, action, filter, fullpath);
366         SAFE_FREE(fullpath);
367 }
368
369 static void notify_fsp(files_struct *fsp, uint32 action, const char *name)
370 {
371         struct notify_change *change, *changes;
372         char *tmp;
373
374         if (fsp->notify == NULL) {
375                 /*
376                  * Nobody is waiting, don't queue
377                  */
378                 return;
379         }
380
381         /*
382          * Someone has triggered a notify previously, queue the change for
383          * later.
384          */
385
386         if ((fsp->notify->num_changes > 1000) || (name == NULL)) {
387                 /*
388                  * The real number depends on the client buf, just provide a
389                  * guard against a DoS here.
390                  */
391                 TALLOC_FREE(fsp->notify->changes);
392                 fsp->notify->num_changes = -1;
393                 return;
394         }
395
396         if (fsp->notify->num_changes == -1) {
397                 return;
398         }
399
400         if (!(changes = TALLOC_REALLOC_ARRAY(
401                       fsp->notify, fsp->notify->changes,
402                       struct notify_change, fsp->notify->num_changes+1))) {
403                 DEBUG(0, ("talloc_realloc failed\n"));
404                 return;
405         }
406
407         fsp->notify->changes = changes;
408
409         change = &(fsp->notify->changes[fsp->notify->num_changes]);
410
411         if (!(tmp = talloc_strdup(changes, name))) {
412                 DEBUG(0, ("talloc_strdup failed\n"));
413                 return;
414         }
415
416         string_replace(tmp, '/', '\\');
417         change->name = tmp;     
418
419         change->action = action;
420         fsp->notify->num_changes += 1;
421
422         if (fsp->notify->requests == NULL) {
423                 /*
424                  * Nobody is waiting, so don't send anything. The ot
425                  */
426                 return;
427         }
428
429         if (action == NOTIFY_ACTION_OLD_NAME) {
430                 /*
431                  * We have to send the two rename events in one reply. So hold
432                  * the first part back.
433                  */
434                 return;
435         }
436
437         /*
438          * Someone is waiting for the change, trigger the reply immediately.
439          *
440          * TODO: do we have to walk the lists of requests pending?
441          */
442
443         change_notify_reply(fsp->conn,
444                         fsp->notify->requests->request_buf,
445                             fsp->notify->requests->max_param,
446                             fsp->notify);
447
448         change_notify_remove_request(fsp->notify->requests);
449 }
450
451 char *notify_filter_string(TALLOC_CTX *mem_ctx, uint32 filter)
452 {
453         char *result = NULL;
454
455         result = talloc_strdup(mem_ctx, "");
456
457         if (filter & FILE_NOTIFY_CHANGE_FILE_NAME)
458                 result = talloc_asprintf_append(result, "FILE_NAME|");
459         if (filter & FILE_NOTIFY_CHANGE_DIR_NAME)
460                 result = talloc_asprintf_append(result, "DIR_NAME|");
461         if (filter & FILE_NOTIFY_CHANGE_ATTRIBUTES)
462                 result = talloc_asprintf_append(result, "ATTRIBUTES|");
463         if (filter & FILE_NOTIFY_CHANGE_SIZE)
464                 result = talloc_asprintf_append(result, "SIZE|");
465         if (filter & FILE_NOTIFY_CHANGE_LAST_WRITE)
466                 result = talloc_asprintf_append(result, "LAST_WRITE|");
467         if (filter & FILE_NOTIFY_CHANGE_LAST_ACCESS)
468                 result = talloc_asprintf_append(result, "LAST_ACCESS|");
469         if (filter & FILE_NOTIFY_CHANGE_CREATION)
470                 result = talloc_asprintf_append(result, "CREATION|");
471         if (filter & FILE_NOTIFY_CHANGE_EA)
472                 result = talloc_asprintf_append(result, "EA|");
473         if (filter & FILE_NOTIFY_CHANGE_SECURITY)
474                 result = talloc_asprintf_append(result, "SECURITY|");
475         if (filter & FILE_NOTIFY_CHANGE_STREAM_NAME)
476                 result = talloc_asprintf_append(result, "STREAM_NAME|");
477         if (filter & FILE_NOTIFY_CHANGE_STREAM_SIZE)
478                 result = talloc_asprintf_append(result, "STREAM_SIZE|");
479         if (filter & FILE_NOTIFY_CHANGE_STREAM_WRITE)
480                 result = talloc_asprintf_append(result, "STREAM_WRITE|");
481
482         if (result == NULL) return NULL;
483         if (*result == '\0') return result;
484
485         result[strlen(result)-1] = '\0';
486         return result;
487 }
488
489 struct sys_notify_context *sys_notify_context_create(connection_struct *conn,
490                                                      TALLOC_CTX *mem_ctx, 
491                                                      struct event_context *ev)
492 {
493         struct sys_notify_context *ctx;
494
495         if (!(ctx = TALLOC_P(mem_ctx, struct sys_notify_context))) {
496                 DEBUG(0, ("talloc failed\n"));
497                 return NULL;
498         }
499
500         ctx->ev = ev;
501         ctx->conn = conn;
502         ctx->private_data = NULL;
503         return ctx;
504 }
505
506 NTSTATUS sys_notify_watch(struct sys_notify_context *ctx,
507                           struct notify_entry *e,
508                           void (*callback)(struct sys_notify_context *ctx, 
509                                            void *private_data,
510                                            struct notify_event *ev),
511                           void *private_data, void *handle)
512 {
513         return SMB_VFS_NOTIFY_WATCH(ctx->conn, ctx, e, callback, private_data,
514                                     handle);
515 }
516