s3:smbd: move global notify_changes_by_mid to smbd_server_connection
[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 #include "smbd/globals.h"
24
25 struct notify_change_request {
26         struct notify_change_request *prev, *next;
27         struct files_struct *fsp;       /* backpointer for cancel by mid */
28         struct smb_request *req;
29         uint32 filter;
30         uint32 max_param;
31         struct notify_mid_map *mid_map;
32         void *backend_data;
33 };
34
35 static void notify_fsp(files_struct *fsp, uint32 action, const char *name);
36
37 /*
38  * For NTCancel, we need to find the notify_change_request indexed by
39  * mid. Separate list here.
40  */
41
42 struct notify_mid_map {
43         struct notify_mid_map *prev, *next;
44         struct notify_change_request *req;
45         uint16 mid;
46 };
47
48 static bool notify_change_record_identical(struct notify_change *c1,
49                                         struct notify_change *c2)
50 {
51         /* Note this is deliberately case sensitive. */
52         if (c1->action == c2->action &&
53                         strcmp(c1->name, c2->name) == 0) {
54                 return True;
55         }
56         return False;
57 }
58
59 static bool notify_marshall_changes(int num_changes,
60                                 uint32 max_offset,
61                                 struct notify_change *changes,
62                                 prs_struct *ps)
63 {
64         int i;
65         UNISTR uni_name;
66
67         uni_name.buffer = NULL;
68
69         for (i=0; i<num_changes; i++) {
70                 struct notify_change *c;
71                 size_t namelen;
72                 uint32 u32_tmp; /* Temp arg to prs_uint32 to avoid
73                                  * signed/unsigned issues */
74
75                 /* Coalesce any identical records. */
76                 while (i+1 < num_changes &&
77                         notify_change_record_identical(&changes[i],
78                                                 &changes[i+1])) {
79                         i++;
80                 }
81
82                 c = &changes[i];
83
84                 if (!convert_string_talloc(talloc_tos(), CH_UNIX, CH_UTF16LE,
85                         c->name, strlen(c->name)+1, &uni_name.buffer,
86                         &namelen, True) || (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                 TALLOC_FREE(uni_name.buffer);
113
114                 if (prs_offset(ps) > max_offset) {
115                         /* Too much data for client. */
116                         DEBUG(10, ("Client only wanted %d bytes, trying to "
117                                    "marshall %d bytes\n", (int)max_offset,
118                                    (int)prs_offset(ps)));
119                         return False;
120                 }
121         }
122
123         return True;
124
125  fail:
126         TALLOC_FREE(uni_name.buffer);
127         return False;
128 }
129
130 /****************************************************************************
131  Setup the common parts of the return packet and send it.
132 *****************************************************************************/
133
134 static void change_notify_reply_packet(connection_struct *conn,
135                                        struct smb_request *req,
136                                        NTSTATUS error_code)
137 {
138         reply_outbuf(req, 18, 0);
139
140         if (!NT_STATUS_IS_OK(error_code)) {
141                 error_packet_set((char *)req->outbuf, 0, 0, error_code,
142                                  __LINE__,__FILE__);
143         }
144
145         show_msg((char *)req->outbuf);
146         if (!srv_send_smb(smbd_server_fd(),
147                           (char *)req->outbuf,
148                           true, req->seqnum+1,
149                           req->encrypted, &req->pcd)) {
150                 exit_server_cleanly("change_notify_reply_packet: srv_send_smb "
151                                     "failed.");
152         }
153         TALLOC_FREE(req->outbuf);
154 }
155
156 void change_notify_reply(connection_struct *conn,
157                          struct smb_request *req, uint32 max_param,
158                          struct notify_change_buf *notify_buf)
159 {
160         prs_struct ps;
161
162         if (notify_buf->num_changes == -1) {
163                 change_notify_reply_packet(conn, req, NT_STATUS_OK);
164                 notify_buf->num_changes = 0;
165                 return;
166         }
167
168         prs_init_empty(&ps, NULL, MARSHALL);
169
170         if (!notify_marshall_changes(notify_buf->num_changes, max_param,
171                                         notify_buf->changes, &ps)) {
172                 /*
173                  * We exceed what the client is willing to accept. Send
174                  * nothing.
175                  */
176                 change_notify_reply_packet(conn, req, NT_STATUS_OK);
177                 goto done;
178         }
179
180         send_nt_replies(conn, req, NT_STATUS_OK, prs_data_p(&ps),
181                         prs_offset(&ps), NULL, 0);
182
183  done:
184         prs_mem_free(&ps);
185
186         TALLOC_FREE(notify_buf->changes);
187         notify_buf->num_changes = 0;
188 }
189
190 static void notify_callback(void *private_data, const struct notify_event *e)
191 {
192         files_struct *fsp = (files_struct *)private_data;
193         DEBUG(10, ("notify_callback called for %s\n", fsp->fsp_name));
194         notify_fsp(fsp, e->action, e->path);
195 }
196
197 NTSTATUS change_notify_create(struct files_struct *fsp, uint32 filter,
198                               bool recursive)
199 {
200         char *fullpath;
201         struct notify_entry e;
202         NTSTATUS status;
203
204         SMB_ASSERT(fsp->notify == NULL);
205
206         if (!(fsp->notify = TALLOC_ZERO_P(NULL, struct notify_change_buf))) {
207                 DEBUG(0, ("talloc failed\n"));
208                 return NT_STATUS_NO_MEMORY;
209         }
210
211         if (asprintf(&fullpath, "%s/%s", fsp->conn->connectpath,
212                      fsp->fsp_name) == -1) {
213                 DEBUG(0, ("asprintf failed\n"));
214                 TALLOC_FREE(fsp->notify);
215                 return NT_STATUS_NO_MEMORY;
216         }
217
218         ZERO_STRUCT(e);
219         e.path = fullpath;
220         e.dir_fd = fsp->fh->fd;
221         e.dir_id = fsp->file_id;
222         e.filter = filter;
223         e.subdir_filter = 0;
224         if (recursive) {
225                 e.subdir_filter = filter;
226         }
227
228         status = notify_add(fsp->conn->notify_ctx, &e, notify_callback, fsp);
229         SAFE_FREE(fullpath);
230
231         return status;
232 }
233
234 NTSTATUS change_notify_add_request(struct smb_request *req,
235                                 uint32 max_param,
236                                 uint32 filter, bool recursive,
237                                 struct files_struct *fsp)
238 {
239         struct notify_change_request *request = NULL;
240         struct notify_mid_map *map = NULL;
241         struct smbd_server_connection *sconn = smbd_server_conn;
242
243         DEBUG(10, ("change_notify_add_request: Adding request for %s: "
244                    "max_param = %d\n", fsp->fsp_name, (int)max_param));
245
246         if (!(request = talloc(NULL, struct notify_change_request))
247             || !(map = talloc(request, struct notify_mid_map))) {
248                 TALLOC_FREE(request);
249                 return NT_STATUS_NO_MEMORY;
250         }
251
252         request->mid_map = map;
253         map->req = request;
254
255         request->req = talloc_move(request, &req);
256         request->max_param = max_param;
257         request->filter = filter;
258         request->fsp = fsp;
259         request->backend_data = NULL;
260
261         DLIST_ADD_END(fsp->notify->requests, request,
262                       struct notify_change_request *);
263
264         map->mid = request->req->mid;
265         DLIST_ADD(sconn->smb1.notify_mid_maps, map);
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         struct smbd_server_connection *sconn = smbd_server_conn;
275
276         /*
277          * Paranoia checks, the fsp referenced must must have the request in
278          * its list of pending requests
279          */
280
281         fsp = remove_req->fsp;
282         SMB_ASSERT(fsp->notify != NULL);
283
284         for (req = fsp->notify->requests; req; req = req->next) {
285                 if (req == remove_req) {
286                         break;
287                 }
288         }
289
290         if (req == NULL) {
291                 smb_panic("notify_req not found in fsp's requests");
292         }
293
294         DLIST_REMOVE(fsp->notify->requests, req);
295         DLIST_REMOVE(sconn->smb1.notify_mid_maps, req->mid_map);
296         TALLOC_FREE(req);
297 }
298
299 /****************************************************************************
300  Delete entries by mid from the change notify pending queue. Always send reply.
301 *****************************************************************************/
302
303 void remove_pending_change_notify_requests_by_mid(uint16 mid)
304 {
305         struct notify_mid_map *map;
306         struct smbd_server_connection *sconn = smbd_server_conn;
307
308         for (map = sconn->smb1.notify_mid_maps; 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->fsp->conn, map->req->req,
319                                    NT_STATUS_CANCELLED);
320         change_notify_remove_request(map->req);
321 }
322
323 /****************************************************************************
324  Delete entries by fnum from the change notify pending queue.
325 *****************************************************************************/
326
327 void remove_pending_change_notify_requests_by_fid(files_struct *fsp,
328                                                   NTSTATUS status)
329 {
330         if (fsp->notify == NULL) {
331                 return;
332         }
333
334         while (fsp->notify->requests != NULL) {
335                 change_notify_reply_packet(
336                         fsp->conn, fsp->notify->requests->req, status);
337                 change_notify_remove_request(fsp->notify->requests);
338         }
339 }
340
341 void notify_fname(connection_struct *conn, uint32 action, uint32 filter,
342                   const char *path)
343 {
344         char *fullpath;
345         char *parent;
346         const char *name;
347
348         if (path[0] == '.' && path[1] == '/') {
349                 path += 2;
350         }
351         if (parent_dirname(talloc_tos(), path, &parent, &name)) {
352                 struct smb_filename *smb_fname_parent = NULL;
353                 NTSTATUS status;
354
355                 status = create_synthetic_smb_fname(talloc_tos(), parent, NULL,
356                                                     NULL, &smb_fname_parent);
357                 if (!NT_STATUS_IS_OK(status)) {
358                         return;
359                 }
360                 if (SMB_VFS_STAT(conn, smb_fname_parent) != -1) {
361                         notify_onelevel(conn->notify_ctx, action, filter,
362                             SMB_VFS_FILE_ID_CREATE(conn, &smb_fname_parent->st),
363                             name);
364                 }
365                 TALLOC_FREE(smb_fname_parent);
366         }
367
368         fullpath = talloc_asprintf(talloc_tos(), "%s/%s", conn->connectpath,
369                                    path);
370         if (fullpath == NULL) {
371                 DEBUG(0, ("asprintf failed\n"));
372                 return;
373         }
374         notify_trigger(conn->notify_ctx, action, filter, fullpath);
375         TALLOC_FREE(fullpath);
376 }
377
378 static void notify_fsp(files_struct *fsp, uint32 action, const char *name)
379 {
380         struct notify_change *change, *changes;
381         char *tmp;
382
383         if (fsp->notify == NULL) {
384                 /*
385                  * Nobody is waiting, don't queue
386                  */
387                 return;
388         }
389
390         /*
391          * Someone has triggered a notify previously, queue the change for
392          * later.
393          */
394
395         if ((fsp->notify->num_changes > 1000) || (name == NULL)) {
396                 /*
397                  * The real number depends on the client buf, just provide a
398                  * guard against a DoS here.  If name == NULL the CN backend is
399                  * alerting us to a problem.  Possibly dropped events.  Clear
400                  * queued changes and send the catch-all response to the client
401                  * if a request is pending.
402                  */
403                 TALLOC_FREE(fsp->notify->changes);
404                 fsp->notify->num_changes = -1;
405                 if (fsp->notify->requests != NULL) {
406                         change_notify_reply(fsp->conn,
407                                             fsp->notify->requests->req,
408                                             fsp->notify->requests->max_param,
409                                             fsp->notify);
410                         change_notify_remove_request(fsp->notify->requests);
411                 }
412                 return;
413         }
414
415         /* If we've exceeded the server side queue or received a NULL name
416          * from the underlying CN implementation, don't queue up any more
417          * requests until we can send a catch-all response to the client */
418         if (fsp->notify->num_changes == -1) {
419                 return;
420         }
421
422         if (!(changes = TALLOC_REALLOC_ARRAY(
423                       fsp->notify, fsp->notify->changes,
424                       struct notify_change, fsp->notify->num_changes+1))) {
425                 DEBUG(0, ("talloc_realloc failed\n"));
426                 return;
427         }
428
429         fsp->notify->changes = changes;
430
431         change = &(fsp->notify->changes[fsp->notify->num_changes]);
432
433         if (!(tmp = talloc_strdup(changes, name))) {
434                 DEBUG(0, ("talloc_strdup failed\n"));
435                 return;
436         }
437
438         string_replace(tmp, '/', '\\');
439         change->name = tmp;     
440
441         change->action = action;
442         fsp->notify->num_changes += 1;
443
444         if (fsp->notify->requests == NULL) {
445                 /*
446                  * Nobody is waiting, so don't send anything. The ot
447                  */
448                 return;
449         }
450
451         if (action == NOTIFY_ACTION_OLD_NAME) {
452                 /*
453                  * We have to send the two rename events in one reply. So hold
454                  * the first part back.
455                  */
456                 return;
457         }
458
459         /*
460          * Someone is waiting for the change, trigger the reply immediately.
461          *
462          * TODO: do we have to walk the lists of requests pending?
463          */
464
465         change_notify_reply(fsp->conn,
466                             fsp->notify->requests->req,
467                             fsp->notify->requests->max_param,
468                             fsp->notify);
469
470         change_notify_remove_request(fsp->notify->requests);
471 }
472
473 char *notify_filter_string(TALLOC_CTX *mem_ctx, uint32 filter)
474 {
475         char *result = NULL;
476
477         result = talloc_strdup(mem_ctx, "");
478
479         if (filter & FILE_NOTIFY_CHANGE_FILE_NAME)
480                 result = talloc_asprintf_append(result, "FILE_NAME|");
481         if (filter & FILE_NOTIFY_CHANGE_DIR_NAME)
482                 result = talloc_asprintf_append(result, "DIR_NAME|");
483         if (filter & FILE_NOTIFY_CHANGE_ATTRIBUTES)
484                 result = talloc_asprintf_append(result, "ATTRIBUTES|");
485         if (filter & FILE_NOTIFY_CHANGE_SIZE)
486                 result = talloc_asprintf_append(result, "SIZE|");
487         if (filter & FILE_NOTIFY_CHANGE_LAST_WRITE)
488                 result = talloc_asprintf_append(result, "LAST_WRITE|");
489         if (filter & FILE_NOTIFY_CHANGE_LAST_ACCESS)
490                 result = talloc_asprintf_append(result, "LAST_ACCESS|");
491         if (filter & FILE_NOTIFY_CHANGE_CREATION)
492                 result = talloc_asprintf_append(result, "CREATION|");
493         if (filter & FILE_NOTIFY_CHANGE_EA)
494                 result = talloc_asprintf_append(result, "EA|");
495         if (filter & FILE_NOTIFY_CHANGE_SECURITY)
496                 result = talloc_asprintf_append(result, "SECURITY|");
497         if (filter & FILE_NOTIFY_CHANGE_STREAM_NAME)
498                 result = talloc_asprintf_append(result, "STREAM_NAME|");
499         if (filter & FILE_NOTIFY_CHANGE_STREAM_SIZE)
500                 result = talloc_asprintf_append(result, "STREAM_SIZE|");
501         if (filter & FILE_NOTIFY_CHANGE_STREAM_WRITE)
502                 result = talloc_asprintf_append(result, "STREAM_WRITE|");
503
504         if (result == NULL) return NULL;
505         if (*result == '\0') return result;
506
507         result[strlen(result)-1] = '\0';
508         return result;
509 }
510
511 struct sys_notify_context *sys_notify_context_create(connection_struct *conn,
512                                                      TALLOC_CTX *mem_ctx, 
513                                                      struct event_context *ev)
514 {
515         struct sys_notify_context *ctx;
516
517         if (!(ctx = TALLOC_P(mem_ctx, struct sys_notify_context))) {
518                 DEBUG(0, ("talloc failed\n"));
519                 return NULL;
520         }
521
522         ctx->ev = ev;
523         ctx->conn = conn;
524         ctx->private_data = NULL;
525         return ctx;
526 }
527
528 NTSTATUS sys_notify_watch(struct sys_notify_context *ctx,
529                           struct notify_entry *e,
530                           void (*callback)(struct sys_notify_context *ctx, 
531                                            void *private_data,
532                                            struct notify_event *ev),
533                           void *private_data, void *handle)
534 {
535         return SMB_VFS_NOTIFY_WATCH(ctx->conn, ctx, e, callback, private_data,
536                                     handle);
537 }
538