2 Unix SMB/CIFS implementation.
4 Copyright (C) Andrew Tridgell 2000
5 Copyright (C) Jeremy Allison 1994-1998
6 Copyright (C) Volker Lendecke 2007
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.
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.
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/>.
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];
30 struct notify_mid_map *mid_map;
34 static void notify_fsp(files_struct *fsp, uint32 action, const char *name);
36 static struct notify_mid_map *notify_changes_by_mid;
39 * For NTCancel, we need to find the notify_change_request indexed by
40 * mid. Separate list here.
43 struct notify_mid_map {
44 struct notify_mid_map *prev, *next;
45 struct notify_change_request *req;
49 static BOOL notify_change_record_identical(struct notify_change *c1,
50 struct notify_change *c2)
52 /* Note this is deliberately case sensitive. */
53 if (c1->action == c2->action &&
54 strcmp(c1->name, c2->name) == 0) {
60 static BOOL notify_marshall_changes(int num_changes,
62 struct notify_change *changes,
68 for (i=0; i<num_changes; i++) {
69 struct notify_change *c;
71 uint32 u32_tmp; /* Temp arg to prs_uint32 to avoid
72 * signed/unsigned issues */
74 /* Coalesce any identical records. */
75 while (i+1 < num_changes &&
76 notify_change_record_identical(&changes[i],
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)) {
90 namelen -= 2; /* Dump NULL termination */
93 * Offset to next entry, only if there is one
96 u32_tmp = (i == num_changes-1) ? 0 : namelen + 12;
97 if (!prs_uint32("offset", ps, 1, &u32_tmp)) goto fail;
100 if (!prs_uint32("action", ps, 1, &u32_tmp)) goto fail;
103 if (!prs_uint32("namelen", ps, 1, &u32_tmp)) goto fail;
105 if (!prs_unistr("name", ps, 1, &uni_name)) goto fail;
108 * Not NULL terminated, decrease by the 2 UCS2 \0 chars
110 prs_set_offset(ps, prs_offset(ps)-2);
112 SAFE_FREE(uni_name.buffer);
114 if (prs_offset(ps) > max_offset) {
115 /* Too much data for client. */
123 SAFE_FREE(uni_name.buffer);
127 /****************************************************************************
128 Setup the common parts of the return packet and send it.
129 *****************************************************************************/
131 static void change_notify_reply_packet(const uint8 *request_buf,
134 const char *inbuf = (char *)request_buf;
135 char outbuf[smb_size+38];
137 memset(outbuf, '\0', sizeof(outbuf));
138 construct_reply_common(inbuf, outbuf);
140 ERROR_NT(error_code);
143 * Seems NT needs a transact command with an error code
144 * in it. This is a longer packet than a simple error.
146 set_message(inbuf,outbuf,18,0,False);
149 if (!send_smb(smbd_server_fd(),outbuf))
150 exit_server_cleanly("change_notify_reply_packet: send_smb "
154 void change_notify_reply(const uint8 *request_buf, uint32 max_param,
155 struct notify_change_buf *notify_buf)
158 struct smb_request *req = NULL;
159 uint8 tmp_request[smb_size];
161 if (notify_buf->num_changes == -1) {
162 change_notify_reply_packet(request_buf, NT_STATUS_OK);
163 notify_buf->num_changes = 0;
167 prs_init(&ps, 0, NULL, MARSHALL);
169 if (!notify_marshall_changes(notify_buf->num_changes, max_param,
170 notify_buf->changes, &ps)) {
172 * We exceed what the client is willing to accept. Send
175 change_notify_reply_packet(request_buf, NT_STATUS_OK);
179 if (!(req = talloc(talloc_tos(), struct smb_request))) {
180 change_notify_reply_packet(request_buf, NT_STATUS_NO_MEMORY);
184 memcpy(tmp_request, request_buf, smb_size);
187 * We're only interested in the header fields here
190 smb_setlen(NULL, (char *)tmp_request, smb_size);
191 SCVAL(tmp_request, smb_wct, 0);
193 init_smb_request(req, tmp_request);
195 send_nt_replies(req, NT_STATUS_OK, prs_data_p(&ps),
196 prs_offset(&ps), NULL, 0);
202 TALLOC_FREE(notify_buf->changes);
203 notify_buf->num_changes = 0;
206 static void notify_callback(void *private_data, const struct notify_event *e)
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);
213 NTSTATUS change_notify_create(struct files_struct *fsp, uint32 filter,
217 struct notify_entry e;
220 SMB_ASSERT(fsp->notify == NULL);
222 if (!(fsp->notify = TALLOC_ZERO_P(NULL, struct notify_change_buf))) {
223 DEBUG(0, ("talloc failed\n"));
224 return NT_STATUS_NO_MEMORY;
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;
237 e.subdir_filter = filter;
240 status = notify_add(fsp->conn->notify_ctx, &e, notify_callback, fsp);
246 NTSTATUS change_notify_add_request(const uint8 *inbuf, uint32 max_param,
247 uint32 filter, BOOL recursive,
248 struct files_struct *fsp)
250 struct notify_change_request *request = NULL;
251 struct notify_mid_map *map = NULL;
253 if (!(request = SMB_MALLOC_P(struct notify_change_request))
254 || !(map = SMB_MALLOC_P(struct notify_mid_map))) {
256 return NT_STATUS_NO_MEMORY;
259 request->mid_map = map;
262 memcpy(request->request_buf, inbuf, sizeof(request->request_buf));
263 request->max_param = max_param;
264 request->filter = filter;
266 request->backend_data = NULL;
268 DLIST_ADD_END(fsp->notify->requests, request,
269 struct notify_change_request *);
271 map->mid = SVAL(inbuf, smb_mid);
272 DLIST_ADD(notify_changes_by_mid, map);
274 /* Push the MID of this packet on the signing queue. */
275 srv_defer_sign_response(SVAL(inbuf,smb_mid));
280 static void change_notify_remove_request(struct notify_change_request *remove_req)
283 struct notify_change_request *req;
286 * Paranoia checks, the fsp referenced must must have the request in
287 * its list of pending requests
290 fsp = remove_req->fsp;
291 SMB_ASSERT(fsp->notify != NULL);
293 for (req = fsp->notify->requests; req; req = req->next) {
294 if (req == remove_req) {
300 smb_panic("notify_req not found in fsp's requests");
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);
310 /****************************************************************************
311 Delete entries by mid from the change notify pending queue. Always send reply.
312 *****************************************************************************/
314 void remove_pending_change_notify_requests_by_mid(uint16 mid)
316 struct notify_mid_map *map;
318 for (map = notify_changes_by_mid; map; map = map->next) {
319 if (map->mid == mid) {
328 change_notify_reply_packet(map->req->request_buf, NT_STATUS_CANCELLED);
329 change_notify_remove_request(map->req);
332 /****************************************************************************
333 Delete entries by fnum from the change notify pending queue.
334 *****************************************************************************/
336 void remove_pending_change_notify_requests_by_fid(files_struct *fsp,
339 if (fsp->notify == NULL) {
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);
350 void notify_fname(connection_struct *conn, uint32 action, uint32 filter,
355 if (asprintf(&fullpath, "%s/%s", conn->connectpath, path) == -1) {
356 DEBUG(0, ("asprintf failed\n"));
360 notify_trigger(conn->notify_ctx, action, filter, fullpath);
364 static void notify_fsp(files_struct *fsp, uint32 action, const char *name)
366 struct notify_change *change, *changes;
369 if (fsp->notify == NULL) {
371 * Nobody is waiting, don't queue
377 * Someone has triggered a notify previously, queue the change for
381 if ((fsp->notify->num_changes > 1000) || (name == NULL)) {
383 * The real number depends on the client buf, just provide a
384 * guard against a DoS here.
386 TALLOC_FREE(fsp->notify->changes);
387 fsp->notify->num_changes = -1;
391 if (fsp->notify->num_changes == -1) {
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"));
402 fsp->notify->changes = changes;
404 change = &(fsp->notify->changes[fsp->notify->num_changes]);
406 if (!(tmp = talloc_strdup(changes, name))) {
407 DEBUG(0, ("talloc_strdup failed\n"));
411 string_replace(tmp, '/', '\\');
414 change->action = action;
415 fsp->notify->num_changes += 1;
417 if (fsp->notify->requests == NULL) {
419 * Nobody is waiting, so don't send anything. The ot
424 if (action == NOTIFY_ACTION_OLD_NAME) {
426 * We have to send the two rename events in one reply. So hold
427 * the first part back.
433 * Someone is waiting for the change, trigger the reply immediately.
435 * TODO: do we have to walk the lists of requests pending?
438 change_notify_reply(fsp->notify->requests->request_buf,
439 fsp->notify->requests->max_param,
442 change_notify_remove_request(fsp->notify->requests);
445 char *notify_filter_string(TALLOC_CTX *mem_ctx, uint32 filter)
449 result = talloc_strdup(mem_ctx, "");
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|");
476 if (result == NULL) return NULL;
477 if (*result == '\0') return result;
479 result[strlen(result)-1] = '\0';
483 struct sys_notify_context *sys_notify_context_create(connection_struct *conn,
485 struct event_context *ev)
487 struct sys_notify_context *ctx;
489 if (!(ctx = TALLOC_P(mem_ctx, struct sys_notify_context))) {
490 DEBUG(0, ("talloc failed\n"));
496 ctx->private_data = NULL;
500 NTSTATUS sys_notify_watch(struct sys_notify_context *ctx,
501 struct notify_entry *e,
502 void (*callback)(struct sys_notify_context *ctx,
504 struct notify_event *ev),
505 void *private_data, void *handle)
507 return SMB_VFS_NOTIFY_WATCH(ctx->conn, ctx, e, callback, private_data,