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